RK3568 I2C使用

说明

ROCKCHIP 系列芯片为客户提供了标准 I2C 总线，方便客户实现对不同外接设备的控制和访问。I2C 总线控制器通过串行数据（SDA）线和串行时钟 （SCL）线在连接到总线的器件间传递信息。每个器件都有一个唯一的地址识别（无论是微控制器——MCU、LCD 驱动器、存储器或键盘接口），而且都可以作为一个发送器或接收器（由器件的功能决定）。
Rockchip I2C 控制器支持下列功能︰

1. 兼容 I2C 与 SMBus 总线
2. 仅支持主模式下的 I2C 总线
3. 软件可编程时钟频率支持到 400kbps,部分芯片可高达1000kbps
4. 支持 7 位和 10 位寻址模式
5. 一次中断或轮询至多 32 个字节的数据传输

RK3568有 6 个片上 I2C 控制器，各个 I2C 的使用情况如下表：

配置 I2C 可分为两大步骤：
定义和注册 I2C 设备
定义和注册 I2C 驱动

定义和注册 I2C 设备

在注册 I2C 设备时，需要结构体 i2c_client 来描述 I2C 设备。而在标准 Linux 中，只需要提供相应的 I2C 设备信息，Linux 就会根据所提供的信息构造 i2c_client 结构体。
所提供的 I2C 设备信息以节点的形式写到 DTS 文件中，修改dts，添加新的i2c设备。
在 arch/arm/boot/dts/rk3568-firefly-aioj-mipi101_JDM101014_BE40_A1.dts中添加i2c设备的相关信息：

&i2c1 {
	status = "okay";
    clock-frequency = <100000>;
    focaltech@38 {
        status = "okay";
        compatible = "focaltech,ft8201";
        reg = <0x38>;
        //focaltech,power-gpio = <&gpio0 RK_PC7 GPIO_ACTIVE_HIGH>;
        focaltech,irq-gpio = <&gpio0 RK_PB5 IRQ_TYPE_LEVEL_LOW>;
        focaltech,reset-gpio = <&gpio0 RK_PB6 GPIO_ACTIVE_LOW>;
        focaltech,display-coords =  <0 0 800 1280>;// x_min, y_min, x_max, y_max
        focaltech,max-touch-number = <5>;
        //focaltech,have-key;
        //focaltech,key-number = <3>;
    };
};

定义和注册 I2C 驱动

定义 I2C 驱动

在定义 I2C 驱动之前，用户首先要定义变量 of_device_id 和 i2c_device_id。
of_device_id 用于在驱动中调用 DTS 文件中定义的设备信息，其定义如下所示：

 static const struct of_device_id fts_dt_match[] = {
    {.compatible = "focaltech,ft8201", },
    {},
};

定义变量 i2c_device_id：

static const struct i2c_device_id fts_ts_id[] = {
    {FTS_DRIVER_NAME, 0},
    {},
};

i2c_driver 如下所示：

static struct i2c_driver fts_ts_driver = {
    .probe = fts_ts_probe,
    .remove = fts_ts_remove,
    .driver = {
        .name = FTS_DRIVER_NAME,
        .owner = THIS_MODULE,
        .of_match_table = of_match_ptr(fts_dt_match),
    },
    .id_table = fts_ts_id,
};

注：变量 id_table 指示该驱动所支持的设备。

注册 I2C 驱动

使用 i2c_add_driver 函数注册 I2C 驱动。

static int __init fts_ts_init(void)
{
    int ret = 0;
    FTS_FUNC_ENTER();
    ret = i2c_add_driver(&fts_ts_driver);
    if ( ret != 0 ) {
        FTS_ERROR("Focaltech touch screen driver init failed!");
    }
    FTS_FUNC_EXIT();
    return ret;
}

在调用 i2c_add_driver 注册 I2C 驱动时，会遍历 I2C 设备，如果该驱动支持所遍历到的设备，则会调用该驱动的 probe 函数。

通过 I2C 收发数据

在注册好 I2C 驱动后，即可进行 I2C 通讯。
向从机发送信息：

 int i2c_master_send(const struct i2c_client *client, const char *buf, int count)
 {
     int ret;
     struct i2c_adapter *adap = client->adapter;
     struct i2c_msg msg;
     msg.addr = client->addr;
     msg.flags = client->flags & I2C_M_TEN;
     msg.len = count;
     msg.buf = (char *)buf;
     ret = i2c_transfer(adap, &msg, 1);
     /*
      * If everything went ok (i.e. 1 msg transmitted), return #bytes
      * transmitted, else error code.
      */
     return (ret == 1) ? count : ret;
 }
