Add Spresense board folder

10 files changed, 198 insertions, 90 deletions

diff --git a/ports/cxd56/Makefile b/ports/cxd56/Makefile
index d8f809635..69c8e1bef 100644
--- a/ports/cxd56/Makefile
+++ b/ports/cxd56/Makefile
@@ -22,8 +22,23 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+# Select the board to build for.
+ifeq ($(BOARD),)
+  $(error You must provide a BOARD parameter)
+else
+  ifeq ($(wildcard boards/$(BOARD)/.),)
+    $(error Invalid BOARD specified)
+  endif
+endif
+
+# If the build directory is not given, make it reflect the board name.
+BUILD ?= build-$(BOARD)
+
 include ../../py/mkenv.mk
 
+# Board-specific
+include boards/$(BOARD)/mpconfigboard.mk
+
 # Port-specific
 include mpconfigport.mk
 
@@ -54,6 +69,7 @@ INC += \
 	-I../lib/timeutils \
 	-I../../lib/tinyusb/src \
 	-I../../supervisor/shared/usb \
+	-Iboards/$(BOARD) \
 	-I$(BUILD) \
 	-I$(SPRESENSE_SDK)/nuttx/include \
 	-I$(SPRESENSE_SDK)/nuttx/arch \
@@ -123,6 +139,8 @@ SRC_C = \
 	background.c \
 	fatfs_port.c \
 	mphalport.c \
+	boards/$(BOARD)/board.c \
+	boards/$(BOARD)/pins.c \
 	lib/utils/stdout_helpers.c \
 	lib/utils/pyexec.c \
 	lib/libc/string0.c \
diff --git a/ports/cxd56/README.md b/ports/cxd56/README.md
index d66ea40b4..99a9032fe 100644
--- a/ports/cxd56/README.md
+++ b/ports/cxd56/README.md
@@ -39,7 +39,7 @@ Change directory to cxd56:
 
 To build circuitpython image run:
 
-    $ make
+    $ make BOARD=spresense
 
 USB connection
 --------------
@@ -67,14 +67,14 @@ Extract spresense binaries in your PC to ports/spresense/spresense-exported-sdk/
 
 To flash the bootloader run the command:
 
-    $ make flash-bootloader
+    $ make BOARD=spresense flash-bootloader
 
 Flash the circuitpython.spk image
 ---------------------------------
 
 To flash the firmware run the command:
 
-    $ make flash
+    $ make BOARD=spresense flash
 
 Accessing the board
 -------------------
