- Fixed stack & heap variables from linkerscript causing HardFaults. Placed in supervisor/port.c

- Moved LEDs & PBs from supervisor/port.c to boards/$(BOARD)/board.c for APARD
- Reviewed Processor.c in common-hal/microcontroller
- Prepared stubs for common-hal/microcontroller/Pin.c

Author: Brandon-Hurst

ports/analog/boards/APARD/board.c

@@ -5,6 +5,24 @@
 // SPDX-License-Identifier: MIT
 
 #include "supervisor/board.h"
+#include "supervisor/port.h"
+#include "mpconfigboard.h"
+#include "max32_port.h"
+
+// Board-level setup for MAX32690
+// clang-format off
+const mxc_gpio_cfg_t pb_pin[] = {
+    { MXC_GPIO1, MXC_GPIO_PIN_27, MXC_GPIO_FUNC_IN, MXC_GPIO_PAD_NONE, MXC_GPIO_VSSEL_VDDIOH, MXC_GPIO_DRVSTR_0},
+};
+const int num_pbs = (sizeof(pb_pin) / sizeof(mxc_gpio_cfg_t));
+
+const mxc_gpio_cfg_t led_pin[] = {
+    { MXC_GPIO2, MXC_GPIO_PIN_1, MXC_GPIO_FUNC_OUT, MXC_GPIO_PAD_NONE, MXC_GPIO_VSSEL_VDDIO, MXC_GPIO_DRVSTR_0 },
+    { MXC_GPIO0, MXC_GPIO_PIN_11, MXC_GPIO_FUNC_OUT, MXC_GPIO_PAD_NONE, MXC_GPIO_VSSEL_VDDIO, MXC_GPIO_DRVSTR_0 },
+    { MXC_GPIO0, MXC_GPIO_PIN_12, MXC_GPIO_FUNC_OUT, MXC_GPIO_PAD_NONE, MXC_GPIO_VSSEL_VDDIO, MXC_GPIO_DRVSTR_0 },
+};
+const int num_leds = (sizeof(led_pin) / sizeof(mxc_gpio_cfg_t));
+// clang-format on
 
 // DEFAULT:  Using the weak-defined supervisor/shared/board.c functions
 
@@ -15,7 +33,23 @@
 // bool board_requests_safe_mode(void);
 
 // Initializes board related state once on start up.
-// void board_init(void);
+void board_init(void) {
+    // Enable GPIO (enables clocks + common init for ports)
+    for (int i = 0; i < MXC_CFG_GPIO_INSTANCES; i++){
+        MXC_GPIO_Init(0x1 << i);
+    }
+
+    // Init Board LEDs
+    /* setup GPIO for the LED */
+    for (int i = 0; i < num_leds; i++) {
+        // Set the output value
+        MXC_GPIO_OutClr(led_pin[i].port, led_pin[i].mask);
+        MXC_GPIO_Config(&led_pin[i]);
+    }
+
+    // Turn on one LED to indicate Sign of Life
+    MXC_GPIO_OutSet(led_pin[2].port, led_pin[2].mask);
+}
 
 // Reset the state of off MCU components such as neopixels.
 // void reset_board(void);
@@ -24,4 +58,5 @@
 // state. It should not prevent the user access method from working (such as
 // disabling USB, BLE or flash) because CircuitPython may continue to run.
 // void board_deinit(void);
+
 /*******************************************************************/

ports/analog/boards/APARD/mpconfigboard.mk

@@ -5,13 +5,18 @@
 # SPDX-License-Identifier: MIT
 
 INTERNAL_FLASH_FILESYSTEM = 1
-# FLASH: 	0x10000000 to 0x10340000
+# FLASH: 	0x10000000 to 0x10300000 (ARM)
 # SRAM: 	0x20000000 to 0x20100000
 
 USB_PRODUCT = "MAX32690 APARD"
 USB_MANUFACTURER = "Analog Devices, Inc."
+
+# NOTE: Not implementing external flash for now
 # CFLAGS+=-DEXT_FLASH_MX25
 
