File System Component  Version 6.14.4
MDK Middleware for Devices with Flash File System
FsIOC: I/O Control Interface

Events generated by File System - I/O Control Interface functions. More...

Functions

__STATIC_INLINE void EvrFsIOC_GetId (uint32_t drive)
 Event on call of fs_ioc_get_id function (API) More...
 
__STATIC_INLINE void EvrFsIOC_GetIdSuccess (uint32_t drive, uint32_t drv_id)
 Event on retrieval of drive ID (Op) More...
 
__STATIC_INLINE void EvrFsIOC_GetIdError (uint32_t drive)
 Event on invalid or nonexisting drive specifier (Error) More...
 
__STATIC_INLINE void EvrFsIOC_Lock (uint32_t drv_id)
 Event on call of fs_ioc_lock function (API) More...
 
__STATIC_INLINE void EvrFsIOC_LockSuccess (uint32_t drv_id)
 Event on successful drive lock operation (Op) More...
 
__STATIC_INLINE void EvrFsIOC_Unlock (uint32_t drv_id)
 Event on call of fs_ioc_unlock function (API) More...
 
__STATIC_INLINE void EvrFsIOC_UnlockSuccess (uint32_t drv_id)
 Event on successful drive unlock operation (Op) More...
 
__STATIC_INLINE void EvrFsIOC_GetCache (uint32_t drv_id, uint32_t cache_info)
 Event on call of fs_ioc_get_cache function (API) More...
 
__STATIC_INLINE void EvrFsIOC_GetCacheSuccess (uint32_t drv_id, uint32_t buf, uint32_t size)
 Event on successful cache buffer information retrieve operation (Op) More...
 
__STATIC_INLINE void EvrFsIOC_ReadSector (uint32_t drv_id, uint32_t sect, uint32_t buf, uint32_t cnt)
 Event on call of fs_ioc_read_sector function (API) More...
 
__STATIC_INLINE void EvrFsIOC_ReadSectorSuccess (uint32_t drv_id, uint32_t sect, uint32_t buf, uint32_t cnt)
 Event on successful read sector operation (Op) More...
 
__STATIC_INLINE void EvrFsIOC_ReadSectorError (uint32_t drv_id, uint32_t sect, uint32_t buf, uint32_t cnt)
 Event on read sector operation error (Error) More...
 
__STATIC_INLINE void EvrFsIOC_WriteSector (uint32_t drv_id, uint32_t sect, uint32_t buf, uint32_t cnt)
 Event on call of fs_ioc_write_sector function (API) More...
 
__STATIC_INLINE void EvrFsIOC_WriteSectorSuccess (uint32_t drv_id, uint32_t sect, uint32_t buf, uint32_t cnt)
 Event on successful read sector operation (Op) More...
 
__STATIC_INLINE void EvrFsIOC_WriteSectorError (uint32_t drv_id, uint32_t sect, uint32_t buf, uint32_t cnt)
 Event on write sector operation error (Error) More...
 
__STATIC_INLINE void EvrFsIOC_ReadInfo (uint32_t drv_id, uint32_t info)
 Event on call of fs_ioc_read_info function (API) More...
 
__STATIC_INLINE void EvrFsIOC_ReadInfoSuccess (uint32_t drv_id, uint32_t block_count)
 Event on successful read info operation (Op) More...
 
__STATIC_INLINE void EvrFsIOC_ReadInfoError (uint32_t drv_id)
 Event on read info operation error (Error) More...
 
__STATIC_INLINE void EvrFsIOC_DeviceControl (uint32_t drv_id, uint32_t code, uint32_t p)
 Event on call of fs_ioc_read_info function (API) More...
 
__STATIC_INLINE void EvrFsIOC_DeviceControlSuccess (uint32_t drv_id, uint32_t code, uint32_t p)
 Event on call of fs_ioc_read_info function (API) More...
 
__STATIC_INLINE void EvrFsIOC_DriveIdInvalid (uint32_t drv_id)
 Event on invalid drive ID specifier (Error) More...
 
__STATIC_INLINE void EvrFsIOC_DriveNotFAT (uint32_t drv_id)
 Event on non-FAT drive specifier (Error) More...
 
