I2S 从模式双向传输示例

📁 源码位置: samples/drivers/devices/lisa_i2s/slave_rx_tx 查看源码

功能说明

演示如何使用 I2S 从模式同时进行发送和接收（全双工）。从设备接收主设备产生的时钟信号（BCK 和 LRCK），并通过 DOUT 引脚发送数据，同时通过 DIN 引脚接收数据。

示例支持 ARCS EVB 和 Venusa RD EVB，构建时会根据 BOARD 选择对应的 I2S 设备、引脚、内部 SRAM 堆大小和 DMA 缓冲模式。

配置为标准 I2S 协议，16kHz 采样率、16位数据宽度、立体声模式。

硬件连接

ARCS EVB

  • PA12: I2S0_BCK（位时钟输入，由主设备提供）

  • PA13: I2S0_LRCK（帧时钟/字选择输入，由主设备提供）

  • PA14: I2S0_DIN（数据输入）

  • PA15: I2S0_DOUT（数据输出）

连接到外部 I2S 主设备。从设备必须连接到主设备才能正常工作。

当前 ARCS EVB 板型配置启用 I2S1，PA12、PA13、PA14 和 PA15 分别复用为 I2S1_BCK、I2S1_LRCK、I2S1_DIN 和 I2S1_DOUT。

Venusa RD EVB

  • PA4: I2S0_BCK（位时钟输入，由主设备提供）

  • PA5: I2S0_LRCK（帧时钟/字选择输入，由主设备提供）

  • PA6: I2S0_DIN（数据输入）

  • PA7: I2S0_DOUT（数据输出）

使用 I2S0 驱动。将主设备的 BCK 和 LRCK 连接到 PA4 和 PA5，主设备 DOUT 连接 PA6，主设备 DIN 连接 PA7，并确保两端 GND 共地。

使用场景

适用于以下场景：

  • 从设备全双工音频通信

  • 音频回环测试（从设备端）

  • 同时向主设备发送和接收音频数据

  • 主设备控制时钟的双向传输场景

示例步骤

  1. 初始化发送缓冲区

  2. 获取 I2S0 设备

  3. 配置 I2S（从模式，标准 I2S，16位，16kHz，立体声，双向）

  4. 设置事件回调函数

  5. 预先加载要发送的数据（CONFIG_LISA_I2S_BLOCK_COUNT - 1 次），write 返回 0 时计入 tx_queued_count

  6. 启动 I2S 双向传输

  7. 创建 TX/RX 两个任务：两任务各自先等待启动门闩，只有两个任务都创建成功后才由主任务用 xTaskNotifyGive() 放行

  8. 两个任务并发执行：TX 任务写 3 次、RX 任务读 3 次，每次 I/O 超时 100 ms；无外部主时钟时超时仅记录日志，I/O 结果不作为成功条件；write 返回 0 时计入 tx_queued_count

  9. 任务结束后分别用 xTaskNotify() 置 TX/RX 完成位，主任务等待聚合两个完成位

  10. 有界等待 TX_DONE 排空：有主时钟时等待 tx_done_count 追上 tx_queued_count 并输出排空日志；无主时钟时最多等待 500 ms 后输出超时日志

  11. 停止 I2S 收发；STOP 成功后输出 LISA I2S SLAVE RX TX stopped

ARCS EVB 使用 I2S1，Venusa RD EVB 使用 I2S0；板型对应的设备和引脚由 board_configs/<BOARD>.conf 与板型配置宏自动选择。

自动测试说明

