spiffs_fs.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2016 OTA keys S.A.
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "spiffs.h"
#include "spiffs_config.h"
#include "vfs.h"
#include "mtd.h"
#include "mutex.h"

#define SPIFFS_DIR_SIZE (12)
 
#if (VFS_DIR_BUFFER_SIZE < SPIFFS_DIR_SIZE)
#error "VFS_DIR_BUFFER_SIZE too small"
#endif

#ifndef SPIFFS_FS_CACHE_SIZE
#if SPIFFS_CACHE || defined(DOXYGEN)
#define SPIFFS_FS_CACHE_SIZE (512)
#else
#define SPIFFS_FS_CACHE_SIZE (0)
#endif /* SPIFFS_CACHE */
#endif /* SPIFFS_FS_CACHE_SIZE */
#ifndef SPIFFS_FS_WORK_SIZE
#define SPIFFS_FS_WORK_SIZE  (512)
#endif
#ifndef SPIFFS_FS_FD_SPACE_SIZE
#define SPIFFS_FS_FD_SPACE_SIZE (4 * 32)
#endif

typedef struct spiffs_desc {
    spiffs fs;                                  
    uint8_t work[SPIFFS_FS_WORK_SIZE];          
    uint8_t fd_space[SPIFFS_FS_FD_SPACE_SIZE];  
#if (SPIFFS_CACHE == 1) || defined(DOXYGEN)
    uint8_t cache[SPIFFS_FS_CACHE_SIZE];        
#endif
    spiffs_config config;                       
    mutex_t lock;                               
#if (SPIFFS_HAL_CALLBACK_EXTRA == 1) || defined(DOXYGEN)
    mtd_dev_t *dev;                             
#endif
#if (SPIFFS_SINGLETON == 0) || defined(DOXYGEN)
    uint32_t base_addr;                         
    uint32_t block_count;                       
#endif
} spiffs_desc_t;

extern const vfs_file_system_t spiffs_file_system;

void spiffs_lock(struct spiffs_t *fs);

void spiffs_unlock(struct spiffs_t *fs);
 
#ifdef __cplusplus
}
#endif