File System Component  
MDK Middleware for Devices with Flash File System
 
Loading...
Searching...
No Matches
Functions
FsNFTL: NAND Flash Translation Layer
Debug Events

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)
 
__STATIC_INLINE void EvrFsNFTL_InitMediaFailed (uint32_t instance)
 Event on NFTL memory media initialization error (Error)
 
__STATIC_INLINE void EvrFsNFTL_Mount (uint32_t instance)
 Event on NFTL mount (Op)
 
__STATIC_INLINE void EvrFsNFTL_MountSuccess (uint32_t instance)
 Event on successful NFTL mount (Op)
 
__STATIC_INLINE void EvrFsNFTL_DeviceNotInitialized (uint32_t instance)
 Event (Error)
 
__STATIC_INLINE void EvrFsNFTL_ResetDevice (uint32_t instance)
 Event on NAND device reset (Op)
 
__STATIC_INLINE void EvrFsNFTL_ResetDeviceFailed (uint32_t instance)
 Event on NAND device reset error (Error)
 
__STATIC_INLINE void EvrFsNFTL_ResetDeviceTimeout (uint32_t instance)
 Event on NAND device reset timeout (Error)
 
__STATIC_INLINE void EvrFsNFTL_ReadBootBlock (uint32_t instance)
 Event on NFTL boot block read (Op)
 
__STATIC_INLINE void EvrFsNFTL_ReadBootBlockFailed (uint32_t instance)
 Event on NFTL boot block error (Error)
 
__STATIC_INLINE void EvrFsNFTL_BootSignatureValid (uint32_t instance)
 Event on NFTL valid boot signatures (Op)
 
__STATIC_INLINE void EvrFsNFTL_BootSignatureInvalid (uint32_t instance)
 Event on NFTL invalid boot signatures (Op)
 
__STATIC_INLINE void EvrFsNFTL_DataBlockCapacity (uint32_t instance, uint32_t capacity)
 Event on NFTL invalid boot signatures (Op)
 
__STATIC_INLINE void EvrFsNFTL_ReadTable (uint32_t instance)
 Event on NFTL invalid boot signatures (Op)
 
__STATIC_INLINE void EvrFsNFTL_ReadTableFailed (uint32_t instance)
 Event on NFTL (Error)
 
__STATIC_INLINE void EvrFsNFTL_Uninit (uint32_t instance)
 Event on NFTL device uninitialization (Op)
 
__STATIC_INLINE void EvrFsNFTL_UninitDriver (uint32_t instance)
 Event on NFTL driver uninitialization (Op)
 
__STATIC_INLINE void EvrFsNFTL_UninitDriverFailed (uint32_t instance)
 Event on NFTL driver uninitialization error (Error)
 
__STATIC_INLINE void EvrFsNFTL_ReadInfo (uint32_t instance, uint32_t info)
 Event on NFTL driver uninitialization (Op)
 
__STATIC_INLINE void EvrFsNFTL_ReadInfoSuccess (uint32_t instance, uint32_t sect_count)
 Event on succesful media capacity retrieval (Op)
 
__STATIC_INLINE void EvrFsNFTL_DevCtrl (uint32_t instance, uint32_t code, void *p)
 Event on NFTL device control operation (Op)
 
__STATIC_INLINE void EvrFsNFTL_DevCtrlUnsupported (uint32_t instance, uint32_t code)
 Event on NFTL device control code unsupported error (Error)
 
__STATIC_INLINE void EvrFsNFTL_Format (uint32_t instance)
 Event on NFTL format operation (Op)
 
__STATIC_INLINE void EvrFsNFTL_FormatSuccess (uint32_t instance)
 Event on successful NFTL format operation (Op)
 
__STATIC_INLINE void EvrFsNFTL_FormatLLEB (uint32_t instance)
 Event on NFTL format operation with option LLEB (Op)
 
__STATIC_INLINE void EvrFsNFTL_BBMPositionSet (uint32_t instance, uint32_t pos)
 Event on NFTL bad block position setting (Op)
 
