说明:此文档不具体介绍实现细节,关注在i2c bus(i2c controller)驱动的框架,以此对i2c bus驱动有个总体认知,具体的软件对i2c controller的操作细节依赖于具体芯片i2c控制器的设计实现,一来绝大部分人很少从事此类工作,二来需要有资源能够查看具体的spec,通常这是很难的。
i2c bus(i2c controller)具体是怎么与i2c slave进行数据传输呢?
做驱动的都知道 i2c slave设备是最常见不过的了,也都清楚slave将需要传输的读写数据整理成一个个i2c_msg,然后通过i2c core调用事先注册好的i2c controller实现的master_xfer回调函数进行数据传输。然而i2c controller的master_xfer具体对数据的传输是怎么处理的,这个细节清楚的人并不多。
本文将结合本人的实际工作经验对i2c controller的master_xfer的工作方式做简要框架性的介绍。希望对大家实际问题的处理有一些指导作用。
本文主要从三个方面来介绍:
- 驱动加载和初始化的 probe函数;
- 总线数据传输处理回调函数 master_xfer;
- 中断处理过程(顶半部 + 底半部)。
1. probe
probe函数部分主要分两大部分:
一个是跟平台i2c总线控制器强相关的,主要是dts,clk,enable;
另一个是通用部分,主要是注册中断和注册adapter到i2c core。
static int xxx_i2c_probe(struct platform_device *pdev)
{
//Part 1: particular part for specific platform i2c bus(controller)
/* 1. Parse dts info into i2c controller driver_data_struct */
/* 2. i2c controller clk init && clk enable */
/* 3. i2c controller enable */
--------------------------------------
//Part 2:common part
/* 4. pm runtime init */
/* 5. request irq */
ret = devm_request_threaded_irq(&pdev->dev, driver_data_struct->irq,
xxx_i2c_isr, xxx_i2c_isr_thread,
IRQF_NO_SUSPEND | IRQF_ONESHOT,
pdev->name, driver_data_struct);
/* 6. register adapter to i2c core */
ret = i2c_add_numbered_adapter(&driver_data_struct->adap);
...
}
2. i2c_algorithm->master_xfer
说明:slave设备驱动如何构造i2c_msg,再调用i2c bus mster_xfer进行传输的相关知识可参考前面写的博文:I2C | i2c_msg 。
static int
xxx_i2c_master_xfer(struct i2c_adapter *i2c_adap,
struct i2c_msg *msgs, int num)
{
...
//以slave传来的i2c_msg为单位进行处理和传输
for (im = 0; ret >= 0 && im != num; im++)
ret = xxx_i2c_handle_msg(i2c_adap, &msgs[im], im == num - 1);
...
}
这里要提一下,当我们遇到一些稍复杂的i2c问题,涉及到需要分析波形时,就需要查看master_xfer 对i2c_msg的处理细节,结合代码和波形查看相应的读写传输字节序列。
static int
xxx_i2c_handle_msg(struct i2c_adapter *i2c_adap,
struct i2c_msg *pmsg, int is_last_msg)
{
//注意,这里每次处理一个新的i2c_msg时,都要重新初始化一下 complete
reinit_completion(&driver_data_struct->complete);
...
/* 1. SW setup i2c controller start data transfer
* 2. HW interrupt and do data transfer, return complete to notify transfer done or error
*/
...
//睡眠等待内核中断线程处理完毕
wait_for_completion(&driver_data_struct->complete);
}
3. Interrupt processing
interrupt top half – clear irq
static irqreturn_t xxx_i2c_isr(int irq, void *dev_id)
{
/* Clear irq -- Deal with urgent, non-time-consuming tasks */
...
//注意,top half返回这个flag,内核将自动调用注册的与该top half绑定的内核中断线程(bottom half)
return IRQ_WAKE_THREAD;
}
interrupt bottom half – kernel thread
static irqreturn_t xxx_i2c_isr_thread(int irq, void *dev_id)
{
/* data transfer */
//注意,一个i2c_msg如果涉及到传输很多个字节,这里面会将这些字节分别批传输,
//每批字节传输完毕又会触发中断开始下一批次字节的传输
return IRQ_HANDLED; // Section-interrupt processing completed
/* deal with no ack error if exist */
...
//唤醒并结束 master_xfer
complete(&pi2c->complete);
//所有中断处理完毕,唤醒之前进入睡眠等待中的 mster_xfer来结束传输
return IRQ_HANDLED; // Total interruptions processing completed
}