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
FsNFTL: NAND Flash Translation Layer

Events generated by File System - NAND Flash Translation Layer functions. More...

Functions

__STATIC_INLINE void EvrFsNFTL_Init (uint32_t instance)
 Event on NFTL initialization (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_InitMediaFailed (uint32_t instance)
 Event on NFTL memory media initialization error (Error) More...
 
__STATIC_INLINE void EvrFsNFTL_Mount (uint32_t instance)
 Event on NFTL mount (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_MountSuccess (uint32_t instance)
 Event on successful NFTL mount (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_DeviceNotInitialized (uint32_t instance)
 Event (Error) More...
 
__STATIC_INLINE void EvrFsNFTL_ResetDevice (uint32_t instance)
 Event on NAND device reset (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_ResetDeviceFailed (uint32_t instance)
 Event on NAND device reset error (Error) More...
 
__STATIC_INLINE void EvrFsNFTL_ResetDeviceTimeout (uint32_t instance)
 Event on NAND device reset timeout (Error) More...
 
__STATIC_INLINE void EvrFsNFTL_ReadBootBlock (uint32_t instance)
 Event on NFTL boot block read (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_ReadBootBlockFailed (uint32_t instance)
 Event on NFTL boot block error (Error) More...
 
__STATIC_INLINE void EvrFsNFTL_BootSignatureValid (uint32_t instance)
 Event on NFTL valid boot signatures (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_DataBlockCapacity (uint32_t instance, uint32_t capacity)
 Event on NFTL invalid boot signatures (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_ReadTable (uint32_t instance)
 Event on NFTL invalid boot signatures (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_ReadTableFailed (uint32_t instance)
 Event on NFTL (Error) More...
 
__STATIC_INLINE void EvrFsNFTL_Uninit (uint32_t instance)
 Event on NFTL device uninitialization (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_UninitDriver (uint32_t instance)
 Event on NFTL driver uninitialization (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_UninitDriverFailed (uint32_t instance)
 Event on NFTL driver uninitialization error (Error) More...
 
__STATIC_INLINE void EvrFsNFTL_ReadInfo (uint32_t instance, uint32_t info)
 Event on NFTL driver uninitialization (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_ReadInfoSuccess (uint32_t instance, uint32_t sect_count)
 Event on succesful media capacity retrieval (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_DevCtrl (uint32_t instance, uint32_t code, void *p)
 Event on NFTL device control operation (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_DevCtrlUnsupported (uint32_t instance, uint32_t code)
 Event on NFTL device control code unsupported error (Error) More...
 
__STATIC_INLINE void EvrFsNFTL_Format (uint32_t instance)
 Event on NFTL format operation (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_FormatSuccess (uint32_t instance)
 Event on successful NFTL format operation (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_FormatLLEB (uint32_t instance)
 Event on NFTL format operation with option LLEB (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_BBMPositionSet (uint32_t instance, uint32_t pos)
 Event on NFTL bad block position setting (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_BadBlockDetected (uint32_t instance, uint32_t block)
 Event on NFTL bad block detection (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_BadBlockMark (uint32_t instance, uint32_t block)
 Event on NFTL bad block mark operation (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_WriteSector (uint32_t instance, uint32_t sector, const uint8_t *buf, uint32_t cnt)
 Event on NFTL write sector operation (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_WriteSectorSuccess (uint32_t instance)
 Event on successful NFTL write sector operation (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_ReadSector (uint32_t instance, uint32_t sector, uint8_t *buf, uint32_t cnt)
 Event on NFTL read sector operation (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_ReadSectorSuccess (uint32_t instance)
 Event on successful NFTL read sector operation (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_LsnToLbn (uint32_t instance, uint32_t lsn, uint32_t lbn)
 Event on NFTL resolving logical sector to logical block (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_LbnToPbn (uint32_t instance, uint32_t lbn, uint32_t pbn_0, uint32_t pbn_1)
 Event on NFTL resolving logical block to physical block (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_LbnOutOfRange (uint32_t instance, uint32_t lbn, uint32_t max)
 Event when logical block number is out of range (Error) More...
 
__STATIC_INLINE void EvrFsNFTL_PbnOutOfRange (uint32_t instance, uint32_t pbn, uint32_t max)
 Event when physical block number is out of range (Error) More...
 
__STATIC_INLINE void EvrFsNFTL_TableLookup (uint32_t instance, uint32_t lbn)
 Event on NFTL translation table lookup (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_TableEntryNotFound (uint32_t instance, uint32_t lbn)
 Event on nonexisting translation table entry (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_AllocateBlock (uint32_t instance, uint32_t area)
 Event on NAND block allocation operation (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_LsnFind (uint32_t instance, uint32_t lsn, uint32_t pbn)
 Event on search of logical sector within NAND block (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_LsnFound (uint32_t instance, uint32_t lsn, uint32_t pbn, uint32_t pg)
 Event when logical sector is found within NAND block (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_LsnNotFound (uint32_t instance, uint32_t lsn, uint32_t pbn)
 Event when logical sector is not found within NAND block (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_GarbageCollection (uint32_t instance, uint32_t src_0, uint32_t src_1, uint32_t dst)
 Event on NFTL garbage collection operation (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_SetBadBlockMarker (uint32_t instance, uint32_t pbn)
 Event on setting NAND block as bad (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_MoveData (uint32_t instance, uint32_t src, uint32_t dst)
 Event on block content move (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_RelocateBlock (uint32_t instance, uint32_t pbn)
 Event on attempt to change block physical location (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_RelocateBlockFailed (uint32_t instance, uint32_t pbn)
 Event on failed attempt to change block physical location (Error) More...
 
__STATIC_INLINE void EvrFsNFTL_SkipBadBlock (uint32_t instance, uint32_t pbn)
 Event on skipped bad block (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_PageReadFailed (uint32_t instance, uint32_t row)
 Event on NAND page read error (Error) More...
 
__STATIC_INLINE void EvrFsNFTL_PageProgramStatusErr (uint32_t instance, uint32_t row)
 Event on invalid page program status value (Error) More...
 
__STATIC_INLINE void EvrFsNFTL_PageProgramFailed (uint32_t instance, uint32_t row)
 Event on NAND page program error (Error) More...
 
__STATIC_INLINE void EvrFsNFTL_PageProgramTimeout (uint32_t instance, uint32_t row)
 Event on NAND page program timeout (Error) More...
 
__STATIC_INLINE void EvrFsNFTL_BlockEraseStatusErr (uint32_t instance, uint32_t row)
 Event on invalid block erase status value (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_BlockEraseFailed (uint32_t instance, uint32_t row)
 Event on NAND block erase error (Error) More...
 
__STATIC_INLINE void EvrFsNFTL_BlockEraseTimeout (uint32_t instance, uint32_t row)
 Event on NAND block erase timeout (Error) More...
 
__STATIC_INLINE void EvrFsNFTL_BitErrorCorrected (uint32_t instance, uint32_t row)
 Event on ECC bit error correction (Op) More...
 
__STATIC_INLINE void EvrFsNFTL_ParameterInvalid (uint32_t instance)
 Event on invalid function parameter(s) (Error) More...
 

Description

Events generated by File System - NAND Flash Translation Layer functions.

FileSystem - NAND Flash Translation Layer

Function Documentation

__STATIC_INLINE void EvrFsNFTL_AllocateBlock ( uint32_t  instance,
uint32_t  area 
)

Event on NAND block allocation operation (Op)

Parameters
[in]instanceNFTL instance number
[in]area0:translation table block, 1:user data block
__STATIC_INLINE void EvrFsNFTL_BadBlockDetected ( uint32_t  instance,
uint32_t  block 
)

Event on NFTL bad block detection (Op)

Parameters
[in]instanceNFTL instance number
[in]blockblock number
__STATIC_INLINE void EvrFsNFTL_BadBlockMark ( uint32_t  instance,
uint32_t  block 
)

Event on NFTL bad block mark operation (Op)

Parameters
[in]instanceNFTL instance number
[in]blockblock number
__STATIC_INLINE void EvrFsNFTL_BBMPositionSet ( uint32_t  instance,
uint32_t  pos 
)

Event on NFTL bad block position setting (Op)

Parameters
[in]instanceNFTL instance number
[in]posbad block position
__STATIC_INLINE void EvrFsNFTL_BitErrorCorrected ( uint32_t  instance,
uint32_t  row 
)

Event on ECC bit error correction (Op)

Parameters
[in]instanceNFTL instance number
[in]rowblock address
__STATIC_INLINE void EvrFsNFTL_BlockEraseFailed ( uint32_t  instance,
uint32_t  row 
)

Event on NAND block erase error (Error)

Parameters
[in]instanceNFTL instance number
[in]rowblock address
__STATIC_INLINE void EvrFsNFTL_BlockEraseStatusErr ( uint32_t  instance,
uint32_t  row 
)

Event on invalid block erase status value (Op)

Parameters
[in]instanceNFTL instance number
[in]rowblock address
__STATIC_INLINE void EvrFsNFTL_BlockEraseTimeout ( uint32_t  instance,
uint32_t  row 
)

Event on NAND block erase timeout (Error)

Parameters
[in]instanceNFTL instance number
[in]rowblock address
__STATIC_INLINE void EvrFsNFTL_BootSignatureValid ( uint32_t  instance)

Event on NFTL valid boot signatures (Op)

Parameters
[in]instanceNFTL instance number
__STATIC_INLINE void EvrFsNFTL_DataBlockCapacity ( uint32_t  instance,
uint32_t  capacity 
)

Event on NFTL invalid boot signatures (Op)

Parameters
[in]instanceNFTL instance number
[in]capacitynumber of available data blocks
__STATIC_INLINE void EvrFsNFTL_DevCtrl ( uint32_t  instance,
uint32_t  code,
void *  p 
)

Event on NFTL device control operation (Op)

Parameters
[in]instanceNFTL instance number
[in]codedevice control command code
[in]pcommand code argument

The event DevCtrl is generated when control code is sent directly to NAND Flash Translation Layer.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • code : string specifying the key name of the control code.
  • p : memory address of the control code parameter
__STATIC_INLINE void EvrFsNFTL_DevCtrlUnsupported ( uint32_t  instance,
uint32_t  code 
)

Event on NFTL device control code unsupported error (Error)

Parameters
[in]instanceNFTL instance number
[in]codedevice control command code

The event DevCtrlUnsupported is generated whenever an unsupported control code is used.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • code : string specifying the key name of the control code.
__STATIC_INLINE void EvrFsNFTL_DeviceNotInitialized ( uint32_t  instance)

Event (Error)

Parameters
[in]instanceNFTL instance number
__STATIC_INLINE void EvrFsNFTL_Format ( uint32_t  instance)

Event on NFTL format operation (Op)

Parameters
[in]instanceNFTL instance number

The event Format is generated when the function fformat attempts to format NAND Flash Translation Layer.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
__STATIC_INLINE void EvrFsNFTL_FormatLLEB ( uint32_t  instance)

Event on NFTL format operation with option LLEB (Op)

Parameters
[in]instanceNFTL instance number
__STATIC_INLINE void EvrFsNFTL_FormatSuccess ( uint32_t  instance)

Event on successful NFTL format operation (Op)

Parameters
[in]instanceNFTL instance number

The event FormatSuccess is generated when NAND Flash Translation Layer formatting is successfully executed.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
__STATIC_INLINE void EvrFsNFTL_GarbageCollection ( uint32_t  instance,
uint32_t  src_0,
uint32_t  src_1,
uint32_t  dst 
)

Event on NFTL garbage collection operation (Op)

Parameters
[in]instanceNFTL instance number
[in]src_0physical block number (source 0)
[in]src_1physical block number (source 1)
[in]dstphysical block number (destination)
__STATIC_INLINE void EvrFsNFTL_Init ( uint32_t  instance)

Event on NFTL initialization (Op)

Parameters
[in]instanceNFTL instance number
__STATIC_INLINE void EvrFsNFTL_InitMediaFailed ( uint32_t  instance)

Event on NFTL memory media initialization error (Error)

Parameters
[in]instanceNFTL instance number
__STATIC_INLINE void EvrFsNFTL_LbnOutOfRange ( uint32_t  instance,
uint32_t  lbn,
uint32_t  max 
)

Event when logical block number is out of range (Error)

Parameters
[in]instanceNFTL instance number
[in]lbnlogical block number
[in]maxmaximum logical block number
__STATIC_INLINE void EvrFsNFTL_LbnToPbn ( uint32_t  instance,
uint32_t  lbn,
uint32_t  pbn_0,
uint32_t  pbn_1 
)

Event on NFTL resolving logical block to physical block (Op)

Parameters
[in]instanceNFTL instance number
[in]lbnlogical block number
[in]pbn_0physical block number
[in]pbn_1physical block number
__STATIC_INLINE void EvrFsNFTL_LsnFind ( uint32_t  instance,
uint32_t  lsn,
uint32_t  pbn 
)

Event on search of logical sector within NAND block (Op)

Parameters
[in]instanceNFTL instance number
[in]lsnlogical sector number
[in]pbnphysical block number
__STATIC_INLINE void EvrFsNFTL_LsnFound ( uint32_t  instance,
uint32_t  lsn,
uint32_t  pbn,
uint32_t  pg 
)

Event when logical sector is found within NAND block (Op)

Parameters
[in]instanceNFTL instance number
[in]lsnlogical sector number
[in]pbnphysical block number
[in]pgpage number
__STATIC_INLINE void EvrFsNFTL_LsnNotFound ( uint32_t  instance,
uint32_t  lsn,
uint32_t  pbn 
)

Event when logical sector is not found within NAND block (Op)

Parameters
[in]instanceNFTL instance number
[in]lsnlogical sector number
[in]pbnphysical block number
__STATIC_INLINE void EvrFsNFTL_LsnToLbn ( uint32_t  instance,
uint32_t  lsn,
uint32_t  lbn 
)

Event on NFTL resolving logical sector to logical block (Op)

Parameters
[in]instanceNFTL instance number
[in]lsnlogical sector number
[in]lbnlogical block number
__STATIC_INLINE void EvrFsNFTL_Mount ( uint32_t  instance)

Event on NFTL mount (Op)

Parameters
[in]instanceNFTL instance number
__STATIC_INLINE void EvrFsNFTL_MountSuccess ( uint32_t  instance)

Event on successful NFTL mount (Op)

Parameters
[in]instanceNFTL instance number
__STATIC_INLINE void EvrFsNFTL_MoveData ( uint32_t  instance,
uint32_t  src,
uint32_t  dst 
)

Event on block content move (Op)

Parameters
[in]instanceNFTL instance number
[in]srcphysical block number
[in]dstphysical block number
__STATIC_INLINE void EvrFsNFTL_PageProgramFailed ( uint32_t  instance,
uint32_t  row 
)

Event on NAND page program error (Error)

Parameters
[in]instanceNFTL instance number
[in]rowpage address
__STATIC_INLINE void EvrFsNFTL_PageProgramStatusErr ( uint32_t  instance,
uint32_t  row 
)

Event on invalid page program status value (Error)

Parameters
[in]instanceNFTL instance number
[in]rowpage address
__STATIC_INLINE void EvrFsNFTL_PageProgramTimeout ( uint32_t  instance,
uint32_t  row 
)

Event on NAND page program timeout (Error)

Parameters
[in]instanceNFTL instance number
[in]rowpage address
__STATIC_INLINE void EvrFsNFTL_PageReadFailed ( uint32_t  instance,
uint32_t  row 
)

Event on NAND page read error (Error)

Parameters
[in]instanceNFTL instance number
[in]rowpage address
__STATIC_INLINE void EvrFsNFTL_ParameterInvalid ( uint32_t  instance)

Event on invalid function parameter(s) (Error)

Parameters
[in]instanceNFTL instance number
__STATIC_INLINE void EvrFsNFTL_PbnOutOfRange ( uint32_t  instance,
uint32_t  pbn,
uint32_t  max 
)

Event when physical block number is out of range (Error)

Parameters
[in]instanceNFTL instance number
[in]pbnphysical block number
[in]maxmaximum logical block number
__STATIC_INLINE void EvrFsNFTL_ReadBootBlock ( uint32_t  instance)

Event on NFTL boot block read (Op)

Parameters
[in]instanceNFTL instance number
__STATIC_INLINE void EvrFsNFTL_ReadBootBlockFailed ( uint32_t  instance)

Event on NFTL boot block error (Error)

Parameters
[in]instanceNFTL instance number
__STATIC_INLINE void EvrFsNFTL_ReadInfo ( uint32_t  instance,
uint32_t  info 
)

Event on NFTL driver uninitialization (Op)

Parameters
[in]instanceNFTL instance number
[in]infofsMediaInfo structure address

The event ReadInfo is generated on attempt to read NFTL storage geometry properties.

Value of the Event Recorder shows:

  • instance : number of Software Component instance.
  • info : memory address of the fsMediaInfo structure
__STATIC_INLINE void EvrFsNFTL_ReadInfoSuccess ( uint32_t  instance,
uint32_t  sect_count 
)

Event on succesful media capacity retrieval (Op)

Parameters
[in]instanceNFTL instance number
[in]sect_countcapacity in number of sectors

The event ReadInfoSuccess is generated when NFTL storage geometry properties are retrieved successfully.

Value of the Event Recorder shows:

  • instance : number of Software Component instance.
  • sect_count : number of sectors available on the memory media
__STATIC_INLINE void EvrFsNFTL_ReadSector ( uint32_t  instance,
uint32_t  sector,
uint8_t *  buf,
uint32_t  cnt 
)

Event on NFTL read sector operation (Op)

Parameters
[in]instanceNFTL instance number
[in]sectorsector number
[in]bufdata buffer
[in]cntnumber of sectors to read
__STATIC_INLINE void EvrFsNFTL_ReadSectorSuccess ( uint32_t  instance)

Event on successful NFTL read sector operation (Op)

Parameters
[in]instanceNFTL instance number
__STATIC_INLINE void EvrFsNFTL_ReadTable ( uint32_t  instance)

Event on NFTL invalid boot signatures (Op)

Parameters
[in]instanceNFTL instance number
__STATIC_INLINE void EvrFsNFTL_ReadTableFailed ( uint32_t  instance)

Event on NFTL (Error)

Parameters
[in]instanceNFTL instance number
__STATIC_INLINE void EvrFsNFTL_RelocateBlock ( uint32_t  instance,
uint32_t  pbn 
)

Event on attempt to change block physical location (Op)

Parameters
[in]instanceNFTL instance number
[in]pbnphysical block number
__STATIC_INLINE void EvrFsNFTL_RelocateBlockFailed ( uint32_t  instance,
uint32_t  pbn 
)

Event on failed attempt to change block physical location (Error)

Parameters
[in]instanceNFTL instance number
[in]pbnphysical block number
__STATIC_INLINE void EvrFsNFTL_ResetDevice ( uint32_t  instance)

Event on NAND device reset (Op)

Parameters
[in]instanceNFTL instance number
__STATIC_INLINE void EvrFsNFTL_ResetDeviceFailed ( uint32_t  instance)

Event on NAND device reset error (Error)

Parameters
[in]instanceNFTL instance number
__STATIC_INLINE void EvrFsNFTL_ResetDeviceTimeout ( uint32_t  instance)

Event on NAND device reset timeout (Error)

Parameters
[in]instanceNFTL instance number
__STATIC_INLINE void EvrFsNFTL_SetBadBlockMarker ( uint32_t  instance,
uint32_t  pbn 
)

Event on setting NAND block as bad (Op)

Parameters
[in]instanceNFTL instance number
[in]pbnphysical block number
__STATIC_INLINE void EvrFsNFTL_SkipBadBlock ( uint32_t  instance,
uint32_t  pbn 
)

Event on skipped bad block (Op)

Parameters
[in]instanceNFTL instance number
[in]pbnphysical block number
__STATIC_INLINE void EvrFsNFTL_TableEntryNotFound ( uint32_t  instance,
uint32_t  lbn 
)

Event on nonexisting translation table entry (Op)

Parameters
[in]instanceNFTL instance number
[in]lbnlogical block number
__STATIC_INLINE void EvrFsNFTL_TableLookup ( uint32_t  instance,
uint32_t  lbn 
)

Event on NFTL translation table lookup (Op)

Parameters
[in]instanceNFTL instance number
[in]lbnlogical block number
__STATIC_INLINE void EvrFsNFTL_Uninit ( uint32_t  instance)

Event on NFTL device uninitialization (Op)

Parameters
[in]instanceNFTL instance number

The event Uninit is generated when the function funinit executes.

Value of the Event Recorder shows:

  • instance : number of Software Component instance.
__STATIC_INLINE void EvrFsNFTL_UninitDriver ( uint32_t  instance)

Event on NFTL driver uninitialization (Op)

Parameters
[in]instanceNFTL instance number

The event UninitDriver is generated when the NAND media driver is de-initialised.

Value of the Event Recorder shows:

  • instance : number of Software Component instance.
__STATIC_INLINE void EvrFsNFTL_UninitDriverFailed ( uint32_t  instance)

Event on NFTL driver uninitialization error (Error)

Parameters
[in]instanceNFTL instance number

The event UninitDriverFailed is generated when the NAND media driver de-initialization failed.

Value of the Event Recorder shows:

  • instance : number of Software Component instance.
__STATIC_INLINE void EvrFsNFTL_WriteSector ( uint32_t  instance,
uint32_t  sector,
const uint8_t *  buf,
uint32_t  cnt 
)

Event on NFTL write sector operation (Op)

Parameters
[in]instanceNFTL instance number
[in]sectorsector number
[in]bufdata buffer
[in]cntnumber of sectors to write
__STATIC_INLINE void EvrFsNFTL_WriteSectorSuccess ( uint32_t  instance)

Event on successful NFTL write sector operation (Op)

Parameters
[in]instanceNFTL instance number