EXPORT_SYMBOL(i2c_master_send);

向从机读取信息：

 int i2c_master_recv(const struct i2c_client *client, char *buf, int count)
 {
     struct i2c_adapter *adap = client->adapter;
     struct i2c_msg msg;
     int ret;
     msg.addr = client->addr;
     msg.flags = client->flags & I2C_M_TEN;
     msg.flags |= I2C_M_RD;
     msg.len = count;
     msg.buf = buf;
     ret = i2c_transfer(adap, &msg, 1);
     /*
      * If everything went ok (i.e. 1 msg received), return #bytes received,
      * else error code.
      */
     return (ret == 1) ? count : ret;
 }
 EXPORT_SYMBOL(i2c_master_recv);

FAQs
Q1: 通信失败，出现这种 log: “timeout, ipd: 0x00, state: 1” 该如何调试？
A1: 请检查从设备硬件上拉是否给电。

Q2: 调用 i2c_transfer 返回值为 -6？
A2: 返回值为 -6 表示为 NACK 错误，即对方设备无应答响应，这种情况一般为外设的问题，常见的有以下几种情况：
1、I2C 地址错误，解决方法是测量 I2C 波形，确认是否 I2C 设备地址错误；
2、I2C slave 设备不处于正常工作状态，比如未给电，错误的上电时序等；
3、时序不符合 I2C slave 设备所要求也会产生 Nack 信号；
4、I2C 总线受外部干扰导致的，用示波器测量可以看到是一个 ACK 波形；

Q3: 当外设对于读时序要求中间是 stop 信号不是 repeat start 信号的时候，该如何处理？
A3: 这时需要调用两次 i2c_transfer, I2C read 拆分成两次，修改如下：

static int i2c_read_bytes(struct i2c_client *client, u8 cmd, u8 *data, u8 data_len) {
    struct i2c_msg msgs[2];
	int ret;
	u8 *buffer;
	buffer = kzalloc(data_len, GFP_KERNEL);
	if (!buffer)
		return -ENOMEM;;
	msgs[0].addr = client->addr;
	msgs[0].flags = client->flags;
	msgs[0].len = 1;
	msgs[0].buf = &cmd;
	ret = i2c_transfer(client->adapter, msgs, 1);
	if (ret < 0) {
		dev_err(&client->adapter->dev, "i2c read failed\n");
        kfree(buffer);
			return ret;
    }
    msgs[1].addr = client->addr;
    msgs[1].flags = client->flags | I2C_M_RD;
    msgs[1].len = data_len;
    msgs[1].buf = buffer;
    ret = i2c_transfer(client->adapter, &msgs[1], 1);
    if (ret < 0)
		dev_err(&client->adapter->dev, "i2c read failed\n");
    else
        memcpy(data, buffer, data_len);
    kfree(buffer);
    return ret;
}

Q4：log：“timeout, ipd: 0x00, state: 1”
A4 : 当出现 I2C 的 log："timeout, ipd: 0x00, state: 1"时，此时 I2C 控制器工作异常，无法产生中断状态，start时序无法发出，有以下几种可能：
1、I2C SCL 或者 SDA Pin 脚 iomux 错误；
2、I2C 的上拉电压不对，如电压不够或者上拉电源没有等；
3、I2C Pin 脚被外设拉住，电压不对；
4、I2C 时钟未开，或者时钟源太小；
5、I2C 同时配置了 CON_START 和 CON_STOP 位。

Q5: timeout, ipd: 0x10, state: 1
A5：当出现 I2C 的 log："timeout, ipd: 0x10, state: 1"时，此时 I2C 控制器工作正常，但是 cpu 无法响应 I2C 中断，此时可能 cpu0 被阻塞了（一般 I2C 中断都在 cpu0 上面，通过 cat /proc/interrups 可以查看），或者可能是 I2C 中断位被关闭了

Q6：log “i2c is not in idle(state = ×)”
A6:当出现 log “i2c is not in idle(state = ×)”的 log 时，表示 I2C 总线至少一个为低，解决办法参考：
1、“state=1” 表示 SDA 为低；
2、“state=2” 表示 SCL 为低；
3、“state=3” 表示 SCL 和 SDA 都为低。

如果遇到的 I2C 问题以上情况都不是，最好的办法是抓取 I2C 出错时候的波形，通过波形来分析 I2C 问题，I2C 的波形非常有用，大部分的问题都能分析出来；可以在出错的地方让 cpu 卡住（比如 while(1)等），不发起新的 I2C 任务，最后抓到的波形应该就是出错的波形，如果需要过滤还可以加入设备 I2C地址的判断条件等