Merge pull request #4177 from microDev1/nvm-rp

RP2040: Support for NVM

ports/raspberrypi/common-hal/nvm/ByteArray.c

@@ -0,0 +1,102 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2020 microDev
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "common-hal/nvm/ByteArray.h"
+
+#include <string.h>
+
+#include "py/runtime.h"
+#include "src/rp2_common/hardware_flash/include/hardware/flash.h"
+
+extern uint32_t __flash_binary_start;
+static const uint32_t flash_binary_start = (uint32_t) &__flash_binary_start;
+
+#define RMV_OFFSET(addr) addr - flash_binary_start
+
+uint32_t common_hal_nvm_bytearray_get_length(nvm_bytearray_obj_t* self) {
+    return self->len;
+}
+
+static void write_page(uint32_t page_addr, uint32_t offset, uint32_t len, uint8_t* bytes) {
+    // Write a whole page to flash, buffering it first and then erasing and rewriting it
+    // since we can only write a whole page at a time.
+    if (offset == 0 && len == FLASH_PAGE_SIZE) {
+        flash_range_program(RMV_OFFSET(page_addr), bytes, FLASH_PAGE_SIZE);
+    } else {
+        uint8_t buffer[FLASH_PAGE_SIZE];
+        memcpy(buffer, (uint8_t*) page_addr, FLASH_PAGE_SIZE);
+        memcpy(buffer + offset, bytes, len);
+        flash_range_program(RMV_OFFSET(page_addr), buffer, FLASH_PAGE_SIZE);
+    }
+}
+
+static void erase_and_write_sector(uint32_t address, uint32_t len, uint8_t* bytes) {
+    // Write a whole sector to flash, buffering it first and then erasing and rewriting it
+    // since we can only erase a whole sector at a time.
+    uint8_t buffer[FLASH_SECTOR_SIZE];
+    memcpy(buffer, (uint8_t*) CIRCUITPY_INTERNAL_NVM_START_ADDR, FLASH_SECTOR_SIZE);
+    memcpy(buffer + address, bytes, len);
+    flash_range_erase(RMV_OFFSET(CIRCUITPY_INTERNAL_NVM_START_ADDR), FLASH_SECTOR_SIZE);
+    flash_range_program(RMV_OFFSET(CIRCUITPY_INTERNAL_NVM_START_ADDR), buffer, FLASH_SECTOR_SIZE);
+}
+
+void common_hal_nvm_bytearray_get_bytes(nvm_bytearray_obj_t* self,
+        uint32_t start_index, uint32_t len, uint8_t* values) {
+    memcpy(values, self->start_address + start_index, len);
+}
+
+bool common_hal_nvm_bytearray_set_bytes(nvm_bytearray_obj_t* self,
+        uint32_t start_index, uint8_t* values, uint32_t len) {
+    uint8_t values_in[len];
+    common_hal_nvm_bytearray_get_bytes(self, start_index, len, values_in);
+
+    bool all_ones = true;
+    for (uint32_t i = 0; i < len; i++) {
+        if (values_in[i] != UINT8_MAX) {
+            all_ones = false;
+            break;
+        }
+    }
+
+    if (all_ones) {
+        uint32_t address = (uint32_t) self->start_address + start_index;
+        uint32_t offset = address % FLASH_PAGE_SIZE;
+        uint32_t page_addr = address - offset;
+
+        while (len) {
+            uint32_t write_len = MIN(len, FLASH_PAGE_SIZE - offset);
+            write_page(page_addr, offset, write_len, values);
+            len -= write_len;
+            values += write_len;
+            page_addr += FLASH_PAGE_SIZE;
+            offset = 0;
+        }
+    } else {
+        erase_and_write_sector(start_index, len, values);
+    }
+
+    return true;
+}

ports/raspberrypi/common-hal/nvm/ByteArray.h

@@ -0,0 +1,38 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2020 microDev
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef MICROPY_INCLUDED_RASPBERRYPI_COMMON_HAL_NVM_BYTEARRAY_H
+#define MICROPY_INCLUDED_RASPBERRYPI_COMMON_HAL_NVM_BYTEARRAY_H
+
+#include "py/obj.h"
+
+typedef struct {
+    mp_obj_base_t base;
+    uint8_t * start_address;
+    uint32_t len;
+} nvm_bytearray_obj_t;
+
+#endif // MICROPY_INCLUDED_RASPBERRYPI_COMMON_HAL_NVM_BYTEARRAY_H

ports/raspberrypi/common-hal/nvm/__init__.c

@@ -0,0 +1 @@
+// No nvm module functions.

ports/raspberrypi/link.ld

@@ -23,7 +23,7 @@
 
 MEMORY
 {
-    FLASH_FIRMWARE (rx) : ORIGIN = 0x10000000, LENGTH = 1024k
+    FLASH_FIRMWARE (rx) : ORIGIN = 0x10000000, LENGTH = 1020k
     RAM (rwx) : ORIGIN =  0x20000000, LENGTH = 256k
     SCRATCH_X (rwx) : ORIGIN = 0x20040000, LENGTH = 4k
     SCRATCH_Y (rwx) : ORIGIN = 0x20041000, LENGTH = 4k

ports/raspberrypi/mpconfigport.h

@@ -29,15 +29,16 @@
 
 #include "src/rp2040/hardware_regs/include/hardware/platform_defs.h"
 
-#define MICROPY_PY_SYS_PLATFORM                     "RP2040"
+#define MICROPY_PY_SYS_PLATFORM             "RP2040"
 
-#define CIRCUITPY_INTERNAL_NVM_SIZE 0
+#define CIRCUITPY_INTERNAL_NVM_SIZE         (4*1024)
+#define CIRCUITPY_INTERNAL_NVM_START_ADDR   (0x100FF000)
 
-#define CIRCUITPY_DEFAULT_STACK_SIZE                (24*1024)
+#define CIRCUITPY_DEFAULT_STACK_SIZE        (24*1024)
 
 #define MICROPY_USE_INTERNAL_PRINTF         (1)
 
-#define CIRCUITPY_PROCESSOR_COUNT (2)
+#define CIRCUITPY_PROCESSOR_COUNT           (2)
 
 // This also includes mpconfigboard.h.
 #include "py/circuitpy_mpconfig.h"

ports/raspberrypi/mpconfigport.mk

@@ -31,7 +31,7 @@ CIRCUITPY_PWMIO = 1
 CIRCUITPY_COUNTIO = 0  # Use PWM interally
 CIRCUITPY_FREQUENCYIO = 0 # Use PWM interally
 CIRCUITPY_I2CPERIPHERAL = 0
-CIRCUITPY_NVM = 0
+CIRCUITPY_NVM = 1
 CIRCUITPY_PULSEIO = 0 # Use PIO interally
 CIRCUITPY_ROTARYIO = 0 # Use PIO interally
 CIRCUITPY_WATCHDOG = 1