File System Component  
MDK Middleware for Devices with Flash File System
 
Loading...
Searching...
No Matches
FsCore: Core Management

Events generated by File System - Core Management functions. More...

Functions

__STATIC_INLINE void EvrFsCore_sys_open (const char *name, int openmode)
 Event on file open (API)
 
__STATIC_INLINE void EvrFsCore_sys_close (int fh)
 Event on file close (API)
 
__STATIC_INLINE void EvrFsCore_sys_write (int fh, const unsigned char *buf, unsigned int len)
 Event on write to a file (API)
 
__STATIC_INLINE void EvrFsCore_sys_read (int fh, unsigned char *buf, unsigned int len)
 Event on read from a file (API)
 
__STATIC_INLINE void EvrFsCore_sys_seek (int fh, long pos)
 Event on file position move (API)
 
__STATIC_INLINE void EvrFsCore_sys_flen (int fh)
 Event on current file length request (API)
 
__STATIC_INLINE void EvrFsCore_sys_handle_assign (const char *name, int fh)
 Event on file handle assignment (Op)
 
__STATIC_INLINE void EvrFsCore_finit (const char *drive)
 Event on drive initialization (API)
 
__STATIC_INLINE void EvrFsCore_funinit (const char *drive)
 Event on drive uninitialization (API)
 
__STATIC_INLINE void EvrFsCore_fmount (const char *drive)
 Event on drive mount (API)
 
__STATIC_INLINE void EvrFsCore_funmount (const char *drive)
 Event on drive unmount (API)
 
__STATIC_INLINE void EvrFsCore_fdelete (const char *path, const char *options)
 Event on file delete (API)
 
__STATIC_INLINE void EvrFsCore_ffind (const char *pattern, fsFileInfo *info)
 Event on file or directory search (API)
 
__STATIC_INLINE void EvrFsCore_frename (const char *path, const char *newname)
 Event on file or directory rename (API)
 
__STATIC_INLINE void EvrFsCore_fattrib (const char *path, const char *attr)
 Event on file or directory attribute change (API)
 
__STATIC_INLINE void EvrFsCore_fpwd (const char *drive, char *buf, uint32_t len)
 Event on working directory retrieval (API)
 
__STATIC_INLINE void EvrFsCore_fchdir (const char *path)
 Event on working directory change (API)
 
__STATIC_INLINE void EvrFsCore_fmkdir (const char *path)
 Event on directory create (API)
 
__STATIC_INLINE void EvrFsCore_frmdir (const char *path, const char *options)
 Event on directory remove (API)
 
__STATIC_INLINE void EvrFsCore_fchdrive (const char *drive)
 Event on current drive change (API)
 
__STATIC_INLINE void EvrFsCore_ffree (const char *drive)
 Event on free space retrieval (API)
 
__STATIC_INLINE void EvrFsCore_fformat (const char *drive, const char *options)
 Event on drive format (API)
 
__STATIC_INLINE void EvrFsCore_fanalyse (const char *drive)
 Event on drive analyse (API)
 
__STATIC_INLINE void EvrFsCore_fcheck (const char *drive)
 Event on drive check (API)
 
__STATIC_INLINE void EvrFsCore_fdefrag (const char *drive)
 Event on drive defrag (API)
 
__STATIC_INLINE void EvrFsCore_fmedia (const char *drive)
 Event on media presence check (API)
 
__STATIC_INLINE void EvrFsCore_finfo (const char *drive, fsDriveInfo *info)
 Event on drive information read (API)
 
__STATIC_INLINE void EvrFsCore_fvol (const char *drive, char *label, uint32_t *serial)
 Event on drive label and serial number read (API)
 
__STATIC_INLINE void EvrFsCore_InvalidDrive (uint32_t drive)
 Event on invalid or disabled drive specifier (Error)
 
__STATIC_INLINE void EvrFsCore_CurrentDriveSelect (uint32_t drive)
 Event on current drive selection (Op)
 
__STATIC_INLINE void EvrFsCore_ftime_set (const char *path, fsTime *create, fsTime *access, fsTime *write)
 Event on file or directory timestamp set (API)
 
__STATIC_INLINE void EvrFsCore_ftime_get (const char *path, fsTime *create, fsTime *access, fsTime *write)
 Event on file or directory timestamp get (API)
 
__STATIC_INLINE void EvrFsCore_fversion (uint32_t version)
 Event on FileSystem component version retrieve (API)
 

Description

Events generated by File System - Core Management functions.

The File System - Core management functions generate events that inform about the general drive status.

Function Documentation

◆ EvrFsCore_CurrentDriveSelect()

__STATIC_INLINE void EvrFsCore_CurrentDriveSelect ( uint32_t  drive)

Event on current drive selection (Op)

Parameters
[in]drive4 byte encoded drive letter

