File System Component  Version 6.9
MDK Middleware for Devices with Flash File System
 All Data Structures Files Functions Variables Enumerations Enumerator Macros Groups Pages
FsNAND: NAND Device Interface

Events generated by File System - NAND Flash Device Interface functions. More...

Functions

__STATIC_INLINE void EvrFsNAND_Init (uint32_t instance)
 Event on NAND media layer initialization (Op) More...
 
__STATIC_INLINE void EvrFsNAND_InitComplete (uint32_t instance, uint32_t status)
 Event on NAND media layer initialization completion (Op) More...
 
__STATIC_INLINE void EvrFsNAND_InitDriver (uint32_t instance, uint32_t driver)
 Event on NAND driver initialization (Op) More...
 
__STATIC_INLINE void EvrFsNAND_InitDriverError (uint32_t instance, uint32_t driver)
 Event on NAND driver initialization error (Error) More...
 
__STATIC_INLINE void EvrFsNAND_DriverPowerCtrlError (uint32_t instance, uint32_t driver, uint32_t state)
 Event on NAND driver initialization error (Error) More...
 
__STATIC_INLINE void EvrFsNAND_DriverBusModeSelect (uint32_t instance, uint32_t driver, uint32_t mode)
 Event on NAND driver initialization error (Error) More...
 
__STATIC_INLINE void EvrFsNAND_DriverBusWidthSelect (uint32_t instance, uint32_t driver, uint32_t width)
 Event on NAND driver initialization error (Error) More...
 
__STATIC_INLINE void EvrFsNAND_DriverBusWidthError (uint32_t instance, uint32_t driver, uint32_t width)
 Event on NAND driver initialization error (Error) More...
 
__STATIC_INLINE void EvrFsNAND_DriverDevPowerSelect (uint32_t instance, uint32_t driver, uint32_t volt)
 Event on NAND device voltage change (Op) More...
 
__STATIC_INLINE void EvrFsNAND_DriverEccInquire (uint32_t instance, uint32_t driver)
 Event on NAND driver ECC inquiry (Op) More...
 
__STATIC_INLINE void EvrFsNAND_DriverEccSelect (uint32_t instance, uint32_t driver, uint32_t index)
 Event on NAND driver ECC selection (Op) More...
 
__STATIC_INLINE void EvrFsNAND_DriverEccInquireError (uint32_t instance, uint32_t driver)
 Event on NAND driver ECC inquiry error (Op) More...
 
__STATIC_INLINE void EvrFsNAND_DriverTimeoutError (uint32_t instance, uint32_t driver)
 Event on NAND driver timeout error (Error) More...
 
__STATIC_INLINE void EvrFsNAND_DeviceTimeoutError (uint32_t instance, uint32_t driver, uint32_t device)
 Event on NAND device timeout error (Error) More...
 
__STATIC_INLINE void EvrFsNAND_Uninit (uint32_t instance)
 Event on NAND media layer uninitialization (Op) More...
 
__STATIC_INLINE void EvrFsNAND_UninitComplete (uint32_t instance, uint32_t status)
 Event on NAND media layer uninitialization completion (Op) More...
 
__STATIC_INLINE void EvrFsNAND_ReadStatus (uint32_t instance)
 Event on NAND device status read operation (Detail) More...
 
__STATIC_INLINE void EvrFsNAND_ReadStatusComplete (uint32_t instance, uint32_t status)
 Event on NAND device status read operation completion (Op) More...
 
__STATIC_INLINE void EvrFsNAND_EraseBlock (uint32_t instance, uint32_t row)
 Event on NAND erase block operation (Op) More...
 
__STATIC_INLINE void EvrFsNAND_EraseBlockComplete (uint32_t instance, uint32_t status)
 Event on NAND erase block operation completion (Op) More...
 
__STATIC_INLINE void EvrFsNAND_PageWrite (uint32_t instance, uint32_t row, uint32_t col, uint32_t len)
 Event on NAND page write operation (Op) More...
 
__STATIC_INLINE void EvrFsNAND_PageWriteComplete (uint32_t instance, uint32_t status)
 Event on NAND page write operation completion (Op) More...
 
__STATIC_INLINE void EvrFsNAND_PageRead (uint32_t instance, uint32_t row, uint32_t col, uint32_t len)
 Event on NAND page read operation (Op) More...
 
__STATIC_INLINE void EvrFsNAND_PageReadComplete (uint32_t instance, uint32_t status)
 Event on NAND page read operation completion (Op) More...
 
__STATIC_INLINE void EvrFsNAND_ParamPageRead (uint32_t instance, uint32_t col, uint32_t len)
 Event on NAND parameter page read operation (Op) More...
 
