05 字符设备驱动（下）

上一节介绍了字符驱动中的一些概念，这一节我们将会基于系统内存编写一个字符设备驱动，加深对上一节中的概念的理解。

本节主要学会的内容：

字符设备注册
对设备节点进行cat和echo操作

1. 驱动设计

编写驱动之前，我们要明确我们的驱动需要或者能够为用户程序提供什么功能，这也是我们之前提到的机制。

在《设备驱动程序》一书中，关于字符设备驱动程序的章节介绍了一个scull（Simple Character Utility for Loading Localities，区域装载的简单字符工具）设备，其设计的机制比较复杂，同时，其中的部分函数也已经被淘汰了。因此，本文简化其机制，并使用新的函数进行实现。

本文设计的设备名称沿用书本中的名字：scull。

本文设计的设备提供一个固定大小的内存区域（由宏DATA_SIZE决定），可以往其中存入（echo）数据（最大不大于指定的大小），同时可以读出（cat）其中的存储的数据。

2. 代码分析

设备驱动的代码比较长，所以就不全部列举出来，本文只对代码中的重点部分进行简要说明，如果需要全部代码，请看：
https://gitee.com/Quehehe/LinuxDeviceDriver

设备结构体

在头文件中（scull.h）定义了一个结构体，内容如下：

struct scull_dev {
    char *data;
    int data_length;
    struct cdev cdev;
};

这个结构体可以理解为设备：其包含了struct cdev，可以理解为继承的概念（当然，在C中没有继承的说法），说明此设备是一个字符设备；存储了数据的起始地址的指针，数据的长度。

如果有其他与设备相关的数据，都可以放到该结构体中，这样，只要获取到这个结构体就相当于获取了这个设备。

文件操作相关的数据结构

static struct file_operations fops = {
    .owner  =   THIS_MODULE,
    .open   =   scull_open,
    .release    = scull_release,
    .read   =   scull_read,
    .write  =   scull_write,
    .unlocked_ioctl  = scull_ioctl,
};

这个就是上一节中说的struct file_operations结构体，本文实现了其中的open、release、read、write和unlocked_ioctl函数。

open()、read()和write()函数说明

针对上面的open()、read()和write()的实现函数进行说明。

open()函数的实现如下：

int scull_open (struct inode *node, struct file *filp)
{
    struct scull_dev *dev;
    
    dev = container_of(node->i_cdev, struct scull_dev, cdev);
    filp->private_data = dev;

    return 0;
}

其中container_of()这个宏的作用是：根据结构体变量A中的某个属性的地址计算出结构体变量A的地址。利用node中的icdev的地址来获取上面的struct scull_dev变量的地址。

将获取到的struct scull_dev地址存储在filp->private_data变量中，这个变量上一节有说明，是一个void *指针变量，后续的read、write等操作都可以通过filp来获取struct scull_dev变量。

read()函数的实现如下（截取）：

ssize_t scull_read (struct file *filp, char __user *buf, size_t size, loff_t *loff)
{
    ......
    if(dev->data_length == 0 || *loff != 0) {
        return 0;
    }
   ......
    ret = raw_copy_to_user(buf, dev->data, size);
    ......
    *loff += size;
    return size;
}

raw_copy_to_user函数后面再说明。

这里对read()的返回值进行说明，其返回值有以下几种：

返回值等于形参size，则表示请求的数据读取完成，这是最理想的状态；
返回值是一个小于size的正整数，表明读取了部分数据，这种情况根据应用程序需要选择继续读取或者停止读取；
返回值为0，表示到达了数据的结尾，后续没有数据可以传输了；
返回值为负数，表示读取数据出错；

write()函数的实现如下（截取）：

ssize_t scull_write (struct file *filp, const char __user *buf, size_t size, loff_t *loff)
{
    ......
    ret = raw_copy_from_user(dev->data, buf, size);
    ......
    dev->data_length = size;
    return size;
}

raw_copy_from_user()函数后面再说明。

这里对write()函数的返回值进行说明，其返回值有以下几种情况：

返回值等于形参size，则表示写入的数据完成；
返回值是小于形参size的正整数，则表示未全部写入，应用程序根据需要可以继续写入或者停止写入；
返回值为0，表示没有写入任何数据，但是出现这个的原因并不是因为任何错误导致的，而是其他非原因；
返回值为负数，表示写入数据出错；

raw_copy_to_user()与raw_copy_from_user()

这两个函数定义在<asm/uaccess.h>头文件中，其作用是将内核空间和用户空间之间相互拷贝数据，从名字就可以看出：raw_copy_to_user从内核向用户空间拷贝；raw_copy_from_user从用户空间向内核空间拷贝。

内核空间与用户空间的地址是不能直接相互引用的，原因如下：

在内核模式运行时，用户空间的指针可能是无效的；
即使用户空间的指针与内核空间的指针代表的是相同的东西，但用户空间的内存是分页的，在系统调用时，涉及到的内存可能不在RAM中；
出于安全考虑，防止该指针指向一个恶意程序后者存在缺陷的程序。

字符设备注册（截取）

字符设备驱动注册的部分代码如下：

static int scull_init(void)
{
    ......    
    scull_dev.data = (char *)kmalloc(DATA_SIZE, GFP_KERNEL); /** 分配数据空间 */
    ......
    scull_dev.data_length = 0;

    ret = alloc_chrdev_region(&dev_num, 0, DEVICE_COUNT, DEVICE_NAME); /** 分配设备号 *

   cdev_init(&scull_dev.cdev, &fops); /** 初始化字符设备 */
   scull_dev.cdev.owner = THIS_MODULE;
   ret = cdev_add(&scull_dev.cdev, dev_num, DEVICE_COUNT); /** 添加字符设备 */
   if(ret < 0) {
       printk(KERN_ALERT "cdev add failed!\n");
       goto cdev_add_err;
   }

   /* 创建节点 */
   scull_class = class_create(THIS_MODULE, DEVICE_NAME);
   for(i = 0; i < DEVICE_COUNT; i++) {
       device_create(scull_class, NULL,
            MKDEV(MAJOR(dev_num), MINOR(dev_num) + i),
            NULL, DEVICE_NAME"%d", i);
   }
   printk(KERN_ALERT "cdev add complete!\n");
   return 0;

cdev_add_err:
    unregister_chrdev_region(dev_num, DEVICE_COUNT); /** 添加字符设备出错的话，将之前分配的设备号释放 */
alloc_dev_num_err:
    kfree(scull_dev.data);
alloc_data_err:
    return ret;
    
}