Header file of OSPI HAL module. More...

Data Structures
struct	__OSPI_HandleTypeDef
	HAL OSPI Handle Structure definition. More...

struct	OSPI_RegularCmdTypeDef
	HAL OSPI Regular Command Structure definition. More...

struct	OSPI_HyperbusCfgTypeDef
	HAL OSPI Hyperbus Configuration Structure definition. More...

struct	OSPI_HyperbusCmdTypeDef
	HAL OSPI Hyperbus Command Structure definition. More...

struct	OSPI_AutoPollingTypeDef
	HAL OSPI Auto Polling mode configuration structure definition. More...

struct	OSPI_MemoryMappedTypeDef
	HAL OSPI Memory Mapped mode configuration structure definition. More...

struct	OSPIM_CfgTypeDef
	HAL OSPI IO Manager Configuration structure definition. More...

Typedefs
typedef struct __OSPI_HandleTypeDef	OSPI_HandleTypeDef
	HAL OSPI Handle Structure definition. More...

typedef void(*	pOSPI_CallbackTypeDef) (OSPI_HandleTypeDef *hospi)
	HAL OSPI Callback pointer definition. More...

Enumerations
enum	HAL_OSPI_CallbackIDTypeDef { HAL_OSPI_ERROR_CB_ID = 0x00U, HAL_OSPI_ABORT_CB_ID = 0x01U, HAL_OSPI_FIFO_THRESHOLD_CB_ID = 0x02U, HAL_OSPI_CMD_CPLT_CB_ID = 0x03U, HAL_OSPI_RX_CPLT_CB_ID = 0x04U, HAL_OSPI_TX_CPLT_CB_ID = 0x05U, HAL_OSPI_RX_HALF_CPLT_CB_ID = 0x06U, HAL_OSPI_TX_HALF_CPLT_CB_ID = 0x07U, HAL_OSPI_STATUS_MATCH_CB_ID = 0x08U, HAL_OSPI_TIMEOUT_CB_ID = 0x09U, HAL_OSPI_MSP_INIT_CB_ID = 0x0AU, HAL_OSPI_MSP_DEINIT_CB_ID = 0x0BU }
	HAL OSPI Callback ID enumeration definition. More...

Functions
HAL_StatusTypeDef	HAL_OSPI_Init (OSPI_HandleTypeDef *hospi)
	Initialize the OSPI mode according to the specified parameters in the OSPI_InitTypeDef and initialize the associated handle. More...

void	HAL_OSPI_MspInit (OSPI_HandleTypeDef *hospi)
	Initialize the OSPI MSP. More...

HAL_StatusTypeDef	HAL_OSPI_DeInit (OSPI_HandleTypeDef *hospi)
	De-Initialize the OSPI peripheral. More...

void	HAL_OSPI_MspDeInit (OSPI_HandleTypeDef *hospi)
	DeInitialize the OSPI MSP. More...

void	HAL_OSPI_IRQHandler (OSPI_HandleTypeDef *hospi)
	Handle OSPI interrupt request. More...

HAL_StatusTypeDef	HAL_OSPI_Command (OSPI_HandleTypeDef hospi, OSPI_RegularCmdTypeDef cmd, uint32_t Timeout)
	Set the command configuration. More...

HAL_StatusTypeDef	HAL_OSPI_Command_IT (OSPI_HandleTypeDef hospi, OSPI_RegularCmdTypeDef cmd)
	Set the command configuration in interrupt mode. More...

HAL_StatusTypeDef	HAL_OSPI_HyperbusCfg (OSPI_HandleTypeDef hospi, OSPI_HyperbusCfgTypeDef cfg, uint32_t Timeout)
	Configure the Hyperbus parameters. More...

HAL_StatusTypeDef	HAL_OSPI_HyperbusCmd (OSPI_HandleTypeDef hospi, OSPI_HyperbusCmdTypeDef cmd, uint32_t Timeout)
	Set the Hyperbus command configuration. More...

HAL_StatusTypeDef	HAL_OSPI_Transmit (OSPI_HandleTypeDef hospi, uint8_t pData, uint32_t Timeout)
	Transmit an amount of data in blocking mode. More...

HAL_StatusTypeDef	HAL_OSPI_Receive (OSPI_HandleTypeDef hospi, uint8_t pData, uint32_t Timeout)
	Receive an amount of data in blocking mode. More...

HAL_StatusTypeDef	HAL_OSPI_Transmit_IT (OSPI_HandleTypeDef hospi, uint8_t pData)
	Send an amount of data in non-blocking mode with interrupt. More...

HAL_StatusTypeDef	HAL_OSPI_Receive_IT (OSPI_HandleTypeDef hospi, uint8_t pData)
	Receive an amount of data in non-blocking mode with interrupt. More...

HAL_StatusTypeDef	HAL_OSPI_Transmit_DMA (OSPI_HandleTypeDef hospi, uint8_t pData)
	Send an amount of data in non-blocking mode with DMA. More...

HAL_StatusTypeDef	HAL_OSPI_Receive_DMA (OSPI_HandleTypeDef hospi, uint8_t pData)
	Receive an amount of data in non-blocking mode with DMA. More...

