[pin_remap 2/3] core,libs: add pin remap hooks

espressif · Nov 22, 2023 · de8ec9d · de8ec9d
1 parent 84e4511
commit de8ec9d
Show file tree

Hide file tree

Showing 8 changed files with 184 additions and 22 deletions.
diff --git a/cores/esp32/Arduino.h b/cores/esp32/Arduino.h
@@ -110,13 +110,13 @@
 #define analogInPinToBit(P)         (P)
 #if SOC_GPIO_PIN_COUNT <= 32
 #define digitalPinToPort(pin)       (0)
-#define digitalPinToBitMask(pin)    (1UL << (pin))
+#define digitalPinToBitMask(pin)    (1UL << digitalPinToGPIONumber(pin))
 #define portOutputRegister(port)    ((volatile uint32_t*)GPIO_OUT_REG)
 #define portInputRegister(port)     ((volatile uint32_t*)GPIO_IN_REG)
 #define portModeRegister(port)      ((volatile uint32_t*)GPIO_ENABLE_REG)
 #elif SOC_GPIO_PIN_COUNT <= 64
-#define digitalPinToPort(pin)       (((pin)>31)?1:0)
-#define digitalPinToBitMask(pin)    (1UL << (((pin)>31)?((pin)-32):(pin)))
+#define digitalPinToPort(pin)       ((digitalPinToGPIONumber(pin)>31)?1:0)
+#define digitalPinToBitMask(pin)    (1UL << (digitalPinToGPIONumber(pin)&31))
 #define portOutputRegister(port)    ((volatile uint32_t*)((port)?GPIO_OUT1_REG:GPIO_OUT_REG))
 #define portInputRegister(port)     ((volatile uint32_t*)((port)?GPIO_IN1_REG:GPIO_IN_REG))
 #define portModeRegister(port)      ((volatile uint32_t*)((port)?GPIO_ENABLE1_REG:GPIO_ENABLE_REG))
@@ -138,8 +138,8 @@
 #endif
 #define EXTERNAL_NUM_INTERRUPTS NUM_DIGITAL_PINS                                  // All GPIOs
 #define analogInputToDigitalPin(p)  (((p)<NUM_ANALOG_INPUTS)?(analogChannelToDigitalPin(p)):-1)
-#define digitalPinToInterrupt(p)    (((p)<NUM_DIGITAL_PINS)?(p):NOT_AN_INTERRUPT)
-#define digitalPinHasPWM(p)         ((p)<NUM_DIGITAL_PINS)
+#define digitalPinToInterrupt(p)    ((((uint8_t)digitalPinToGPIONumber(p))<NUM_DIGITAL_PINS)?digitalPinToGPIONumber(p):NOT_AN_INTERRUPT)
+#define digitalPinHasPWM(p)         (((uint8_t)digitalPinToGPIONumber(p))<NUM_DIGITAL_PINS)
 
 typedef bool boolean;
 typedef uint8_t byte;
@@ -235,5 +235,6 @@ void noTone(uint8_t _pin);
 #endif /* __cplusplus */
 
 #include "pins_arduino.h"
+#include "io_pin_remap.h"
 
 #endif /* _ESP32_CORE_ARDUINO_H_ */
diff --git a/cores/esp32/FunctionalInterrupt.h b/cores/esp32/FunctionalInterrupt.h
@@ -12,10 +12,11 @@
 #include <stdint.h>
 
 struct InterruptArgStructure {
-	std::function<void(void)> interruptFunction;
+    std::function<void(void)> interruptFunction;
 };
 
-void attachInterrupt(uint8_t pin, std::function<void(void)> intRoutine, int mode);
-
+// The extra set of parentheses here prevents macros defined
+// in io_pin_remap.h from applying to this declaration.
+void (attachInterrupt)(uint8_t pin, std::function<void(void)> intRoutine, int mode);
 
 #endif /* CORE_CORE_FUNCTIONALINTERRUPT_H_ */
