Add library for burst mode support

Wenn0101 · Wenn0101 · commit cd6fe5ed43b5 · 2021-05-04T11:29:19.000-06:00
diff --git a/libraries/BurstMode/examples/Example1_EnableDisable/Example1_EnableDisable.ino b/libraries/BurstMode/examples/Example1_EnableDisable/Example1_EnableDisable.ino
@@ -0,0 +1,42 @@
+//Burst Mode example
+//TEST_PIN is toggled as fast as possible, with burst mode enable and disabled.
+//Use a logic analyzer to view the difference in output
+#include "BurstMode.h"
+
+#define TEST_PIN D2 //Change to whatever pin you would like
+
+#define NUM_TOGGLES 20 //Number of times to toggle the gpio as an example task
+
+void setup() {
+  Serial.begin(115200); 
+  Serial.println("BurstMode Example1 - Enable and Disable");
+}
+
+void loop() {
+  long startTime, endTime;
+  enableBurstMode(); //Go to 96MHz
+  //Toggle the with digital write as fast as possible, 20 times
+  startTime = micros();
+  for(int i = 0; i < NUM_TOGGLES; i++)
+  {
+    digitalWrite(TEST_PIN, HIGH);
+    digitalWrite(TEST_PIN, LOW);
+  }
+  endTime = micros();
+  Serial.printf("Time (in microseconds) to toggle GPIO %d times = %d, at clock speed %d \r\n",
+                                              NUM_TOGGLES, (endTime - startTime), getCpuFreqMHz());
+
+  disableBurstMode(); //Go back to 48MHz
+  //Toggle the with digital write as fast as possible, 20 times
+  startTime = micros();
+  for(int i = 0; i < NUM_TOGGLES; i++)
+  {
+    digitalWrite(TEST_PIN, HIGH);
+    digitalWrite(TEST_PIN, LOW);
+  }
+  endTime = micros();
+  Serial.printf("Time (in microseconds) to toggle GPIO %d times = %d, at clock speed %d \r\n",
+                                              NUM_TOGGLES, (endTime - startTime), getCpuFreqMHz());
+  
+  delay(1000);
+}
diff --git a/libraries/BurstMode/keywords.txt b/libraries/BurstMode/keywords.txt
@@ -0,0 +1,16 @@
+# Syntax Coloring Map For 'libraries/BurstMode'
+
+# Datatypes (KEYWORD1)
+
+
+# Functions (KEYWORD2)
+enableBurstMode KEYWORD2
+disableBurstMode KEYWORD2
+getCpuFreqMHz KEYWORD2
+
+# Structures (KEYWORD3)
+
+# Constants (LITERAL1)
+
+# Properties (LITERAL2)
+
diff --git a/libraries/BurstMode/library.properties b/libraries/BurstMode/library.properties
@@ -0,0 +1,9 @@
+name=BurstMode
+version=2.0.0
+author=SparkFun Electronics
+maintainer=SparkFun Electronics <sparkfun.com>
+sentence=Burst Mode library for the SparkFun Artemis
+paragraph=Allows for enabling, disabling, and checking status of burst mode which changes the clock from 48Mhz to 96Mhz
+category=
+url=
+architectures=apollo3
diff --git a/libraries/BurstMode/src/BurstMode.cpp b/libraries/BurstMode/src/BurstMode.cpp
@@ -0,0 +1,50 @@
+#include "BurstMode.h"
+
+uint32_t cpuFreq = 48000000; //At POR core is 48MHz
+
+//Turns main processor from 48MHz to 96MHz
+//Returns false if burst mode failed to enable
+bool enableBurstMode(void)
+{
+    // Check that the Burst Feature is available.
+    am_hal_burst_avail_e eBurstModeAvailable;
+    if (AM_HAL_STATUS_SUCCESS != am_hal_burst_mode_initialize(&eBurstModeAvailable))
+    {
+        return (false);
+    }
+
+    // Put the MCU into "Burst" mode.
+    am_hal_burst_mode_e eBurstMode;
+    if (AM_HAL_STATUS_SUCCESS != am_hal_burst_mode_enable(&eBurstMode))
+    {
+        return (false);
+    }
+    cpuFreq = 96000000;
+    return (true);
+}
+
+//Turns main processor from 96MHz to 48MHz
+//Returns false if disable fails
+bool disableBurstMode(void)
+{
+    am_hal_burst_mode_e eBurstMode;
+    if (AM_HAL_STATUS_SUCCESS == am_hal_burst_mode_disable(&eBurstMode))
+    {
+        if (AM_HAL_NORMAL_MODE != eBurstMode)
+        {
+            return (false);
+        }
+    }
+    else
+    {
+        return (false);
+    }
+    cpuFreq = 48000000;
+    return (true);
+}
+
+//Returns the current core speed
+uint32_t getCpuFreqMHz(void)
+{
+    return (cpuFreq);
+}
diff --git a/libraries/BurstMode/src/BurstMode.h b/libraries/BurstMode/src/BurstMode.h
@@ -0,0 +1,31 @@
+/*
+Copyright (c) 2019 SparkFun Electronics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+#ifndef _AP3_CLOCK_SOURCES_H_
+#define _AP3_CLOCK_SOURCES_H_
+
+#include "Arduino.h"
+
+bool enableBurstMode();
+bool disableBurstMode();
+uint32_t getCpuFreqMHz();
+
+#endif //_AP3_GPIO_H_
