Allow non contiguous analog pins definition

Signed-off-by: Frederic Pillon <frederic.pillon@st.com>
Co-Authored-By: MCUdude <mcudude@users.noreply.github.com>

Author: fpistm

cores/arduino/pins_arduino.h

@@ -51,17 +51,30 @@ enum {
 };
 
 // Arduino analog pins
+
 #ifndef NUM_ANALOG_INPUTS
 #define NUM_ANALOG_INPUTS 0
 #endif
+
+// If NUM_ANALOG_FIRST is not defined:
+// - Ax are not contiguous in the digitalPin array
+// - analogInPin array is available
 #ifndef NUM_ANALOG_FIRST
-#define NUM_ANALOG_FIRST NUM_DIGITAL_PINS
+#define NUM_ANALOG_FIRST          (NUM_DIGITAL_PINS + 1)
+#define NUM_ANALOG_LAST           (NUM_DIGITAL_PINS + NUM_ANALOG_INPUTS)
+#define NUM_ANALOG_INTERNAL_FIRST (NUM_ANALOG_LAST + 1)
+#else
+#define NUM_ANALOG_INTERNAL_FIRST (NUM_DIGITAL_PINS + 1)
 #endif
 
+// If NUM_ANALOG_INPUTS is not defined there is no analog pins defined.
+// Anyway ADC internal channels are always avaialable.
+#if NUM_ANALOG_INPUTS > 0
 // Analog pins must be contiguous to be able to loop on each value
 #define MAX_ANALOG_INPUTS 24
 _Static_assert(NUM_ANALOG_INPUTS <= MAX_ANALOG_INPUTS,
                "Core NUM_ANALOG_INPUTS limited to MAX_ANALOG_INPUTS");
+
 _Static_assert(NUM_ANALOG_FIRST >= NUM_ANALOG_INPUTS,
                "First analog pin value (A0) must be greater than or equal to NUM_ANALOG_INPUTS");
 
@@ -161,6 +174,7 @@ static const uint8_t A22 = PIN_A22;
 #define PIN_A23      (PIN_A22 + 1)
 static const uint8_t A23 = PIN_A23;
 #endif
+#endif /* NUM_ANALOG_INPUTS > 0 */
 
 // Default for Arduino connector compatibility
 // SPI Definitions
@@ -208,38 +222,56 @@ static const uint8_t SCL = PIN_WIRE_SCL;
 // ADC internal channels (not a pins)
 // Only used for analogRead()
 #if defined(ADC_CHANNEL_TEMPSENSOR) || defined(ADC_CHANNEL_TEMPSENSOR_ADC1)
-#define ATEMP        (NUM_DIGITAL_PINS + 1)
+#define ATEMP        (NUM_ANALOG_INTERNAL_FIRST)
 #endif
 #ifdef ADC_CHANNEL_VREFINT
-#define AVREF        (NUM_DIGITAL_PINS + 2)
+#define AVREF        (NUM_ANALOG_INTERNAL_FIRST + 2)
 #endif
 #ifdef ADC_CHANNEL_VBAT
-#define AVBAT        (NUM_DIGITAL_PINS + 3)
+#define AVBAT        (NUM_ANALOG_INTERNAL_FIRST + 3)
 #endif
 #if defined(ADC5) && defined(ADC_CHANNEL_TEMPSENSOR_ADC5)
-#define ATEMP_ADC5   (NUM_DIGITAL_PINS + 4)
+#define ATEMP_ADC5   (NUM_ANALOG_INTERNAL_FIRST + 4)
 #endif
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 extern const PinName digitalPin[];
+extern const uint32_t analogInPin[];
 
 #define NOT_AN_INTERRUPT            NC // -1
 
 // Convert a digital pin number Dxx to a PinName PX_n
 // Note: Analog pin is also a digital pin.
+#ifndef NUM_ANALOG_LAST
 #define digitalPinToPinName(p)      (((uint32_t)p < NUM_DIGITAL_PINS) ? digitalPin[p] : NC)
