首页 > 其他分享 >【IMX6ULL学习笔记】二十、IIC驱动和设备

【IMX6ULL学习笔记】二十、IIC驱动和设备

时间:2023-02-18 23:45:09浏览次数:40  
标签:i2c struct driver 笔记 IIC imx IMX6ULL I2C ap3216c

一、IIC驱动和IIC设备

驱动和设备是成对的,一个驱动对应一个设备,而驱动又分为主机驱动(IIC控制器驱动)和设备驱动,相对应的就是主机设备(IIC控制器)和普通设备(外围设备)。

1、主机驱动(IIC控制器驱动)

总线是由Linux完成,与硬件无关的,使用 bus_type 结构体的实例来表示。对于驱动和设备,也有相应的结构体用来表示,不同的是所有总线使用的是同一个结构体,而不同的驱动会对应着不同的结构体。

以 IIC 驱动为例,SOC 的 IIC 是一个硬件接口,要想使用这个接口,就需要一套驱动程序来驱动它,而这里的驱动程序就是主机驱动(IIC控制器驱动),而该主机驱动所对于的主机设备(IIC控制器)就是 IIC 这个硬件接口。由此可总结,与 SOC 外设相关的驱动(如IIC、SPI、SDIO等)都是主机驱动。

Linux 内核将 SOC 的 I2C 控制器抽象成 i2c_adapter 结构体,定义在 include/linux/i2c.h 文件中,结构体内容如下:

struct i2c_adapter {
    struct module *owner;
    unsigned int class; /* classes to allow probing for */
    const struct i2c_algorithm *algo; /* 总线访问算法 */
    void *algo_data;

    /* data fields that are valid for all devices */
    struct rt_mutex bus_lock;

    int timeout; /* in jiffies */
    int retries;
    struct device dev; /* the adapter device */

    int nr;
    char name[48];
    struct completion dev_released;

    struct mutex userspace_clients_lock;
    struct list_head userspace_clients;

    struct i2c_bus_recovery_info *bus_recovery_info;
    const struct i2c_adapter_quirks *quirks;
};

第 4 行:i2c_algorithm 类型的指针变量 algo,对于一个 I2C 控制器,肯定要对外提供读写 API 函数,设备驱动程序可以使用这些 API 函数来完成读写操作。
i2c_algorithm 就是 I2C 控制器与 IIC 设备进行通信的方法。i2c_algorithm 结构体定义在 include/linux/i2c.h 文件中,内容如下(删除条件编译):

struct i2c_algorithm {
......
    int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs, int num);
    int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
                       unsigned short flags, char read_write,
                       u8 command, int size, union i2c_smbus_data *data);

    /* To determine what the adapter supports */
    u32 (*functionality) (struct i2c_adapter *);
......
};

第 3 行:master_xfer 就是 I2C 适配器的传输函数,可以通过此函数来完成与 IIC 设备之间的通信。
第 4 行:smbus_xfer 就是 SMBUS 总线的传输函数。

综上所述,I2C 主机驱动的主要工作就是初始化 i2c_adapter 结构体变量,然后设置 i2c_algorithm 中的 master_xfer 函数。完成后通过i2c_add_adapter 或 i2c_add_numbered_adapter 这两个函数向系统注册设置好的 i2c_adapter,这两个函数的原型如下:

int i2c_add_adapter(struct i2c_adapter *adapter)
int i2c_add_numbered_adapter(struct i2c_adapter *adap)

函数区别在于i2c_add_adapter使用动态总线号,而i2c_add_numbered_adapter 使用静态总线号。
函数参数和返回值含义如下:

adapter 或 adap:要添加到 Linux 内核中的 i2c_adapter,即 I2C 控制器。
返回值:0,成功;负值,失败。

如果要删除 I2C 适配器使用 i2c_del_adapter 函数即可,函数原型如下:

void i2c_del_adapter(struct i2c_adapter * adap)

函数参数和返回值含义如下:

adap:要删除的 I2C 适配器。
返回值:无。

2、主机设备(IIC控制器)

主机设备即IIC控制器的信息由设备树来描述,在 imx6ull.dtsi 文件中找到 I.MX6U 的 I2C1 控制器节点,节点内容如下所示:

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

3、主机驱动与主机设备匹配分析

设备和驱动的匹配过程也是由 I2C 总线完成的,使用 i2c_device_match 这个函数进行匹配,在总线部分已经分析过。

I2C 主机驱动一般都是 SOC 厂商去编写的,比如 NXP 就编写好了 I.MX6U 的 I2C 适配器驱动。在 imx6ull.dtsi 文件中找到 I.MX6U 的 I2C1 控制器节点,节点内容如下所示:

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

