Implement SecureStore class

CONTRIBUTING.md

@@ -2,4 +2,4 @@
 
 Mbed OS is an open-source, device software platform for the Internet of Things. Contributions are an important part of the platform, and our goal is to make it as simple as possible to become a contributor.
 
-To encourage productive collaboration, as well as robust, consistent and maintainable code, we have a set of guidelines for contributing to Mbed OS. Please see: [contributing guidelines](https://os.mbed.com/docs/latest/reference/contributing.html).
+To encourage productive collaboration, as well as robust, consistent and maintainable code, we have a set of guidelines for [contributing to Mbed OS](https://os.mbed.com/docs/latest/reference/contributing.html).

README.md

@@ -19,13 +19,20 @@
 Arm Mbed OS is an open source embedded operating system designed specifically for the "things" in the Internet of Things. It includes all the features you need to develop a connected product based on an Arm Cortex-M microcontroller, including security, connectivity, an RTOS and drivers for sensors and I/O devices.
 
 Mbed OS provides a platform that includes:
-* Security foundations.
-* Cloud management services.
-* Drivers for sensors, I/O devices and connectivity. 
+
+- Security foundations.
+- Cloud management services.
+- Drivers for sensors, I/O devices and connectivity. 
 
 ## Release notes
 The [release notes](https://os.mbed.com/releases) detail the current release. You can also find information about previous versions.
 
+## License and contributions 
+
+The software is provided under [Apache-2.0 license](LICENSE). Contributions to this project are accepted under the same license. Please see [contributing.md](CONTRIBUTING.md) for more info. 
+
+This project contains code from other projects. The original license text is included in those source files. They must comply with our [license guide](https://os.mbed.com/docs/latest/reference/license.html)
+
 ## Getting started for developers
 
 We have a [developer website](https://os.mbed.com) for asking questions, engaging with others, finding information on boards and components, using an online IDE and compiler, reading the documentation and learning about what's new and what's coming next in Mbed OS.
@@ -36,6 +43,7 @@ We also have a [contributing and publishing guide](https://os.mbed.com/contribut
 
 ## Documentation
 
-For more information about Mbed OS, please see [our published documentation](https://os.mbed.com/docs/latest). It includes published Doxygen for our APIs, step-by-step tutorials, porting information and background reference materials about our architecture and tools.
+For more information about Mbed OS, please see [our published documentation](https://os.mbed.com/docs/latest). It includes Doxygen for our APIs, step-by-step tutorials, porting information and background reference materials about our architecture and tools.
+
+To contribute to this documentation, please see the [mbed-os-5-docs repository](https://github.com/ARMmbed/mbed-os-5-docs).
 
-To contribute to this documentation, please see the [mbed-os-5-docs repo](https://github.com/ARMmbed/mbed-os-5-docs).

TESTS/mbed_drivers/flashiap/main.cpp

@@ -55,9 +55,6 @@ void flashiap_program_test()
     TEST_ASSERT_TRUE(sector_size % page_size == 0);
     uint32_t prog_size = std::max(page_size, (uint32_t)8);
     uint8_t *data = new uint8_t[prog_size + 2];
-    for (uint32_t i = 0; i < prog_size + 2; i++) {
-        data[i] = i;
-    }
 
     // the one before the last sector in the system
     uint32_t address = (flash_device.get_flash_start() + flash_device.get_flash_size()) - (sector_size);
@@ -68,14 +65,27 @@ void flashiap_program_test()
     ret = flash_device.erase(address, sector_size);
     TEST_ASSERT_EQUAL_INT32(0, ret);
 
+    uint8_t erase_val = flash_device.get_erase_value();
+    memset(data, erase_val, prog_size);
+
+    uint8_t *data_flashed = new uint8_t[prog_size];
+    for (uint32_t i = 0; i < sector_size / prog_size; i++) {
+        uint32_t page_addr = address + i * prog_size;
+        ret = flash_device.read(data_flashed, page_addr, prog_size);
+        TEST_ASSERT_EQUAL_INT32(0, ret);
+        TEST_ASSERT_EQUAL_UINT8_ARRAY(data, data_flashed, prog_size);
+    }
+
+    for (uint32_t i = 0; i < prog_size + 2; i++) {
+        data[i] = i;
+    }
 
     for (uint32_t i = 0; i < sector_size / prog_size; i++) {
         uint32_t prog_addr = address + i * prog_size;
         ret = flash_device.program(data, prog_addr, prog_size);
         TEST_ASSERT_EQUAL_INT32(0, ret);
     }
 
-    uint8_t *data_flashed = new uint8_t[prog_size];
     for (uint32_t i = 0; i < sector_size / prog_size; i++) {
         uint32_t page_addr = address + i * prog_size;
         ret = flash_device.read(data_flashed, page_addr, prog_size);

TESTS/network/emac/main.cpp

@@ -53,7 +53,7 @@ using namespace utest::v1;
 utest::v1::status_t test_setup(const size_t number_of_cases)
 {
 #if !MBED_CONF_APP_ECHO_SERVER
-    GREENTEA_SETUP(1200, "default_auto");
+    GREENTEA_SETUP(1400, "default_auto");
 #endif
     return verbose_test_setup_handler(number_of_cases);
 }

components/storage/blockdevice/COMPONENT_DATAFLASH/DataFlashBlockDevice.cpp

@@ -164,6 +164,7 @@ DataFlashBlockDevice::DataFlashBlockDevice(PinName mosi,
 
 int DataFlashBlockDevice::init()
 {
+    _mutex.lock();
     DEBUG_PRINTF("init\r\n");
 
     if (!_is_initialized) {
@@ -173,6 +174,7 @@ int DataFlashBlockDevice::init()
     uint32_t val = core_util_atomic_incr_u32(&_init_ref_count, 1);
 
     if (val != 1) {
+        _mutex.unlock();
         return BD_ERROR_OK;
     }
 
@@ -281,33 +283,40 @@ int DataFlashBlockDevice::init()
         _is_initialized = true;
     }
 
+    _mutex.unlock();
     return result;
 }
 
 int DataFlashBlockDevice::deinit()
 {
+    _mutex.lock();
     DEBUG_PRINTF("deinit\r\n");
 
     if (!_is_initialized) {
         _init_ref_count = 0;
+        _mutex.unlock();
         return BD_ERROR_OK;
     }
 
     uint32_t val = core_util_atomic_decr_u32(&_init_ref_count, 1);
 
     if (val) {
+        _mutex.unlock();
         return BD_ERROR_OK;
     }
 
     _is_initialized = false;
+    _mutex.unlock();
     return BD_ERROR_OK;
 }
 
 int DataFlashBlockDevice::read(void *buffer, bd_addr_t addr, bd_size_t size)
 {
+    _mutex.lock();
     DEBUG_PRINTF("read: %p %" PRIX64 " %" PRIX64 "\r\n", buffer, addr, size);
 
     if (!_is_initialized) {
+        _mutex.unlock();
         return BD_ERROR_DEVICE_ERROR;
     }
 
@@ -345,14 +354,17 @@ int DataFlashBlockDevice::read(void *buffer, bd_addr_t addr, bd_size_t size)
         result = BD_ERROR_OK;
     }
 
+    _mutex.unlock();
     return result;
 }
 
 int DataFlashBlockDevice::program(const void *buffer, bd_addr_t addr, bd_size_t size)
 {
+    _mutex.lock();
     DEBUG_PRINTF("program: %p %" PRIX64 " %" PRIX64 "\r\n", buffer, addr, size);
 
     if (!_is_initialized) {
+        _mutex.unlock();
         return BD_ERROR_DEVICE_ERROR;
     }
 
@@ -411,14 +423,17 @@ int DataFlashBlockDevice::program(const void *buffer, bd_addr_t addr, bd_size_t
         _write_enable(false);
     }
 
+    _mutex.unlock();
     return result;
 }
 
 int DataFlashBlockDevice::erase(bd_addr_t addr, bd_size_t size)
 {
+    _mutex.lock();
     DEBUG_PRINTF("erase: %" PRIX64 " %" PRIX64 "\r\n", addr, size);
 
     if (!_is_initialized) {
+        _mutex.unlock();
         return BD_ERROR_DEVICE_ERROR;
     }
 
@@ -465,6 +480,7 @@ int DataFlashBlockDevice::erase(bd_addr_t addr, bd_size_t size)
         _write_enable(false);
     }
 
+    _mutex.unlock();
     return result;
 }
 
@@ -484,23 +500,29 @@ bd_size_t DataFlashBlockDevice::get_program_size() const
 
 bd_size_t DataFlashBlockDevice::get_erase_size() const
 {
+    _mutex.lock();
     DEBUG_PRINTF("erase size: %" PRIX16 "\r\n", _block_size);
-
-    return _block_size;
+    bd_size_t block_size = _block_size;
+    _mutex.unlock();
+    return block_size;
 }
 
 bd_size_t DataFlashBlockDevice::get_erase_size(bd_addr_t addr) const
 {
+    _mutex.lock();
     DEBUG_PRINTF("erase size: %" PRIX16 "\r\n", _block_size);
-
-    return _block_size;
+    bd_size_t block_size = _block_size;
+    _mutex.unlock();
+    return block_size;
 }
 
 bd_size_t DataFlashBlockDevice::size() const
 {
+    _mutex.lock();
     DEBUG_PRINTF("device size: %" PRIX32 "\r\n", _device_size);
-
-    return _device_size;
+    bd_size_t device_size = _device_size;
+    _mutex.unlock();
+    return device_size;
 }
 
 /**
@@ -512,6 +534,7 @@ bd_size_t DataFlashBlockDevice::size() const
  */
 uint16_t DataFlashBlockDevice::_get_register(uint8_t opcode)
 {
+    _mutex.lock();
     DEBUG_PRINTF("_get_register: %" PRIX8 "\r\n", opcode);
 
     /* activate device */
@@ -527,6 +550,7 @@ uint16_t DataFlashBlockDevice::_get_register(uint8_t opcode)
     /* deactivate device */
     _cs = 1;
 
+    _mutex.unlock();
     return status;
 }
 

components/storage/blockdevice/COMPONENT_DATAFLASH/DataFlashBlockDevice.h

@@ -173,6 +173,9 @@ class DataFlashBlockDevice : public BlockDevice {
     int _sync(void);
     int _write_page(const uint8_t *buffer, uint32_t addr, uint32_t offset, uint32_t size);
     uint32_t _translate_address(bd_addr_t addr);
+
+    // Mutex for thread safety
+    mutable PlatformMutex _mutex;
 };
 
 

components/storage/blockdevice/COMPONENT_FLASHIAP/FlashIAPBlockDevice.cpp

@@ -227,6 +227,20 @@ bd_size_t FlashIAPBlockDevice::get_erase_size(bd_addr_t addr) const
     return erase_size;
 }
 
+int FlashIAPBlockDevice::get_erase_value() const
+{
+    if (!_is_initialized) {
+        return -1;
+    }
+
+    uint8_t erase_val = _flash.get_erase_value();
+
+    DEBUG_PRINTF("get_erase_value: %" PRIX8 "\r\n", erase_val);
+
+    return erase_val;
+}
+
+
 bd_size_t FlashIAPBlockDevice::size() const
 {
     DEBUG_PRINTF("size: %" PRIX64 "\r\n", _size);

components/storage/blockdevice/COMPONENT_FLASHIAP/FlashIAPBlockDevice.h

@@ -109,6 +109,12 @@ class FlashIAPBlockDevice : public BlockDevice {
      */
     virtual bd_size_t get_erase_size(bd_addr_t addr) const;
 
+    /** Get the value of storage when erased
+     *
+     *  @return         The value of storage when erased
+     */
+    virtual int get_erase_value() const;
+
     /** Get the total size of the underlying device
      *
      *  @return         Size of the underlying device in bytes

components/storage/blockdevice/COMPONENT_QSPIF/QSPIFBlockDevice.cpp

@@ -514,6 +514,11 @@ bd_size_t QSPIFBlockDevice::size() const
     return _device_size_bytes;
 }
 
+int QSPIFBlockDevice::get_erase_value() const
+{
+    return 0xFF;
+}
+
 /********************************/
 /*   Different Device Csel Mgmt */
 /********************************/

components/storage/blockdevice/COMPONENT_QSPIF/QSPIFBlockDevice.h

@@ -191,6 +191,17 @@ class QSPIFBlockDevice : public BlockDevice {
      */
     virtual bd_size_t get_erase_size(bd_addr_t addr);
 
+    /** Get the value of storage byte after it was erased
+     *
+     *  If get_erase_value returns a non-negative byte value, the underlying
+     *  storage is set to that value when erased, and storage containing
+     *  that value can be programmed without another erase.
+     *
+     *  @return         The value of storage when erased, or -1 if you can't
+     *                  rely on the value of erased storage
+     */
+    virtual int get_erase_value() const;
+
     /** Get the total size of the underlying device
      *
      *  @return         Size of the underlying device in bytes

components/storage/blockdevice/COMPONENT_SD/SDBlockDevice.cpp

@@ -897,7 +897,6 @@ int SDBlockDevice::_read(uint8_t *buffer, uint32_t length)
     // read until start byte (0xFE)
     if (false == _wait_token(SPI_START_BLOCK)) {
         debug_if(SD_DBG, "Read timeout\n");
-        _deselect();
         return SD_BLOCK_DEVICE_ERROR_NO_RESPONSE;
     }
 

docs/.gitignore

@@ -0,0 +1,2 @@
+*.md.html
+

docs/design-documents/features/storage/FileSystemStore/FileSystemStore_class_hierarchy.xml

@@ -0,0 +1 @@
+<mxfile userAgent="Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:63.0) Gecko/20100101 Firefox/63.0" version="9.1.6" editor="www.draw.io" type="device"><diagram id="03139726-0aa5-5ee2-a4e8-af4a44b6180b" name="Page-1">7VfbbtswDP0aP3bwJU7zmjRNCwwDBgS7PSo2bQuVLU9WEmdfP8qm41u8ZsDWbkDzEFuHFEUe8ZJY3l1aPiiWJx9kCMJy7bC0vLXluo7vz/BhkFON3C4IiBUPSakFtvwHEGgTuuchFD1FLaXQPO+DgcwyCHQPY0rJY18tkqJ/as5iGAHbgIkx+oWHOqnRhW+3+CPwOGlOdmyS7FjwFCu5z+g8y/Wi6lOLU9bYIv0iYaE8diDv3vLulJS6fkvLOxCG24a2et9mQnr2W0Gmr9pAfhyY2EPj8lzg3lVu3NMnomT+fW98WqVMxTyzvCVK7bzEbwSryAx+o2Vey2YdmYZS3zDBY9oXoHOgWpv4FtOzOnnXABsuYHsqNKRbLRU0cgxnN9yDWD7EEmVCaJKrOc2ZPjjkh4tBJ3TXxnnXBDZlAL2obDSo2zPnHkBpjlm2rLlYV2ytiJm1gMjskqgViSopIo6X5a0imWmqEcel9YalXJjqegRxAGPV+KlTYZTOZ3cTgXLD+ABlB6LEeACZglYnVCGp61FyUBG7M1of25JwGizplMOCMEZVGJ9Nt5mIL5SME4npjBLzUwEjRiELl6becSVzQBZXiHS5ClmRQEikXMMPhL3WMGanG/2cIlUgmOaHfve4FD6Z+yg5Hntm2rsdMD1ksJB7FQDt6pbzwJBvP2NIY5mCHhmqbuMc43UX5P4fneNXTWOn3trIX28jo5x80TYy+5ez9P3nt7n2+nNt8ZL56F/Ix+mZthMyeBpOMZRvKgLX9njedahChtTpq1F75zfLb8/RWA+IfvG8ykic6hq/OxJn84Eh70+NRFy2P9Rr9fbfkHf/Ew==</diagram></mxfile>