STM32F4xx_HAL_Driver  1.8.3
Input and Output functions

Input Output and memory control functions. More...

+ Collaboration diagram for Input and Output functions:

Functions

HAL_StatusTypeDef HAL_NOR_Read_ID (NOR_HandleTypeDef *hnor, NOR_IDTypeDef *pNOR_ID)
 Read NOR flash IDs. More...
 
HAL_StatusTypeDef HAL_NOR_ReturnToReadMode (NOR_HandleTypeDef *hnor)
 Returns the NOR memory to Read mode. More...
 
HAL_StatusTypeDef HAL_NOR_Read (NOR_HandleTypeDef *hnor, uint32_t *pAddress, uint16_t *pData)
 Read data from NOR memory. More...
 
HAL_StatusTypeDef HAL_NOR_Program (NOR_HandleTypeDef *hnor, uint32_t *pAddress, uint16_t *pData)
 Program data to NOR memory. More...
 
HAL_StatusTypeDef HAL_NOR_ReadBuffer (NOR_HandleTypeDef *hnor, uint32_t uwAddress, uint16_t *pData, uint32_t uwBufferSize)
 Reads a half-word buffer from the NOR memory. More...
 
HAL_StatusTypeDef HAL_NOR_ProgramBuffer (NOR_HandleTypeDef *hnor, uint32_t uwAddress, uint16_t *pData, uint32_t uwBufferSize)
 Writes a half-word buffer to the NOR memory. This function must be used only with S29GL128P NOR memory. More...
 
HAL_StatusTypeDef HAL_NOR_Erase_Block (NOR_HandleTypeDef *hnor, uint32_t BlockAddress, uint32_t Address)
 Erase the specified block of the NOR memory. More...
 
HAL_StatusTypeDef HAL_NOR_Erase_Chip (NOR_HandleTypeDef *hnor, uint32_t Address)
 Erase the entire NOR chip. More...
 
HAL_StatusTypeDef HAL_NOR_Read_CFI (NOR_HandleTypeDef *hnor, NOR_CFITypeDef *pNOR_CFI)
 Read NOR flash CFI IDs. More...
 
HAL_StatusTypeDef HAL_NOR_RegisterCallback (NOR_HandleTypeDef *hnor, HAL_NOR_CallbackIDTypeDef CallbackId, pNOR_CallbackTypeDef pCallback)
 Register a User NOR Callback To be used to override the weak predefined callback. More...
 
HAL_StatusTypeDef HAL_NOR_UnRegisterCallback (NOR_HandleTypeDef *hnor, HAL_NOR_CallbackIDTypeDef CallbackId)
 Unregister a User NOR Callback NOR Callback is redirected to the weak predefined callback. More...
 

Detailed Description

Input Output and memory control functions.

  ==============================================================================
                ##### NOR Input and Output functions #####
  ==============================================================================
  [..]
    This section provides functions allowing to use and control the NOR memory

Function Documentation

◆ HAL_NOR_Erase_Block()

HAL_StatusTypeDef HAL_NOR_Erase_Block ( NOR_HandleTypeDef hnor,
uint32_t  BlockAddress,
uint32_t  Address 
)

Erase the specified block of the NOR memory.

Parameters
hnorpointer to a NOR_HandleTypeDef structure that contains the configuration information for NOR module.
BlockAddressBlock to erase address
AddressDevice address
Return values
HALstatus

Definition at line 1052 of file stm32f4xx_hal_nor.c.

◆ HAL_NOR_Erase_Chip()

HAL_StatusTypeDef HAL_NOR_Erase_Chip ( NOR_HandleTypeDef hnor,
uint32_t  Address 
)

Erase the entire NOR chip.

Parameters
hnorpointer to a NOR_HandleTypeDef structure that contains the configuration information for NOR module.
AddressDevice address
Return values
HALstatus

Definition at line 1148 of file stm32f4xx_hal_nor.c.

◆ HAL_NOR_Program()

HAL_StatusTypeDef HAL_NOR_Program ( NOR_HandleTypeDef hnor,
uint32_t *  pAddress,
uint16_t *  pData 
)

Program data to NOR memory.

Parameters
hnorpointer to a NOR_HandleTypeDef structure that contains the configuration information for NOR module.
pAddressDevice address
pDatapointer to the data to write
Return values
HALstatus

