Initialization and de-initialization functions

Initialization and Configuration functions. More...

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. More...
HAL_StatusTypeDef	HAL_NAND_DeInit (NAND_HandleTypeDef *hnand)
	Perform NAND memory De-Initialization sequence. More...
HAL_StatusTypeDef	HAL_NAND_ConfigDevice (NAND_HandleTypeDef *hnand, NAND_DeviceConfigTypeDef *pDeviceConfig)
	Configure the device: Enter the physical parameters of the device. More...
HAL_StatusTypeDef	HAL_NAND_Read_ID (NAND_HandleTypeDef *hnand, NAND_IDTypeDef *pNAND_ID)
	Read the NAND memory electronic signature. More...
void	HAL_NAND_MspInit (NAND_HandleTypeDef *hnand)
	Initialize the NAND MSP. More...
void	HAL_NAND_MspDeInit (NAND_HandleTypeDef *hnand)
	DeInitialize the NAND MSP. More...
void	HAL_NAND_IRQHandler (NAND_HandleTypeDef *hnand)
	This function handles NAND device interrupt request. More...
void	HAL_NAND_ITCallback (NAND_HandleTypeDef *hnand)
	NAND interrupt feature callback. More...

Detailed Description

Initialization and Configuration functions.

  ==============================================================================
            ##### NAND Initialization and de-initialization functions #####
  ==============================================================================
  [..]
    This section provides functions allowing to initialize/de-initialize
    the NAND memory

Function Documentation

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

hnand	pointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.
pDeviceConfig	pointer to NAND_DeviceConfigTypeDef structure

Return values

HAL

status

Definition at line 406 of file stm32l4xx_hal_nand.c.

{
  hnand->Config.PageSize           = pDeviceConfig->PageSize;
  hnand->Config.SpareAreaSize      = pDeviceConfig->SpareAreaSize;
  hnand->Config.BlockSize          = pDeviceConfig->BlockSize;
  hnand->Config.BlockNbr           = pDeviceConfig->BlockNbr;
  hnand->Config.PlaneSize          = pDeviceConfig->PlaneSize;
  hnand->Config.PlaneNbr           = pDeviceConfig->PlaneNbr;
  hnand->Config.ExtraCommandEnable = pDeviceConfig->ExtraCommandEnable;

  return HAL_OK;
}

HAL_NAND_DeInit()

HAL_StatusTypeDef HAL_NAND_DeInit

(

NAND_HandleTypeDef *

hnand

)

Perform NAND memory De-Initialization sequence.

Parameters

hnand

pointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.

Return values

HAL

status

Definition at line 160 of file stm32l4xx_hal_nand.c.

{
  /* Initialize the low level hardware (MSP) */
  HAL_NAND_MspDeInit(hnand);

  /* Configure the NAND registers with their reset values */
  FMC_NAND_DeInit(hnand->Instance, hnand->Init.NandBank);

  /* Reset the NAND controller state */
  hnand->State = HAL_NAND_STATE_RESET;

  /* Release Lock */
  __HAL_UNLOCK(hnand);

  return HAL_OK;
}

HAL_NAND_Init()

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.

Parameters

hnand	pointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.
ComSpace_Timing	pointer to Common space timing structure
AttSpace_Timing	pointer to Attribute space timing structure

Return values

HAL

status

Definition at line 120 of file stm32l4xx_hal_nand.c.

{
  /* Check the NAND handle state */
  if(hnand == NULL)
  {
     return HAL_ERROR;
  }

  if(hnand->State == HAL_NAND_STATE_RESET)
  {
    /* Allocate lock resource and initialize it */
    hnand->Lock = HAL_UNLOCKED;
    /* Initialize the low level hardware (MSP) */
    HAL_NAND_MspInit(hnand);
  }

  /* Initialize NAND control Interface */
  FMC_NAND_Init(hnand->Instance, &(hnand->Init));

  /* Initialize NAND common space timing Interface */
  FMC_NAND_CommonSpace_Timing_Init(hnand->Instance, ComSpace_Timing, hnand->Init.NandBank);

  /* Initialize NAND attribute space timing Interface */
  FMC_NAND_AttributeSpace_Timing_Init(hnand->Instance, AttSpace_Timing, hnand->Init.NandBank);

  /* Enable the NAND device */
  __FMC_NAND_ENABLE(hnand->Instance);

  /* Update the NAND controller state */
  hnand->State = HAL_NAND_STATE_READY;

  return HAL_OK;
}

HAL_NAND_IRQHandler()

void HAL_NAND_IRQHandler

(

NAND_HandleTypeDef *

hnand

)

This function handles NAND device interrupt request.

Parameters

hnand

pointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.

Return values

HAL

status

Definition at line 216 of file stm32l4xx_hal_nand.c.