重点在 i2c1 节点的 compatible 属性值,因为通过 compatible 属性值可以在 Linux 源码里面找到对应的驱动文件。这里i2c1节点的 compatible 属性值有个:“fsl,imx6ul-i2c”和“fsl,imx21-i2c”,在 Linux 源码中搜索这两个字符串即可找到对应的驱动文件。

I.MX6U 的 I2C 适配器驱动驱动文件为 drivers/i2c/busses/i2c-imx.c,在此文件中有如下内容:

static struct platform_device_id imx_i2c_devtype[] = {
    {
        .name = "imx1-i2c",
        .driver_data = (kernel_ulong_t)&imx1_i2c_hwdata,
    }, {
        .name = "imx21-i2c",
        .driver_data = (kernel_ulong_t)&imx21_i2c_hwdata,
    }, {
        /* sentinel */
    }
};
MODULE_DEVICE_TABLE(platform, imx_i2c_devtype);

static const struct of_device_id i2c_imx_dt_ids[] = {
    { .compatible = "fsl,imx1-i2c", .data = &imx1_i2c_hwdata, },
    { .compatible = "fsl,imx21-i2c", .data = &imx21_i2c_hwdata, },
    { .compatible = "fsl,vf610-i2c", .data = &vf610_i2c_hwdata, },
    { /* sentinel */ }
};
MODULE_DEVICE_TABLE(of, i2c_imx_dt_ids);
......
static struct platform_driver i2c_imx_driver = {
    .probe = i2c_imx_probe,
    .remove = i2c_imx_remove,
    .driver = {
        .name = DRIVER_NAME,
        .owner = THIS_MODULE,
        .of_match_table = i2c_imx_dt_ids,
        .pm = IMX_I2C_PM,
    },
    .id_table = imx_i2c_devtype,
};

static int __init i2c_adap_imx_init(void)
{
    return platform_driver_register(&i2c_imx_driver);
}
subsys_initcall(i2c_adap_imx_init);

static void __exit i2c_adap_imx_exit(void)
{
    platform_driver_unregister(&i2c_imx_driver);
}
module_exit(i2c_adap_imx_exit);

从示例代码可以看出,I.MX6U 的 I2C 主机驱动是个标准的 platform 驱动,由此可以看出,虽然 I2C 总线为别的设备提供了一种总线驱动框架,但是 I2C 主机驱动却是 platform 驱动。
第 16 行:“fsl,imx21-i2c”属性值,设备树中 i2c1 节点的 compatible 属性值就是与此匹配上的。因此 i2c-imx.c 文件就是 I.MX6U 的 I2C 适主机动文件。
第 23 行:当主机设备和主机驱动匹配成功以后 i2c_imx_probe 函数就会执行,i2c_imx_probe 函数会完成 I2C 主机控制器的初始化工作。

i2c_imx_probe 函数主要的工作就是以下两点:
①、初始化 i2c_adapter,设置 i2c_algorithm 为 i2c_imx_algo,最后向 Linux 内核注册 i2c_adapter。
②、初始化 I2C1 控制器的相关寄存器。

i2c_imx_algo 包含 I2C1 控制器与 I2C 外围设备(如MPU6050)的通信函数 master_xfer,结构体定义如下:

static struct i2c_algorithm i2c_imx_algo = {
    .master_xfer = i2c_imx_xfer,
    .functionality = i2c_imx_func,
};

functionality 用于返回此 I2C 适配器支持什么样的通信协议,在这里就是 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 外围设备通信的,此函数内容如下(有省略):

static int i2c_imx_xfer(struct i2c_adapter *adapter,
                        struct i2c_msg *msgs, int num)
{
    unsigned int i, temp;
    int result;
    bool is_lastmsg = false;
    struct imx_i2c_struct *i2c_imx = i2c_get_adapdata(adapter);

    dev_dbg(&i2c_imx->adapter.dev, "<%s>\n", __func__);

    /* Start I2C transfer */
    result = i2c_imx_start(i2c_imx);
    if (result)
        goto fail0;

    /* read/write data */
    for (i = 0; i < num; i++) {
        if (i == num - 1)
            is_lastmsg = true;

        if (i) {
            dev_dbg(&i2c_imx->adapter.dev,
                    "<%s> repeated start\n", __func__);
            temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
            temp |= I2CR_RSTA;
            imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
            result = i2c_imx_bus_busy(i2c_imx, 1);
            if (result)
                goto fail0;
        }
        dev_dbg(&i2c_imx->adapter.dev,
                "<%s> transfer message: %d\n", __func__, i);
        /* write/read data */
......
        if (msgs[i].flags & I2C_M_RD)
            result = i2c_imx_read(i2c_imx, &msgs[i], is_lastmsg);
        else {
            if (i2c_imx->dma && msgs[i].len >= DMA_THRESHOLD)
                result = i2c_imx_dma_write(i2c_imx, &msgs[i]);
            else
                result = i2c_imx_write(i2c_imx, &msgs[i]);
        }
        if (result)
            goto fail0;
    }

fail0:
    /* Stop I2C transfer */
    i2c_imx_stop(i2c_imx);

