mirror of
https://gitee.com/openharmony/third_party_littlefs
synced 2024-11-23 06:50:37 +00:00
6b96ac5db9
Close: #I77XXH Signed-off-by: liuwenxin <liuwenxin11@huawei.com> Change-Id: Id783611964850c03b96eb0f2a24bdedd376650df
143 lines
3.9 KiB
C
143 lines
3.9 KiB
C
/*
|
|
* Testing block device, wraps filebd and rambd while providing a bunch
|
|
* of hooks for testing littlefs in various conditions.
|
|
*
|
|
* Copyright (c) 2022, The littlefs authors.
|
|
* 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 "lfs_util.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_config {
|
|
// 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 RAM block device.
|
|
void *buffer;
|
|
|
|
// Optional buffer for wear
|
|
void *wear_buffer;
|
|
};
|
|
|
|
// testbd state
|
|
typedef struct lfs_testbd {
|
|
union {
|
|
struct {
|
|
lfs_filebd_t bd;
|
|
struct lfs_filebd_config cfg;
|
|
} file;
|
|
struct {
|
|
lfs_rambd_t bd;
|
|
struct lfs_rambd_config cfg;
|
|
} ram;
|
|
} u;
|
|
|
|
bool persist;
|
|
uint32_t power_cycles;
|
|
lfs_testbd_wear_t *wear;
|
|
|
|
const struct lfs_testbd_config *cfg;
|
|
} lfs_testbd_t;
|
|
|
|
|
|
/// Block device API ///
|
|
|
|
// Create a test block device using the geometry in lfs_config
|
|
//
|
|
// 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_create(const struct lfs_config *cfg, const char *path);
|
|
int lfs_testbd_createcfg(const struct lfs_config *cfg, const char *path,
|
|
const struct lfs_testbd_config *bdcfg);
|
|
|
|
// Clean up memory associated with block device
|
|
int lfs_testbd_destroy(const struct lfs_config *cfg);
|
|
|
|
// Read a block
|
|
int lfs_testbd_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_testbd_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_testbd_erase(const struct lfs_config *cfg, lfs_block_t block);
|
|
|
|
// Sync the block device
|
|
int lfs_testbd_sync(const struct lfs_config *cfg);
|
|
|
|
|
|
/// Additional extended API for driving test features ///
|
|
|
|
// Get simulated wear on a given block
|
|
lfs_testbd_swear_t lfs_testbd_getwear(const struct lfs_config *cfg,
|
|
lfs_block_t block);
|
|
|
|
// Manually set simulated wear on a given block
|
|
int lfs_testbd_setwear(const struct lfs_config *cfg,
|
|
lfs_block_t block, lfs_testbd_wear_t wear);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
#endif
|