本示例的自动测试只验证 I2S 从模式的配置、START、TX/RX 两个任务并发的 3 次读写尝试、有界等待排空和 STOP 生命周期是否正常执行，不能证明收发数据正确。从模式下 BCK、LRCK 以及收发数据都需要外部主设备配合：

  • static volatile tx_done_count 由 LISA_I2S_EVENT_TX_DONE 回调递增；tx_queued_count 统计预加载阶段和 TX 任务 3 次写循环中 lisa_i2s_write() 返回 0（入队成功）的块数

  • 有主时钟时：每个 DMA 块发送完成会触发 LISA_I2S_EVENT_TX_DONE 回调，主任务 最多等待 500 ms，直到 tx_done_count >= tx_queued_count 并输出排空日志

  • 无主时钟时：lisa_i2s_write() 与 lisa_i2s_read() 在等待 100 ms 后返回 -7， 已成功入队的块无法排空，主任务在 500 ms 超时后输出 TX not drained 日志并继续执行 STOP

CI 环境没有外部主设备时，排空超时属于预期行为，不影响测试通过。测试通过的唯一标志是 STOP 成功后输出的 LISA I2S SLAVE RX TX stopped。

编译

重要提示：编译前需要先确认当前示例支持的目标板型，然后将板型标识传给 -DBOARD。请按以下方式选择：

  1. 确认示例限制：查看当前示例 README 中的硬件连接和注意事项，确认是否限定板型。

  2. 参考示例配置：查看相关示例目录下的 sample.yaml，确认支持的板型。

  3. 填写板型标识：SDK 内置板型的标识为 boards/ 下的目录名。例如实际使用的板型目录为 boards/<板型名称>/，则编译参数填写为 -DBOARD=<板型名称>。

在 SDK 根目录执行编译，并将命令中的 <示例路径> 和 <板型名称> 替换为实际值。

Linux 使用 build.sh：

# 通用命令
./build.sh -C -S samples/<示例路径> -DBOARD=<板型名称>

# 示例：使用 arcs_evb 开发板
./build.sh -C -S samples/<示例路径> -DBOARD=arcs_evb

Windows PowerShell 使用 build.ps1：

# 通用命令
.\build.ps1 -C -S samples/<示例路径> -DBOARD=<板型名称>

# 示例：使用 arcs_evb 开发板
.\build.ps1 -C -S samples/<示例路径> -DBOARD=arcs_evb

Note

确保已安装对应平台的工具链和 ListenAI 开发工具包。Windows 环境请先执行 .\env.ps1 或直接使用 .\build.ps1 自动加载环境。

注意事项：-DBOARD 填写的是板型标识，不是芯片系列名称。如果示例有板型专用配置或额外编译参数，以示例 README 中的说明为准。

在 SDK 根目录使用以下命令选择目标板型：

# ARCS EVB
./build.sh -C -S samples/drivers/devices/lisa_i2s/slave_rx_tx -DBOARD=arcs_evb

# Venusa RD EVB
./build.sh -C -S samples/drivers/devices/lisa_i2s/slave_rx_tx -DBOARD=venusa_rd_evb

烧录

编译完成后，使用 SDK tools/burn 目录下的 cskburn 工具烧录固件。请先根据目标板型和当前示例确定芯片系列、串口设备、烧录地址和固件路径。

Linux：

# 通用命令
./tools/burn/cskburn -C <芯片系列> -s <串口设备> -b 3000000 <烧录地址> <固件路径>

# 示例：使用 arcs_evb 开发板
./tools/burn/cskburn -s /dev/ttyUSB0 -b 3000000 0x0 build/arcs.bin -C arcs

Windows PowerShell：

# 通用命令
.\tools\burn\cskburn.exe -C <芯片系列> -s <串口号> -b 3000000 <烧录地址> <固件路径>

# 示例：使用 arcs_evb 开发板
.\tools\burn\cskburn.exe -C arcs -s COM7 -b 3000000 0x0 .\build\arcs.bin

Note

烧录参数说明：

  • -s /dev/ttyUSB0 / -s COM7：串口设备路径，需要根据实际情况修改 - Linux 系统：通常是 /dev/ttyUSB0 或 /dev/ttyACM0 - 可通过 ls /dev/tty* 命令查看可用串口设备 - Windows 系统：通常是 COM7、COM8 等，可在“设备管理器”的“端口”中查看 - 不同开发板或 USB 转串口芯片可能使用不同的设备名

  • -b 3000000：烧录波特率（3Mbps）

  • 0x0：烧录起始地址

  • build/arcs.bin / .\build\arcs.bin：编译生成的固件路径

  • -C arcs：芯片类型

