Add WDT Library

cores/arduino/am_sdk_ap3/mcu/apollo3/hal/am_hal_uart.h

@@ -172,8 +172,8 @@ am_hal_uart_transfer_t;
 
 // Flow control
 #define AM_HAL_UART_FLOW_CTRL_NONE          0
-#define AM_HAL_UART_FLOW_CTRL_CTS_ONLY      UART_CR_CTSEN_Msk
-#define AM_HAL_UART_FLOW_CTRL_RTS_ONLY      UART_CR_RTSEN_Msk
+#define AM_HAL_UART_FLOW_CTRL_CTS_ONLY      UART0_CR_CTSEN_Msk
+#define AM_HAL_UART_FLOW_CTRL_RTS_ONLY      UART0_CR_RTSEN_Msk
 #define AM_HAL_UART_FLOW_CTRL_RTS_CTS       (UART0_CR_CTSEN_Msk |   \
                                              UART0_CR_RTSEN_Msk)
 // FIFO enable/disable.

cores/arduino/ard_sup/uart/ap3_uart.cpp

@@ -296,6 +296,22 @@ ap3_err_t Uart::set_config(HardwareSerial_Config_e HWSconfig)
         retval = AP3_INVALID_ARG;
         break;
     }
+
+    //Setup flow control
+    _config.ui32FlowControl = AM_HAL_UART_FLOW_CTRL_NONE;
+    if(_pinRTS != AP3_UART_PIN_UNUSED && _pinCTS != AP3_UART_PIN_UNUSED)
+    {
+        _config.ui32FlowControl = AM_HAL_UART_FLOW_CTRL_RTS_CTS;
+    }
+    else if(_pinRTS != AP3_UART_PIN_UNUSED)
+    {
+        _config.ui32FlowControl = AM_HAL_UART_FLOW_CTRL_RTS_ONLY;
+    }
+    else if(_pinCTS != AP3_UART_PIN_UNUSED)
+    {
+        _config.ui32FlowControl = AM_HAL_UART_FLOW_CTRL_CTS_ONLY;
+    }
+
     return retval;
 }
 
