feat(fast_gpio): support CPU controlled fast GPIO driver on esp32p4

2024-10-05 20:47:46 -04:00 · 2024-01-23 12:35:10 +08:00 · 2024-01-23 12:35:10 +08:00 · f71044c877
commit f71044c877
parent 573bd1bcc9
13 changed files with 156 additions and 29 deletions
--- a/components/esp_driver_gpio/test_apps/gpio_extensions/README.md
+++ b/components/esp_driver_gpio/test_apps/gpio_extensions/README.md
@ -1,2 +1,2 @@
-| Supported Targets | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-S2 | ESP32-S3 |
-| ----------------- | -------- | -------- | -------- | -------- | -------- | -------- |
+| Supported Targets | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
+| ----------------- | -------- | -------- | -------- | -------- | -------- | -------- | -------- |
--- a/components/esp_driver_gpio/test_apps/gpio_extensions/main/test_dedicated_gpio.c
+++ b/components/esp_driver_gpio/test_apps/gpio_extensions/main/test_dedicated_gpio.c
@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2021-2024 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */
@ -146,7 +146,11 @@ TEST_CASE("Dedicated_GPIO_run_on_multiple_CPU_cores", "[dedic_gpio]")
    TaskHandle_t task_handle[SOC_CPU_CORES_NUM];

    for (int i = 0; i < SOC_CPU_CORES_NUM; i++) {
+#if CONFIG_IDF_TARGET_ESP32P4
+        int start_gpio = i * TEST_GPIO_GROUP_SIZE + 20;
+#else
        int start_gpio = i * TEST_GPIO_GROUP_SIZE;
+#endif
        test_dedic_task_context_t isr_ctx = {
            .sem = sem,
            .gpios = {start_gpio, start_gpio + 1, start_gpio + 2, start_gpio + 3}
@ -181,7 +185,11 @@ TEST_CASE("Dedicated_GPIO_interrupt_and_callback", "[dedic_gpio]")
    SemaphoreHandle_t sem = xSemaphoreCreateBinary();

    // configure GPIO
+#if CONFIG_IDF_TARGET_ESP32P4
+    const int bundle_gpios[] = {20, 21};
+#else
    const int bundle_gpios[] = {0, 1};
+#endif
    gpio_config_t io_conf = {
        .mode = GPIO_MODE_INPUT_OUTPUT,
    };
@ -200,12 +208,12 @@ TEST_CASE("Dedicated_GPIO_interrupt_and_callback", "[dedic_gpio]")
    };
    TEST_ESP_OK(dedic_gpio_new_bundle(&bundle_config, &bundle));

-    // enable interrupt on GPIO1
-    TEST_ESP_OK(gpio_set_intr_type(1, GPIO_INTR_POSEDGE));
+    // enable interrupt
+    TEST_ESP_OK(gpio_set_intr_type(bundle_gpios[1], GPIO_INTR_POSEDGE));
    // install gpio isr service
    TEST_ESP_OK(gpio_install_isr_service(0));
    // hook isr handler for specific gpio pin
-    TEST_ESP_OK(gpio_isr_handler_add(1, test_dedic_gpio_isr_callback, sem));
+    TEST_ESP_OK(gpio_isr_handler_add(bundle_gpios[1], test_dedic_gpio_isr_callback, sem));

    // trigger a posedge on GPIO1
    dedic_gpio_bundle_write(bundle, BIT(1), 0x00);
@ -214,7 +222,7 @@ TEST_CASE("Dedicated_GPIO_interrupt_and_callback", "[dedic_gpio]")
    TEST_ASSERT_EQUAL(pdTRUE, xSemaphoreTake(sem, pdMS_TO_TICKS(1000)));

    // remove isr handler for gpio number
-    TEST_ESP_OK(gpio_isr_handler_remove(1));
+    TEST_ESP_OK(gpio_isr_handler_remove(bundle_gpios[1]));
    // uninstall GPIO interrupt service
    gpio_uninstall_isr_service();

--- a/components/esp_driver_gpio/test_apps/gpio_extensions/pytest_gpio_extensions.py
+++ b/components/esp_driver_gpio/test_apps/gpio_extensions/pytest_gpio_extensions.py
@ -28,6 +28,7 @@ def test_gpio_filter(dut: IdfDut) -> None:
@pytest.mark.esp32h2
@pytest.mark.esp32s2
@pytest.mark.esp32s3
+@pytest.mark.esp32p4
@pytest.mark.generic
@pytest.mark.parametrize('config', CONFIGS, indirect=True)
 def test_dedic_gpio(dut: IdfDut) -> None:
--- a/components/hal/esp32p4/include/hal/dedic_gpio_cpu_ll.h
+++ b/components/hal/esp32p4/include/hal/dedic_gpio_cpu_ll.h
@ -0,0 +1,57 @@
+/*
+ * SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+
+#include <stdint.h>
+#include "riscv/csr.h"
+
+/*fast gpio*/
+#define CSR_GPIO_OEN_USER   0x803
+#define CSR_GPIO_IN_USER    0x804
+#define CSR_GPIO_OUT_USER   0x805
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+__attribute__((always_inline))
+static inline void dedic_gpio_cpu_ll_enable_output(uint32_t mask)
+{
+    // the OEN register is active low
+    RV_CLEAR_CSR(CSR_GPIO_OEN_USER, mask);
+}
+
+__attribute__((always_inline))
+static inline void dedic_gpio_cpu_ll_write_all(uint32_t value)
+{
+    RV_WRITE_CSR(CSR_GPIO_OUT_USER, value);
+}
+
+__attribute__((always_inline))
+static inline uint32_t dedic_gpio_cpu_ll_read_in(void)
+{
+    uint32_t value = RV_READ_CSR(CSR_GPIO_IN_USER);
+    return value;
+}
+
+__attribute__((always_inline))
+static inline uint32_t dedic_gpio_cpu_ll_read_out(void)
+{
+    uint32_t value = RV_READ_CSR(CSR_GPIO_OUT_USER);
+    return value;
+}
+
+__attribute__((always_inline))
+static inline void dedic_gpio_cpu_ll_write_mask(uint32_t mask, uint32_t value)
+{
+    RV_SET_CSR(CSR_GPIO_OUT_USER, mask & value);
+    RV_CLEAR_CSR(CSR_GPIO_OUT_USER, mask & ~(value));
+}
+
+#ifdef __cplusplus
+}
+#endif
--- a/components/soc/esp32p4/dedic_gpio_periph.c
+++ b/components/soc/esp32p4/dedic_gpio_periph.c
@ -0,0 +1,58 @@
+/*
+ * SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "soc/gpio_sig_map.h"
+#include "soc/dedic_gpio_periph.h"
+
+const dedic_gpio_signal_conn_t dedic_gpio_periph_signals = {
+    .irq = -1,
+    .cores = {
+        [0] = {
+            .in_sig_per_channel = {
+                [0] = CORE_GPIO_IN_PAD_IN0_IDX,
+                [1] = CORE_GPIO_IN_PAD_IN1_IDX,
+                [2] = CORE_GPIO_IN_PAD_IN2_IDX,
+                [3] = CORE_GPIO_IN_PAD_IN3_IDX,
+                [4] = CORE_GPIO_IN_PAD_IN4_IDX,
+                [5] = CORE_GPIO_IN_PAD_IN5_IDX,
+                [6] = CORE_GPIO_IN_PAD_IN6_IDX,
+                [7] = CORE_GPIO_IN_PAD_IN7_IDX,
+            },
+            .out_sig_per_channel = {
+                [0] = CORE_GPIO_OUT_PAD_OUT0_IDX,
+                [1] = CORE_GPIO_OUT_PAD_OUT1_IDX,
+                [2] = CORE_GPIO_OUT_PAD_OUT2_IDX,
+                [3] = CORE_GPIO_OUT_PAD_OUT3_IDX,
+                [4] = CORE_GPIO_OUT_PAD_OUT4_IDX,
+                [5] = CORE_GPIO_OUT_PAD_OUT5_IDX,
+                [6] = CORE_GPIO_OUT_PAD_OUT6_IDX,
+                [7] = CORE_GPIO_OUT_PAD_OUT7_IDX,
+            }
+        },
+        [1] = {
+            .in_sig_per_channel = {
+                [0] = CORE_GPIO_IN_PAD_IN8_IDX,
+                [1] = CORE_GPIO_IN_PAD_IN9_IDX,
+                [2] = CORE_GPIO_IN_PAD_IN10_IDX,
+                [3] = CORE_GPIO_IN_PAD_IN11_IDX,
+                [4] = CORE_GPIO_IN_PAD_IN12_IDX,
+                [5] = CORE_GPIO_IN_PAD_IN13_IDX,
+                [6] = CORE_GPIO_IN_PAD_IN14_IDX,
+                [7] = CORE_GPIO_IN_PAD_IN15_IDX,
+            },
+            .out_sig_per_channel = {
+                [0] = CORE_GPIO_OUT_PAD_OUT8_IDX,
+                [1] = CORE_GPIO_OUT_PAD_OUT9_IDX,
+                [2] = CORE_GPIO_OUT_PAD_OUT10_IDX,
+                [3] = CORE_GPIO_OUT_PAD_OUT11_IDX,
+                [4] = CORE_GPIO_OUT_PAD_OUT12_IDX,
+                [5] = CORE_GPIO_OUT_PAD_OUT13_IDX,
+                [6] = CORE_GPIO_OUT_PAD_OUT14_IDX,
+                [7] = CORE_GPIO_OUT_PAD_OUT15_IDX,
+            }
+        },
+    },
+};
--- a/components/soc/esp32p4/include/soc/Kconfig.soc_caps.in
+++ b/components/soc/esp32p4/include/soc/Kconfig.soc_caps.in
@ -7,6 +7,10 @@ config SOC_ANA_CMPR_SUPPORTED
    bool
    default y

+config SOC_DEDICATED_GPIO_SUPPORTED
+    bool
+    default y
+
 config SOC_UART_SUPPORTED
    bool
    default y
--- a/components/soc/esp32p4/include/soc/soc_caps.h
+++ b/components/soc/esp32p4/include/soc/soc_caps.h
@ -19,7 +19,7 @@
 /*-------------------------- COMMON CAPS ---------------------------------------*/
 // #define SOC_ADC_SUPPORTED               1  //TODO: IDF-6496
 #define SOC_ANA_CMPR_SUPPORTED          1
