refactor(i2s): refactor i2s examples common dependencies

L-KAYA · L-KAYA · commit 75fb8bbe049a · 2024-12-24T12:07:45.000+08:00
Closes espressif#14751 Make the common I2S dependencies as an example common component, so that to avoid slash & backslash issue on windows when use absolute include path.
diff --git a/examples/peripherals/i2s/i2s_basic/i2s_pdm/main/CMakeLists.txt b/examples/peripherals/i2s/i2s_basic/i2s_pdm/main/CMakeLists.txt
@@ -9,5 +9,5 @@ if(CONFIG_SOC_I2S_SUPPORTS_PDM_RX AND CONFIG_EXAMPLE_PDM_RX)
 endif()
 
 idf_component_register(SRCS "${srcs}"
-                    PRIV_REQUIRES esp_driver_i2s esp_driver_gpio
-                    INCLUDE_DIRS "." "$ENV{IDF_PATH}/examples/peripherals/i2s/common")
+                    PRIV_REQUIRES esp_driver_i2s esp_driver_gpio i2s_examples_common
+                    INCLUDE_DIRS ".")
diff --git a/examples/peripherals/i2s/i2s_basic/i2s_pdm/main/idf_component.yml b/examples/peripherals/i2s/i2s_basic/i2s_pdm/main/idf_component.yml
@@ -0,0 +1,3 @@
+dependencies:
+  i2s_examples_common:
+    path: ${IDF_PATH}/examples/peripherals/i2s/i2s_examples_common
diff --git a/examples/peripherals/i2s/i2s_basic/i2s_std/main/CMakeLists.txt b/examples/peripherals/i2s/i2s_basic/i2s_std/main/CMakeLists.txt
@@ -1,3 +1,3 @@
 idf_component_register(SRCS "i2s_std_example_main.c"
-                    PRIV_REQUIRES esp_driver_i2s esp_driver_gpio
-                    INCLUDE_DIRS "." "$ENV{IDF_PATH}/examples/peripherals/i2s/common")
+                    PRIV_REQUIRES esp_driver_i2s esp_driver_gpio i2s_examples_common
+                    INCLUDE_DIRS ".")
diff --git a/examples/peripherals/i2s/i2s_basic/i2s_std/main/idf_component.yml b/examples/peripherals/i2s/i2s_basic/i2s_std/main/idf_component.yml
@@ -0,0 +1,3 @@
+dependencies:
+  i2s_examples_common:
+    path: ${IDF_PATH}/examples/peripherals/i2s/i2s_examples_common
diff --git a/examples/peripherals/i2s/i2s_basic/i2s_tdm/main/CMakeLists.txt b/examples/peripherals/i2s/i2s_basic/i2s_tdm/main/CMakeLists.txt
@@ -1,3 +1,3 @@
 idf_component_register(SRCS "i2s_tdm_example_main.c"
-                    PRIV_REQUIRES esp_driver_i2s esp_driver_gpio
-                    INCLUDE_DIRS "." "$ENV{IDF_PATH}/examples/peripherals/i2s/common")
+                    PRIV_REQUIRES esp_driver_i2s esp_driver_gpio i2s_examples_common
+                    INCLUDE_DIRS ".")
diff --git a/examples/peripherals/i2s/i2s_basic/i2s_tdm/main/idf_component.yml b/examples/peripherals/i2s/i2s_basic/i2s_tdm/main/idf_component.yml
@@ -0,0 +1,3 @@
+dependencies:
+  i2s_examples_common:
+    path: ${IDF_PATH}/examples/peripherals/i2s/i2s_examples_common
diff --git a/examples/peripherals/i2s/i2s_codec/i2s_es7210_tdm/main/CMakeLists.txt b/examples/peripherals/i2s/i2s_codec/i2s_es7210_tdm/main/CMakeLists.txt
@@ -1,4 +1,4 @@
 idf_component_register(SRCS "i2s_es7210_record_example.c"
-                       PRIV_REQUIRES esp_driver_i2s esp_driver_gpio fatfs
-                       INCLUDE_DIRS "$ENV{IDF_PATH}/examples/peripherals/i2s/common"
+                       PRIV_REQUIRES esp_driver_i2s esp_driver_gpio fatfs i2s_examples_common
+                       INCLUDE_DIRS
 )
diff --git a/examples/peripherals/i2s/i2s_codec/i2s_es7210_tdm/main/idf_component.yml b/examples/peripherals/i2s/i2s_codec/i2s_es7210_tdm/main/idf_component.yml
@@ -15,3 +15,5 @@ dependencies:
   #   # `public` flag doesn't have an effect dependencies of the `main` component.
   #   # All dependencies of `main` are public by default.
   #   public: true
+  i2s_examples_common:
+    path: ${IDF_PATH}/examples/peripherals/i2s/i2s_examples_common
diff --git a/examples/peripherals/i2s/i2s_codec/i2s_es8311/main/idf_component.yml b/examples/peripherals/i2s/i2s_codec/i2s_es8311/main/idf_component.yml
@@ -16,3 +16,5 @@ dependencies:
   #  version: "^1"
   #  rules:
   #    - if: "target in [esp32s3]"
+  i2s_examples_common:
+    path: ${IDF_PATH}/examples/peripherals/i2s/i2s_examples_common
diff --git a/examples/peripherals/i2s/i2s_examples_common/CMakeLists.txt b/examples/peripherals/i2s/i2s_examples_common/CMakeLists.txt
@@ -0,0 +1,2 @@
+# register I2S common dependencies as a component
+idf_component_register(INCLUDE_DIRS ".")
diff --git a/examples/peripherals/i2s/i2s_examples_common/format_wav.h b/examples/peripherals/i2s/i2s_examples_common/format_wav.h
diff --git a/examples/peripherals/i2s/i2s_examples_common/i2s_example_pins.h b/examples/peripherals/i2s/i2s_examples_common/i2s_example_pins.h
diff --git a/examples/peripherals/i2s/i2s_recorder/main/CMakeLists.txt b/examples/peripherals/i2s/i2s_recorder/main/CMakeLists.txt
@@ -1,3 +1,3 @@
 idf_component_register(SRCS "i2s_recorder_main.c"
-                    PRIV_REQUIRES esp_driver_i2s fatfs
-                    INCLUDE_DIRS "$ENV{IDF_PATH}/examples/peripherals/i2s/common")
+                    PRIV_REQUIRES esp_driver_i2s fatfs i2s_examples_common
+                    INCLUDE_DIRS)
diff --git a/examples/peripherals/i2s/i2s_recorder/main/idf_component.yml b/examples/peripherals/i2s/i2s_recorder/main/idf_component.yml
@@ -0,0 +1,3 @@
+dependencies:
+  i2s_examples_common:
+    path: ${IDF_PATH}/examples/peripherals/i2s/i2s_examples_common

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+dependencies:`
	`2`	`+ i2s_examples_common:`
	`3`	`+ path: ${IDF_PATH}/examples/peripherals/i2s/i2s_examples_common`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`idf_component_register(SRCS "i2s_es7210_record_example.c"`
`2`		`- PRIV_REQUIRES esp_driver_i2s esp_driver_gpio fatfs`
`3`		`- INCLUDE_DIRS "$ENV{IDF_PATH}/examples/peripherals/i2s/common"`
	`2`	`+ PRIV_REQUIRES esp_driver_i2s esp_driver_gpio fatfs i2s_examples_common`
	`3`	`+ INCLUDE_DIRS`
`4`	`4`	`)`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# register I2S common dependencies as a component`
	`2`	`+idf_component_register(INCLUDE_DIRS ".")`