Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions | Static Public Member Functions | Protected Member Functions
LittleFileSystem Class Reference

LittleFileSystem, a little file system. More...

#include <LittleFileSystem.h>

Inheritance diagram for LittleFileSystem:
FileSystem FileSystemLike FileSystemHandle FileBase NonCopyable< FileSystemLike > NonCopyable< FileSystemHandle > NonCopyable< FileBase >

Public Member Functions

 LittleFileSystem (const char *name=NULL, mbed::BlockDevice *bd=NULL, lfs_size_t read_size=MBED_LFS_READ_SIZE, lfs_size_t prog_size=MBED_LFS_PROG_SIZE, lfs_size_t block_size=MBED_LFS_BLOCK_SIZE, lfs_size_t lookahead=MBED_LFS_LOOKAHEAD)
 Lifetime of the LittleFileSystem. More...
 
virtual int mount (mbed::BlockDevice *bd)
 Mount a file system to a block device. More...
 
virtual int unmount ()
 Unmount a file system from the underlying block device. More...
 
virtual int reformat (mbed::BlockDevice *bd)
 Reformat a file system. More...
 
virtual int remove (const char *path)
 Remove a file from the file system. More...
 
virtual int rename (const char *path, const char *newpath)
 Rename a file in the file system. More...
 
virtual int stat (const char *path, struct stat *st)
 Store information about the file in a stat structure. More...
 
virtual int mkdir (const char *path, mode_t mode)
 Create a directory in the file system. More...
 
virtual int statvfs (const char *path, struct statvfs *buf)
 Store information about the mounted file system in a statvfs structure. More...
 

Static Public Member Functions

static int format (mbed::BlockDevice *bd, lfs_size_t read_size=MBED_LFS_READ_SIZE, lfs_size_t prog_size=MBED_LFS_PROG_SIZE, lfs_size_t block_size=MBED_LFS_BLOCK_SIZE, lfs_size_t lookahead=MBED_LFS_LOOKAHEAD)
 Format a block device with the LittleFileSystem. More...
 
static FileSystemget_default_instance ()
 Return the default file system. More...
 

Protected Member Functions

virtual int open (FileHandle **file, const char *path, int flags)
 defined(DOXYGEN_ONLY) More...
 
virtual int open (DirHandle **dir, const char *path)
 Open a directory on the filesystem. More...
 

Detailed Description

LittleFileSystem, a little file system.

Synchronization level: Thread safe

Definition at line 35 of file LittleFileSystem.h.

Constructor & Destructor Documentation

LittleFileSystem ( const char *  name = NULL,
mbed::BlockDevice bd = NULL,
lfs_size_t  read_size = MBED_LFS_READ_SIZE,
lfs_size_t  prog_size = MBED_LFS_PROG_SIZE,
lfs_size_t  block_size = MBED_LFS_BLOCK_SIZE,
lfs_size_t  lookahead = MBED_LFS_LOOKAHEAD 
)

Lifetime of the LittleFileSystem.

Parameters
nameName of the file system in the tree.
bdBlock device to mount. Mounted immediately if not NULL.
read_sizeMinimum size of a block read. This determines the size of read buffers. This may be larger than the physical read size to improve performance by caching more of the block device.
prog_sizeMinimum size of a block program. This determines the size of program buffers. This may be larger than the physical program size to improve performance by caching more of the block device.
block_sizeSize of an erasable block. This does not impact ram consumption and may be larger than the physical erase size. However, this should be kept small as each file currently takes up an entire block.
lookaheadNumber of blocks to lookahead during block allocation. A larger lookahead reduces the number of passes required to allocate a block. The lookahead buffer requires only 1 bit per block so it can be quite large with little ram impact. Should be a multiple of 32.

Member Function Documentation

