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_NAND_Reset (NAND_HandleTypeDef *hnand)
 NAND memory reset. More...
 
HAL_StatusTypeDef HAL_NAND_Read_Page_8b (NAND_HandleTypeDef *hnand, const NAND_AddressTypeDef *pAddress, uint8_t *pBuffer, uint32_t NumPageToRead)
 Read Page(s) from NAND memory block (8-bits addressing) More...
 
HAL_StatusTypeDef HAL_NAND_Write_Page_8b (NAND_HandleTypeDef *hnand, const NAND_AddressTypeDef *pAddress, const uint8_t *pBuffer, uint32_t NumPageToWrite)
 Write Page(s) to NAND memory block (8-bits addressing) More...
 
HAL_StatusTypeDef HAL_NAND_Read_SpareArea_8b (NAND_HandleTypeDef *hnand, const NAND_AddressTypeDef *pAddress, uint8_t *pBuffer, uint32_t NumSpareAreaToRead)
 Read Spare area(s) from NAND memory (8-bits addressing) More...
 
HAL_StatusTypeDef HAL_NAND_Write_SpareArea_8b (NAND_HandleTypeDef *hnand, const NAND_AddressTypeDef *pAddress, const uint8_t *pBuffer, uint32_t NumSpareAreaTowrite)
 Write Spare area(s) to NAND memory (8-bits addressing) More...
 
HAL_StatusTypeDef HAL_NAND_Read_Page_16b (NAND_HandleTypeDef *hnand, const NAND_AddressTypeDef *pAddress, uint16_t *pBuffer, uint32_t NumPageToRead)
 Read Page(s) from NAND memory block (16-bits addressing) More...
 
HAL_StatusTypeDef HAL_NAND_Write_Page_16b (NAND_HandleTypeDef *hnand, const NAND_AddressTypeDef *pAddress, const uint16_t *pBuffer, uint32_t NumPageToWrite)
 Write Page(s) to NAND memory block (16-bits addressing) More...
 
HAL_StatusTypeDef HAL_NAND_Read_SpareArea_16b (NAND_HandleTypeDef *hnand, const NAND_AddressTypeDef *pAddress, uint16_t *pBuffer, uint32_t NumSpareAreaToRead)
 Read Spare area(s) from NAND memory (16-bits addressing) More...
 
HAL_StatusTypeDef HAL_NAND_Write_SpareArea_16b (NAND_HandleTypeDef *hnand, const NAND_AddressTypeDef *pAddress, const uint16_t *pBuffer, uint32_t NumSpareAreaTowrite)
 Write Spare area(s) to NAND memory (16-bits addressing) More...
 
HAL_StatusTypeDef HAL_NAND_Erase_Block (NAND_HandleTypeDef *hnand, const NAND_AddressTypeDef *pAddress)
 NAND memory Block erase. More...
 
uint32_t HAL_NAND_Address_Inc (const NAND_HandleTypeDef *hnand, NAND_AddressTypeDef *pAddress)
 Increment the NAND memory address. More...
 
HAL_StatusTypeDef HAL_NAND_RegisterCallback (NAND_HandleTypeDef *hnand, HAL_NAND_CallbackIDTypeDef CallbackId, pNAND_CallbackTypeDef pCallback)
 Register a User NAND Callback To be used to override the weak predefined callback. More...
 
HAL_StatusTypeDef HAL_NAND_UnRegisterCallback (NAND_HandleTypeDef *hnand, HAL_NAND_CallbackIDTypeDef CallbackId)
 Unregister a User NAND Callback NAND Callback is redirected to the weak predefined callback. More...
 
HAL_StatusTypeDef HAL_NAND_Read_ID (NAND_HandleTypeDef *hnand, NAND_IDTypeDef *pNAND_ID)
 Read the NAND memory electronic signature. More...
 
HAL_StatusTypeDef HAL_NAND_ConfigDevice (NAND_HandleTypeDef *hnand, NAND_DeviceConfigTypeDef *pDeviceConfig)
 Configure the device: Enter the physical parameters of the device. More...
 

Detailed Description

