File system abstraction layer (RL-FlashFS) More...

#include "os_port.h"
#include "rl_fs.h"

Data Structures
struct	FsDir
	Directory descriptor. More...

Macros
#define	FS_MAX_PATH_LEN 260

Typedefs
typedef void	FsFile
	File descriptor. More...

Functions
error_t	fsInit (void)
	File system initialization. More...

bool_t	fsFileExists (const char_t *path)
	Check whether a file exists. More...

error_t	fsGetFileSize (const char_t path, uint32_t size)
	Retrieve the size of the specified file. More...

error_t	fsGetFileStat (const char_t path, FsFileStat fileStat)
	Retrieve the attributes of the specified file. More...

error_t	fsRenameFile (const char_t oldPath, const char_t newPath)
	Rename the specified file. More...

error_t	fsDeleteFile (const char_t *path)
	Delete a file. More...

FsFile *	fsOpenFile (const char_t *path, uint_t mode)
	Open the specified file for reading or writing. More...

error_t	fsSeekFile (FsFile *file, int_t offset, uint_t origin)
	Move to specified position in file. More...

error_t	fsWriteFile (FsFile file, void data, size_t length)
	Write data to the specified file. More...

error_t	fsReadFile (FsFile file, void data, size_t size, size_t *length)
	Read data from the specified file. More...

void	fsCloseFile (FsFile *file)
	Close a file. More...

bool_t	fsDirExists (const char_t *path)
	Check whether a directory exists. More...

error_t	fsCreateDir (const char_t *path)
	Create a directory. More...

error_t	fsRemoveDir (const char_t *path)
	Remove a directory. More...

FsDir *	fsOpenDir (const char_t *path)
	Open a directory stream. More...

error_t	fsReadDir (FsDir dir, FsDirEntry dirEntry)
	Read an entry from the specified directory stream. More...

void	fsCloseDir (FsDir *dir)
	Close a directory stream. More...

Detailed Description

File system abstraction layer (RL-FlashFS)

License

SPDX-License-Identifier: GPL-2.0-or-later

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author: Oryx Embedded SARL (www.oryx-embedded.com)

Version: 2.4.4

Definition in file fs_port_rl_fs.h.

Macro Definition Documentation

◆ FS_MAX_PATH_LEN

#define FS_MAX_PATH_LEN 260

Definition at line 38 of file fs_port_rl_fs.h.

Typedef Documentation

◆ FsFile

typedef void FsFile

File descriptor.

Definition at line 53 of file fs_port_rl_fs.h.

Function Documentation

◆ fsCloseDir()

void fsCloseDir ( FsDir * dir )

Close a directory stream.

Parameters

[in] dir Handle that identifies the directory to be closed

Definition at line 947 of file fs_port_fatfs.c.

◆ fsCloseFile()

void fsCloseFile ( FsFile * file )

Close a file.

Parameters

[in] file Handle that identifies the file to be closed

Definition at line 637 of file fs_port_fatfs.c.

◆ fsCreateDir()

error_t fsCreateDir ( const char_t * path )

Create a directory.

Parameters

[in] path NULL-terminated string specifying the directory path

Returns: Error code

Definition at line 722 of file fs_port_fatfs.c.

◆ fsDeleteFile()

error_t fsDeleteFile ( const char_t * path )

Delete a file.

Parameters

[in] path NULL-terminated string specifying the filename

Returns: Error code

Definition at line 368 of file fs_port_fatfs.c.

◆ fsDirExists()

bool_t fsDirExists ( const char_t * path )

Check whether a directory exists.

Parameters

[in] path NULL-terminated string specifying the directory path

Returns: The function returns TRUE if the directory exists. Otherwise FALSE is returned

Definition at line 667 of file fs_port_fatfs.c.

◆ fsFileExists()

bool_t fsFileExists ( const char_t * path )

Check whether a file exists.

Parameters

[in] path NULL-terminated string specifying the filename

Returns: The function returns TRUE if the file exists. Otherwise FALSE is returned

Definition at line 152 of file fs_port_fatfs.c.

◆ fsGetFileSize()

error_t fsGetFileSize	(	const char_t *	path,
		uint32_t *	size
	)

Retrieve the size of the specified file.

Parameters

[in]	path	NULL-terminated string specifying the filename
[out]	size	Size of the file in bytes