+#else
+#define digitalPinToPinName(p)      (((uint32_t)p < NUM_DIGITAL_PINS) ? digitalPin[p] : \
+            ((uint32_t)p >= NUM_ANALOG_FIRST) && ((uint32_t)p <= NUM_ANALOG_LAST) ? \
+                                                digitalPin[analogInPin[p-NUM_ANALOG_FIRST]] : NC)
+#endif
 // Convert a PinName PX_n to a digital pin number
 uint32_t pinNametoDigitalPin(PinName p);
 
 // Convert an analog pin number to a digital pin number
-#if defined(NUM_ANALOG_INPUTS) && (NUM_ANALOG_INPUTS>0)
+#if NUM_ANALOG_INPUTS > 0
 // Used by analogRead api to have A0 == 0
+// For contiguous analog pins definition in digitalPin array
+#ifndef NUM_ANALOG_LAST
 #define analogInputToDigitalPin(p)  (((uint32_t)p < NUM_ANALOG_INPUTS) ? (p+A0) : p)
 #else
+// For non contiguous analog pins definition in digitalPin array
+#define analogInputToDigitalPin(p)  ( \
+            ((uint32_t)p < NUM_ANALOG_INPUTS) ? analogInPin[p] : \
+            ((uint32_t)p >= NUM_ANALOG_FIRST) && ((uint32_t)p <= NUM_ANALOG_LAST) ? \
+                                                analogInPin[p-NUM_ANALOG_FIRST] : p)
+#endif // !NUM_ANALOG_LAST
+#else
+// No analog pin defined
 #define analogInputToDigitalPin(p)  (NUM_DIGITAL_PINS)
-#endif
+#endif // NUM_ANALOG_INPUTS > 0
+
 // Convert an analog pin number Axx to a PinName PX_n
 PinName analogInputToPinName(uint32_t pin);
 

variants/board_template/variant.cpp

@@ -17,7 +17,7 @@
 extern "C" {
 #endif
 
-// Pin number
+// Digital PinName array
 // This array allows to wrap Arduino pin number(Dx or x)
 // to STM32 PinName (PX_n)
 const PinName digitalPin[] = {
@@ -38,89 +38,31 @@ const PinName digitalPin[] = {
   P, //D13
   P, //D14
   P, //D15
-  P, //D16
-  P, //D17
-  P, //D18
-  P, //D19
-  P, //D20
-  P, //D21
-  P, //D22
-  P, //D23
-  P, //D24
-  P, //D25
-  P, //D26
-  P, //D27
-  P, //D28
-  P, //D29
-  P, //D30
-  P, //D31
-  P, //D32
-  P, //D33
-  P, //D34
-  P, //D35
-  P, //D36
-  P, //D37
-  P, //D38
-  P, //D39
-  P, //D40
-  P, //D41
-  P, //D42
-  P, //D43
-  P, //D44
-  P, //D45
-  P, //D46
-  P, //D47
-  P, //D48
-  P, //D49
-  P, //D50
-  P, //D51
-  P, //D52
-  P, //D53
-  P, //D54
-  P, //D55
-  P, //D56
-  P, //D57
-  P, //D58
-  P, //D59
-  P, //D60
-  P, //D61
-  P, //D62
-  P, //D63
-  P, //D64
-  P, //D65
-  P, //D66
-  P, //D67
-  P, //D68
-  P, //D69
-  P, //D70
-  P, //D71
-  P, //D72
-  P, //D73
-  P, //D74
-  P, //D75
-  P, //D76
-  P, //D77
-  P, //D78/A0
-  P, //D79/A1
-  P, //D80/A2
-  P, //D81/A3
-  P, //D82/A4
-  P, //D83/A5
-  P, //D84/A6
-  P, //D85/A7
-  P, //D86/A8
-  P, //D87/A9
+  P, //D16/A0
+  P, //D17/A1
+  P, //D18/A2
+  P, //D19/A3
+  P, //D20/A4
+  P, //D21/A5
+  // Required only if Ax pins are automaticaly defined using `NUM_ANALOG_FIRST`
+  // and have to be contiguous in this array
   // Duplicated pins in order to be aligned with PinMap_ADC
-  P, //D88/A10 = D
-  P, //D89/A11 = D
-  P, //D90/A12 = D
-  P, //D91/A13 = D
-  P, //D92/A14 = D
-  P, //D93/A15 = D
-  P, //D94/A16 = D
-  P  //D95/A17 = D
+  P, //D22/A6 = D
+  P, //D23/A7 = D
+  P  //D24/A8 = D
 };
 
+// If analog pins are not contiguous in the digitalPin array:
+// Add the analogInPin array without defining NUM_ANALOG_FIRST
+// Analog (Ax) pin number array
+// where x is the index to retrieve the digital pin number
+const uint32_t analogInPin[] = {
+  //PXn, //Ax = Dx
+  2, //A0 = Dx
+  8, //A1 = Dy
+  3  //A2 = Dz
+}
+
 #ifdef __cplusplus
 }
 #endif
@@ -143,7 +85,7 @@ WEAK void SystemClock_Config(void)
   // available in src/main.c
   // or
   // copied from a STM32CubeYY project examples
-  // where 'YY' could be F0, F1, F2, F3, F4, F7, G0, G4, H7, L0, L1, L4, WB
+  // where 'YY' could be F0, F1, F2, F3, F4, F7, G0, G4, H7, L0, L1, L4, MP1, WB
 }
 
 #ifdef __cplusplus