__STATIC_INLINE void EvrFsNAND_ParamPageReadComplete (uint32_t instance, uint32_t status)
 Event on NAND parameter page read operation completion (Op) More...
 
__STATIC_INLINE void EvrFsNAND_IdRead (uint32_t instance, uint32_t addr, uint32_t len)
 Event on NAND device ID read operation (Op) More...
 
__STATIC_INLINE void EvrFsNAND_IdReadComplete (uint32_t instance, uint32_t status)
 Event on NAND device ID read operation completion (Op) More...
 
__STATIC_INLINE void EvrFsNAND_ResetDevice (uint32_t instance)
 Event on NAND device reset operation (Op) More...
 
__STATIC_INLINE void EvrFsNAND_ResetDeviceComplete (uint32_t instance, uint32_t status)
 Event on NAND device reset operation completion (Op) More...
 

Description

Events generated by File System - NAND Flash Device Interface functions.

FileSystem - NAND Flash Device Interface

Function Documentation

__STATIC_INLINE void EvrFsNAND_DeviceTimeoutError ( uint32_t  instance,
uint32_t  driver,
uint32_t  device 
)

Event on NAND device timeout error (Error)

Parameters
[in]instanceNAND media layer instance
[in]driverCMSIS NAND driver control block address
[in]deviceNAND device number

The event DeviceTimeoutError is generated when a function fails to access a device on time. Usually, the device is busy.

Value in the Event Recorder shows:

  • instance : number of Software Component driver instance.
  • driver : name of Software Component driver.
  • device : name of device.
__STATIC_INLINE void EvrFsNAND_DriverBusModeSelect ( uint32_t  instance,
uint32_t  driver,
uint32_t  mode 
)

Event on NAND driver initialization error (Error)

Parameters
[in]instanceNAND media layer instance
[in]driverCMSIS NAND driver control block address
[in]modeNAND bus mode

The event DriverBusModeSelect is generated when the NAND driver bus mode is set.

Value in the Event Recorder shows:

  • instance : number of Software Component driver instance.
  • driver : name of Software Component driver.
  • mode : bus mode (ARM_NAND_BUS_MODE)
__STATIC_INLINE void EvrFsNAND_DriverBusWidthError ( uint32_t  instance,
uint32_t  driver,
uint32_t  width 
)

Event on NAND driver initialization error (Error)

Parameters
[in]instanceNAND media layer instance
[in]driverCMSIS NAND driver control block address
[in]widthNAND bus width

The event DriverBusWidthSelect is generated when the NAND driver bus width cannot be set.

Value in the Event Recorder shows:

  • instance : number of Software Component driver instance.
  • driver : name of Software Component driver.
  • width : bus data width (ARM_NAND_BUS_DATA_WIDTH)
__STATIC_INLINE void EvrFsNAND_DriverBusWidthSelect ( uint32_t  instance,
uint32_t  driver,
uint32_t  width 
)

Event on NAND driver initialization error (Error)

Parameters
[in]instanceNAND media layer instance
[in]driverCMSIS NAND driver control block address
[in]widthNAND bus width

The event DriverBusWidthSelect is generated when the NAND driver bus width is set.

Value in the Event Recorder shows:

  • instance : number of Software Component driver instance.
  • driver : name of Software Component driver.
  • width : bus data width (ARM_NAND_BUS_DATA_WIDTH)
__STATIC_INLINE void EvrFsNAND_DriverDevPowerSelect ( uint32_t  instance,
uint32_t  driver,
uint32_t  volt 
)

Event on NAND device voltage change (Op)

Parameters
[in]instanceNAND media layer instance
[in]driverCMSIS NAND driver control block address
[in]voltNAND device voltage

The event DriverDevPowerSelect is generated when setting the NAND device power.

Value in the Event Recorder shows:

  • instance : number of Software Component driver instance.
  • driver : name of Software Component driver.
  • volt : NAND Device Power
__STATIC_INLINE void EvrFsNAND_DriverEccInquire ( uint32_t  instance,
uint32_t  driver 
)

Event on NAND driver ECC inquiry (Op)

Parameters
[in]instanceNAND media layer instance
[in]driverCMSIS NAND driver control block address

The event DriverEccInquire is generated when a function is retrieving ECC information.

Value in the Event Recorder shows:

  • instance : number of Software Component driver instance.
  • driver : name of Software Component driver.
__STATIC_INLINE void EvrFsNAND_DriverEccInquireError ( uint32_t  instance,
uint32_t  driver 
)