+# define 13 bytes UID for memory safety (buffer gets passed as a raw ptr)
+COMMON_HAL_MCU_PROCESSOR_UID_LENGTH = 13
+
 MCU_SERIES=max32
 MCU_VARIANT=max32690
 

ports/analog/common-hal/microcontroller/Pin.c

@@ -2,33 +2,62 @@
 #include <stdbool.h>
 
 #include "shared-bindings/microcontroller/Pin.h"
-// #include "shared-bindings/digitalio/DigitalInOut.h"
+#include "mpconfigboard.h"
+#include "pins.h"
 
+#include "mxc_sys.h"
+#include "max32690.h"
+#include "gpio.h"
 
-// #include "gpio.h"
-
-
-//FIXME: Implement
 void reset_all_pins(void) {
-    return;
+    // todo: this is not a good method for this long-term
+    // Pins should be individually reset to account for never_reset pins like SWD
+    for (int i = 0; i < NUM_GPIO_PORTS; i++) {
+        MXC_GPIO_Reset(i);
+    }
 }
 
-// FIXME: Implement
+// todo: Implement
 void reset_pin_number(uint8_t pin) {
-    return;
 }
 
-// FIXME: Implement
+// todo: Implement
 void claim_pin(const mcu_pin_obj_t *pin) {
     return;
 }
 
-// FIXME: Implement
+// todo: Implement
 bool pin_number_is_free(uint8_t pin_number) {
     return true;
 }
 
-// FIXME: Implement
+
+// todo: Implement
 void never_reset_pin_number(uint8_t pin_number) {
     return;
 }
+
+//todo: implement
+uint8_t common_hal_mcu_pin_number(const mcu_pin_obj_t *pin) {
+    return 0;
+}
+
+// todo: implement
+bool common_hal_mcu_pin_is_free(const mcu_pin_obj_t *pin) {
+    return true;
+}
+
+void common_hal_never_reset_pin(const mcu_pin_obj_t *pin) {
+}
+
+void common_hal_reset_pin(const mcu_pin_obj_t *pin) {
+}
+
+void common_hal_mcu_pin_claim(const mcu_pin_obj_t *pin) {
+}
+
+void common_hal_mcu_pin_claim_number(uint8_t pin_no) {
+}
+
+void common_hal_mcu_pin_reset_number(uint8_t pin_no) {
+}

ports/analog/common-hal/microcontroller/Processor.c

@@ -10,14 +10,15 @@
 #include "common-hal/microcontroller/Processor.h"
 #include "shared-bindings/microcontroller/ResetReason.h"
 
-#include "system_max32690.h"
+#include "max32_port.h"
 
-//
+// No means of getting core temperature for currently supported devices
 float common_hal_mcu_processor_get_temperature(void) {
     return NAN;
 }
 
-// TODO: Determine if there's a means of getting core voltage
+// MAX32690 can measure VCORE
+// TODO: (low prior.) Implement ADC API under "peripherals" and use API to measure VCORE
 float common_hal_mcu_processor_get_voltage(void) {
     return NAN;
 }
@@ -26,11 +27,16 @@ uint32_t common_hal_mcu_processor_get_frequency(void) {
     return SystemCoreClock;
 }
 
+// NOTE: COMMON_HAL_MCU_PROCESSOR_UID_LENGTH is defined in mpconfigboard.h
+// Use this per device to make sure raw_id is an appropriate minimum number of bytes
 void common_hal_mcu_processor_get_uid(uint8_t raw_id[]) {
+    MXC_SYS_GetUSN(raw_id, NULL); // NULL checksum will not be verified by AES
     return;
 }
 
-// TODO: May need to add reset reason in alarm / deepsleep cases
 mcu_reset_reason_t common_hal_mcu_processor_get_reset_reason(void) {
+    #if CIRCUITPY_ALARM
+        // TODO: (low prior.) add reset reason in alarm / deepsleep cases (should require alarm peripheral API in "peripherals")
+    #endif
     return RESET_REASON_UNKNOWN;
 }

ports/analog/common-hal/microcontroller/__init__.c