diff --git a/cores/esp32/HardwareSerial.cpp b/cores/esp32/HardwareSerial.cpp
@@ -5,6 +5,7 @@
 #include <ctime>
 
 #include "pins_arduino.h"
+#include "io_pin_remap.h"
 #include "HardwareSerial.h"
 #include "soc/soc_caps.h"
 #include "driver/uart.h"
@@ -325,6 +326,10 @@ void HardwareSerial::begin(unsigned long baud, uint32_t config, int8_t rxPin, in
         }
     }
 
+    // map logical pins to GPIO numbers
+    rxPin = digitalPinToGPIONumber(rxPin);
+    txPin = digitalPinToGPIONumber(txPin);
+
     if(_uart) {
         // in this case it is a begin() over a previous begin() - maybe to change baud rate
         // thus do not disable debug output
@@ -500,6 +505,12 @@ void HardwareSerial::setRxInvert(bool invert)
 // can be called after or before begin()
 bool HardwareSerial::setPins(int8_t rxPin, int8_t txPin, int8_t ctsPin, int8_t rtsPin)
 {
+    // map logical pins to GPIO numbers
+    rxPin = digitalPinToGPIONumber(rxPin);
+    txPin = digitalPinToGPIONumber(txPin);
+    ctsPin = digitalPinToGPIONumber(ctsPin);
+    rtsPin = digitalPinToGPIONumber(rtsPin);
+
     // uartSetPins() checks if pins are valid and, if necessary, detaches the previous ones
     return uartSetPins(_uart_nr, rxPin, txPin, ctsPin, rtsPin);
 }

diff --git a/cores/esp32/io_pin_remap.h b/cores/esp32/io_pin_remap.h
@@ -0,0 +1,138 @@
+#ifndef __IO_PIN_REMAP_H__
+#define __IO_PIN_REMAP_H__
+
+#include "Arduino.h"
+
+#if defined(BOARD_HAS_PIN_REMAP) && !defined(BOARD_USES_HW_GPIO_NUMBERS)
+
+// Pin remapping functions
+int8_t digitalPinToGPIONumber(int8_t digitalPin);
+int8_t gpioNumberToDigitalPin(int8_t gpioNumber);
+
+// Apply pin remapping to API only when building libraries and user sketch
+#ifndef ARDUINO_CORE_BUILD
+
+// Override APIs requiring pin remapping
+
+// cores/esp32/Arduino.h
+#define pulseInLong(pin, args...)   pulseInLong(digitalPinToGPIONumber(pin), args)
+#define pulseIn(pin, args...)       pulseIn(digitalPinToGPIONumber(pin), args)
+#define noTone(_pin)                noTone(digitalPinToGPIONumber(_pin))
+#define tone(_pin, args...)         tone(digitalPinToGPIONumber(_pin), args)
+
+// cores/esp32/esp32-hal.h
+#define analogGetChannel(pin)               analogGetChannel(digitalPinToGPIONumber(pin))
+#define analogWrite(pin, value)             analogWrite(digitalPinToGPIONumber(pin), value)
+#define analogWriteFrequency(pin, freq)     analogWriteFrequency(digitalPinToGPIONumber(pin), freq)
+#define analogWriteResolution(pin, bits)    analogWriteResolution(digitalPinToGPIONumber(pin), bits)
+
+// cores/esp32/esp32-hal-adc.h
+#define analogRead(pin)                             analogRead(digitalPinToGPIONumber(pin))
+#define analogReadMilliVolts(pin)                   analogReadMilliVolts(digitalPinToGPIONumber(pin))
+#define analogSetPinAttenuation(pin, attenuation)   analogSetPinAttenuation(digitalPinToGPIONumber(pin), attenuation)
+
+// cores/esp32/esp32-hal-dac.h
+#define dacDisable(pin)         dacDisable(digitalPinToGPIONumber(pin))
+#define dacWrite(pin, value)    dacWrite(digitalPinToGPIONumber(pin), value)
+
+// cores/esp32/esp32-hal-gpio.h
+#define analogChannelToDigitalPin(channel)          gpioNumberToDigitalPin(analogChannelToDigitalPin(channel))
+#define digitalPinToAnalogChannel(pin)              digitalPinToAnalogChannel(digitalPinToGPIONumber(pin))
+#define digitalPinToTouchChannel(pin)               digitalPinToTouchChannel(digitalPinToGPIONumber(pin))
+#define digitalRead(pin)                            digitalRead(digitalPinToGPIONumber(pin))
+#define attachInterruptArg(pin, fcn, arg, mode)     attachInterruptArg(digitalPinToGPIONumber(pin), fcn, arg, mode)
+#define attachInterrupt(pin, fcn, mode)             attachInterrupt(digitalPinToGPIONumber(pin), fcn, mode)
+#define detachInterrupt(pin)                        detachInterrupt(digitalPinToGPIONumber(pin))
+#define digitalWrite(pin, val)                      digitalWrite(digitalPinToGPIONumber(pin), val)
+#define pinMode(pin, mode)                          pinMode(digitalPinToGPIONumber(pin), mode)
+
+// cores/esp32/esp32-hal-i2c.h
+#define i2cInit(i2c_num, sda, scl, clk_speed)   i2cInit(i2c_num, digitalPinToGPIONumber(sda), digitalPinToGPIONumber(scl), clk_speed)
+
+// cores/esp32/esp32-hal-i2c-slave.h
+#define i2cSlaveInit(num, sda, scl, slaveID, frequency, rx_len, tx_len)     i2cSlaveInit(num, digitalPinToGPIONumber(sda), digitalPinToGPIONumber(scl), slaveID, frequency, rx_len, tx_len)
+
+// cores/esp32/esp32-hal-ledc.h
+#define ledcAttach(pin, freq, resolution)           ledcAttach(digitalPinToGPIONumber(pin), freq, resolution)
+#define ledcWrite(pin, duty)                        ledcWrite(digitalPinToGPIONumber(pin), duty)
+#define ledcWriteTone(pin, freq)                    ledcWriteTone(digitalPinToGPIONumber(pin), freq)
+#define ledcWriteNote(pin, note, octave)            ledcWriteNote(digitalPinToGPIONumber(pin), note, octave)
+#define ledcRead(pin)                               ledcRead(digitalPinToGPIONumber(pin))
+#define ledcReadFreq(pin)                           ledcReadFreq(digitalPinToGPIONumber(pin))
+#define ledcDetach(pin)                             ledcDetach(digitalPinToGPIONumber(pin))
+#define ledcChangeFrequency(pin, freq, resolution)  ledcChangeFrequency(digitalPinToGPIONumber(pin), freq, resolution)
+
+#define ledcFade(pin, start_duty, target_duty, max_fade_time_ms)                                ledcFade(digitalPinToGPIONumber(pin), start_duty, target_duty, max_fade_time_ms)
+#define ledcFadeWithInterrupt(pin, start_duty, target_duty, max_fade_time_ms, userFunc)         ledcFadeWithInterrupt(digitalPinToGPIONumber(pin), start_duty, target_duty, max_fade_time_ms, userFunc)
+#define ledcFadeWithInterruptArg(pin, start_duty, target_duty, max_fade_time_ms, userFunc, arg) ledcFadeWithInterruptArg(digitalPinToGPIONumber(pin), start_duty, target_duty, max_fade_time_ms, userFunc, arg)
+
+// cores/esp32/esp32-hal-matrix.h
+#define pinMatrixInAttach(pin, signal, inverted)                    pinMatrixInAttach(digitalPinToGPIONumber(pin), signal, inverted)
+#define pinMatrixOutAttach(pin, function, invertOut, invertEnable)  pinMatrixOutAttach(digitalPinToGPIONumber(pin), function, invertOut, invertEnable)
+#define pinMatrixOutDetach(pin, invertOut, invertEnable)            pinMatrixOutDetach(digitalPinToGPIONumber(pin), invertOut, invertEnable)
+
+// cores/esp32/esp32-hal-periman.h
+#define perimanSetPinBus(pin, type, bus)    perimanSetPinBus(digitalPinToGPIONumber(pin), type, bus)
+#define perimanGetPinBus(pin, type)         perimanGetPinBus(digitalPinToGPIONumber(pin), type)
+#define perimanGetPinBusType(pin)           perimanGetPinBusType(digitalPinToGPIONumber(pin))
+#define perimanPinIsValid(pin)              perimanPinIsValid(digitalPinToGPIONumber(pin))
+
+// cores/esp32/esp32-hal-rgb-led.h
+#define neopixelWrite(pin, red_val, green_val, blue_val)    neopixelWrite(digitalPinToGPIONumber(pin), red_val, green_val, blue_val)
+
+// cores/esp32/esp32-hal-rmt.h
+#define rmtInit(pin, channel_direction, memsize, frequency_Hz)                      rmtInit(digitalPinToGPIONumber(pin), channel_direction, memsize, frequency_Hz)
+#define rmtWrite(pin, data, num_rmt_symbols, timeout_ms)                            rmtWrite(digitalPinToGPIONumber(pin), data, num_rmt_symbols, timeout_ms)
+#define rmtWriteAsync(pin, data, num_rmt_symbols)                                   rmtWriteAsync(digitalPinToGPIONumber(pin), data, num_rmt_symbols)
+#define rmtWriteLooping(pin, data, num_rmt_symbols)                                 rmtWriteLooping(digitalPinToGPIONumber(pin), data, num_rmt_symbols)
+#define rmtTransmitCompleted(pin)                                                   rmtTransmitCompleted(digitalPinToGPIONumber(pin))
+#define rmtRead(pin, data, num_rmt_symbols, timeout_ms)                             rmtRead(digitalPinToGPIONumber(pin), data, num_rmt_symbols, timeout_ms)
+#define rmtReadAsync(pin, data, num_rmt_symbols)                                    rmtReadAsync(digitalPinToGPIONumber(pin), data, num_rmt_symbols)
+#define rmtReceiveCompleted(pin)                                                    rmtReceiveCompleted(digitalPinToGPIONumber(pin))
+#define rmtSetRxMaxThreshold(pin, idle_thres_ticks)                                 rmtSetRxMaxThreshold(digitalPinToGPIONumber(pin), idle_thres_ticks)
+#define rmtSetCarrier(pin, carrier_en, carrier_level, frequency_Hz, duty_percent)   rmtSetCarrier(digitalPinToGPIONumber(pin), carrier_en, carrier_level, frequency_Hz, duty_percent)
+#define rmtSetRxMinThreshold(pin, filter_pulse_ticks)                               rmtSetRxMinThreshold(digitalPinToGPIONumber(pin), filter_pulse_ticks)
+#define rmtDeinit(pin)                                                              rmtDeinit(digitalPinToGPIONumber(pin))
+
+// cores/esp32/esp32-hal-sigmadelta.h
+#define sigmaDeltaAttach(pin, freq)     sigmaDeltaAttach(digitalPinToGPIONumber(pin), freq)
+#define sigmaDeltaWrite(pin, duty)      sigmaDeltaWrite(digitalPinToGPIONumber(pin), duty)
+#define sigmaDeltaDetach(pin)           sigmaDeltaDetach(digitalPinToGPIONumber(pin))
+
+// cores/esp32/esp32-hal-spi.h
+#define spiAttachSCK(spi, sck)          spiAttachSCK(spi, digitalPinToGPIONumber(sck))
+#define spiAttachMISO(spi, miso)        spiAttachMISO(spi, digitalPinToGPIONumber(miso))
+#define spiAttachMOSI(spi, mosi)        spiAttachMOSI(spi, digitalPinToGPIONumber(mosi))
+#define spiDetachSCK(spi, sck)          spiDetachSCK(spi, digitalPinToGPIONumber(sck))
+#define spiDetachMISO(spi, miso)        spiDetachMISO(spi, digitalPinToGPIONumber(miso))
+#define spiDetachMOSI(spi, mosi)        spiDetachMOSI(spi, digitalPinToGPIONumber(mosi))
+#define spiAttachSS(spi, cs_num, ss)    spiAttachSS(spi, cs_num, digitalPinToGPIONumber(ss))
+#define spiDetachSS(spi, ss)            spiDetachSS(spi, digitalPinToGPIONumber(ss))
+
+// cores/esp32/esp32-hal-touch.h
+#define touchInterruptGetLastStatus(pin)                        touchInterruptGetLastStatus(digitalPinToGPIONumber(pin))
+#define touchRead(pin)                                          touchRead(digitalPinToGPIONumber(pin))
+#define touchAttachInterruptArg(pin, userFunc, arg, threshold)  touchAttachInterruptArg(digitalPinToGPIONumber(pin), userFunc, arg, threshold)
+#define touchAttachInterrupt(pin, userFunc, threshold)          touchAttachInterrupt(digitalPinToGPIONumber(pin), userFunc, threshold)
+#define touchDetachInterrupt(pin)                               touchDetachInterrupt(digitalPinToGPIONumber(pin))
+#define touchSleepWakeUpEnable(pin, threshold)                  touchSleepWakeUpEnable(digitalPinToGPIONumber(pin), threshold)
+
+// cores/esp32/esp32-hal-uart.h
+#define uartBegin(uart_nr, baudrate, config, rxPin, txPin, rx_buffer_size, tx_buffer_size, inverted, rxfifo_full_thrhd) \
+        uartBegin(uart_nr, baudrate, config, digitalPinToGPIONumber(rxPin), digitalPinToGPIONumber(txPin), rx_buffer_size, tx_buffer_size, inverted, rxfifo_full_thrhd)
+#define uartSetPins(uart, rxPin, txPin, ctsPin, rtsPin) \
+        uartSetPins(uart, digitalPinToGPIONumber(rxPin), digitalPinToGPIONumber(txPin), digitalPinToGPIONumber(ctsPin), digitalPinToGPIONumber(rtsPin))
+#define uartDetachPins(uart, rxPin, txPin, ctsPin, rtsPin) \
+        uartDetachPins(uart, digitalPinToGPIONumber(rxPin), digitalPinToGPIONumber(txPin), digitalPinToGPIONumber(ctsPin), digitalPinToGPIONumber(rtsPin))
+
+#endif // ARDUINO_CORE_BUILD
+
+#else
+
+// pin remapping disabled: use stubs
+#define digitalPinToGPIONumber(digitalPin) (digitalPin)
+#define gpioNumberToDigitalPin(gpioNumber) (gpioNumber)
+
+#endif
+
+#endif /* __GPIO_PIN_REMAP_H__ */
diff --git a/cores/esp32/main.cpp b/cores/esp32/main.cpp
@@ -46,7 +46,7 @@ __attribute__((weak)) bool shouldPrintChipDebugReport(void) {
 void loopTask(void *pvParameters)
 {
     // sets UART0 (default console) RX/TX pins as already configured in boot or as defined in variants/pins_arduino.h
-    Serial0.setPins(SOC_RX0, SOC_TX0);
+    Serial0.setPins(gpioNumberToDigitalPin(SOC_RX0), gpioNumberToDigitalPin(SOC_TX0));
 #if ARDUHAL_LOG_LEVEL >= ARDUHAL_LOG_LEVEL_DEBUG
     printBeforeSetupInfo();
 #else

diff --git a/libraries/ESP_I2S/src/ESP_I2S.cpp b/libraries/ESP_I2S/src/ESP_I2S.cpp
@@ -230,11 +230,11 @@ bool I2SClass::i2sDetachBus(void * bus_pointer){
 
 // Set pins for STD and TDM mode
 void I2SClass::setPins(int8_t bclk, int8_t ws, int8_t dout, int8_t din, int8_t mclk){
-    _mclk = mclk;
-    _bclk = bclk;
-    _ws = ws;
-    _dout = dout;
-    _din = din;
+    _mclk = digitalPinToGPIONumber(mclk);
+    _bclk = digitalPinToGPIONumber(bclk);
+    _ws = digitalPinToGPIONumber(ws);
+    _dout = digitalPinToGPIONumber(dout);
+    _din = digitalPinToGPIONumber(din);
 }
 
 void I2SClass::setInverted(bool bclk, bool ws, bool mclk){
@@ -246,23 +246,23 @@ void I2SClass::setInverted(bool bclk, bool ws, bool mclk){
 // Set pins for PDM TX mode
 #if SOC_I2S_SUPPORTS_PDM_TX
 void I2SClass::setPinsPdmTx(int8_t clk, int8_t dout0, int8_t dout1){
-    _tx_clk = clk;
-    _tx_dout0 = dout0;
+    _tx_clk = digitalPinToGPIONumber(clk);
+    _tx_dout0 = digitalPinToGPIONumber(dout0);
 #if (SOC_I2S_PDM_MAX_TX_LINES > 1)
-    _tx_dout1 = dout1;
+    _tx_dout1 = digitalPinToGPIONumber(dout1);
 #endif
 }
 #endif
 
 // Set pins for PDM RX mode
 #if SOC_I2S_SUPPORTS_PDM_RX
 void I2SClass::setPinsPdmRx(int8_t clk, int8_t din0, int8_t din1, int8_t din2, int8_t din3){
-    _rx_clk = clk;
-    _rx_din0 = din0;
+    _rx_clk = digitalPinToGPIONumber(clk);
+    _rx_din0 = digitalPinToGPIONumber(din0);
 #if (SOC_I2S_PDM_MAX_RX_LINES > 1)
-    _rx_din1 = din1;
-    _rx_din2 = din2;
-    _rx_din3 = din3;
+    _rx_din1 = digitalPinToGPIONumber(din1);
+    _rx_din2 = digitalPinToGPIONumber(din2);
+    _rx_din3 = digitalPinToGPIONumber(din3);
 #endif
 }
 #endif

diff --git a/libraries/SD_MMC/src/SD_MMC.cpp b/libraries/SD_MMC/src/SD_MMC.cpp
@@ -13,6 +13,7 @@
 // limitations under the License.
 
 #include "pins_arduino.h"
+#include "io_pin_remap.h"
 #include "SD_MMC.h"
 #ifdef SOC_SDMMC_HOST_SUPPORTED
 #include "vfs_api.h"
@@ -72,6 +73,15 @@ bool SDMMCFS::setPins(int clk, int cmd, int d0, int d1, int d2, int d3)
         log_e("SD_MMC.setPins must be called before SD_MMC.begin");
         return false;
     }
+
+    // map logical pins to GPIO numbers
+    clk = digitalPinToGPIONumber(clk);
+    cmd = digitalPinToGPIONumber(cmd);
+    d0 = digitalPinToGPIONumber(d0);
+    d1 = digitalPinToGPIONumber(d1);
+    d2 = digitalPinToGPIONumber(d2);
+    d3 = digitalPinToGPIONumber(d3);
+
 #ifdef SOC_SDMMC_USE_GPIO_MATRIX
     // SoC supports SDMMC pin configuration via GPIO matrix. Save the pins for later use in SDMMCFS::begin.
     _pin_clk = (int8_t) clk;

diff --git a/libraries/SPI/src/SPI.cpp b/libraries/SPI/src/SPI.cpp
@@ -22,6 +22,7 @@
 #include "SPI.h"
 #if SOC_GPSPI_SUPPORTED
 
+#include "io_pin_remap.h"
 #include "esp32-hal-log.h"
 
 #if !CONFIG_DISABLE_HAL_LOCKS