__STATIC_INLINE void EvrFsIOC_NotAllowed (uint32_t drive)
 Event on specifying drive without IOC support (Error) More...
 

Description

Events generated by File System - I/O Control Interface functions.

FileSystem - I/O Control Interface

Function Documentation

◆ EvrFsIOC_DeviceControl()

__STATIC_INLINE void EvrFsIOC_DeviceControl ( uint32_t  drv_id,
uint32_t  code,
uint32_t  p 
)

Event on call of fs_ioc_read_info function (API)

Parameters
[in]drv_iddrive ID
[in]codedevice control code fsDevCtrlCode
[in]pgeneric pointer address

The event DeviceControl is generated when the function fs_ioc_device_ctrl is executed.

Value in the Event Recorder shows:

  • drv_id : drive ID as an integer.
  • code : string specifying the key name of the control code.
  • p : memory address of the control code parameter.

◆ EvrFsIOC_DeviceControlSuccess()

__STATIC_INLINE void EvrFsIOC_DeviceControlSuccess ( uint32_t  drv_id,
uint32_t  code,
uint32_t  p 
)

Event on call of fs_ioc_read_info function (API)

Parameters
[in]drv_iddrive ID
[in]codedevice control code fsDevCtrlCode
[in]pgeneric pointer address

The event DeviceControlSuccess is generated when the function fs_ioc_device_ctrl executes successfully.

Value in the Event Recorder shows:

  • drv_id : drive ID as an integer.
  • code : string specifying the key name of the control code.
  • p : memory address of the control code parameter.

◆ EvrFsIOC_DriveIdInvalid()

__STATIC_INLINE void EvrFsIOC_DriveIdInvalid ( uint32_t  drv_id)

Event on invalid drive ID specifier (Error)

Parameters
[in]drv_iddrive ID

The event DriveIdInvalid is generated when I/O Control Interface Routines detect invalid drive ID specification.

Value in the Event Recorder shows:

  • drv_id : drive ID as an integer.

◆ EvrFsIOC_DriveNotFAT()

__STATIC_INLINE void EvrFsIOC_DriveNotFAT ( uint32_t  drv_id)

Event on non-FAT drive specifier (Error)

Parameters
[in]drv_iddrive ID

The event DriveNotFAT is generated when I/O Control Interface Routines detect that drive ID specifies non FAT drive.

Value in the Event Recorder shows:

  • drv_id : drive ID as an integer.

◆ EvrFsIOC_GetCache()

__STATIC_INLINE void EvrFsIOC_GetCache ( uint32_t  drv_id,
uint32_t  cache_info 
)

Event on call of fs_ioc_get_cache function (API)

Parameters
[in]drv_iddrive ID
[in]cache_infocache information structure address

The event GetCache is generated when the function fs_ioc_get_cache is executed.

Value in the Event Recorder shows:

  • drv_id : drive ID as an integer.
  • cache_info : memory address of the fsIOC_Cache structure.

◆ EvrFsIOC_GetCacheSuccess()

__STATIC_INLINE void EvrFsIOC_GetCacheSuccess ( uint32_t  drv_id,
uint32_t  buf,
uint32_t  size 
)

Event on successful cache buffer information retrieve operation (Op)

Parameters
[in]drv_iddrive ID
[in]bufcache buffer address
[in]sizecache buffer size

The event GetCacheSuccess is generated when the function fs_ioc_get_cache executes successfully and drive cache information is retrieved.

Value in the Event Recorder shows:

  • drv_id : drive ID as an integer.
  • buf : memory address of the drive cache buffer.
  • size : drive cache buffer size in bytes.

◆ EvrFsIOC_GetId()

__STATIC_INLINE void EvrFsIOC_GetId ( uint32_t  drive)

Event on call of fs_ioc_get_id function (API)

Parameters
[in]drive4 byte encoded drive letter

The event GetId is generated when the function fs_ioc_get_id is called.

Value in the Event Recorder shows:

  • drive : identifier of the drive.

◆ EvrFsIOC_GetIdError()

__STATIC_INLINE void EvrFsIOC_GetIdError ( uint32_t  drive)

Event on invalid or nonexisting drive specifier (Error)

