Merge branch 'master' into matrixportal

Author: ladyada

.github/workflows/githubci.yml

@@ -49,11 +49,15 @@ jobs:
         arduino-cli core update-index --additional-urls $BSP_URL        
         arduino-cli core install arduino:samd --additional-urls $BSP_URL
         arduino-cli core install adafruit:samd --additional-urls $BSP_URL
-        # Repalce release BSP with our code
+        # Replace release BSP with our code
         BSP_VERSION=`eval ls $HOME/$BSP_PATH`
         rm -r $HOME/$BSP_PATH/*
         ln -s $GITHUB_WORKSPACE $HOME/$BSP_PATH/$BSP_VERSION
         arduino-cli lib install $LIB_DEPS
 
     - name: Build examples
       run: python3 extras/build_all.py ${{ matrix.arduino-platform }}
+
+    # How to mark this as allowed-to-fail?
+    - name: Build examples (-Wall)
+      run: python3 extras/build_all.py --all_warnings --warnings_do_not_cause_job_failure

cores/arduino/SERCOM.h

@@ -248,7 +248,7 @@ class SERCOM
 		uint32_t getFreqRef(void) { return freqRef; };
 #else
 		// The equivalent SAMD21 dummy functions...
-		void setClockSource(__attribute__((unused)) int8_t idx, __attribute__((unused)) SercomClockSource src, __attribute__((unused)) bool core) { };
+		void setClockSource(int8_t idx, SercomClockSource src, bool core) { (void)idx; (void)src; (void)core; };
 		SercomClockSource getClockSource(void) { return SERCOM_CLOCK_SOURCE_FCPU; };
 		uint32_t getFreqRef(void) { return F_CPU; };
 #endif

cores/arduino/Tone.cpp

@@ -20,12 +20,6 @@
 #include "Tone.h"
 #include "variant.h"
 
-#if defined(__SAMD51__) 
-#define WAIT_TC16_REGS_SYNC(x) while(x->COUNT16.SYNCBUSY.bit.ENABLE);
-#else
-#define WAIT_TC16_REGS_SYNC(x) while(x->COUNT16.STATUS.bit.SYNCBUSY);
-#endif
-
 uint32_t toneMaxFrequency = F_CPU / 2;
 uint32_t lastOutputPin = 0xFFFFFFFF;
 
@@ -37,22 +31,24 @@ volatile bool toneIsActive = false;
 volatile bool firstTimeRunning = false;
 
 #if defined(__SAMD51__)
-#define TONE_TC         TC0
-#define TONE_TC_IRQn    TC0_IRQn
-#define TONE_TC_GCLK_ID	TC0_GCLK_ID
+  #define TONE_TC         TC0
+  #define TONE_TC_IRQn    TC0_IRQn
+  #define TONE_TC_GCLK_ID	TC0_GCLK_ID
+  #define Tone_Handler    TC0_Handler
+
+  #define WAIT_TC16_REGS_SYNC(x) while(x->COUNT16.SYNCBUSY.bit.ENABLE);
+
 #else
-#define TONE_TC         TC5
-#define TONE_TC_IRQn    TC5_IRQn
+  #define TONE_TC         TC5
+  #define TONE_TC_IRQn    TC5_IRQn
+  #define Tone_Handler    TC5_Handler
+
+  #define WAIT_TC16_REGS_SYNC(x) while(x->COUNT16.STATUS.bit.SYNCBUSY);
 #endif
+
 #define TONE_TC_TOP     0xFFFF
 #define TONE_TC_CHANNEL 0
 
-#if defined(__SAMD51__)
-void TC0_Handler (void) __attribute__ ((weak, alias("Tone_Handler")));
-#else
-void TC5_Handler (void) __attribute__ ((weak, alias("Tone_Handler")));
-#endif
-
 static inline void resetTC (Tc* TCx)
 {
   // Disable TCx
@@ -72,6 +68,14 @@ void toneAccurateClock (uint32_t accurateSystemCoreClockFrequency)
 
 void tone (uint32_t outputPin, uint32_t frequency, uint32_t duration)
 {
+
+  // Avoid divide by zero error by calling 'noTone' instead
+  if (frequency == 0)
+  {
+    noTone(outputPin);
+    return;
+  }
+
   // Configure interrupt request
   NVIC_DisableIRQ(TONE_TC_IRQn);
   NVIC_ClearPendingIRQ(TONE_TC_IRQn);
@@ -90,9 +94,6 @@ void tone (uint32_t outputPin, uint32_t frequency, uint32_t duration)
     while (GCLK->STATUS.bit.SYNCBUSY);
 #endif
   }
-
-  //if it's a rest, set to 1Hz (below audio range)
-  frequency = (frequency > 0 ? frequency : 1);
 
   if (toneIsActive && (outputPin != lastOutputPin))
     noTone(lastOutputPin);
@@ -167,8 +168,8 @@ void tone (uint32_t outputPin, uint32_t frequency, uint32_t duration)
     lastOutputPin = outputPin;
     digitalWrite(outputPin, LOW);
     pinMode(outputPin, OUTPUT);
+    toneIsActive = true;
   }
-  toneIsActive = true;
 
   // Enable TONE_TC
   TONE_TC->COUNT16.CTRLA.reg |= TC_CTRLA_ENABLE;
@@ -179,9 +180,19 @@ void tone (uint32_t outputPin, uint32_t frequency, uint32_t duration)
 
 void noTone (uint32_t outputPin)
 {
-  resetTC(TONE_TC);
-  digitalWrite(outputPin, LOW);
-  toneIsActive = false;
+  /* 'tone' need to run at least once in order to enable GCLK for
+   * the timers used for the tone-functionality. If 'noTone' is called
+   * without ever calling 'tone' before then 'WAIT_TC16_REGS_SYNC(TCx)'
+   * will wait infinitely. The variable 'firstTimeRunning' is set the
+   * 1st time 'tone' is set so it can be used to detect wether or not
+   * 'tone' has been called before.
+   */
+  if(firstTimeRunning)
+  {
+    resetTC(TONE_TC);
+    digitalWrite(outputPin, LOW);
+    toneIsActive = false;
+  }
 }
 
 #ifdef __cplusplus

