Add default block device support (SD, SPIF and FLASHIAP) #7774

yossi2le · 2018-08-13T13:55:56Z

Description

In this PR the SD, SPIF and FLASHIAP block device are moved into mbedos, enabling the addon of default block device and default filesystem functionality in favor of firmware update requirement.
SD, SPIF and FLASHIAP block devices are added under the new component label configured in target.json. Any board with SD or SPIF component enabled will have a default block device and filesystem. Using the new feature is as easy as:

#include "SystemStorage.h"
BlockDevice *bd = mbed::SystemStorage::get_default_blockdevice();
FileSystem  *fs = mbed::SystemStorage::get_default_filesystem();

The default implementation is implemented using MBED_WEAK enabling an easy way to override it if needed.

namespace mbed {
namespace SystemStorage{
BlockDevice* get_default_blockdevice()
{
    static HeapBlockDevice( 32*1024);
    return &default_bd;
}
}
}

Using any desired block device and filesystem are not affected by this PR.

Directory structure

New block devices and their tests can be found under the following paths:
./components/storage/blockdevices/COMPONENT_SD
/components/storage/blockdevices/COMPONENT_SPIF
/components/storage/blockdevices/COMPONENT_FLASHIAP

The default block device and default filesystem implementation is found under SystemStorage namespace at:
./features/storage/system_storage

New filesystem test for default block device and filesystem are found at:
./features/storage/TESTS/filesystem/general_filesystem

The PR also includes reordering of the storage directory in order to maintain much cleaner and more structured environment in mbedos.

Common filesystem files were moved from ./feature/filesystem to ./feature/storage/filesystem.
Common block devices files were moved from ./features/filesystem/bd to ./features/storage/blockdevices
those changes has been done in order to follow the components design spirit.

configuration

Configuration of SPI pins has been moved into PinsNames.h under targets, however the option to override the default configuration or add one, if PinsName.h is missing the SPI pins, can be done from application config.

Example for SD:

