Merge branch 'feature/c2_clean_up_not_supported_periphs' into 'master'

docs: remove peripherals docs that are not supported on C2

Closes IDF-4201, IDF-4673, and IDF-4658

See merge request espressif/esp-idf!17168

components/driver/CMakeLists.txt

@@ -55,25 +55,28 @@ if(CONFIG_SOC_SDMMC_HOST_SUPPORTED)
     list(APPEND srcs "sdmmc_transaction.c" "sdmmc_host.c")
 endif()
 
+if(CONFIG_SOC_I2S_SUPPORTED)
+    list(APPEND srcs "i2s.c")
+endif()
+
+if(CONFIG_SOC_TWAI_SUPPORTED)
+    list(APPEND srcs "twai.c")
+endif()
 
 if(${target} STREQUAL "esp32")
     list(APPEND srcs "dac_common.c"
                      "sdio_slave.c"
-                     "i2s.c"
                      "touch_sensor_common.c"
                      "esp32/touch_sensor.c"
                      "esp32/adc.c"
                      "adc_deprecated.c"
-                     "esp32/dac.c"
-                     "twai.c")
+                     "esp32/dac.c")
 endif()
 
 if(IDF_TARGET STREQUAL "esp32s2")
     list(APPEND srcs "dac_common.c"
                      "spi_slave_hd.c"
                      "touch_sensor_common.c"
-                     "i2s.c"
-                     "twai.c"
                      "esp32s2/rtc_tempsensor.c"
                      "esp32s2/touch_sensor.c"
                      "esp32s2/adc.c"
@@ -86,25 +89,19 @@ if(${target} STREQUAL "esp32s3")
     list(APPEND srcs "usb_serial_jtag.c"
                      "spi_slave_hd.c"
                      "touch_sensor_common.c"
-                     "esp32s3/touch_sensor.c"
-                     "i2s.c"
-                     "twai.c")
+                     "esp32s3/touch_sensor.c")
 endif()
 
 if(IDF_TARGET STREQUAL "esp32c3")
     list(APPEND srcs "spi_slave_hd.c"
                      "usb_serial_jtag.c"
-                     "i2s.c"
                      "esp32c3/adc2_init_cal.c"
-                     "esp32c3/rtc_tempsensor.c"
-                     "twai.c")
+                     "esp32c3/rtc_tempsensor.c")
 endif()
 
 if(IDF_TARGET STREQUAL "esp32h2")
     list(APPEND srcs "spi_slave_hd.c"
-                     "i2s.c"
-                     "esp32h2/rtc_tempsensor.c"
-                     "twai.c")
+                     "esp32h2/rtc_tempsensor.c")
 endif()
 
 if(IDF_TARGET STREQUAL "esp32c2")

components/soc/esp32c2/include/soc/Kconfig.soc_caps.in

@@ -159,18 +159,6 @@ config SOC_CPU_WATCHPOINT_SIZE
     hex
     default 0x80000000
 
-config SOC_DS_SIGNATURE_MAX_BIT_LEN
-    int
-    default 3072
-
-config SOC_DS_KEY_PARAM_MD_IV_LENGTH
-    int
-    default 16
-
-config SOC_DS_KEY_CHECK_MAX_WAIT_US
-    int
-    default 1100
-
 config SOC_GDMA_GROUPS
     int
     default 1
@@ -327,14 +315,6 @@ config SOC_SHA_SUPPORT_SHA256
     bool
     default y
 
-config SOC_SIGMADELTA_NUM
-    int
-    default 1
-
-config SOC_SIGMADELTA_CHANNEL_NUM
-    int
-    default 4
-
 config SOC_SPI_PERIPH_NUM
     int
     default 2

components/soc/esp32c2/include/soc/soc_caps.h

@@ -85,18 +85,6 @@
 
 #define SOC_CPU_WATCHPOINT_SIZE         0x80000000 // bytes
 
-/*-------------------------- DIGITAL SIGNATURE CAPS ----------------------------------------*/
-/** The maximum length of a Digital Signature in bits. */
-#define SOC_DS_SIGNATURE_MAX_BIT_LEN (3072)
-
-/** Initialization vector (IV) length for the RSA key parameter message digest (MD) in bytes. */
-#define SOC_DS_KEY_PARAM_MD_IV_LENGTH (16)
-
-
-/** Maximum wait time for DS parameter decryption key. If overdue, then key error.
-    See TRM DS chapter for more details */
-#define SOC_DS_KEY_CHECK_MAX_WAIT_US (1100)
-
 /*-------------------------- GDMA CAPS -------------------------------------*/
 #define SOC_GDMA_GROUPS                 (1U) // Number of GDMA groups
 #define SOC_GDMA_PAIRS_PER_GROUP        (1U) // Number of GDMA pairs in each group
@@ -188,10 +176,6 @@
 #define SOC_SHA_SUPPORT_SHA224          (1)
 #define SOC_SHA_SUPPORT_SHA256          (1)
 
-/*-------------------------- SIGMA DELTA CAPS --------------------------------*/
-#define SOC_SIGMADELTA_NUM         (1U) // 1 sigma-delta peripheral
-#define SOC_SIGMADELTA_CHANNEL_NUM (4)  // 4 channels
-
 /*-------------------------- SPI CAPS ----------------------------------------*/
 #define SOC_SPI_PERIPH_NUM          2
 #define SOC_SPI_PERIPH_CS_NUM(i)    6

docs/conf_common.py

