Support for SAMD51 timer3 if timer 5 is not available (Adafruit ItsyBitsy M4)

ArminJo · ArminJo · commit 29613aced6d7 · 2024-11-05T23:24:52.000+01:00
diff --git a/.github/workflows/LibraryBuild.yml b/.github/workflows/LibraryBuild.yml
@@ -57,6 +57,7 @@ jobs:
           - arduino:samd:arduino_zero_native
           - arduino:renesas_uno:unor4wifi
           - adafruit:samd:adafruit_metro_m4:cache=on,speed=120,opt=small,maxqspi=50,usbstack=arduino,debug=off
+          - adafruit:samd:adafruit_itsybitsy_m4
           - arduino:mbed:nano33ble
           - arduino:mbed_rp2040:pico
           - rp2040:rp2040:arduino_nano_connect
@@ -153,6 +154,13 @@ jobs:
             build-properties: # the flags were put in compiler.cpp.extra_flags
               IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750
 
+          - arduino-boards-fqbn: adafruit:samd:adafruit_itsybitsy_m4
+            platform-url: https://adafruit.github.io/arduino-board-index/package_adafruit_index.json
+            sketches-exclude: TinyReceiver,IRDispatcherDemo
+            build-properties: # the flags were put in compiler.cpp.extra_flags
+              IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750
+
+
           - arduino-boards-fqbn: arduino:mbed:nano33ble
             build-properties: # the flags were put in compiler.cpp.extra_flags
               IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750