    dev_dbg(&i2c_imx->adapter.dev, "<%s> exit with: %s: %d\n",
            __func__,
            (result < 0) ? "error" : "success msg",
            (result < 0) ? result : num);
    return (result < 0) ? result : num;
}

第 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 寄存器的具体操作函数。

当使用 IIC 接口与一些外围设备如 MPU6050 进行通信时,要初始化 I2C 设备并与设备进行通信就必须能够对 I2C 设备寄存器进行读写操作,这里就要用到 i2c_transfer 函数。该函数最终会调用 I2C 控制器中 i2c_algorithm 里面的 master_xfer 函数,对于 I.MX6U 而言就是i2c_imx_xfer 这个函数,函数最终会调用i2c_imx_start、i2c_imx_read、i2c_imx_write 和 i2c_imx_stop 这些函数来读写设备寄存器。

i2c_transfer 函数原型如下:

int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)

函数参数和返回值含义如下:

adap:所使用的 I2C 适配器,i2c_client 会保存其对应的 i2c_adapter。
msgs:I2C 要发送的一个或多个消息。
num:消息数量,也就是 msgs 的数量。
返回值:负值,失败,其他非负值,发送的 msgs 数量。

另外还有两个API函数分别用于 I2C 数据的收发操作,在 drives/i2c/i2c-core.c中定义,这两个函数最终都会调用i2c_transfer。

I2C 数据发送函数 i2c_master_send,函数原型如下:

int i2c_master_send(const struct i2c_client *client, const char *buf, int count)

函数参数和返回值含义如下:

client:I2C 设备对应的 i2c_client。
buf:要发送的数据。
count:要发送的数据字节数,要小于 64KB,以为 i2c_msg 的 len 成员变量是一个 u16(无符号 16 位)类型的数据。
返回值:负值,失败,其他非负值,发送的字节数。

I2C 数据接收函数为 i2c_master_recv,函数原型如下:

int i2c_master_recv(const struct i2c_client *client, char *buf, int count)

函数参数和返回值含义如下:

client:I2C 设备对应的 i2c_client。
buf:要接收的数据。
count:要接收的数据字节数,要小于 64KB,以为 i2c_msg 的 len 成员变量是一个 u16(无符号 16 位)类型的数据。
返回值:负值,失败,其他非负值,发送的字节数。

结论:
主机驱动通过 IIC 总线提供的 API 向 Linux 注册与注销一个主机驱动。同时,向下给设备驱动提供 IIC 通讯相关 API。主机驱动由 SOC 厂商提供,用户无需编写。

二、设备驱动和普通设备

设备驱动指具体的IIC接口设备的驱动程序(如MPU6050的驱动程序),而普通设备指具体的IIC设备(如MPU6050芯片)。

1、设备驱动

I2C设备驱动重点关注两个数据结构:i2c_client和i2c_driver,i2c_client 就是描述设备信息的,i2c_driver 描述驱动内容。

①、i2c_client 结构体

i2c_client 结构体定义在 include/linux/i2c.h 文件中,内容如下:

struct i2c_client {
    unsigned short flags; /* 标志 */
    unsigned short addr;  /* 芯片地址,7 位,存在低 7 位*/
......
    char name[I2C_NAME_SIZE];    /* 名字 */
    struct i2c_adapter *adapter; /* 对应的 I2C 适配器 */
    struct device dev;           /* 设备结构体 */
    int irq;                     /* 中断 */
    struct list_head detected;
......
};

一个设备对应一个 i2c_client,每检测到一个 I2C 设备就会给这个 I2C 设备分配一个i2c_client,Linux 获取(有设备树解析获取 或 无设备树获取)设备信息时自动生成。
比如在设备树种定义了 MPU6050 这个 IIC 接口的设备,Linux 在解析设备树时会将获取到的 MPU6050 的信息用一个 i2c_client 类型的结构体变量保存起来。

②、i2c_driver 结构体

i2c_driver 是我们编写 I2C 设备驱动重点要处理的内容,i2c_driver 结构体定义在 include/linux/i2c.h 文件中,内容如下:

struct i2c_driver {
    unsigned int class;

    /* Notifies the driver that a new bus has appeared. You should
     * avoid using this, it will be removed in a near future.
     */
    int (*attach_adapter)(struct i2c_adapter *) __deprecated;

