Merge branch 'master' into Servo

Author: Nathan Seidle

README.md

@@ -3,12 +3,38 @@
 
 ## Contents
 
-* [Development Status]()
 * [Installation]()
+* [Development Status]()
 * [Issue Template]()
 * [Repo Contents]()
 * [Acknowledgements]()
 
+
+## 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). 
@@ -35,30 +61,6 @@ Current focus is to begin building support for the essential Arduino libraries i
     * Working: transfers with SPISettings.
 
 
-## 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
 
 ## How to Contribute
 The goal of this Arduino Core is to provide excellent Apollo3 support in a clear and extendable manner. The guidelines for contributing and submitting issues are designed to make it easy to integrate work from many people.  

cores/arduino/ard_sup/analog/ap3_analog.cpp

@@ -41,13 +41,14 @@ ap3_err_t ap3_set_pin_to_analog(uint8_t pinNumber);
 ap3_err_t ap3_analog_pad_funcsel(ap3_gpio_pad_t padNumber, uint8_t *funcsel);
 ap3_err_t ap3_change_channel(ap3_gpio_pad_t padNumber);
 
+bool power_adc_disable();
 uint16_t analogRead(uint8_t pinNumber);
 void analogReadResolution(uint8_t bits);
 
-ap3_err_t analogWriteResolution( uint8_t res );
-ap3_err_t analogWrite( uint8_t pin, uint32_t val );
-ap3_err_t servoWriteResolution( uint8_t res );
-ap3_err_t servoWrite( uint8_t pin, uint32_t val );
-
+ap3_err_t ap3_pwm_output(uint8_t pin, uint32_t th, uint32_t fw, uint32_t clk);
+ap3_err_t analogWriteResolution(uint8_t res);
+ap3_err_t analogWrite(uint8_t pin, uint32_t val);
+ap3_err_t servoWriteResolution(uint8_t res);
+ap3_err_t servoWrite(uint8_t pin, uint32_t val);
 
 #endif // _AP3_ANALOG_H_

cores/arduino/ard_sup/ap3_analog.h

@@ -67,7 +67,20 @@ void Uart::begin(unsigned long baudrate, am_hal_uart_config_t config)
 
 void Uart::end()
 {
-    // todo:
+    if (_handle != NULL)
+    {
+        flush();
+
+        // Power down the UART, and surrender the handle.
+        am_hal_uart_power_control(_handle, AM_HAL_SYSCTRL_DEEPSLEEP, false);
+        am_hal_uart_deinitialize(_handle);
+
+        // Disable the UART pins.
+        am_hal_gpio_pinconfig(_pinTX, g_AM_HAL_GPIO_DISABLE);
+        am_hal_gpio_pinconfig(_pinRX, g_AM_HAL_GPIO_DISABLE);
+
+        _handle = NULL;
+    }
 }
 
 int Uart::available()
@@ -93,7 +106,8 @@ int Uart::read()
 
 void Uart::flush()
 {
-    // todo:
+    // Make sure the UART has finished sending everything it's going to send.
+    am_hal_uart_tx_flush(_handle);
 }
 
 size_t Uart::write(const uint8_t data)

cores/arduino/ard_sup/uart/ap3_uart.cpp