__STATIC_INLINE void EvrFsNFTL_BadBlockDetected (uint32_t instance, uint32_t block)
 Event on NFTL bad block detection (Op)
 
__STATIC_INLINE void EvrFsNFTL_BadBlockMark (uint32_t instance, uint32_t block)
 Event on NFTL bad block mark operation (Op)
 
__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)
 
__STATIC_INLINE void EvrFsNFTL_WriteSectorSuccess (uint32_t instance)
 Event on successful NFTL write sector operation (Op)
 
__STATIC_INLINE void EvrFsNFTL_ReadSector (uint32_t instance, uint32_t sector, uint8_t *buf, uint32_t cnt)
 Event on NFTL read sector operation (Op)
 
__STATIC_INLINE void EvrFsNFTL_ReadSectorSuccess (uint32_t instance)
 Event on successful NFTL read sector operation (Op)
 
__STATIC_INLINE void EvrFsNFTL_LsnToLbn (uint32_t instance, uint32_t lsn, uint32_t lbn)
 Event on NFTL resolving logical sector to logical block (Op)
 
__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)
 
__STATIC_INLINE void EvrFsNFTL_LbnOutOfRange (uint32_t instance, uint32_t lbn, uint32_t max)
 Event when logical block number is out of range (Error)
 
__STATIC_INLINE void EvrFsNFTL_PbnOutOfRange (uint32_t instance, uint32_t pbn, uint32_t max)
 Event when physical block number is out of range (Error)
 
__STATIC_INLINE void EvrFsNFTL_TableLookup (uint32_t instance, uint32_t lbn)
 Event on NFTL translation table lookup (Op)
 
__STATIC_INLINE void EvrFsNFTL_TableEntryNotFound (uint32_t instance, uint32_t lbn)
 Event on nonexisting translation table entry (Op)
 
__STATIC_INLINE void EvrFsNFTL_AllocateBlock (uint32_t instance, uint32_t area)
 Event on NAND block allocation operation (Op)
 
__STATIC_INLINE void EvrFsNFTL_LsnFind (uint32_t instance, uint32_t lsn, uint32_t pbn)
 Event on search of logical sector within NAND block (Op)
 
__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)
 
__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)
 
__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)
 
__STATIC_INLINE void EvrFsNFTL_SetBadBlockMarker (uint32_t instance, uint32_t pbn)
 Event on setting NAND block as bad (Op)
 
__STATIC_INLINE void EvrFsNFTL_MoveData (uint32_t instance, uint32_t src, uint32_t dst)
 Event on block content move (Op)
 
__STATIC_INLINE void EvrFsNFTL_RelocateBlock (uint32_t instance, uint32_t pbn)
 Event on attempt to change block physical location (Op)
 
__STATIC_INLINE void EvrFsNFTL_RelocateBlockFailed (uint32_t instance, uint32_t pbn)
 Event on failed attempt to change block physical location (Error)
 
__STATIC_INLINE void EvrFsNFTL_SkipBadBlock (uint32_t instance, uint32_t pbn)
 Event on skipped bad block (Op)
 
__STATIC_INLINE void EvrFsNFTL_PageReadFailed (uint32_t instance, uint32_t row)
 Event on NAND page read error (Error)
 
__STATIC_INLINE void EvrFsNFTL_PageProgramStatusErr (uint32_t instance, uint32_t row)
 Event on invalid page program status value (Error)
 
__STATIC_INLINE void EvrFsNFTL_PageProgramFailed (uint32_t instance, uint32_t row)
 Event on NAND page program error (Error)
 
__STATIC_INLINE void EvrFsNFTL_PageProgramTimeout (uint32_t instance, uint32_t row)
 Event on NAND page program timeout (Error)
 
__STATIC_INLINE void EvrFsNFTL_BlockEraseStatusErr (uint32_t instance, uint32_t row)
 Event on invalid block erase status value (Op)
 
__STATIC_INLINE void EvrFsNFTL_BlockEraseFailed (uint32_t instance, uint32_t row)
 Event on NAND block erase error (Error)
 