-// #define SOC_DEDICATED_GPIO_SUPPORTED    1  //TODO: IDF-7552
+#define SOC_DEDICATED_GPIO_SUPPORTED    1
 #define SOC_UART_SUPPORTED              1
 #define SOC_GDMA_SUPPORTED              1
 #define SOC_AHB_GDMA_SUPPORTED          1
--- a/docs/docs_not_updated/esp32p4.txt
+++ b/docs/docs_not_updated/esp32p4.txt
@ -77,7 +77,6 @@ api-reference/peripherals/touch_pad.rst
 api-reference/peripherals/adc_calibration.rst
 api-reference/peripherals/parlio.rst
 api-reference/peripherals/i2c.rst
-api-reference/peripherals/dedic_gpio.rst
 api-reference/peripherals/sd_pullup_requirements.rst
 api-reference/peripherals/index.rst
 api-reference/network/esp_openthread.rst
--- a/docs/en/api-reference/peripherals/dedic_gpio.rst
+++ b/docs/en/api-reference/peripherals/dedic_gpio.rst
@ -112,9 +112,7 @@ For advanced users, they can always manipulate the GPIOs by writing assembly cod

    For details of supported dedicated GPIO instructions, please refer to **{IDF_TARGET_NAME} Technical Reference Manual** > **Processor Instruction Extensions (PIE) (to be added later)** [`PDF <{IDF_TARGET_TRM_EN_URL}#pie>`__].

