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

LittleFileSystem2, a little file system. More...

#include <LittleFileSystem2.h>

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

Public Member Functions

 LittleFileSystem2 (const char *name=NULL, mbed::BlockDevice *bd=NULL, lfs2_size_t block_size=MBED_LFS2_BLOCK_SIZE, uint32_t block_cycles=MBED_LFS2_BLOCK_CYCLES, lfs2_size_t cache_size=MBED_LFS2_CACHE_SIZE, lfs2_size_t lookahead=MBED_LFS2_LOOKAHEAD_SIZE)
 Lifetime of the LittleFileSystem2. 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, lfs2_size_t block_size=MBED_LFS2_BLOCK_SIZE, uint32_t block_cycles=MBED_LFS2_BLOCK_CYCLES, lfs2_size_t cache_size=MBED_LFS2_CACHE_SIZE, lfs2_size_t lookahead_size=MBED_LFS2_LOOKAHEAD_SIZE)
 Format a block device with the LittleFileSystem2. 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

LittleFileSystem2, a little file system.

Synchronization level: Thread safe

Definition at line 36 of file LittleFileSystem2.h.

Constructor & Destructor Documentation

LittleFileSystem2 ( const char *  name = NULL,
mbed::BlockDevice bd = NULL,
lfs2_size_t  block_size = MBED_LFS2_BLOCK_SIZE,
uint32_t  block_cycles = MBED_LFS2_BLOCK_CYCLES,
lfs2_size_t  cache_size = MBED_LFS2_CACHE_SIZE,
lfs2_size_t  lookahead = MBED_LFS2_LOOKAHEAD_SIZE 
)

Lifetime of the LittleFileSystem2.

Parameters
nameName of the file system in the tree.
bdBlock device to mount. Mounted immediately if not NULL.
block_sizeSize of a logical block. This does not impact ram consumption and may be larger than the physical erase block. If the physical erase block is larger, littlefs will use that instead. Larger values will be faster but waste more storage when files are not aligned to a block size.
block_cyclesNumber of erase cycles before a block is forcefully evicted. Larger values are more efficient but cause less even wear distribution. 0 disables dynamic wear-leveling.
cache_sizeSize of read/program caches. Each file uses 1 cache, and littlefs allocates 2 caches for internal operations. Larger values should be faster but uses more RAM.
lookahead_sizeSize of the lookahead buffer. A larger lookahead reduces the allocation scans and results in a faster filesystem but uses more RAM.

Member Function Documentation

static int format ( mbed::BlockDevice bd,
lfs2_size_t  block_size = MBED_LFS2_BLOCK_SIZE,
uint32_t  block_cycles = MBED_LFS2_BLOCK_CYCLES,
lfs2_size_t  cache_size = MBED_LFS2_CACHE_SIZE,
lfs2_size_t  lookahead_size = MBED_LFS2_LOOKAHEAD_SIZE 
)
static

Format a block device with the LittleFileSystem2.

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

Parameters
bdThis is the block device that will be formatted.
block_sizeSize of a logical block. This does not impact ram consumption and may be larger than the physical erase block. If the physical erase block is larger, littlefs will use that instead. Larger values will be faster but waste more storage when files are not aligned to a block size.
block_cyclesNumber of erase cycles before a block is forcefully evicted. Larger values are more efficient but cause less even wear distribution. 0 disables dynamic wear-leveling.
cache_sizeSize of read/program caches. Each file uses 1 cache, and littlefs allocates 2 caches for internal operations. Larger values should be faster but uses more RAM.
lookahead_sizeSize of the lookahead buffer. A larger lookahead reduces the allocation scans and results in a faster filesystem but uses more RAM.
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.