From 8bb8c144c73430b907e28c116fea7eac581869f6 Mon Sep 17 00:00:00 2001 From: laokaiyao Date: Wed, 26 Apr 2023 22:50:53 +0800 Subject: [PATCH] i2s_doc: fixed the data of stereo left/right state --- docs/en/api-reference/peripherals/i2s.rst | 4 ++-- docs/zh_CN/api-reference/peripherals/i2s.rst | 18 +++++++++--------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/en/api-reference/peripherals/i2s.rst b/docs/en/api-reference/peripherals/i2s.rst index 5cdaab8152..e8a0f04319 100644 --- a/docs/en/api-reference/peripherals/i2s.rst +++ b/docs/en/api-reference/peripherals/i2s.rst @@ -367,9 +367,9 @@ Here is the table of the real data on the line with different :cpp:member:`i2s_s | | +-----------+----------+----------+----------+----------+----------+----------+----------+----------+ | | | both | 0x0001 | 0x0001 | 0x0002 | 0x0002 | 0x0003 | 0x0003 | 0x0004 | 0x0004 | | +-----------+-----------+----------+----------+----------+----------+----------+----------+----------+----------+ - | | stereo | left | 0x0001 | 0x0001 | 0x0003 | 0x0003 | 0x0005 | 0x0005 | 0x0007 | 0x0007 | + | | stereo | left | 0x0001 | 0x0000 | 0x0003 | 0x0000 | 0x0005 | 0x0000 | 0x0007 | 0x0000 | | | +-----------+----------+----------+----------+----------+----------+----------+----------+----------+ - | | | right | 0x0002 | 0x0002 | 0x0004 | 0x0004 | 0x0006 | 0x0006 | 0x0008 | 0x0008 | + | | | right | 0x0000 | 0x0002 | 0x0000 | 0x0004 | 0x0000 | 0x0006 | 0x0000 | 0x0008 | | | +-----------+----------+----------+----------+----------+----------+----------+----------+----------+ | | | both | 0x0001 | 0x0002 | 0x0003 | 0x0004 | 0x0005 | 0x0006 | 0x0007 | 0x0008 | +----------------+-----------+-----------+----------+----------+----------+----------+----------+----------+----------+----------+ diff --git a/docs/zh_CN/api-reference/peripherals/i2s.rst b/docs/zh_CN/api-reference/peripherals/i2s.rst index c373c91723..e86b797909 100644 --- a/docs/zh_CN/api-reference/peripherals/i2s.rst +++ b/docs/zh_CN/api-reference/peripherals/i2s.rst @@ -111,10 +111,10 @@ I2S 通信模式 ========= ======== ======== ======== ======== ======== ========== ESP32 I2S 0/1 I2S 0 I2S 0 无 I2S 0 I2S 0 ESP32-S2 I2S 0 无 无 无 无 I2S 0 -ESP32-C3 I2S 0 I2S 0 无 I2S 0 无 无 -ESP32-C6 I2S 0 I2S 0 无 I2S 0 无 无 -ESP32-S3 I2S 0/1 I2S 0 I2S 0 I2S 0/1 无 无 -ESP32-H2 I2S 0 I2S 0 无 I2S 0 无 无 +ESP32-C3 I2S 0 I2S 0 无 I2S 0 无 无 +ESP32-C6 I2S 0 I2S 0 无 I2S 0 无 无 +ESP32-S3 I2S 0/1 I2S 0 I2S 0 I2S 0/1 无 无 +ESP32-H2 I2S 0 I2S 0 无 I2S 0 无 无 ========= ======== ======== ======== ======== ======== ========== 标准模式 @@ -202,7 +202,7 @@ ESP32-H2 I2S 0 I2S 0 无 I2S 0 无 无 ADC/DAC 模式 ^^^^^^^^^^^^^ - 仅 ESP32 支持在 I2S0 上运行 ADC 和 DAC 模式。实际上，ADC 和 DAC 模式是 LCD/摄像头模式的两个子模式。I2S0 可以直接路由到内部模数转换器 (ADC) 和数模转换器 (DAC)，也即 ADC 和 DAC 外设可以通过 I2S0 的 DMA 连续读取或写入数据。由于 ADC 和 DAC 并非通信模式，因此并没有在 I2S 驱动中实现。 + 仅 ESP32 支持在 I2S0 上运行 ADC 和 DAC 模式。实际上，ADC 和 DAC 模式是 LCD/摄像头模式的两个子模式。I2S0 可以直接连接到内部模数转换器 (ADC) 和数模转换器 (DAC)，也即 ADC 和 DAC 外设可以通过 I2S0 的 DMA 连续读取或写入数据。由于 ADC 和 DAC 并非通信模式，因此并没有在 I2S 驱动中实现。 功能概览 -------- @@ -367,15 +367,15 @@ STD TX 模式 | | +-----------+----------+----------+----------+----------+----------+----------+----------+----------+ | | | 左右 | 0x0001 | 0x0001 | 0x0002 | 0x0002 | 0x0003 | 0x0003 | 0x0004 | 0x0004 | | +-----------+-----------+----------+----------+----------+----------+----------+----------+----------+----------+ - | | 立体声 | 左 | 0x0001 | 0x0001 | 0x0003 | 0x0003 | 0x0005 | 0x0005 | 0x0007 | 0x0007 | + | | 立体声 | 左 | 0x0001 | 0x0000 | 0x0003 | 0x0000 | 0x0005 | 0x0000 | 0x0007 | 0x0000 | | | +-----------+----------+----------+----------+----------+----------+----------+----------+----------+ - | | | 右 | 0x0002 | 0x0002 | 0x0004 | 0x0004 | 0x0006 | 0x0006 | 0x0008 | 0x0008 | + | | | 右 | 0x0000 | 0x0002 | 0x0000 | 0x0004 | 0x0000 | 0x0006 | 0x0000 | 0x0008 | | | +-----------+----------+----------+----------+----------+----------+----------+----------+----------+ | | | 左右 | 0x0001 | 0x0002 | 0x0003 | 0x0004 | 0x0005 | 0x0006 | 0x0007 | 0x0008 | +----------------+-----------+-----------+----------+----------+----------+----------+----------+----------+----------+----------+ .. note:: - + 数据位宽为 8 位和 32 位时，缓冲区的类型最好为 ``uint8_t`` 和 ``uint32_t``。但需注意，数据位宽为 24 位时，数据缓冲区应该以 3 字节对齐，即每 3 个字节代表一个 24 位数据，另外，:cpp:member:`i2s_chan_config_t::dma_frame_num`、 :cpp:member:`i2s_std_clk_config_t::mclk_multiple` 和写缓冲区的大小应该为 ``3`` 的倍数，否则线路上的数据或采样率可能会不准确。 .. code-block:: c @@ -680,7 +680,7 @@ STD RX 模式 +-----------+-----------+----------+----------+----------+----------+----------+----------+----------+----------+ | 立体声 | 左右 | 0x0002 | 0x0001 | 0x0004 | 0x0003 | 0x0006 | 0x0005 | 0x0008 | 0x0007 | +-----------+-----------+----------+----------+----------+----------+----------+----------+----------+----------+ - + .. note:: 在立体声模式下，右声道先被接收。如需切换缓冲区中的左右声道，可设置 :cpp:member:`i2s_pdm_rx_gpio_config_t::invert_flags::clk_inv` 来强制反转时钟信号。