"target_overrides": {
        "DISCO_L476VG": {
              "sd.SPI_MOSI": "PE_15",
              "sd.SPI_MISO": "PE_14",
              "sd.SPI_CLK":  "PE_13",
              "sd.SPI_CS":   "PE_12"
        },

Example for SPIF:

"target_overrides": {
       "MTB_UBLOX_ODIN_W2": {
             "spif-driver.SPI_MOSI": "PE_14",
             "spif-driver.SPI_MISO": "PE_13",
             "spif-driver.SPI_CLK":  "PE_12",
             "spif-driver.SPI_CS":   "PE_11"
        },

Dependencies

This PR is dependent on PR #7644

Pull request type

[ ] Fix
[ ] Refactor
[ ] Target update
[ ] Feature
[x] Breaking change

…updated filesytem readme.

…ormation.

Fix default spi speed to 40mhz

… BlockDevice::size() const change.

…s due to incompatible versions of mbed-os and sd-driver.

Fix default spi speed to 40Mhz

…er block device examples.

Fix const attribute mismatch on size function

…FS test cases on first time initialisation.

…ation with 1ms wait between response queries.

Fix for armmbed/sd-driver issue 4: SDCard Initialisation fails for ES…

Into shell..

Modify example also similarly to match the PIN definitions. This encapsulates all the SD-card related stuff to this library. By including this library you also get the pin definitions on the same go.

Start using mbed_lib.json

Enable the internal SD-card reader in UBLOX_EVK_ODIN_W2. This will disable the CI-shield SD-card reader if you have, if you prefer using it you have to remove this target override section. Please note that there seem to be some reliability problems with the internal SD-card slot, in my case the mbed OS CI-shield works better.

Add UBLOX_EVK_ODIN_W2 override for int. SD-card

This is needed as the regular configuration does not work with this board due pin conflict with Ethernet and SD-card.

1. Added function to select/deselect the device 2. Init function for SPI

3. Removed redundant function _cmdx

1. Added enum for all commands supported. 2. Added error codes 3. Command Response defines 4. SPI Data Read/Write defines

5. Separated SPI functionality in different function call. 6. Used enums for existing commands using _cmd function.

mbed-ci · 2018-09-01T12:55:56Z

Test : FAILURE

Build number : 2735
Test logs :http://mbed-os-logs.s3-website-us-west-1.amazonaws.com/?prefix=logs/7774/2735

0xc0170 · 2018-09-01T12:58:22Z

/morph test

mbed-ci · 2018-09-01T16:13:10Z

Test : SUCCESS

Build number : 2737
Test logs :http://mbed-os-logs.s3-website-us-west-1.amazonaws.com/?prefix=logs/7774/2737

yossi2le · 2018-09-01T17:48:02Z

@0xc0170, @cmonr and all maintainers.
Thanks a lot for all the help with this PR:)

cmonr · 2018-09-01T20:50:44Z

@yossi2le Of course! Thank you for all of the hard work on the PR!

jeromecoutant · 2018-09-04T09:41:48Z

Hi

It seems that added "SPI_PERSISTENT_MEM_CS" is not used anywhere ?

Maybe you should remove it from all PinNames.h files ?

Thx

yossi2le · 2018-09-04T10:24:33Z

Hi

It seems that added "SPI_PERSISTENT_MEM_CS" is not used anywhere ?

Maybe you should remove it from all PinNames.h files ?

Thx

@jeromecoutant Thanks for pointing this. those are important and should be used in config files. it appears that we missed it in last releases.
I will fix it in a sperate PR.

jeromecoutant · 2018-09-04T12:19:11Z

Hi

Do you also plan to update https://github.com/ARMmbed/ci-test-shield ?
(replace SDDriver.lib by the component)

yossi2le · 2018-09-04T12:31:05Z

We haven't added this in our plans. however, I believe someone does need to do so.

jeromecoutant · 2018-09-04T13:07:23Z

And in https://github.com/ARMmbed/sd-driver

Maybe we should indicate that this repo is “deprecated”,
all new patch will be posted only in mbed-os now ?

yossi2le · 2018-09-04T13:34:37Z

And in https://github.com/ARMmbed/sd-driver

Maybe we should indicate that this repo is “deprecated”,
all new patch will be posted only in mbed-os now?

The Sd-driver, spif-driver, dataflash-driver and flashiap-driver repos have already has a pending PR just for that.

…mit reverts those files excpet for K82F and K64F which are left as an example

Reverting PinNames.h after PR #7774 changes

…erts those files excpet for K82F and K64F which are left as an example

… Target should be K64F

…t should be K64F

…to the config files

simonqhughes and others added 30 commits March 7, 2017 17:19

Fixed fopen and basic test cases to use renamed mbed_retarget.h, and …

a3484e0

…updated filesytem readme.

Fixing url references

58c52d3

Updated to match API changes in mbed OS

6e3dcd9

Updated README.md to include worked exmaples and restructuring of inf…

b2fb488

…ormation.

Update SPIFBlockDevice.h

8ef4d3d

Fix default spi speed to 40mhz

Fixing SDBlockDevice::size() and SPIFBlockDevice::size() to implement…

a8c85d3

… BlockDevice::size() const change.

Updated version of README.md describing how to overcome build problem…

7ee1fbc

…s due to incompatible versions of mbed-os and sd-driver.

Fixed const attribute mismatch on size function

aabeb8c

Merge pull request #1 from canhkha/patch-1

2dd0c79

Fix default spi speed to 40Mhz

Updated readme with appendices describing i2ceeprom and spiflash-driv…

61d3a88

…er block device examples.

Updated readme with appendices corrections.

29074fe

Updated readme with appendices corrections.

c7dba87

Removing SPIBlockDevice module as present in spiflash-driver repository.

e2fc4fc

Removing old spif test case.

96142e4

Merge pull request #1 from ARMmbed/g-fix-size-const

3b0529a

Fix const attribute mismatch on size function

Fix for armmbed/sd-driver issue 4: SDCard Initialisation fails for ES…

88fecd5

…FS test cases on first time initialisation.

Incorporated review feedback for simplfied _go_idle_state() implement…

5830844

…ation with 1ms wait between response queries.

Merge pull request #5 from simonqhughes/master

37b5043

Fix for armmbed/sd-driver issue 4: SDCard Initialisation fails for ES…

Anonymise the shell prompts

2ee24bd

Into shell..

Start using mbed_lib.json

f90353c

Modify example also similarly to match the PIN definitions. This encapsulates all the SD-card related stuff to this library. By including this library you also get the pin definitions on the same go.

Merge pull request davidsaada#13 from ARMmbed/mbed_lib

2dc0da5

Start using mbed_lib.json

Merge pull request davidsaada#15 from ARMmbed/ublox_odin_int_sd

be68bf8

Add UBLOX_EVK_ODIN_W2 override for int. SD-card

Add pin override for NUCLEO_F429ZI (davidsaada#20)

efc6bbc

This is needed as the regular configuration does not work with this board due pin conflict with Ethernet and SD-card.

capacity of card to be calcualted from csd [69,48]

f462bb6

Cleanup of SPI related code

a26b3bc

1. Added function to select/deselect the device 2. Init function for SPI

Cleanup of SPI related code

fa885f4

3. Removed redundant function _cmdx

Single command function call for all commands supported.

fbd1faf

1. Added enum for all commands supported. 2. Added error codes 3. Command Response defines 4. SPI Data Read/Write defines

Single command function call for all commands supported

27ceeee

5. Separated SPI functionality in different function call. 6. Used enums for existing commands using _cmd function.

Added response type handling for _cmd

e10c59d

cmonr merged commit 993c897 into ARMmbed:master Sep 1, 2018

0xc0170 removed the needs: CI label Sep 1, 2018

cmonr removed the risk: G label Sep 2, 2018

offirko mentioned this pull request Sep 2, 2018

Prevent sector-unaligned erase #7952

Merged

yossi2le mentioned this pull request Sep 4, 2018

Using SPI_ macros from PinNames in SPIF and SD config files. #7979

Merged

yossi2le pushed a commit to yossi2le/mbed-os that referenced this pull request Sep 5, 2018

Changes in PR ARMmbed#7774 of PinNames.h should be reverted. This com…

acfda58

…mit reverts those files excpet for K82F and K64F which are left as an example

yossi2le mentioned this pull request Sep 5, 2018

Reverting PinNames.h after PR #7774 changes #7995

Merged

cmonr pushed a commit that referenced this pull request Sep 6, 2018

Merge pull request #7995 from yossi2le/revert-pinnames-files

ff1a0ed

Reverting PinNames.h after PR #7774 changes

adbridge pushed a commit that referenced this pull request Sep 11, 2018

Changes in PR #7774 of PinNames.h should be reverted. This commit rev…

0ec2514

…erts those files excpet for K82F and K64F which are left as an example

jygeARM mentioned this pull request Sep 19, 2018

Library name 'sd' is not unique PelionIoT/mbed-bootloader#8

Closed

yossi2le pushed a commit to yossi2le/mbed-os that referenced this pull request Oct 4, 2018

Adding back blockdevice example after removing it for PR ARMmbed#7774.…

4bb8ebf

… Target should be K64F

yossi2le mentioned this pull request Oct 4, 2018

Add blockdevice example back to CI #8323

Merged

adbridge pushed a commit that referenced this pull request Oct 19, 2018

Adding back blockdevice example after removing it for PR #7774. Targe…

8f95eb5

…t should be K64F

yossi2le pushed a commit to yossi2le/mbed-os that referenced this pull request Oct 25, 2018

Using the SPI_ macros which was added to PinNames.h in PR ARMmbed#7774 …

eddd2b1

…to the config files

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add default block device support (SD, SPIF and FLASHIAP) #7774

Add default block device support (SD, SPIF and FLASHIAP) #7774

Uh oh!

yossi2le commented Aug 13, 2018 •

edited

Loading

Uh oh!

mbed-ci commented Sep 1, 2018

Uh oh!

0xc0170 commented Sep 1, 2018

Uh oh!

mbed-ci commented Sep 1, 2018

Uh oh!

yossi2le commented Sep 1, 2018

Uh oh!

cmonr commented Sep 1, 2018

Uh oh!

jeromecoutant commented Sep 4, 2018

Uh oh!

yossi2le commented Sep 4, 2018 •

edited

Loading

Uh oh!

jeromecoutant commented Sep 4, 2018

Uh oh!

yossi2le commented Sep 4, 2018

Uh oh!

jeromecoutant commented Sep 4, 2018

Uh oh!

yossi2le commented Sep 4, 2018

Uh oh!

Uh oh!

Add default block device support (SD, SPIF and FLASHIAP) #7774

Add default block device support (SD, SPIF and FLASHIAP) #7774

Uh oh!

Conversation

yossi2le commented Aug 13, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Directory structure

configuration

Dependencies

Pull request type

Uh oh!

mbed-ci commented Sep 1, 2018

Test : FAILURE

Uh oh!

0xc0170 commented Sep 1, 2018

Uh oh!

mbed-ci commented Sep 1, 2018

Test : SUCCESS

Uh oh!

yossi2le commented Sep 1, 2018

Uh oh!

cmonr commented Sep 1, 2018

Uh oh!

jeromecoutant commented Sep 4, 2018

Uh oh!

yossi2le commented Sep 4, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jeromecoutant commented Sep 4, 2018

Uh oh!

yossi2le commented Sep 4, 2018

Uh oh!

jeromecoutant commented Sep 4, 2018

Uh oh!

yossi2le commented Sep 4, 2018

Uh oh!

Uh oh!

yossi2le commented Aug 13, 2018 •

edited

Loading

yossi2le commented Sep 4, 2018 •

edited

Loading