Parameters
[in]drive4 byte encoded drive letter

The event GetIdError is generated when the function fs_ioc_get_id detects nonexistent drive or invalid drive specification.

Value in the Event Recorder shows:

  • drive : identifier of the drive.

◆ EvrFsIOC_GetIdSuccess()

__STATIC_INLINE void EvrFsIOC_GetIdSuccess ( uint32_t  drive,
uint32_t  drv_id 
)

Event on retrieval of drive ID (Op)

Parameters
[in]drive4 byte encoded drive letter
[in]drv_iddrive ID

The event GetIdSuccess is generated when the function fs_ioc_get_id executes successfully.

Value in the Event Recorder shows:

  • drive : identifier of the drive.
  • drv_id : drive ID as an integer.

◆ EvrFsIOC_Lock()

__STATIC_INLINE void EvrFsIOC_Lock ( uint32_t  drv_id)

Event on call of fs_ioc_lock function (API)

Parameters
[in]drv_iddrive ID

The event Lock is generated when the function fs_ioc_lock is executed.

Value in the Event Recorder shows:

  • drv_id : drive ID as an integer.

◆ EvrFsIOC_LockSuccess()

__STATIC_INLINE void EvrFsIOC_LockSuccess ( uint32_t  drv_id)

Event on successful drive lock operation (Op)

Parameters
[in]drv_iddrive ID

The event LockSuccess is generated when the function fs_ioc_lock successfully prepares the drive for I/O Control access.

Value in the Event Recorder shows:

  • drv_id : drive ID as an integer.

◆ EvrFsIOC_NotAllowed()

__STATIC_INLINE void EvrFsIOC_NotAllowed ( uint32_t  drive)

Event on specifying drive without IOC support (Error)

Parameters
[in]drive4 byte encoded drive letter

The event NotAllowed is generated when I/O Control Interface Routines detect that I/O Control access is not allowed for specified drive.

Value in the Event Recorder shows:

  • drive : identifier of the drive.

◆ EvrFsIOC_ReadInfo()

__STATIC_INLINE void EvrFsIOC_ReadInfo ( uint32_t  drv_id,
uint32_t  info 
)

Event on call of fs_ioc_read_info function (API)

Parameters
[in]drv_iddrive ID
[in]infomedia information structure address

The event ReadInfo is generated when the function fs_ioc_read_info is executed.

Value in the Event Recorder shows:

  • drv_id : drive ID as an integer.

◆ EvrFsIOC_ReadInfoError()

__STATIC_INLINE void EvrFsIOC_ReadInfoError ( uint32_t  drv_id)

Event on read info operation error (Error)

Parameters
[in]drv_iddrive ID

The event ReadInfoError is generated when the function fs_ioc_read_info fails due to the media driver error.

Value in the Event Recorder shows:

  • drv_id : drive ID as an integer.

◆ EvrFsIOC_ReadInfoSuccess()

__STATIC_INLINE void EvrFsIOC_ReadInfoSuccess ( uint32_t  drv_id,
uint32_t  block_count 
)

Event on successful read info operation (Op)

Parameters
[in]drv_iddrive ID
[in]block_countmedia capacity in 512 bytes blocks

The event ReadInfoSuccess is generated when the function fs_ioc_read_info executes successfully and storage geometry properties are retrieved.

Value in the Event Recorder shows:

  • drv_id : drive ID as an integer.
  • sect_count : number of sectors available on the memory media.

◆ EvrFsIOC_ReadSector()

__STATIC_INLINE void EvrFsIOC_ReadSector ( uint32_t  drv_id,
uint32_t  sect,
uint32_t  buf,
uint32_t  cnt 
)

Event on call of fs_ioc_read_sector function (API)

Parameters
[in]drv_iddrive ID
[in]sectsector number
[in]bufdata buffer address
[in]cntnumber of sectors

The event ReadSector is generated when the function fs_ioc_read_sector is executed.

Value in the Event Recorder shows:

  • drv_id : drive ID as an integer.
  • sect : sector number to read.
  • buf : data buffer memory location.
  • cnt : number of sectors to read.

◆ EvrFsIOC_ReadSectorError()

