Merge branch 'feature/esp32p4_pcnt_support' into 'master'

feat(pcnt): add support for ESP32P4

Closes IDF-7475

See merge request espressif/esp-idf!25149

Author: suda-morris

components/driver/Kconfig

@@ -308,38 +308,7 @@ menu "Driver Configurations"
 
     orsource "./gptimer/Kconfig.gptimer"
 
-    menu "PCNT Configuration"
-        depends on SOC_PCNT_SUPPORTED
-        config PCNT_CTRL_FUNC_IN_IRAM
-            bool "Place PCNT control functions into IRAM"
-            default n
-            help
-                Place PCNT control functions (like start/stop) into IRAM,
-                so that these functions can be IRAM-safe and able to be called in the other IRAM interrupt context.
-                Enabling this option can improve driver performance as well.
-
-        config PCNT_ISR_IRAM_SAFE
-            bool "PCNT ISR IRAM-Safe"
-            default n
-            help
-                Ensure the PCNT interrupt is IRAM-Safe by allowing the interrupt handler to be
-                executable when the cache is disabled (e.g. SPI Flash write).
-
-        config PCNT_SUPPRESS_DEPRECATE_WARN
-            bool "Suppress legacy driver deprecated warning"
-            default n
-            help
-                Wether to suppress the deprecation warnings when using legacy PCNT driver (driver/pcnt.h).
-                If you want to continue using the legacy driver, and don't want to see related deprecation warnings,
-                you can enable this option.
-
-        config PCNT_ENABLE_DEBUG_LOG
-            bool "Enable debug log"
-            default n
-            help
-                Wether to enable the debug log message for PCNT driver.
-                Note that, this option only controls the PCNT driver log, won't affect other drivers.
-    endmenu # PCNT Configuration
+    orsource "./pcnt/Kconfig.pcnt"
 
     menu "RMT Configuration"
         depends on SOC_RMT_SUPPORTED

components/driver/pcnt/Kconfig.pcnt

@@ -0,0 +1,32 @@
+menu "PCNT Configuration"
+    depends on SOC_PCNT_SUPPORTED
+    config PCNT_CTRL_FUNC_IN_IRAM
+        bool "Place PCNT control functions into IRAM"
+        default n
+        help
+            Place PCNT control functions (like start/stop) into IRAM,
+            so that these functions can be IRAM-safe and able to be called in the other IRAM interrupt context.
+            Enabling this option can improve driver performance as well.
+
+    config PCNT_ISR_IRAM_SAFE
+        bool "PCNT ISR IRAM-Safe"
+        default n
+        help
+            Ensure the PCNT interrupt is IRAM-Safe by allowing the interrupt handler to be
+            executable when the cache is disabled (e.g. SPI Flash write).
+
+    config PCNT_SUPPRESS_DEPRECATE_WARN
+        bool "Suppress legacy driver deprecated warning"
+        default n
+        help
+            Wether to suppress the deprecation warnings when using legacy PCNT driver (driver/pcnt.h).
+            If you want to continue using the legacy driver, and don't want to see related deprecation warnings,
+            you can enable this option.
+
+    config PCNT_ENABLE_DEBUG_LOG
+        bool "Enable debug log"
+        default n
+        help
+            Wether to enable the debug log message for PCNT driver.
+            Note that, this option only controls the PCNT driver log, won't affect other drivers.
+endmenu # PCNT Configuration

components/driver/pcnt/include/driver/pulse_cnt.h

