just a change or two...

Author: SpenceKonde

ChangeLog.md

@@ -13,9 +13,14 @@ These items are in addition to what was listed under changes already in release.
 
 ## 1.6.0
 These are typically planned for release in a future version (usually the next one) as noted.
-* Add support for not-yet-announced S class DA-series parts, which are identical but for having the new EB-series lockdown thingie. There are no changes needed.
 * Support for the PTC peripheral on DA parts
-* Correct bug with EA-series parts having the SYSCFG0 fuse burned incorrectly. This would brick any EA-series part programmed. Luckily as uploading doesn't work right, few people have managed to do this.
+* Correct bug with EA-series parts having the SYSCFG0 fuse set during normal uploads, which is inappropriate, because if the UPDIPINCFG bit is not 1, the chip can only be reprogrammed with an exotic HV programmer.
+* Corrected a bug with EA-series parts incorrectly calculating the UPDIPINCFG bit as 0 in all cases. In combination with the above, unlucky users who were able to get an upload to attempt would promptly brick the chip, since nobody has HV programmers. Sorry bout that \o/ I'm not even certain there is a programming problem, or if I'd just attempted to program every chip I had mounted on a board....
+* Correct bug with EA-series parts failing to correctly configure clock speed.
+* Add support for EB-series to tools menus, permitting compile tests.
+* Brutal restructuring of Arduino.h.
+* keywords.txt for DxCore contained numerous deficiencies of varying severities. It was rebuilt de novo. Slightly less disorganized this time.
+* device_timer_pins.h design deemed hopelessly defective. Functionally identical file regenerated de novo,
 
 
 ### 1.5.11 (Emergency fix)

megaavr/boards.txt

@@ -519,7 +519,86 @@ See Ref_Analog.md for more information of the representations of "analog pins".
 
 
 #include "pins_arduino.h"
+/* The Variant file must do one of the following */
+/* 1. Use the same pin order as this core's default pin mapping (recommended)
+ * 2. Number each pin (port * 8) + bit_position, and define HYPERRATIONAL_PIN_NUMBERS (also recommended)
+ * 3. Define NONCANONICAL_PIN_NUMBERS and use any pin numbering. (recommended if you must use a layout that departs significantly from the above)
+ * 4. Define SPECIAL_PIN_NUMBERS, and provide a _digitalPinToCanon(pin) macro that takes an Arduino pin number, and returns (port * 8) + bit_position
+ *    (Only if you can do it better than the standard noncanonical implementation - that implementation is not grotesque, but it's also not great.
+ *    each table lookup takes the form lds lds add adc ld, 7 words and 10 clocks, so the whole thing is probably on the order of 20 and 26)
+ * This change permits underlying logic to be written with a single byte to represent a pin, which is present in some obscure parts of the code
+ * mostly involving interrupts.
+ * Note that for constant pins known at compile time, these should all be able to be constant folded, it's only compile time unknown pins
+ * where this applies. And only for the rare cases where we end up doing this, often interrupt related.
+ * A lot of this comes back to the question of whether to leave "holes" for missing pins in the numbering. There are two forces pulling in
+ * opposite directions here: each ghost pin takes up 4b for it's entries in the pin table (and it's sort of absurd for a 28-pin part to have
+ * 47 logical pins because they were missing PB, PE, and 4 pins of PC and PF, but they make this sort of conversion (and a number of
+ * similar ones) much easier.
+ */
 