    /* Standard driver model interfaces */
    int (*probe)(struct i2c_client *, const struct i2c_device_id *);
    int (*remove)(struct i2c_client *);

    /* driver model interfaces that don't relate to enumeration */
    void (*shutdown)(struct i2c_client *);

    /* Alert callback, for example for the SMBus alert protocol.
     * The format and meaning of the data value depends on the
     * protocol.For the SMBus alert protocol, there is a single bit
     * of data passed as the alert response's low bit ("event
       flag"). */
    void (*alert)(struct i2c_client *, unsigned int data);

    /* a ioctl like command that can be used to perform specific
     * functions with the device.
     */
    int (*command)(struct i2c_client *client, unsigned int cmd, void *arg);

    struct device_driver driver;
    const struct i2c_device_id *id_table;

    /* Device detection callback for automatic device creation */
    int (*detect)(struct i2c_client *, struct i2c_board_info *);
    const unsigned short *address_list;
    struct list_head clients;
};

第 10 行:当 I2C 设备和驱动匹配成功以后 probe 函数就会执行,和 platform 驱动一样。
第 28 行:device_driver 驱动结构体,使用设备树的话需设置 device_driver 的 of_match_table 成员变量,即驱动的兼容(compatible)属性。
第 29 行:id_table 是传统的、未使用设备树的设备匹配 ID 表。

③注册与注销

注册:对于 I2C 设备驱动编写人来说,重点工作就是构建 i2c_driver,构建完成以后需要向 Linux 内核注册这个 i2c_driver。i2c_driver 注册函数原型如下:

int i2c_register_driver(struct module *owner, struct i2c_driver *driver)

函数参数和返回值含义如下:

owner:一般为 THIS_MODULE。
driver:要注册的 i2c_driver。
返回值:0,成功;负值,失败。

另外 i2c_add_driver 也常常用于注册 i2c_driver,i2c_add_driver 是一个宏,定义如下:

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

i2c_add_driver 就是对 i2c_register_driver 做了一个简单的封装,只有一个参数,就是要注册的 i2c_driver。

注销:注销 I2C 设备驱动的时候需要将前面注册的 i2c_driver 从 Linux 内核中注销掉,需要用到 i2c_del_driver 函数,此函数原型如下:

void i2c_del_driver(struct i2c_driver *driver)

函数参数和返回值含义如下:

driver:要注销的 i2c_driver。
返回值:无。

2、普通设备(设备)

①、未使用设备树的时候

未使用设备树的时候需要在 BSP 里面使用 i2c_board_info 结构体来描述一个具体的 I2C 设备。i2c_board_info 结构体如下:

struct i2c_board_info {
    char type[I2C_NAME_SIZE]; /* I2C 设备名字 */
    unsigned short flags; /* 标志 */
    unsigned short addr; /* I2C 器件地址 */
    void *platform_data;
    struct dev_archdata *archdata;
    struct device_node *of_node;
    struct fwnode_handle *fwnode;
    int irq;
};

type 和 addr 这两个成员变量是必须要设置的,一个是 I2C 设备的名字,一个是 I2C 设备的器件地址。

打开 arch/arm/mach-imx/mach-mx27_3ds.c 文件,此文件中关于 OV2640 的 I2C 设备信息描述如下:

static struct i2c_board_info mx27_3ds_i2c_camera = {
    I2C_BOARD_INFO("ov2640", 0x30),
};

示例代码中使用 I2C_BOARD_INFO 来完成 mx27_3ds_i2c_camera 的初始化工作,I2C_BOARD_INFO 是一个宏,定义如下:

#define I2C_BOARD_INFO(dev_type, dev_addr) \
        .type = dev_type, .addr = (dev_addr)

可以看出,I2C_BOARD_INFO 宏其实就是设置 i2c_board_info 的 type 和 addr 这两个成员变量,即设置 I2C 设备名字为 ov2640,ov2640 的器件地址为 0X30。设备名字用于匹配驱动。

②、使用设备树的时候

使用设备树的时候 I2C 设备信息通过创建相应的节点就行了,比如 NXP 官方的 EVK 开发板在 I2C1 上接了 mag3110 这个磁力计芯片,因此必须在 i2c1 节点下创建 mag3110 子节点,然后在这个子节点内描述 mag3110 这个芯片的相关信息。

打开 imx6ull-14x14-evk.dts 这个设备树文件,然后找到如下内容:

&i2c1 {
    clock-frequency = <100000>;
    pinctrl-names = "default";
    pinctrl-0 = <&pinctrl_i2c1>;
    status = "okay";

    mag3110@0e {
        compatible = "fsl,mag3110";
        reg = <0x0e>;
        position = <2>;
    };
......
};

