feat(gpio): esp_rom_gpio_connect_in/out_signal now has their hal implementation

Author: songruo

components/esp_driver_gpio/README.md

@@ -12,15 +12,15 @@ There is no need to enable the output for the IO explicitly, it is done internal
 
 If the signal is routed through IO MUX to the pin, then only needs to call `gpio_iomux_output` to select the IO MUX function index. Output enable is controlled by the signal itself.
 
-If the signal is routed through GPIO Matrix to the pin, then first call `gpio_func_sel` to let the pin use `PIN_FUNC_GPIO` function, follow by calling `esp_rom_gpio_connect_out_signal` to connect the signal.
+If the signal is routed through GPIO Matrix to the pin, then call `gpio_matrix_output` to select the `PIN_FUNC_GPIO` function and connect the signal to the pin.
 
 When a peripheral driver does de-initialization, to de-configure the pin as the peripheral signal output, a call to `gpio_output_disable` is enough. It will disconnect the signal internally.
 
 ## Configure an IO as a peripheral signal input
 
 If the signal is routed through IO MUX to the pin, then only needs to call `gpio_iomux_input` to select the IO MUX function index and direct the signal to IO MUX. Input will be enabled for the IO internally.
 
-If the signal is routed through GPIO Matrix to the pin, then call `gpio_input_enable` and `esp_rom_gpio_connect_in_signal` to enable the input and connect the signal to the pin.
+If the signal is routed through GPIO Matrix to the pin, then call `gpio_matrix_input` to enable the input and connect the signal to the pin.
 
 When a peripheral driver does de-initialization, to de-configure the pin as the peripheral signal input, use `esp_rom_gpio_connect_in_signal` to connect the signal to CONST_ONE or CONST_ZERO, so that it is disconnected from the pin. It is not desired to call `gpio_input_disable`, because there might be other drivers still using this pin as an input.
 

components/esp_driver_gpio/include/driver/gpio.h

@@ -497,22 +497,6 @@ void gpio_deep_sleep_hold_en(void);
 void gpio_deep_sleep_hold_dis(void);
 #endif //SOC_GPIO_SUPPORT_HOLD_IO_IN_DSLP && !SOC_GPIO_SUPPORT_HOLD_SINGLE_IO_IN_DSLP
 
-/**
-  * @brief Set pad input to a peripheral signal through the IOMUX.
-  * @param gpio_num GPIO number of the pad.
-  * @param signal_idx Peripheral signal id to input. One of the ``*_IN_IDX`` signals in ``soc/gpio_sig_map.h``.
-  */
-void gpio_iomux_in(uint32_t gpio_num, uint32_t signal_idx) __attribute__((deprecated("Please use `gpio_iomux_input` instead")));
-
-/**
-  * @brief Set peripheral output to an GPIO pad through the IOMUX.
-  * @param gpio_num gpio_num GPIO number of the pad.
-  * @param func The function number of the peripheral pin to output pin.
-  *        One of the ``FUNC_X_*`` of specified pin (X) in ``soc/io_mux_reg.h``.
-  * @param out_en_inv True if the output enable needs to be inverted, otherwise False.
-  */
-void gpio_iomux_out(uint8_t gpio_num, int func, bool out_en_inv) __attribute__((deprecated("Please use `gpio_iomux_output` instead")));
-
 #if SOC_GPIO_SUPPORT_FORCE_HOLD
 /**
   * @brief Force hold all digital and rtc gpio pads.

components/esp_driver_gpio/include/esp_private/gpio.h

@@ -68,7 +68,7 @@ esp_err_t gpio_config_as_analog(gpio_num_t gpio_num);
   * @param gpio_num GPIO number of the pad.
   * @param func The index number of the IOMUX function to be selected for the pin.
   *        One of the ``FUNC_X_*`` of specified pin (X) in ``soc/io_mux_reg.h``.
-  * @param signal_idx Peripheral signal id to input. One of the ``*_IN_IDX`` signals in ``soc/gpio_sig_map.h``.
+  * @param signal_idx Peripheral signal index to input. One of the ``*_IN_IDX`` signals in ``soc/gpio_sig_map.h``.
   *
   * @return
   *     - ESP_OK Success
@@ -89,6 +89,41 @@ esp_err_t gpio_iomux_input(gpio_num_t gpio_num, int func, uint32_t signal_idx);
   */
 esp_err_t gpio_iomux_output(gpio_num_t gpio_num, int func);
 
