83 lines
1.8 KiB
C
83 lines
1.8 KiB
C
/*
|
|
* Block device emulated in a file
|
|
*
|
|
* Copyright (c) 2022, The littlefs authors.
|
|
* Copyright (c) 2017, Arm Limited. All rights reserved.
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
#ifndef LFS_FILEBD_H
|
|
#define LFS_FILEBD_H
|
|
|
|
#include "lfs.h"
|
|
#include "lfs_util.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif
|
|
|
|
|
|
// Block device specific tracing
|
|
#ifndef LFS_FILEBD_TRACE
|
|
#ifdef LFS_FILEBD_YES_TRACE
|
|
#define LFS_FILEBD_TRACE(...) LFS_TRACE(__VA_ARGS__)
|
|
#else
|
|
#define LFS_FILEBD_TRACE(...)
|
|
#endif
|
|
#endif
|
|
|
|
// filebd config
|
|
struct lfs_filebd_config {
|
|
// Minimum size of a read operation in bytes.
|
|
lfs_size_t read_size;
|
|
|
|
// Minimum size of a program operation in bytes.
|
|
lfs_size_t prog_size;
|
|
|
|
// Size of an erase operation in bytes.
|
|
lfs_size_t erase_size;
|
|
|
|
// Number of erase blocks on the device.
|
|
lfs_size_t erase_count;
|
|
};
|
|
|
|
// filebd state
|
|
typedef struct lfs_filebd {
|
|
int fd;
|
|
const struct lfs_filebd_config *cfg;
|
|
} lfs_filebd_t;
|
|
|
|
|
|
// Create a file block device
|
|
int lfs_filebd_create(const struct lfs_config *cfg, const char *path,
|
|
const struct lfs_filebd_config *bdcfg);
|
|
|
|
// Clean up memory associated with block device
|
|
int lfs_filebd_destroy(const struct lfs_config *cfg);
|
|
|
|
// Read a block
|
|
int lfs_filebd_read(const struct lfs_config *cfg, lfs_block_t block,
|
|
lfs_off_t off, void *buffer, lfs_size_t size);
|
|
|
|
// Program a block
|
|
//
|
|
// The block must have previously been erased.
|
|
int lfs_filebd_prog(const struct lfs_config *cfg, lfs_block_t block,
|
|
lfs_off_t off, const void *buffer, lfs_size_t size);
|
|
|
|
// Erase a block
|
|
//
|
|
// A block must be erased before being programmed. The
|
|
// state of an erased block is undefined.
|
|
int lfs_filebd_erase(const struct lfs_config *cfg, lfs_block_t block);
|
|
|
|
// Sync the block device
|
|
int lfs_filebd_sync(const struct lfs_config *cfg);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
#endif
|