第 7~11 行:向 i2c1 添加 mag3110 子节点。
第 7 行:“mag3110@0e”是子节点名字,“@”后面的“0e”就是 mag3110 的 I2C 器件地址。
第 8 行:设置 compatible 属性值为“fsl,mag3110”。
第 9 行:reg 属性也是设置 mag3110 的器件地址的,因此值为 0x0e。I2C 设备节点的创建重点是 compatible 属性和 reg 属性的设置,一个用于匹配驱动,一个用于设置器件地址。

三、设备驱动模板(AP3216C为例)

1、修改设备树

①、IO 修改或添加

AP3216C 用到了 I2C1 接口,I.MX6U-ALPHA 开发板上的 I2C1 接口使用到了 UART4_TXD 和 UART4_RXD,只需要设置 UART4_TXD 和 UART4_RXD 这两个IO,NXP 已经将这两个 IO 设置好了,打开 imx6ull-alientek-emmc.dts,然后找到如下内容:

pinctrl_i2c1: i2c1grp {
    fsl,pins = <
        MX6UL_PAD_UART4_TX_DATA__I2C1_SCL 0x4001b8b0
        MX6UL_PAD_UART4_RX_DATA__I2C1_SDA 0x4001b8b0
    >;
};

②、在 i2c1 节点追加 ap3216c 子节点

AP3216C 是连接到 I2C1 上的,因此需要在 i2c1 节点下添加 ap3216c 的设备子节点,在 imx6ull-alientek-emmc.dts 文件中找到 i2c1 节点,此节点默认内容如下:

&i2c1 {
    clock-frequency = <100000>;
    pinctrl-names = "default";
    pinctrl-0 = <&pinctrl_i2c1>;
    status = "okay";

    mag3110@0e {
        compatible = "fsl,mag3110";
        reg = <0x0e>;
        position = <2>;
    };

    fxls8471@1e {
        compatible = "fsl,fxls8471";
        reg = <0x1e>;
        position = <0>;
        interrupt-parent = <&gpio5>;
        interrupts = <0 8>;
    };
};

将 i2c1 节点里面原有的 mag3110 和 fxls8471 这两个 I2C 子节点删除,然后添加 ap3216c子节点信息,完成以后的 i2c1 节点内容如下所示:

&i2c1 {
    clock-frequency = <100000>;
    pinctrl-names = "default";
    pinctrl-0 = <&pinctrl_i2c1>;
    status = "okay";
    
    ap3216c@1e {
        compatible = "alientek,ap3216c";
        reg = <0x1e>;
    };
};

第 7 行:ap3216c 子节点,@后面的“1e”是 ap3216c 的器件地址。
第 8 行:设置 compatible 值为“alientek,ap3216c”。
第 9 行:reg 属性也是设置 ap3216c 器件地址的,因此 reg 设置为 0x1e。
设备树修改完成以后使用“make dtbs”重新编译

2、AP3216C 驱动编写

新建 ap3216c.c 和 ap3216creg.h 这两个文件,ap3216c.c 为 AP3216C 的驱动代码,ap3216creg.h 是 AP3216C 寄存器头文件。
先在 ap3216creg.h 中定义好 AP3216C 的寄存器,输入如下内容:

#ifndef AP3216C_H
#define AP3216C_H

/* AP3316C 寄存器 */
#define AP3216C_SYSTEMCONG 0x00 /* 配置寄存器 */
#define AP3216C_INTSTATUS 0X01 /* 中断状态寄存器 */
#define AP3216C_INTCLEAR 0X02 /* 中断清除寄存器 */
#define AP3216C_IRDATALOW 0x0A /* IR 数据低字节 */
#define AP3216C_IRDATAHIGH 0x0B /* IR 数据高字节 */
#define AP3216C_ALSDATALOW 0x0C /* ALS 数据低字节 */
#define AP3216C_ALSDATAHIGH 0X0D /* ALS 数据高字节 */
#define AP3216C_PSDATALOW 0X0E /* PS 数据低字节 */
#define AP3216C_PSDATAHIGH 0X0F /* PS 数据高字节 */

#endif

在 ap3216c.c 输入如下内容:
#include <linux/types.h>
#include <linux/kernel.h>
#include <linux/delay.h>
#include <linux/ide.h>
#include <linux/init.h>
#include <linux/module.h>
#include <linux/errno.h>
#include <linux/gpio.h>
#include <linux/cdev.h>
#include <linux/device.h>
#include <linux/of_gpio.h>
#include <linux/semaphore.h>
#include <linux/timer.h>
#include <linux/i2c.h>
#include <asm/mach/map.h>
#include <asm/uaccess.h>
#include <asm/io.h>
#include "ap3216creg.h"

