【北京迅为】i.MX6ULL终结者Linux I2C驱动实验IMX6ULL的I2C总线驱动分析

在上一节中我们了解了I2C框架分为I2C核心、I2C总线驱动和I2C设备驱动三部分。其中I2C总线驱动就是SOC的I2C控制器驱动,一般来说都是SOC厂家实现好的。而I2C设备驱动是用户根据自己不同的设备具体实现的。
在imx6ull平台下,NXP官方已经实现好了I2C总线驱动,下面简单分析一下。
首先要找到设备树中关于I2C控制器的设备节点。打开imx6ull.dtsi文件,有如下内容:

1 i2c1: i2c@021a0000 {
    
     
2      #address-cells = <1>; 
3      #size-cells = <0>; 
4      compatible = "fsl,imx6ul-i2c", "fsl,imx21-i2c"; 
5      reg = <0x021a0000 0x4000>; 
6      interrupts = <GIC_SPI 36 IRQ_TYPE_LEVEL_HIGH>; 
7      clocks = <&clks IMX6UL_CLK_I2C1>; 
8      status = "disabled";
9 }; 

根据I2C1设备节点中的compatible属性值"fsl,imx6ul-i2c"和"fsl,imx21-i2c",我们就可以在内核中找到相应的驱动文件,在Linux内核源码中搜索这两个字符串,可以找到驱动文件为drivers/i2c/busses/i2c-imx.c,有下面部分内容:

244 static struct platform_device_id imx_i2c_devtype[] = {
    
     
245        {
    
     
246            .name = "imx1-i2c", 
247            .driver_data = (kernel_ulong_t)&imx1_i2c_hwdata, 
248        }, {
    
     
249            .name = "imx21-i2c", 
250            .driver_data = (kernel_ulong_t)&imx21_i2c_hwdata, 
251        }, {
    
     
252        /* sentinel */ 
253        } 
254 }; 
255 MODULE_DEVICE_TABLE(platform, imx_i2c_devtype); 
256 
257 static const struct of_device_id i2c_imx_dt_ids[] = {
    
     
258        {
    
     .compatible = "fsl,imx1-i2c", .data = &imx1_i2c_hwdata, }, 
259        {
    
     .compatible = "fsl,imx21-i2c", .data = &imx21_i2c_hwdata, }, 
260        {
    
     .compatible = "fsl,vf610-i2c", .data = &vf610_i2c_hwdata, }, 
261        {
    
     /* sentinel */ } 
262 }; 
263 MODULE_DEVICE_TABLE(of, i2c_imx_dt_ids); 
...... 
1119 static struct platform_driver i2c_imx_driver = {
    
     
1120       .probe = i2c_imx_probe, 
1121       .remove = i2c_imx_remove, 
1122       .driver = {
    
     
1123               .name = DRIVER_NAME, 
1124               .owner = THIS_MODULE, 
1125               .of_match_table = i2c_imx_dt_ids, 
1126               .pm = IMX_I2C_PM, 
1127         }, 
1128       .id_table = imx_i2c_devtype, 
1129 }; 
1130 
1131 static int __init i2c_adap_imx_init(void) 
1132 {
    
     
1133         return platform_driver_register(&i2c_imx_driver); 
1134 }
1135       subsys_initcall(i2c_adap_imx_init); 
1136 
1137 static void __exit i2c_adap_imx_exit(void) 
1138 {
    
     
1139       platform_driver_unregister(&i2c_imx_driver); 
1140 } 
1141 module_exit(i2c_adap_imx_exit); 

从上面代码可以看出I2C总线驱动的本质也是一个标准的platform驱动框架,所以说I2C总线驱动是基于platform框架实现的,相当于又封装了一层。
第 259 行,compatible属性值“fsl,imx21-i2c”,设备树中 i2c1 节点的 compatible 属性值就是与此匹配上的。因此 i2c-imx.c 文件就是 I.MX6U 的 I2C 适配器驱动文件。
第 1120 行,当设备和驱动匹配成功以后 i2c_imx_probe 函数就会执行,i2c_imx_probe 函数就会完成 I2C 适配器初始化工作。
i2c_imx_probe 函数部分内容如下所示:

971 static int i2c_imx_probe(struct platform_device *pdev) 
972 {
    
     
973        const struct of_device_id *of_id = 
974            of_match_device(i2c_imx_dt_ids, &pdev->dev); 
975        struct imx_i2c_struct *i2c_imx; 
976        struct resource *res; 
977        struct imxi2c_platform_data *pdata = dev_get_platdata(&pdev->dev); 
978        void __iomem *base; 
979      int irq, ret; 
980      dma_addr_t phy_addr; 
981 
982        dev_dbg(&pdev->dev, "<%s>\n", __func__); 
983 
984        irq = platform_get_irq(pdev, 0); 
...... 
990        res = platform_get_resource(pdev, IORESOURCE_MEM, 0); 
991        base = devm_ioremap_resource(&pdev->dev, res); 
992        if (IS_ERR(base)) 
993            return PTR_ERR(base); 
994 
995        phy_addr = (dma_addr_t)res->start; 
996        i2c_imx = devm_kzalloc(&pdev->dev, sizeof(*i2c_imx), GFP_KERNEL); 
997        if (!i2c_imx) 
998          return -ENOMEM;
999 
1000   if (of_id) 
1001       i2c_imx->hwdata = of_id->data; 
1002   else 
1003       i2c_imx->hwdata = (struct imx_i2c_hwdata *) 
1004   platform_get_device_id(pdev)->driver_data; 
1005 
1006   /* Setup i2c_imx driver structure */ 
1007   strlcpy(i2c_imx->adapter.name, pdev->name, 
sizeof(i2c_imx->adapter.name)); 
1008   i2c_imx->adapter.owner = THIS_MODULE; 
1009   i2c_imx->adapter.algo = &i2c_imx_algo; 
1010   i2c_imx->adapter.dev.parent = &pdev->dev; 
1011   i2c_imx->adapter.nr = pdev->id; 
1012   i2c_imx->adapter.dev.of_node = pdev->dev.of_node; 
1013   i2c_imx->base = base; 
1014 
1015   /* Get I2C clock */ 
1016   i2c_imx->clk = devm_clk_get(&pdev->dev, NULL); 
...... 
1022   ret = clk_prepare_enable(i2c_imx->clk); 
...... 
1027   /* Request IRQ */ 
1028   ret = devm_request_irq(&pdev->dev, irq, i2c_imx_isr, 
1029   IRQF_NO_SUSPEND, pdev->name, i2c_imx); 
...... 
1035   /* Init queue */ 
1036   init_waitqueue_head(&i2c_imx->queue); 
1037 
1038   /* Set up adapter data */ 
1039   i2c_set_adapdata(&i2c_imx->adapter, i2c_imx); 
1040 
1041   /* Set up clock divider */ 
1042   i2c_imx->bitrate = IMX_I2C_BIT_RATE; 
1043   ret = of_property_read_u32(pdev->dev.of_node, 
1044       "clock-frequency", &i2c_imx->bitrate); 
1045   if (ret < 0 && pdata && pdata->bitrate) 
1046   i2c_imx->bitrate = pdata->bitrate; 
1047 
1048     /* Set up chip registers to defaults */ 
1049   imx_i2c_write_reg(i2c_imx->hwdata->i2cr_ien_opcode ^ I2CR_IEN, 
1050                   i2c_imx, IMX_I2C_I2CR); 
1051   imx_i2c_write_reg(i2c_imx->hwdata->i2sr_clr_opcode, i2c_imx,
IMX_I2C_I2SR); 
1052 
1053   /* Add I2C adapter */ 
1054   ret = i2c_add_numbered_adapter(&i2c_imx->adapter); 
1055   if (ret < 0) {
    
     
1056       dev_err(&pdev->dev, "registration failed\n"); 
1057       goto clk_disable; 
1058     } 
1059 
1060   /* Set up platform driver data */ 
1061   platform_set_drvdata(pdev, i2c_imx); 
1062   clk_disable_unprepare(i2c_imx->clk); 
...... 
1070   /* Init DMA config if supported */ 
1071   i2c_imx_dma_request(i2c_imx, phy_addr); 
1072 
1073   return 0; /* Return OK */ 
1074 
1075 clk_disable: 
1076   clk_disable_unprepare(i2c_imx->clk); 
1077   return ret; 
1078 } 