+/**
+ * @brief Set pad input to a peripheral signal through the GPIO matrix.
+ *
+ * @note A GPIO can combine with multiple input signals.
+ *
+ * @param gpio_num GPIO number, especially, `GPIO_MATRIX_CONST_ZERO_INPUT` means connect logic 0 to signal;
+ *                                          `GPIO_MATRIX_CONST_ONE_INPUT` means connect logic 1 to signal.
+ * @param signal_idx Peripheral signal index (tagged as input attribute).
+ *                   One of the ``*_IN_IDX`` signals in ``soc/gpio_sig_map.h``.
+ * @param in_inv Whether the GPIO input to be inverted or not.
+ *
+ * @return
+ *      - ESP_OK Success
+ *      - ESP_ERR_INVALID_ARG GPIO number error
+ */
+esp_err_t gpio_matrix_input(gpio_num_t gpio_num, uint32_t signal_idx, bool in_inv);
+
+/**
+ * @brief Set peripheral output to an GPIO pad through the GPIO matrix.
+ *
+ * @note An output signal can be combined with multiple GPIOs.
+ *
+ * @param gpio_num GPIO number
+ * @param signal_idx Peripheral signal index (tagged as output attribute).
+ *                   One of the ``*_OUT_IDX`` signals in ``soc/gpio_sig_map.h``.
+ *                   Particularly, `SIG_GPIO_OUT_IDX` means disconnect GPIO with any peripheral.
+ * @param out_inv Whether to signal to be inverted or not.
+ * @param oen_inv Whether the output enable control is inverted or not.
+ *
+ * @return
+ *      - ESP_OK Success
+ *      - ESP_ERR_INVALID_ARG GPIO number error
+ */
+esp_err_t gpio_matrix_output(gpio_num_t gpio_num, uint32_t signal_idx, bool out_inv, bool oen_inv);
+
 #ifdef __cplusplus
 }
 #endif

components/esp_driver_gpio/src/gpio.c

@@ -813,13 +813,6 @@ esp_err_t IRAM_ATTR gpio_force_unhold_all()
 }
 #endif //SOC_GPIO_SUPPORT_FORCE_HOLD
 
-// Deprecated function
-void gpio_iomux_in(uint32_t gpio, uint32_t signal_idx)
-{
-    gpio_ll_set_input_signal_from(gpio_context.gpio_hal->dev, signal_idx, false);
-    gpio_hal_input_enable(gpio_context.gpio_hal, gpio);
-}
-
 esp_err_t gpio_iomux_input(gpio_num_t gpio_num, int func, uint32_t signal_idx)
 {
     GPIO_CHECK(GPIO_IS_VALID_GPIO(gpio_num), "GPIO number error", ESP_ERR_INVALID_ARG);
@@ -831,13 +824,6 @@ esp_err_t gpio_iomux_input(gpio_num_t gpio_num, int func, uint32_t signal_idx)
     return ESP_OK;
 }
 
-// Deprecated function
-void gpio_iomux_out(uint8_t gpio_num, int func, bool out_en_inv)
-{
-    (void)out_en_inv; // out_en_inv only takes effect when signal goes through gpio matrix to the IO
-    gpio_hal_iomux_out(gpio_context.gpio_hal, gpio_num, func);
-}
-
 esp_err_t gpio_iomux_output(gpio_num_t gpio_num, int func)
 {
     GPIO_CHECK(GPIO_IS_VALID_OUTPUT_GPIO(gpio_num), "GPIO number error", ESP_ERR_INVALID_ARG);
@@ -849,6 +835,24 @@ esp_err_t gpio_iomux_output(gpio_num_t gpio_num, int func)
     return ESP_OK;
 }
 