@@ -90,6 +90,12 @@ XTENSA_DOCS = ['api-guides/hlinterrupts.rst',
 
 RISCV_DOCS = []  # type: list[str]
 
+TWAI_DOCS = ['api-reference/peripherals/twai.rst']
+
+SIGMADELTA_DOCS = ['api-reference/peripherals/sigmadelta.rst']
+
+I2S_DOCS = ['api-reference/peripherals/i2s.rst']
+
 ESP32_DOCS = ['api-guides/ulp_instruction_set.rst',
               'api-reference/system/himem.rst',
               'api-guides/romconsole.rst',
@@ -142,6 +148,9 @@ conditional_include_dict = {'SOC_BT_SUPPORTED':BT_DOCS,
                             'CONFIG_IDF_TARGET_ARCH_XTENSA':XTENSA_DOCS,
                             'CONFIG_IDF_TARGET_ARCH_RISCV':RISCV_DOCS,
                             'SOC_TEMP_SENSOR_SUPPORTED':TEMP_SENSOR_DOCS,
+                            'SOC_TWAI_SUPPORTED':TWAI_DOCS,
+                            'SOC_I2S_SUPPORTED':I2S_DOCS,
+                            'SOC_SIGMADELTA_SUPPORTED':SIGMADELTA_DOCS,
                             'esp32':ESP32_DOCS,
                             'esp32s2':ESP32S2_DOCS,
                             'esp32s3':ESP32S3_DOCS,

docs/docs_not_updated/esp32c2.txt

@@ -85,36 +85,20 @@ api-reference/storage/sdmmc
 api-reference/storage/mass_mfg
 api-reference/storage/index
 api-reference/peripherals/adc
-api-reference/peripherals/usb_host
-api-reference/peripherals/sigmadelta
-api-reference/peripherals/twai
-api-reference/peripherals/hmac
-api-reference/peripherals/usb_device
 api-reference/peripherals/gpio
 api-reference/peripherals/sdspi_host
-api-reference/peripherals/dac
 api-reference/peripherals/spi_slave
-api-reference/peripherals/i2s
-api-reference/peripherals/pcnt
-api-reference/peripherals/touch_element
 api-reference/peripherals/lcd
-api-reference/peripherals/mcpwm
 api-reference/peripherals/secure_element
 api-reference/peripherals/ledc
 api-reference/peripherals/temp_sensor
 api-reference/peripherals/spi_features
-api-reference/peripherals/sdio_slave
-api-reference/peripherals/touch_pad
 api-reference/peripherals/spi_slave_hd
-api-reference/peripherals/ds
 api-reference/peripherals/i2c
 api-reference/peripherals/dedic_gpio
-api-reference/peripherals/sd_pullup_requirements
 api-reference/peripherals/spi_master
 api-reference/peripherals/index
-api-reference/peripherals/sdmmc_host
 api-reference/peripherals/uart
-api-reference/peripherals/rmt
 api-reference/kconfig
 api-reference/network/esp_openthread
 api-reference/network/esp_eth

docs/en/api-reference/peripherals/index.rst

@@ -14,7 +14,7 @@ Peripherals API
     :SOC_HMAC_SUPPORTED: hmac
     :SOC_DIG_SIGN_SUPPORTED: ds
     i2c
-    i2s
+    :SOC_I2S_SUPPORTED: i2s
     lcd
     ledc
     :SOC_MCPWM_SUPPORTED: mcpwm
@@ -24,7 +24,7 @@ Peripherals API
     :SOC_SDMMC_HOST_SUPPORTED: sdmmc_host
     sdspi_host
     :SOC_SDIO_SLAVE_SUPPORTED: sdio_slave
-    sigmadelta
+    :SOC_SIGMADELTA_SUPPORTED: sigmadelta
     spi_master
     spi_slave
     :esp32: secure_element
@@ -32,7 +32,7 @@ Peripherals API
     :SOC_TEMP_SENSOR_SUPPORTED: temp_sensor
     :SOC_TOUCH_SENSOR_NUM: touch_pad
     :esp32s2: touch_element
-    twai
+    :SOC_TWAI_SUPPORTED: twai
     uart
     :SOC_USB_OTG_SUPPORTED: usb_device
     :SOC_USB_OTG_SUPPORTED: usb_host

docs/zh_CN/api-reference/peripherals/index.rst

@@ -14,17 +14,17 @@
     :SOC_HMAC_SUPPORTED: hmac
     :SOC_DIG_SIGN_SUPPORTED: ds
     i2c
-    i2s
+    :SOC_I2S_SUPPORTED: i2s
     lcd
     ledc
     :SOC_MCPWM_SUPPORTED: mcpwm
     :SOC_PCNT_SUPPORTED: pcnt
     :SOC_RMT_SUPPORTED: rmt
-    :esp32 or esp32s3: sd_pullup_requirements
+    :SOC_SDMMC_HOST_SUPPORTED: sd_pullup_requirements
     :SOC_SDMMC_HOST_SUPPORTED: sdmmc_host
     sdspi_host
     :SOC_SDIO_SLAVE_SUPPORTED: sdio_slave
-    sigmadelta
+    :SOC_SIGMADELTA_SUPPORTED: sigmadelta
     spi_master
     spi_slave
     :esp32: secure_element
@@ -32,7 +32,7 @@
     :SOC_TEMP_SENSOR_SUPPORTED: temp_sensor
     :SOC_TOUCH_SENSOR_NUM: touch_pad
     :esp32s2: touch_element
-    twai
+    :SOC_TWAI_SUPPORTED: twai
     uart
     :SOC_USB_OTG_SUPPORTED: usb_device
     :SOC_USB_OTG_SUPPORTED: usb_host