注意事项：

  • 确保开发板已正确连接到电脑

  • 如果无法识别串口设备，请检查 USB 连接线是否正常，或尝试其他 USB 端口

预期输出

终端输出：

  • 外部 i2s master 没有启动

********Arcs SDK 0.1.2 @ v0.0.1-917-g14ea2d8ccfe3********
Running on hart-id: 1
I/elog            [1034:42:44.159 1 elog_async] EasyLogger V2.2.99 is initialize success.
I/main            [1034:42:44.160 1 main] ========================================
I/main            [1034:42:44.160 1 main]   LISA I2S SLAVE TX RX Example
I/main            [1034:42:44.160 1 main] ========================================
I/lisa_i2s_arcs   [1034:42:44.161 1 main] one transfer size: 1024
I/lisa_i2s_arcs   [1034:42:44.161 1 main] I2S1 Control: control=0x5a026, argv=0x0
I/lisa_i2s_arcs   [1034:42:44.161 1 main] I2S configured: mode=1, protocol=0, data_width=0, bit_order: 0, sample_rate=16000, slot_mask=3, direction=3, echo=0, echo_slot_mask=0, use_tdm=0, tdm_slots=0, block_size:1024
I/lisa_i2s_arcs   [1034:42:44.161 1 main] I2S start RX: data=0x2800ce00, len=512, slot_mask=3, start_now=0
I/lisa_i2s_arcs   [1034:42:44.162 1 main] I2S start TX: data=0x2800bd80, len=512, slot_mask=3, start_now=0
I/lisa_i2s_arcs   [1034:42:44.162 1 main] I2S RX TX started
E/main            [1034:42:44.562 1 i2s tx] Failed to send data: -7
E/main            [1034:42:44.662 1 i2s rx] Failed to receive data: -7
E/main            [1034:42:44.762 1 i2s tx] Failed to send data: -7
E/main            [1034:42:44.862 1 i2s rx] Failed to receive data: -7
E/main            [1034:42:44.962 1 i2s tx] Failed to send data: -7
E/main            [1034:42:45.062 1 i2s rx] Failed to receive data: -7
W/main            [1034:42:45.562 1 main] TX not drained in 500 ms: done=0 queued=4
I/main            [1034:42:45.563 1 main] LISA I2S SLAVE RX TX stopped

  • 外部 i2s master 启动收发之后

I/main            [1034:42:44.623 1 isr] TX completed
I/main            [1034:42:44.638 1 isr] RX completed
I/main            [1034:42:44.654 1 isr] TX completed
I/main            [1034:42:44.670 1 isr] RX completed
...
I/main            [1034:42:44.703 1 main] TX drained: done=N queued=N
I/main            [1034:42:44.704 1 main] LISA I2S SLAVE RX TX stopped

以上日志为示意：TX completed 次数与 done/queued 具体数值以 CONFIG_LISA_I2S_BLOCK_COUNT 和循环中 lisa_i2s_write() 成功入队的块数为准；排空完成的标志是 done 追上 queued。

TX 与 RX 两个任务并发执行：Failed to send data 来自 i2s tx 任务、Failed to receive data 来自 i2s rx 任务，两任务的日志顺序随调度交错，示例中的先后顺序不代表固定时序。

主设备正常收发时，lisa_i2s_read() 成功还会输出 Received 1024 bytes data 及前 8 个字节数据；TX completed 与 RX completed 的先后顺序随驱动调度交错，不影响排空判定。

Venusa RD EVB 终端输出：

Venusa RD EVB 正常收发时的应用层关键日志与 ARCS EVB 一致：