+#if defined(NONCANONICAL_PIN_NUMBERS)
+  #define _digitalPinToCanon(pin) (((pin) < NUM_TOTAL_PINS) ? ((digital_pin_to_port[pin] << 3) + digital_pin_to_bit_position[pin] ) : NOT_A_PIN)
+#elif defined(HYPERRATIONAL_PIN_NUMBERS) /* Variant must number pins in order, and must skip numbers of pins not present on the chip. */
+  #define _digitalPinToCanon(pin) (((pin) < NUM_TOTAL_PINS) ? (pin) : NOT_A_PIN)
+#elif !defined(SPECIAL_PIN_NUMBERS)
+  #if _AVR_PINCOUNT == 64
+    #define _digitalPinToCanon(pin) (((pin) < NUM_TOTAL_PINS) ? (((pin) < PIN_PG0) ? (pin) : (((pin) > PIN_PG7) ? (pin) - 8 : (pin) + 2 )) : NOT_A_PIN)
+  #elif _AVR_PINCOUNT == 48
+    #define _digitalPinToCanon(pin) (((pin) < NUM_TOTAL_PINS) ? (((pin) < PIN_PC0) ? (pin) : (pin) + 2 ) : NOT_A_PIN)
+  #elif _AVR_PINCOUNT == 32
+    #define _digitalPinToCanon(pin) (((pin) < NUM_TOTAL_PINS) ? (((pin) <= PIN_PA7) ? (pin) : (((pin) < PIN_PD0) ? (pin) + 8 : (((pin) < PIN_PF0) ? (pin) + 12 : (pin) + 20 ))) : NOT_A_PIN)
+  #elif _AVR_PINCOUNT == 28
+    #define _digitalPinToCanon(pin) (((pin) <= PIN_PF1) ? (((pin) <= PIN_PA7) ? (pin) : (((pin) < PIN_PD0) ? (pin) + 8 : (((pin) < PIN_PF0) ? (pin) + 12 : (pin) + 20 ))) : (((pin) < NUM_TOTAL_PINS) ? (pin) + 16 : NOT_A_PIN))
+  #elif _AVR_PINCOUNT == 20 || _AVR_PINCOUNT == 14
+    #define _digitalPinToCanon(pin) (((pin) < PIN_PF6) ? (((pin) <= PIN_PC0) ? (pin) : (((pin) < PIN_PD0) ? (pin) + 8 : (pin) + 12)) : (((pin) < NUM_TOTAL_PINS) ? (pin) + 26 : NOT_A_PIN))
+  #endif
+#else
+  #if !defined(_digitalPinToCanon)
+    #error "Your custom variant says it provides a _digitalPinToCanon (SPECIAL_PIN_NUMBERS defined) but you don't provide one. \n Define NONCANONICAL_PIN_NUMBERS instead to use a possibly slower handler for the general case"
+  #endif
+#endif
+  // this stuff used to be in the variants.
+#if !defined(NUM_DIGITAL_PINS)
+/* Despite the name, this actually is a number 1 higher than the highest valid number for a digital pin
+ * that is, it's the first integer which does not refer to a pin, and the number of digital pins if there
+ * were no gaps in the numbering. Almost every pin mapping has gaps.
+ * Tests like if (pin >= NUM_DIGITAL_PIN) return; are ubiquitous.
+ * So we need to make our NUM_DIGITAL_PINS work like that.
+ */
+  #if defined(PIN_PG7) // if there's a PORTG, that's the last pin. Add 1 to get the first non-pin
+    #define NUM_DIGITAL_PINS            (PIN_PG7 + 1)
+  #elif defined(PIN_PF7)  // if the UPDI pin, PF7 is defined (ie, UPDI can be prorgrammed as GPIO)
+    #define NUM_DIGITAL_PINS            (PIN_PF7 + 1)
+  #elif defined(PIN_PF6)  // otherwise it should be the reset pin, PG6.
+    #define NUM_DIGITAL_PINS            (PIN_PF6 + 1)
+  #else
+    #error "The variant file is incorrect, as it indicates no PG7, PF7 or PF6. All supported and announced parts have one or more of those pins."
+  #endif
+#endif
+#if !defined(NUM_RESERVED_PINS)
+  #define NUM_RESERVED_PINS             (0)
+#endif
+#if !defined(NUM_INTERNALLY_USED_PINS)
+  #if ((CLOCK_SOURCE & 0x03) == 1)
+    #define NUM_INTERNALLY_USED_PINS    (2) // External crystal takes PA0 and PA1
+  #elif ((CLOCK_SOURCE & 0x03) == 2)
+    #define NUM_INTERNALLY_USED_PINS    (1) // External clock takes out PA0
+  #else
+    #define NUM_INTERNALLY_USED_PINS    (0)
+  #endif
+#endif
+#if !defined(NUM_I2C_PINS)
+  #define NUM_I2C_PINS                  (2) // per I2C port in use - this number is nonsensical without qualification is is only for compatibility.
+#endif
+#if !defined(NUM_SPI_PINS)
+  #define NUM_SPI_PINS                  (3) // per SPI port in use - this number is nonsensical without qualification is is only for compatibility.
+#endif
+#if !defined(NUM_TOTAL_FREE_PINS)
+  #define NUM_TOTAL_FREE_PINS           (PINS_COUNT - NUM_INTERNALLY_USED_PINS)
+#endif
+#if !defined(NUM_TOTAL_PINS)
+  #define NUM_TOTAL_PINS                (NUM_DIGITAL_PINS) /* Used the same way as NUM_DIGITAL_PINS. so it doesn't mean what it's named  - I didn't make the convention*/
+#endif
 #define CHANNEL0_UNCHANGED    (0x40)
 #define CHANNEL1_UNCHANGED    (0x41)
 
