Api.h File Reference

#include "colony_config.h"
#include "littlefs/lfs.h"
#include <string.h>

Include dependency graph for Api.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	Cpl::Io::File::Littlefs::Api
	This 'singleton' class is used to create and manage the littlefs file system. More...
struct	Cpl::Io::File::Littlefs::Api::Volume_T
	This structure defines the configuration and the underlying block driver used for each volume instance. More...

Namespaces
namespace	Cpl
	The 'Cpl' namespace is the root name space for the Colony.
namespace	Cpl::Io
	The Io namespace provides the base/common interfaces for reading and writing data from/to streams and files.
namespace	Cpl::Io::File
	The File namespace provides the base/common interfaces for reading and writing data from/to Files.
namespace	Cpl::Io::File::Littlefs
	The 'Littlefs' namespace implements the CPL file abstractions using the open source 'littlefs' file system (https://github.com/littlefs-project/littlefs)

Macros
#define	OPTION_CPL_IO_FILE_LITTLEFS_MAX_CONCURRENT_FILES   4
	The maximum number of files that can be opened at one time.
#define	OPTION_CPL_IO_FILE_LITTLEFS_CACHE_SIZE   32
	The size, in bytes, of the lfs 'cache buffers'.
#define	OPTION_CPL_IO_FILE_LITTLEFS_MAX_VOLUMES   1
	The maximum number of volumes that can be mounted.
#define	OPTION_CPL_IO_FILE_DIRLIST_MAX_DEPTH   4
	Maximum support depth for directory traversal.

Macro Definition Documentation

OPTION_CPL_IO_FILE_DIRLIST_MAX_DEPTH

#define OPTION_CPL_IO_FILE_DIRLIST_MAX_DEPTH   4

Maximum support depth for directory traversal.

Each level adds CPL_IO_FILE_MAX_NAME bytes of memory to the size of the DirList_ class.

Note: CPL_IO_FILE_MAX_NAME is the max PATH+FILENAME length, not the max file name length

OPTION_CPL_IO_FILE_LITTLEFS_CACHE_SIZE

#define OPTION_CPL_IO_FILE_LITTLEFS_CACHE_SIZE   32

The size, in bytes, of the lfs 'cache buffers'.

This size is used for read, prog, lookahead, etc. buffers. The total amount of static allocated memory will be: (3 + OPTION_CPL_IO_FILE_LITTLEFS_MAX_CONCURRENT_FILES) * OPTION_CPL_IO_FILE_LITTLEFS_CACHE_SIZE

OPTION_CPL_IO_FILE_LITTLEFS_MAX_CONCURRENT_FILES

#define OPTION_CPL_IO_FILE_LITTLEFS_MAX_CONCURRENT_FILES   4

The maximum number of files that can be opened at one time.

OPTION_CPL_IO_FILE_LITTLEFS_MAX_VOLUMES

#define OPTION_CPL_IO_FILE_LITTLEFS_MAX_VOLUMES   1

The maximum number of volumes that can be mounted.