STM32F479xx HAL User Manual
Functions
Input and Output functions
NOR Exported Functions

Input Output and memory control functions. More...

Functions

HAL_StatusTypeDef HAL_NOR_Read_ID (NOR_HandleTypeDef *hnor, NOR_IDTypeDef *pNOR_ID)
 Read NOR flash IDs.
HAL_StatusTypeDef HAL_NOR_ReturnToReadMode (NOR_HandleTypeDef *hnor)
 Returns the NOR memory to Read mode.
HAL_StatusTypeDef HAL_NOR_Read (NOR_HandleTypeDef *hnor, uint32_t *pAddress, uint16_t *pData)
 Read data from NOR memory.
HAL_StatusTypeDef HAL_NOR_Program (NOR_HandleTypeDef *hnor, uint32_t *pAddress, uint16_t *pData)
 Program data to NOR memory.
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.
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.
HAL_StatusTypeDef HAL_NOR_Erase_Block (NOR_HandleTypeDef *hnor, uint32_t BlockAddress, uint32_t Address)
 Erase the specified block of the NOR memory.
HAL_StatusTypeDef HAL_NOR_Erase_Chip (NOR_HandleTypeDef *hnor, uint32_t Address)
 Erase the entire NOR chip.
HAL_StatusTypeDef HAL_NOR_Read_CFI (NOR_HandleTypeDef *hnor, NOR_CFITypeDef *pNOR_CFI)
 Read NOR flash CFI IDs.
HAL_StatusTypeDef HAL_NOR_RegisterCallback (NOR_HandleTypeDef *hnor, HAL_NOR_CallbackIDTypeDef CallbackId, pNOR_CallbackTypeDef pCallback)
 Register a User NOR Callback To be used instead of the weak (surcharged) predefined callback.
HAL_StatusTypeDef HAL_NOR_UnRegisterCallback (NOR_HandleTypeDef *hnor, HAL_NOR_CallbackIDTypeDef CallbackId)
 Unregister a User NOR Callback NOR Callback is redirected to the weak (surcharged) predefined callback.

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_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 947 of file stm32f4xx_hal_nor.c.

References NOR_AMD_FUJITSU_COMMAND_SET, NOR_CMD_ADDRESS_FIFTH, NOR_CMD_ADDRESS_FIRST, NOR_CMD_ADDRESS_FOURTH, NOR_CMD_ADDRESS_SECOND, NOR_CMD_ADDRESS_THIRD, NOR_CMD_BLOCK_ERASE, NOR_CMD_BLOCK_UNLOCK, NOR_CMD_CONFIRM, NOR_CMD_DATA_BLOCK_ERASE, NOR_CMD_DATA_CHIP_BLOCK_ERASE_FIFTH, NOR_CMD_DATA_CHIP_BLOCK_ERASE_FOURTH, NOR_CMD_DATA_CHIP_BLOCK_ERASE_THIRD, NOR_CMD_DATA_FIRST, NOR_CMD_DATA_SECOND, NOR_INTEL_SHARP_EXT_COMMAND_SET, and uwNORMemoryDataWidth.

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 1031 of file stm32f4xx_hal_nor.c.

References NOR_AMD_FUJITSU_COMMAND_SET, NOR_CMD_ADDRESS_FIFTH, NOR_CMD_ADDRESS_FIRST, NOR_CMD_ADDRESS_FOURTH, NOR_CMD_ADDRESS_SECOND, NOR_CMD_ADDRESS_SIXTH, NOR_CMD_ADDRESS_THIRD, NOR_CMD_DATA_CHIP_BLOCK_ERASE_FIFTH, NOR_CMD_DATA_CHIP_BLOCK_ERASE_FOURTH, NOR_CMD_DATA_CHIP_BLOCK_ERASE_THIRD, NOR_CMD_DATA_CHIP_ERASE, NOR_CMD_DATA_FIRST, NOR_CMD_DATA_SECOND, and uwNORMemoryDataWidth.

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 661 of file stm32f4xx_hal_nor.c.