__STATIC_INLINE void EvrFsNFTL_BlockEraseTimeout (uint32_t instance, uint32_t row)
 Event on NAND block erase timeout (Error)
 
__STATIC_INLINE void EvrFsNFTL_BitErrorCorrected (uint32_t instance, uint32_t row)
 Event on ECC bit error correction (Op)
 
__STATIC_INLINE void EvrFsNFTL_ParameterInvalid (uint32_t instance)
 Event on invalid function parameter(s) (Error)
 
__STATIC_INLINE void EvrFsNFTL_TableUpdate (uint32_t instance, uint32_t lbn, uint32_t pbn_0, uint32_t pbn_1)
 Event on translation table update (Op)
 
__STATIC_INLINE void EvrFsNFTL_AllocatedBlock (uint32_t instance, uint32_t pbn)
 Event on successful block allocation (Op)
 
__STATIC_INLINE void EvrFsNFTL_LoadSector (uint32_t instance, uint32_t lsn, uint32_t offs, uint32_t spare)
 Event on loading sector data from/to NAND page buffer (Detail)
 
__STATIC_INLINE void EvrFsNFTL_LoadTableLayout (uint32_t instance, uint32_t pbn_0, uint32_t pbn_1)
 Event on translation table layout configuration read (Detail)
 
__STATIC_INLINE void EvrFsNFTL_LoadDataLayout (uint32_t instance, uint32_t pbn_0, uint32_t pbn_1)
 Event on file data layout configuration read (Detail)
 
__STATIC_INLINE void EvrFsNFTL_SetupPageLayout (uint32_t instance, uint32_t sector_inc, uint32_t spare_ofs, uint32_t spare_inc)
 Event on page layout setup (Detail)
 
__STATIC_INLINE void EvrFsNFTL_SetupSpareLayout (uint32_t instance, uint32_t ofs_lsn, uint32_t ofs_dcm, uint32_t ofs_bbm, uint32_t ofs_ecc)
 Event on spare area layout setup (Detail)
 
__STATIC_INLINE void EvrFsNFTL_PageRead (uint32_t instance, uint32_t pbn, uint32_t pg)
 Event on page read (Op)
 
__STATIC_INLINE void EvrFsNFTL_PageWrite (uint32_t instance, uint32_t pbn, uint32_t pg)
 Event on page write (Op)
 
__STATIC_INLINE void EvrFsNFTL_BlockErase (uint32_t instance, uint32_t pbn)
 Event on block erase (Op)
 
__STATIC_INLINE void EvrFsNFTL_StatusRead (uint32_t instance, uint32_t status)
 Event on status read (Op)
 
__STATIC_INLINE void EvrFsNFTL_CacheRead (uint32_t instance, uint32_t pbn, uint32_t pg, uint32_t col)
 Event on page cache read (Op)
 
__STATIC_INLINE void EvrFsNFTL_CacheWrite (uint32_t instance, uint32_t pbn, uint32_t pg)
 Event on page cache write (Op)
 

Description

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

FileSystem - NAND Flash Translation Layer

Function Documentation

◆ EvrFsNFTL_AllocateBlock()

__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

The event AllocateBlock is generated when NAND Flash Translation Layer attempts to allocate free block.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • area : allocation area (0=translation table, 1=data area).

◆ EvrFsNFTL_AllocatedBlock()

__STATIC_INLINE void EvrFsNFTL_AllocatedBlock ( uint32_t  instance,
uint32_t  pbn 
)

Event on successful block allocation (Op)

Parameters
[in]instanceNFTL instance number
[in]pbnphysical block number

The event AllocatedBlock is generated when NAND Flash Translation Layer successfully allocates an empty physical block.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • pbn : allocated physical block number

◆ EvrFsNFTL_BadBlockDetected()

__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

The event BadBlockDetected is generated when bad block marker is detected within block.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • block : physical block number.

◆ EvrFsNFTL_BadBlockMark()

__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

The event BadBlockMark is generated when NAND Flash Translation Layer formatting function detects unreliable block and attempts to mark it as bad.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • block : physical block number.