Event on NAND driver ECC inquiry error (Op)

Parameters
[in]instanceNAND media layer instance
[in]driverCMSIS NAND driver control block address

The event DriverEccInquireError is generated when a function fails to retrieve ECC information.

Value in the Event Recorder shows:

  • instance : number of Software Component driver instance.
  • driver : name of Software Component driver.
__STATIC_INLINE void EvrFsNAND_DriverEccSelect ( uint32_t  instance,
uint32_t  driver,
uint32_t  index 
)

Event on NAND driver ECC selection (Op)

Parameters
[in]instanceNAND media layer instance
[in]driverCMSIS NAND driver control block address
[in]indexECC selection index

The event DriverEccSelect is generated when NAND media driver selects ECC layout.

Value in the Event Recorder shows:

  • instance : number of Software Component driver instance.
  • driver : name of Software Component driver.
  • index : selected ECC index.
__STATIC_INLINE void EvrFsNAND_DriverPowerCtrlError ( uint32_t  instance,
uint32_t  driver,
uint32_t  state 
)

Event on NAND driver initialization error (Error)

Parameters
[in]instanceNAND media layer instance
[in]driverCMSIS NAND driver control block address
[in]stateCMSIS driver power state

The event DriverPowerCtrlError is generated when the NAND driver power control functions fail.

Value in the Event Recorder shows:

  • instance : number of Software Component driver instance.
  • driver : name of Software Component driver.
  • state : power state (ARM_POWER_STATE)
__STATIC_INLINE void EvrFsNAND_DriverTimeoutError ( uint32_t  instance,
uint32_t  driver 
)

Event on NAND driver timeout error (Error)

Parameters
[in]instanceNAND media layer instance
[in]driverCMSIS NAND driver control block address

The event DriverTimeoutError is generated when a function fails to access a driver on time. Usually, the driver is busy.

Value in the Event Recorder shows:

  • instance : number of Software Component driver instance.
  • driver : name of Software Component driver.
__STATIC_INLINE void EvrFsNAND_EraseBlock ( uint32_t  instance,
uint32_t  row 
)

Event on NAND erase block operation (Op)

Parameters
[in]instanceNAND media layer instance
[in]rowblock (row) address

The event EraseBlock is generated on attempt to erase NAND device memory block.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • row: block row address
__STATIC_INLINE void EvrFsNAND_EraseBlockComplete ( uint32_t  instance,
uint32_t  status 
)

Event on NAND erase block operation completion (Op)

Parameters
[in]instanceNAND media layer instance
[in]statusexecution status

The event EraseBlockComplete is generated when NAND device memory block erase function completes the execution and returns the execution status.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • status : NAND media execution status
__STATIC_INLINE void EvrFsNAND_IdRead ( uint32_t  instance,
uint32_t  addr,
uint32_t  len 
)

Event on NAND device ID read operation (Op)

Parameters
[in]instanceNAND media layer instance
[in]addrID address
[in]lennumber of bytes

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • addr : ID address
  • len : number of bytes to read
__STATIC_INLINE void EvrFsNAND_IdReadComplete ( uint32_t  instance,
uint32_t  status 
)

Event on NAND device ID read operation completion (Op)

Parameters
[in]instanceNAND media layer instance
[in]statusexecution status

The event IdReadComplete is generated when NAND device ID read function completes the execution and returns the execution status.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • status : NAND media execution status
__STATIC_INLINE void EvrFsNAND_Init ( uint32_t  instance)

Event on NAND media layer initialization (Op)

Parameters
[in]instanceNAND media layer instance

The event Init is generated on attempt to initialize the NAND media driver.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
__STATIC_INLINE void EvrFsNAND_InitComplete ( uint32_t  instance,
uint32_t  status 
)

Event on NAND media layer initialization completion (Op)

Parameters
[in]instanceNAND media layer instance
[in]statusexecution status

The event InitComplete is generated when NAND media driver initialize function completes the execution and returns the execution status.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • status : NAND media execution status
__STATIC_INLINE void EvrFsNAND_InitDriver ( uint32_t  instance,
uint32_t  driver 
)

Event on NAND driver initialization (Op)

Parameters
[in]instanceNAND media layer instance
[in]driverCMSIS NAND driver control block address

The event InitDriver is generated when the system initializes the NAND driver.

Value in the Event Recorder shows:

  • instance : number of Software Component driver instance.
  • driver : name of Software Component driver.
__STATIC_INLINE void EvrFsNAND_InitDriverError ( uint32_t  instance,
uint32_t  driver 
)

Event on NAND driver initialization error (Error)