cores/arduino/WInterrupts.c

@@ -250,8 +250,9 @@ void detachInterrupt(uint32_t pin)
  * External Interrupt Controller NVIC Interrupt Handler
  */
 #if defined(__SAMD51__)
-void InterruptHandler(uint32_t i)
+void InterruptHandler(uint32_t unused_i)
 {
+  (void)unused_i;
   // Calling the routine directly from -here- takes about 1us
   // Depending on where you are in the list it will take longer
 

cores/arduino/math_helper.c

@@ -165,18 +165,18 @@ uint32_t arm_compare_fixed_q15(q15_t *pIn, q15_t * pOut, uint32_t numSamples)
 {
   uint32_t i; 
   int32_t diff;
-  uint32_t diffCrnt;
+  uint32_t diffCrnt = 0;
   uint32_t maxDiff = 0;
 
   for (i = 0; i < numSamples; i++)
   {
-  	diff = pIn[i] - pOut[i];
-  	diffCrnt = (diff > 0) ? diff : -diff;
+    diff = pIn[i] - pOut[i];
+    diffCrnt = (uint32_t)( (diff > 0) ? diff : -diff );
 
-	if(diffCrnt > maxDiff)
-	{
-		maxDiff = diffCrnt;
-	}	
+    if(diffCrnt > maxDiff)
+    {
+      maxDiff = diffCrnt;
+    }
   }
 
   return(maxDiff);
@@ -194,18 +194,18 @@ uint32_t arm_compare_fixed_q31(q31_t *pIn, q31_t * pOut, uint32_t numSamples)
 {
   uint32_t i; 
   int32_t diff;
-  uint32_t diffCrnt;
+  uint32_t diffCrnt = 0;
   uint32_t maxDiff = 0;
 
   for (i = 0; i < numSamples; i++)
   {
-  	diff = pIn[i] - pOut[i];
-  	diffCrnt = (diff > 0) ? diff : -diff;
+    diff = pIn[i] - pOut[i];
+    diffCrnt = (uint32_t)( (diff > 0) ? diff : -diff );
 
-	if(diffCrnt > maxDiff)
-	{
-		maxDiff = diffCrnt;
-	}
+    if(diffCrnt > maxDiff)
+    {
+      maxDiff = diffCrnt;
+    }
   }
 
   return(maxDiff);

extras/build_all.py

@@ -3,37 +3,51 @@
 import sys
 import subprocess
 import time
+import argparse
+
+FQBN_PREFIX='adafruit:samd:adafruit_'
+
+
+parser = argparse.ArgumentParser(
+    description='python wrapper for adafruit arduino CI workflows',
+    allow_abbrev=False
+    )
+parser.add_argument(
+    '--all_warnings', '--Wall',
+    action='store_true',
+    help='build with all warnings enabled (`--warnings all`)',
+    )
+parser.add_argument(
+    '--warnings_do_not_cause_job_failure',
+    action='store_true',
+    help='failed builds will be listed as failed, but not cause job to exit with an error status',
+    )
+parser.add_argument(
+    'build_boards',
+    metavar='board',
+    nargs='*',
+    help='list of boards to be built -- Note that the fqbn is created by prepending "{}"'.format(FQBN_PREFIX),
+    default= [ 'metro_m0', 'metro_m4', 'circuitplayground_m0' ]
+    )
+args = parser.parse_args()
 
-all_warnings = False
 exit_status = 0
 success_count = 0
 fail_count = 0
 skip_count = 0
-
 build_format = '| {:22} | {:30} | {:9} '
 build_separator = '-' * 80
 
-default_boards = [ 'metro_m0', 'metro_m4', 'circuitplayground_m0']
-
-build_boards = []
-
-# build all variants if input not existed
-if len(sys.argv) > 1:
-    build_boards.append(sys.argv[1])
-else:
-    build_boards = default_boards
-
-def errorOutputFilter(line):
+def errorOutputFilter(line: str):
     if len(line) == 0:
         return False
     if line.isspace(): # Note: empty string does not match here!
         return False
     # TODO: additional items to remove?
     return True
 
-
-def build_examples(variant):
-    global exit_status, success_count, fail_count, skip_count, build_format, build_separator
+def build_examples(variant: str):
+    global args, exit_status, success_count, fail_count, skip_count, build_format, build_separator
 
     print('\n')
     print(build_separator)
@@ -42,7 +56,7 @@ def build_examples(variant):
     print((build_format + '| {:6} |').format('Library', 'Example', 'Result', 'Time'))
     print(build_separator)
 
-    fqbn = "adafruit:samd:adafruit_{}".format(variant)
+    fqbn = "{}{}".format(FQBN_PREFIX, variant)
 
     for sketch in glob.iglob('libraries/**/*.ino', recursive=True):
         start_time = time.monotonic()
@@ -58,14 +72,14 @@ def build_examples(variant):
             # TODO - preferably, would have STDERR show up in **both** STDOUT and STDERR.
             #        preferably, would use Python logging handler to get both distinct outputs and one merged output
             #        for now, split STDERR when building with all warnings enabled, so can detect warning/error output.
-            if all_warnings:
+            if args.all_warnings:
                 build_result = subprocess.run("arduino-cli compile --warnings all --fqbn {} {}".format(fqbn, sketch), shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
             else:
                 build_result = subprocess.run("arduino-cli compile --warnings default --fqbn {} {}".format(fqbn, sketch), shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
 
             # get stderr into a form where len(warningLines) indicates a true warning was output to stderr
             warningLines = [];
-            if all_warnings and build_result.stderr:
+            if args.all_warnings and build_result.stderr:
                 tmpWarningLines = build_result.stderr.decode("utf-8").splitlines()
                 warningLines = list(filter(errorOutputFilter, (tmpWarningLines)))
 
@@ -74,7 +88,8 @@ def build_examples(variant):
                 success = "\033[31mfailed\033[0m   "
                 fail_count += 1
             elif len(warningLines) != 0:
-                exit_status = -1
+                if not args.warnings_do_not_cause_job_failure:
+                    exit_status = -1
                 success = "\033[31mwarnings\033[0m "
                 fail_count += 1
             else:
@@ -98,7 +113,7 @@ def build_examples(variant):
 
 build_time = time.monotonic()
 
-for board in build_boards:
+for board in args.build_boards:
     build_examples(board)
 
 print(build_separator)

libraries/Adafruit_ZeroDMA/examples/zerodma_memcpy/zerodma_memcpy.ino

@@ -17,6 +17,7 @@ volatile bool transfer_is_done = false; // Done yet?
 
 // Callback for end-of-DMA-transfer
 void dma_callback(Adafruit_ZeroDMA *dma) {
+  (void)dma; // avoid compiler warning about unused function parameter
   transfer_is_done = true;
 }
 

libraries/Adafruit_ZeroDMA/examples/zerodma_spi1/zerodma_spi1.ino

@@ -19,6 +19,7 @@ volatile bool transfer_is_done = false; // Done yet?
 
 // Callback for end-of-DMA-transfer
 void dma_callback(Adafruit_ZeroDMA *dma) {
+  (void)dma; // avoid compiler warning about unused parameter
   transfer_is_done = true;
 }
 

libraries/Adafruit_ZeroDMA/examples/zerodma_spi2/zerodma_spi2.ino

@@ -33,6 +33,7 @@ volatile bool transfer_is_done = true; // Done yet?
 
 // Callback for end-of-DMA-transfer
 void dma_callback(Adafruit_ZeroDMA *dma) {
+  (void)dma; // avoid compiler warning about unused parameter
   transfer_is_done = true;
 }