◆ EvrFsNFTL_BBMPositionSet()

__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

The event BBMPositionSet is generated when bad block marker position is set.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • pos : absolute position of the bad block marker byte.

◆ EvrFsNFTL_BitErrorCorrected()

__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

The event BitErrorCorrected is generated when ECC algorithm corrects bit error.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • row : row address of the page where bit error occurred.

◆ EvrFsNFTL_BlockErase()

__STATIC_INLINE void EvrFsNFTL_BlockErase ( uint32_t  instance,
uint32_t  pbn 
)

Event on block erase (Op)

Parameters
[in]instanceNFTL instance number
[in]pbnphysical block number

The event BlockErase is generated when NAND Flash Translation Layer erases NAND device block.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • pbn : physical block number

◆ EvrFsNFTL_BlockEraseFailed()

__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

The event BlockEraseFailed is generated when NAND media driver fails to execute block erase operation.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • row : row address of the block.

◆ EvrFsNFTL_BlockEraseStatusErr()

__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

The event BlockEraseStatusErr is generated when NAND device fails to erase the memory block. This usually happens when block becomes bad or when block erase operation is executed on a bad block.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • row : row address of the block.

◆ EvrFsNFTL_BlockEraseTimeout()

__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

The event BlockEraseTimeout is generated when block erase operation fails due to the timeout.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • row : row address of the block.

◆ EvrFsNFTL_BootSignatureInvalid()

__STATIC_INLINE void EvrFsNFTL_BootSignatureInvalid ( uint32_t  instance)

Event on NFTL invalid boot signatures (Op)

Parameters
[in]instanceNFTL instance number

The event BootSignatureValid is generated when NAND Flash Translation Layer detects invalid signature in its boot information block.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.

◆ EvrFsNFTL_BootSignatureValid()

__STATIC_INLINE void EvrFsNFTL_BootSignatureValid ( uint32_t  instance)

Event on NFTL valid boot signatures (Op)

Parameters
[in]instanceNFTL instance number

The event BootSignatureValid is generated when valid signature of the NAND Flash Translation Layer boot information block is detected.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.

◆ EvrFsNFTL_CacheRead()

__STATIC_INLINE void EvrFsNFTL_CacheRead ( uint32_t  instance,
uint32_t  pbn,
uint32_t  pg,
uint32_t  col 
)

Event on page cache read (Op)

Parameters
[in]instanceNFTL instance number
[in]pbnphysical block number
[in]pgpage number
[in]colpage column number

The event CacheRead is generated when NAND Flash Translation Layer reads a page using page cache.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • pbn : physical block number
  • pg : page number
  • col : column number

◆ EvrFsNFTL_CacheWrite()

__STATIC_INLINE void EvrFsNFTL_CacheWrite ( uint32_t  instance,
uint32_t  pbn,
uint32_t  pg 
)

Event on page cache write (Op)

Parameters
[in]instanceNFTL instance number
[in]pbnphysical block number
[in]pgpage number

The event CacheWrite is generated when NAND Flash Translation Layer writes a page using page cache.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • pbn : physical block number
  • pg : page number

◆ EvrFsNFTL_DataBlockCapacity()

__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

The event DataBlockCapacity is generated when NAND Flash Translation Layer determines number of data blocks available to setup the file system.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • capacity : number of data blocks (size of block equals to device block size).

◆ EvrFsNFTL_DevCtrl()

__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.

◆ EvrFsNFTL_DevCtrlUnsupported()

__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.

◆ EvrFsNFTL_DeviceNotInitialized()

__STATIC_INLINE void EvrFsNFTL_DeviceNotInitialized ( uint32_t  instance)

Event (Error)

Parameters
[in]instanceNFTL instance number

The event DeviceNotInitialized is generated on attempt to access de-initialized NAND device.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.

◆ EvrFsNFTL_Format()

__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.

◆ EvrFsNFTL_FormatLLEB()

__STATIC_INLINE void EvrFsNFTL_FormatLLEB ( uint32_t  instance)

Event on NFTL format operation with option LLEB (Op)

