STM32F439xx HAL User Manual: stm32f4xx_hal

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

#include "stm32f4xx_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.
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.
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_Read_Status (NAND_HandleTypeDef *hnand)
	NAND memory read status.
uint32_t	HAL_NAND_Address_Inc (NAND_HandleTypeDef hnand, NAND_AddressTypeDef pAddress)
	Increment the NAND memory address.
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

Detailed Description

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

Author:

MCD Application Team

  ==============================================================================
                         ##### 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/FSMC 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 HAL_NAND_Info_TypeDef 
          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.

Attention:

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file stm32f4xx_hal_nand.c.

Functions

Detailed Description

© COPYRIGHT(c) 2017 STMicroelectronics