__STATIC_INLINE void EvrFsIOC_ReadSectorError ( uint32_t  drv_id,
uint32_t  sect,
uint32_t  buf,
uint32_t  cnt 
)

Event on read sector operation error (Error)

Parameters
[in]drv_iddrive ID
[in]sectsector number
[in]bufdata buffer address
[in]cntnumber of sectors

The event ReadSectorError is generated when the function fs_ioc_read_sector fails due to the media driver error.

Value in the Event Recorder shows:

  • drv_id : drive ID as an integer.
  • sect : sector number to read.
  • buf : data buffer memory location.
  • cnt : number of sectors to read.

◆ EvrFsIOC_ReadSectorSuccess()

__STATIC_INLINE void EvrFsIOC_ReadSectorSuccess ( uint32_t  drv_id,
uint32_t  sect,
uint32_t  buf,
uint32_t  cnt 
)

Event on successful read sector operation (Op)

Parameters
[in]drv_iddrive ID
[in]sectsector number
[in]bufdata buffer address
[in]cntnumber of sectors

The event ReadSectorSuccess is generated when the function fs_ioc_read_sector executes successfully.

Value in the Event Recorder shows:

  • drv_id : drive ID as an integer.
  • sect : sector number to read.
  • buf : data buffer memory location.
  • cnt : number of sectors to read.

◆ EvrFsIOC_Unlock()

__STATIC_INLINE void EvrFsIOC_Unlock ( uint32_t  drv_id)

Event on call of fs_ioc_unlock function (API)

Parameters
[in]drv_iddrive ID

The event Unlock is generated when the function fs_ioc_unlock is executed.

Value in the Event Recorder shows:

  • drv_id : drive ID as an integer.

◆ EvrFsIOC_UnlockSuccess()

__STATIC_INLINE void EvrFsIOC_UnlockSuccess ( uint32_t  drv_id)

Event on successful drive unlock operation (Op)

Parameters
[in]drv_iddrive ID

The event UnlockSuccess is generated when the function fs_ioc_unlock successfully releases the drive I/O Control access.

Value in the Event Recorder shows:

  • drv_id : drive ID as an integer.

◆ EvrFsIOC_WriteSector()

__STATIC_INLINE void EvrFsIOC_WriteSector ( uint32_t  drv_id,
uint32_t  sect,
uint32_t  buf,
uint32_t  cnt 
)

Event on call of fs_ioc_write_sector function (API)

Parameters
[in]drv_iddrive ID
[in]sectsector number
[in]bufdata buffer address
[in]cntnumber of sectors

The event WriteSector is generated when the function fs_ioc_write_sector is executed.

Value in the Event Recorder shows:

  • drv_id : drive ID as an integer.
  • sect : sector number to write.
  • buf : data buffer memory location.
  • cnt : number of sectors to write.

◆ EvrFsIOC_WriteSectorError()

__STATIC_INLINE void EvrFsIOC_WriteSectorError ( uint32_t  drv_id,
uint32_t  sect,
uint32_t  buf,
uint32_t  cnt 
)

Event on write sector operation error (Error)

Parameters
[in]drv_iddrive ID
[in]sectsector number
[in]bufdata buffer address
[in]cntnumber of sectors

The event WriteSectorError is generated when the function fs_ioc_write_sector fails due to the media driver error.

Value in the Event Recorder shows:

  • drv_id : drive ID as an integer.
  • sect : sector number to write.
  • buf : data buffer memory location.
  • cnt : number of sectors to write.

◆ EvrFsIOC_WriteSectorSuccess()

__STATIC_INLINE void EvrFsIOC_WriteSectorSuccess ( uint32_t  drv_id,
uint32_t  sect,
uint32_t  buf,
uint32_t  cnt 
)

Event on successful read sector operation (Op)

Parameters
[in]drv_iddrive ID
[in]sectsector number
[in]bufdata buffer address
[in]cntnumber of sectors

The event WriteSectorSuccess is generated when the function fs_ioc_write_sector executes successfully.

Value in the Event Recorder shows:

  • drv_id : drive ID as an integer.
  • sect : sector number to write.
  • buf : data buffer memory location.
  • cnt : number of sectors to write.