-.. only:: esp32c2 or esp32c3 or esp32c6 or esp32h2
-
-    Code examples for manipulating dedicated GPIOs from assembly are provided in the :example:`peripherals/dedicated_gpio` directory of ESP-IDF examples. These examples show how to emulate a UART, an I2C and an SPI bus in assembly thanks to dedicated GPIOs.
+.. only:: not (esp32s2 or esp32s3)

    For details of supported dedicated GPIO instructions, please refer to **{IDF_TARGET_NAME} Technical Reference Manual** > **ESP-RISC-V CPU** [`PDF <{IDF_TARGET_TRM_EN_URL}#riscvcpu>`__].

@ -152,12 +150,14 @@ Some of the dedicated CPU instructions are also wrapped inside ``hal/dedic_gpio_
        // wait for done semaphore
        xSemaphoreTake(sem, portMAX_DELAY);

-.. only:: SOC_DEDIC_GPIO_HAS_INTERRUPT

-    Application Example
-    -------------------
+Application Example
+-------------------

-    Matrix keyboard example based on dedicated GPIO: :example:`peripherals/gpio/matrix_keyboard`.
+.. list::
+
+    * Emulate UART/I2C/SPI peripherals in assembly with dedicate CPU instructions designed for manipulating the GPIOs: :example:`peripherals/dedicated_gpio`.
+    :SOC_DEDIC_GPIO_HAS_INTERRUPT: * Matrix keyboard example based on dedicated GPIO: :example:`peripherals/gpio/matrix_keyboard`.


 API Reference