#define AP3216C_CNT 1
#define AP3216C_NAME "ap3216c"

struct ap3216c_dev {
    dev_t devid; /* 设备号 */
    int major;   /* 主设备号 */
    struct cdev cdev;      /* cdev */
    struct class *class;   /* 类 */
    struct device *device; /* 设备 */
    struct device_node *nd;  /* 设备节点 */
    void *private_data;         /* 私有数据:保存 client 设备信息,在 probe 函数中赋值*/
    unsigned short ir, als, ps; /* 三个光传感器数据 */
};

static struct ap3216c_dev ap3216cdev;

/*
 * @description : 从 ap3216c 读取多个寄存器数据
 * @param – dev : ap3216c 设备
 * @param – reg : 要读取的寄存器首地址
 * @param – val : 读取到的数据
 * @param – len : 要读取的数据长度
 * @return : 操作结果
*/
static int ap3216c_read_regs(struct ap3216c_dev *dev, u8 reg, void *val, int len)
{
    int ret;
    struct i2c_msg msg[2];
    struct i2c_client *client = (struct i2c_client *) dev->private_data;

    /* msg[0]为发送要读取的首地址 */
    msg[0].addr = client->addr; /* ap3216c 地址 */
    msg[0].flags = 0; /* 标记为发送数据 */
    msg[0].buf = &reg; /* 读取的首地址 */
    msg[0].len = 1; /* reg 长度 */

    /* msg[1]读取数据 */
    msg[1].addr = client->addr;
    /* ap3216c 地址 */
    msg[1].flags = I2C_M_RD; /* 标记为读取数据 */
    msg[1].buf = val; /* 读取数据缓冲区 */
    msg[1].len = len; /* 要读取的数据长度 */

    ret = i2c_transfer(client->adapter, msg, 2);
    if(ret == 2) {
        ret = 0;
    } else {
        printk("i2c rd failed=%d reg=%06x len=%d\n",ret, reg, len);
        ret = -EREMOTEIO;
    }
    return ret;
}

/*
 * @description : 向 ap3216c 多个寄存器写入数据
 * @param – dev : ap3216c 设备
 * @param – reg : 要写入的寄存器首地址
 * @param – val : 要写入的数据缓冲区
 * @param – len : 要写入的数据长度
 * @return : 操作结果
 */
static s32 ap3216c_write_regs(struct ap3216c_dev *dev, u8 reg, u8 *buf, u8 len)
{
    u8 b[256];
    struct i2c_msg msg;
    struct i2c_client *client = (struct i2c_client *) dev->private_data;

    b[0] = reg; /* 寄存器首地址 */
    memcpy(&b[1],buf,len); /* 将要写入的数据拷贝到数组 b 里面 */

    msg.addr = client->addr; /* ap3216c 地址 */
    msg.flags = 0; /* 标记为写数据 */

    msg.buf = b; /* 要写入的数据缓冲区 */
    msg.len = len + 1; /* 要写入的数据长度 */

    return i2c_transfer(client->adapter, &msg, 1);
}

/*
 * @description : 读取 ap3216c 指定寄存器值,读取一个寄存器
 * @param – dev : ap3216c 设备
 * @param – reg : 要读取的寄存器
 * @return : 读取到的寄存器值
 */
static unsigned char ap3216c_read_reg(struct ap3216c_dev *dev, u8 reg)
{
    u8 data = 0;

    ap3216c_read_regs(dev, reg, &data, 1);
    return data;

    #if 0
        struct i2c_client *client = (struct i2c_client *) dev->private_data;
        return i2c_smbus_read_byte_data(client, reg);
    #endif
}

/*
 * @description : 向 ap3216c 指定寄存器写入指定的值,写一个寄存器
 * @param – dev : ap3216c 设备
 * @param – reg : 要写的寄存器
 * @param – data : 要写入的值
 * @return : 无
 */
static void ap3216c_write_reg(struct ap3216c_dev *dev, u8 reg, u8 data)
{
    u8 buf = 0;
    buf = data;
    ap3216c_write_regs(dev, reg, &buf, 1);
}

/*
 * @description : 读取 AP3216C 的数据,读取原始数据,包括 ALS,PS 和 IR,
 * :同时打开 ALS,IR+PS 的话两次数据读取的间隔要大于 112.5ms
 * @param - ir : ir 数据
 * @param - ps : ps 数据
 * @param - ps : als 数据
 * @return : 无。
 */
