I2C 基础读写示例

📁 源码位置: samples/drivers/devices/lisa_i2c/basic_write_read 查看源码

功能说明

本示例演示 LISA I2C 驱动的三个基础 API 用法：写数据、读数据和组合传输（写后读）。

底层使用中断方式传输，支持标准模式（100kHz）和快速模式（400kHz）。本示例主要展示 API 的使用方法，不依赖特定硬件。实际运行时如果总线上没有设备，会提示 NACK 错误，这是正常的。

硬件连接

如需连接实际 I2C 设备测试：

  • PA22: I2C0 SDA（连接到 I2C 设备的 SDA，需上拉）

  • PA23: I2C0 SCL（连接到 I2C 设备的 SCL，需上拉）

  • GND: 与 I2C 设备共地

常见的 I2C 设备：EEPROM (AT24Cxx)、传感器 (BME280)、RTC (DS1307) 等。

Venusa RD EVB 使用 I2C1，连接引脚如下：

  • PB1: I2C1 SDA（连接到 I2C 设备的 SDA，需上拉）

  • PB2: I2C1 SCL（连接到 I2C 设备的 SCL，需上拉）

  • GND: 与 I2C 设备共地

示例中的设备地址默认为 0x50，适用于常见的 AT24Cxx EEPROM；如果实际从机地址不同，请修改 DEVICE_ADDR。

示例步骤

  1. 根据板型获取 i2c0（ARCS EVB）或 i2c1（Venusa RD EVB）设备，并配置为标准速率主机模式

  2. 由驱动初始化阶段调用对应的 lisa_i2c0_pinmux() 或 lisa_i2c1_pinmux()，完成 I2C 引脚复用

  3. 演示 lisa_i2c_write() API：写数据到 I2C 设备

  4. 演示 lisa_i2c_read() API：从 I2C 设备读数据

  5. 演示 lisa_i2c_transfer() API：组合传输（写寄存器地址后读数据）

编译

重要提示：编译前需要先确认当前示例支持的目标板型，然后将板型标识传给 -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 中的说明为准。

构建时只需选择板型，板型专用配置会自动启用对应的 I2C 控制器：

# ARCS EVB：I2C0（PA22/PA23）
./build.sh -C -S samples/drivers/devices/lisa_i2c/basic_write_read -DBOARD=arcs_evb

# Venusa RD EVB：I2C1（PB1/PB2）
./build.sh -C -S samples/drivers/devices/lisa_i2c/basic_write_read -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 端口

预期输出

终端输出：

ARCS EVB：

=== LISA I2C basic write/read example ===
I2C0 SDA@PA22 / SCL@PA23 configured
i2c0 device ready
I2C configured (speed: 100000 Hz)

========================================
Demonstrating LISA I2C API usage
Target device address: 0x50
Note: Examples show API usage, actual results depend on hardware
========================================

--- Example 1: Write API ---
Calling: lisa_i2c_write(dev, 0x50, data, 5)
Data to write: [0x00 0x55 0xAA 0x12 0x34]
Write operation completed successfully

--- Example 2: Read API ---
Calling: lisa_i2c_read(dev, 0x50, buffer, 4)
Read operation completed successfully
Data read: [0x00 0x00 0x00 0x00]

--- Example 3: Transfer API (Write-Read Combined) ---
Calling: lisa_i2c_transfer(dev, msgs, 2)
  Message[0]: WRITE reg_addr=0x00 (NO_STOP)
  Message[1]: READ 4 bytes (READ flag)
Transfer operation completed successfully
Data read: [0x00 0x00 0x00 0x00]

========================================
All API examples completed
========================================

Venusa RD EVB 的前几行输出为：

=== LISA I2C basic write/read example ===
I2C1 SDA@PB01 / SCL@PB02 configured
i2c1 device ready
I2C configured (speed: 100000 Hz)

后续 API 调用输出与 ARCS EVB 相同；如果总线上没有地址为 0x50 的设备，读写操作会返回 NACK。

注意：如果总线上没有设备，会显示 “Device not responding (NACK)”，这是正常的。

核心 API

API

说明

lisa_device_get()

获取 I2C 设备

lisa_i2c_configure()

配置 I2C 总线参数（速度、模式）

lisa_i2c_write()

写数据到 I2C 从设备

lisa_i2c_read()

从 I2C 从设备读数据

lisa_i2c_transfer()

组合传输（支持写后读等复杂操作）

关键代码

API 1: lisa_i2c_write()

写数据到 I2C 从设备：

uint8_t write_data[] = {0x00, 0x55, 0xAA, 0x12, 0x34};
int ret = lisa_i2c_write(dev, slave_addr, write_data, sizeof(write_data));

API 2: lisa_i2c_read()

从 I2C 从设备读取数据：

uint8_t read_data[4];
int ret = lisa_i2c_read(dev, slave_addr, read_data, sizeof(read_data));

API 3: lisa_i2c_transfer()

组合传输（典型用法：写寄存器地址 + 读寄存器值）：

lisa_i2c_msg_t msgs[2];

/* 消息1：写寄存器地址 */
uint8_t reg_addr = 0x00;
msgs[0].addr = slave_addr;
msgs[0].flags = LISA_I2C_FLAG_NO_STOP;  /* 不发送 STOP */
msgs[0].len = 1;
msgs[0].buf = &reg_addr;

/* 消息2：读取数据 */
uint8_t read_buf[4];
msgs[1].addr = slave_addr;
msgs[1].flags = LISA_I2C_FLAG_READ;     /* 读操作标志 */
msgs[1].len = sizeof(read_buf);
msgs[1].buf = read_buf;

int ret = lisa_i2c_transfer(dev, msgs, 2);

配置说明

公共配置位于 prj.conf，板型专用配置位于 board_configs/<BOARD>.conf，构建时会自动合并：

CONFIG_LISA_DEVICE=y      # 使能 LISA 设备框架
CONFIG_LISA_I2C=y         # 使能 I2C 驱动
CONFIG_LOG=y              # 使能日志功能

# board_configs/arcs_evb.conf
CONFIG_LISA_I2C0=y

# board_configs/venusa_rd_evb.conf
CONFIG_LISA_I2C1=y

注意事项

  1. 读操作标志：使用 lisa_i2c_transfer() 进行读操作时，必须设置 LISA_I2C_FLAG_READ 标志，否则会被当作写操作

  2. 写后读操作：组合传输时，第一个消息需要设置 LISA_I2C_FLAG_NO_STOP，避免发送 STOP 条件

  3. 返回值处理：

    • LISA_DEVICE_OK (0): 成功

    • LISA_DEVICE_ERR_NACK (-13): 设备无响应（地址错误或设备不存在）

    • 其他负值: 其他错误

  4. 引脚上拉：I2C 总线需要外接上拉电阻（通常 4.7kΩ），或确认开发板已提供默认上拉

  5. 引脚配置：I2C 驱动初始化时会调用示例中对应的 pinmux 函数。ARCS EVB 使用 lisa_i2c0_pinmux() 配置 PA22/PA23，Venusa RD EVB 使用 lisa_i2c1_pinmux() 配置 PB1/PB2

  6. 设备地址：修改 DEVICE_ADDR 宏以匹配实际设备地址

实际应用场景

修改 DEVICE_ADDR 后可用于：

设备类型

典型地址

用途

AT24C02 EEPROM

0x50

数据存储

BME280 传感器

0x76/0x77

温湿度气压

MPU6050 IMU

0x68/0x69

加速度陀螺仪

DS1307 RTC

0x68

实时时钟

PCF8574 IO扩展

0x20-0x27

GPIO 扩展