Input Output and memory control functions.

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

Function Documentation

◆ HAL_NAND_Address_Inc()

uint32_t HAL_NAND_Address_Inc ( const NAND_HandleTypeDef hnand,
NAND_AddressTypeDef pAddress 
)

Increment the NAND memory address.

Parameters
hnandpointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.
pAddresspointer to NAND address structure
Return values
Thenew status of the increment address operation. It can be:
  • NAND_VALID_ADDRESS: When the new address is valid address
  • NAND_INVALID_ADDRESS: When the new address is invalid address

Definition at line 2024 of file stm32f4xx_hal_nand.c.

◆ HAL_NAND_ConfigDevice()

HAL_StatusTypeDef HAL_NAND_ConfigDevice ( NAND_HandleTypeDef hnand,
NAND_DeviceConfigTypeDef pDeviceConfig 
)

Configure the device: Enter the physical parameters of the device.

Parameters
hnandpointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.
pDeviceConfigpointer to NAND_DeviceConfigTypeDef structure
Return values
HALstatus

Definition at line 542 of file stm32f4xx_hal_nand.c.

◆ HAL_NAND_Erase_Block()

HAL_StatusTypeDef HAL_NAND_Erase_Block ( NAND_HandleTypeDef hnand,
const NAND_AddressTypeDef pAddress 
)

NAND memory Block erase.

Parameters
hnandpointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.
pAddresspointer to NAND address structure
Return values
HALstatus

Definition at line 1957 of file stm32f4xx_hal_nand.c.

◆ HAL_NAND_Read_ID()

HAL_StatusTypeDef HAL_NAND_Read_ID ( NAND_HandleTypeDef hnand,
NAND_IDTypeDef pNAND_ID 
)

Read the NAND memory electronic signature.

Parameters
hnandpointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.
pNAND_IDNAND ID structure
Return values
HALstatus

Definition at line 400 of file stm32f4xx_hal_nand.c.

◆ HAL_NAND_Read_Page_16b()

HAL_StatusTypeDef HAL_NAND_Read_Page_16b ( NAND_HandleTypeDef hnand,
const NAND_AddressTypeDef pAddress,
uint16_t *  pBuffer,
uint32_t  NumPageToRead 
)

Read Page(s) from NAND memory block (16-bits addressing)

Parameters
hnandpointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.
pAddresspointer to NAND address structure
pBufferpointer to destination read buffer. pBuffer should be 16bits aligned
NumPageToReadnumber of pages to read from block
Return values
HALstatus

Definition at line 733 of file stm32f4xx_hal_nand.c.

◆ HAL_NAND_Read_Page_8b()

HAL_StatusTypeDef HAL_NAND_Read_Page_8b ( NAND_HandleTypeDef hnand,
const NAND_AddressTypeDef pAddress,
uint8_t *  pBuffer,
uint32_t  NumPageToRead 
)

Read Page(s) from NAND memory block (8-bits addressing)

Parameters
hnandpointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.
pAddresspointer to NAND address structure
pBufferpointer to destination read buffer
NumPageToReadnumber of pages to read from block
Return values
HALstatus

Definition at line 564 of file stm32f4xx_hal_nand.c.

◆ HAL_NAND_Read_SpareArea_16b()

HAL_StatusTypeDef HAL_NAND_Read_SpareArea_16b ( NAND_HandleTypeDef hnand,
const NAND_AddressTypeDef pAddress,
uint16_t *  pBuffer,
uint32_t  NumSpareAreaToRead 
)

Read Spare area(s) from NAND memory (16-bits addressing)

Parameters
hnandpointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.
pAddresspointer to NAND address structure
pBufferpointer to source buffer to write. pBuffer should be 16bits aligned.
NumSpareAreaToReadNumber of spare area to read
Return values
HALstatus

Definition at line 1435 of file stm32f4xx_hal_nand.c.

◆ HAL_NAND_Read_SpareArea_8b()

HAL_StatusTypeDef HAL_NAND_Read_SpareArea_8b ( NAND_HandleTypeDef hnand,
const NAND_AddressTypeDef pAddress,
uint8_t *  pBuffer,
uint32_t  NumSpareAreaToRead 
)

