CTS-SAT-1-OBC-Firmware
Loading...
Searching...
No Matches
littlefs_helper.h
Go to the documentation of this file.
1
7
8#ifndef INCLUDE_GUARD__LITTLEFS_HELPER_H__
9#define INCLUDE_GUARD__LITTLEFS_HELPER_H__
10
11/*-----------------------------INCLUDES-----------------------------*/
12
13#include <stdint.h>
14
16#include "littlefs/lfs.h"
17
18extern lfs_t LFS_filesystem; // LittleFS filesystem object; traditionally called `lfs`
19extern struct lfs_config LFS_cfg;
20extern struct lfs_file_config LFS_file_cfg;
21extern uint8_t LFS_is_lfs_mounted;
22
25#define LFS_MAX_PATH_LENGTH 250
26
27/*---------------------------FUNCTIONS---------------------------*/
28int8_t LFS_format();
29int8_t LFS_mount();
30int8_t LFS_unmount();
31int8_t LFS_ensure_mounted();
33int8_t LFS_list_directory(const char root_directory[], uint16_t offset, int16_t count);
34int8_t LFS_make_directory(const char dir_name[]);
35int8_t LFS_delete_file(const char file_name[]);
36int8_t LFS_write_file(const char file_name[], uint8_t *write_buffer, uint32_t write_buffer_len);
37int8_t LFS_write_file_with_offset(const char file_name[], lfs_soff_t offset, uint8_t *write_buffer, uint32_t write_buffer_len);
38int8_t LFS_append_file(const char file_name[], uint8_t *write_buffer, uint32_t write_buffer_len);
39lfs_ssize_t LFS_read_file(const char file_name[], lfs_soff_t offset, uint8_t *read_buffer, uint32_t read_buffer_size);
40lfs_ssize_t LFS_file_size(const char file_name[]);
41
42#endif /* INCLUDE_GUARD__LITTLEFS_HELPER_H__ */
int32_t lfs_ssize_t
Definition lfs.h:42
struct lfs lfs_t
int32_t lfs_soff_t
Definition lfs.h:43
int8_t LFS_format()
Formats Memory Module so it can successfully mount LittleFS.
Definition littlefs_helper.c:59
int8_t LFS_unmount()
Unmounts LittleFS to the Memory Module.
Definition littlefs_helper.c:106
int8_t LFS_write_file(const char file_name[], uint8_t *write_buffer, uint32_t write_buffer_len)
Creates/Opens LittleFS File to write to the Memory Module.
Definition littlefs_helper.c:285
int8_t LFS_mount()
Mounts LittleFS to the Memory Module.
Definition littlefs_helper.c:80
int8_t LFS_ensure_mounted()
Mounts LFS filesystem if not already mounted. Does nothing if LFS is already mounted.
Definition littlefs_helper.c:131
int8_t LFS_append_file(const char file_name[], uint8_t *write_buffer, uint32_t write_buffer_len)
Creates/Opens LittleFS File to append contents.
Definition littlefs_helper.c:329
struct lfs_file_config LFS_file_cfg
Definition littlefs_helper.c:49
lfs_ssize_t LFS_read_file(const char file_name[], lfs_soff_t offset, uint8_t *read_buffer, uint32_t read_buffer_size)
Opens LittleFS File to read from the Memory Module.
Definition littlefs_helper.c:492
int8_t LFS_delete_file(const char file_name[])
Removes / deletes the file specified.
Definition littlefs_helper.c:263
lfs_t LFS_filesystem
Definition littlefs_helper.c:28
int8_t LFS_write_file_with_offset(const char file_name[], lfs_soff_t offset, uint8_t *write_buffer, uint32_t write_buffer_len)
Creates / Opens LittleFS File and writes data at a specific offset.
Definition littlefs_helper.c:372
uint8_t LFS_is_lfs_mounted
Definition littlefs_helper.c:11
lfs_ssize_t LFS_file_size(const char file_name[])
Returns the file size.
Definition littlefs_helper.c:536
int8_t LFS_ensure_unmounted()
Mounts LFS filesystem if not already mounted. Does nothing if LFS is already mounted.
Definition littlefs_helper.c:140
int8_t LFS_make_directory(const char dir_name[])
Creates directory.
Definition littlefs_helper.c:237
struct lfs_config LFS_cfg
Definition littlefs_helper.c:29
int8_t LFS_list_directory(const char root_directory[], uint16_t offset, int16_t count)
Lists contents of LittleFS Directory, where each entry is sent as a log message.
Definition littlefs_helper.c:153
Definition lfs.h:157
Definition lfs.h:346