The event CurrentDriveSelect is generated when no drive is specified. In this case the current drive is used.

Value in the Event Recorder shows:

  • drive : identifier of the drive.

◆ EvrFsCore_fanalyse()

__STATIC_INLINE void EvrFsCore_fanalyse ( const char *  drive)

Event on drive analyse (API)

Parameters
[in]drivea string specifying the drive.

The event fanalyse is generated when the function fanalyse is called.

Value in the Event Recorder shows:

  • drive : hex value specifying the memory location of the drive specification string.

◆ EvrFsCore_fattrib()

__STATIC_INLINE void EvrFsCore_fattrib ( const char *  path,
const char *  attr 
)

Event on file or directory attribute change (API)

Parameters
[in]patha string specifying the file or directory.
[in]attrstring specifying file or directory attributes to be modified.

The event fattrib is generated when the function fattrib is called.

Value in the Event Recorder shows:

  • path : hex value specifying the memory location of the file path string.
  • attr : hex value specifying the memory location of the attribute specification string.

◆ EvrFsCore_fchdir()

__STATIC_INLINE void EvrFsCore_fchdir ( const char *  path)

Event on working directory change (API)

Parameters
[in]patha string specifying the directory path.

The event fchdir is generated when the function fchdir is called.

Value in the Event Recorder shows:

  • path : hex value specifying the memory location of the directory path string.

◆ EvrFsCore_fchdrive()

__STATIC_INLINE void EvrFsCore_fchdrive ( const char *  drive)

Event on current drive change (API)

Parameters
[in]drivea string specifying the drive.

The event fchdrive is generated when the function fchdrive is called.

Value in the Event Recorder shows:

  • drive : hex value specifying the memory location of the drive specification string.

◆ EvrFsCore_fcheck()

__STATIC_INLINE void EvrFsCore_fcheck ( const char *  drive)

Event on drive check (API)

Parameters
[in]drivea string specifying the drive.

The event fcheck is generated when the function fcheck is called.

Value in the Event Recorder shows:

  • drive : hex value specifying the memory location of the drive specification string.

◆ EvrFsCore_fdefrag()

__STATIC_INLINE void EvrFsCore_fdefrag ( const char *  drive)

Event on drive defrag (API)

Parameters
[in]drivea string specifying the drive.

The event fdefrag is generated when the function fdefrag is called.

Value in the Event Recorder shows:

  • drive : hex value specifying the memory location of the drive specification string.

◆ EvrFsCore_fdelete()

__STATIC_INLINE void EvrFsCore_fdelete ( const char *  path,
const char *  options 
)

Event on file delete (API)

Parameters
[in]patha string specifying the file or directory.
[in]optionsa string specifying function options.

The event fdelete is generated when the function fdelete is called.

Value in the Event Recorder shows:

  • path : hex value specifying the memory location of the file path string.
  • options : hex value specifying the memory location of the delete options string.

◆ EvrFsCore_ffind()

__STATIC_INLINE void EvrFsCore_ffind ( const char *  pattern,
fsFileInfo info 
)

Event on file or directory search (API)

Parameters
[in]patterna string specifying the pattern.
[in]infostructure storing information about matching files.

The event ffind is generated when the function ffind is called.

Value in the Event Recorder shows:

  • pattern : hex value specifying the memory location of the search pattern string.
  • info : hex value specifying the memory location of the file info structure.

◆ EvrFsCore_fformat()

__STATIC_INLINE void EvrFsCore_fformat ( const char *  drive,
const char *  options 
)

Event on drive format (API)

Parameters
[in]drivea string specifying the drive.
[in]optionsstring specifying formatting options.

The event fformat is generated when the function fformat is called.

Value in the Event Recorder shows:

  • drive : hex value specifying the memory location of the drive specification string.
  • options : hex value specifying the memory location of format options string.

◆ EvrFsCore_ffree()

__STATIC_INLINE void EvrFsCore_ffree ( const char *  drive)

Event on free space retrieval (API)

Parameters
[in]drivea string specifying the drive.

The event ffree is generated when the function ffree is called.

Value in the Event Recorder shows:

  • drive : hex value specifying the memory location of the drive specification string.

◆ EvrFsCore_finfo()

__STATIC_INLINE void EvrFsCore_finfo ( const char *  drive,
fsDriveInfo info 
)

Event on drive information read (API)

Parameters
[in]drivea string specifying the drive.
[in]infodrive information structure.

The event finfo is generated when the function finfo is called.

Value in the Event Recorder shows:

  • drive : hex value specifying the memory location of the drive specification string.
  • info : hex value specifying the memory location of the drive info structure.

◆ EvrFsCore_finit()

__STATIC_INLINE void EvrFsCore_finit ( const char *  drive)

Event on drive initialization (API)