Read Spare area(s) from NAND memory (8-bits addressing)

Parameters
hnandpointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.
pAddresspointer to NAND address structure
pBufferpointer to source buffer to write
NumSpareAreaToReadNumber of spare area to read
Return values
HALstatus

Definition at line 1259 of file stm32f4xx_hal_nand.c.

◆ HAL_NAND_RegisterCallback()

HAL_StatusTypeDef HAL_NAND_RegisterCallback ( NAND_HandleTypeDef hnand,
HAL_NAND_CallbackIDTypeDef  CallbackId,
pNAND_CallbackTypeDef  pCallback 
)

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

Parameters
hnand: NAND 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 2065 of file stm32f4xx_hal_nand.c.

◆ HAL_NAND_Reset()

HAL_StatusTypeDef HAL_NAND_Reset ( NAND_HandleTypeDef hnand)

NAND memory reset.

Parameters
hnandpointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.
Return values
HALstatus

Definition at line 486 of file stm32f4xx_hal_nand.c.

◆ HAL_NAND_UnRegisterCallback()

HAL_StatusTypeDef HAL_NAND_UnRegisterCallback ( NAND_HandleTypeDef hnand,
HAL_NAND_CallbackIDTypeDef  CallbackId 
)

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

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

Definition at line 2130 of file stm32f4xx_hal_nand.c.

◆ HAL_NAND_Write_Page_16b()

HAL_StatusTypeDef HAL_NAND_Write_Page_16b ( NAND_HandleTypeDef hnand,
const NAND_AddressTypeDef pAddress,
const uint16_t *  pBuffer,
uint32_t  NumPageToWrite 
)

Write Page(s) to NAND memory block (16-bits addressing)

Parameters
hnandpointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.
pAddresspointer to NAND address structure
pBufferpointer to source buffer to write. pBuffer should be 16bits aligned
NumPageToWritenumber of pages to write to block
Return values
HALstatus

Definition at line 1080 of file stm32f4xx_hal_nand.c.

◆ HAL_NAND_Write_Page_8b()

HAL_StatusTypeDef HAL_NAND_Write_Page_8b ( NAND_HandleTypeDef hnand,
const NAND_AddressTypeDef pAddress,
const uint8_t *  pBuffer,
uint32_t  NumPageToWrite 
)

Write Page(s) to NAND memory block (8-bits addressing)

Parameters
hnandpointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.
pAddresspointer to NAND address structure
pBufferpointer to source buffer to write
NumPageToWritenumber of pages to write to block
Return values
HALstatus

Definition at line 916 of file stm32f4xx_hal_nand.c.

◆ HAL_NAND_Write_SpareArea_16b()

HAL_StatusTypeDef HAL_NAND_Write_SpareArea_16b ( NAND_HandleTypeDef hnand,
const NAND_AddressTypeDef pAddress,
const uint16_t *  pBuffer,
uint32_t  NumSpareAreaTowrite 
)

Write Spare area(s) to NAND memory (16-bits addressing)

Parameters
hnandpointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.
pAddresspointer to NAND address structure
pBufferpointer to source buffer to write. pBuffer should be 16bits aligned.
NumSpareAreaTowritenumber of spare areas to write to block
Return values
HALstatus

Definition at line 1785 of file stm32f4xx_hal_nand.c.

◆ HAL_NAND_Write_SpareArea_8b()

HAL_StatusTypeDef HAL_NAND_Write_SpareArea_8b ( NAND_HandleTypeDef hnand,
const NAND_AddressTypeDef pAddress,
const uint8_t *  pBuffer,
uint32_t  NumSpareAreaTowrite 
)

Write Spare area(s) to NAND memory (8-bits addressing)

Parameters
hnandpointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.
pAddresspointer to NAND address structure
pBufferpointer to source buffer to write
NumSpareAreaTowritenumber of spare areas to write to block
Return values
HALstatus

Definition at line 1611 of file stm32f4xx_hal_nand.c.