RK3568驱动指南｜第十五篇 I2C-第172章 I2C 驱动框架编写

瑞芯微RK3568芯片是一款定位中高端的通用型SOC，采用22nm制程工艺，搭载一颗四核Cortex-A55处理器和Mali G52 2EE 图形处理器。RK3568 支持4K 解码和 1080P 编码，支持SATA/PCIE/USB3.0 外围接口。RK3568内置独立NPU，可用于轻量级人工智能应用。RK3568 支持安卓 11 和 linux 系统，主要面向物联网网关、NVR 存储、工控平板、工业检测、工控盒、卡拉 OK、云终端、车载中控等行业。

【公众号】迅为电子

【粉丝群】258811263（加群获取驱动文档+例程）

【视频观看】嵌入式学习之Linux驱动（第十五篇 I2C_全新升级）_基于RK3568

【购买链接】迅为RK3568开发板瑞芯微Linux安卓鸿蒙ARM核心板人工智能AI主板

第172章I2C 驱动框架编写

在上一个章节中，讲解了I2C Client设备树的编写，在I2C控制器节点中添加了FT5X06触摸芯片对应的节点，接下来将开始一步步完善I2C驱动程序，首先在本章节中将会完善I2C驱动框架，注册一个最简单的I2C驱动设备，并匹配上一章节中编写的设备树，在后面的章节中将会逐步对该驱动程序进行内容的填充。

171.1 注册I2C设备

I2C设备的注册使用的函数为i2c_add_driver，被定义在内核源码的“include/linux/i2c.h”目录下，具体内容如下所示：

#define i2c_add_driver(driver) \
	i2c_register_driver(THIS_MODULE, driver)

可以看到i2c_add_driver是一个宏定义，这个宏定义的作用是为了简化注册 I2C 设备驱动程序的过程，实际注册I2C设备的函数为i2c_register_driver，该函数定义在“drivers/i2c/i2c-core-base.c”文件中，具体内容如下所示：

int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
{
    int res;

    /* 在驱动模型初始化完成之前,无法注册驱动程序 */
    if (WARN_ON(!is_registered))
        return -EAGAIN;

    /* 将驱动程序添加到驱动核心的 i2c 驱动列表中 */
    driver->driver.owner = owner;
    driver->driver.bus = &i2c_bus_type;
    INIT_LIST_HEAD(&driver->clients);

    /* 当注册返回时,驱动核心会为所有匹配但尚未绑定的设备调用 probe() 函数 */
    res = driver_register(&driver->driver);
    if (res)
        return res;

    pr_debug("driver [%s] registered\n", driver->driver.name);

    /* 遍历所有已经存在的适配器 */
    i2c_for_each_dev(driver, __process_new_driver);

    return 0;
}

该函数的主要作用是将 I2C 设备驱动程序注册到驱动核心中,并初始化相关数据结构,这里传入的数据结构类型为i2c_driver，需要我们在驱动程序编写的时候进行填充，该结构体定义在“include/linux/i2c.h”头文件中，具体内容如下所示：

struct i2c_driver {
    unsigned int class;  // 驱动程序所属的设备类型

   int (*probe)(struct i2c_client *, const struct i2c_device_id *); // 探测并绑定设备的回调函数
    int (*remove)(struct i2c_client *); // 从设备上解绑驱动程序的回调函数
    int (*probe_new)(struct i2c_client *); // 新的探测设备并绑定的回调函数
    void (*shutdown)(struct i2c_client *); // 设备关闭时调用的回调函数
    void (*alert)(struct i2c_client *, enum i2c_alert_protocol protocol,
               unsigned int data); // 设备报警时调用的回调函数,格式和含义取决于所使用的协议
    int (*command)(struct i2c_client *client, unsigned int cmd, void *arg); // 用于执行设备特定功能的命令回调函数
    struct device_driver driver; // 设备驱动程序基础结构
    const struct i2c_device_id *id_table; // 与该驱动程序匹配的设备 ID 表
    int (*detect)(struct i2c_client *, struct i2c_board_info *); // 用于自动创建设备的探测回调函数
    const unsigned short *address_list; // 与该驱动程序匹配的设备地址列表
    struct list_head clients; // 与该驱动程序绑定的 I2C 设备列表
    bool disable_i2c_core_irq_mapping; // 禁用 I2C 核心中断映射的标志
};

在调用i2c_add_driver函数注册I2C设备之前，需要先填充i2c_driver结构体，然后实现的各种回调函数，跟前面讲解的平台总线内容相同。

171.2驱动程序的编写

本实验驱动对应的网盘路径为：iTOP-RK3568开发板【底板V1.7版本】\03_【iTOP-RK3568开发板】指南教程\02_Linux驱动配套资料\04_Linux驱动程序\102_ft5x06_01。

本实验旨在搭建最简单的I2C驱动程序框架，申请注册一个I2C设备，所以只填充了最简单的probe初始化函数和remove移除函数，在后面的章节中会对该驱动程序进行填充。

编写完成的ft5x06_driver.c代码如下所示：

#include <linux/init.h>
#include <linux/module.h>
#include <linux/i2c.h>
#include <linux/of_device.h>

// ft5x06设备的初始化函数
int ft5x06_probe(struct i2c_client *client, const struct i2c_device_id *id) {
    printk("This is ft5x06 probe\n");
    return 0;
}

// ft5x06设备的移除函数
int ft5x06_remove(struct i2c_client *client) {
    return 0;
}

// 设备树匹配表
static const struct of_device_id ft5x06_id[] = {
    { .compatible = "my-ft5x06" },
    { }, 
};

// ft5x06设备驱动结构体
static struct i2c_driver ft5x06_driver = {
    .driver = {
        .owner = THIS_MODULE,
        .name = "my-ft5x06",
        .of_match_table = ft5x06_id, // 添加设备树匹配表
    },    
    .probe = ft5x06_probe,
    .remove = ft5x06_remove,    
};

// 驱动初始化函数
static int __init ft5x06_driver_init(void) {
    int ret;
    // 注册I2C设备驱动
    ret = i2c_add_driver(&ft5x06_driver);
    if (ret < 0) {
        printk("i2c_add_driver is error\n");
        return ret;
    }
    return 0;
}

// 驱动退出函数
static void __exit ft5x06_driver_exit(void) {
    // 注销I2C设备驱动
    i2c_del_driver(&ft5x06_driver);
}

module_init(ft5x06_driver_init);
module_exit(ft5x06_driver_exit);
MODULE_LICENSE("GPL");

171.3 运行测试

171.3.1 编译驱动程序

在上一小节中的ft5x06_driver.c代码同一目录下创建 Makefile 文件，Makefile 文件内容如下所示：

export ARCH=arm64#设置平台架构
export CROSS_COMPILE=aarch64-linux-gnu-#交叉编译器前缀
obj-m += ft5x06_driver.o    #此处要和你的驱动源文件同名
KDIR :=/home/topeet/Linux/linux_sdk/kernel    #这里是你的内核目录                                                                                                                            
PWD ?= $(shell pwd)
all:
    make -C $(KDIR) M=$(PWD) modules    #make操作
clean:
    make -C $(KDIR) M=$(PWD) clean    #make clean操作

对于Makefile的内容注释已在上图添加，保存退出之后，来到存放platform_driver.c和Makefile文件目录下，如下图所示：