littlefs2_fs.h

Go to the documentation of this file.

/*
 * Copyright (C) 2017 OTA keys S.A.
 * Copyright (C) 2020 Inria
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#pragma once

 
#include <stdalign.h>
 
#include "vfs.h"
#include "lfs.h"
#include "mtd.h"
#include "mutex.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#ifndef CONFIG_LITTLEFS2_LOOKAHEAD_SIZE
#define CONFIG_LITTLEFS2_LOOKAHEAD_SIZE     (16)
#endif
 
#ifndef CONFIG_LITTLEFS2_FILE_BUFFER_SIZE
#define CONFIG_LITTLEFS2_FILE_BUFFER_SIZE   (0)
#endif
 
#ifndef CONFIG_LITTLEFS2_READ_BUFFER_SIZE
#define CONFIG_LITTLEFS2_READ_BUFFER_SIZE   (0)
#endif
 
#ifndef CONFIG_LITTLEFS2_PROG_BUFFER_SIZE
#define CONFIG_LITTLEFS2_PROG_BUFFER_SIZE   (0)
#endif
 
#ifndef CONFIG_LITTLEFS2_CACHE_PAGES
#define CONFIG_LITTLEFS2_CACHE_PAGES        (1)
#endif
 
#ifndef CONFIG_LITTLEFS2_BLOCK_CYCLES
#define CONFIG_LITTLEFS2_BLOCK_CYCLES       (512)
#endif
 
#ifndef CONFIG_LITTLEFS2_MIN_BLOCK_SIZE_EXP
#define CONFIG_LITTLEFS2_MIN_BLOCK_SIZE_EXP (-1)
#endif

typedef struct {
    lfs_t fs;                   
    struct lfs_config config;   
    mtd_dev_t *dev;             
    mutex_t lock;               
    uint32_t base_addr;
#if CONFIG_LITTLEFS2_FILE_BUFFER_SIZE || DOXYGEN
    alignas(uint32_t) uint8_t file_buf[CONFIG_LITTLEFS2_FILE_BUFFER_SIZE];
#endif
#if CONFIG_LITTLEFS2_READ_BUFFER_SIZE || DOXYGEN
    alignas(uint32_t) uint8_t read_buf[CONFIG_LITTLEFS2_READ_BUFFER_SIZE];
#endif
#if CONFIG_LITTLEFS2_PROG_BUFFER_SIZE || DOXYGEN
    alignas(uint32_t) uint8_t prog_buf[CONFIG_LITTLEFS2_PROG_BUFFER_SIZE];
#endif
    alignas(uint32_t) uint8_t lookahead_buf[CONFIG_LITTLEFS2_LOOKAHEAD_SIZE];
    uint16_t sectors_per_block; 
} littlefs2_desc_t;

extern const vfs_file_system_t littlefs2_file_system;
 
#ifdef __cplusplus
}
#endif