{
  /* Check NAND interrupt Rising edge flag */
  if(__FMC_NAND_GET_FLAG(hnand->Instance, hnand->Init.NandBank, FMC_FLAG_RISING_EDGE))
  {
    /* NAND interrupt callback*/
    HAL_NAND_ITCallback(hnand);

    /* Clear NAND interrupt Rising edge pending bit */
    __FMC_NAND_CLEAR_FLAG(hnand->Instance, FMC_FLAG_RISING_EDGE);
  }

  /* Check NAND interrupt Level flag */
  if(__FMC_NAND_GET_FLAG(hnand->Instance, hnand->Init.NandBank, FMC_FLAG_LEVEL))
  {
    /* NAND interrupt callback*/
    HAL_NAND_ITCallback(hnand);

    /* Clear NAND interrupt Level pending bit */
    __FMC_NAND_CLEAR_FLAG(hnand->Instance, FMC_FLAG_LEVEL);
  }

  /* Check NAND interrupt Falling edge flag */
  if(__FMC_NAND_GET_FLAG(hnand->Instance, hnand->Init.NandBank, FMC_FLAG_FALLING_EDGE))
  {
    /* NAND interrupt callback*/
    HAL_NAND_ITCallback(hnand);

    /* Clear NAND interrupt Falling edge pending bit */
    __FMC_NAND_CLEAR_FLAG(hnand->Instance, FMC_FLAG_FALLING_EDGE);
  }

  /* Check NAND interrupt FIFO empty flag */
  if(__FMC_NAND_GET_FLAG(hnand->Instance, hnand->Init.NandBank, FMC_FLAG_FEMPT))
  {
    /* NAND interrupt callback*/
    HAL_NAND_ITCallback(hnand);

    /* Clear NAND interrupt FIFO empty pending bit */
    __FMC_NAND_CLEAR_FLAG(hnand->Instance, FMC_FLAG_FEMPT);
  }

}

HAL_NAND_ITCallback()

__weak void HAL_NAND_ITCallback

(

NAND_HandleTypeDef *

hnand

)

NAND interrupt feature callback.

Parameters

hnand

pointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.

Return values

None

Definition at line 266 of file stm32l4xx_hal_nand.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hnand);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_NAND_ITCallback could be implemented in the user file
   */
}

HAL_NAND_MspDeInit()

__weak void HAL_NAND_MspDeInit

(

NAND_HandleTypeDef *

hnand

)

DeInitialize the NAND MSP.

Parameters

hnand

pointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.

Return values

None

Definition at line 199 of file stm32l4xx_hal_nand.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hnand);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_NAND_MspDeInit could be implemented in the user file
   */
}

HAL_NAND_MspInit()

__weak void HAL_NAND_MspInit

(

NAND_HandleTypeDef *

hnand

)

Initialize the NAND MSP.

Parameters

hnand

pointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.

Return values

None

Definition at line 183 of file stm32l4xx_hal_nand.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hnand);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_NAND_MspInit could be implemented in the user file
   */
}

HAL_NAND_Read_ID()

HAL_StatusTypeDef HAL_NAND_Read_ID	(	NAND_HandleTypeDef *	hnand,
		NAND_IDTypeDef *	pNAND_ID
	)

Read the NAND memory electronic signature.

Parameters

hnand	pointer to a NAND_HandleTypeDef structure that contains the configuration information for NAND module.
pNAND_ID	NAND ID structure

Return values

HAL

status

Definition at line 302 of file stm32l4xx_hal_nand.c.

{
  __IO uint32_t data = 0;
  __IO uint32_t data1 = 0;
  uint32_t deviceAddress = 0;

  /* Process Locked */
  __HAL_LOCK(hnand);

  /* Check the NAND controller state */
  if(hnand->State == HAL_NAND_STATE_BUSY)
  {
     return HAL_BUSY;
  }

  /* Identify the device address */
  deviceAddress = NAND_DEVICE;

  /* Update the NAND controller state */
  hnand->State = HAL_NAND_STATE_BUSY;

  /* Send Read ID command sequence */
  *(__IO uint8_t *)((uint32_t)(deviceAddress | CMD_AREA))  = NAND_CMD_READID;
  __DSB();
  *(__IO uint8_t *)((uint32_t)(deviceAddress | ADDR_AREA)) = 0x00;
  __DSB();

  /* Read the electronic signature from NAND flash */
  if (hnand->Init.MemoryDataWidth == FMC_NAND_MEM_BUS_WIDTH_8)
  {
    data = *(__IO uint32_t *)deviceAddress;

    /* Return the data read */
    pNAND_ID->Maker_Id   = ADDR_1ST_CYCLE(data);
    pNAND_ID->Device_Id  = ADDR_2ND_CYCLE(data);
    pNAND_ID->Third_Id   = ADDR_3RD_CYCLE(data);
    pNAND_ID->Fourth_Id  = ADDR_4TH_CYCLE(data);
  }
  else
  {
    data = *(__IO uint32_t *)deviceAddress;
    data1 = *((__IO uint32_t *)deviceAddress + 4);

    /* Return the data read */
    pNAND_ID->Maker_Id   = ADDR_1ST_CYCLE(data);
    pNAND_ID->Device_Id  = ADDR_3RD_CYCLE(data);
    pNAND_ID->Third_Id   = ADDR_1ST_CYCLE(data1);
    pNAND_ID->Fourth_Id  = ADDR_3RD_CYCLE(data1);
  }

  /* Update the NAND controller state */
  hnand->State = HAL_NAND_STATE_READY;

  /* Process unlocked */
  __HAL_UNLOCK(hnand);

  return HAL_OK;
}