HAL_StatusTypeDef	HAL_OSPI_AutoPolling (OSPI_HandleTypeDef hospi, OSPI_AutoPollingTypeDef cfg, uint32_t Timeout)
	Configure the OSPI Automatic Polling Mode in blocking mode. More...

HAL_StatusTypeDef	HAL_OSPI_AutoPolling_IT (OSPI_HandleTypeDef hospi, OSPI_AutoPollingTypeDef cfg)
	Configure the OSPI Automatic Polling Mode in non-blocking mode. More...

HAL_StatusTypeDef	HAL_OSPI_MemoryMapped (OSPI_HandleTypeDef hospi, OSPI_MemoryMappedTypeDef cfg)
	Configure the Memory Mapped mode. More...

void	HAL_OSPI_ErrorCallback (OSPI_HandleTypeDef *hospi)
	Transfer Error callback. More...

void	HAL_OSPI_AbortCpltCallback (OSPI_HandleTypeDef *hospi)
	Abort completed callback. More...

void	HAL_OSPI_FifoThresholdCallback (OSPI_HandleTypeDef *hospi)
	FIFO Threshold callback. More...

void	HAL_OSPI_CmdCpltCallback (OSPI_HandleTypeDef *hospi)
	Command completed callback. More...

void	HAL_OSPI_RxCpltCallback (OSPI_HandleTypeDef *hospi)
	Rx Transfer completed callback. More...

void	HAL_OSPI_TxCpltCallback (OSPI_HandleTypeDef *hospi)
	Tx Transfer completed callback. More...

void	HAL_OSPI_RxHalfCpltCallback (OSPI_HandleTypeDef *hospi)
	Rx Half Transfer completed callback. More...

void	HAL_OSPI_TxHalfCpltCallback (OSPI_HandleTypeDef *hospi)
	Tx Half Transfer completed callback. More...

void	HAL_OSPI_StatusMatchCallback (OSPI_HandleTypeDef *hospi)
	Status Match callback. More...

void	HAL_OSPI_TimeOutCallback (OSPI_HandleTypeDef *hospi)
	Timeout callback. More...

HAL_StatusTypeDef	HAL_OSPI_RegisterCallback (OSPI_HandleTypeDef *hospi, HAL_OSPI_CallbackIDTypeDef CallbackID, pOSPI_CallbackTypeDef pCallback)
	Register a User OSPI Callback To be used instead of the weak (surcharged) predefined callback. More...

HAL_StatusTypeDef	HAL_OSPI_UnRegisterCallback (OSPI_HandleTypeDef *hospi, HAL_OSPI_CallbackIDTypeDef CallbackID)
	Unregister a User OSPI Callback OSPI Callback is redirected to the weak (surcharged) predefined callback. More...

HAL_StatusTypeDef	HAL_OSPI_Abort (OSPI_HandleTypeDef *hospi)
	Abort the current transmission. More...

HAL_StatusTypeDef	HAL_OSPI_Abort_IT (OSPI_HandleTypeDef *hospi)
	Abort the current transmission (non-blocking function) More...

HAL_StatusTypeDef	HAL_OSPI_SetFifoThreshold (OSPI_HandleTypeDef *hospi, uint32_t Threshold)
	Set OSPI Fifo threshold. More...

uint32_t	HAL_OSPI_GetFifoThreshold (OSPI_HandleTypeDef *hospi)
	Get OSPI Fifo threshold. More...

HAL_StatusTypeDef	HAL_OSPI_SetTimeout (OSPI_HandleTypeDef *hospi, uint32_t Timeout)
	Set OSPI timeout. More...

uint32_t	HAL_OSPI_GetError (OSPI_HandleTypeDef *hospi)
	Return the OSPI error code. More...

uint32_t	HAL_OSPI_GetState (OSPI_HandleTypeDef *hospi)
	Return the OSPI handle state. More...

HAL_StatusTypeDef	HAL_OSPIM_Config (OSPI_HandleTypeDef hospi, OSPIM_CfgTypeDef cfg, uint32_t Timeout)
	Configure the OctoSPI IO manager. More...

Variables
	C

Detailed Description

Header file of OSPI HAL module.

Author: MCD Application Team

Attention

© Copyright (c) 2018 STMicroelectronics. All rights reserved.

This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause

Definition in file stm32l4xx_hal_ospi.h.

Data Structure Documentation

◆ OSPI_RegularCmdTypeDef

struct OSPI_RegularCmdTypeDef

HAL OSPI Regular Command Structure definition.

Definition at line 120 of file stm32l4xx_hal_ospi.h.

Data Fields
uint32_t	Address
uint32_t	AddressDtrMode
uint32_t	AddressMode
uint32_t	AddressSize
uint32_t	AlternateBytes
uint32_t	AlternateBytesDtrMode
uint32_t	AlternateBytesMode
uint32_t	AlternateBytesSize
uint32_t	DataDtrMode
uint32_t	DataMode
uint32_t	DQSMode
uint32_t	DummyCycles
uint32_t	FlashId
uint32_t	Instruction
uint32_t	InstructionDtrMode
uint32_t	InstructionMode
uint32_t	InstructionSize
uint32_t	NbData
uint32_t	OperationType
uint32_t	SIOOMode

