Linux内核驱动编写

/**
 * <memory initial>
 * 驱动初始化
*/

/* Necessary includes for device drivers */
#include <linux/init.h>
// #include <linux/config.h>
#include <linux/module.h>
#include <linux/kernel.h>  /* printk() */
#include <linux/slab.h>    /* kmalloc() */
#include <linux/fs.h>      /* everything... */
#include <linux/errno.h>   /* error codes */
#include <linux/types.h>   /* size_t */
#include <linux/fcntl.h>   /* O_ACCMODE */
#include <linux/uaccess.h> /* copy_from/to_user */
#include <asm/switch_to.h> /* cli(), *_flags */
#include <asm/uaccess.h>   /* copy_from/to_user ???   <linux/uaccess.h>*/
#include <linux/proc_fs.h>

MODULE_LICENSE("Dual BSD/GPL");

/* 函数声明 Declaration of memory.c functions */
int memory_open(struct inode *inode, struct file *filp);
int memory_release(struct inode *inode, struct file *filp);

ssize_t memory_read(struct file *filp, char __user *buf, size_t count, loff_t *f_pos);
ssize_t memory_write(struct file *filp, const char __user *buf, size_t count, loff_t *f_pos);

void memory_exit(void);
int memory_init(void);

/* file_operations结构体填充 Structure that declares the usual file */
/* access functions */
struct file_operations memory_fops = {
    .read = memory_read,
    .write = memory_write,
    .open = memory_open,
    .release = memory_release,
};

/* Declaration of the init and exit functions */
module_init(memory_init);
module_exit(memory_exit);

/* 全局变量 Global variables of the driver */
/* Major number */
int memory_major = 60; //主设备号   待会 mknod /dev/memory c 60 0 里的60就是这个主设备号
/* Buffer to store data */
char *memory_buffer; //内存指针，将用于存储该内核驱动的数据

/**
 * <memory init module>
 * 连接到设备
*/
/**
 * 下面代码使用留kmalloc函数。这个函数工作在内核空间，用于为该驱动程序的缓冲区分配内存。
 * 它和我们熟悉的malloc函数很相似。
 * 最后，如果注册主设备号或者分配内存失败，模块将退出。
*/
int memory_init(void)
{
    int result;
    /* Registering device */
    // 在内核空间，把驱动和/dev下设备文件链接在一起。
    // 它有三个参数：主设备号，模块名称、file_operations结构体指针
    // 在安装模块(insmod)时被调用
    result = register_chrdev(memory_major, "memory", &memory_fops);
    if (result < 0)
    {
        printk("<1>memory: cannot obtain major number %d\n", memory_major);
        return result;
    }
    /* Allocating memory for the buffer */
    memory_buffer = kmalloc(1, GFP_KERNEL);
    if (!memory_buffer)
    {
        result = -ENOMEM;
        goto fail;
    }
    memset(memory_buffer, 0, 1);
    printk("<1>Inserting memory module\n");
    return 0;
fail:
    memory_exit();
    return result;
}

/**
 * <memory exit module>
 * 卸载驱动
*/
/* 为了完全地卸载该驱动，缓冲区也要通过该函数进行释放 */
void memory_exit(void)
{
    /* Freeing the major number */
    unregister_chrdev(memory_major, "memory");
    /* Freeing buffer memory */
    if (memory_buffer)
    {
        kfree(memory_buffer);
    }
    printk("<1>Removing memory module\n");
}

/**
 * <memory open>
 * 像打开文件一样打开设备
*/
/**
 * 内核空间打开文件的函数是open，和用户空间打开文件的函数fopen对应。
 * 在本例里，是memory_open函数
 * 参数1：inode结构体指针，该结构向内核发送主设备号和从设备号的信息
 * 参数2：file结构体指针，用于说明该设备文件允许哪些操作
 * 
 * 当设备文件打开后，通常就需要初始化驱动的各个变量，对设备进行复位。但在本例中，这些操作都没进行
*/
int memory_open(struct inode *inode, struct file *filp)
{
    /* Success */
    return 0;
}

/**
 * <memory release>
 * 像关闭文件一样关闭设备
*/
/**
 * 在内核空间里，和用户空间里关闭文件的fclose对应的函数是release。
 * 它是file_operations结构体的成员，用于调用register_chardev。
 * 在本例中，它时函数memory_release,和上面相似，他也有两个参数inode和file
*/
int memory_release(struct inode *inode, struct file *filp)
{
    /* Success */
    return 0;
}

/**
 * <memory read>
 * 读取设备
*/
/**
 * 和用户空间函数fread类似，内核空间里，读取设备文件使用read函数
 * read是file_operations的成员,在本例中调用memory_read函数
 * 参数1：file结构
 * 参数2：一个缓冲区
 * 参数3：要传输的字节数
 * 参数4：f_pos，表示从哪里开始读取该设备文件
 * 
 * 本例中，memory_read函数通过copy_to_user函数从驱动的缓冲区memory_buffer向用户空间传送一个简单的字节。
*/
ssize_t memory_read(struct file *filp, char __user *buf, size_t count, loff_t *f_pos)
{
    /* Transfering data to user space */
    copy_to_user(buf, memory_buffer, 1);
    /* Changing reading position as best suits */
    if (*f_pos == 0)
    {
        *f_pos += 1;
        return 1;
    }
    else
    {
        return 0;
    }
}

/**
 * <memory write>
 * 向设备写数据
*/
/**
 * 和用户空间里写文件的fwrite对应，内核空间里时write
 * write时file_operations的成员，本例中对应memory_write函数
 * 函数参数和read类似
 * 本例中函数copy_from_user从用户空间传送到内核空间
*/
ssize_t memory_write(struct file *filp, const char __user *buf, size_t count, loff_t *f_pos)
{
    const char __user *tmp;
    tmp = buf + count - 1;
    copy_from_user(memory_buffer, tmp, 1);
    return 1;
}

obj-m = memory.o

all:
	make -C /lib/modules/$(shell uname -r)/build/ M=${PWD} modules
clean:
	make -C /lib/modules/$(shell uname -r)/build/ M=${PWD} clean

liyongjun@Box:~/project/c/DRIVERS/memory$ make
make -C /lib/modules/4.15.0-91-generic/build/ M=/home/liyongjun/project/c/DRIVERS/memory modules
make[1]: Entering directory '/usr/src/linux-headers-4.15.0-91-generic'
  CC [M]  /home/liyongjun/project/c/DRIVERS/memory/memory.o
  Building modules, stage 2.
  MODPOST 1 modules
  CC      /home/liyongjun/project/c/DRIVERS/memory/memory.mod.o
  LD [M]  /home/liyongjun/project/c/DRIVERS/memory/memory.ko
make[1]: Leaving directory '/usr/src/linux-headers-4.15.0-91-generic'
liyongjun@Box:~/project/c/DRIVERS/memory$ sudo insmod memory.ko 
liyongjun@Box:~/project/c/DRIVERS/memory$ sudo mknod /dev/memory c 60 0
liyongjun@Box:~/project/c/DRIVERS/memory$ sudo chmod 777 /dev/memory
liyongjun@Box:~/project/c/DRIVERS/memory$ echo -n "a" > /dev/memory
liyongjun@Box:~/project/c/DRIVERS/memory$ cat /dev/memory
aliyongjun@Box:~/project/c/DRIVERS/memory$