static int format ( mbed::BlockDevice bd,
lfs_size_t  read_size = MBED_LFS_READ_SIZE,
lfs_size_t  prog_size = MBED_LFS_PROG_SIZE,
lfs_size_t  block_size = MBED_LFS_BLOCK_SIZE,
lfs_size_t  lookahead = MBED_LFS_LOOKAHEAD 
)
static

Format a block device with the LittleFileSystem.

The block device to format should be mounted when this function is called.

Parameters
bdThis is the block device that will be formatted.
read_sizeMinimum size of a block read. This determines the size of read buffers. This may be larger than the physical read size to improve performance by caching more of the block device.
prog_sizeMinimum size of a block program. This determines the size of program buffers. This may be larger than the physical program size to improve performance by caching more of the block device.
block_sizeSize of an erasable block. This does not impact ram consumption and may be larger than the physical erase size. However, this should be kept small as each file currently takes up an entire block.
lookaheadNumber of blocks to lookahead during block allocation. A larger lookahead reduces the number of passes required to allocate a block. The lookahead buffer requires only 1 bit per block so it can be quite large with little ram impact. Should be a multiple of 32.
static FileSystem* get_default_instance ( )
staticinherited

Return the default file system.

Returns the default file system based on the default block device configuration. Use the components in target.json or application config to change the default block device and affect the default filesystem. SD block device => FAT filesystem QSPIF, SPIF, DATAFLASH or FLAHIAP block device => LITTLE filesystem

An application can override all target settings by implementing FileSystem::get_default_instance() - the default definition is weak, and calls get_target_default_instance().

virtual int mkdir ( const char *  path,
mode_t  mode 
)
virtual

Create a directory in the file system.

Parameters
pathThe name of the directory to create.
modeThe permissions with which to create the directory.
Returns
0 on success, negative error code on failure

Reimplemented from FileSystem.

virtual int mount ( mbed::BlockDevice bd)
virtual

Mount a file system to a block device.

Parameters
bdBlock device to mount to.
Returns
0 on success, negative error code on failure.

Implements FileSystem.

virtual int open ( FileHandle **  file,
const char *  path,
int  flags 
)
protectedvirtualinherited

defined(DOXYGEN_ONLY)

Implements FileSystemHandle.

virtual int open ( DirHandle **  dir,
const char *  path 
)
protectedvirtualinherited

Open a directory on the filesystem.

Parameters
dirDestination for the handle to the directory
pathName of the directory to open
Returns
0 on success, negative error code on failure

Reimplemented from FileSystemHandle.

virtual int reformat ( mbed::BlockDevice bd)
virtual

Reformat a file system.

Results in an empty and mounted file system.

Parameters
bdBlock device to reformat and mount. If NULL, the mounted Block device is used. Note: If mount fails, bd must be provided. Default: NULL
Returns
0 on success, negative error code on failure

Reimplemented from FileSystem.

virtual int remove ( const char *  path)
virtual

Remove a file from the file system.

Parameters
pathThe name of the file to remove.
Returns
0 on success, negative error code on failure

Reimplemented from FileSystem.

virtual int rename ( const char *  path,
const char *  newpath 
)
virtual

Rename a file in the file system.

Parameters
pathThe name of the file to rename.
newpathThe name to rename it to.
Returns
0 on success, negative error code on failure

Reimplemented from FileSystem.

virtual int stat ( const char *  path,
struct stat st 
)
virtual

Store information about the file in a stat structure.

Parameters
pathThe name of the file to find information about.
stThe stat buffer to write to.
Returns
0 on success, negative error code on failure

Reimplemented from FileSystem.

virtual int statvfs ( const char *  path,
struct statvfs buf 
)
virtual

Store information about the mounted file system in a statvfs structure.

Parameters
pathThe name of the file to find information about.
bufThe stat buffer to write to.
Returns
0 on success, negative error code on failure

Reimplemented from FileSystem.

virtual int unmount ( )
virtual

Unmount a file system from the underlying block device.

Returns
0 on success, negative error code on failure

Implements FileSystem.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.