littlefs.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Bolt Innovation Management, LLC
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_FS_LITTLEFS_H_
#define ZEPHYR_INCLUDE_FS_LITTLEFS_H_
 
#include <zephyr/types.h>
#include <zephyr/kernel.h>
#include <zephyr/storage/flash_map.h>
 
#include <lfs.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct fs_littlefs {
 /* Defaulted in driver, customizable before mount. */
 struct lfs_config cfg;
 
 /* Must be cfg.cache_size */
 uint8_t *read_buffer;
 
 /* Must be cfg.cache_size */
 uint8_t *prog_buffer;
 
 /* Must be cfg.lookahead_size/4 elements, and
 * cfg.lookahead_size must be a multiple of 8.
 */
 uint32_t *lookahead_buffer[CONFIG_FS_LITTLEFS_LOOKAHEAD_SIZE / sizeof(uint32_t)];
 
 /* These structures are filled automatically at mount. */
 struct lfs lfs;
 void *backend;
 struct k_mutex mutex;
};
 
#define FS_LITTLEFS_DECLARE_CUSTOM_CONFIG(name, alignment, read_sz, prog_sz, cache_sz, \
 lookahead_sz) \
 static uint8_t __aligned(alignment) name ## _read_buffer[cache_sz]; \
 static uint8_t __aligned(alignment) name ## _prog_buffer[cache_sz]; \
 static uint32_t name ## _lookahead_buffer[(lookahead_sz) / sizeof(uint32_t)]; \
 static struct fs_littlefs name = { \
 .cfg = { \
 .read_size = (read_sz), \
 .prog_size = (prog_sz), \
 .cache_size = (cache_sz), \
 .lookahead_size = (lookahead_sz), \
 .read_buffer = name ## _read_buffer, \
 .prog_buffer = name ## _prog_buffer, \
 .lookahead_buffer = name ## _lookahead_buffer, \
 }, \
 }
 
#define FS_LITTLEFS_DECLARE_DEFAULT_CONFIG(name) \
 FS_LITTLEFS_DECLARE_CUSTOM_CONFIG(name, \
 4, \
 CONFIG_FS_LITTLEFS_READ_SIZE, \
 CONFIG_FS_LITTLEFS_PROG_SIZE, \
 CONFIG_FS_LITTLEFS_CACHE_SIZE, \
 CONFIG_FS_LITTLEFS_LOOKAHEAD_SIZE)
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_FS_LITTLEFS_H_ */