Merge branch 'master' into PDM

Author: Nathan Seidle

README.md

@@ -12,52 +12,36 @@
 
 ## Installation
 
-The structure of this repo is such that it will most closely resemble the structure required when it is time to add it to the Arduino boards manager. Until then you'll have to use the manual installation process.
-
 * [Using Arduino IDE Boards Manager](https://github.com/sparkfun/Arduino_Boards) (Reccomended)
     * Follow the instructions at the [SparkFun Arduino Boards Repo](https://github.com/sparkfun/Arduino_Boards)
     * Open 'Boards Manager' and select 'SparkFun Apollo3 Boards,' install the latest version.
     * JSON boards manager link for convenience: https://raw.githubusercontent.com/sparkfun/Arduino_Boards/master/IDE_Board_Manager/package_sparkfun_index.json
 
 
-* [Manually Install in Arduino Sketchbook]()
-    * **First** Install the Arduino SAMD Boards through the Arduino Board Manager. This is required for the ARM Cortex-M toolchain.
-    * Open your Arduno sketchbook folder, listed in Arduino's preferences pane (it is where your libraries folder lives)
-    * If there is no ```hardware``` folder create it
-    * Inside the ```hardware``` folder create ```SparkFun```
-    * Choose to clone with Git or download the .zip of this repo
-        * Cloning
-            * Clone this repo into ```SparkFun``` and give it the name ```apollo3```
-        * .ZIP
-            * Download the .ZIP of this repository
-            * Within ```SparkFun``` create the ```apollo3``` directory
-            * Unzip the contents of the .ZIP into the ```apollo3``` directory
-    * Restart Arduino IDE for good measure
-
 
 ## Development Status
 
 The basic necesseties are in-place. This means that you can compile and upload code to your Apollo3 board. Development can be done with the whole range of Hardware Abstraction Layer functions provided in the AmbiqSuite Software Development Kit (based on Release2.1.0). 
 
-Current focus is to begin building support for the essential Arduino libraries including:
-  * Serial: Fully implemented (will fix bugs and tweak performance over time)
-  * GPIO
-    * Working:
-      * ditigal functions (read / write)
-      * analogRead
-      * analogWrite
-      * interrupts
-  * Timing
-    * Working:
-      * delay
-      * delayMicroseconds
-      * millis
-      * micros
-      * seconds (extension)
+**Main Arduino Features**
+  * Serial: ✅
+  * GPIO: ✅
+  * Analog / Servo Output: ✅
+  * Analog Input: ✅
+  * Timing / Delays: ✅
   * Wire
-    * Working: 90% use case, master I2C interface. 
+    * Master: ✅
+    * Slave: ❌
   * SPI
-    * Working: transfers with SPISettings.
+    * Master: ✅
+    * Slave: ❌
+
+**Apollo3 Specialty Peripherals**
+  * PDM Microphones / I2S: 🤔
+  * BLE: 🤔
+  * Multi-bit SPI: 🤔
+  * I2C/SPI Slave: 🤔
+  
 
 
 
@@ -78,6 +62,7 @@ The goal of this Arduino Core is to provide excellent Apollo3 support in a clear
 
 ## Repo Contents
 
+* bootloaders: source code and binary images of the SparkFun Variable Loader (SVL)
 * cores : source code and headers common to all Apollo3 Arduino boards
 * docs : 
     * CONTRIBUTING.md

bootloaders/artemis/!artemis_svl/README.txt

@@ -1,19 +1,18 @@
 Name:
 =====
- hello_world_uart
+ artemis_svl
 
 
 Description:
 ============
- A simple "Hello World" example using the UART peripheral.
-
-
-Purpose:
-========
-This example prints a "Hello World" message with some device info
-over UART at 115200 baud. To see the output of this program, run AMFlash,
-and configure the console for UART. The example sleeps after it is done
-printing.
+ Variable baud rate bootloader for Apollo3/Artemis
+ 
+ 
+ Usage:
+ =====
+ This source code is provided mostly for reference. The easiest way to upload the SVL is by using the Arduino "burn bootloader" tool and selecting "Ambiq Secure Bootloader" as the "Programmer" option.
+ 
+ If you want to make changes you can compile and upload the artemis_svl using the AmbiqSuite SDK.
 
 
 ******************************************************************************

cores/arduino/ard_sup/Arduino.h

@@ -84,4 +84,6 @@ extern "C"
 
 #include "variant.h"
 
+#include "ap3_post_variant.h"
+
 #endif // _ARDUINO_H_

cores/arduino/ard_sup/ap3_post_variant.h

@@ -0,0 +1,23 @@
+#ifndef _AP3_POST_VARIANT_H_
+#define _AP3_POST_VARIANT_H_
+
+// Some fail-unsafe defines for SD card library compilation. 
+// These ideally would be defined in a variant header, however
+// if they are not these definitions may suffice
+#ifndef SS
+#define SS 50
+#endif  // SS
+#ifndef MOSI
+#define MOSI 50
+#endif  // SS
+#ifndef MISO
+#define MISO 50
+#endif  // SS
+#ifndef CLK
+#define CLK 50
+#endif  // SS
+
+
+
+
+#endif // _AP3_POST_VARIANT_H_

cores/arduino/ard_sup/iomaster/ap3_iomaster.cpp

@@ -51,6 +51,8 @@ ap3_err_t IOMaster::initialize(am_hal_iom_config_t config){
     if (retVal32 != AM_HAL_STATUS_SUCCESS){ return AP3_ERR; }
 
     // Configure the IOM pins. (Must be done by the inherited classes [this is just a reminder])
+
+    return AP3_OK;
 }
 
 ap3_err_t IOMaster::deinitialize( void ){

docs/ACKNOWLEDGEMENTS.md

@@ -9,5 +9,6 @@ Thank you to everyone who has contributed!
 Contributors
 ============
 * Jim Lindblom
+* Kenny Hora
 * Owen Lyke
 * Nathan Seidle

docs/CHANGELOG.md

@@ -5,6 +5,22 @@ This is a record of the major changes between versions of the SparkFun Arduino A
 
 Each log entry will use the version number of the release that contains the changes listed. Newest version at the top of the file (just below this line)
 
+1.0.6 - Aug 5 2019
+===================
+- Added default SD support with Arduino SD library
+- Fixed non-return errors in SPI library
+- Added full duplex capability to 'transfer(uint8_t)'
+
+1.0.5 - Jul 30 2019
+===================
+- Minor updates to bootloaders
+    - SVL: added some exits and improved verbose/quiet formatting
+    - ASB (SBL): reduced impact of UART hammering with 'reset_input_buffer'
+
+1.0.4 - Jul 25 2019
+===================
+- Implement Artemis SVL v3
+
 1.0.3 - Jul 16 2019
 ===================
 - Fix platform discrepancies in upload tools (SVL)