variants/board_template/variant.h

@@ -35,13 +35,17 @@ extern "C" {
 // !!! // x is PXn (y)
 // !!! Ex:
 // !!! ...
-// !!! #define PA4  20 // A14
+// !!! #define PA4  20 // A14 <-- if NUM_ANALOG_FIRST not defined
+// !!! or
+// !!! #define PA4  A14 // 20 <-- if NUM_ANALOG_FIRST defined
 // !!! #define PB4  21
 // !!! #define PB5  22
 // !!! #define PB3  23
 // !!! // 24 is PA4 (20)
 // !!! // 25 is PB4 (21)
-// !!! #define PA2  26 // A15
+// !!! #define PA2  26 // A15 <-- if NUM_ANALOG_FIRST not defined
+// !!! or
+// !!! #define PA2  A15 // 26 <-- if NUM_ANALOG_FIRST defined
 // !!! ...
 //#define PXn x
 
@@ -51,22 +55,35 @@ extern "C" {
 #define NUM_DIGITAL_PINS        0
 
 // Allow to define Arduino style alias for analog input pin number --> Ax
-// If no analog pin required then NUM_ANALOG_INPUTS and NUM_ANALOG_FIRST
-// could not be defined or set to respectively `0` and `NUM_DIGITAL_PINS`
-// All pins are digital, analog inputs are a subset of digital pins
-// and must be contiguous to be able to loop on each value
-// This must be a literal with a value less than or equal to MAX_ANALOG_INPUTS
-// defined in pin_arduino.h
+// If no analog pin required then NUM_ANALOG_INPUTS could not be defined
+// or set to `0`
+// All pins are digital, analog inputs are a subset of digital pins.
+// This must be a literal
 // It is used with preprocessor tests (e.g. #if NUM_ANALOG_INPUTS > 3)
 // so an enum will not work.
 // !!!
 // !!! It must be aligned with the number of analog PinName
 // !!! defined in digitalPin[] array in variant.cpp
 // !!!
 #define NUM_ANALOG_INPUTS       0
-// Define digital pin number of the first analog input  (i.e. which digital pin is A0)
-// First analog pin value (A0) must be greater than or equal to NUM_ANALOG_INPUTS
+
+// They are 2 possibles way to define analog pins:
+//-------------------------------------------------------------------------------------------
+//   - If they are contiguous in the digitalPin array:
+//     Simply defined `NUM_ANALOG_FIRST` and all pins Ax will be automatically defined.
+//     It define the digital pin number of the first analog input  (i.e. which digital pin is A0)
+//     First analog pin value (A0) must be greater than or equal to NUM_ANALOG_INPUTS
+//     This must be a literal with a value less than or equal to MAX_ANALOG_INPUTS
+//     defined in pin_arduino.h
 #define NUM_ANALOG_FIRST        0
+//------------------------------------OR------------------------------------------------------
+//   - If they are not contiguous in the digitalPin array:
+//     Add an analogInPin array in the variant.cpp without defining NUM_ANALOG_FIRST
+//     In that case the defined PYn for analog pin have to define the Ax definition instead of
+//     index in digitalPin[] array:
+//     #define PA4  A14
+//-------------------------------------------------------------------------------------------
+
 
 // Below ADC, DAC and PWM definitions already done in the core
 // Could be redefined here if needed