Parameters
[in]instanceNFTL instance number

The event FormatLLEB is generated when NAND Flash Translation Layer enables erase of blocks marked as bad.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.

◆ EvrFsNFTL_FormatSuccess()

__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.

◆ EvrFsNFTL_GarbageCollection()

__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)

The event GarbageCollection is generated when garbage collection procedure is started.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • src_0 : first data source block.
  • src_1 : second data source block.
  • dst : data destination block.

◆ EvrFsNFTL_Init()

__STATIC_INLINE void EvrFsNFTL_Init ( uint32_t  instance)

Event on NFTL initialization (Op)

Parameters
[in]instanceNFTL instance number

The event Init is generated on attempt to initialize the NAND Flash Translation Layer.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.

◆ EvrFsNFTL_InitMediaFailed()

__STATIC_INLINE void EvrFsNFTL_InitMediaFailed ( uint32_t  instance)

Event on NFTL memory media initialization error (Error)

Parameters
[in]instanceNFTL instance number

The event InitMediaFailed is generated when NAND media driver initialization fails.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.

◆ EvrFsNFTL_LbnOutOfRange()

__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

The event LbnOutOfRange is generated when NAND Flash Translation Layer detect logical block number which is higher than total number of logical blocks.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • lbn : detected logical block number.
  • max : maximum number of logical blocks.

◆ EvrFsNFTL_LbnToPbn()

__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

The event LbnToPbn is generated when NAND Flash Translation Layer determines the physical locations of a logical block.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • lbn : logical block number.
  • pbn_0 : number of physical block 0.
  • pbn_1 : number of physical block 1.

◆ EvrFsNFTL_LoadDataLayout()

__STATIC_INLINE void EvrFsNFTL_LoadDataLayout ( uint32_t  instance,
uint32_t  pbn_0,
uint32_t  pbn_1 
)

Event on file data layout configuration read (Detail)

Parameters
[in]instanceNFTL instance number
[in]pbn_0physical block number
[in]pbn_1physical block number

The event LoadDataLayout is generated when NAND Flash Translation Layer reads file data area configuration from the NAND configuration structure.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • pbn_0 : physical block number of the first file data block
  • pbn_1 : physical block number of the last first data block

◆ EvrFsNFTL_LoadSector()

__STATIC_INLINE void EvrFsNFTL_LoadSector ( uint32_t  instance,
uint32_t  lsn,
uint32_t  offs,
uint32_t  spare 
)

Event on loading sector data from/to NAND page buffer (Detail)

Parameters
[in]instanceNFTL instance number
[in]lsnlogical sector number
[in]offssector data offset (position within page)
[in]sparesector spare offset (position within page)

The event LoadSector is generated when NAND Flash Translation Layer loads sector data from/to the NAND page buffer.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • lsn : logical sector number to be loaded
  • offs : sector data byte offset within page
  • spare : sector spare byte offset within page

◆ EvrFsNFTL_LoadTableLayout()

__STATIC_INLINE void EvrFsNFTL_LoadTableLayout ( uint32_t  instance,
uint32_t  pbn_0,
uint32_t  pbn_1 
)

Event on translation table layout configuration read (Detail)

Parameters
[in]instanceNFTL instance number
[in]pbn_0physical block number
[in]pbn_1physical block number

The event LoadTableLayout is generated when NAND Flash Translation Layer reads translation table area configuration from the NAND configuration structure.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • pbn_0 : physical block number of the first translation table block
  • pbn_1 : physical block number of the last translation table block

◆ EvrFsNFTL_LsnFind()

__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

The event LsnFind is generated when NAND Flash Translation Layer attempts to find logical sector within physical block.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • lsn : logical sector number.
  • pbn : physical sector number.

◆ EvrFsNFTL_LsnFound()

__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

The event LsnFound is generated when NAND Flash Translation Layer logical sector is found within physical block.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • lsn : logical sector number.
  • pbn : physical sector number.
  • pg : page which contains logical sector.

◆ EvrFsNFTL_LsnNotFound()

__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

