STM32H735xx HAL User Manual: stm32h7xx_hal

NAND HAL module driver. This file provides a generic firmware to drive NAND memories mounted as external device. More...

#include "stm32h7xx_hal.h"

Go to the source code of this file.

Functions
HAL_StatusTypeDef	HAL_NAND_Init (NAND_HandleTypeDef hnand, FMC_NAND_PCC_TimingTypeDef ComSpace_Timing, FMC_NAND_PCC_TimingTypeDef *AttSpace_Timing)
	Perform NAND memory Initialization sequence.
HAL_StatusTypeDef	HAL_NAND_DeInit (NAND_HandleTypeDef *hnand)
	Perform NAND memory De-Initialization sequence.
__weak void	HAL_NAND_MspInit (NAND_HandleTypeDef *hnand)
	NAND MSP Init.
__weak void	HAL_NAND_MspDeInit (NAND_HandleTypeDef *hnand)
	NAND MSP DeInit.
void	HAL_NAND_IRQHandler (NAND_HandleTypeDef *hnand)
	This function handles NAND device interrupt request.
__weak void	HAL_NAND_ITCallback (NAND_HandleTypeDef *hnand)
	NAND interrupt feature callback.
HAL_StatusTypeDef	HAL_NAND_Read_ID (NAND_HandleTypeDef hnand, NAND_IDTypeDef pNAND_ID)
	Read the NAND memory electronic signature.
HAL_StatusTypeDef	HAL_NAND_Reset (NAND_HandleTypeDef *hnand)
	NAND memory reset.
HAL_StatusTypeDef	HAL_NAND_ConfigDevice (NAND_HandleTypeDef hnand, NAND_DeviceConfigTypeDef pDeviceConfig)
	Configure the device: Enter the physical parameters of the device.
HAL_StatusTypeDef	HAL_NAND_Read_Page_8b (NAND_HandleTypeDef hnand, NAND_AddressTypeDef pAddress, uint8_t *pBuffer, uint32_t NumPageToRead)
	Read Page(s) from NAND memory block (8-bits addressing)
HAL_StatusTypeDef	HAL_NAND_Read_Page_16b (NAND_HandleTypeDef hnand, NAND_AddressTypeDef pAddress, uint16_t *pBuffer, uint32_t NumPageToRead)
	Read Page(s) from NAND memory block (16-bits addressing)
HAL_StatusTypeDef	HAL_NAND_Write_Page_8b (NAND_HandleTypeDef hnand, NAND_AddressTypeDef pAddress, uint8_t *pBuffer, uint32_t NumPageToWrite)
	Write Page(s) to NAND memory block (8-bits addressing)
HAL_StatusTypeDef	HAL_NAND_Write_Page_16b (NAND_HandleTypeDef hnand, NAND_AddressTypeDef pAddress, uint16_t *pBuffer, uint32_t NumPageToWrite)
	Write Page(s) to NAND memory block (16-bits addressing)
HAL_StatusTypeDef	HAL_NAND_Read_SpareArea_8b (NAND_HandleTypeDef hnand, NAND_AddressTypeDef pAddress, uint8_t *pBuffer, uint32_t NumSpareAreaToRead)
	Read Spare area(s) from NAND memory (8-bits addressing)
HAL_StatusTypeDef	HAL_NAND_Read_SpareArea_16b (NAND_HandleTypeDef hnand, NAND_AddressTypeDef pAddress, uint16_t *pBuffer, uint32_t NumSpareAreaToRead)
	Read Spare area(s) from NAND memory (16-bits addressing)
HAL_StatusTypeDef	HAL_NAND_Write_SpareArea_8b (NAND_HandleTypeDef hnand, NAND_AddressTypeDef pAddress, uint8_t *pBuffer, uint32_t NumSpareAreaTowrite)
	Write Spare area(s) to NAND memory (8-bits addressing)
HAL_StatusTypeDef	HAL_NAND_Write_SpareArea_16b (NAND_HandleTypeDef hnand, NAND_AddressTypeDef pAddress, uint16_t *pBuffer, uint32_t NumSpareAreaTowrite)
	Write Spare area(s) to NAND memory (16-bits addressing)
HAL_StatusTypeDef	HAL_NAND_Erase_Block (NAND_HandleTypeDef hnand, NAND_AddressTypeDef pAddress)
	NAND memory Block erase.
uint32_t	HAL_NAND_Address_Inc (NAND_HandleTypeDef hnand, NAND_AddressTypeDef pAddress)
	Increment the NAND memory address.
HAL_StatusTypeDef	HAL_NAND_RegisterCallback (NAND_HandleTypeDef *hnand, HAL_NAND_CallbackIDTypeDef CallbackId, pNAND_CallbackTypeDef pCallback)
	Register a User NAND Callback To be used instead of the weak (surcharged) predefined callback.
HAL_StatusTypeDef	HAL_NAND_UnRegisterCallback (NAND_HandleTypeDef *hnand, HAL_NAND_CallbackIDTypeDef CallbackId)
	Unregister a User NAND Callback NAND Callback is redirected to the weak (surcharged) predefined callback.