第 984 行,调用 platform_get_irq 函数获取中断号。
第 990~991 行,调用 platform_get_resource 函数从设备树中获取 I2C1 控制器寄存器物理基地址,也就是 0X021A0000。获取到寄存器基地址以后使用 devm_ioremap_resource 函数对其进行内存映射,得到可以在 Linux 内核中使用的虚拟地址。
第 996 行,NXP 使用 imx_i2c_struct 结构体来表示 I.MX 系列 SOC 的 I2C 控制器,这里使用 devm_kzalloc 函数来申请内存。
第 1008~1013 行,imx_i2c_struct 结构体要有个叫做 adapter 的成员变量,adapter 就是i2c_adapter,这里初始化i2c_adapter。第1009行设置i2c_adapter的algo成员变量为i2c_imx_algo,也就是设置 i2c_algorithm。
第 1028~1029 行,注册 I2C 控制器中断,中断服务函数为 i2c_imx_isr。
第 1042~1044 行,设置 I2C 频率默认为 IMX_I2C_BIT_RATE=100KHz,如果设备树节点设置了“clock-frequency”属性的话 I2C 频率就使用 clock-frequency 属性值。
第 1049~1051 行,设置 I2C1 控制的 I2CR 和 I2SR 寄存器。
第 1054 行,调用 i2c_add_numbered_adapter 函数向 Linux 内核注册 i2c_adapter。
第 1071 行,申请 DMA,看来 I.MX 的 I2C 适配器驱动采用了 DMA 方式。
i2c_imx_probe 函数主要的工作就是一下两点:
① 初始化 i2c_adapter,设置 i2c_algorithm 为 i2c_imx_algo,最后向 Linux 内核注册i2c_adapter。
② 初始化 I2C1 控制器的相关寄存器。
i2c_imx_algo 包含 I2C1 适配器与 I2C 设备的通信函数 master_xfer,i2c_imx_algo 结构体定义如下:

966 static struct i2c_algorithm i2c_imx_algo = {
    
     
967		.master_xfer = i2c_imx_xfer, 
968 		.functionality = i2c_imx_func, 
969 };

我们先来看一下. functionality,functionality用于返回此I2C适配器支持什么样的通信协议,在这里 functionality 就是 i2c_imx_func 函数,i2c_imx_func 函数内容如下:

static u32 i2c_imx_func(struct i2c_adapter *adapter) 
{
    
     
return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL 
| I2C_FUNC_SMBUS_READ_BLOCK_DATA; 
} 

重点来看一下 i2c_imx_xfer 函数,因为最终就是通过此函数来完成与 I2C 设备通信的,此函数部分内容如下:

888 static int i2c_imx_xfer(struct i2c_adapter *adapter, 
889                    struct i2c_msg *msgs, int num) 
890 {
    
     
891        unsigned int i, temp; 
892        int result; 
893        bool is_lastmsg = false; 
894        struct imx_i2c_struct *i2c_imx = i2c_get_adapdata(adapter); 
895 
896        dev_dbg(&i2c_imx->adapter.dev, "<%s>\n", __func__); 
897 
898        /* Start I2C transfer */ 
899        result = i2c_imx_start(i2c_imx); 
900        if (result) 
901            goto fail0; 
902 
903        /* read/write data */ 
904        for (i = 0; i < num; i++) {
    
     
905            if (i == num - 1) 
906                is_lastmsg = true; 
907 
908          if (i) {
    
     
909                dev_dbg(&i2c_imx->adapter.dev, 
910                        "<%s> repeated start\n", __func__); 
911                temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR); 
912                temp |= I2CR_RSTA; 
913              imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR); 
914                result = i2c_imx_bus_busy(i2c_imx, 1);
915                if (result) 
916                    goto fail0; 
917            } 
918            dev_dbg(&i2c_imx->adapter.dev, 
919                    "<%s> transfer message: %d\n", __func__, i); 
920            /* write/read data */ 
...... 
938            if (msgs[i].flags & I2C_M_RD) 
939              result = i2c_imx_read(i2c_imx, &msgs[i], is_lastmsg); 
940            else {
    
     
941              if (i2c_imx->dma && msgs[i].len >= DMA_THRESHOLD) 
942            result = i2c_imx_dma_write(i2c_imx, &msgs[i]); 
943            else 
944                result = i2c_imx_write(i2c_imx, &msgs[i]); 
945        } 
946            if (result) 
947                goto fail0; 
948      } 
949 
950 fail0: 
951        /* Stop I2C transfer */ 
952        i2c_imx_stop(i2c_imx); 
953 
954        dev_dbg(&i2c_imx->adapter.dev, "<%s> exit with: %s: %d\n", __func__, 
955                (result < 0) ? "error" : "success msg", 
956                (result < 0) ? result : num); 
957        return (result < 0) ? result : num; 
958 }

第 899 行,调用 i2c_imx_start 函数开启 I2C 通信。
第 939 行,如果是从 I2C 设备读数据的话就调用 i2c_imx_read 函数。
第 941~945 行,向 I2C 设备写数据,如果要用 DMA 的话就使用 i2c_imx_dma_write 函数来完成写数据。如果不使用 DMA 的话就使用 i2c_imx_write 函数完成写数据。
第 952 行,I2C 通信完成以后调用 i2c_imx_stop 函数停止 I2C 通信。
i2c_imx_start、i2c_imx_read、i2c_imx_write 和 i2c_imx_stop 这些函数就是 I2C 寄存器的具体操作函数。

在这里插入图片描述

猜你喜欢

转载自blog.csdn.net/BeiJingXunWei/article/details/112506068