mirror of
https://github.com/eledio-devices/thirdparty-littlefs.git
synced 2025-10-31 08:42:40 +01:00
30ed816feb
I have another branch where I tried exploring inlined config structs backed by RAM, but this did not work out due to additional RAM and ROM costs. Changing the bds to follow this was surprisingly annoying, as they had a lot of shared geometry that was previously in a single shared config object, and the way that testbd contains either of rambd and filebd made configuring all three of these a bit complicated. Ended up settling on a lfs_testbd_cfg that contains optional pointers to lfs_rambd_cfg and lfs_filebd_cfg. These can be NULL, but only if that bd goes unused.
149 lines
4.1 KiB
C
149 lines
4.1 KiB
C
/*
|
|
* Testing block device, wraps filebd and rambd while providing a bunch
|
|
* of hooks for testing littlefs in various conditions.
|
|
*
|
|
* Copyright (c) 2017, Arm Limited. All rights reserved.
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
#ifndef LFS_TESTBD_H
|
|
#define LFS_TESTBD_H
|
|
|
|
#include "lfs.h"
|
|
#include "bd/lfs_rambd.h"
|
|
#include "bd/lfs_filebd.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
// Block device specific tracing
|
|
#ifdef LFS_TESTBD_YES_TRACE
|
|
#define LFS_TESTBD_TRACE(...) LFS_TRACE(__VA_ARGS__)
|
|
#else
|
|
#define LFS_TESTBD_TRACE(...)
|
|
#endif
|
|
|
|
// Mode determining how "bad blocks" behave during testing. This simulates
|
|
// some real-world circumstances such as progs not sticking (prog-noop),
|
|
// a readonly disk (erase-noop), and ECC failures (read-error).
|
|
//
|
|
// Not that read-noop is not allowed. Read _must_ return a consistent (but
|
|
// may be arbitrary) value on every read.
|
|
enum lfs_testbd_badblock_behavior {
|
|
LFS_TESTBD_BADBLOCK_PROGERROR,
|
|
LFS_TESTBD_BADBLOCK_ERASEERROR,
|
|
LFS_TESTBD_BADBLOCK_READERROR,
|
|
LFS_TESTBD_BADBLOCK_PROGNOOP,
|
|
LFS_TESTBD_BADBLOCK_ERASENOOP,
|
|
};
|
|
|
|
// Type for measuring wear
|
|
typedef uint32_t lfs_testbd_wear_t;
|
|
typedef int32_t lfs_testbd_swear_t;
|
|
|
|
// testbd config, this is required for testing
|
|
struct lfs_testbd_cfg {
|
|
// Block device specific configuration, see the related config structs.
|
|
// May be NULL if the underlying implementation goes unused.
|
|
const struct lfs_rambd_cfg *rambd_cfg;
|
|
const struct lfs_filebd_cfg *filebd_cfg;
|
|
|
|
// Minimum size of block read. All read operations must be a
|
|
// multiple of this value.
|
|
lfs_size_t read_size;
|
|
|
|
// Minimum size of block program. All program operations must be a
|
|
// multiple of this value.
|
|
lfs_size_t prog_size;
|
|
|
|
// Size of an erasable block.
|
|
lfs_size_t erase_size;
|
|
|
|
// Number of erasable blocks on the device.
|
|
lfs_size_t erase_count;
|
|
|
|
// 8-bit erase value to use for simulating erases. -1 does not simulate
|
|
// erases, which can speed up testing by avoiding all the extra block-device
|
|
// operations to store the erase value.
|
|
int32_t erase_value;
|
|
|
|
// Number of erase cycles before a block becomes "bad". The exact behavior
|
|
// of bad blocks is controlled by the badblock_mode.
|
|
uint32_t erase_cycles;
|
|
|
|
// The mode determining how bad blocks fail
|
|
uint8_t badblock_behavior;
|
|
|
|
// Number of write operations (erase/prog) before forcefully killing
|
|
// the program with exit. Simulates power-loss. 0 disables.
|
|
uint32_t power_cycles;
|
|
|
|
// Optional buffer for wear
|
|
void *wear_buffer;
|
|
};
|
|
|
|
// testbd state
|
|
typedef struct lfs_testbd {
|
|
union {
|
|
lfs_filebd_t filebd;
|
|
lfs_rambd_t rambd;
|
|
} impl;
|
|
|
|
bool persist;
|
|
uint32_t power_cycles;
|
|
lfs_testbd_wear_t *wear;
|
|
|
|
const struct lfs_testbd_cfg *cfg;
|
|
} lfs_testbd_t;
|
|
|
|
|
|
/// Block device API ///
|
|
|
|
// Create a test block device using the geometry in lfs_cfg
|
|
//
|
|
// Note that filebd is used if a path is provided, if path is NULL
|
|
// testbd will use rambd which can be much faster.
|
|
int lfs_testbd_createcfg(lfs_testbd_t *bd, const char *path,
|
|
const struct lfs_testbd_cfg *cfg);
|
|
|
|
// Clean up memory associated with block device
|
|
int lfs_testbd_destroy(lfs_testbd_t *bd);
|
|
|
|
// Read a block
|
|
int lfs_testbd_read(lfs_testbd_t *bd, 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_testbd_prog(lfs_testbd_t *bd, 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_testbd_erase(lfs_testbd_t *bd, lfs_block_t block);
|
|
|
|
// Sync the block device
|
|
int lfs_testbd_sync(lfs_testbd_t *bd);
|
|
|
|
|
|
/// Additional extended API for driving test features ///
|
|
|
|
// Get simulated wear on a given block
|
|
lfs_testbd_swear_t lfs_testbd_getwear(lfs_testbd_t *bd,
|
|
lfs_block_t block);
|
|
|
|
// Manually set simulated wear on a given block
|
|
int lfs_testbd_setwear(lfs_testbd_t *bd,
|
|
lfs_block_t block, lfs_testbd_wear_t wear);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|