Merge branch 'feature/add_cjc8910_codec_driver' into 'master'

feat(esp_codec_dev): Add support for cjc8910 codec

See merge request adf/esp-adf-internal!1418

Author: jason-mao

components/esp_codec_dev/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## v1.3.6
+
+### Feature
+
+- Added support for CJC8910 codec.
+
+### Bug Fixed
+
+- Added missing ES8389 include in `esp_codec_dev_defaults.h`.
+
 ## v1.3.5
 
 ### Feature
@@ -56,8 +66,8 @@
 
 ### Features
 
-- Add IDF v5.3 support  
-  Using new i2c driver `esp_driver_i2c`, add `bus_handle` configuration for `audio_codec_i2c_cfg_t`.  
+- Add IDF v5.3 support
+  Using new i2c driver `esp_driver_i2c`, add `bus_handle` configuration for `audio_codec_i2c_cfg_t`.
   User need create the `bus_handle` using API `i2c_new_master_bus` instead of `i2c_driver_install`.
 - Change test code to standalone application, user can directly build it under folder [codec_dev_test](test_apps/codec_dev_test)
 

components/esp_codec_dev/CMakeLists.txt

@@ -70,6 +70,10 @@ if (CONFIG_CODEC_ZL38063_SUPPORT)
     device/zl38063/example_apps/tw_spi_access.c)
 endif()
 
