Getting Started With The mbed-os Example for the SPI Flash Block Device

This is the mbed-os example for the SPIFBlockDevice driver. See the spiflash-driver repository for more information.

This guide outlines the steps to get a SPI NOR flash part working on an mbed OS platform.

Please install mbed CLI.

Hardware Requirements

This example can be used on an mbedos platform with a SPI NOR part connected to the SPI pins (on the Arduino header, for example).

This document uses the K64F as an example. Simply change the relevant options (e.g. -m K64F) to be appropriate for your target.

Create the Example Application

From the command-line, import the example:

mbed import mbed-os-example-spiflash-driver

You should see:

[mbed] Importing program "mbed-os-example-spiflash-driver" from "https://github.com/ARMmbed/mbed-os-example-spiflash-driver" at latest revision in the current branch
[mbed] Adding library "mbed-os" from "https://github.com/ARMmbed/mbed-os" at rev #f4864dc6429e

Move into the newly created directory:

cd mbed-os-example-spiflash-driver

If the mbed-os library was not automatically added (see trace above), do the following to import mbed-os:

mbed new .

Build the Example

Invoke mbed compile, and specify the name of your platform and your favorite toolchain (GCC_ARM, ARM, IAR). For example, for the GCC_ARM toolchain:

mbed compile -m K64F -t GCC_ARM

Your PC may take a few minutes to compile your code. At the end, you see the following result:

[snip]
+--------------------------+-------+-------+-------+
| Module                   | .text | .data |  .bss |
+--------------------------+-------+-------+-------+
| Fill                     |    86 |     4 |  2077 |
| Misc                     | 33975 |  2212 |   492 |
| drivers                  |   558 |     0 |    32 |
| features/storage         |    42 |     0 |   184 |
| hal                      |   450 |     0 |     8 |
| platform                 |  1232 |     4 |   269 |
| rtos                     |   135 |     4 |     4 |
| rtos/rtx                 |  5915 |    20 |  6870 |
| targets/TARGET_Freescale | 12447 |    12 |   384 |
| Subtotals                | 54840 |  2256 | 10320 |
+--------------------------+-------+-------+-------+
Allocated Heap: 24576 bytes
Allocated Stack: unknown
Total Static RAM memory (data + bss): 12576 bytes
Total RAM memory (data + bss + heap + stack): 37152 bytes
Total Flash memory (text + data + misc): 58136 bytes

Image: .\BUILD\K64F\GCC_ARM\mbed-os-example-spiflash-driver.bin	

Run the Example Binary on the K64F

Copy the binary from <root_dir>/mbed-os-example-spiflash-driver/BUILD/K64F/GCC_ARM/mbed-os-example-spiflash-driver.bin to the K64F:

1. Connect your mbed device to the computer over USB.
2. Copy the binary file to the mbed device.
3. Press the reset button to start the program.
4. Open the UART of the board in your favorite UART viewing program. For example, screen /dev/ttyACM0.

After connecting a serial console and resetting the target, the following trace should be seen:

spif test
spif size: 2097152
spif read size: 1
spif program size: 1
spif erase size: 4096
Hello World!

Troubleshooting

1. Make sure mbed-cli is working correctly and its version is newer than 1.0.0.

mbed --version

If not, update it:

pip install mbed-cli --upgrade