◆ OSPI_HyperbusCfgTypeDef

struct OSPI_HyperbusCfgTypeDef

HAL OSPI Hyperbus Configuration Structure definition.

Definition at line 171 of file stm32l4xx_hal_ospi.h.

Data Fields
uint32_t	AccessTime
uint32_t	LatencyMode
uint32_t	RWRecoveryTime
uint32_t	WriteZeroLatency

◆ OSPI_HyperbusCmdTypeDef

struct OSPI_HyperbusCmdTypeDef

HAL OSPI Hyperbus Command Structure definition.

Definition at line 186 of file stm32l4xx_hal_ospi.h.

Data Fields
uint32_t	Address
uint32_t	AddressSize
uint32_t	AddressSpace
uint32_t	DQSMode
uint32_t	NbData

◆ OSPI_AutoPollingTypeDef

struct OSPI_AutoPollingTypeDef

HAL OSPI Auto Polling mode configuration structure definition.

Definition at line 205 of file stm32l4xx_hal_ospi.h.

Data Fields
uint32_t	AutomaticStop
uint32_t	Interval
uint32_t	Mask
uint32_t	Match
uint32_t	MatchMode

◆ OSPI_MemoryMappedTypeDef

struct OSPI_MemoryMappedTypeDef

HAL OSPI Memory Mapped mode configuration structure definition.

Definition at line 222 of file stm32l4xx_hal_ospi.h.

Data Fields
uint32_t	TimeOutActivation
uint32_t	TimeOutPeriod

◆ OSPIM_CfgTypeDef

struct OSPIM_CfgTypeDef

HAL OSPI IO Manager Configuration structure definition.

Definition at line 233 of file stm32l4xx_hal_ospi.h.

Data Fields
uint32_t	ClkPort
uint32_t	DQSPort
uint32_t	IOHighPort
uint32_t	IOLowPort
uint32_t	NCSPort

Typedef Documentation

◆ OSPI_HandleTypeDef

typedef struct __OSPI_HandleTypeDef OSPI_HandleTypeDef

HAL OSPI Handle Structure definition.

◆ pOSPI_CallbackTypeDef

typedef void(* pOSPI_CallbackTypeDef) (OSPI_HandleTypeDef *hospi)

HAL OSPI Callback pointer definition.

Definition at line 271 of file stm32l4xx_hal_ospi.h.

Enumeration Type Documentation

◆ HAL_OSPI_CallbackIDTypeDef

enum HAL_OSPI_CallbackIDTypeDef

HAL OSPI Callback ID enumeration definition.

Enumerator
HAL_OSPI_ERROR_CB_ID	OSPI Error Callback ID
HAL_OSPI_ABORT_CB_ID	OSPI Abort Callback ID
HAL_OSPI_FIFO_THRESHOLD_CB_ID	OSPI FIFO Threshold Callback ID
HAL_OSPI_CMD_CPLT_CB_ID	OSPI Command Complete Callback ID
HAL_OSPI_RX_CPLT_CB_ID	OSPI Rx Complete Callback ID
HAL_OSPI_TX_CPLT_CB_ID	OSPI Tx Complete Callback ID
HAL_OSPI_RX_HALF_CPLT_CB_ID	OSPI Rx Half Complete Callback ID
HAL_OSPI_TX_HALF_CPLT_CB_ID	OSPI Tx Half Complete Callback ID
HAL_OSPI_STATUS_MATCH_CB_ID	OSPI Status Match Callback ID
HAL_OSPI_TIMEOUT_CB_ID	OSPI Timeout Callback ID
HAL_OSPI_MSP_INIT_CB_ID	OSPI MspInit Callback ID
HAL_OSPI_MSP_DEINIT_CB_ID	OSPI MspDeInit Callback ID

Definition at line 251 of file stm32l4xx_hal_ospi.h.

 {
   HAL_OSPI_ERROR_CB_ID          = 0x00U,  
   HAL_OSPI_ABORT_CB_ID          = 0x01U,  
   HAL_OSPI_FIFO_THRESHOLD_CB_ID = 0x02U,  
   HAL_OSPI_CMD_CPLT_CB_ID       = 0x03U,  
   HAL_OSPI_RX_CPLT_CB_ID        = 0x04U,  
   HAL_OSPI_TX_CPLT_CB_ID        = 0x05U,  
   HAL_OSPI_RX_HALF_CPLT_CB_ID   = 0x06U,  
   HAL_OSPI_TX_HALF_CPLT_CB_ID   = 0x07U,  
   HAL_OSPI_STATUS_MATCH_CB_ID   = 0x08U,  
   HAL_OSPI_TIMEOUT_CB_ID        = 0x09U,  
   HAL_OSPI_MSP_INIT_CB_ID       = 0x0AU,  
   HAL_OSPI_MSP_DEINIT_CB_ID     = 0x0BU   
 }HAL_OSPI_CallbackIDTypeDef;

Variable Documentation

◆ C

C

Data Structures

Typedefs

Enumerations

Functions

Variables