Merge pull request #86 from mprse/storage_examples

Add storage examples

Author: Qinghao Shi

APIs_Storage/BufferedBlockDevice/main.cpp

@@ -1,19 +1,7 @@
-/* mbed Microcontroller Library
- * Copyright (c) 2019 ARM Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+/*
+ * Copyright (c) 2006-2020 Arm Limited and affiliates.
+ * SPDX-License-Identifier: Apache-2.0
  */
-
 #include "BufferedBlockDevice.h"
 #include "HeapBlockDevice.h"
 #include <cstdio>

APIs_Storage/DataFlashBlockDevice/README.md

@@ -0,0 +1,5 @@
+## DataFlashBlockDevice Example
+
+This example shows how to use an DataFlashBlockDevice class to controll AT45DB (SPI Serial Flash Memory) on the K64F.
+
+**Note:** Please adapt `SPI` pins for target different than `K64F`.

APIs_Storage/DataFlashBlockDevice/main.cpp

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2006-2020 Arm Limited and affiliates.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+// Here's an example using the AT45DB on the K64F
+#include "mbed.h"
+#include "DataFlashBlockDevice.h"
+
+// Create DataFlash on SPI bus with PTE5 as chip select
+DataFlashBlockDevice dataflash(PTE1, PTE3, PTE2, PTE4);
+
+// Create DataFlash on SPI bus with PTE6 as write-protect
+// DataFlashBlockDevice dataflash(PTE1, PTE3, PTE2, PTE4, PTE6);
+
+int main()
+{
+    printf("dataflash test\n");
+
+    // Initialize the SPI flash device and print the memory layout
+    dataflash.init();
+    printf("dataflash size: %llu\n", dataflash.size());
+    printf("dataflash read size: %llu\n", dataflash.get_read_size());
+    printf("dataflash program size: %llu\n", dataflash.get_program_size());
+    printf("dataflash erase size: %llu\n", dataflash.get_erase_size());
+
+    // Write "Hello World!" to the first block
+    char *buffer = (char *)malloc(dataflash.get_erase_size());
+    sprintf(buffer, "Hello World!\n");
+    dataflash.erase(0, dataflash.get_erase_size());
+    dataflash.program(buffer, 0, dataflash.get_erase_size());
+
+    // Read back what was stored
+    dataflash.read(buffer, 0, dataflash.get_erase_size());
+    printf("%s", buffer);
+
+    // Deinitialize the device
+    dataflash.deinit();
+}

APIs_Storage/DataFlashBlockDevice/mbed_app.json

@@ -0,0 +1,7 @@
+{
+    "target_overrides": {
+        "K64F": {
+            "target.components_add": ["DATAFLASH"]
+        }
+    }
+}

APIs_Storage/FlashSimBlockDevice/main.cpp

@@ -1,19 +1,7 @@
-/* mbed Microcontroller Library
- * Copyright (c) 2019 ARM Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+/*
+ * Copyright (c) 2006-2020 Arm Limited and affiliates.
+ * SPDX-License-Identifier: Apache-2.0
  */
-
 #include "mbed.h"
 #include "HeapBlockDevice.h"
 #include "FlashSimBlockDevice.h"

test.json

@@ -5,8 +5,8 @@
 			"spif-driver.SPI_MOSI"  : "D11", 
 			"spif-driver.SPI_MISO"  : "D12",
 			"spif-driver.SPI_CLK"   : "D13",
-			"spif-driver.SPI_CS"    : "D10"
-
+			"spif-driver.SPI_CS"    : "D10",
+			"target.components_add": ["DATAFLASH"]
 		}
 	}
 }