mbed-os-examples / Mbed OS mbed-os-example-mbed5-filesystem

.

README.md@25:65a9183a2178, 2018-09-26 (annotated)

Committer:
mbed_official
Date:
Wed Sep 26 15:01:07 2018 +0100
Revision:
25:65a9183a2178
Parent:
24:54f958b463d0
Child:
32:decaa56b2fd0
Merge pull request #68 from ARMmbed/mbed-os-5.10.0-oob



Update to Mbed os 5.10.0

.

Commit copied from https://github.com/ARMmbed/mbed-os-example-filesystem

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 0:8e251d9511b8 1 # Getting started with the Mbed OS file system
mbed_official 0:8e251d9511b8 2
mbed_official 0:8e251d9511b8 3 This example demonstrates how to use the Mbed OS file system.
mbed_official 0:8e251d9511b8 4
mbed_official 1:2bfc377bcc2a 5 You can find more information about the Mbed OS file system and other related pieces of the Mbed OS storage stack [in the storage overview](https://os.mbed.com/docs/latest/reference/storage.html).
mbed_official 1:2bfc377bcc2a 6
mbed_official 1:2bfc377bcc2a 7 **Table of contents:**
mbed_official 1:2bfc377bcc2a 8
mbed_official 1:2bfc377bcc2a 9 1. [Hardware requirements](#hardware-requirements)
mbed_official 1:2bfc377bcc2a 10 1. [Usage](#usage)
mbed_official 1:2bfc377bcc2a 11 - [Import the example](#import-the-example)
mbed_official 1:2bfc377bcc2a 12 - [Compile the example](#compile-the-example)
mbed_official 1:2bfc377bcc2a 13 - [Run the example](#run-the-example)
mbed_official 1:2bfc377bcc2a 14 - [Troubleshooting](#troubleshooting)
mbed_official 1:2bfc377bcc2a 15 1. [Changing the file system](#changing-the-file-system)
mbed_official 1:2bfc377bcc2a 16 1. [Changing the block device](#changing-the-block-device)
mbed_official 1:2bfc377bcc2a 17 1. [Tested configurations](#tested-configurations)
mbed_official 0:8e251d9511b8 18
mbed_official 0:8e251d9511b8 19 ## Hardware requirements
mbed_official 0:8e251d9511b8 20
mbed_official 16:df247c577209 21 This example uses a block device as storage. This can be one of:
mbed_official 16:df247c577209 22
mbed_official 16:df247c577209 23 * A built-in SPI flash, such as on the [FRDM-K82F](https://os.mbed.com/platforms/FRDM-K82F/).
mbed_official 16:df247c577209 24 * An external block device (one of SPI flash, DataFlash or an SD card).
mbed_official 16:df247c577209 25 * Simulated on a heap block device on boards with enough RAM.
mbed_official 1:2bfc377bcc2a 26
mbed_official 1:2bfc377bcc2a 27 This example uses an instance of the LittleFileSystem API (LittleFS) on external SPI flash.
mbed_official 1:2bfc377bcc2a 28 The [changing the block device](#changing-the-block-device) section describes
mbed_official 1:2bfc377bcc2a 29 how to change the file system or block device in the example.
mbed_official 0:8e251d9511b8 30
mbed_official 0:8e251d9511b8 31 ## Usage
mbed_official 0:8e251d9511b8 32
mbed_official 0:8e251d9511b8 33 #### Import the example
mbed_official 0:8e251d9511b8 34
mbed_official 24:54f958b463d0 35 Make sure you have an Mbed development environment set up. [Get started with Mbed OS](https://os.mbed.com/docs/latest/tutorials/mbed-os-quick-start.html)
mbed_official 0:8e251d9511b8 36 to set everything up.
mbed_official 0:8e251d9511b8 37
mbed_official 0:8e251d9511b8 38 From the command-line, import the example:
mbed_official 0:8e251d9511b8 39
mbed_official 0:8e251d9511b8 40 ```
mbed_official 0:8e251d9511b8 41 mbed import mbed-os-example-filesystem
mbed_official 0:8e251d9511b8 42 cd mbed-os-example-filesystem
mbed_official 0:8e251d9511b8 43 ```
mbed_official 0:8e251d9511b8 44
mbed_official 0:8e251d9511b8 45 #### Compile the example
mbed_official 0:8e251d9511b8 46
mbed_official 0:8e251d9511b8 47 Invoke `mbed compile`, and specify the name of your platform and your favorite
mbed_official 0:8e251d9511b8 48 toolchain (`GCC_ARM`, `ARM`, `IAR`). For example, for the ARM Compiler 5:
mbed_official 0:8e251d9511b8 49
mbed_official 0:8e251d9511b8 50 ```
mbed_official 0:8e251d9511b8 51 mbed compile -m K64F -t ARM
mbed_official 0:8e251d9511b8 52 ```
mbed_official 0:8e251d9511b8 53
mbed_official 0:8e251d9511b8 54 Your PC may take a few minutes to compile your code. At the end, you see the
mbed_official 0:8e251d9511b8 55 following result:
mbed_official 0:8e251d9511b8 56
mbed_official 0:8e251d9511b8 57 ```
mbed_official 0:8e251d9511b8 58 [snip]
mbed_official 0:8e251d9511b8 59 +--------------------------+-------+-------+-------+
mbed_official 0:8e251d9511b8 60 | Module | .text | .data | .bss |
mbed_official 0:8e251d9511b8 61 +--------------------------+-------+-------+-------+
mbed_official 0:8e251d9511b8 62 | Fill | 164 | 0 | 2136 |
mbed_official 0:8e251d9511b8 63 | Misc | 54505 | 2556 | 754 |
mbed_official 0:8e251d9511b8 64 | drivers | 640 | 0 | 32 |
mbed_official 0:8e251d9511b8 65 | features/filesystem | 15793 | 0 | 550 |
mbed_official 0:8e251d9511b8 66 | features/storage | 42 | 0 | 184 |
mbed_official 0:8e251d9511b8 67 | hal | 418 | 0 | 8 |
mbed_official 0:8e251d9511b8 68 | platform | 2355 | 20 | 582 |
mbed_official 0:8e251d9511b8 69 | rtos | 135 | 4 | 4 |
mbed_official 0:8e251d9511b8 70 | rtos/rtx | 5861 | 20 | 6870 |
mbed_official 0:8e251d9511b8 71 | targets/TARGET_Freescale | 8382 | 12 | 384 |
mbed_official 0:8e251d9511b8 72 | Subtotals | 88295 | 2612 | 11504 |
mbed_official 0:8e251d9511b8 73 +--------------------------+-------+-------+-------+
mbed_official 0:8e251d9511b8 74 Allocated Heap: 24576 bytes
mbed_official 0:8e251d9511b8 75 Allocated Stack: unknown
mbed_official 0:8e251d9511b8 76 Total Static RAM memory (data + bss): 14116 bytes
mbed_official 0:8e251d9511b8 77 Total RAM memory (data + bss + heap + stack): 38692 bytes
mbed_official 0:8e251d9511b8 78 Total Flash memory (text + data + misc): 91947 bytes
mbed_official 0:8e251d9511b8 79
mbed_official 0:8e251d9511b8 80 Image: ./BUILD/K64F/ARM/mbed-os-example-filesystem.bin
mbed_official 0:8e251d9511b8 81 ```
mbed_official 0:8e251d9511b8 82
mbed_official 0:8e251d9511b8 83 #### Run the example
mbed_official 0:8e251d9511b8 84
mbed_official 0:8e251d9511b8 85 1. Connect your Mbed Enabled device to the computer over USB.
mbed_official 0:8e251d9511b8 86 1. Copy the binary file to the Mbed Enabled device.
mbed_official 0:8e251d9511b8 87 1. Press the reset button to start the program.
mbed_official 0:8e251d9511b8 88 1. Open the UART of the board in your favorite UART viewing program. For
mbed_official 0:8e251d9511b8 89 example, `screen /dev/ttyACM0`.
mbed_official 0:8e251d9511b8 90
mbed_official 0:8e251d9511b8 91 **Note:** The default serial port baud rate is 9600 bit/s.
mbed_official 0:8e251d9511b8 92
mbed_official 0:8e251d9511b8 93 Expected output:
mbed_official 0:8e251d9511b8 94
mbed_official 0:8e251d9511b8 95 ```
mbed_official 0:8e251d9511b8 96 --- Mbed OS filesystem example ---
mbed_official 0:8e251d9511b8 97 Mounting the filesystem... Fail :(
mbed_official 0:8e251d9511b8 98 No filesystem found, formatting... OK
mbed_official 0:8e251d9511b8 99 Opening "/fs/numbers.txt"... Fail :(
mbed_official 0:8e251d9511b8 100 No file found, creating a new file... OK
mbed_official 0:8e251d9511b8 101 Writing numbers (10/10)... OK
mbed_official 0:8e251d9511b8 102 Seeking file... OK
mbed_official 0:8e251d9511b8 103 Incrementing numbers (10/10)... OK
mbed_official 0:8e251d9511b8 104 Closing "/fs/numbers.txt"... OK
mbed_official 0:8e251d9511b8 105 Opening the root directory... OK
mbed_official 0:8e251d9511b8 106 root directory:
mbed_official 0:8e251d9511b8 107 .
mbed_official 0:8e251d9511b8 108 ..
mbed_official 0:8e251d9511b8 109 numbers.txt
mbed_official 0:8e251d9511b8 110 Closing the root directory... OK
mbed_official 0:8e251d9511b8 111 Opening "/fs/numbers.txt"...OK
mbed_official 0:8e251d9511b8 112 numbers:
mbed_official 0:8e251d9511b8 113 1
mbed_official 0:8e251d9511b8 114 2
mbed_official 0:8e251d9511b8 115 3
mbed_official 0:8e251d9511b8 116 4
mbed_official 0:8e251d9511b8 117 5
mbed_official 0:8e251d9511b8 118 6
mbed_official 0:8e251d9511b8 119 7
mbed_official 0:8e251d9511b8 120 8
mbed_official 0:8e251d9511b8 121 9
mbed_official 0:8e251d9511b8 122 10
mbed_official 0:8e251d9511b8 123 Closing "/fs/numbers.txt"... OK
mbed_official 0:8e251d9511b8 124 Unmounting... OK
mbed_official 0:8e251d9511b8 125 Mbed OS filesystem example done!
mbed_official 0:8e251d9511b8 126 ```
mbed_official 0:8e251d9511b8 127
mbed_official 0:8e251d9511b8 128 You can also reset the board to see the data persist across boots. Each boot
mbed_official 0:8e251d9511b8 129 increments the numbers stored on disk:
mbed_official 0:8e251d9511b8 130
mbed_official 0:8e251d9511b8 131 ```
mbed_official 0:8e251d9511b8 132 --- Mbed OS filesystem example ---
mbed_official 0:8e251d9511b8 133 Mounting the filesystem... OK
mbed_official 0:8e251d9511b8 134 Opening "/fs/numbers.txt"... OK
mbed_official 0:8e251d9511b8 135 Incrementing numbers (10/10)... OK
mbed_official 0:8e251d9511b8 136 Closing "/fs/numbers.txt"... OK
mbed_official 0:8e251d9511b8 137 Opening the root directory... OK
mbed_official 0:8e251d9511b8 138 root directory:
mbed_official 0:8e251d9511b8 139 .
mbed_official 0:8e251d9511b8 140 ..
mbed_official 0:8e251d9511b8 141 numbers.txt
mbed_official 0:8e251d9511b8 142 Closing the root directory... OK
mbed_official 0:8e251d9511b8 143 Opening "/fs/numbers.txt"...OK
mbed_official 0:8e251d9511b8 144 numbers:
mbed_official 0:8e251d9511b8 145 2
mbed_official 0:8e251d9511b8 146 3
mbed_official 0:8e251d9511b8 147 4
mbed_official 0:8e251d9511b8 148 5
mbed_official 0:8e251d9511b8 149 6
mbed_official 0:8e251d9511b8 150 7
mbed_official 0:8e251d9511b8 151 8
mbed_official 0:8e251d9511b8 152 9
mbed_official 0:8e251d9511b8 153 10
mbed_official 0:8e251d9511b8 154 11
mbed_official 0:8e251d9511b8 155 Closing "/fs/numbers.txt"... OK
mbed_official 0:8e251d9511b8 156 Unmounting... OK
mbed_official 0:8e251d9511b8 157 Mbed OS filesystem example done!
mbed_official 0:8e251d9511b8 158 ```
mbed_official 0:8e251d9511b8 159
mbed_official 0:8e251d9511b8 160 If you find yourself with a corrupted file system, you can reset the storage
mbed_official 0:8e251d9511b8 161 by pressing BUTTON1:
mbed_official 0:8e251d9511b8 162
mbed_official 0:8e251d9511b8 163 ```
mbed_official 0:8e251d9511b8 164 Initializing the block device... OK
mbed_official 0:8e251d9511b8 165 Erasing the block device... OK
mbed_official 0:8e251d9511b8 166 Deinitializing the block device... OK
mbed_official 0:8e251d9511b8 167 ```
mbed_official 0:8e251d9511b8 168
mbed_official 0:8e251d9511b8 169 Note that if you press the reset button at the wrong time, you may corrupt
mbed_official 0:8e251d9511b8 170 a file system that is not power resilient!
mbed_official 0:8e251d9511b8 171
mbed_official 0:8e251d9511b8 172 #### Troubleshooting
mbed_official 0:8e251d9511b8 173
mbed_official 0:8e251d9511b8 174 If you have problems, you can review the [documentation](https://os.mbed.com/docs/latest/tutorials/debugging.html)
mbed_official 0:8e251d9511b8 175 for suggestions on what could be wrong and how to fix it.
mbed_official 0:8e251d9511b8 176
mbed_official 0:8e251d9511b8 177 ## Changing the file system
mbed_official 0:8e251d9511b8 178
mbed_official 1:2bfc377bcc2a 179 In Mbed OS, a C++ classes that inherits from the [FileSystem](https://os.mbed.com/docs/latest/reference/storage.html#declaring-a-file-system)
mbed_official 0:8e251d9511b8 180 interface represents each file system. You can change the file system in the
mbed_official 0:8e251d9511b8 181 example by changing the class declared in main.cpp.
mbed_official 0:8e251d9511b8 182
mbed_official 0:8e251d9511b8 183 ``` diff
mbed_official 0:8e251d9511b8 184 - LittleFileSystem fs("fs");
mbed_official 12:a07d0af60cc6 185 + FATFileSystem fs("fs");
mbed_official 0:8e251d9511b8 186 ```
mbed_official 0:8e251d9511b8 187
mbed_official 6:5be6b5fd262f 188 **Note:** Different file systems require different minimum numbers of storage
mbed_official 6:5be6b5fd262f 189 blocks to function. For the `FATFileSystem`, this example requires a minimum of
mbed_official 6:5be6b5fd262f 190 256 blocks, and for the `LittleFileSystem`, this example requires a minimum of 6
mbed_official 6:5be6b5fd262f 191 blocks. You can find the number of blocks on a block device by dividing the
mbed_official 6:5be6b5fd262f 192 block device's size by its erase size.
mbed_official 6:5be6b5fd262f 193
mbed_official 0:8e251d9511b8 194 Mbed OS has two options for the file system:
mbed_official 0:8e251d9511b8 195
mbed_official 1:2bfc377bcc2a 196 - [**LittleFileSystem**](https://os.mbed.com/docs/latest/reference/littlefilesystem.html) -
mbed_official 1:2bfc377bcc2a 197 The little file system is a fail-safe file system we designed
mbed_official 0:8e251d9511b8 198 for embedded systems, specifically for microcontrollers that use flash
mbed_official 0:8e251d9511b8 199 storage.
mbed_official 1:2bfc377bcc2a 200
mbed_official 1:2bfc377bcc2a 201 ``` cpp
mbed_official 1:2bfc377bcc2a 202 LittleFileSystem fs("fs");
mbed_official 1:2bfc377bcc2a 203 ```
mbed_official 0:8e251d9511b8 204
mbed_official 0:8e251d9511b8 205 - **Bounded RAM/ROM** - This file system works with a limited amount of memory.
mbed_official 0:8e251d9511b8 206 It avoids recursion and limits dynamic memory to configurable
mbed_official 0:8e251d9511b8 207 buffers.
mbed_official 0:8e251d9511b8 208
mbed_official 0:8e251d9511b8 209 - **Power-loss resilient** - We designed this for operating systems
mbed_official 0:8e251d9511b8 210 that may have random power failures. It has strong copy-on-write
mbed_official 0:8e251d9511b8 211 guarantees and keeps storage on disk in a valid state.
mbed_official 0:8e251d9511b8 212
mbed_official 0:8e251d9511b8 213 - **Wear leveling** - Because the most common form of embedded storage is
mbed_official 0:8e251d9511b8 214 erodible flash memories, this file system provides a form of dynamic wear
mbed_official 0:8e251d9511b8 215 leveling for systems that cannot fit a full flash translation layer.
mbed_official 0:8e251d9511b8 216
mbed_official 0:8e251d9511b8 217 - **FATFileSystem** - The FAT file system is a well-known file system that you
mbed_official 0:8e251d9511b8 218 can find on almost every system, including PCs. The Mbed OS implementation of
mbed_official 0:8e251d9511b8 219 the FAT file system is based on ChanFS and is optimized for small embedded systems.
mbed_official 1:2bfc377bcc2a 220
mbed_official 1:2bfc377bcc2a 221 ``` cpp
mbed_official 1:2bfc377bcc2a 222 FATFileSystem fs("fs");
mbed_official 1:2bfc377bcc2a 223 ```
mbed_official 0:8e251d9511b8 224
mbed_official 0:8e251d9511b8 225 - **Portable** - Almost every operating system supports the FAT file system,
mbed_official 0:8e251d9511b8 226 which is the most common file system found on portable storage, such as SD
mbed_official 0:8e251d9511b8 227 cards and flash drives. The FAT file system is the easiest way to support
mbed_official 0:8e251d9511b8 228 access from a PC.
mbed_official 0:8e251d9511b8 229
mbed_official 0:8e251d9511b8 230 ## Changing the block device
mbed_official 0:8e251d9511b8 231
mbed_official 1:2bfc377bcc2a 232 In Mbed OS, a C++ classes that inherits from the [BlockDevice](https://os.mbed.com/docs/latest/reference/storage.html#block-devices)
mbed_official 0:8e251d9511b8 233 interface represents each block device. You can change the filesystem in the
mbed_official 0:8e251d9511b8 234 example by changing the class declared in main.cpp.
mbed_official 0:8e251d9511b8 235
mbed_official 0:8e251d9511b8 236 ``` diff
mbed_official 0:8e251d9511b8 237 -SPIFBlockDevice bd(
mbed_official 0:8e251d9511b8 238 - MBED_CONF_SPIF_DRIVER_SPI_MOSI,
mbed_official 0:8e251d9511b8 239 - MBED_CONF_SPIF_DRIVER_SPI_MISO,
mbed_official 0:8e251d9511b8 240 - MBED_CONF_SPIF_DRIVER_SPI_CLK,
mbed_official 0:8e251d9511b8 241 - MBED_CONF_SPIF_DRIVER_SPI_CS);
mbed_official 0:8e251d9511b8 242 +SDBlockDevice bd(
mbed_official 0:8e251d9511b8 243 + MBED_CONF_SD_SPI_MOSI,
mbed_official 0:8e251d9511b8 244 + MBED_CONF_SD_SPI_MISO,
mbed_official 0:8e251d9511b8 245 + MBED_CONF_SD_SPI_CLK,
mbed_official 0:8e251d9511b8 246 + MBED_CONF_SD_SPI_CS);
mbed_official 0:8e251d9511b8 247 ```
mbed_official 0:8e251d9511b8 248
mbed_official 2:6a0c72c9d3fb 249 **Note:** Most block devices require pin assignments. Double check that the
mbed_official 2:6a0c72c9d3fb 250 pins in `<driver>/mbed_lib.json` are correct. For example, to change the pins for the SD driver, open `sd-driver/config/mbed_lib.json`, and change your target platform to the correct pin-out in the `target_overrides` configuration:
mbed_official 2:6a0c72c9d3fb 251
mbed_official 2:6a0c72c9d3fb 252 ```
mbed_official 2:6a0c72c9d3fb 253 "target_overrides": {
mbed_official 2:6a0c72c9d3fb 254 ...
mbed_official 2:6a0c72c9d3fb 255 "NUCLEO_F429ZI": {
mbed_official 2:6a0c72c9d3fb 256 "SPI_MOSI": "PC_12",
mbed_official 2:6a0c72c9d3fb 257 "SPI_MISO": "PC_11",
mbed_official 2:6a0c72c9d3fb 258 "SPI_CLK": "PC_10",
mbed_official 2:6a0c72c9d3fb 259 "SPI_CS": "PA_15"
mbed_official 2:6a0c72c9d3fb 260 },
mbed_official 2:6a0c72c9d3fb 261 ...
mbed_official 2:6a0c72c9d3fb 262 }
mbed_official 2:6a0c72c9d3fb 263 ```
mbed_official 25:65a9183a2178 264 The pins macros define above can be override at the application configuration file using the driver prefix before the parameter name.
mbed_official 25:65a9183a2178 265 ```
mbed_official 25:65a9183a2178 266 "target_overrides": {
mbed_official 25:65a9183a2178 267 ...
mbed_official 25:65a9183a2178 268 "NUCLEO_F429ZI": {
mbed_official 25:65a9183a2178 269 "spif-driver.SPI_MOSI": "PC_12",
mbed_official 25:65a9183a2178 270 "spif-driver.SPI_MISO": "PC_11",
mbed_official 25:65a9183a2178 271 "spif-driver.SPI_CLK": "PC_10",
mbed_official 25:65a9183a2178 272 "spif-driver.SPI_CS": "PA_15"
mbed_official 25:65a9183a2178 273 },
mbed_official 25:65a9183a2178 274 ...
mbed_official 25:65a9183a2178 275 }
mbed_official 25:65a9183a2178 276 ```
mbed_official 25:65a9183a2178 277 or
mbed_official 25:65a9183a2178 278 ```
mbed_official 25:65a9183a2178 279 "target_overrides": {
mbed_official 25:65a9183a2178 280 ...
mbed_official 25:65a9183a2178 281 "NUCLEO_F429ZI": {
mbed_official 25:65a9183a2178 282 "sd.SPI_MOSI": "PC_12",
mbed_official 25:65a9183a2178 283 "sd.SPI_MISO": "PC_11",
mbed_official 25:65a9183a2178 284 "sd.SPI_CLK": "PC_10",
mbed_official 25:65a9183a2178 285 "sd.SPI_CS": "PA_15"
mbed_official 25:65a9183a2178 286 },
mbed_official 25:65a9183a2178 287 ...
mbed_official 25:65a9183a2178 288 }
mbed_official 25:65a9183a2178 289 ```
mbed_official 2:6a0c72c9d3fb 290
mbed_official 0:8e251d9511b8 291 Mbed OS has several options for the block device:
mbed_official 0:8e251d9511b8 292
mbed_official 0:8e251d9511b8 293 - **SPIFBlockDevice** - Block device driver for NOR-based SPI flash devices that
mbed_official 1:2bfc377bcc2a 294 support SFDP. NOR-based SPI flash supports byte-sized read and writes, with an
mbed_official 1:2bfc377bcc2a 295 erase size of about 4kbytes. An erase sets a block to all 1s, with successive
mbed_official 1:2bfc377bcc2a 296 writes clearing set bits.
mbed_official 1:2bfc377bcc2a 297
mbed_official 1:2bfc377bcc2a 298 ``` cpp
mbed_official 1:2bfc377bcc2a 299 SPIFBlockDevice bd(
mbed_official 1:2bfc377bcc2a 300 MBED_CONF_SPIF_DRIVER_SPI_MOSI,
mbed_official 1:2bfc377bcc2a 301 MBED_CONF_SPIF_DRIVER_SPI_MISO,
mbed_official 1:2bfc377bcc2a 302 MBED_CONF_SPIF_DRIVER_SPI_CLK,
mbed_official 1:2bfc377bcc2a 303 MBED_CONF_SPIF_DRIVER_SPI_CS);
mbed_official 1:2bfc377bcc2a 304 ```
mbed_official 0:8e251d9511b8 305
mbed_official 25:65a9183a2178 306 Starting mbed-os 5.10 the SPIFBlockDevice is a component under mbed-os. In order to add a component to the application use the following `target_overrides` configuration at the application configuration file:
mbed_official 25:65a9183a2178 307 ```
mbed_official 25:65a9183a2178 308 "target_overrides": {
mbed_official 25:65a9183a2178 309 ...
mbed_official 25:65a9183a2178 310 "NUCLEO_F429ZI": {
mbed_official 25:65a9183a2178 311 "target.components_add": ["SPIF"],
mbed_official 25:65a9183a2178 312 ...
mbed_official 25:65a9183a2178 313 },
mbed_official 25:65a9183a2178 314 ...
mbed_official 25:65a9183a2178 315 }
mbed_official 25:65a9183a2178 316 ```
mbed_official 25:65a9183a2178 317
mbed_official 0:8e251d9511b8 318 - **DataFlashBlockDevice** - Block device driver for NOR-based SPI flash devices
mbed_official 1:2bfc377bcc2a 319 that support the DataFlash protocol, such as the Adesto AT45DB series of
mbed_official 1:2bfc377bcc2a 320 devices. DataFlash is a memory protocol that combines flash with SRAM buffers
mbed_official 1:2bfc377bcc2a 321 for a programming interface. DataFlash supports byte-sized read and writes, with
mbed_official 1:2bfc377bcc2a 322 an erase size of about 528 bytes or sometimes 1056 bytes. DataFlash provides
mbed_official 1:2bfc377bcc2a 323 erase sizes with an extra 16 bytes for error correction codes (ECC), so a flash
mbed_official 1:2bfc377bcc2a 324 translation layer (FTL) may still present 512 byte erase sizes.
mbed_official 1:2bfc377bcc2a 325
mbed_official 1:2bfc377bcc2a 326 ``` cpp
mbed_official 1:2bfc377bcc2a 327 DataFlashBlockDevice bd(
mbed_official 1:2bfc377bcc2a 328 MBED_CONF_DATAFLASH_SPI_MOSI,
mbed_official 1:2bfc377bcc2a 329 MBED_CONF_DATAFLASH_SPI_MISO,
mbed_official 1:2bfc377bcc2a 330 MBED_CONF_DATAFLASH_SPI_CLK,
mbed_official 1:2bfc377bcc2a 331 MBED_CONF_DATAFLASH_SPI_CS);
mbed_official 1:2bfc377bcc2a 332 ```
mbed_official 0:8e251d9511b8 333
mbed_official 25:65a9183a2178 334 Starting mbed-os 5.10 the DataFlashBlockDevice is a component under mbed-os. In order to add a component to the application use the following `target_overrides` configuration at the application configuration file:
mbed_official 25:65a9183a2178 335 ```
mbed_official 25:65a9183a2178 336 "target_overrides": {
mbed_official 25:65a9183a2178 337 ...
mbed_official 25:65a9183a2178 338 "NUCLEO_F429ZI": {
mbed_official 25:65a9183a2178 339 "target.components_add": ["DATAFLASH"],
mbed_official 25:65a9183a2178 340 ...
mbed_official 25:65a9183a2178 341 },
mbed_official 25:65a9183a2178 342 ...
mbed_official 25:65a9183a2178 343 }
mbed_official 25:65a9183a2178 344 ```
mbed_official 25:65a9183a2178 345
mbed_official 0:8e251d9511b8 346 - **SDBlockDevice** - Block device driver for SD cards and eMMC memory chips. SD
mbed_official 1:2bfc377bcc2a 347 cards or eMMC chips offer a full FTL layer on top of NAND flash. This makes the
mbed_official 1:2bfc377bcc2a 348 storage well-suited for systems that require a about 1GB of memory.
mbed_official 1:2bfc377bcc2a 349 Additionally, SD cards are a popular form of portable storage. They are useful
mbed_official 1:2bfc377bcc2a 350 if you want to store data that you can access from a PC.
mbed_official 1:2bfc377bcc2a 351
mbed_official 1:2bfc377bcc2a 352 ``` cpp
mbed_official 1:2bfc377bcc2a 353 SDBlockDevice bd(
mbed_official 1:2bfc377bcc2a 354 MBED_CONF_SD_SPI_MOSI,
mbed_official 1:2bfc377bcc2a 355 MBED_CONF_SD_SPI_MISO,
mbed_official 1:2bfc377bcc2a 356 MBED_CONF_SD_SPI_CLK,
mbed_official 1:2bfc377bcc2a 357 MBED_CONF_SD_SPI_CS);
mbed_official 1:2bfc377bcc2a 358 ```
mbed_official 0:8e251d9511b8 359
mbed_official 25:65a9183a2178 360 Starting mbed-os 5.10 the SDBlockDevice is a component under mbed-os. In order to add a component to the application use the following `target_overrides` configuration at the application configuration file:
mbed_official 25:65a9183a2178 361 ```
mbed_official 25:65a9183a2178 362 "target_overrides": {
mbed_official 25:65a9183a2178 363 ...
mbed_official 25:65a9183a2178 364 "NUCLEO_F429ZI": {
mbed_official 25:65a9183a2178 365 "target.components_add": ["SD"],
mbed_official 25:65a9183a2178 366 ...
mbed_official 25:65a9183a2178 367 },
mbed_official 25:65a9183a2178 368 ...
mbed_official 25:65a9183a2178 369 }
mbed_official 25:65a9183a2178 370 ```
mbed_official 25:65a9183a2178 371
mbed_official 0:8e251d9511b8 372 - [**HeapBlockDevice**](https://os.mbed.com/docs/v5.6/reference/heapblockdevice.html) -
mbed_official 0:8e251d9511b8 373 Block device that simulates storage in RAM using the heap. Do not use the heap
mbed_official 0:8e251d9511b8 374 block device for storing data persistently because a power loss causes
mbed_official 0:8e251d9511b8 375 complete loss of data. Instead, use it fortesting applications when a storage
mbed_official 0:8e251d9511b8 376 device is not available.
mbed_official 1:2bfc377bcc2a 377
mbed_official 1:2bfc377bcc2a 378 ``` cpp
mbed_official 1:2bfc377bcc2a 379 HeapBlockDevice bd(1024*512, 512);
mbed_official 1:2bfc377bcc2a 380 ```
mbed_official 0:8e251d9511b8 381
mbed_official 0:8e251d9511b8 382 Additionally, Mbed OS contains several utility block devices to give you better
mbed_official 0:8e251d9511b8 383 control over the allocation of storage.
mbed_official 0:8e251d9511b8 384
mbed_official 1:2bfc377bcc2a 385 - [**SlicingBlockDevice**](https://os.mbed.com/docs/latest/reference/slicingblockdevice.html) -
mbed_official 0:8e251d9511b8 386 With the slicing block device, you can partition storage into smaller block
mbed_official 0:8e251d9511b8 387 devices that you can use independently.
mbed_official 0:8e251d9511b8 388
mbed_official 1:2bfc377bcc2a 389 - [**ChainingBlockDevice**](https://os.mbed.com/docs/latest/reference/chainingblockdevice.html) -
mbed_official 0:8e251d9511b8 390 With the chaining block device, you can chain multiple block devices together
mbed_official 0:8e251d9511b8 391 and extend the usable amount of storage.
mbed_official 0:8e251d9511b8 392
mbed_official 1:2bfc377bcc2a 393 - [**MBRBlockDevice**](https://os.mbed.com/docs/latest/reference/mbrblockdevice.html) -
mbed_official 0:8e251d9511b8 394 Mbed OS comes with support for storing partitions on disk with a Master Boot
mbed_official 0:8e251d9511b8 395 Record (MBR). The MBRBlockDevice provides this functionality and supports
mbed_official 0:8e251d9511b8 396 creating partitions at runtime or using preformatted partitions configured
mbed_official 0:8e251d9511b8 397 separately from outside the application.
mbed_official 0:8e251d9511b8 398
mbed_official 0:8e251d9511b8 399 - **ReadOnlyBlockDevice** - With the read-only block device, you can wrap a
mbed_official 0:8e251d9511b8 400 block device in a read-only layer, ensuring that user of the block device does
mbed_official 0:8e251d9511b8 401 not modify the storage.
mbed_official 0:8e251d9511b8 402
mbed_official 0:8e251d9511b8 403 - **ProfilingBlockDevice** - With the profiling block device, you can profile
mbed_official 0:8e251d9511b8 404 the quantity of erase, program and read operations that are incurred on a
mbed_official 0:8e251d9511b8 405 block device.
mbed_official 0:8e251d9511b8 406
mbed_official 0:8e251d9511b8 407 - **ObservingBlockDevice** - The observing block device grants the user the
mbed_official 0:8e251d9511b8 408 ability to register a callback on block device operations. You can use this to
mbed_official 0:8e251d9511b8 409 inspect the state of the block device, log different metrics or perform some
mbed_official 0:8e251d9511b8 410 other operation.
mbed_official 0:8e251d9511b8 411
mbed_official 0:8e251d9511b8 412 - **ExhaustibleBlockDevice** - Useful for evaluating how file systems respond to
mbed_official 0:8e251d9511b8 413 wear, the exhaustible block device simulates wear on another form of storage.
mbed_official 0:8e251d9511b8 414 You can configure it to expire blocks as necessary.
mbed_official 0:8e251d9511b8 415
mbed_official 1:2bfc377bcc2a 416 ## Tested configurations
mbed_official 1:2bfc377bcc2a 417
mbed_official 1:2bfc377bcc2a 418 - K64F + Heap + LittleFS
mbed_official 1:2bfc377bcc2a 419 - K64F + Heap + FATFS
mbed_official 1:2bfc377bcc2a 420 - K64F + SD + LittleFS
mbed_official 1:2bfc377bcc2a 421 - K64F + SD + FATFS
mbed_official 1:2bfc377bcc2a 422 - K64F + SPIF (requires shield) + LittleFS
mbed_official 1:2bfc377bcc2a 423 - K64F + SPIF (requires shield) + FATFS
mbed_official 1:2bfc377bcc2a 424 - K64F + DataFlash (requires shield) + LittleFS
mbed_official 1:2bfc377bcc2a 425 - K64F + DataFlash (requires shield) + FATFS
mbed_official 11:656a96b9981b 426 - UBLOX_EVK_ODIN_W2 \[1\] + Heap + LittleFS
mbed_official 11:656a96b9981b 427 - UBLOX_EVK_ODIN_W2 \[1\] + Heap + FATFS
mbed_official 11:656a96b9981b 428 - UBLOX_EVK_ODIN_W2 \[1\] + SD + LittleFS
mbed_official 11:656a96b9981b 429 - UBLOX_EVK_ODIN_W2 \[1\] + SD + FATFS
mbed_official 11:656a96b9981b 430 - UBLOX_EVK_ODIN_W2 \[1\] + SPIF (requires shield) + LittleFS
mbed_official 11:656a96b9981b 431 - UBLOX_EVK_ODIN_W2 \[1\] + SPIF (requires shield) + FATFS
mbed_official 11:656a96b9981b 432 - UBLOX_EVK_ODIN_W2 \[1\] + DataFlash (requires shield) + LittleFS
mbed_official 11:656a96b9981b 433 - UBLOX_EVK_ODIN_W2 \[1\] + DataFlash (requires shield) + FATFS
mbed_official 1:2bfc377bcc2a 434 - NUCLEO_F429ZI + Heap + LittleFS
mbed_official 1:2bfc377bcc2a 435 - NUCLEO_F429ZI + Heap + FATFS
mbed_official 1:2bfc377bcc2a 436 - NUCLEO_F429ZI + SD (requires shield) + LittleFS
mbed_official 1:2bfc377bcc2a 437 - NUCLEO_F429ZI + SD (requires shield) + FATFS
mbed_official 1:2bfc377bcc2a 438 - NUCLEO_F429ZI + SPIF (requires shield) + LittleFS
mbed_official 1:2bfc377bcc2a 439 - NUCLEO_F429ZI + SPIF (requires shield) + FATFS
mbed_official 1:2bfc377bcc2a 440 - NUCLEO_F429ZI + DataFlash (requires shield) + LittleFS
mbed_official 1:2bfc377bcc2a 441 - NUCLEO_F429ZI + DataFlash (requires shield) + FATFS
mbed_official 11:656a96b9981b 442
mbed_official 11:656a96b9981b 443 \[1\]: Note: The UBLOX_EVK_ODIN_W2 SPI pins conflict with the default serial
mbed_official 11:656a96b9981b 444 pins. A different set of serial pins must be selected to use SPI flash with
mbed_official 11:656a96b9981b 445 serial output.
mbed_official 11:656a96b9981b 446
mbed_official 11:656a96b9981b 447 ```c++
mbed_official 11:656a96b9981b 448 // Connect Tx, Rx, and ground pins to a separte board running the passthrough example:
mbed_official 11:656a96b9981b 449 // https://os.mbed.com/users/sarahmarshy/code/SerialPassthrough/file/2a3a62ee17fa/main.cpp/
mbed_official 11:656a96b9981b 450 Serial pc(TX, RX);
mbed_official 11:656a96b9981b 451
mbed_official 11:656a96b9981b 452 pc.printf("..."); // Replace printf with pc.printf in the example
mbed_official 11:656a96b9981b 453 ```
mbed_official 11:656a96b9981b 454