The event LsnNotFound is generated when NAND Flash Translation Layer logical sector is found within physical block.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • lsn : logical sector number.
  • pbn : physical block number.

◆ EvrFsNFTL_LsnToLbn()

__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

The event LsnToLbn is generated on conversion of logical sector number to logical block number.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • lsn : logical sector number.
  • lbn : logical block number.

◆ EvrFsNFTL_Mount()

__STATIC_INLINE void EvrFsNFTL_Mount ( uint32_t  instance)

Event on NFTL mount (Op)

Parameters
[in]instanceNFTL instance number

The event Mount is generated on attempt to mount the NAND Flash Translation Layer.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.

◆ EvrFsNFTL_MountSuccess()

__STATIC_INLINE void EvrFsNFTL_MountSuccess ( uint32_t  instance)

Event on successful NFTL mount (Op)

Parameters
[in]instanceNFTL instance number

The event MountSuccess is generated when NAND Flash Translation Layer is successfully mounted.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.

◆ EvrFsNFTL_MoveData()

__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

The event MoveData is generated on attempt to move data from source to destination block.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • src : physical number of the source block.
  • dst : physical number of the destination block.

◆ EvrFsNFTL_PageProgramFailed()

__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

The event PageProgramFailed is generated when NAND media driver fails to execute page program operation.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • row : row address of the page.

◆ EvrFsNFTL_PageProgramStatusErr()

__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

The event PageProgramStatusErr is generated when NAND device fails to program the memory page.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • row : row address of the page.

◆ EvrFsNFTL_PageProgramTimeout()

__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

The event PageProgramTimeout is generated when page program operation fails due to the timeout.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • row : row address of the page.

◆ EvrFsNFTL_PageRead()

__STATIC_INLINE void EvrFsNFTL_PageRead ( uint32_t  instance,
uint32_t  pbn,
uint32_t  pg 
)

Event on page read (Op)

Parameters
[in]instanceNFTL instance number
[in]pbnphysical block number
[in]pgpage number

The event PageRead is generated when NAND Flash Translation Layer reads a page from NAND device.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • pbn : physical block number
  • pg : page number

◆ EvrFsNFTL_PageReadFailed()

__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

The event PageReadFailed is generated when NAND media driver fails to execute page read operation.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • row : row address of the page.

◆ EvrFsNFTL_PageWrite()

__STATIC_INLINE void EvrFsNFTL_PageWrite ( uint32_t  instance,
uint32_t  pbn,
uint32_t  pg 
)

Event on page write (Op)

Parameters
[in]instanceNFTL instance number
[in]pbnphysical block number
[in]pgpage number

The event PageWrite is generated when NAND Flash Translation Layer writes a page to NAND device.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • pbn : physical block number
  • pg : page number

◆ EvrFsNFTL_ParameterInvalid()

__STATIC_INLINE void EvrFsNFTL_ParameterInvalid ( uint32_t  instance)

Event on invalid function parameter(s) (Error)

Parameters
[in]instanceNFTL instance number

The event ParameterInvalid is generated when NAND Flash Translation Layer detects invalid function parameter.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.

◆ EvrFsNFTL_PbnOutOfRange()

__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

The event PbnOutOfRange is generated NAND Flash Translation Layer detect physical block number which is higher than total number of physical blocks.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • pbn : detected physical block number.
  • max : maximum number of physical blocks.

◆ EvrFsNFTL_ReadBootBlock()

__STATIC_INLINE void EvrFsNFTL_ReadBootBlock ( uint32_t  instance)

Event on NFTL boot block read (Op)

Parameters
[in]instanceNFTL instance number

The event ReadBootBlock is generated when NAND Flash Translation Layer attempts to read its boot information block.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.

◆ EvrFsNFTL_ReadBootBlockFailed()

__STATIC_INLINE void EvrFsNFTL_ReadBootBlockFailed ( uint32_t  instance)

Event on NFTL boot block error (Error)

Parameters
[in]instanceNFTL instance number

The event ReadBootBlock is generated when NAND Flash Translation Layer fails to read its boot information block.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.