Parameters
[in]drivespecified drive

The event finit is generated when the function finit is called.

Value in the Event Recorder shows:

  • drive : hex value specifying the memory location of the drive specification string.

◆ EvrFsCore_fmedia()

__STATIC_INLINE void EvrFsCore_fmedia ( const char *  drive)

Event on media presence check (API)

Parameters
[in]drivea string specifying the drive.

The event fmedia is generated when the function fmedia is called.

Value in the Event Recorder shows:

  • drive : hex value specifying the memory location of the drive specification string.

◆ EvrFsCore_fmkdir()

__STATIC_INLINE void EvrFsCore_fmkdir ( const char *  path)

Event on directory create (API)

Parameters
[in]patha string specifying directory path.

The event fmkdir is generated when the function fmkdir is called.

Value in the Event Recorder shows:

  • path : hex value specifying the memory location of the directory path string.

◆ EvrFsCore_fmount()

__STATIC_INLINE void EvrFsCore_fmount ( const char *  drive)

Event on drive mount (API)

Parameters
[in]drivespecified drive

The event fmount is generated when the function fmount is called.

Value in the Event Recorder shows:

  • drive : hex value specifying the memory location of the drive specification string.

◆ EvrFsCore_fpwd()

__STATIC_INLINE void EvrFsCore_fpwd ( const char *  drive,
char *  buf,
uint32_t  len 
)

Event on working directory retrieval (API)

Parameters
[in]drivea string specifying the file or directory.
[in]bufpointer to string buffer.
[in]lenstring buffer length.

The event fpwd is generated when the function fpwd is called.

Value in the Event Recorder shows:

  • drive : hex value specifying the memory location of the drive specification string.
  • buf : hex value specifying the data buffer memory location.
  • len : data buffer length.

◆ EvrFsCore_frename()

__STATIC_INLINE void EvrFsCore_frename ( const char *  path,
const char *  newname 
)

Event on file or directory rename (API)

Parameters
[in]patha string specifying the file or directory.
[in]newnamea string specifying new file or directory name.

The event frename is generated when the function frename is called.

Value in the Event Recorder shows:

  • path : hex value specifying the memory location of the file path string.
  • newname : hex value specifying the memory location of the new file name string.

◆ EvrFsCore_frmdir()

__STATIC_INLINE void EvrFsCore_frmdir ( const char *  path,
const char *  options 
)

Event on directory remove (API)

Parameters
[in]patha string specifying directory path.
[in]optionsa string specifying function options.

The event frmdir is generated when the function frmdir is called.

Value in the Event Recorder shows:

  • path : hex value specifying the memory location of the directory path string.
  • options : hex value specifying the memory location of the remove options string.

◆ EvrFsCore_ftime_get()

__STATIC_INLINE void EvrFsCore_ftime_get ( const char *  path,
fsTime create,
fsTime access,
fsTime write 
)

Event on file or directory timestamp get (API)

Parameters
[in]pathstring specifying the file or directory path.
[out]createfsTime structure where file creation time will be stored
[out]accessfsTime structure where file last access time will be stored
[out]writefsTime structure where file last write time will be stored

The event ftime_get is generated when the function ftime_get is called.

Value in the Event Recorder shows:

  • path : hex value specifying the memory location of the file path string.
  • create : hex value specifying the memory location of the fsTime structure where create time information will be stored.
  • access : hex value specifying the memory location of the fsTime structure where last access time information will be stored.
  • write : hex value specifying the memory location of the fsTime structure where last write time information will be stored.

◆ EvrFsCore_ftime_set()

__STATIC_INLINE void EvrFsCore_ftime_set ( const char *  path,
fsTime create,
fsTime access,
fsTime write 
)

Event on file or directory timestamp set (API)

Parameters
[in]pathstring specifying the file or directory path.
[in]createfsTime structure specifying the file creation time
[in]accessfsTime structure specifying the file last access time
[in]writefsTime structure specifying the file last write time

The event ftime_set is generated when the function ftime_set is called.

Value in the Event Recorder shows:

  • path : hex value specifying the memory location of the file path string.
  • create : hex value specifying the memory location of the fsTime structure containing create time information.
  • access : hex value specifying the memory location of the fsTime structure containing last access time information.
  • write : hex value specifying the memory location of the fsTime structure containing last write time information.

◆ EvrFsCore_funinit()

__STATIC_INLINE void EvrFsCore_funinit ( const char *  drive)

Event on drive uninitialization (API)

Parameters
[in]drivespecified drive

The event funinit is generated when the function funinit is called.

Value in the Event Recorder shows:

  • drive : hex value specifying the memory location of the drive specification string.

◆ EvrFsCore_funmount()

__STATIC_INLINE void EvrFsCore_funmount ( const char *  drive)