diff --git a/ports/cxd56/boards/board.h b/ports/cxd56/boards/board.h
new file mode 100644
index 000000000..597ae72e6
--- /dev/null
+++ b/ports/cxd56/boards/board.h
@@ -0,0 +1,45 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright 2019 Sony Semiconductor Solutions Corporation
+ *
+ * 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.
+ */
+
+// This file defines board specific functions.
+
+#ifndef MICROPY_INCLUDED_CXD56_BOARDS_BOARD_H
+#define MICROPY_INCLUDED_CXD56_BOARDS_BOARD_H
+
+#include <stdbool.h>
+
+// Initializes board related state once on start up.
+void board_init(void);
+
+// Returns true if the user initiates safe mode in a board specific way.
+// Also add BOARD_USER_SAFE_MODE in mpconfigboard.h to explain the board specific
+// way.
+bool board_requests_safe_mode(void);
+
+// Reset the state of off MCU components such as neopixels.
+void reset_board(void);
+
+#endif  // MICROPY_INCLUDED_CXD56_BOARDS_BOARD_H
diff --git a/ports/cxd56/boards/spresense/board.c b/ports/cxd56/boards/spresense/board.c
new file mode 100644
index 000000000..2af7cfdcf
--- /dev/null
+++ b/ports/cxd56/boards/spresense/board.c
@@ -0,0 +1,38 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright 2019 Sony Semiconductor Solutions Corporation
+ *
+ * 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 "boards/board.h"
+
+void board_init(void)
+{
+}
+
+bool board_requests_safe_mode(void) {
+    return false;
+}
+
+void reset_board(void) {
+}
diff --git a/ports/cxd56/mpconfigboard.h b/ports/cxd56/boards/spresense/mpconfigboard.h
index e0fef60f0..e0fef60f0 100644
--- a/ports/cxd56/mpconfigboard.h
+++ b/ports/cxd56/boards/spresense/mpconfigboard.h
diff --git a/ports/cxd56/boards/spresense/mpconfigboard.mk b/ports/cxd56/boards/spresense/mpconfigboard.mk
new file mode 100644
index 000000000..a2d4e5d88
--- /dev/null
+++ b/ports/cxd56/boards/spresense/mpconfigboard.mk
@@ -0,0 +1,4 @@
+USB_VID = 0x054c
+USB_PID = 0x0bc2
+USB_PRODUCT = "Spresense"
+USB_MANUFACTURER = "Sony"
diff --git a/ports/cxd56/boards/spresense/pins.c b/ports/cxd56/boards/spresense/pins.c
new file mode 100644
index 000000000..d123969fe
--- /dev/null
+++ b/ports/cxd56/boards/spresense/pins.c
@@ -0,0 +1,80 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright 2019 Sony Semiconductor Solutions Corporation
+ *
+ * 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 "shared-bindings/board/__init__.h"
+
+STATIC const mp_rom_map_elem_t board_module_globals_table[] = {
+    { MP_ROM_QSTR(MP_QSTR_D0), MP_ROM_PTR(&pin_D0) },
+    { MP_ROM_QSTR(MP_QSTR_D1), MP_ROM_PTR(&pin_D1) },
+    { MP_ROM_QSTR(MP_QSTR_D2), MP_ROM_PTR(&pin_D2) },
+    { MP_ROM_QSTR(MP_QSTR_D3), MP_ROM_PTR(&pin_D3) },
+    { MP_ROM_QSTR(MP_QSTR_D4), MP_ROM_PTR(&pin_D4) },
+    { MP_ROM_QSTR(MP_QSTR_D5), MP_ROM_PTR(&pin_D5) },
+    { MP_ROM_QSTR(MP_QSTR_D6), MP_ROM_PTR(&pin_D6) },
+    { MP_ROM_QSTR(MP_QSTR_D7), MP_ROM_PTR(&pin_D7) },
+    { MP_ROM_QSTR(MP_QSTR_D8), MP_ROM_PTR(&pin_D8) },
+    { MP_ROM_QSTR(MP_QSTR_D9), MP_ROM_PTR(&pin_D9) },
+    { MP_ROM_QSTR(MP_QSTR_D10), MP_ROM_PTR(&pin_D10) },
+    { MP_ROM_QSTR(MP_QSTR_D11), MP_ROM_PTR(&pin_D11) },
+    { MP_ROM_QSTR(MP_QSTR_D12), MP_ROM_PTR(&pin_D12) },
+    { MP_ROM_QSTR(MP_QSTR_D13), MP_ROM_PTR(&pin_D13) },
+    { MP_ROM_QSTR(MP_QSTR_D14), MP_ROM_PTR(&pin_D14) },
+    { MP_ROM_QSTR(MP_QSTR_D15), MP_ROM_PTR(&pin_D15) },
+    { MP_ROM_QSTR(MP_QSTR_D16), MP_ROM_PTR(&pin_D16) },
+    { MP_ROM_QSTR(MP_QSTR_D17), MP_ROM_PTR(&pin_D17) },
+    { MP_ROM_QSTR(MP_QSTR_D18), MP_ROM_PTR(&pin_D18) },
+    { MP_ROM_QSTR(MP_QSTR_D19), MP_ROM_PTR(&pin_D19) },
+    { MP_ROM_QSTR(MP_QSTR_D20), MP_ROM_PTR(&pin_D20) },
+    { MP_ROM_QSTR(MP_QSTR_D21), MP_ROM_PTR(&pin_D21) },
+    { MP_ROM_QSTR(MP_QSTR_D22), MP_ROM_PTR(&pin_D22) },
+    { MP_ROM_QSTR(MP_QSTR_D23), MP_ROM_PTR(&pin_D23) },
+    { MP_ROM_QSTR(MP_QSTR_D24), MP_ROM_PTR(&pin_D24) },
+    { MP_ROM_QSTR(MP_QSTR_D25), MP_ROM_PTR(&pin_D25) },
+    { MP_ROM_QSTR(MP_QSTR_D26), MP_ROM_PTR(&pin_D26) },
+    { MP_ROM_QSTR(MP_QSTR_D27), MP_ROM_PTR(&pin_D27) },
+    { MP_ROM_QSTR(MP_QSTR_D28), MP_ROM_PTR(&pin_D28) },
+    { MP_ROM_QSTR(MP_QSTR_LED0), MP_ROM_PTR(&pin_LED0) },
+    { MP_ROM_QSTR(MP_QSTR_LED1), MP_ROM_PTR(&pin_LED1) },
+    { MP_ROM_QSTR(MP_QSTR_LED2), MP_ROM_PTR(&pin_LED2) },
+    { MP_ROM_QSTR(MP_QSTR_LED3), MP_ROM_PTR(&pin_LED3) },
+    { MP_ROM_QSTR(MP_QSTR_A0), MP_ROM_PTR(&pin_A0) },
+    { MP_ROM_QSTR(MP_QSTR_A1), MP_ROM_PTR(&pin_A1) },
+    { MP_ROM_QSTR(MP_QSTR_A2), MP_ROM_PTR(&pin_A2) },
+    { MP_ROM_QSTR(MP_QSTR_A3), MP_ROM_PTR(&pin_A3) },
+    { MP_ROM_QSTR(MP_QSTR_A4), MP_ROM_PTR(&pin_A4) },
+    { MP_ROM_QSTR(MP_QSTR_A5), MP_ROM_PTR(&pin_A5) },
+    { MP_ROM_QSTR(MP_QSTR_SDA), MP_ROM_PTR(&pin_D14) },
+    { MP_ROM_QSTR(MP_QSTR_SCL), MP_ROM_PTR(&pin_D15) },
+    { MP_ROM_QSTR(MP_QSTR_SCK), MP_ROM_PTR(&pin_D13) },
+    { MP_ROM_QSTR(MP_QSTR_MISO), MP_ROM_PTR(&pin_D12) },
+    { MP_ROM_QSTR(MP_QSTR_MOSI), MP_ROM_PTR(&pin_D11) },
+    { MP_ROM_QSTR(MP_QSTR_RX), MP_ROM_PTR(&pin_D0) },
+    { MP_ROM_QSTR(MP_QSTR_TX), MP_ROM_PTR(&pin_D1) },
+    { MP_ROM_QSTR(MP_QSTR_I2C), MP_ROM_PTR(&board_i2c_obj) },
+    { MP_ROM_QSTR(MP_QSTR_SPI), MP_ROM_PTR(&board_spi_obj) },
+    { MP_ROM_QSTR(MP_QSTR_UART), MP_ROM_PTR(&board_uart_obj) },
+};
+MP_DEFINE_CONST_DICT(board_module_globals, board_module_globals_table);
diff --git a/ports/cxd56/common-hal/board/__init__.c b/ports/cxd56/common-hal/board/__init__.c
index d123969fe..7a409d503 100644
--- a/ports/cxd56/common-hal/board/__init__.c
+++ b/ports/cxd56/common-hal/board/__init__.c
@@ -1,80 +1 @@
-/*
- * This file is part of the MicroPython project, http://micropython.org/
- *
- * The MIT License (MIT)
- *
- * Copyright 2019 Sony Semiconductor Solutions Corporation
- *
- * 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 "shared-bindings/board/__init__.h"
-
-STATIC const mp_rom_map_elem_t board_module_globals_table[] = {
-    { MP_ROM_QSTR(MP_QSTR_D0), MP_ROM_PTR(&pin_D0) },
-    { MP_ROM_QSTR(MP_QSTR_D1), MP_ROM_PTR(&pin_D1) },
-    { MP_ROM_QSTR(MP_QSTR_D2), MP_ROM_PTR(&pin_D2) },
-    { MP_ROM_QSTR(MP_QSTR_D3), MP_ROM_PTR(&pin_D3) },
-    { MP_ROM_QSTR(MP_QSTR_D4), MP_ROM_PTR(&pin_D4) },
-    { MP_ROM_QSTR(MP_QSTR_D5), MP_ROM_PTR(&pin_D5) },
-    { MP_ROM_QSTR(MP_QSTR_D6), MP_ROM_PTR(&pin_D6) },
-    { MP_ROM_QSTR(MP_QSTR_D7), MP_ROM_PTR(&pin_D7) },
-    { MP_ROM_QSTR(MP_QSTR_D8), MP_ROM_PTR(&pin_D8) },
-    { MP_ROM_QSTR(MP_QSTR_D9), MP_ROM_PTR(&pin_D9) },
-    { MP_ROM_QSTR(MP_QSTR_D10), MP_ROM_PTR(&pin_D10) },
-    { MP_ROM_QSTR(MP_QSTR_D11), MP_ROM_PTR(&pin_D11) },
-    { MP_ROM_QSTR(MP_QSTR_D12), MP_ROM_PTR(&pin_D12) },
-    { MP_ROM_QSTR(MP_QSTR_D13), MP_ROM_PTR(&pin_D13) },
-    { MP_ROM_QSTR(MP_QSTR_D14), MP_ROM_PTR(&pin_D14) },
-    { MP_ROM_QSTR(MP_QSTR_D15), MP_ROM_PTR(&pin_D15) },
-    { MP_ROM_QSTR(MP_QSTR_D16), MP_ROM_PTR(&pin_D16) },
-    { MP_ROM_QSTR(MP_QSTR_D17), MP_ROM_PTR(&pin_D17) },
-    { MP_ROM_QSTR(MP_QSTR_D18), MP_ROM_PTR(&pin_D18) },
-    { MP_ROM_QSTR(MP_QSTR_D19), MP_ROM_PTR(&pin_D19) },
-    { MP_ROM_QSTR(MP_QSTR_D20), MP_ROM_PTR(&pin_D20) },
-    { MP_ROM_QSTR(MP_QSTR_D21), MP_ROM_PTR(&pin_D21) },
-    { MP_ROM_QSTR(MP_QSTR_D22), MP_ROM_PTR(&pin_D22) },
-    { MP_ROM_QSTR(MP_QSTR_D23), MP_ROM_PTR(&pin_D23) },
-    { MP_ROM_QSTR(MP_QSTR_D24), MP_ROM_PTR(&pin_D24) },
-    { MP_ROM_QSTR(MP_QSTR_D25), MP_ROM_PTR(&pin_D25) },
-    { MP_ROM_QSTR(MP_QSTR_D26), MP_ROM_PTR(&pin_D26) },
-    { MP_ROM_QSTR(MP_QSTR_D27), MP_ROM_PTR(&pin_D27) },
-    { MP_ROM_QSTR(MP_QSTR_D28), MP_ROM_PTR(&pin_D28) },
-    { MP_ROM_QSTR(MP_QSTR_LED0), MP_ROM_PTR(&pin_LED0) },
-    { MP_ROM_QSTR(MP_QSTR_LED1), MP_ROM_PTR(&pin_LED1) },
-    { MP_ROM_QSTR(MP_QSTR_LED2), MP_ROM_PTR(&pin_LED2) },
-    { MP_ROM_QSTR(MP_QSTR_LED3), MP_ROM_PTR(&pin_LED3) },
-    { MP_ROM_QSTR(MP_QSTR_A0), MP_ROM_PTR(&pin_A0) },
-    { MP_ROM_QSTR(MP_QSTR_A1), MP_ROM_PTR(&pin_A1) },
-    { MP_ROM_QSTR(MP_QSTR_A2), MP_ROM_PTR(&pin_A2) },
-    { MP_ROM_QSTR(MP_QSTR_A3), MP_ROM_PTR(&pin_A3) },
-    { MP_ROM_QSTR(MP_QSTR_A4), MP_ROM_PTR(&pin_A4) },
-    { MP_ROM_QSTR(MP_QSTR_A5), MP_ROM_PTR(&pin_A5) },
-    { MP_ROM_QSTR(MP_QSTR_SDA), MP_ROM_PTR(&pin_D14) },
-    { MP_ROM_QSTR(MP_QSTR_SCL), MP_ROM_PTR(&pin_D15) },
-    { MP_ROM_QSTR(MP_QSTR_SCK), MP_ROM_PTR(&pin_D13) },
-    { MP_ROM_QSTR(MP_QSTR_MISO), MP_ROM_PTR(&pin_D12) },
-    { MP_ROM_QSTR(MP_QSTR_MOSI), MP_ROM_PTR(&pin_D11) },
-    { MP_ROM_QSTR(MP_QSTR_RX), MP_ROM_PTR(&pin_D0) },
-    { MP_ROM_QSTR(MP_QSTR_TX), MP_ROM_PTR(&pin_D1) },
-    { MP_ROM_QSTR(MP_QSTR_I2C), MP_ROM_PTR(&board_i2c_obj) },
-    { MP_ROM_QSTR(MP_QSTR_SPI), MP_ROM_PTR(&board_spi_obj) },
-    { MP_ROM_QSTR(MP_QSTR_UART), MP_ROM_PTR(&board_uart_obj) },
-};
-MP_DEFINE_CONST_DICT(board_module_globals, board_module_globals_table);
+// No board module functions.
diff --git a/ports/cxd56/mpconfigport.mk b/ports/cxd56/mpconfigport.mk
index 53dba2840..a418ae8e9 100644
--- a/ports/cxd56/mpconfigport.mk
+++ b/ports/cxd56/mpconfigport.mk
@@ -1,7 +1,3 @@
-USB_VID = 0x054c
-USB_PID = 0x0bc2
-USB_PRODUCT = "Spresense"
-USB_MANUFACTURER = "Sony"
 USB_SERIAL_NUMBER_LENGTH = 10
 USB_DEVICES = "CDC,MSC"
 USB_MSC_MAX_PACKET_SIZE = 512
diff --git a/ports/cxd56/supervisor/port.c b/ports/cxd56/supervisor/port.c
index ab1ea5273..3fddfe52c 100644
--- a/ports/cxd56/supervisor/port.c
+++ b/ports/cxd56/supervisor/port.c
@@ -27,6 +27,8 @@
 #include <stdint.h>
 #include <sys/boardctl.h>
 
+#include "boards/board.h"
+
 #include "supervisor/port.h"
 
 #include "common-hal/microcontroller/Pin.h"
@@ -36,6 +38,13 @@
 
 safe_mode_t port_init(void) {
     boardctl(BOARDIOC_INIT, 0);
+
+    board_init();
+
+    if (board_requests_safe_mode()) {
+        return USER_SAFE_MODE;
+    }
+
     return NO_SAFE_MODE;
 }
 
@@ -55,9 +64,6 @@ void reset_port(void) {
     reset_all_pins();
 }
 
-void reset_board(void) {
-}
-
 void reset_to_bootloader(void) {
 }