HAL_StatusTypeDef	HAL_NAND_ECC_Enable (NAND_HandleTypeDef *hnand)
	Enables dynamically NAND ECC feature.
HAL_StatusTypeDef	HAL_NAND_ECC_Disable (NAND_HandleTypeDef *hnand)
	Disables dynamically FMC_NAND ECC feature.
HAL_StatusTypeDef	HAL_NAND_GetECC (NAND_HandleTypeDef hnand, uint32_t ECCval, uint32_t Timeout)
	Disables dynamically NAND ECC feature.
HAL_NAND_StateTypeDef	HAL_NAND_GetState (NAND_HandleTypeDef *hnand)
	return the NAND state
uint32_t	HAL_NAND_Read_Status (NAND_HandleTypeDef *hnand)
	NAND memory read status.

Detailed Description

NAND HAL module driver. This file provides a generic firmware to drive NAND memories mounted as external device.

Author:: MCD Application Team

Attention:

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

  ==============================================================================
                         ##### How to use this driver #####
  ==============================================================================
    [..]
      This driver is a generic layered driver which contains a set of APIs used to
      control NAND flash memories. It uses the FMC layer functions to interface
      with NAND devices. This driver is used as follows:

      (+) NAND flash memory configuration sequence using the function HAL_NAND_Init()
          with control and timing parameters for both common and attribute spaces.

      (+) Read NAND flash memory maker and device IDs using the function
          HAL_NAND_Read_ID(). The read information is stored in the NAND_ID_TypeDef
          structure declared by the function caller.

      (+) Access NAND flash memory by read/write operations using the functions
          HAL_NAND_Read_Page_8b()/HAL_NAND_Read_SpareArea_8b(),
          HAL_NAND_Write_Page_8b()/HAL_NAND_Write_SpareArea_8b(),
          HAL_NAND_Read_Page_16b()/HAL_NAND_Read_SpareArea_16b(),
          HAL_NAND_Write_Page_16b()/HAL_NAND_Write_SpareArea_16b()
          to read/write page(s)/spare area(s). These functions use specific device
          information (Block, page size..) predefined by the user in the NAND_DeviceConfigTypeDef
          structure. The read/write address information is contained by the Nand_Address_Typedef
          structure passed as parameter.

      (+) Perform NAND flash Reset chip operation using the function HAL_NAND_Reset().

      (+) Perform NAND flash erase block operation using the function HAL_NAND_Erase_Block().
          The erase block address information is contained in the Nand_Address_Typedef
          structure passed as parameter.

      (+) Read the NAND flash status operation using the function HAL_NAND_Read_Status().

      (+) You can also control the NAND device by calling the control APIs HAL_NAND_ECC_Enable()/
          HAL_NAND_ECC_Disable() to respectively enable/disable the ECC code correction
          feature or the function HAL_NAND_GetECC() to get the ECC correction code.

      (+) You can monitor the NAND device HAL state by calling the function
          HAL_NAND_GetState()

    [..]
      (@) This driver is a set of generic APIs which handle standard NAND flash operations.
          If a NAND flash device contains different operations and/or implementations,
          it should be implemented separately.

    *** Callback registration ***
    =============================================
    [..]
      The compilation define  USE_HAL_NAND_REGISTER_CALLBACKS when set to 1
      allows the user to configure dynamically the driver callbacks.

      Use Functions HAL_NAND_RegisterCallback() to register a user callback,
      it allows to register following callbacks:
        (+) MspInitCallback    : NAND MspInit.
        (+) MspDeInitCallback  : NAND MspDeInit.
      This function takes as parameters the HAL peripheral handle, the Callback ID
      and a pointer to the user callback function.

      Use function HAL_NAND_UnRegisterCallback() to reset a callback to the default
      weak (surcharged) function. It allows to reset following callbacks:
        (+) MspInitCallback    : NAND MspInit.
        (+) MspDeInitCallback  : NAND MspDeInit.
      This function) takes as parameters the HAL peripheral handle and the Callback ID.

      By default, after the HAL_NAND_Init and if the state is HAL_NAND_STATE_RESET
      all callbacks are reset to the corresponding legacy weak (surcharged) functions.
      Exception done for MspInit and MspDeInit callbacks that are respectively
      reset to the legacy weak (surcharged) functions in the HAL_NAND_Init
      and  HAL_NAND_DeInit only when these callbacks are null (not registered beforehand).
      If not, MspInit or MspDeInit are not null, the HAL_NAND_Init and HAL_NAND_DeInit
      keep and use the user MspInit/MspDeInit callbacks (registered beforehand)

      Callbacks can be registered/unregistered in READY state only.
      Exception done for MspInit/MspDeInit callbacks that can be registered/unregistered
      in READY or RESET state, thus registered (user) MspInit/DeInit callbacks can be used
      during the Init/DeInit.
      In that case first register the MspInit/MspDeInit user callbacks
      using HAL_NAND_RegisterCallback before calling HAL_NAND_DeInit
      or HAL_NAND_Init function.

      When The compilation define USE_HAL_NAND_REGISTER_CALLBACKS is set to 0 or
      not defined, the callback registering feature is not available
      and weak (surcharged) callbacks are used.

Definition in file stm32h7xx_hal_nand.c.