@@ -589,7 +668,7 @@ inline __attribute__((always_inline)) void check_valid_digital_pin(pin_size_t pi
     // Passing -1/255/NOT_A_PIN to the digital I/O functions is most likely intentional.
       badArg("Digital pin is constant, but not a valid pin");
     }
-    #if (CLOCK_SOURCE == 2)
+    #if (((CLOCK_SOURCE & 0x03) == 2))
       #if defined(MEGATINYCORE)
         if (pin == PIN_PA3) {
           badArg("Constant digital pin PIN_PA3 is used for the external osc, and is not available for other uses.");
@@ -599,7 +678,7 @@ inline __attribute__((always_inline)) void check_valid_digital_pin(pin_size_t pi
           badArg("Constant digital pin PIN_PA0 is used for the external osc, and is not available for other uses.");
         }
       #endif
-    #elif CLOCK_SOURCE == 1
+    #elif ((CLOCK_SOURCE & 0x03) == 1)
       if (pin < 2) {
         badArg("Pin PA0 and PA1 cannot be used for digital I/O because those are used for external crystal clock.");
       }

megaavr/cores/dxcore/Arduino.h

@@ -306,7 +306,7 @@
   #if defined(USART0)
     const uint8_t _usart0_pins[][USART_PINS_WIDTH] PROGMEM = {
       #if (defined(HWSERIAL0_MUX))
-        #if (defined(PIN_HWSERIAL0_TX) && defined(PIN_HWSERIAL0_RX) && defined(PIN_HWSERIAL0_XCK) && defined(PIN_HWSERIAL0_XDIR) && ((PIN_HWSERIAL0_TX != NOT_A_PIN && CLOCK_SOURCE == 0) || (PIN_HWSERIAL0_RX != NOT_A_PIN && CLOCK_SOURCE != 1)))
+        #if (defined(PIN_HWSERIAL0_TX) && defined(PIN_HWSERIAL0_RX) && defined(PIN_HWSERIAL0_XCK) && defined(PIN_HWSERIAL0_XDIR) && ((PIN_HWSERIAL0_TX != NOT_A_PIN && ((CLOCK_SOURCE & 0x03) == 0)) || (PIN_HWSERIAL0_RX != NOT_A_PIN && CLOCK_SOURCE != 1)))
           #if !defined(HWSERIAL0_MUX_DEFAULT)
             #define HWSERIAL0_MUX_DEFAULT (HWSERIAL0_MUX)
           #endif

megaavr/cores/dxcore/UART_swap.h

@@ -77,25 +77,25 @@
 #endif
 
 #if defined(TCF0)
-  #if (CLOCK_SOURCE == 0)
+  #if (((CLOCK_SOURCE & 0x03) == 0))
     #define PIN_TCF0_WO0_DEFAULT          PIN_PA0
   #else
     #define PIN_TCF0_WO0_DEFAULT          NOT_A_PIN
   #endif
-  #if (CLOCK_SOURCE == 1)
+  #if (((CLOCK_SOURCE & 0x03) == 1))
     #define PIN_TCF0_WO1_DEFAULT          NOT_A_PIN
   #else
     #define PIN_TCF0_WO1_DEFAULT          PIN_PA1
   #endif
 #endif
 
 #if defined(TCA0)
-  #if (CLOCK_SOURCE == 0) // PA0 only available when using internal oscillator.
+  #if (((CLOCK_SOURCE & 0x03) == 0)) // PA0 only available when using internal oscillator.
     #define PIN_TCA0_WO0_DEFAULT    PIN_PA0
   #else
     #define PIN_TCA0_WO0_DEFAULT    NOT_A_PIN
   #endif
-  #if (CLOCK_SOURCE == 1) // crystal doesn't have PA1 available either
+  #if (((CLOCK_SOURCE & 0x03) == 1)) // crystal doesn't have PA1 available either
     #define PIN_TCA0_WO1_DEFAULT    NOT_A_PIN
   #else
     #define PIN_TCA0_WO1_DEFAULT    PIN_PA1

megaavr/cores/dxcore/device_timer_pins.h

@@ -259,7 +259,7 @@
       #define TIMERD0_WGMODE_SETTING (TCD_WGMODE_ONERAMP_gc)
     #endif
     #if !defined(TIMERD0_CLOCK_SETTING)
-      #if (CLOCK_SOURCE != 0)
+      #if (((CLOCK_SOURCE & 0x03) == 0))
         /*
         This is ALSO almost indistinguishable! Same F_PWM, but lower internal frequency.
         Sync is slower. but the bugs with TCD async events won't happen, and it's easier to do wacky stuff with the PROGEV.

megaavr/cores/dxcore/timers.h

@@ -2027,7 +2027,7 @@ void nudge_millis(__attribute__((unused)) uint16_t nudgesize) {
 
 // These are defaults that could be overridden by variant or arguments passed to compiler
 // They are only relevant for the case of using a crystal.
-#if CLOCK_SOURCE == 1 && defined(CLKCTRL_FRQRANGE_gm)
+#if ((CLOCK_SOURCE & 0x03) == 1) && defined(CLKCTRL_FRQRANGE_gm)
   // In a quick test, with terrible layout (strip-board), I could run a 16 MHz crystal with any of these options!
   // it was an 18 pf crystal with parasitic capacitance of stripboard as loading. User can force it to desired value
   // but nobody is likely to care. Lower speed settings use less power, I *think* - but the datasheet has nothing
@@ -2051,7 +2051,7 @@ void nudge_millis(__attribute__((unused)) uint16_t nudgesize) {
 #endif
 #if (defined(__AVR_DA__) || defined(__AVR_DB__) || defined(__AVR_DD__) || defined(__AVR_DU__))
   void  __attribute__((weak)) init_clock() {
-    #if CLOCK_SOURCE == 0
+    #if ((CLOCK_SOURCE & 0x03) == 0)
       /* internal can be cranked up to 32 Mhz by just extending the prior pattern from 24 to 28 and 32.
        *  F_CPU    CLKCTRL_FREQSEL or FRQSEL depending on ATpack version
        *  1 MHz    0x0
@@ -2142,7 +2142,7 @@ void nudge_millis(__attribute__((unused)) uint16_t nudgesize) {
       #else
         #error "F_CPU defined as an unsupported value for the internal oscillator."
       #endif
-    #elif (CLOCK_SOURCE == 1 || CLOCK_SOURCE == 2)
+    #elif (((CLOCK_SOURCE & 0x03) == 1) || ((CLOCK_SOURCE & 0x03) == 2))
     /* For this, we care very little, from the perspective of the init code, what the system frequency is - we have little choice but to
      * run at crystal frequency, and THE USER MUST TELL US WHAT THAT IS.
      * It is foolish to determine what we're running at at runtime, as the user should really knoe the basic parameters of the
@@ -2155,7 +2155,7 @@ void nudge_millis(__attribute__((unused)) uint16_t nudgesize) {
      */
       #if !defined(CLKCTRL_XOSCHFCTRLA)
         // it's an AVR DA-series or something with that version of CLKCTRL.
-        #if (CLOCK_SOURCE == 1)
+        #if (((CLOCK_SOURCE & 0x03) == 1))
           #error "AVR DA-series selected, but crystal as clock source specified. DA-series parts only support internal oscillator or external clock."
         #else
           // external clock
@@ -2174,7 +2174,7 @@ void nudge_millis(__attribute__((unused)) uint16_t nudgesize) {
         // a clock sufficiently broken that it resets instead.
         _PROTECTED_WRITE(CLKCTRL_MCLKCTRLC, CLKCTRL_CFDSRC_CLKMAIN_gc | CLKCTRL_CFDEN_bm);
         _PROTECTED_WRITE(CLKCTRL_MCLKINTCTRL, CLKCTRL_CFD_bm);
-        #if (CLOCK_SOURCE == 2)
+        #if (((CLOCK_SOURCE & 0x03) == 2))
           // external clock
           // CLKCTRL_SELHF_EXTCLOCK_gc or CLKCTRL_SELHF_EXTCLK_gc? Microchip can't seem to decide, and we can't test for it with the preprocessor because it's a bloody enumerated type.
           // 0x02 is the numeric value of that constant. I can't even provide compatibility defines, because I don't have any way to tell which one it is for a given version of the headers.
@@ -2198,7 +2198,7 @@ void nudge_millis(__attribute__((unused)) uint16_t nudgesize) {
   }
 #elif defined(__AVR_EA__)
   void  __attribute__((weak)) init_clock() {
-    #if CLOCK_SOURCE == 0
+    #if ((CLOCK_SOURCE & 0x03) == 0)
       // This sucks! Our internal clock sucks! two lousy speeds, selected by fuses? What is this, tinyAVR?
       #if F_CPU == 20000000 || F_CPU == 16000000
         _PROTECTED_WRITE(CLKCTRL_MCLKCTRLB, 0); // turn off prescaler.
@@ -2211,7 +2211,7 @@ void nudge_millis(__attribute__((unused)) uint16_t nudgesize) {
       #elif F_CPU == 1000000
         _PROTECTED_WRITE(CLKCTRL_MCLKCTRLB, 7); // /16
       #endif
-    #elif (CLOCK_SOURCE == 1 || CLOCK_SOURCE == 2)
+    #elif (((CLOCK_SOURCE & 0x03) == 1) || ((CLOCK_SOURCE & 0x03) == 2))
     /* For this, we don't really care what speed it is at - we will run at crystal frequency, and THE USER MUST TELL US WHAT THAT IS.
      * It is foolish to determine what we're running at at runtime, as the user should really know the basic parameters of the
      * board, like the speed of the crystal - it's usually printed on the damned thing. We don't prescale from crystals, eveh though
@@ -2226,7 +2226,7 @@ void nudge_millis(__attribute__((unused)) uint16_t nudgesize) {
      */
       #if !defined(CLKCTRL_XOSCHFCTRLA)
         // it's an AVR EB-series or something.
-        #if (CLOCK_SOURCE == 1)
+        #if (((CLOCK_SOURCE & 0x03) == 1))
           #error "AVR EB-series selected, but crystal as clock source specified. EB-series parts only support internal oscillator or external clock."
         #else
           // external clock
@@ -2246,7 +2246,7 @@ void nudge_millis(__attribute__((unused)) uint16_t nudgesize) {
         // to result in similar failure modes to overclocking.
         _PROTECTED_WRITE(CLKCTRL_MCLKCTRLC, CLKCTRL_CFDSRC_CLKMAIN_gc | CLKCTRL_CFDEN_bm);
         _PROTECTED_WRITE(CLKCTRL_MCLKINTCTRL, CLKCTRL_CFD_bm);
-        #if (CLOCK_SOURCE == 2)
+        #if (((CLOCK_SOURCE & 0x03) == 2))
           // external clock
           _PROTECTED_WRITE(CLKCTRL_XOSCHFCTRLA, (0x02 | CLKCTRL_ENABLE_bm));
           uint8_t i = 255;
@@ -2280,7 +2280,7 @@ void nudge_millis(__attribute__((unused)) uint16_t nudgesize) {
   }
 #elif defined(__AVR_EB__)
   void  __attribute__((weak)) init_clock() {
-    #if CLOCK_SOURCE == 0
+    #if ((CLOCK_SOURCE & 0x03) == 0)
       #if F_CPU == 20000000 || F_CPU == 16000000
         _PROTECTED_WRITE(CLKCTRL_MCLKCTRLB, 0); // turn off prescaler.
       #elif F_CPU == 10000000 || F_CPU == 8000000
@@ -2292,9 +2292,9 @@ void nudge_millis(__attribute__((unused)) uint16_t nudgesize) {
       #elif F_CPU == 1000000
         _PROTECTED_WRITE(CLKCTRL_MCLKCTRLB, 7); // /16
       #endif
-    #elif (CLOCK_SOURCE == 1)
+    #elif (((CLOCK_SOURCE & 0x03) == 1))
         #error "External high frequency crystal as clock source is not available on the EB-series"
-    #elif (CLOCK_SOURCE == 2)
+    #elif (((CLOCK_SOURCE & 0x03) == 2))
     /* For this, we don't really care what speed it is at - we will run at crystal frequency, and THE USER MUST TELL US WHAT THAT IS.
      * It is foolish to determine what we're running at at runtime, as the user should really know the basic parameters of the
      * board, like the speed of the crystal - it's usually printed on the damned thing. We don't prescale from crystals, eveh though
@@ -2357,7 +2357,7 @@ void nudge_millis(__attribute__((unused)) uint16_t nudgesize) {
  ***********************************************************************************************/
 
 
-#if (CLOCK_SOURCE == 1 || CLOCK_SOURCE == 2 || CLOCK_SOURCE == 6) // PLL here because you can
+#if (((CLOCK_SOURCE & 0x03) == 1) || ((CLOCK_SOURCE & 0x03) == 2) || CLOCK_SOURCE == 6) // PLL here because you can
   // easily exceed the max speed with the PLL clock. If this behaves like the Dx's clocking
   // the TCD, where if you push it too hard, it will vanish instead of saturating at a max
   // speed

megaavr/cores/dxcore/wiring.c

@@ -56,7 +56,7 @@ inline __attribute__((always_inline)) void check_valid_digital_pin(pin_size_t pi
     if (pin >= NUM_TOTAL_PINS && pin != NOT_A_PIN) { // Exception made for NOT_A_PIN - code exists which relies on being able to pass this and have nothing happen.
       badArg("Digital pin is constant, but not a valid pin");
     }
-  #if (CLOCK_SOURCE == 2)
+  #if (((CLOCK_SOURCE & 0x03) == 2))
     #if defined(MEGATINYCORE)
       if (pin == PIN_PA3) {
         badArg("Constant digital pin PIN_PA3 is used for the external osc, and is not available for other uses.");
@@ -66,7 +66,7 @@ inline __attribute__((always_inline)) void check_valid_digital_pin(pin_size_t pi
         badArg("Constant digital pin PIN_PA0 is used for the external osc, and is not available for other uses.");
       }
     #endif
-  #elif CLOCK_SOURCE == 1
+  #elif ((CLOCK_SOURCE & 0x03) == 1)
     if (pin < 2) {
       badArg("Pin PA0 and PA1 cannot be used for digital I/O because those are used for external crystal clock.");
     }

megaavr/extras/Ref_LTO.md

@@ -432,12 +432,12 @@ static const uint8_t A21 = PIN_A21;
   };
   // But pins that are not usable at all should be marked NOT_A_PIN here
   const uint8_t digital_pin_to_bit_position[] = {
-    #if CLOCK_SOURCE == 0 // PA0 used for external clock and crystal.
+    #if ((CLOCK_SOURCE & 0x03) == 0) // PA0 used for external clock and crystal.
       PIN0_bp,            // PA0
     #else
       NOT_A_PIN,
     #endif
-    #if CLOCK_SOURCE == 1 // PA1 also used for crystal
+    #if ((CLOCK_SOURCE & 0x03) == 1) // PA1 also used for crystal
       NOT_A_PIN,  //   1 PA1
     #else
       // PA1 used for external crystal.
@@ -487,12 +487,12 @@ static const uint8_t A21 = PIN_A21;
 
   // and down here
   const uint8_t digital_pin_to_bit_mask[] = {
-    #if CLOCK_SOURCE == 0 // PA0 used for external clock and crystal.
+    #if ((CLOCK_SOURCE & 0x03) == 0) // PA0 used for external clock and crystal.
       PIN0_bm,            // PA0
     #else
       NOT_A_PIN,
     #endif
-    #if CLOCK_SOURCE == 1 // PA1 also used for crystal
+    #if ((CLOCK_SOURCE & 0x03) == 1) // PA1 also used for crystal
       NOT_A_PIN,  //   1 PA1
     #else
       // PA1 used for external crystal.