Bsp Integration (#90)

Bsp Integration

Author: oclyke

boards.txt

@@ -28,7 +28,7 @@ menu.sbl_baud=Ambiq Secure Bootloader Baud Rate
 ###############################################################
 
 artemis.name=SparkFun Artemis Module
-artemis.build.variant=SparkFun_Artemis
+artemis.build.variant=artemis
 artemis.build.board=SFE_ARTEMIS
 artemis.upload.maximum_size=960000
 artemis.upload.sbl_baud=115200
@@ -65,7 +65,7 @@ artemis.menu.loader.sparkfun_svl.build.ldscript={build.variant.path}/linker_scri
 ###############################################################
 
 amap3redboard.name=SparkFun RedBoard Artemis
-amap3redboard.build.variant=SparkFun_RedBoard_Artemis
+amap3redboard.build.variant=redboard_artemis
 amap3redboard.build.board=AM_AP3_SFE_BB_ARTEMIS
 amap3redboard.upload.maximum_size=960000
 amap3redboard.upload.sbl_baud=115200
@@ -102,7 +102,7 @@ amap3redboard.menu.loader.sparkfun_svl.build.ldscript={build.variant.path}/linke
 ###############################################################
 
 amap3nano.name=SparkFun RedBoard Artemis Nano
-amap3nano.build.variant=SparkFun_RedBoard_Artemis_Nano
+amap3nano.build.variant=redboard_artemis_nano
 amap3nano.build.board=AM_AP3_SFE_BB_ARTEMIS_NANO
 amap3nano.upload.maximum_size=960000
 amap3nano.upload.sbl_baud=115200
@@ -139,7 +139,7 @@ amap3nano.menu.loader.sparkfun_svl.build.ldscript={build.variant.path}/linker_sc
 ###############################################################
 
 amap3atp.name=SparkFun RedBoard Artemis ATP
-amap3atp.build.variant=SparkFun_RedBoard_Artemis_ATP
+amap3atp.build.variant=redboard_artemis_atp
 amap3atp.build.board=AM_AP3_SFE_BB_ARTEMIS_ATP
 amap3atp.upload.maximum_size=960000
 amap3atp.upload.sbl_baud=115200
@@ -176,7 +176,7 @@ amap3atp.menu.loader.sparkfun_svl.build.ldscript={build.variant.path}/linker_scr
 ###############################################################
 
 amap3thing.name=SparkFun Artemis Thing Plus
-amap3thing.build.variant=SparkFun_Artemis_Thing_Plus
+amap3thing.build.variant=artemis_thing_plus
 amap3thing.build.board=AM_AP3_SFE_THING_PLUS
 amap3thing.upload.maximum_size=960000
 amap3thing.upload.sbl_baud=115200
@@ -213,7 +213,7 @@ amap3thing.menu.loader.sparkfun_svl.build.ldscript={build.variant.path}/linker_s
 ###############################################################
 
 edge.name=SparkFun Edge
-edge.build.variant=SparkFun_Edge
+edge.build.variant=edge
 edge.build.board=SFE_EDGE
 edge.upload.tool=ambiq_bin2board
 edge.upload.maximum_size=960000
@@ -260,7 +260,7 @@ edge.menu.loader.sparkfun_svl.build.ldscript={build.variant.path}/linker_scripts
 ###############################################################
 
 edge2.name=SparkFun Edge2
-edge2.build.variant=SparkFun_Edge2
+edge2.build.variant=edge2
 edge2.build.board=SFE_EDGE2
 edge2.upload.maximum_size=960000
 edge2.upload.sbl_baud=115200

tools/variants/README.md

@@ -0,0 +1,7 @@
+Variant Tools
+=============
+
+The 'single source of truth' for variants is the [SparkFun_AmbiqSuite_Apollo3_BSPs](https://github.com/sparkfun/SparkFun_Apollo3_AmbiqSuite_BSPs) repo. This script is used to sync Arduino's sources with the BSP repo by copying the relevant ```.c``` and ```.h``` files. 
+
+* BSP libraries (```libam_bsp.a```) are not copied because Arduino compiles the bsp files with the core
+* BSP source (```bsp_pins.src```) are not copied because you are not meant to edit variants in the Arduino environment

tools/variants/arduino_boards.sh

@@ -0,0 +1 @@
+export BOARDS="edge edge2 artemis artemis_thing_plus redboard_artemis redboard_artemis_atp redboard_artemis_nano"

tools/variants/regen_variants.sh

@@ -0,0 +1,56 @@
+#!/usr/bin/env bash
+
+# use this script to update variants based on bsp files
+
+
+
+# setup
+set -e
+set -o errexit
+echo "" 1>&2
+
+# get enclosing directory
+DIR=$(dirname -- "$(readlink -f -- "$BASH_SOURCE")")
+
+# defaults
+BSP_ROOT=.
+BOARDS_FILE=$DIR/arduino_boards.sh
+VARIANTS_ROOT=../../variants
+
+# handle arguments
+while getopts ":r:b:" opt; do
+  case $opt in
+    r) BSP_ROOT="$OPTARG"
+    ;;
+    b) BOARDS_FILE="$OPTARG"
+    ;;
+    \?) echo "Invalid option -$OPTARG" 1>&2
+    ;;
+  esac
+done
+
+# verify bsp root
+echo "Using \$BSP_ROOT=$BSP_ROOT" 1>&2
+VFILE=$BSP_ROOT/README.md
+if [ -f "$VFILE" ]; 
+then
+    echo "\$BSP_ROOT verification passed" 1>&2
+else
+    echo "\$BSP_ROOT verification failed" 1>&2
+    exit 1
+fi
+
+# load in boards to handle
+echo "Using \$BOARDS_FILE=$BOARDS_FILE" 1>&2
+source $BOARDS_FILE
+
+# copy bsp files from BSP repo to Arduino variants
+echo "" 1>&2
+for value in $BOARDS
+do
+    echo "Copying bsp files for: $value" 1>&2
+    cp $BSP_ROOT/$value/bsp/am_bsp_pins.c $VARIANTS_ROOT/$value/bsp/am_bsp_pins.c
+    cp $BSP_ROOT/$value/bsp/am_bsp_pins.h $VARIANTS_ROOT/$value/bsp/am_bsp_pins.h
+    cp $BSP_ROOT/$value/bsp/am_bsp.c $VARIANTS_ROOT/$value/bsp/am_bsp.c
+    cp $BSP_ROOT/$value/bsp/am_bsp.h $VARIANTS_ROOT/$value/bsp/am_bsp.h
+done