I/main            LISA I2S SLAVE TX RX Example
I/main            TX completed
I/main            RX completed
I/main            Received 1024 bytes data
I/main            [0] 0 [1] 1 [2] 2 [3] 3
[4] 4 [5] 5 [6] 6 [7] 7

如果外部 I2S 主设备尚未输出 BCK、LRCK 和数据，lisa_i2s_write() 与 lisa_i2s_read() 会在等待 100 ms 后返回 -7，属于预期行为，不影响 STOP 成功标志；主设备启动全双工收发后即可正常传输。TX completed 表示发送端完成一个缓冲区传输，RX completed 表示接收端完成一个缓冲区接收，均不证明数据内容正确；自动测试以 STOP 后的 LISA I2S SLAVE RX TX stopped 作为唯一成功标志。

核心 API

API

说明

lisa_device_get()

获取 I2S 设备

lisa_i2s_configure()

配置 I2S 参数

lisa_i2s_set_callback()

设置事件回调

lisa_i2s_write()

发送数据（非阻塞）

lisa_i2s_read()

接收数据（阻塞）

lisa_i2s_trigger()

启动/停止 I2S

关键代码

/* 全局：TX_DONE 计数由 ISR 回调递增，主任务在等待循环中读取 */
static volatile uint32_t tx_done_count = 0;
static volatile uint32_t tx_queued_count = 0;
static TaskHandle_t main_task_handle = NULL;

/* 任务完成通知位：TX/RX 任务各置一个 bit，主任务聚合两个 bit */
#define TX_TASK_DONE_BIT   (1UL << 0)
#define RX_TASK_DONE_BIT   (1UL << 1)
#define TASK_DONE_ALL_BITS (TX_TASK_DONE_BIT | RX_TASK_DONE_BIT)

/* TX 任务：等待启动门闩后固定写 3 次，结束置完成位并自删 */
static void i2s_tx_task(void *pvParameters)
{
    lisa_device_t *i2s_dev = (lisa_device_t *)pvParameters;
    ulTaskNotifyTake(pdTRUE, portMAX_DELAY);
    for (int i = 0; i < TX_RX_ROUNDS; i++) {
        int ret = lisa_i2s_write(i2s_dev, (uint32_t *)tx_buffer,
                                 BLOCK_SIZE / sizeof(uint32_t), 100);
        if (ret < 0) {
            LISA_LOGE(TAG, "Failed to send data: %d", ret);
        } else {
            tx_queued_count++;
        }
    }
    xTaskNotify(main_task_handle, TX_TASK_DONE_BIT, eSetBits);
    vTaskDelete(NULL);
}

/* RX 任务：等待启动门闩后固定读 3 次，结束置完成位并自删 */
static void i2s_rx_task(void *pvParameters)
{
    lisa_device_t *i2s_dev = (lisa_device_t *)pvParameters;
    uint8_t *rx_buffer = NULL;
    uint32_t len = 0;
    ulTaskNotifyTake(pdTRUE, portMAX_DELAY);
    for (int i = 0; i < TX_RX_ROUNDS; i++) {
        int ret = lisa_i2s_read(i2s_dev, &rx_buffer, &len, 100);
        if (ret < 0) {
            LISA_LOGE(TAG, "Failed to receive data: %d", ret);
        } else {
            LISA_LOGI(TAG, "Received %d bytes data", len);
        }
    }
    xTaskNotify(main_task_handle, RX_TASK_DONE_BIT, eSetBits);
    vTaskDelete(NULL);
}

/* 1. 获取 I2S 设备并复位计数 */
lisa_device_t *i2s_dev = lisa_device_get("i2s0");
tx_done_count = 0;
tx_queued_count = 0;
main_task_handle = xTaskGetCurrentTaskHandle();