void ap3216c_readdata(struct ap3216c_dev *dev)
{
    unsigned char i =0;
    unsigned char buf[6];

    /* 循环读取所有传感器数据 */
    for(i = 0; i < 6; i++)
    {
        buf[i] = ap3216c_read_reg(dev, AP3216C_IRDATALOW + i);
    }

    if(buf[0] & 0X80) /* IR_OF 位为 1,则数据无效 */
        dev->ir = 0;
    else /* 读取 IR 传感器的数据 */
        dev->ir = ((unsigned short)buf[1] << 2) | (buf[0] & 0X03);

    dev->als = ((unsigned short)buf[3] << 8) | buf[2];/* ALS 数据 */

    if(buf[4] & 0x40) /* IR_OF 位为 1,则数据无效 */
        dev->ps = 0;
    else /* 读取 PS 传感器的数据 */
        dev->ps = ((unsigned short)(buf[5] & 0X3F) << 4) | (buf[4] & 0X0F);
}

/*
 * @description : 打开设备
 * @param – inode : 传递给驱动的 inode
 * @param - filp : 设备文件,file 结构体有个叫做 private_data 的成员变量
 * 一般在 open 的时候将 private_data 指向设备结构体。
 * @return : 0 成功;其他 失败
 */
static int ap3216c_open(struct inode *inode, struct file *filp)
{
    filp->private_data = &ap3216cdev;

    /* 初始化 AP3216C */
    ap3216c_write_reg(&ap3216cdev, AP3216C_SYSTEMCONG, 0x04);
    mdelay(50); /* AP3216C 复位最少 10ms */
    ap3216c_write_reg(&ap3216cdev, AP3216C_SYSTEMCONG, 0X03);
    return 0;
}

/*
 * @description : 从设备读取数据
 * @param – filp : 要打开的设备文件(文件描述符)
 * @param - buf : 返回给用户空间的数据缓冲区
 * @param - cnt : 要读取的数据长度
 * @param – offt : 相对于文件首地址的偏移
 * @return : 读取的字节数,如果为负值,表示读取失败
 */
static ssize_t ap3216c_read(struct file *filp, char __user *buf, size_t cnt, loff_t *off)
{
    short data[3];
    long err = 0;

    struct ap3216c_dev *dev = (struct ap3216c_dev *)
    filp->private_data;

    ap3216c_readdata(dev);

    data[0] = dev->ir;
    data[1] = dev->als;
    data[2] = dev->ps;
    err = copy_to_user(buf, data, sizeof(data));
    return 0;
}

/*
 * @description : 关闭/释放设备
 * @param - filp : 要关闭的设备文件(文件描述符)
 * @return : 0 成功;其他 失败
 */
static int ap3216c_release(struct inode *inode, struct file *filp)
{
    return 0;
}

/* AP3216C 操作函数 */
static const struct file_operations ap3216c_ops = {
    .owner = THIS_MODULE,
    .open = ap3216c_open,
    .read = ap3216c_read,
    .release = ap3216c_release,
};

/*
 * @description : i2c 驱动的 probe 函数,当驱动与
 *                设备匹配以后此函数就会执行
 * @param - client : i2c 设备
 * @param - id : i2c 设备 ID
 * @return : 0,成功;其他负值,失败
 */
static int ap3216c_probe(struct i2c_client *client, const struct i2c_device_id *id)
{
    /* 1、构建设备号 */
    if (ap3216cdev.major) {
        ap3216cdev.devid = MKDEV(ap3216cdev.major, 0);
        register_chrdev_region(ap3216cdev.devid, AP3216C_CNT,
        AP3216C_NAME);
    } else {
        alloc_chrdev_region(&ap3216cdev.devid, 0, AP3216C_CNT, AP3216C_NAME);
        ap3216cdev.major = MAJOR(ap3216cdev.devid);
    }

    /* 2、注册设备 */
    cdev_init(&ap3216cdev.cdev, &ap3216c_ops);
    cdev_add(&ap3216cdev.cdev, ap3216cdev.devid, AP3216C_CNT);

    /* 3、创建类 */
    ap3216cdev.class = class_create(THIS_MODULE, AP3216C_NAME);
    if (IS_ERR(ap3216cdev.class)) {
        return PTR_ERR(ap3216cdev.class);
    }

    /* 4、创建设备 */
    ap3216cdev.device = device_create(ap3216cdev.class, NULL, ap3216cdev.devid, NULL, AP3216C_NAME);
    if (IS_ERR(ap3216cdev.device)) {
        return PTR_ERR(ap3216cdev.device);
    }

    ap3216cdev.private_data = client;

return 0;
}

/*
 * @description : i2c 驱动的 remove 函数,移除 i2c 驱动此函数会执行
 * @param – client : i2c 设备
 * @return : 0,成功;其他负值,失败
 */