@@ -61,8 +61,15 @@ typedef struct {
 typedef struct {
     int low_limit;  /*!< Low limitation of the count unit, should be lower than 0 */
     int high_limit; /*!< High limitation of the count unit, should be higher than 0 */
+#if SOC_PCNT_SUPPORT_ZERO_INPUT
+    int zero_input_gpio_num;  /*!< GPIO number used by the clear signal, the default active level is high, input mode with pull down enabled. Set to -1 if unused */
+#endif
     struct {
         uint32_t accum_count: 1; /*!< Whether to accumulate the count value when overflows at the high/low limit */
+#if SOC_PCNT_SUPPORT_ZERO_INPUT
+        uint32_t invert_zero_input: 1;   /*!< Invert the zero input signal and set input mode with pull up.*/
+        uint32_t io_loop_back: 1;        /*!< For debug/test, the signal output from the GPIO will be fed to the input path as well */
+#endif
     } flags;       /*!< Extra flags */
 } pcnt_unit_config_t;
 
@@ -253,6 +260,7 @@ esp_err_t pcnt_unit_register_event_callbacks(pcnt_unit_handle_t unit, const pcnt
 /**
  * @brief Add a watch point for PCNT unit, PCNT will generate an event when the counter value reaches the watch point value
  *
+ *
  * @param[in] unit PCNT unit handle created by `pcnt_new_unit()`
  * @param[in] watch_point Value to be watched
  * @return

components/driver/pcnt/pulse_cnt.c

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2021-2023 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -84,6 +84,7 @@ struct pcnt_unit_t {
     int unit_id;                                          // allocated unit numerical ID
     int low_limit;                                        // low limit value
     int high_limit;                                       // high limit value
+    int zero_input_gpio_num;                              // which gpio clear signal input
     int accum_value;                                      // accumulated count value
     pcnt_chan_t *channels[SOC_PCNT_CHANNELS_PER_UNIT];    // array of PCNT channels
     pcnt_watch_point_t watchers[PCNT_LL_WATCH_EVENT_MAX]; // array of PCNT watchers
@@ -226,6 +227,30 @@ esp_err_t pcnt_new_unit(const pcnt_unit_config_t *config, pcnt_unit_handle_t *re
     for (int i = 0; i < PCNT_LL_WATCH_EVENT_MAX; i++) {
         unit->watchers[i].event_id = PCNT_LL_WATCH_EVENT_INVALID; // invalid all watch point
     }
+
+#if SOC_PCNT_SUPPORT_ZERO_INPUT
+    // GPIO configuration
+    gpio_config_t gpio_conf = {
+        .intr_type = GPIO_INTR_DISABLE,
+        .mode = GPIO_MODE_INPUT | (config->flags.io_loop_back ? GPIO_MODE_OUTPUT : 0), // also enable the output path if `io_loop_back` is enabled
+        .pull_down_en = true,
+        .pull_up_en = false,
+    };
+
+    if (config->zero_input_gpio_num >= 0) {
+        if (config->flags.invert_zero_input) {
+            gpio_conf.pull_down_en = false;
+            gpio_conf.pull_up_en = true;
+        }
+        gpio_conf.pin_bit_mask = 1ULL << config->zero_input_gpio_num;
+        ESP_GOTO_ON_ERROR(gpio_config(&gpio_conf), err, TAG, "config zero GPIO failed");
+        esp_rom_gpio_connect_in_signal(config->zero_input_gpio_num,
+                                       pcnt_periph_signals.groups[group_id].units[unit_id].clear_sig,
+                                       config->flags.invert_zero_input);
+    }
+    unit->zero_input_gpio_num = config->zero_input_gpio_num;
+#endif // SOC_PCNT_SUPPORT_ZERO_INPUT
+
     ESP_LOGD(TAG, "new pcnt unit (%d,%d) at %p, count range:[%d,%d]", group_id, unit_id, unit, unit->low_limit, unit->high_limit);
     *ret_unit = unit;
     return ESP_OK;
@@ -249,6 +274,12 @@ esp_err_t pcnt_del_unit(pcnt_unit_handle_t unit)
         ESP_RETURN_ON_FALSE(!unit->channels[i], ESP_ERR_INVALID_STATE, TAG, "channel %d still in working", i);
     }
 
+#if SOC_PCNT_SUPPORT_ZERO_INPUT
+    if (unit->zero_input_gpio_num >= 0) {
+        gpio_reset_pin(unit->zero_input_gpio_num);
+    }
+#endif // SOC_PCNT_SUPPORT_ZERO_INPUT
+
     ESP_LOGD(TAG, "del unit (%d,%d)", group_id, unit_id);
     // recycle memory resource
     ESP_RETURN_ON_ERROR(pcnt_destroy(unit), TAG, "destroy pcnt unit failed");
@@ -742,6 +773,8 @@ IRAM_ATTR static void pcnt_default_isr(void *args)
     uint32_t intr_status = pcnt_ll_get_intr_status(group->hal.dev);
     if (intr_status & PCNT_LL_UNIT_WATCH_EVENT(unit_id)) {
         pcnt_ll_clear_intr_status(group->hal.dev, PCNT_LL_UNIT_WATCH_EVENT(unit_id));
+
+        // points watcher event
         uint32_t event_status = pcnt_ll_get_event_status(group->hal.dev, unit_id);
         // iter on each event_id
         while (event_status) {

components/driver/test_apps/pulse_cnt/main/test_pulse_cnt.c

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -20,6 +20,9 @@ TEST_CASE("pcnt_unit_install_uninstall", "[pcnt]")
     pcnt_unit_config_t unit_config = {
         .low_limit = -100,
         .high_limit = 100,
+#if SOC_PCNT_SUPPORT_ZERO_INPUT
+        .zero_input_gpio_num = -1,
+#endif
     };
     pcnt_unit_handle_t units[SOC_PCNT_UNITS_PER_GROUP];
     int count_value = 0;
@@ -77,6 +80,9 @@ TEST_CASE("pcnt_channel_install_uninstall", "[pcnt]")
     pcnt_unit_config_t unit_config = {
         .low_limit = -100,
         .high_limit = 100,
+#if SOC_PCNT_SUPPORT_ZERO_INPUT
+        .zero_input_gpio_num = -1,
+#endif
     };
     pcnt_chan_config_t chan_config = {
         .edge_gpio_num = TEST_PCNT_GPIO_A, // only detect edge signal in this case
@@ -165,6 +171,9 @@ TEST_CASE("pcnt_multiple_units_pulse_count", "[pcnt]")
     pcnt_unit_config_t unit_config = {
         .low_limit = -100,
         .high_limit = 100,
+#if SOC_PCNT_SUPPORT_ZERO_INPUT
+        .zero_input_gpio_num = -1,
+#endif
     };
     pcnt_unit_handle_t units[2];
     for (int i = 0; i < 2; i++) {
@@ -229,7 +238,10 @@ TEST_CASE("pcnt_quadrature_decode_event", "[pcnt]")
 {
     pcnt_unit_config_t unit_config = {
         .low_limit = -100,
-        .high_limit = 100
+        .high_limit = 100,
+#if SOC_PCNT_SUPPORT_ZERO_INPUT
+        .zero_input_gpio_num = -1,
+#endif
     };
 
     printf("install pcnt unit\r\n");
@@ -352,7 +364,10 @@ TEST_CASE("pcnt_zero_cross_mode", "[pcnt]")
 {
     pcnt_unit_config_t unit_config = {
         .low_limit = -100,
-        .high_limit = 100
+        .high_limit = 100,
+#if SOC_PCNT_SUPPORT_ZERO_INPUT
+        .zero_input_gpio_num = -1,
+#endif
     };
 
     printf("install pcnt unit\r\n");
@@ -445,6 +460,9 @@ TEST_CASE("pcnt_virtual_io", "[pcnt]")
     pcnt_unit_config_t unit_config = {
         .low_limit = -100,
         .high_limit = 100,
+#if SOC_PCNT_SUPPORT_ZERO_INPUT
+        .zero_input_gpio_num = -1,
+#endif
     };
     pcnt_chan_config_t chan_config = {
         .edge_gpio_num = TEST_PCNT_GPIO_A, // only detect edge signal in this case
@@ -490,3 +508,63 @@ TEST_CASE("pcnt_virtual_io", "[pcnt]")
     TEST_ESP_OK(pcnt_del_channel(chan));
     TEST_ESP_OK(pcnt_del_unit(unit));
 }
+
+#if SOC_PCNT_SUPPORT_ZERO_INPUT
+TEST_CASE("pcnt_zero_input_signal", "[pcnt]")
+{
+    pcnt_unit_config_t unit_config = {
+        .low_limit = -1000,
+        .high_limit = 1000,
+        .zero_input_gpio_num = TEST_PCNT_GPIO_Z,
+        .flags.io_loop_back = true,
+    };
+
+    printf("install pcnt unit\r\n");
+    pcnt_unit_handle_t unit = NULL;
+    TEST_ESP_OK(pcnt_new_unit(&unit_config, &unit));
+    pcnt_glitch_filter_config_t filter_config = {
+        .max_glitch_ns = 1000,
+    };
+    TEST_ESP_OK(pcnt_unit_set_glitch_filter(unit, &filter_config));
+
+    printf("install pcnt channels\r\n");
+    pcnt_chan_config_t chan_config = {
+        .level_gpio_num = -1,
+        .edge_gpio_num = TEST_PCNT_GPIO_A,
+        .flags.io_loop_back = true,
+    };
+    pcnt_channel_handle_t channel;
+
+    TEST_ESP_OK(pcnt_new_channel(unit, &chan_config, &channel));
+    TEST_ESP_OK(pcnt_channel_set_edge_action(channel, PCNT_CHANNEL_EDGE_ACTION_INCREASE, PCNT_CHANNEL_EDGE_ACTION_HOLD));
+    TEST_ESP_OK(pcnt_channel_set_level_action(channel, PCNT_CHANNEL_LEVEL_ACTION_KEEP, PCNT_CHANNEL_LEVEL_ACTION_KEEP));
+
+    printf("enable and start unit\r\n");
+
+    TEST_ESP_OK(pcnt_unit_enable(unit));
+    TEST_ESP_OK(pcnt_unit_start(unit));
+    TEST_ESP_OK(gpio_set_level(TEST_PCNT_GPIO_Z, 0));
+
+    // trigger 10 rising edge on GPIO
+    test_gpio_simulate_rising_edge(TEST_PCNT_GPIO_A, 10);
+
+    int count_value = 0;
+
+    TEST_ESP_OK(pcnt_unit_get_count(unit, &count_value));
+    printf("count_value=%d\r\n", count_value);
+    TEST_ASSERT_EQUAL(10, count_value);
+
+    printf("simulating zero input signal\r\n");
+    TEST_ESP_OK(gpio_set_level(TEST_PCNT_GPIO_Z, 1));
+    TEST_ESP_OK(gpio_set_level(TEST_PCNT_GPIO_Z, 0));
+
+    TEST_ESP_OK(pcnt_unit_get_count(unit, &count_value));
+    printf("count_value=%d\r\n", count_value);
+    TEST_ASSERT_EQUAL(0, count_value); // 0 after rst_sig
+
+    TEST_ESP_OK(pcnt_del_channel(channel));
+    TEST_ESP_OK(pcnt_unit_stop(unit));
+    TEST_ESP_OK(pcnt_unit_disable(unit));
+    TEST_ESP_OK(pcnt_del_unit(unit));
+}
+#endif // SOC_PCNT_SUPPORT_ZERO_INPUT

components/driver/test_apps/pulse_cnt/main/test_pulse_cnt_board.h

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -11,6 +11,7 @@ extern "C" {
 
 #define TEST_PCNT_GPIO_A 0
 #define TEST_PCNT_GPIO_B 2
+#define TEST_PCNT_GPIO_Z 4
 
 #if CONFIG_PCNT_ISR_IRAM_SAFE
 #define TEST_PCNT_CALLBACK_ATTR IRAM_ATTR

components/hal/esp32p4/include/hal/clk_gate_ll.h

@@ -112,6 +112,8 @@ static inline uint32_t periph_ll_get_clk_en_mask(periph_module_t periph)
         return HP_SYS_CLKRST_REG_CRYPTO_ECDSA_CLK_EN;
     case PERIPH_ISP_MODULE:
         return HP_SYS_CLKRST_REG_ISP_CLK_EN;
+    case PERIPH_PCNT_MODULE:
+        return HP_SYS_CLKRST_REG_PCNT_APB_CLK_EN;
     default:
         return 0;
     }
@@ -264,6 +266,7 @@ static inline uint32_t periph_ll_get_clk_en_reg(periph_module_t periph)
         return HP_SYS_CLKRST_PERI_CLK_CTRL119_REG;
     case PERIPH_MCPWM0_MODULE:
     case PERIPH_MCPWM1_MODULE:
+    case PERIPH_PCNT_MODULE:
         return HP_SYS_CLKRST_SOC_CLK_CTRL2_REG;
     case PERIPH_TIMG0_MODULE:
         return HP_SYS_CLKRST_PERI_CLK_CTRL20_REG;