/* 2. 配置 I2S: 从模式，标准 I2S，16位，16kHz，立体声，双向 */
lisa_i2s_config_t config = LISA_I2S_DEFAULT_CONFIG_TX();
config.mode = LISA_I2S_MODE_SLAVE;  // 从模式
config.direction = LISA_I2S_DIRECTION_BOTH;  // 双向传输
config.block_size = 1024;
int ret = lisa_i2s_configure(i2s_dev, &config);

/* 3. 设置回调函数 */
ret = lisa_i2s_set_callback(i2s_dev, i2s_event_callback, NULL);

/* 4. 预先加载要发送的数据，write 返回 0 表示入队成功才计数 */
for(int i = 0; i < CONFIG_LISA_I2S_BLOCK_COUNT - 1; i++) {
    ret = lisa_i2s_write(i2s_dev, (uint32_t *)tx_buffer,
                         BLOCK_SIZE / sizeof(uint32_t), 0);
    if (ret < 0) {
        LISA_LOGE(TAG, "Failed to send data: %d", ret);
        return -1;
    }
    tx_queued_count++;
}

/* 5. 启动 I2S 双向传输 */
ret = lisa_i2s_trigger(i2s_dev, LISA_I2S_DIRECTION_BOTH, LISA_I2S_CMD_START);

/* 6. 创建 TX/RX 两个任务；两个都创建成功后才放行启动门闩 */
TaskHandle_t tx_task_handle = NULL;
TaskHandle_t rx_task_handle = NULL;
if (xTaskCreate(i2s_tx_task, "i2s tx", TASK_STACK_SIZE, i2s_dev,
                TASK_PRIORITY, &tx_task_handle) != pdPASS) {
    /* 回滚 STOP，且不输出成功 marker */
    lisa_i2s_trigger(i2s_dev, LISA_I2S_DIRECTION_BOTH, LISA_I2S_CMD_STOP);
    return -1;
}
if (xTaskCreate(i2s_rx_task, "i2s rx", TASK_STACK_SIZE, i2s_dev,
                TASK_PRIORITY, &rx_task_handle) != pdPASS) {
    /* TX 仍阻塞在启动门闩上，删除安全；再回滚 STOP */
    vTaskDelete(tx_task_handle);
    lisa_i2s_trigger(i2s_dev, LISA_I2S_DIRECTION_BOTH, LISA_I2S_CMD_STOP);
    return -1;
}
xTaskNotifyGive(tx_task_handle);
xTaskNotifyGive(rx_task_handle);

/* 7. 等待 TX/RX 任务完成位：任务用 eSetBits 置位，主任务循环聚合避免覆盖 */
uint32_t task_done_bits = 0;
while ((task_done_bits & TASK_DONE_ALL_BITS) != TASK_DONE_ALL_BITS) {
    uint32_t notified = 0;
    xTaskNotifyWait(0x00, UINT32_MAX, &notified, portMAX_DELAY);
    task_done_bits |= notified;
}

/* 8. 有界等待 TX_DONE 排空，最多 500 ms */
TickType_t wait_start = xTaskGetTickCount();
while (tx_done_count < tx_queued_count &&
       (xTaskGetTickCount() - wait_start) < pdMS_TO_TICKS(500)) {
    vTaskDelay(pdMS_TO_TICKS(1));
}
if (tx_done_count >= tx_queued_count) {
    LISA_LOGI(TAG, "TX drained: done=%u queued=%u",
              (unsigned int)tx_done_count, (unsigned int)tx_queued_count);
} else {
    LISA_LOGW(TAG, "TX not drained in 500 ms: done=%u queued=%u",
              (unsigned int)tx_done_count, (unsigned int)tx_queued_count);
}

/* 9. 停止 I2S 收发 */
ret = lisa_i2s_trigger(i2s_dev, LISA_I2S_DIRECTION_BOTH, LISA_I2S_CMD_STOP);
if (ret != 0) {
    LISA_LOGE(TAG, "Failed to stop I2S: %d", ret);
    return -1;
}