static int ap3216c_remove(struct i2c_client *client)
{
    /* 删除设备 */
    cdev_del(&ap3216cdev.cdev);
    unregister_chrdev_region(ap3216cdev.devid, AP3216C_CNT);

    /* 注销掉类和设备 */
    device_destroy(ap3216cdev.class, ap3216cdev.devid);
    class_destroy(ap3216cdev.class);
    return 0;
}

/* 传统匹配方式 ID 列表 */
static const struct i2c_device_id ap3216c_id[] = {
    {"alientek,ap3216c", 0},
    {}
};

/* 设备树匹配列表 */
static const struct of_device_id ap3216c_of_match[] = {
    { .compatible = "alientek,ap3216c" },
    { /* Sentinel */ }
};

/* i2c 驱动结构体 */
static struct i2c_driver ap3216c_driver = {
    .probe = ap3216c_probe,
    .remove = ap3216c_remove,
    .driver = {
        .owner = THIS_MODULE,
        .name = "ap3216c",
        .of_match_table = ap3216c_of_match,
    },
    .id_table = ap3216c_id,
};

/*
 * @description : 驱动入口函数
 * @param : 无
 * @return : 无
 */
static int __init ap3216c_init(void)
{
    int ret = 0;

    ret = i2c_add_driver(&ap3216c_driver);
    return ret;
}

/*
 * @description : 驱动出口函数
 * @param : 无
 * @return : 无 
 */
static void __exit ap3216c_exit(void)
{
    i2c_del_driver(&ap3216c_driver);
}

/* module_i2c_driver(ap3216c_driver) */

module_init(ap3216c_init);
module_exit(ap3216c_exit);
MODULE_LICENSE("GPL");
MODULE_AUTHOR("KODO");

标签:i2c,struct,driver,笔记,IIC,imx,IMX6ULL,I2C,ap3216c
From: https://www.cnblogs.com/KuDianWanJia/p/17133115.html

相关文章

  • 【IMX6ULL学习笔记】十九、Pinctrl、GPIO驱动驱动框架
    一、I.MX6ULL的pinctrl(IOMUXC)子系统1、设备树中PIN配置信息详解打开imx6ull.dtsi文件,找到一个叫做iomuxc的节点,如下所示:iomuxc:iomuxc@020e0000{compati......
  • etcd学习笔记-组件架构
    etcd项目结构其中核心模块etcdserver,lease,mvcc,raft整体架构客户端层包括clientv3和etcdctl等客户端,用户通过命令行或者客户端通过restfulapi降低了etcd客户端的使用复杂......
  • Python学习笔记(二)变量的使用
    一、变量的定义把程序运算的中间结果临时存到内存里,以备后面的代码继续调用,这几个名字的学名就叫做“变量”可以把变量看做保存信息的容器,它们的目的是在内存中标注和存......
  • Spring IOC官方文档学习笔记(十一)之使用JSR 330标准注解
    1.使用@Inject和@Named进行依赖注入(1)Spring提供了对JSR330标准注解的支持,因此我们也可以使用JSR330标准注解来进行依赖注入,不过,在此之前,我们得先使用maven添加相关依......
  • 【第一个随笔来啦~】Tuffy的复习笔记 —— 数字电路 —— 数据存储
    最近一直在为数字电路复习,发现数据存储这部分的知识点对于数字电路相关课程的初学者来说实在过于复杂不怎么好理解,所以希望通过这个blog为初学者解决这样的问题。注:本blog......
  • 【IMX6ULL学习笔记】十八、Platform 驱动框架
    一、platform驱动Linux提出了platform这个虚拟总线,相应的就有platform_driver和platform_device。platform驱动使用platform_driver结构体表示,此结构体定义在......
  • 【IMX6ULL学习笔记】十七、总线驱动框架-Platform、IIC、SPI等
    一、总线Linux总线驱动模型主要可以分为三个部分:总线、设备、驱动。Linux中的总线(bus)、驱动(driver)和设备(device)模型,也就是常说的驱动分离。Linux内核在启动时会向......
  • Android笔记--添加联系人
    添加联系人(将联系人信息添加到手机的通讯录里面)方式一:使用ContentResolver方法写入对象,每次一个字段新创建一个需要加入通讯录的对象(我这里写的比较简单,并不是通讯录的......
  • PHP学习笔记(观隅反三)
    前言上一篇文章PHP学习笔记(才贯二酉)为大家介绍了PHP中的流程控制语句,这篇文章接着学习PHP中的数组。数组(一)为什么要创建数组这里就不赘述了,在PHP中,有三种类型的数组:​​......
  • 参考iictools源码实现HP203b气压温度传感器读取
    参考i2ctools源码实现HP203B气压温度传感器读取由于开发的设备中要用到HP203B气压温度传感器,此设备要用到i2c协议进行数据的读取,我将以韦东山老师课程为指引,参考经典的i2c......