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) More...

__STATIC_INLINE void	EvrFsCore_sys_close (int fh)
	Event on file close (API) More...

__STATIC_INLINE void	EvrFsCore_sys_write (int fh, const unsigned char *buf, unsigned int len)
	Event on write to a file (API) More...

__STATIC_INLINE void	EvrFsCore_sys_read (int fh, unsigned char *buf, unsigned int len)
	Event on read from a file (API) More...

__STATIC_INLINE void	EvrFsCore_sys_seek (int fh, long pos)
	Event on file position move (API) More...

__STATIC_INLINE void	EvrFsCore_sys_flen (int fh)
	Event on current file length request (API) More...

__STATIC_INLINE void	EvrFsCore_sys_handle_assign (const char *name, int fh)
	Event on file handle assignment (Op) More...

__STATIC_INLINE void	EvrFsCore_finit (const char *drive)
	Event on drive initialization (API) More...

__STATIC_INLINE void	EvrFsCore_funinit (const char *drive)
	Event on drive uninitialization (API) More...

__STATIC_INLINE void	EvrFsCore_fmount (const char *drive)
	Event on drive mount (API) More...

__STATIC_INLINE void	EvrFsCore_funmount (const char *drive)
	Event on drive unmount (API) More...

__STATIC_INLINE void	EvrFsCore_fdelete_l (const char *path)
	Event on file delete (API) More...

__STATIC_INLINE void	EvrFsCore_fdelete (const char path, const char options)
	Event on file delete (API) More...

__STATIC_INLINE void	EvrFsCore_ffind (const char pattern, fsFileInfo info)
	Event on file or directory search (API) More...

__STATIC_INLINE void	EvrFsCore_frename (const char path, const char newname)
	Event on file or directory rename (API) More...

__STATIC_INLINE void	EvrFsCore_fattrib (const char path, const char attr)
	Event on file or directory attribute change (API) More...

__STATIC_INLINE void	EvrFsCore_fpwd (const char drive, char buf, uint32_t len)
	Event on working directory retrieval (API) More...

__STATIC_INLINE void	EvrFsCore_fchdir (const char *path)
	Event on working directory change (API) More...

__STATIC_INLINE void	EvrFsCore_fmkdir (const char *path)
	Event on directory create (API) More...

__STATIC_INLINE void	EvrFsCore_frmdir (const char path, const char options)
	Event on directory remove (API) More...

__STATIC_INLINE void	EvrFsCore_fchdrive (const char *drive)
	Event on current drive change (API) More...

__STATIC_INLINE void	EvrFsCore_ffree (const char *drive)
	Event on free space retrieval (API) More...

__STATIC_INLINE void	EvrFsCore_fformat (const char drive, const char options)
	Event on drive format (API) More...

__STATIC_INLINE void	EvrFsCore_fanalyse (const char *drive)
	Event on drive analyse (API) More...

__STATIC_INLINE void	EvrFsCore_fcheck (const char *drive)
	Event on drive check (API) More...

__STATIC_INLINE void	EvrFsCore_fdefrag (const char *drive)
	Event on drive defrag (API) More...

__STATIC_INLINE void	EvrFsCore_fmedia (const char *drive)
	Event on media presence check (API) More...

__STATIC_INLINE void	EvrFsCore_finfo (const char drive, fsDriveInfo info)
	Event on drive information read (API) More...

__STATIC_INLINE void	EvrFsCore_fvol (const char drive, char label, uint32_t *serial)
	Event on drive label and serial number read (API) More...

__STATIC_INLINE void	EvrFsCore_InvalidDrive (uint32_t drive)
	Event on invalid or disabled drive specifier (Error) More...

__STATIC_INLINE void	EvrFsCore_CurrentDriveSelect (uint32_t drive)
	Event on current drive selection (Op) More...

__STATIC_INLINE void	EvrFsCore_ftime_set (const char path, fsTime create, fsTime access, fsTime write)
	Event on file or directory timestamp set (API) More...

__STATIC_INLINE void	EvrFsCore_ftime_get (const char path, fsTime create, fsTime access, fsTime write)
	Event on file or directory timestamp get (API) More...

__STATIC_INLINE void	EvrFsCore_fversion (uint32_t version)
	Event on FileSystem component version retrieve (API) More...

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] drive 4 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] drive a 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]	path	a string specifying the file or directory.
[in]	attr	string 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] path a 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] drive a 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] drive a 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] drive a 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]	path	a string specifying the file or directory.
[in]	options	a 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_fdelete_l()