◆ EvrFsNFTL_ReadInfo()

__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.

◆ EvrFsNFTL_ReadInfoSuccess()

__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.

◆ EvrFsNFTL_ReadSector()

__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

The event ReadSector is generated when NAND Flash Translation Layer attempts to read data from the flash.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • sector : sector number to read.
  • buf : memory location of the data buffer.
  • cnt : number of sectors to read.

◆ EvrFsNFTL_ReadSectorSuccess()

__STATIC_INLINE void EvrFsNFTL_ReadSectorSuccess ( uint32_t  instance)

Event on successful NFTL read sector operation (Op)

Parameters
[in]instanceNFTL instance number

The event ReadSectorSuccess is generated when NAND Flash Translation Layer successfully reads data from the flash.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • sector : sector number to read.
  • buf : memory location of the data buffer.
  • cnt : number of sectors read.

◆ EvrFsNFTL_ReadTable()

__STATIC_INLINE void EvrFsNFTL_ReadTable ( uint32_t  instance)

Event on NFTL invalid boot signatures (Op)

Parameters
[in]instanceNFTL instance number

The event DataBlockCapacity is generated when NAND Flash Translation Layer attempts to load the block translation table.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.

◆ EvrFsNFTL_ReadTableFailed()

__STATIC_INLINE void EvrFsNFTL_ReadTableFailed ( uint32_t  instance)

Event on NFTL (Error)

Parameters
[in]instanceNFTL instance number

The event ReadTableFailed is generated when block translation table read fails.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.

◆ EvrFsNFTL_RelocateBlock()

__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

The event RelocateBlock is generated when NAND Flash Translation Layer attempts to relocate content from a bad block.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • pbn : physical block number.

◆ EvrFsNFTL_RelocateBlockFailed()

__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

The event RelocateBlockFailed is generated when NAND Flash Translation Layer fails to relocate content from a bad block.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • pbn : physical block number.

◆ EvrFsNFTL_ResetDevice()

__STATIC_INLINE void EvrFsNFTL_ResetDevice ( uint32_t  instance)

Event on NAND device reset (Op)

Parameters
[in]instanceNFTL instance number

The event ResetDevice is generated on attempt to reset the NAND device.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.

◆ EvrFsNFTL_ResetDeviceFailed()

__STATIC_INLINE void EvrFsNFTL_ResetDeviceFailed ( uint32_t  instance)

Event on NAND device reset error (Error)

Parameters
[in]instanceNFTL instance number

The event ResetDeviceFailed is generated when NAND media driver fails to execute device reset operation.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.

◆ EvrFsNFTL_ResetDeviceTimeout()

__STATIC_INLINE void EvrFsNFTL_ResetDeviceTimeout ( uint32_t  instance)

Event on NAND device reset timeout (Error)

Parameters
[in]instanceNFTL instance number

The event ResetDeviceTimeout is generated when device reset operation fails due to the timeout.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.

◆ EvrFsNFTL_SetBadBlockMarker()

__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

The event MoveData is generated on attempt to mark block as bad.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • pbn : physical block number.

◆ EvrFsNFTL_SetupPageLayout()

__STATIC_INLINE void EvrFsNFTL_SetupPageLayout ( uint32_t  instance,
uint32_t  sector_inc,
uint32_t  spare_ofs,
uint32_t  spare_inc 
)

Event on page layout setup (Detail)

Parameters
[in]instanceNFTL instance number
[in]sector_incincrement till next sector
[in]spare_ofsfirst spare area offset
[in]spare_incincrement till next spare

The event SetupPageLayout is generated when NAND Flash Translation Layer sets NAND page layout configuration.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • sector_inc : column increment till next sector - first sector starts at byte zero, second at sect_inc, third at (sect_inc + sect_inc) etc.
  • spare_ofs : spare area offset from beginning of the page.
  • spare_inc : column increment till next spare - first spare area is determined by spare_ofs value, while next spare is at (spare_ofs + spare_inc)

◆ EvrFsNFTL_SetupSpareLayout()

