Skip to content

Commit ceaa09b

Browse files
author
AnotherButler
committed
Add storage images
Add class hierarchy images to storage user APIs.
1 parent 304b053 commit ceaa09b

File tree

6 files changed

+12
-0
lines changed

6 files changed

+12
-0
lines changed

docs/reference/api/storage/ChainingBlockDevice.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
## ChainingBlockDevice
22

3+
<span class="images">![](https://os.mbed.com/docs/v5.8/mbed-os-api-doxy/class_chaining_block_device.png)<span>ChainingBlockDevice class hierarchy</span></span>
4+
35
The ChainingBlockDevice class provides a way to chain together multiple block devices. You can then interact with the chained block devices as if they were a single block device of size equal to the sum of each substorage unit. The ChainingBlockDevice acts as an opposite of the [SlicingBlockDevice](/docs/v5.8/reference/slicingblockdevice.html).
46

57
Note that each block device's block size must be a multiple of the other devices' block sizes (512, 1024 and so on).

docs/reference/api/storage/HeapBlockDevice.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
## HeapBlockDevice
22

3+
<span class="images">![](https://os.mbed.com/docs/v5.8/mbed-os-api-doxy/class_heap_block_device.png)<span>HeapBlockDevice class hierarchy</span></span>
4+
35
The HeapBlockDevice class provides a way to simulate block devices for software development or testing. The created blocks are nonvolatile; they do not persist across power cycles.
46

57
HeapBlockDevices have the following configurable parameters in either one of two constructors:

docs/reference/api/storage/LittleFileSystem.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
## LittleFileSystem
22

3+
<span class="images">![](https://os.mbed.com/docs/v5.8/mbed-os-api-doxy/class_little_file_system.png)<span>LittleFileSystem class hierarchy</span></span>
4+
35
The little file system (LittleFS) is a fail-safe file system designed for embedded systems, specifically for microcontrollers that use external flash storage.
46

57
```

docs/reference/api/storage/MBRBlockDevice.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
## MBRBlockDevice
22

3+
<span class="images">![](https://os.mbed.com/docs/v5.8/mbed-os-api-doxy/class_m_b_r_block_device.png)<span>MBRBlockDevice class hierarchy</span></span>
4+
35
The MBRBlockDevice class provides a way to manage a Master Boot Record (MBR) on a storage device, which allows you to partition the device. Without the MBR, you can still format a storage device with a file system, but including the MBR will allow for future partition modifications.
46

57
MBRBlockDevices have the following configurable parameters in the constructor:

docs/reference/api/storage/ProfilingBlockDevice.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
## ProfilingBlockDevice
22

3+
<span class="images">![](https://os.mbed.com/docs/v5.8/mbed-os-api-doxy/class_profiling_block_device.png)<span>ProfilingBlockDevice class hierarchy</span></span>
4+
35
The ProfilingBlockDevice class provides a decorator for an existing block device object to log reads, writes and erases.
46

57
ProfilingBlockDevices take in a pointer to the block device being profiled as the only configurable parameter. If you want to count a storage operation such as programming, reading or writing to a block device, you should use the ProfilingBlockDevice object as the interface to the storage block rather than the underlying device. The below example highlights this use case.

docs/reference/api/storage/SlicingBlockDevice.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
## SlicingBlockDevice
22

3+
<span class="images">![](https://os.mbed.com/docs/v5.8/mbed-os-api-doxy/class_slicing_block_device.png)<span>SlicingBlockDevice class hierarchy</span></span>
4+
35
The SlicingBlockDevice class provides a way to break up a block device into subunits without the need to manually track offsets. The SlicingBlockDevice acts as an opposite of the [ChainingBlockDevice](/docs/v5.8/reference/chainingblockdevice.html) class.
46

57
The constructor takes in the master block device pointer and the start and end addresses of where you would like to partition the sub-block. By not specifying the end address, you create a block device that spans from the provided start address to the end of the underlying block device.

0 commit comments

Comments
 (0)