@@ -22,24 +22,20 @@
 
 
 #include "max32690.h"
+#include "mxc_delay.h"
+
 /** NOTE: It is not advised to directly include the below!
  * These are includes taken care of by the core cmsis file.
  * e.g. "max32690.h". Since CMSIS is compiled as lib, these are
  * included there as <core_cm4.h> for example.
 */
-// #include "core_cmFunc.h"    // For enable/disable interrupts
-// #include "core_cm4.h"       // For NVIC_SystemReset
-// #include "core_cmInstr.h"   // For __DMB Data Memory Barrier
+// #include <core_cmFunc.h>    // For enable/disable interrupts
+// #include <core_cm4.h>       // For NVIC_SystemReset
+// #include <core_cmInstr.h>   // For __DMB Data Memory Barrier (flush DBUS activity)
 
 void common_hal_mcu_delay_us(uint32_t delay) {
-    // uint32_t ticks_per_us = HAL_RCC_GetSysClockFreq() / 1000000UL;
-    // delay *= ticks_per_us;
-    // SysTick->VAL = 0UL;
-    // SysTick->LOAD = delay;
-    // SysTick->CTRL = SysTick_CTRL_CLKSOURCE_Msk | SysTick_CTRL_ENABLE_Msk;
-    // while ((SysTick->CTRL & SysTick_CTRL_COUNTFLAG_Msk) == 0) {
-    // }
-    // SysTick->CTRL = 0UL;
+
+    MXC_Delay(MXC_DELAY_USEC(delay));
 }
 
 volatile uint32_t nesting_count = 0;
@@ -59,7 +55,7 @@ void common_hal_mcu_enable_interrupts(void) {
     if (nesting_count > 0) {
         return;
     }
-    __DMB();
+    __DMB(); // flush internal DBUS before proceeding
     __enable_irq();
 }
 