+esp_err_t gpio_matrix_input(gpio_num_t gpio_num, uint32_t signal_idx, bool in_inv)
+{
+    GPIO_CHECK(GPIO_IS_VALID_GPIO(gpio_num), "GPIO number error", ESP_ERR_INVALID_ARG);
+
+    gpio_hal_matrix_in(gpio_context.gpio_hal, gpio_num, signal_idx, in_inv);
+
+    return ESP_OK;
+}
+
+esp_err_t gpio_matrix_output(gpio_num_t gpio_num, uint32_t signal_idx, bool out_inv, bool oen_inv)
+{
+    GPIO_CHECK(GPIO_IS_VALID_OUTPUT_GPIO(gpio_num), "GPIO number error", ESP_ERR_INVALID_ARG);
+
+    gpio_hal_matrix_out(gpio_context.gpio_hal, gpio_num, signal_idx, out_inv, oen_inv);
+
+    return ESP_OK;
+}
+
 static esp_err_t gpio_sleep_pullup_en(gpio_num_t gpio_num)
 {
     GPIO_CHECK(GPIO_IS_VALID_GPIO(gpio_num), "GPIO number error", ESP_ERR_INVALID_ARG);

components/esp_driver_ledc/src/ledc.c

@@ -17,7 +17,6 @@
 #include "soc/soc_caps.h"
 #include "hal/ledc_hal.h"
 #include "driver/ledc.h"
-#include "esp_rom_gpio.h"
 #include "clk_ctrl_os.h"
 #include "esp_private/esp_sleep_internal.h"
 #include "esp_private/periph_ctrl.h"
@@ -807,14 +806,13 @@ esp_err_t ledc_timer_config(const ledc_timer_config_t *timer_conf)
 
 esp_err_t _ledc_set_pin(int gpio_num, bool out_inv, ledc_mode_t speed_mode, ledc_channel_t channel)
 {
-    gpio_func_sel(gpio_num, PIN_FUNC_GPIO);
     // reserve the GPIO output path, because we don't expect another peripheral to signal to the same GPIO
     uint64_t old_gpio_rsv_mask = esp_gpio_reserve(BIT64(gpio_num));
     // check if the GPIO is already used by others, LEDC signal only uses the output path of the GPIO
     if (old_gpio_rsv_mask & BIT64(gpio_num)) {
         ESP_LOGW(LEDC_TAG, "GPIO %d is not usable, maybe conflict with others", gpio_num);
     }
-    esp_rom_gpio_connect_out_signal(gpio_num, ledc_periph_signal[speed_mode].sig_out0_idx + channel, out_inv, 0);
+    gpio_matrix_output(gpio_num, ledc_periph_signal[speed_mode].sig_out0_idx + channel, out_inv, false);
     return ESP_OK;
 }
 

components/esp_driver_ledc/test_apps/ledc/sdkconfig.ci.iram_safe

@@ -7,3 +7,5 @@ CONFIG_COMPILER_OPTIMIZATION_CHECKS_SILENT=y
 # ledc driver uses assert in the ISR code path
 CONFIG_COMPILER_OPTIMIZATION_ASSERTIONS_DISABLE=y
 CONFIG_LEDC_CTRL_FUNC_IN_IRAM=y
+# test gpio signal connection with non-default option
+CONFIG_HAL_GPIO_USE_ROM_IMPL=n

components/esp_driver_uart/src/uart.c

@@ -844,10 +844,7 @@ esp_err_t uart_set_pin(uart_port_t uart_num, int tx_io_num, int rx_io_num, int r
 #endif
         if (tx_rx_same_io || !uart_try_set_iomux_pin(uart_num, tx_io_num, SOC_UART_TX_PIN_IDX)) {
             if (uart_num < SOC_UART_HP_NUM) {
-                gpio_func_sel(tx_io_num, PIN_FUNC_GPIO);
-                esp_rom_gpio_connect_out_signal(tx_io_num, UART_PERIPH_SIGNAL(uart_num, SOC_UART_TX_PIN_IDX), 0, 0);
-                // output enable is set inside esp_rom_gpio_connect_out_signal func after the signal is connected
-                // (output enabled too early may cause unnecessary level change at the pad)
+                gpio_matrix_output(tx_io_num, UART_PERIPH_SIGNAL(uart_num, SOC_UART_TX_PIN_IDX), false, false);
             }
 #if SOC_LP_GPIO_MATRIX_SUPPORTED
             else {
@@ -870,8 +867,7 @@ esp_err_t uart_set_pin(uart_port_t uart_num, int tx_io_num, int rx_io_num, int r
         if (tx_rx_same_io || !uart_try_set_iomux_pin(uart_num, rx_io_num, SOC_UART_RX_PIN_IDX)) {
             io_reserve_mask &= ~BIT64(rx_io_num); // input IO via GPIO matrix does not need to be reserved
             if (uart_num < SOC_UART_HP_NUM) {
-                gpio_input_enable(rx_io_num);
-                esp_rom_gpio_connect_in_signal(rx_io_num, UART_PERIPH_SIGNAL(uart_num, SOC_UART_RX_PIN_IDX), 0);
+                gpio_matrix_input(rx_io_num, UART_PERIPH_SIGNAL(uart_num, SOC_UART_RX_PIN_IDX), false);
             }
 #if SOC_LP_GPIO_MATRIX_SUPPORTED
             else {
@@ -889,9 +885,7 @@ esp_err_t uart_set_pin(uart_port_t uart_num, int tx_io_num, int rx_io_num, int r
 
     if (rts_io_num >= 0 && (uart_context[uart_num].rts_io_num = rts_io_num, !uart_try_set_iomux_pin(uart_num, rts_io_num, SOC_UART_RTS_PIN_IDX))) {
         if (uart_num < SOC_UART_HP_NUM) {
-            gpio_func_sel(rts_io_num, PIN_FUNC_GPIO);
-            esp_rom_gpio_connect_out_signal(rts_io_num, UART_PERIPH_SIGNAL(uart_num, SOC_UART_RTS_PIN_IDX), 0, 0);
-            // output enable is set inside esp_rom_gpio_connect_out_signal func after the signal is connected
+            gpio_matrix_output(rts_io_num, UART_PERIPH_SIGNAL(uart_num, SOC_UART_RTS_PIN_IDX), false, false);
         }
 #if SOC_LP_GPIO_MATRIX_SUPPORTED
         else {
@@ -905,9 +899,7 @@ esp_err_t uart_set_pin(uart_port_t uart_num, int tx_io_num, int rx_io_num, int r
     if (cts_io_num >= 0  && (uart_context[uart_num].cts_io_num = cts_io_num, !uart_try_set_iomux_pin(uart_num, cts_io_num, SOC_UART_CTS_PIN_IDX))) {
         io_reserve_mask &= ~BIT64(cts_io_num); // input IO via GPIO matrix does not need to be reserved
         if (uart_num < SOC_UART_HP_NUM) {
-            gpio_pullup_en(cts_io_num);
-            gpio_input_enable(cts_io_num);
-            esp_rom_gpio_connect_in_signal(cts_io_num, UART_PERIPH_SIGNAL(uart_num, SOC_UART_CTS_PIN_IDX), 0);
+            gpio_matrix_input(cts_io_num, UART_PERIPH_SIGNAL(uart_num, SOC_UART_CTS_PIN_IDX), false);
         }
 #if SOC_LP_GPIO_MATRIX_SUPPORTED
         else {

components/esp_driver_uart/test_apps/uart/sdkconfig.ci.iram_safe

@@ -6,3 +6,5 @@ CONFIG_FREERTOS_PLACE_FUNCTIONS_INTO_FLASH=y
 # silent the error check, as the error string are stored in rodata, causing RTL check failure
 CONFIG_COMPILER_OPTIMIZATION_CHECKS_SILENT=y
 CONFIG_COMPILER_OPTIMIZATION_ASSERTIONS_SILENT=y
+# test gpio signal connection with non-default option
+CONFIG_HAL_GPIO_USE_ROM_IMPL=n

components/hal/Kconfig

@@ -91,6 +91,16 @@ menu "Hardware Abstraction Layer (HAL) and Low Level (LL)"
             features will be added and bugs will be fixed in the IDF source
             but cannot be synced to ROM.
 
+    config HAL_GPIO_USE_ROM_IMPL
+        bool "Use ROM implementation of GPIO HAL driver"
+        default y
+        help
+            Enable this flag to use HAL functions from ROM when applicable instead of ESP-IDF.
+
+            If keeping this as "n" in your project, you will have less free IRAM.
+            When compiling an application for a CPU that cannot access to the ROM memory,
+            this option should be disabled.
+
     config HAL_ECDSA_GEN_SIG_CM
         bool "Enable countermeasure for ECDSA signature generation"
         depends on IDF_TARGET_ESP32H2

components/hal/esp32/include/hal/gpio_ll.h

@@ -468,18 +468,6 @@ static inline void gpio_ll_od_enable(gpio_dev_t *hw, uint32_t gpio_num)
     hw->pin[gpio_num].pad_driver = 1;
 }
 
-/**
- * @brief Disconnect any peripheral output signal routed via GPIO matrix to the pin
- *
- * @param  hw Peripheral GPIO hardware instance address.
- * @param  gpio_num GPIO number
- */
-__attribute__((always_inline))
-static inline void gpio_ll_matrix_out_default(gpio_dev_t *hw, uint32_t gpio_num)
-{
-    REG_WRITE(GPIO_FUNC0_OUT_SEL_CFG_REG + (gpio_num * 4), SIG_GPIO_OUT_IDX);
-}
-
 /**
  * @brief  Select a function for the pin in the IOMUX
  *
@@ -687,6 +675,40 @@ static inline void gpio_ll_set_input_signal_from(gpio_dev_t *hw, uint32_t signal
     hw->func_in_sel_cfg[signal_idx].sig_in_sel = from_gpio_matrix;
 }
 
+/**
+ * @brief Connect a GPIO input with a peripheral signal, which tagged as input attribute.
+ *
+ * @note There's no limitation on the number of signals that a GPIO can combine with.
+ *
+ * @param signal_idx Peripheral signal index (tagged as input attribute)
+ * @param gpio_num GPIO number, especially, `GPIO_MATRIX_CONST_ZERO_INPUT` means connect logic 0 to signal
+ *                                          `GPIO_MATRIX_CONST_ONE_INPUT` means connect logic 1 to signal
+ * @param in_inv True if the GPIO input needs to be inverted, otherwise False.
+ */
+static inline void gpio_ll_set_input_signal_matrix_source(gpio_dev_t *hw, uint32_t signal_idx, uint32_t gpio_num, bool in_inv)
+{
+    hw->func_in_sel_cfg[signal_idx].func_sel = gpio_num;
+    hw->func_in_sel_cfg[signal_idx].sig_in_inv = in_inv;
+    gpio_ll_set_input_signal_from(hw, signal_idx, true);
+}
+
+/**
+ * @brief Get the GPIO number that is routed to the input peripheral signal through GPIO matrix.
+ *
+ * @param hw Peripheral GPIO hardware instance address.
+ * @param in_sig_idx Peripheral signal index (tagged as input attribute).
+ *
+ * @return
+ *    - -1     Signal bypassed GPIO matrix
+ *    - Others GPIO number
+ */
+static inline int gpio_ll_get_in_signal_connected_io(gpio_dev_t *hw, uint32_t in_sig_idx)
+{
+    typeof(hw->func_in_sel_cfg[in_sig_idx]) reg;
+    reg.val = hw->func_in_sel_cfg[in_sig_idx].val;
+    return (reg.sig_in_sel ? reg.func_sel : -1);
+}
+
 /**
   * @brief Configure the source of output enable signal for the GPIO pin.
   *
@@ -701,6 +723,21 @@ static inline void gpio_ll_set_output_enable_ctrl(gpio_dev_t *hw, uint8_t gpio_n
     hw->func_out_sel_cfg[gpio_num].oen_sel = !ctrl_by_periph;
 }
 
+/**
+ * @brief Connect a peripheral signal which tagged as output attribute with a GPIO.
+ *
+ * @note There's no limitation on the number of signals that a GPIO can combine with.
+ *
+ * @param gpio_num GPIO number
+ * @param signal_idx Peripheral signal index (tagged as output attribute). Particularly, `SIG_GPIO_OUT_IDX` means disconnect GPIO and other peripherals. Only the GPIO driver can control the output level.
+ * @param out_inv True if the signal output needs to be inverted, otherwise False.
+ */
+static inline void gpio_ll_set_output_signal_matrix_source(gpio_dev_t *hw, uint32_t gpio_num, uint32_t signal_idx, bool out_inv)
+{
+    hw->func_out_sel_cfg[gpio_num].func_sel = signal_idx;
+    hw->func_out_sel_cfg[gpio_num].inv_sel = out_inv;
+}
+
 /**
  * @brief  Control the pin in the IOMUX
  *
@@ -714,23 +751,6 @@ static inline void gpio_ll_set_pin_ctrl(uint32_t val, uint32_t bmap, uint32_t sh
     SET_PERI_REG_BITS(PIN_CTRL, bmap, val, shift);
 }
 
-/**
- * @brief Get the GPIO number that is routed to the input peripheral signal through GPIO matrix.
- *
- * @param hw Peripheral GPIO hardware instance address.
- * @param in_sig_idx Peripheral signal index (tagged as input attribute).
- *
- * @return
- *    - -1     Signal bypassed GPIO matrix
- *    - Others GPIO number
- */
-static inline int gpio_ll_get_in_signal_connected_io(gpio_dev_t *hw, uint32_t in_sig_idx)
-{
-    typeof(hw->func_in_sel_cfg[in_sig_idx]) reg;
-    reg.val = hw->func_in_sel_cfg[in_sig_idx].val;
-    return (reg.sig_in_sel ? reg.func_sel : -1);
-}
-
 #ifdef __cplusplus
 }
 #endif