@@ -5,6 +5,15 @@ 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.1
+=====
+- Add burst mode support (PR #13)
+- Made examples under 'Core Testing' visible through File->Examples menu (PR #10)
+- Add EEPROM library (PR #11)
+- Fix handling of spaces in paths (PR #20)
+- Fix paths to SparkFun SVL for Mac and Linux
+- Add ADC power functions and Serial end/flush (PR #18)
+
 1.0.0
 =====
 - Add SparkFun Variable Bootloader

docs/CHANGELOG.md

@@ -32,13 +32,13 @@ void setup()
   Serial.println("SparkFun Arduino Apollo3 analogWrite() Example");
   Serial.printf("Compiled on %s, %s\n\n", __DATE__, __TIME__); // Look! You can use printf, if you so choose
 
-  analogWrite(46, 127);      // analogWrite uses a high frequency counter/timer module to generate a PWM value with f ~= 350 Hz
-  analogWriteResolution(15); // you can increase the resolution of the write from the default (8-bit, 0-255) to up to 15 bits (0-32767)
-  analogWrite(37, 16383);    // subsequent cals to analogWrite use the new resolution, so both this call and the original have a 50% duty cycle, or 3.3/2 V
+  analogWrite(46, 127);      // analogWrite uses a high frequency counter/timer module to generate a PWM value with f ~= 180 Hz
+  analogWriteResolution(16); // you can increase the resolution of the write from the default (8-bit, 0-255) to up to 16 bits (0-65535)
+  analogWrite(37, 32767);    // subsequent cals to analogWrite use the new resolution, so both this call and the original have a 50% duty cycle, or 3.3/2 V
 
   servoWrite(44, 127);      // The servoWrite function produces a PWM signal with a pulse width between 1 and 2 ms at 500 Hz
-  servoWriteResolution(15); // You can also increase the servoWrite() resolution
-  servoWrite(47, 16383);    // This and the above write should both produce 1.5 ms wide pulses, though using different resolutions
+  servoWriteResolution(16); // You can also increase the servoWrite() resolution
+  servoWrite(47, 32767);    // This and the above write should both produce 1.5 ms wide pulses, though using different resolutions
 
   delay(5000);
 }
@@ -56,8 +56,8 @@ void loop()
   servoWrite(44, val);
   servoWrite(47, val);
 
-  val += 5 * sign;
-  if (val > 32767)
+  val += 10 * sign;
+  if (val > 65535)
   {
     sign = -1;
   }

libraries/CoreTesting/examples/Advanced/BurstMode/BurstMode.ino renamed to libraries/Examples/examples/Advanced/BurstMode/BurstMode.ino

@@ -43,10 +43,10 @@ ap3core.ambiq_sdk.path={ap3core.path}/am_sdk_ap3
 
 ## Core Includes
 includes.extra=
-includes.ambiq_sdk=-I{ap3core.ambiq_sdk.path}/mcu/apollo3 -I{ap3core.ambiq_sdk.path}/mcu/apollo3/hal -I{ap3core.ambiq_sdk.path}/mcu/apollo3/regs -I{ap3core.ambiq_sdk.path}/utils
-includes.cmsis=-I{ap3core.ambiq_sdk.path}/CMSIS/AmbiqMicro/Include -I{ap3core.ambiq_sdk.path}/CMSIS/ARM/Include
-includes.core=-I{ap3core.path}/ard_sup -I{ap3core.path}/ard_sup/ard_supers {includes}
-includes.variant={build.includes}
+includes.ambiq_sdk="-I{ap3core.ambiq_sdk.path}/mcu/apollo3" "-I{ap3core.ambiq_sdk.path}/mcu/apollo3/hal" "-I{ap3core.ambiq_sdk.path}/mcu/apollo3/regs" "-I{ap3core.ambiq_sdk.path}/utils"
+includes.cmsis="-I{ap3core.ambiq_sdk.path}/CMSIS/AmbiqMicro/Include" "-I{ap3core.ambiq_sdk.path}/CMSIS/ARM/Include"
+includes.core="-I{ap3core.path}/ard_sup" "-I{ap3core.path}/ard_sup/ard_supers" {includes}
+includes.variant="{build.includes}"
 
 
 ## Precompiled Libraries
@@ -154,11 +154,11 @@ tools.ambiq_bin2board.upload.pattern={pgm} {args}
 ##### The following tool settings are for the SparkFun variable bootloader (Artemis SVL) (Saturn Five Loader)
 
     # Linux
-tools.artemis_svl.pgm={runtime.platform.path}/tools/ambiq/linux/artemis_svl/artemis_svl
+tools.artemis_svl.pgm={runtime.platform.path}/tools/artemis/linux/artemis_svl/artemis_svl
 tools.artemis_svl.args="{serial.port}" -f "{build.path}/{build.project_name}.bin" -b {upload.baud} {upload.verbose}
 
     # MacOSX
-tools.artemis_svl.pgm.macosx={runtime.platform.path}/tools/ambiq/macosx/artemis_svl/artemis_svl
+tools.artemis_svl.pgm.macosx={runtime.platform.path}/tools/artemis/macosx/artemis_svl/artemis_svl
 tools.artemis_svl.args.macosx="{serial.port}" -f "{build.path}/{build.project_name}.bin" -b {upload.baud} {upload.verbose}
 
     # Windows