Parameters
[in]instanceNAND media layer instance
[in]driverCMSIS NAND driver control block address

The event InitDriverError is generated when the system fails to initialize the NAND driver.

Value in the Event Recorder shows:

  • instance : number of Software Component driver instance.
  • driver : name of Software Component driver.
__STATIC_INLINE void EvrFsNAND_PageRead ( uint32_t  instance,
uint32_t  row,
uint32_t  col,
uint32_t  len 
)

Event on NAND page read operation (Op)

Parameters
[in]instanceNAND media layer instance
[in]rowpage (row) address
[in]colbyte (column) address
[in]lennumber of bytes

The event PageRead is generated on attempt to read NAND device memory page.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • row : page row address
  • col : page column address
  • len : number of bytes to read
__STATIC_INLINE void EvrFsNAND_PageReadComplete ( uint32_t  instance,
uint32_t  status 
)

Event on NAND page read operation completion (Op)

Parameters
[in]instanceNAND media layer instance
[in]statusexecution status

The event PageReadComplete is generated when NAND device memory page read function completes the execution and returns the execution status.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • status : NAND media execution status
__STATIC_INLINE void EvrFsNAND_PageWrite ( uint32_t  instance,
uint32_t  row,
uint32_t  col,
uint32_t  len 
)

Event on NAND page write operation (Op)

Parameters
[in]instanceNAND media layer instance
[in]rowpage (row) address
[in]colbyte (column) address
[in]lennumber of bytes

The event PageWrite is generated on attempt to write NAND device memory page.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • row : page row address
  • col : page column address
  • len : number of bytes to read
__STATIC_INLINE void EvrFsNAND_PageWriteComplete ( uint32_t  instance,
uint32_t  status 
)

Event on NAND page write operation completion (Op)

Parameters
[in]instanceNAND media layer instance
[in]statusexecution status

The event PageWriteComplete is generated when NAND device memory page write function completes the execution and returns the execution status.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • status : NAND media execution status
__STATIC_INLINE void EvrFsNAND_ParamPageRead ( uint32_t  instance,
uint32_t  col,
uint32_t  len 
)

Event on NAND parameter page read operation (Op)

Parameters
[in]instanceNAND media layer instance
[in]colbyte (column) address
[in]lennumber of bytes

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • col : column number
  • len : number of bytes to read
__STATIC_INLINE void EvrFsNAND_ParamPageReadComplete ( uint32_t  instance,
uint32_t  status 
)

Event on NAND parameter page read operation completion (Op)

Parameters
[in]instanceNAND media layer instance
[in]statusexecution status

The event ParamPageReadComplete is generated when NAND device parameter page read function completes the execution and returns the execution status.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • status : NAND media execution status
__STATIC_INLINE void EvrFsNAND_ReadStatus ( uint32_t  instance)

Event on NAND device status read operation (Detail)

Parameters
[in]instanceNAND media layer instance

The event ReadStatus is generated on attempt to read NAND device status.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
__STATIC_INLINE void EvrFsNAND_ReadStatusComplete ( uint32_t  instance,
uint32_t  status 
)

Event on NAND device status read operation completion (Op)

Parameters
[in]instanceNAND media layer instance
[in]statusdevice status

The event ReadStatusComplete is generated when NAND device status read function completes the execution and returns the execution status.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • status : NAND media execution status
__STATIC_INLINE void EvrFsNAND_ResetDevice ( uint32_t  instance)

Event on NAND device reset operation (Op)

Parameters
[in]instanceNAND media layer instance

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
__STATIC_INLINE void EvrFsNAND_ResetDeviceComplete ( uint32_t  instance,
uint32_t  status 
)

Event on NAND device reset operation completion (Op)

Parameters
[in]instanceNAND media layer instance
[in]statusexecution status

The event ResetDeviceComplete is generated when NAND device reset function completes the execution and returns the execution status.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • status : NAND media execution status
__STATIC_INLINE void EvrFsNAND_Uninit ( uint32_t  instance)

Event on NAND media layer uninitialization (Op)

Parameters
[in]instanceNAND media layer instance

The event Uninit is generated on attempt to de-initialize the NAND media driver.

Value of the Event Recorder shows:

  • instance : number of Software Component instance.
__STATIC_INLINE void EvrFsNAND_UninitComplete ( uint32_t  instance,
uint32_t  status 
)

Event on NAND media layer uninitialization completion (Op)

Parameters
[in]instanceNAND media layer instance
[in]statusexecution status

The event UninitComplete is generated when NAND media driver de-initialize function completes the execution and returns the execution status.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • status : NAND media execution status