Add an MbedOS target for the IF MCU on V2.2.

microbit-carlos · microbit-carlos · commit 28bf0942ce45 · 2022-03-03T13:00:36.000Z
diff --git a/README.md b/README.md
@@ -4,8 +4,7 @@
 
 - [Features](#features)
 - [Requirements](#requirements)
-- [Using Mbed](#using-mbed)
-- [Using Make](#using-make)
+- [Building This Project](#building-this-project)
 - [Visual Studio Code](#visual-studio-code)
 - [Using NFC](#using-nfc)
 - [License](#license)
@@ -23,21 +22,17 @@ This is a basic Mbed OS project for [micro:bit V2](https://microbit.org/new-micr
 - [Arm GCC](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads)
     - v7.3.1 is the oldest and v10.2.1 the last tested versions
 - Python 3
-- pip (version >= 10.0)
 - [Mbed CLI](https://github.com/ARMmbed/mbed-cli)
     - v1.10.2 is last tested version
+    - Can be installed using one of the methods from the official documentation:
+      https://os.mbed.com/docs/mbed-os/v6.15/build-tools/install-and-set-up.html
+    - The installers are outdated and not recommended
+    - If installed via pip a virtual environment is recommended
 
 
-## Using Mbed
+## Building This Project
 
-### Install dependencies
-
-Install mbed-cli using one of the methods from the official documentation:
-https://os.mbed.com/docs/mbed-os/v6.15/build-tools/install-and-set-up.html
-
-The manual installation (in a Python 3 virtual environment) is the prefer method.
-
-### Multiple targets
+### Available Targets
 
 As there are multiple revisions of the nRF52 board we are using multiple mbed
 targets.
@@ -57,6 +52,12 @@ right side of the edge connector.
 
 The branch `mbedos-softdevice` contains older targets.
 
+#### Interface MCU
+
+The micro:bit V2.2 contains an nRF52 microcontroller as the
+[Interface MCU](https://tech.microbit.org/software/daplink-interface/) and Mbed
+OS targets has been created 
+
 ### Initialise
 
 Note that for the `mbed target ...` line you should select the right target
@@ -71,10 +72,10 @@ mbed toolchain GCC_ARM
 mbed deploy
 ```
 
-If it fails to install some of the Python dependencies on the last command (
-`mbed deploy`) you can try again manually.
+If it fails to install some of the Python dependencies on the last command
+(`mbed deploy`) you can try to install them manually.
 
-Run in the Python environment that has `mbed-cli` installed:
+Run this command in the Python environment that has `mbed-cli` installed:
 
 ```
 pip install -r mbed-os/requirements.txt
@@ -104,12 +105,13 @@ delete the mbed cache by removing `~/.mbed/`.
 ### Mbed OS Version
 
 This repo is currently configured Mbed OS to version
-[6.13.0]((https://github.com/ARMmbed/mbed-os/releases/tag/mbed-os-6.14.0)).
+[6.13.0](https://github.com/ARMmbed/mbed-os/releases/tag/mbed-os-6.13.0).
 
 The branch `mbedos-softdevice` (commit
 `9e185e9388cdd634ac4cc38f92a0bbf73af9c5b3`) is configured to
 [v5.12.4](https://github.com/ARMmbed/mbed-os/releases/tag/mbed-os-5.12.4), as
-this is the last Mbed OS version to support the Nordic Soft Device (BLE stack).
+this is the last Mbed OS version to support the Nordic Soft Device BLE stack
+before it was switched to the Cordio BLE stack.
 
 ### Mbed OS RTOS
 
diff --git a/TARGET_NRF52_MICROBIT_v1_43/PinNames.h b/TARGET_NRF52_MICROBIT_v1_43/PinNames.h
@@ -156,12 +156,25 @@ typedef enum {
     P1_14 = p46,
     P1_15 = p47,
 
-    // Buttons A and B
+    // Not connected
+    NC = (int)0xFFFFFFFF,
+
+    // Buttons
+#if defined(TARGET_NRF52_MICROBIT_V2_IF_833)
+    BUTTON1 = P1_9,
+    BUTTON_RESET = BUTTON1,
+#elif defined(TARGET_NRF52_MICROBIT_V2_IF_820)
+    BUTTON1 = P0_6,
+    BUTTON_RESET = BUTTON1,
+#else
     BUTTON1 = P0_14,
     BUTTON2 = P0_23,
     BUTTONA = BUTTON1,
     BUTTONB = BUTTON2,
+#endif
 
+    // Target MCU only pins
+#if !defined(MICROBIT_IF)
     // LED matrix
     ROW_1 = P0_21,
     ROW_2 = P0_22,
@@ -179,63 +192,112 @@ typedef enum {
     RING1 = P0_3,
     RING2 = P0_4,
 
-    // GPIO
-    GPIO1 = P0_10,
-    GPIO2 = P0_9,
-    GPIO3 = P1_2,
-    GPIO4 = P0_12,
+    // Free edge connector GPIOs
+    GPIO1 = P0_10,  // Edge connector pin 8
+    GPIO2 = P0_9,   // Edge connector pin 9
+    GPIO3 = P1_2,   // Edge connector pin 16
+    GPIO4 = P0_12,  // Edge connector pin 12
 
     // Audio
     SPEAKER = P0_0,
     MIC = P0_5,
     RUN_MIC = P0_20,
+#endif
 
-    // Other micro:bit specific pins
+    // Interface MCU only pins
+#if defined(TARGET_NRF52_MICROBIT_V2_IF_833)
+    LED1 = P0_15,
+    LED2 = P0_17,
+#elif defined(TARGET_NRF52_MICROBIT_V2_IF_820)
+    LED1 = P0_14,
+    LED2 = P0_15,
+#endif
+
+    // Other micro:bit specific pins common to Interface and Target
+#if defined(TARGET_NRF52_MICROBIT_V2_IF_833)
+    COMBINED_SENSOR_INT = P0_9,
+#elif defined(TARGET_NRF52_MICROBIT_V2_IF_820)
+    COMBINED_SENSOR_INT = P0_16,
+#else
     COMBINED_SENSOR_INT = P0_25,
+#endif
 
     // UART
+#if defined(TARGET_NRF52_MICROBIT_V2_IF_833)
+    // TODO: Add UART TX and RX pins
+    RX_PIN_NUMBER  = NC,
+    TX_PIN_NUMBER  = NC,
+    // mBed interface Pins
+    CONSOLE_TX = NC,
+    CONSOLE_RX = NC,
+    STDIO_UART_TX = NC,
+    STDIO_UART_RX = NC,
+#elif defined(TARGET_NRF52_MICROBIT_V2_IF_820)
+    // TODO: Add UART TX and RX pins
+    RX_PIN_NUMBER  = NC,
+    TX_PIN_NUMBER  = NC,
+    // mBed interface Pins
+    CONSOLE_TX = NC,
+    CONSOLE_RX = NC,
+    STDIO_UART_TX = NC,
+    STDIO_UART_RX = NC,
+#else
     RX_PIN_NUMBER  = P1_8,
     TX_PIN_NUMBER  = P0_6,
-    CTS_PIN_NUMBER = p7,
-    RTS_PIN_NUMBER = p5,
-
     // mBed interface Pins
     CONSOLE_TX = TX_PIN_NUMBER,
     CONSOLE_RX = RX_PIN_NUMBER,
     STDIO_UART_TX = TX_PIN_NUMBER,
     STDIO_UART_RX = RX_PIN_NUMBER,
+#endif
+
+    CTS_PIN_NUMBER = NC,
+    RTS_PIN_NUMBER = NC,
+    // mBed interface Pins
     STDIO_UART_CTS = CTS_PIN_NUMBER,
     STDIO_UART_RTS = RTS_PIN_NUMBER,
 
+#if defined(MICROBIT_IF)
+    SPI_PSELMOSI0 = NC,
+    SPI_PSELMISO0 = NC,
+    SPI_PSELSS0   = NC,
+    SPI_PSELSCK0  = NC,
+#else
     SPI_PSELMOSI0 = P0_13,
     SPI_PSELMISO0 = P0_1,
     SPI_PSELSS0   = P1_2,
     SPI_PSELSCK0  = P0_17,
+#endif
 
+#if defined(TARGET_NRF52_MICROBIT_V2_IF_833)
+    // TODO: Include the internal I2C pins
+#elif defined(TARGET_NRF52_MICROBIT_V2_IF_820)
+    // TODO: Include the internal I2C pins
+#else
+    // Internal I2C
     I2C_SDA0 = P0_16,
     I2C_SCL0 = P0_8,
 
+    // External I2C at the edge connector
     I2C_SDA1 = P1_0,
     I2C_SCL1 = P0_26,
+#endif
 
     /**** QSPI pins ****/
-    QSPI1_IO0 = P0_20,
-    QSPI1_IO1 = P0_21,
-    QSPI1_IO2 = P0_22,
-    QSPI1_IO3 = P0_23,
-    QSPI1_SCK = P0_19,
-    QSPI1_CSN = P0_17,
+    QSPI1_IO0 = NC,
+    QSPI1_IO1 = NC,
+    QSPI1_IO2 = NC,
+    QSPI1_IO3 = NC,
+    QSPI1_SCK = NC,
+    QSPI1_CSN = NC,
 
     /**** QSPI FLASH pins ****/
-    QSPI_FLASH1_IO0 = QSPI1_IO0,
-    QSPI_FLASH1_IO1 = QSPI1_IO1,
-    QSPI_FLASH1_IO2 = QSPI1_IO2,
-    QSPI_FLASH1_IO3 = QSPI1_IO3,
-    QSPI_FLASH1_SCK = QSPI1_SCK,
-    QSPI_FLASH1_CSN = QSPI1_CSN,
-
-    // Not connected
-    NC = (int)0xFFFFFFFF
+    QSPI_FLASH1_IO0 = NC,
+    QSPI_FLASH1_IO1 = NC,
+    QSPI_FLASH1_IO2 = NC,
+    QSPI_FLASH1_IO3 = NC,
+    QSPI_FLASH1_SCK = NC,
+    QSPI_FLASH1_CSN = NC,
 } PinName;
 
 typedef enum {
diff --git a/custom_targets.json b/custom_targets.json
@@ -47,7 +47,8 @@
             "NRF52_PAN_62",
             "NRF52_PAN_63",
             "NRF52_PAN_64",
-            "CONFIG_NFCT_PINS_AS_GPIOS"
+            "CONFIG_NFCT_PINS_AS_GPIOS",
+            "MICROBIT_TARGET"
         ],
         "device_has_remove": ["ITM"],
         "overrides": {
@@ -68,5 +69,24 @@
     },
     "NRF52_MICROBIT_v2": {
         "inherits": ["NRF52_MICROBIT_v1_43"]
+    },
+    "NRF52_MICROBIT_V2_IF_820": {
+        "inherits": ["NRF52_MICROBIT_v1_43"],
+        "core": "Cortex-M4",
+        "extra_labels_remove": [
+        ],
+        "macros_add": [
+            "MICROBIT_IF"
+        ],
+        "macros_remove": [
+            "MICROBIT_TARGET"
+        ],
+        "static_memory_defines": true,
+        "mbed_app_start": "0x8000",
+        "mbed_app_size": "0x17000",
+        "mbed_ram_size": "0x8000"
+    },
+    "NRF52_MICROBIT_V2_IF_833": {
+        "inherits": ["NRF52_MICROBIT_V2_IF_820"]
     }
 }
diff --git a/mbed_app.json b/mbed_app.json
@@ -20,6 +20,10 @@
         "NRF52_MICROBIT_v1_47": {
         },
         "NRF52_MICROBIT_v2": {
+        },
+        "NRF52_MICROBIT_V2_IF_820": {
+        },
+        "NRF52_MICROBIT_V2_IF_833": {
         }
     }
 }
diff --git a/source/main.cpp b/source/main.cpp
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 Micro:bit Educational Foundation and contributors
+ * Copyright 2020-2022 Micro:bit Educational Foundation and contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,28 +16,35 @@
  */
 #include "mbed.h"
 
-DigitalOut rows[5] = {
-    DigitalOut(ROW_1, 0),
-    DigitalOut(ROW_2, 0),
-    DigitalOut(ROW_3, 0),
-    DigitalOut(ROW_4, 0),
-    DigitalOut(ROW_5, 0)
-};
-DigitalOut cols[5] = {
-    DigitalOut(COL_1, 1),
-    DigitalOut(COL_2, 1),
-    DigitalOut(COL_3, 1),
-    DigitalOut(COL_4, 1),
-    DigitalOut(COL_5, 1)
-};
-
-#ifdef LED1
-    DigitalOut led(LED1);
+#if defined(MICROBIT_TARGET)
+    // Main micro:bit target has access to the LED matrix and on-board features
+    DigitalOut rows[5] = {
+        DigitalOut(ROW_1, 0),
+        DigitalOut(ROW_2, 0),
+        DigitalOut(ROW_3, 0),
+        DigitalOut(ROW_4, 0),
+        DigitalOut(ROW_5, 0)
+    };
+    DigitalOut cols[5] = {
+        DigitalOut(COL_1, 1),
+        DigitalOut(COL_2, 1),
+        DigitalOut(COL_3, 1),
+        DigitalOut(COL_4, 1),
+        DigitalOut(COL_5, 1)
+    };
+    bool led1;
+    bool led2;
 #else
-    bool led;
+    // The nRF52833 DK and micro:bit V2.2 IF MCU have access to direct LEDs
+    bool rows[5];
+    bool cols[5];
+    DigitalOut led1(LED1, 0);
+    DigitalOut led2(LED2, 1);
 #endif
 
 int main(void) {
+    // Infinite loop to blink the matrix LEDs if built for the target MCU or
+    // to toggle the orange and red USB LEDs if built for the interface MCU 
     while (true) {
         for (int i = 0; i < 5; i++) {
             rows[i] = 1;
@@ -50,10 +57,11 @@ int main(void) {
                 if (prev_j < 0) prev_j = 4;
                 cols[prev_j] = 1;
 
+                led1 = !led1;
+                led2 = !led2;
+
                 ThisThread::sleep_for(250);
                 //wait_us(250000);
-
-                led = !led;
             }
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,10 @@`
`20`	`20`	`"NRF52_MICROBIT_v1_47": {`
`21`	`21`	`},`
`22`	`22`	`"NRF52_MICROBIT_v2": {`
	`23`	`+ },`
	`24`	`+ "NRF52_MICROBIT_V2_IF_820": {`
	`25`	`+ },`
	`26`	`+ "NRF52_MICROBIT_V2_IF_833": {`
`23`	`27`	`}`
`24`	`28`	`}`
`25`	`29`	`}`