@@ -75,7 +71,6 @@ void common_hal_mcu_on_next_reset(mcu_runmode_t runmode) {
 }
 
 void common_hal_mcu_reset(void) {
-
     if (next_reset_to_bootloader) {
         reset_to_bootloader();
     } else {
@@ -398,6 +393,8 @@ static const mp_rom_map_elem_t mcu_pin_global_dict_table[] = {
 };
 MP_DEFINE_CONST_DICT(mcu_pin_globals, mcu_pin_global_dict_table);
 
+
+/** NOTE: Not implemented yet */
 // #if CIRCUITPY_INTERNAL_NVM_SIZE > 0
 // // The singleton nvm.ByteArray object.
 // const nvm_bytearray_obj_t common_hal_mcu_nvm_obj = {

ports/analog/supervisor/max32_port.h ports/analog/max32_port.hports/analog/supervisor/max32_port.h renamed to ports/analog/max32_port.h

@@ -4,10 +4,18 @@
 
 #include <stdint.h>
 
-#include "mxc_sys.h"
+#include "mxc_assert.h"
+#include "mxc_delay.h"
+#include "mxc_device.h"
 #include "mxc_pins.h"
+#include "mxc_sys.h"
+
 #include "gpio.h"
-#include "mxc_assert.h"
+
+#ifdef MQAX32690
+#include "system_max32690.h"
+#include "max32690.h"
+#endif
 
 /** Linker variables defined....
  *  _estack:    end of the stack

ports/analog/supervisor/port.c

@@ -47,26 +47,19 @@
 #include "mxc_delay.h"
 #include "rtc.h"
 
+// Externs defined by linker .ld file
+extern uint32_t _stack, _heap, _estack, _eheap;
+extern uint32_t _ebss;
+
+// From boards/$(BOARD)/board.c
+extern const mxc_gpio_cfg_t pb_pin[];
+extern const int num_pbs;
+extern const mxc_gpio_cfg_t led_pin[];
+extern const int num_leds;
+
 //todo: define an LED HAL
 // #include "peripherals/led.h"
 
-#ifdef MAX32690
-// Board-level setup for MAX32690
-// clang-format off
-const mxc_gpio_cfg_t pb_pin[] = {
-    { MXC_GPIO1, MXC_GPIO_PIN_27, MXC_GPIO_FUNC_IN, MXC_GPIO_PAD_NONE, MXC_GPIO_VSSEL_VDDIOH, MXC_GPIO_DRVSTR_0},
-};
-const unsigned int num_pbs = (sizeof(pb_pin) / sizeof(mxc_gpio_cfg_t));
-
-const mxc_gpio_cfg_t led_pin[] = {
-    { MXC_GPIO2, MXC_GPIO_PIN_1, MXC_GPIO_FUNC_OUT, MXC_GPIO_PAD_NONE, MXC_GPIO_VSSEL_VDDIO, MXC_GPIO_DRVSTR_0 },
-    { MXC_GPIO0, MXC_GPIO_PIN_11, MXC_GPIO_FUNC_OUT, MXC_GPIO_PAD_NONE, MXC_GPIO_VSSEL_VDDIO, MXC_GPIO_DRVSTR_0 },
-    { MXC_GPIO0, MXC_GPIO_PIN_12, MXC_GPIO_FUNC_OUT, MXC_GPIO_PAD_NONE, MXC_GPIO_VSSEL_VDDIO, MXC_GPIO_DRVSTR_0 },
-};
-const unsigned int num_leds = (sizeof(led_pin) / sizeof(mxc_gpio_cfg_t));
-// clang-format on
-#endif
-
 // For caching rtc data for ticks
 static uint32_t subsec, sec = 0;
 
@@ -96,7 +89,7 @@ safe_mode_t port_init(void) {
     }
 
     // Turn on one LED to indicate Sign of Life
-    MXC_GPIO_OutSet(led_pin[0].port, led_pin[0].mask);
+    MXC_GPIO_OutSet(led_pin[2].port, led_pin[2].mask);
 
     // Init RTC w/ 0sec, 0subsec
     // Driven by 32.768 kHz ERTCO, with ssec= 1/4096 s
@@ -120,23 +113,9 @@ void reset_cpu(void) {
 
 // Reset MCU state
 void reset_port(void) {
-    int err;
-    // Reset GPIO Ports
-    // Enable GPIO (enables clocks + common init for ports)
-    for (int i = 0; i < MXC_CFG_GPIO_INSTANCES; i++){
-        err = MXC_GPIO_Reset(0x1 << i);
-        if (err) {
-            // todo: indicate some gpio error
-            continue;
-        }
-    }
-
-    // TODO: Reset peripheral clocks
+    reset_all_pins();
 
-    // Reset 1/1024 tick timer
-    MXC_RTC_Stop();
-    MXC_RTC_ClearFlags(0xFFFFFFFF);
-    MXC_RTC_Init(0,0);
+    // todo: may need rtc-related resets here later
 }
 
 // Reset to the bootloader
@@ -154,22 +133,19 @@ void reset_to_bootloader(void) {
  *  Return variables defined by linkerscript.
  */
 uint32_t *port_stack_get_limit(void) {
-    // ignore array bounds GCC warnings for stack here
+    // ignore array bounds GCC warnings
     #pragma GCC diagnostic push
     #pragma GCC diagnostic ignored "-Warray-bounds"
 
     // NOTE: Only return how much stack we have alloted for CircuitPython
-    return (uint32_t *)(port_stack_get_top() - (CIRCUITPY_DEFAULT_STACK_SIZE + CIRCUITPY_EXCEPTION_STACK_SIZE) / sizeof(uint32_t));
-    // return _estack;
-
-    // end GCC diagnostic disable
+    return port_stack_get_top() - (CIRCUITPY_DEFAULT_STACK_SIZE + CIRCUITPY_EXCEPTION_STACK_SIZE) / sizeof(uint32_t);
     #pragma GCC diagnostic pop
 }
 uint32_t *port_stack_get_top(void) {
-    return (uint32_t *)__stack;
+    return &_stack;
 }
 uint32_t *port_heap_get_bottom(void) {
-    return (uint32_t *)__heap;
+    return &_heap;
 }
 uint32_t *port_heap_get_top(void) {
     return port_stack_get_limit();