__STATIC_INLINE void EvrFsNFTL_SetupSpareLayout ( uint32_t  instance,
uint32_t  ofs_lsn,
uint32_t  ofs_dcm,
uint32_t  ofs_bbm,
uint32_t  ofs_ecc 
)

Event on spare area layout setup (Detail)

Parameters
[in]instanceNFTL instance number
[in]ofs_lsnLSN position offset
[in]ofs_dcmDCM position offset
[in]ofs_bbmBBM position offset
[in]ofs_eccECC position offset

The event SetupSpareLayout is generated when NAND Flash Translation Layer sets spare area layout configuration.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • ofs_lsn : LSN position, offset within spare area where logical sector number (LSN) is placed.
  • ofs_dcm : DCM position, offset within spare area where data corrupted marker (DCM) is placed.
  • ofs_bbm : BBM position, offset within spare area where bad block marker (BBM) is placed.
  • ofs_ecc : ECC position, offset within spare area where error correction code (ECC) data starts.

◆ EvrFsNFTL_SkipBadBlock()

__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

The event SkipBadBlock is generated when NAND Flash Translation Layer detects bad block and skips the operation till next valid block.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • pbn : physical block number.

◆ EvrFsNFTL_StatusRead()

__STATIC_INLINE void EvrFsNFTL_StatusRead ( uint32_t  instance,
uint32_t  status 
)

Event on status read (Op)

Parameters
[in]instanceNFTL instance number
[in]statusNAND status byte

The event StatusRead is generated when NAND Flash Translation Layer retrieves NAND device status.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • status : NAND device status byte

◆ EvrFsNFTL_TableEntryNotFound()

__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

The event TableEntryNotFound is generated when translation table does not contain translation information for specified logical block.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • lbn : logical block number.

◆ EvrFsNFTL_TableLookup()

__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

The event TableLookup is generated NAND Flash Translation Layer attempts to read translation table in order to retrieve translation information for specified logical block.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • lbn : logical block number.

◆ EvrFsNFTL_TableUpdate()

__STATIC_INLINE void EvrFsNFTL_TableUpdate ( uint32_t  instance,
uint32_t  lbn,
uint32_t  pbn_0,
uint32_t  pbn_1 
)

Event on translation table update (Op)

Parameters
[in]instanceNFTL instance number
[in]lbnlogical block number
[in]pbn_0physical block number
[in]pbn_1physical block number

The event TableUpdate is generated when NAND Flash Translation Layer updates logical to physical block translation info.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • lbn : logical block number
  • src_0 : physical block number (location 0)
  • src_1 : physical block number (location 1)

◆ EvrFsNFTL_Uninit()

__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 and attempts to de-initialize the NAND Flash Translation Layer.

Value of the Event Recorder shows:

  • instance : number of Software Component instance.

◆ EvrFsNFTL_UninitDriver()

__STATIC_INLINE void EvrFsNFTL_UninitDriver ( uint32_t  instance)

Event on NFTL driver uninitialization (Op)

Parameters
[in]instanceNFTL instance number

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

Value of the Event Recorder shows:

  • instance : number of Software Component instance.

◆ EvrFsNFTL_UninitDriverFailed()

__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 fails.

Value of the Event Recorder shows:

  • instance : number of Software Component instance.

◆ EvrFsNFTL_WriteSector()

__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

The event WriteSector is generated when NAND Flash Translation Layer attempts to write data to the flash.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • sector : sector number to write.
  • buf : memory location of the data buffer.
  • cnt : number of sectors to write.

◆ EvrFsNFTL_WriteSectorSuccess()

__STATIC_INLINE void EvrFsNFTL_WriteSectorSuccess ( uint32_t  instance)

Event on successful NFTL write sector operation (Op)

Parameters
[in]instanceNFTL instance number

The event WriteSectorSuccess is generated when NAND Flash Translation Layer successfully writes data to the flash.

Value in the Event Recorder shows:

  • instance : number of Software Component instance.
  • sector : sector number to write.
  • buf : memory location of the data buffer.
  • cnt : number of sectors written.