RA Flexible Software Package Documentation  Release v5.2.0

 
LittleFS Interface

Detailed Description

Interface for LittleFS access.

Summary

The LittleFS Port configures a fail-safe filesystem designed for microcontrollers on top of a lower level storage device.

Data Structures

struct  rm_littlefs_cfg_t
 
struct  rm_littlefs_api_t
 
struct  rm_littlefs_instance_t
 

Typedefs

typedef void rm_littlefs_ctrl_t
 

Data Structure Documentation

◆ rm_littlefs_cfg_t

struct rm_littlefs_cfg_t

User configuration structure, used in open function

Data Fields
struct lfs_config const * p_lfs_cfg Pointer LittleFS configuration structure.
void const * p_extend Pointer to hardware dependent configuration.

◆ rm_littlefs_api_t

struct rm_littlefs_api_t

LittleFS Port interface API.

Data Fields

fsp_err_t(* open )(rm_littlefs_ctrl_t *const p_ctrl, rm_littlefs_cfg_t const *const p_cfg)
 
fsp_err_t(* close )(rm_littlefs_ctrl_t *const p_ctrl)
 

Field Documentation

◆ open

fsp_err_t(* rm_littlefs_api_t::open) (rm_littlefs_ctrl_t *const p_ctrl, rm_littlefs_cfg_t const *const p_cfg)

Initialize The lower level storage device.

Parameters
[in]p_ctrlPointer to control block. Must be declared by user. Elements set here.
[in]p_cfgPointer to configuration structure. All elements of this structure must be set by user.

◆ close

fsp_err_t(* rm_littlefs_api_t::close) (rm_littlefs_ctrl_t *const p_ctrl)

Closes the module and lower level storage device.

Parameters
[in]p_ctrlControl block set in rm_littlefs_api_t::open call.

◆ rm_littlefs_instance_t

struct rm_littlefs_instance_t

This structure encompasses everything that is needed to use an instance of this interface.

Data Fields
rm_littlefs_ctrl_t * p_ctrl Pointer to the control structure for this instance.
rm_littlefs_cfg_t const * p_cfg Pointer to the configuration structure for this instance.
rm_littlefs_api_t const * p_api Pointer to the API structure for this instance.

Typedef Documentation

◆ rm_littlefs_ctrl_t

typedef void rm_littlefs_ctrl_t

LittleFS Port API control block. Allocate an instance specific control block to pass into the LittleFS Port API calls.