@@ -375,7 +391,7 @@ ap3_err_t Uart::_begin(void)
 
     if (_pinRTS != AP3_UART_PIN_UNUSED)
     {
-        retval = ap3_uart_pad_funcsel(_instance, AP3_UART_TX, ap3_gpio_pin2pad(_pinRTS), &funcsel);
+        retval = ap3_uart_pad_funcsel(_instance, AP3_UART_RTS, ap3_gpio_pin2pad(_pinRTS), &funcsel);
         if (retval != AP3_OK)
         {
             return retval;
@@ -391,7 +407,7 @@ ap3_err_t Uart::_begin(void)
 
     if (_pinCTS != AP3_UART_PIN_UNUSED)
     {
-        retval = ap3_uart_pad_funcsel(_instance, AP3_UART_RX, ap3_gpio_pin2pad(_pinCTS), &funcsel);
+        retval = ap3_uart_pad_funcsel(_instance, AP3_UART_CTS, ap3_gpio_pin2pad(_pinCTS), &funcsel);
         if (retval != AP3_OK)
         {
             return retval;

keywords.txt

@@ -0,0 +1,39 @@
+#######################################
+# Syntax Coloring Map For Wire
+#######################################
+
+#######################################
+# Datatypes (KEYWORD1)
+#######################################
+
+#######################################
+# Methods and Functions (KEYWORD2)
+#######################################
+
+enableBurstMode	KEYWORD2
+disableBurstMode	KEYWORD2
+getCpuFreqMHz	KEYWORD2
+
+getInternalTemp	KEYWORD2
+
+analogWriteResolution	KEYWORD2
+analogWriteFrameWidth	KEYWORD2
+analogWriteFrequency	KEYWORD2
+servoWrite	KEYWORD2
+
+enableFastShift	KEYWORD2
+fastShiftOut	KEYWORD2
+fastShiftIn	KEYWORD2
+
+secs	KEYWORD2
+systicks	KEYWORD2
+sysoverflows	KEYWORD2
+
+#######################################
+# Instances (KEYWORD2)
+#######################################
+
+#######################################
+# Constants (LITERAL1)
+#######################################
+

libraries/WDT/examples/Example1_WDT_Basic/Example1_WDT_Basic.ino

@@ -0,0 +1,82 @@
+/*
+  Author: Adam Garbo
+  Created: August 1st, 2020
+  License: MIT. See SparkFun Arduino Apollo3 Project for more information
+
+  This example demonstrates a simple configuration of the Artemis Watchdog Timer.
+
+  The code will configure the watchdog for both interrupt and reset generation,
+  and immediately start the watchdog timer.
+
+  The watchdog ISR provided will 'pet' the watchdog four times. On the fifth
+  interrupt, the watchdog will not be pet, so the 'reset' action can occur.
+  On the sixth timeout event, the WDT will issue a system reset, and the
+  program will start over from the beginning.
+
+  The watchdogCounter will show the number of ticks before the watchdog
+  reset occurs.
+
+  This example is based on the Ambiq SDK 2.4.2 watchdog.c example.
+
+  Tested with SparkFun Artemis Redboard.
+*/
+
+#include <WDT.h>
+
+APM3_WDT wdt;
+
+volatile bool watchdogFlag = false; // Watchdog Timer ISR flag
+volatile int  watchdogInterrupt = 0; // Watchdog interrupt counter
+unsigned long currentMillis = 0,
+              previousMillis = 0;
+
+void setup() {
+
+  Serial.begin(115200);
+
+  Serial.println("Artemis Watchdog Timer Example");
+
+  // Start the watchdog
+  wdt.start();
+}
+
+void loop()
+{
+  // Check for watchdog interrupts
+  if (watchdogFlag)
+  {
+    // Calculate duration between watchdog interrupts
+    currentMillis = millis() - previousMillis;
+    previousMillis = millis();
+
+    Serial.print("Interrupt: "); Serial.print(watchdogInterrupt);
+    Serial.print(" Period: "); Serial.print(currentMillis); Serial.println(" ms ");
+
+    if (watchdogInterrupt == 5) 
+    {
+      Serial.println("Warning: Watchdog has triggered a system reset");
+    }
+  }
+
+  watchdogFlag = false; // Clear watchdog flag
+  delay(1);
+}
+
+// Interrupt handler for the watchdog
+extern "C" void am_watchdog_isr(void)
+{
+  // Clear the watchdog interrupt
+  wdt.clear();
+
+  // Catch the first four watchdog interrupts, but let the fifth through untouched
+  if ( watchdogInterrupt < 4 )
+  {
+    wdt.restart(); // "Pet" the dog
+  }
+  else {
+    digitalWrite(LED_BUILTIN, HIGH); // Visual indication of system reset trigger
+  }
+
+  watchdogFlag = true; // Set watchdog flag
+  watchdogInterrupt++; // Increment watchdog interrupt counter
+}

libraries/WDT/examples/Example2_WDT_Config/Example2_WDT_Config.ino

@@ -0,0 +1,103 @@
+/*
+  Author: Adam Garbo
+  Created: August 1st, 2020
+  License: MIT. See SparkFun Arduino Apollo3 Project for more information
+
+  This example demonstrates how to modify the configuration of the Artemis
+  Watchdog Timer (WDT).
+
+  The watchdog timer is controlled by a clock divider, interrupt ticks and 
+  reset ticks. To achieve desired watchdog timing, a simple calculation can be made:
+
+  period = # ticks / clock divider frequency 
+
+  Examples: 
+  128 interrupt ticks / 128 Hz clock = 1 second
+  64 interrupt ticks / 16 Hz clock = 4 seconds
+  32 interrupt ticks / 1 Hz clock = 32 seconds
+  16 interrupt ticks / 1/16 Hz clock = 256 seconds
+
+  The following code will configure the watchdog for both interrupt and reset
+  generation, and immediately start the watchdog timer.
+  The watchdog ISR provided will 'pet' the watchdog four times. On the fifth
+  interrupt, the watchdog will not be pet, so the 'reset' action can occur.
+  On the sixth timeout event, the WDT will issue a system reset, and the
+  program will start over from the beginning.
+
+  This example is based on the Ambiq SDK 2.4.2 watchdog.c example.
+
+  Tested with SparkFun Artemis Redboard.
+*/
+
+#include <WDT.h>
+
+APM3_WDT wdt;
+
+volatile bool watchdogFlag = false; // Watchdog Timer ISR flag
+volatile int watchdogInterrupt = 0; // Watchdog interrupt counter
+
+unsigned long currentMillis = 0,
+              previousMillis = 0;
+
+void setup()
+{
+  Serial.begin(115200);
+
+  Serial.println("Artemis Watchdog Timer Example");
+
+  // Configure the watchdog
+  /*
+    Available watchdog timer clock dividers:
+    0 = Low Power Mode. This setting disables the watch dog timer
+    1 = 128 Hz 
+    2 = 16 Hz 
+    3 = 1 Hz
+    4 = 1/16th Hz
+  */
+  // Set watchdog timer clock to 128 Hz
+  // Set watchdog interrupt to 1 seconds (128 ticks / 128 Hz = 1 second)
+  // Set watchdog reset ~2 seconds (255 ticks / 128 Hz = 1.99 seconds)
+  wdt.configure(1, 128, 255); // Note: Ticks are limited to 255 (8-bit)
+  wdt.start(); // Start the watchdog
+}
+
+void loop()
+{
+  // Check for watchdog interrupts
+  if (watchdogFlag)
+  {
+    // Calculate duration between watchdog interrupts
+    currentMillis = millis() - previousMillis;
+    previousMillis = millis();
+
+    Serial.print("Interrupt: "); Serial.print(watchdogInterrupt);
+    Serial.print(" Period: "); Serial.print(currentMillis); Serial.println(" ms");
+
+    // The watchdog configurations can also be set individually
+    wdt.setClock(2); // Set watchdog timer clock to 16 Hz
+    wdt.setInterrupt(64); // Set watchdog interrupt to 4 second (64 ticks / 16 Hz = 4 seconds)
+    wdt.setReset(96); // Set watchdog reset to 8 seconds (96 ticks / 16 Hz = 8 seconds)
+  }
+  watchdogFlag = false; // Clear watchdog flag
+  delay(1);
+}
+
+// Interrupt handler for the watchdog
+extern "C" void am_watchdog_isr(void)
+{
+  // Clear the watchdog interrupt
+  wdt.clear();
+
+  // Catch the first eight watchdog interrupts, but let the ninth through untouched
+  if ( watchdogInterrupt < 8 )
+  {
+    wdt.restart(); // "Pet" the dog
+  }
+  else
+  {
+    digitalWrite(LED_BUILTIN, HIGH); // Visual indication of system reset trigger
+  }
+
+  watchdogFlag = true; // Set watchdog flag
+  watchdogInterrupt++; // Increment watchdog interrupt counter
+}