Event on drive unmount (API)

Parameters
[in]drivespecified drive

The event funmount is generated when the function funmount is called.

Value in the Event Recorder shows:

  • drive : hex value specifying the memory location of the drive specification string.

◆ EvrFsCore_fversion()

__STATIC_INLINE void EvrFsCore_fversion ( uint32_t  version)

Event on FileSystem component version retrieve (API)

Parameters
[in]versionBCD encoded version: 0xMMmmbbbb (MM:major, mm:minor, bbbb:build)

The event fversion get is generated when the function fversion is called.

Value in the Event Recorder shows:

  • FileSystem component version in decimal format: MM.mm.bbbb

◆ EvrFsCore_fvol()

__STATIC_INLINE void EvrFsCore_fvol ( const char *  drive,
char *  label,
uint32_t *  serial 
)

Event on drive label and serial number read (API)

Parameters
[in]drivea string specifying the drive.
[in]labelbuffer for storing label as a null terminated string.
[in]serialpointer to variable where serial number will be stored.

The event fvol is generated when the function fvol is called.

Value in the Event Recorder shows:

  • drive : hex value specifying the memory location of the drive specification string.
  • label : hex value specifying the memory location of the label buffer.
  • serial : hex value specifying the memory location of the 32-bit variable.

◆ EvrFsCore_InvalidDrive()

__STATIC_INLINE void EvrFsCore_InvalidDrive ( uint32_t  drive)

Event on invalid or disabled drive specifier (Error)

Parameters
[in]drive4 byte encoded drive letter

The event InvalidDrive is generated when an invalid or disabled drive is specified.

Value in the Event Recorder shows:

  • drive : identifier of the drive.

◆ EvrFsCore_sys_close()

__STATIC_INLINE void EvrFsCore_sys_close ( int  fh)

Event on file close (API)

Parameters
[in]fhfile handle

The event sys_close is generated when Standard I/O Routines call the _sys_close retarget function.

Value in the Event Recorder shows:

◆ EvrFsCore_sys_flen()

__STATIC_INLINE void EvrFsCore_sys_flen ( int  fh)

Event on current file length request (API)

Parameters
[in]fhfile handle

The event sys_flen is generated when Standard I/O Routines call the _sys_flen retarget function.

Value in the Event Recorder shows:

◆ EvrFsCore_sys_handle_assign()

__STATIC_INLINE void EvrFsCore_sys_handle_assign ( const char *  name,
int  fh 
)

Event on file handle assignment (Op)

Parameters
[in]namefile name pointer
[in]fhfile handle

The event sys_handle_assign is generated when file handle number is assigned to a file name.

File handle number consists of File System type and file handle index. Bit representation is as follows:

Bit Description
0:15 File handle index
16 File handle is assigned to a file opened on a FAT file system
17 File handle is assigned to a file opened on a EFS file system

Value in the Event Recorder shows:

  • name : file name buffer address.
  • fh : file handle number.

◆ EvrFsCore_sys_open()

__STATIC_INLINE void EvrFsCore_sys_open ( const char *  name,
int  openmode 
)

Event on file open (API)

Parameters
[in]namefile name pointer
[in]openmodeANSI open mode bitmap

The event sys_open is generated when Standard I/O Routines call the _sys_open retarget function.

The openmode parameter is a bitmap whose bits correspond directly to the ISO mode specification:

Bit Description
0 Request to open file in read mode
1 Request to open file in binary mode
2 Request to open file for update
4 Request to open file in write more
8 Request to open file in append mode

Value in the Event Recorder shows:

  • name : file name buffer address.
  • openmode: open mode bitmap.

◆ EvrFsCore_sys_read()

__STATIC_INLINE void EvrFsCore_sys_read ( int  fh,
unsigned char *  buf,
unsigned int  len 
)

Event on read from a file (API)

Parameters
[in]fhfile handle
[in]bufdata buffer
[in]lendata length

The event sys_read is generated when Standard I/O Routines call the _sys_read retarget function.

Value in the Event Recorder shows:

◆ EvrFsCore_sys_seek()

__STATIC_INLINE void EvrFsCore_sys_seek ( int  fh,
long  pos 
)

Event on file position move (API)

Parameters
[in]fhfile handle
[in]posfile position from the file start

The event sys_seek is generated when Standard I/O Routines call the _sys_seek retarget function.

Value in the Event Recorder shows:

◆ EvrFsCore_sys_write()

__STATIC_INLINE void EvrFsCore_sys_write ( int  fh,
const unsigned char *  buf,
unsigned int  len 
)

Event on write to a file (API)

Parameters
[in]fhfile handle
[in]bufdata buffer
[in]lendata length

The event sys_write is generated when Standard I/O Routines call the _sys_write retarget function.

Value in the Event Recorder shows: