Skip to content

Commit

Permalink
TDBStore no longer requires flash behaviour
Browse files Browse the repository at this point in the history
Since ARMmbed/mbed-os#11987 was merged
to Mbed OS, a flash device or a simulated flash device is no
longer a requirement.
  • Loading branch information
LDong-Arm committed Dec 7, 2020
1 parent 428d10d commit 6417894
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/api/storage/KVStoreAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ It is also possible to instantiate single objects of the classes detailed below

Classes implementing KVStore API:

- Tiny Database Storage (TDBStore): A lightweight module that stores data on a flash storage. It is part of the KVStore class family, so it supports the get/set interface. It is designed to optimize performance (speed of access), reduce wearing of the flash and minimize storage overhead. It is also resilient to power failures.
- Tiny Database Storage (TDBStore): A lightweight module that stores data on a block device. It is part of the KVStore class family, so it supports the get/set interface. It is designed to optimize performance (speed of access), reduce wearing of the storage and minimize storage overhead. It is also resilient to power failures.

- Requirements and assumptions: TDBStore assumes that the underlying block device is fully dedicated for it (starting offset 0). If you want to dedicate only a part of the device to TDBStore, then use a sliced block device, typically with `SlicingBlockDevice`. This feature requires a flash based block device, such as `FlashIAPBlockDevice` or `SpifBlockDevice`. It can work on top of block devices that don't need erasing before writes, such as `HeapBlockDevice` or `SDBlockDevice`, but requires a flash simulator layer for this purpose, like the one offered by `FlashSimBlockDevice`.
- Requirements and assumptions: TDBStore assumes that the underlying block device is fully dedicated for it (starting offset 0). If you want to dedicate only a part of the device to TDBStore, then use a sliced block device, typically with `SlicingBlockDevice`.

- FileSystemStore: A lightweight implementation of the KVStore interface over file systems.

Expand Down

0 comments on commit 6417894

Please sign in to comment.