/* 10. STOP 成功后输出测试通过标志 */
LISA_LOGI(TAG, "LISA I2S SLAVE RX TX stopped");

Venusa RD EVB 关键配置

/* Venusa RD EVB 使用 I2S0 */
#define I2S0_BCK    CSK_IOMUX_PAD_A, 4, 9
#define I2S0_LRCK   CSK_IOMUX_PAD_A, 5, 9
#define I2S0_DIN    CSK_IOMUX_PAD_A, 6, 9
#define I2S0_DOUT   CSK_IOMUX_PAD_A, 7, 9

lisa_device_t *i2s_dev = lisa_device_get("i2s0");

配置说明

板型配置

公共配置位于 prj.conf，其中启用了 LISA I2S 设备框架和 PSRAM 堆：

CONFIG_LISA_DEVICE=y
CONFIG_LISA_I2S_DEVICE=y
CONFIG_PSRAM_HEAP_SIZE=0x680000

板型专用配置位于 board_configs/<BOARD>.conf，构建时会根据 BOARD 自动加载：

# board_configs/arcs_evb.conf
CONFIG_HEAP_SIZE=0x10000
CONFIG_LISA_I2S1=y

# board_configs/venusa_rd_evb.conf
CONFIG_HEAP_SIZE=0x5000
CONFIG_LISA_I2S_PIPO=n
CONFIG_LISA_I2S0=y

开发板

BOARD 值

I2S 设备

BCK

LRCK

DIN

DOUT

内部 SRAM 堆

DMA 缓冲模式

ARCS EVB

arcs_evb

i2s1

PA12

PA13

PA14

PA15

64 KiB

PiPo

Venusa RD EVB

venusa_rd_evb

i2s0

PA4

PA5

PA6

PA7

20 KiB

普通模式

当前 Venusa I2S 适配通过 CONFIG_LISA_I2S_PIPO=n 关闭 PiPo 双缓冲，使用普通 DMA 模式进行全双工收发。ARCS EVB 保持 Kconfig 默认的 PiPo 模式。

I2S 配置参数

  • 模式: LISA_I2S_MODE_SLAVE（从模式，接收时钟）

  • 协议: LISA_I2S_PROTOCOL_PHILIPS（标准 I2S）

  • 数据位宽: LISA_I2S_DATA_WIDTH_16BIT（16位）

  • 采样率: LISA_I2S_SAMPLE_RATE_16K（16kHz）

  • 声道: LISA_I2S_SLOT_STEREO（立体声）

  • 方向: LISA_I2S_DIRECTION_BOTH（双向传输）

  • block_size: 1024 字节（对应 16ms 音频数据）

数据格式

对于 16 位立体声，每个 uint32_t 包含左右两个声道：

  • 低 16 位：左声道数据

  • 高 16 位：右声道数据

注意事项

  1. 从设备依赖：从模式下必须连接到主设备，由主设备提供 BCK、LRCK 时钟信号

  2. 双向传输：需要同时配置 TX 和 RX，使用 LISA_I2S_DIRECTION_BOTH

  3. 并发收发：本示例创建 TX/RX 两个任务并发执行，各固定 3 次 I/O（每次 100 ms 超时）；主任务等两个任务完成位后，有界等待 TX 排空（最多 500 ms），最后停止 I2S

  4. 预加载数据：启动前需预先加载 CONFIG_LISA_I2S_BLOCK_COUNT - 1 次数据，避免下溢

  5. 时钟输入：从模式下，BCK 和 LRCK 为输入，由主设备产生

  6. 全双工能力：驱动支持全双工通信，也可按业务需要在不同线程中收发

  7. 板型选择：编译时的 BOARD 必须与实际开发板一致，在 ARCS EVB 和 Venusa RD EVB 之间切换时应使用 -C 清理旧的构建配置

  8. Venusa DMA 模式：Venusa RD EVB 通过板型配置关闭 PiPo，使用普通 DMA 模式进行全双工收发