Definition at line 727 of file stm32f4xx_hal_nor.c.

◆ HAL_NOR_ProgramBuffer()

HAL_StatusTypeDef HAL_NOR_ProgramBuffer ( NOR_HandleTypeDef hnor,
uint32_t  uwAddress,
uint16_t *  pData,
uint32_t  uwBufferSize 
)

Writes a half-word buffer to the NOR memory. This function must be used only with S29GL128P NOR memory.

Parameters
hnorpointer to the NOR handle
uwAddressNOR memory internal start write address
pDatapointer to source data buffer.
uwBufferSizeSize of the buffer to write
Return values
HALstatus

Definition at line 932 of file stm32f4xx_hal_nor.c.

◆ HAL_NOR_Read()

HAL_StatusTypeDef HAL_NOR_Read ( NOR_HandleTypeDef hnor,
uint32_t *  pAddress,
uint16_t *  pData 
)

Read data from NOR memory.

Parameters
hnorpointer to a NOR_HandleTypeDef structure that contains the configuration information for NOR module.
pAddresspointer to Device address
pDatapointer to read data
Return values
HALstatus

Definition at line 627 of file stm32f4xx_hal_nor.c.

◆ HAL_NOR_Read_CFI()

HAL_StatusTypeDef HAL_NOR_Read_CFI ( NOR_HandleTypeDef hnor,
NOR_CFITypeDef pNOR_CFI 
)

Read NOR flash CFI IDs.

Parameters
hnorpointer to a NOR_HandleTypeDef structure that contains the configuration information for NOR module.
pNOR_CFIpointer to NOR CFI IDs structure
Return values
HALstatus

Definition at line 1238 of file stm32f4xx_hal_nor.c.

◆ HAL_NOR_Read_ID()

HAL_StatusTypeDef HAL_NOR_Read_ID ( NOR_HandleTypeDef hnor,
NOR_IDTypeDef pNOR_ID 
)

Read NOR flash IDs.

Parameters
hnorpointer to a NOR_HandleTypeDef structure that contains the configuration information for NOR module.
pNOR_IDpointer to NOR ID structure
Return values
HALstatus

Definition at line 445 of file stm32f4xx_hal_nor.c.

◆ HAL_NOR_ReadBuffer()

HAL_StatusTypeDef HAL_NOR_ReadBuffer ( NOR_HandleTypeDef hnor,
uint32_t  uwAddress,
uint16_t *  pData,
uint32_t  uwBufferSize 
)

Reads a half-word buffer from the NOR memory.

Parameters
hnorpointer to the NOR handle
uwAddressNOR memory internal address to read from.
pDatapointer to the buffer that receives the data read from the NOR memory.
uwBufferSizenumber of Half word to read.
Return values
HALstatus

Definition at line 821 of file stm32f4xx_hal_nor.c.

◆ HAL_NOR_RegisterCallback()

HAL_StatusTypeDef HAL_NOR_RegisterCallback ( NOR_HandleTypeDef hnor,
HAL_NOR_CallbackIDTypeDef  CallbackId,
pNOR_CallbackTypeDef  pCallback 
)

Register a User NOR Callback To be used to override the weak predefined callback.

Parameters
hnor: NOR handle
CallbackId: ID of the callback to be registered This parameter can be one of the following values:
pCallback: pointer to the Callback function
Return values
status

Definition at line 1321 of file stm32f4xx_hal_nor.c.

◆ HAL_NOR_ReturnToReadMode()

HAL_StatusTypeDef HAL_NOR_ReturnToReadMode ( NOR_HandleTypeDef hnor)

Returns the NOR memory to Read mode.

Parameters
hnorpointer to a NOR_HandleTypeDef structure that contains the configuration information for NOR module.
Return values
HALstatus

Definition at line 549 of file stm32f4xx_hal_nor.c.

◆ HAL_NOR_UnRegisterCallback()

HAL_StatusTypeDef HAL_NOR_UnRegisterCallback ( NOR_HandleTypeDef hnor,
HAL_NOR_CallbackIDTypeDef  CallbackId 
)

Unregister a User NOR Callback NOR Callback is redirected to the weak predefined callback.

Parameters
hnor: NOR handle
CallbackId: ID of the callback to be unregistered This parameter can be one of the following values:
Return values
status

Definition at line 1368 of file stm32f4xx_hal_nor.c.