__STATIC_INLINE void EvrFsCore_fdelete_l ( const char * path )

Event on file delete (API)

Parameters

[in] path a string specifying the file or directory.

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

Value in the Event Recorder shows:

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

◆ EvrFsCore_ffind()

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

Event on file or directory search (API)

Parameters

[in]	pattern	a string specifying the pattern.
[in]	info	structure 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]	drive	a string specifying the drive.
[in]	options	string 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] drive a 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]	drive	a string specifying the drive.
[in]	info	drive 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] drive specified 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] drive a 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] path a 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] drive specified 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]	drive	a string specifying the file or directory.
[in]	buf	pointer to string buffer.
[in]	len	string 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]	path	a string specifying the file or directory.
[in]	newname	a 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]	path	a string specifying directory path.
[in]	options	a 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]	path	string specifying the file or directory path.
[out]	create	fsTime structure where file creation time will be stored
[out]	access	fsTime structure where file last access time will be stored
[out]	write	fsTime 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]	path	string specifying the file or directory path.
[in]	create	fsTime structure specifying the file creation time
[in]	access	fsTime structure specifying the file last access time
[in]	write	fsTime 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] drive specified 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] drive specified 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] version BCD 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]	drive	a string specifying the drive.
[in]	label	buffer for storing label as a null terminated string.
[in]	serial	pointer 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] drive 4 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] fh file handle

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

Value in the Event Recorder shows:

fh : file handle number (see also EvrFsCore_sys_handle_assign).

◆ EvrFsCore_sys_flen()

__STATIC_INLINE void EvrFsCore_sys_flen ( int fh )

Event on current file length request (API)

Parameters

[in] fh file handle

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

Value in the Event Recorder shows:

fh : file handle number (see also EvrFsCore_sys_handle_assign).

◆ EvrFsCore_sys_handle_assign()

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

Event on file handle assignment (Op)

Parameters

[in]	name	file name pointer
[in]	fh	file 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]	name	file name pointer
[in]	openmode	ANSI 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]	fh	file handle
[in]	buf	data buffer
[in]	len	data length

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

Value in the Event Recorder shows:

fh : file handle number (see also EvrFsCore_sys_handle_assign).
buf : data buffer address.
len : data length.

◆ EvrFsCore_sys_seek()

__STATIC_INLINE void EvrFsCore_sys_seek	(	int	fh,
		long	pos
	)

Event on file position move (API)

Parameters

[in]	fh	file handle
[in]	pos	file 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:

fh : file handle number (see also EvrFsCore_sys_handle_assign).
pos : file cursor location.

◆ 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]	fh	file handle
[in]	buf	data buffer
[in]	len	data length

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

Value in the Event Recorder shows:

fh : file handle number (see also EvrFsCore_sys_handle_assign).
buf : data buffer address.
len : data length.

Functions

Description

Function Documentation

◆ EvrFsCore_CurrentDriveSelect()

◆ EvrFsCore_fanalyse()

◆ EvrFsCore_fattrib()

◆ EvrFsCore_fchdir()

◆ EvrFsCore_fchdrive()

◆ EvrFsCore_fcheck()

◆ EvrFsCore_fdefrag()

◆ EvrFsCore_fdelete()

◆ EvrFsCore_fdelete_l()

◆ EvrFsCore_ffind()

◆ EvrFsCore_fformat()

◆ EvrFsCore_ffree()

◆ EvrFsCore_finfo()

◆ EvrFsCore_finit()

◆ EvrFsCore_fmedia()

◆ EvrFsCore_fmkdir()

◆ EvrFsCore_fmount()

◆ EvrFsCore_fpwd()

◆ EvrFsCore_frename()

◆ EvrFsCore_frmdir()

◆ EvrFsCore_ftime_get()

◆ EvrFsCore_ftime_set()

◆ EvrFsCore_funinit()

◆ EvrFsCore_funmount()

◆ EvrFsCore_fversion()

◆ EvrFsCore_fvol()

◆ EvrFsCore_InvalidDrive()

◆ EvrFsCore_sys_close()

◆ EvrFsCore_sys_flen()

◆ EvrFsCore_sys_handle_assign()

◆ EvrFsCore_sys_open()

◆ EvrFsCore_sys_read()

◆ EvrFsCore_sys_seek()

◆ EvrFsCore_sys_write()