diff --git a/README.md b/README.md
@@ -906,7 +906,7 @@ ATtiny boards are only tested with [ATTinyCore](https://github.com/SpenceKonde/A
 - ATmega4809 (Nano every)
 - ATtiny3217 (Tiny Core 32 Dev Board)
 - ATtiny84, 85, 167 (Digispark + Digispark Pro)
-- SAMD21 (Zero, MKR*, **but not SAMD51 and not DUE, the latter is SAM architecture**)
+- SAMD (Zero, MKR*, **but not DUE, the latter is SAM architecture**)
 - ESP8266
 - ESP32 (ESP32-C3 since board package 2.0.2 from Espressif)
 - Sparkfun Pro Micro
diff --git a/changelog.md b/changelog.md
@@ -3,6 +3,7 @@ The latest version may not be released!
 See also the commit log at github: https://github.com/Arduino-IRremote/Arduino-IRremote/commits/master
 
 # 4.4.2
+- Support for SAMD51 timer3 if timer 5 is not available (Adafruit ItsyBitsy M4)
 
 # 4.4.1
 - Support for ESP core 3.x by akellai.
diff --git a/examples/AllProtocolsOnLCD/PinDefinitionsAndMore.h b/examples/AllProtocolsOnLCD/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/ControlRelay/PinDefinitionsAndMore.h b/examples/ControlRelay/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/IRDispatcherDemo/PinDefinitionsAndMore.h b/examples/IRDispatcherDemo/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/IRremoteExtensionTest/PinDefinitionsAndMore.h b/examples/IRremoteExtensionTest/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/MicroGirs/PinDefinitionsAndMore.h b/examples/MicroGirs/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/ReceiveAndSend/PinDefinitionsAndMore.h b/examples/ReceiveAndSend/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/ReceiveAndSendDistanceWidth/PinDefinitionsAndMore.h b/examples/ReceiveAndSendDistanceWidth/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/ReceiveAndSendHob2Hood/PinDefinitionsAndMore.h b/examples/ReceiveAndSendHob2Hood/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/ReceiveDemo/PinDefinitionsAndMore.h b/examples/ReceiveDemo/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/ReceiveDump/PinDefinitionsAndMore.h b/examples/ReceiveDump/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/ReceiveOneAndSendMultiple/PinDefinitionsAndMore.h b/examples/ReceiveOneAndSendMultiple/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/SendAndReceive/PinDefinitionsAndMore.h b/examples/SendAndReceive/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/SendBoseWaveDemo/PinDefinitionsAndMore.h b/examples/SendBoseWaveDemo/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/SendDemo/PinDefinitionsAndMore.h b/examples/SendDemo/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/SendLGAirConditionerDemo/PinDefinitionsAndMore.h b/examples/SendLGAirConditionerDemo/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/SendProntoDemo/PinDefinitionsAndMore.h b/examples/SendProntoDemo/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/SendRawDemo/PinDefinitionsAndMore.h b/examples/SendRawDemo/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/SimpleReceiver/PinDefinitionsAndMore.h b/examples/SimpleReceiver/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/SimpleReceiverForHashCodes/PinDefinitionsAndMore.h b/examples/SimpleReceiverForHashCodes/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/SimpleReceiverWithCallback/PinDefinitionsAndMore.h b/examples/SimpleReceiverWithCallback/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/SimpleSender/PinDefinitionsAndMore.h b/examples/SimpleSender/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/TinyReceiver/PinDefinitionsAndMore.h b/examples/TinyReceiver/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/examples/TinySender/PinDefinitionsAndMore.h b/examples/TinySender/PinDefinitionsAndMore.h
@@ -39,7 +39,7 @@
  * ATtiny1604   2           3|PA5       %
  * ATtiny816   14|PA1      16|PA3       1|PA5     MegaTinyCore
  * ATtiny1614   8|PA1      10|PA3       1|PA5     MegaTinyCore
- * SAMD21       3           4           5
+ * SAMD         2           3           4
  * ESP8266      14|D5       12|D6       %
  * ESP32        15          4          27
  * ESP32-C3     2           3           4
diff --git a/src/TinyIRReceiver.hpp b/src/TinyIRReceiver.hpp
@@ -84,7 +84,7 @@
 //#define USE_ONKYO_PROTOCOL    // Like NEC, but take the 16 bit address and command each as one 16 bit value and not as 8 bit normal and 8 bit inverted value.
 //#define USE_FAST_PROTOCOL     // Use FAST protocol instead of NEC / ONKYO.
 //#define ENABLE_NEC2_REPEATS // Instead of sending / receiving the NEC special repeat code, send / receive the original frame for repeat.
-#include "TinyIR.h" // If not defined, it defines IR_RECEIVE_PIN, IR_FEEDBACK_LED_PIN and TINY_RECEIVER_USE_ARDUINO_ATTACH_INTERRUPT
+#include "TinyIR.h"
 
 #include "digitalWriteFast.h"
 /** \addtogroup TinyReceiver Minimal receiver for NEC and FAST protocol
@@ -110,6 +110,8 @@ volatile TinyIRReceiverCallbackDataStruct TinyIRReceiverData;
 /*
  * Set input pin and output pin definitions etc.
  */
+//#define IR_RECEIVE_PIN          2
+//#define IR_FEEDBACK_LED_PIN     LED_BUILTIN
 #if defined(IR_INPUT_PIN)
 #warning "IR_INPUT_PIN is deprecated, use IR_RECEIVE_PIN"
 #define IR_RECEIVE_PIN  IR_INPUT_PIN
@@ -129,7 +131,7 @@ volatile TinyIRReceiverCallbackDataStruct TinyIRReceiverData;
 #endif
 
 #if !defined(IR_FEEDBACK_LED_PIN) && defined(LED_BUILTIN)
-#define IR_FEEDBACK_LED_PIN    LED_BUILTIN
+#define IR_FEEDBACK_LED_PIN     LED_BUILTIN
 #endif
 
 #if !( \
diff --git a/src/private/IRTimer.hpp b/src/private/IRTimer.hpp
@@ -48,7 +48,7 @@ void timerConfigForReceive();           // Initialization of 50 us timer, interr
 void timerEnableReceiveInterrupt();     // Enable interrupts of an initialized timer
 void timerDisableReceiveInterrupt();    // Disable interrupts of an initialized timer
 void timerResetInterruptPending();      // ISR helper function for some architectures, which require a manual reset
-                                        // of the pending interrupt (TIMER_REQUIRES_RESET_INTR_PENDING is defined). Otherwise empty.
+// of the pending interrupt (TIMER_REQUIRES_RESET_INTR_PENDING is defined). Otherwise empty.
 
 void timerConfigForSend(uint16_t aFrequencyKHz); // Initialization of timer hardware generated PWM, if defined(SEND_PWM_BY_TIMER)
 void enableSendPWMByTimer();            // Switch on PWM generation
@@ -1581,8 +1581,13 @@ void timerConfigForSend(uint16_t aFrequencyKHz) {
 
 #  if !defined(IR_SAMD_TIMER)
 #    if defined(__SAMD51__)
+#      if defined(TC5)
 #define IR_SAMD_TIMER       TC5
 #define IR_SAMD_TIMER_IRQ   TC5_IRQn
+#      else
+#define IR_SAMD_TIMER       TC3
+#define IR_SAMD_TIMER_IRQ   TC3_IRQn
+#      endif
 #    else
 // SAMD21
 #define IR_SAMD_TIMER       TC3
@@ -1617,7 +1622,11 @@ void timerConfigForReceive() {
 
 #  if defined(__SAMD51__)
     // Enable the TC5 clock, use generic clock generator 0 (F_CPU) for TC5
+#    if defined(TC5_GCLK_ID)
     GCLK->PCHCTRL[TC5_GCLK_ID].reg = GCLK_PCHCTRL_GEN_GCLK0_Val | (1 << GCLK_PCHCTRL_CHEN_Pos);
+#    else
+    GCLK->PCHCTRL[TC3_GCLK_ID].reg = GCLK_PCHCTRL_GEN_GCLK0_Val | (1 << GCLK_PCHCTRL_CHEN_Pos);
+#    endif
 
     // The TC should be disabled before the TC is reset in order to avoid undefined behavior.
     TC->CTRLA.reg &= ~TC_CTRLA_ENABLE; // Disable the Timer
@@ -1674,18 +1683,12 @@ void timerConfigForReceive() {
 }
 
 #  if !defined(DISABLE_CODE_FOR_RECEIVER)
-#    if defined(__SAMD51__)
-void TC5_Handler(void) {
-    TcCount16 *TC = (TcCount16*) IR_SAMD_TIMER;
-    // Check for right interrupt bit
-    if (TC->INTFLAG.bit.MC0 == 1) {
-        // reset bit for next turn
-        TC->INTFLAG.bit.MC0 = 1;
-        IRReceiveTimerInterruptHandler();
-    }
-}
+#    if defined(__SAMD51__) && defined(TC5)
+void TC5_Handler(void)
 #    else
-void TC3_Handler(void) {
+void TC3_Handler(void)
+#    endif // defined(__SAMD51__)
+{
     TcCount16 *TC = (TcCount16*) IR_SAMD_TIMER;
     // Check for right interrupt bit
     if (TC->INTFLAG.bit.MC0 == 1) {
@@ -1694,7 +1697,6 @@ void TC3_Handler(void) {
         IRReceiveTimerInterruptHandler();
     }
 }
-#    endif // defined(__SAMD51__)
 #  endif // !defined(DISABLE_CODE_FOR_RECEIVER)
 
 /***************************************