+if (CONFIG_CODEC_CJC8910_SUPPORT)
+  list(APPEND COMPONENT_SRCS device/cjc8910/cjc8910.c)
+endif()
+
 idf_component_register(SRCS "${COMPONENT_SRCS}"
                        INCLUDE_DIRS "${COMPONENT_ADD_INCLUDEDIRS}"
                        PRIV_INCLUDE_DIRS "${COMPONENT_PRIV_INCLUDEDIRS}"

components/esp_codec_dev/Kconfig

@@ -76,4 +76,10 @@ menu "Audio Codec Device Configuration"
         help
             Enable this option to support codec ZL38063.
             ZL38063 firmware only support xtensa, don't enable for RISC-V IC.
+
+    config CODEC_CJC8910_SUPPORT
+        bool "Support CJC8910 Codec Chip"
+        default n
+        help
+            Enable this option to support codec CJC8910.
  endmenu

components/esp_codec_dev/README.md

@@ -29,6 +29,7 @@ The currently supported codec devices are listed as below:
 |ES7243 |N|Y|
 |ES7243E |N|Y|
 |ES8156 |N|Y|
+|CJC8910 |Y|Y|
 
 
 ## Architecture overview

components/esp_codec_dev/README_CN.md

@@ -28,11 +28,12 @@
 |ES7243 |N|Y|
 |ES7243E |N|Y|
 |ES8156 |N|Y|
+|CJC8910 |Y|Y|
 
 
 ## 架构预览
 
-以编解码器设备 (ES8311) 为例，下面分别介绍硬件框图和软件架构。  
+以编解码器设备 (ES8311) 为例，下面分别介绍硬件框图和软件架构。
 编解码器设备 (ES8311) 和主芯片(ESP32-S3) 之间的硬件连接简图如下:
 ```mermaid
 graph LR;
@@ -79,7 +80,7 @@ class audio_codec_ctrl_if_t {
 	open()
 	read_reg()
 	write_reg()
-	close()    
+	close()
 }
 
 class audio_codec_gpio_if_t {
@@ -134,19 +135,19 @@ audio_codec_if_t ..> esp_codec_dev
 audio_codec_data_if_t ..> esp_codec_dev
 ```
 
-通讯通道抽象为两种接口: 
+通讯通道抽象为两种接口:
 * `audio_codec_ctrl_if_t` 控制接口：
-	主要提供 `read_reg` 和 `write_reg` API 来配置编解码器设备  
+	主要提供 `read_reg` 和 `write_reg` API 来配置编解码器设备
 	常用控制通道包括 I2C， SPI 等
 * `audio_codec_data_if_t` 数据接口：
-	主要提供 `read` 和 `write` API 用来交换音频数据  
+	主要提供 `read` 和 `write` API 用来交换音频数据
 	常用数据通道包括 I2S， SPI 等
 
 `esp_codec_dev` 为用户提供便捷的上层 API 来实现播放和录音功能。它是由 `audio_codec_data_if_t` 和 `audio_codec_if_t` 组成。`audio_codec_if_t` 对编解码器控制操作进行抽象，通过编解码器特有的配置参数构建（由 `audio_codec_ctrl_if_t` 和`audio_codec_gpio_if_t` 通过 `es8311_codec_cfg_t` 进行配置）。`audio_codec_gpio_if_t ` 对 IO 控制进行抽象，以适配主控 IO 或者扩展芯片 IO， 在编解码器内部进行调用用以匹配特有的设定时序。
 
 ## 解码器音量设定
 
-音量统一通过 API `esp_codec_dev_set_out_vol` 进行设定。  
+音量统一通过 API `esp_codec_dev_set_out_vol` 进行设定。
 `esp_codec_dev` 支持以下音量设定实现:
 1. 通过调节音量寄存器实现
 2. 在硬件不支持音量调节下，可以使用内置的软件音量实现 `audio_codec_new_sw_vol`
@@ -159,13 +160,13 @@ audio_codec_data_if_t ..> esp_codec_dev
 ## 使用方法
 
 以 ES8311 为例，下面将演示播放和录音的具体步骤
-1. 为编解码器设备的控制和数据总线安装驱动，可参考[test_board.c](test_apps/codec_dev_test/main/test_board.c)   
+1. 为编解码器设备的控制和数据总线安装驱动，可参考[test_board.c](test_apps/codec_dev_test/main/test_board.c)
    	```c
 	ut_i2c_init(0);
 	ut_i2s_init(0);
    	```
- 
-2. 为编解码器设备实现控制接口，数据接口和 GPIO 接口 (使用默认提供的接口实现)   
+
+2. 为编解码器设备实现控制接口，数据接口和 GPIO 接口 (使用默认提供的接口实现)
    	```c
 	audio_codec_i2s_cfg_t i2s_cfg = {
 	#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 0, 0)
@@ -181,7 +182,7 @@ audio_codec_data_if_t ..> esp_codec_dev
 	const audio_codec_gpio_if_t *gpio_if = audio_codec_new_gpio();
    	```
 
-3. 基于控制接口和 ES8311 特有的配置实现 `audio_codec_if_t` 接口  
+3. 基于控制接口和 ES8311 特有的配置实现 `audio_codec_if_t` 接口
    	```c
 	es8311_codec_cfg_t es8311_cfg = {
 	    .codec_mode = ESP_CODEC_DEV_WORK_MODE_BOTH,
@@ -193,7 +194,7 @@ audio_codec_data_if_t ..> esp_codec_dev
 	const audio_codec_if_t *out_codec_if = es8311_codec_new(&es8311_cfg);
    	```
 
-4. 通过 API `esp_codec_dev_new` 获取 `esp_codec_dev_handle_t` 句柄  
+4. 通过 API `esp_codec_dev_new` 获取 `esp_codec_dev_handle_t` 句柄
    参考下面代码用获取到的句柄来进行播放和录制操作:
 	```c
 	esp_codec_dev_cfg_t dev_cfg = {
@@ -221,8 +222,8 @@ audio_codec_data_if_t ..> esp_codec_dev
 
 ## 客制化编解码器设备
 
-1. 实现接口 `audio_codec_ctrl_if_t` 和 `audio_codec_data_if_t`  
-   如果使用 I2C 总线作控制，I2S 总线做数据传输，可以使用默认的接口实现：  
+1. 实现接口 `audio_codec_ctrl_if_t` 和 `audio_codec_data_if_t`
+   如果使用 I2C 总线作控制，I2S 总线做数据传输，可以使用默认的接口实现：
    `audio_codec_new_i2c_ctrl` 和 `audio_codec_new_i2s_data`
 
 2. 在第一步的基础上实现接口 `audio_codec_if_t`