Returns: Error code

Definition at line 204 of file fs_port_fatfs.c.

◆ fsGetFileStat()

error_t fsGetFileStat	(	const char_t *	path,
		FsFileStat *	fileStat
	)

Retrieve the attributes of the specified file.

Parameters

[in]	path	NULL-terminated string specifying the filename
[out]	fileStat	File attributes

Returns: Error code

Definition at line 256 of file fs_port_fatfs.c.

◆ fsInit()

error_t fsInit ( void )

File system initialization.

Returns: Error code

Definition at line 110 of file fs_port_fatfs.c.

◆ fsOpenDir()

FsDir* fsOpenDir ( const char_t * path )

Open a directory stream.

Parameters

[in] path NULL-terminated string specifying the directory path

Returns: Directory handle

Definition at line 808 of file fs_port_fatfs.c.

◆ fsOpenFile()

FsFile* fsOpenFile	(	const char_t *	path,
		uint_t	mode
	)

Open the specified file for reading or writing.

Parameters

[in]	path	NULL-terminated string specifying the filename
[in]	mode	Type of access permitted (FS_FILE_MODE_READ, FS_FILE_MODE_WRITE or FS_FILE_MODE_CREATE)

Returns: File handle

Definition at line 413 of file fs_port_fatfs.c.

◆ fsReadDir()

error_t fsReadDir	(	FsDir *	dir,
		FsDirEntry *	dirEntry
	)

Read an entry from the specified directory stream.

Parameters

[in]	dir	Handle that identifies the directory
[out]	dirEntry	Pointer to a directory entry

Returns: Error code

Definition at line 859 of file fs_port_fatfs.c.

◆ fsReadFile()

error_t fsReadFile	(	FsFile *	file,
		void *	data,
		size_t	size,
		size_t *	length
	)

Read data from the specified file.

Parameters

[in]	file	Handle that identifies the file to be read
[in]	data	Pointer to the buffer where to copy the data
[in]	size	Size of the buffer, in bytes
[out]	length	Number of data bytes that have been read

Returns: Error code

Definition at line 590 of file fs_port_fatfs.c.

◆ fsRemoveDir()

error_t fsRemoveDir ( const char_t * path )

Remove a directory.

Parameters

[in] path NULL-terminated string specifying the directory path

Returns: Error code

Definition at line 765 of file fs_port_fatfs.c.

◆ fsRenameFile()

error_t fsRenameFile	(	const char_t *	oldPath,
		const char_t *	newPath
	)

Rename the specified file.

Parameters

[in]	oldPath	NULL-terminated string specifying the pathname of the file to be renamed
[in]	newPath	NULL-terminated string specifying the new filename

Returns: Error code

Definition at line 325 of file fs_port_fatfs.c.

◆ fsSeekFile()

error_t fsSeekFile	(	FsFile *	file,
		int_t	offset,
		uint_t	origin
	)

Move to specified position in file.

Parameters

[in]	file	Handle that identifies the file
[in]	offset	Number of bytes to move from origin
[in]	origin	Position used as reference for the offset (FS_SEEK_SET, FS_SEEK_CUR or FS_SEEK_END)

Returns: Error code

Definition at line 483 of file fs_port_fatfs.c.

◆ fsWriteFile()

error_t fsWriteFile	(	FsFile *	file,
		void *	data,
		size_t	length
	)

Write data to the specified file.

Parameters

[in]	file	Handle that identifies the file to be written
[in]	data	Pointer to a buffer containing the data to be written
[in]	length	Number of data bytes to write

Returns: Error code

Definition at line 539 of file fs_port_fatfs.c.

Data Structures

Macros

Typedefs

Functions

Detailed Description

License

Macro Definition Documentation

◆ FS_MAX_PATH_LEN

Typedef Documentation

◆ FsFile

Function Documentation

◆ fsCloseDir()

◆ fsCloseFile()

◆ fsCreateDir()

◆ fsDeleteFile()

◆ fsDirExists()

◆ fsFileExists()

◆ fsGetFileSize()

◆ fsGetFileStat()

◆ fsInit()

◆ fsOpenDir()

◆ fsOpenFile()

◆ fsReadDir()

◆ fsReadFile()

◆ fsRemoveDir()

◆ fsRenameFile()

◆ fsSeekFile()

◆ fsWriteFile()