References NOR_AMD_FUJITSU_COMMAND_SET, NOR_CMD_ADDRESS_FIRST, NOR_CMD_ADDRESS_SECOND, NOR_CMD_ADDRESS_THIRD, NOR_CMD_DATA_FIRST, NOR_CMD_DATA_PROGRAM, NOR_CMD_DATA_SECOND, NOR_CMD_WORD_PROGRAM, NOR_INTEL_SHARP_EXT_COMMAND_SET, and uwNORMemoryDataWidth.

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 837 of file stm32f4xx_hal_nor.c.

References NOR_AMD_FUJITSU_COMMAND_SET, NOR_CMD_ADDRESS_FIRST, NOR_CMD_ADDRESS_SECOND, NOR_CMD_BUFFERED_PROGRAM, NOR_CMD_CONFIRM, NOR_CMD_DATA_BUFFER_AND_PROG, NOR_CMD_DATA_BUFFER_AND_PROG_CONFIRM, NOR_CMD_DATA_FIRST, NOR_CMD_DATA_SECOND, NOR_INTEL_SHARP_EXT_COMMAND_SET, and uwNORMemoryDataWidth.

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 578 of file stm32f4xx_hal_nor.c.

References NOR_AMD_FUJITSU_COMMAND_SET, NOR_CMD_ADDRESS_FIRST, NOR_CMD_ADDRESS_SECOND, NOR_CMD_ADDRESS_THIRD, NOR_CMD_DATA_FIRST, NOR_CMD_DATA_READ_RESET, NOR_CMD_DATA_SECOND, NOR_CMD_READ_ARRAY, NOR_INTEL_SHARP_EXT_COMMAND_SET, and uwNORMemoryDataWidth.

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 1108 of file stm32f4xx_hal_nor.c.

References NOR_CMD_ADDRESS_FIRST_CFI, NOR_CMD_DATA_CFI, and uwNORMemoryDataWidth.

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 417 of file stm32f4xx_hal_nor.c.

References NOR_AMD_FUJITSU_COMMAND_SET, NOR_CMD_ADDRESS_FIRST, NOR_CMD_ADDRESS_SECOND, NOR_CMD_ADDRESS_THIRD, NOR_CMD_DATA_AUTO_SELECT, NOR_CMD_DATA_FIRST, NOR_CMD_DATA_SECOND, NOR_INTEL_SHARP_EXT_COMMAND_SET, and uwNORMemoryDataWidth.

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 743 of file stm32f4xx_hal_nor.c.

References NOR_AMD_FUJITSU_COMMAND_SET, NOR_CMD_ADDRESS_FIRST, NOR_CMD_ADDRESS_SECOND, NOR_CMD_ADDRESS_THIRD, NOR_CMD_DATA_FIRST, NOR_CMD_DATA_READ_RESET, NOR_CMD_DATA_SECOND, NOR_CMD_READ_ARRAY, NOR_INTEL_SHARP_EXT_COMMAND_SET, and uwNORMemoryDataWidth.

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

Register a User NOR Callback To be used instead of the weak (surcharged) predefined callback.

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

Definition at line 1180 of file stm32f4xx_hal_nor.c.

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 504 of file stm32f4xx_hal_nor.c.

References NOR_AMD_FUJITSU_COMMAND_SET, NOR_CMD_DATA_READ_RESET, NOR_CMD_READ_ARRAY, and NOR_INTEL_SHARP_EXT_COMMAND_SET.

Referenced by HAL_NOR_Init().

HAL_StatusTypeDef HAL_NOR_UnRegisterCallback ( NOR_HandleTypeDef *  hnor,
HAL_NOR_CallbackIDTypeDef  CallbackId 
)

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

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

Definition at line 1232 of file stm32f4xx_hal_nor.c.

References HAL_NOR_MspDeInit(), and HAL_NOR_MspInit().