--- a/docs/zh_CN/api-reference/peripherals/dedic_gpio.rst
+++ b/docs/zh_CN/api-reference/peripherals/dedic_gpio.rst
@ -112,9 +112,7 @@ GPIO 捆绑包操作

    有关支持的专用 GPIO 指令的详细信息，请参考 **{IDF_TARGET_NAME} 技术参考手册** > **处理器指令拓展 (PIE)（稍后发布）** [`PDF <{IDF_TARGET_TRM_CN_URL}#pie>`__].

-.. only:: esp32c2 or esp32c3 or esp32c6 or esp32h2
-
-    通过汇编操作专用 GPIO 的示例代码存放在 ESP-IDF 示例项目的 :example:`peripherals/dedicated_gpio` 目录下。示例演示了如何通过汇编操作专用 GPIO 来模拟 UART、I2C 和 SPI 总线。
+.. only:: not (esp32s2 or esp32s3)

    有关支持的专用 GPIO 指令的详细信息，请参考 **{IDF_TARGET_NAME} 技术参考手册** > **ESP-RISC-V CPU** [`PDF <{IDF_TARGET_TRM_CN_URL}#riscvcpu>`__]。

@ -152,12 +150,14 @@ GPIO 捆绑包操作
        // 等待完成信号量
        xSemaphoreTake(sem, portMAX_DELAY);

-.. only:: SOC_DEDIC_GPIO_HAS_INTERRUPT

-    应用示例
-    -------------------
+应用示例
+-------------------

-    基于专用 GPIO 的矩阵键盘示例：:example:`peripherals/gpio/matrix_keyboard`.
+.. list::
+
+    * 通过汇编代码使用专用的 CPU 指令来操作 GPIO 以模拟 UART/I2C/SPI 外设 :example:`peripherals/dedicated_gpio`.
+    :SOC_DEDIC_GPIO_HAS_INTERRUPT: * 基于专用 GPIO 驱动的矩阵键盘：:example:`peripherals/gpio/matrix_keyboard`.


 API 参考
--- a/examples/peripherals/dedicated_gpio/soft_i2c/README.md
+++ b/examples/peripherals/dedicated_gpio/soft_i2c/README.md
@ -1,5 +1,5 @@
-| Supported Targets | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-S2 | ESP32-S3 |
-| ----------------- | -------- | -------- | -------- | -------- | -------- | -------- |
+| Supported Targets | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
+| ----------------- | -------- | -------- | -------- | -------- | -------- | -------- | -------- |

 # Example: Software I2C Master via Dedicated/Fast GPIOs

--- a/examples/peripherals/dedicated_gpio/soft_spi/README.md
+++ b/examples/peripherals/dedicated_gpio/soft_spi/README.md
@ -1,5 +1,5 @@
-| Supported Targets | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 |
-| ----------------- | -------- | -------- | -------- | -------- |
+| Supported Targets | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 |
+| ----------------- | -------- | -------- | -------- | -------- | -------- |

 # Example: SPI software emulation using dedicated/fast GPIOs

--- a/examples/peripherals/dedicated_gpio/soft_uart/README.md
+++ b/examples/peripherals/dedicated_gpio/soft_uart/README.md
@ -1,5 +1,5 @@
-| Supported Targets | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-S2 | ESP32-S3 |
-| ----------------- | -------- | -------- | -------- | -------- | -------- | -------- |
+| Supported Targets | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
+| ----------------- | -------- | -------- | -------- | -------- | -------- | -------- | -------- |

 # Example: UART software emulation using dedicated/fast GPIOs