AP316C I2C驅動示例

lethe1203發表於2024-03-31

參考資料:正點原子Linux裝置驅動

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>

#define AP3216C_CNT    1
#define AP3216C_NAME    "ap3216c"

#define AP3216C_ADDR        0X1E    /* AP3216C器件地址  */

/* 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資料高位元組     */

struct ap3216c_dev {
    dev_t devid;            /* 裝置號      */
    struct cdev cdev;        /* cdev     */
    struct class *class;    /**/
    struct device *device;    /* 裝置      */
    struct device_node    *nd; /* 裝置節點 */
    int major;            /* 主裝置號 */
    void *private_data;    /* 私有資料 */
    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);  // 第一Byte地址,第二Byte讀資料
    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);        /* 復位AP3216C             */
    mdelay(50);                                                        /* AP3216C復位最少10ms     */
    ap3216c_write_reg(&ap3216cdev, AP3216C_SYSTEMCONG, 0X03);        /* 開啟ALS、PS+IR         */
    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("lethe1203");

相關文章