基于分层思想的驱动程序软件框架

目的

让驱动程序有很好的移植性。

实现的方法

• 将硬件相关的操作放入一个结构体中，类似于file_operation的结构体中，之后和将其操作的实现，一起封装在一个函数中，且需要设计提供一个函数让外部函数能得到硬件相关的结构体。（分层思想）

• 让向内核注册驱动的入口和出口中函数，只需要将所有驱动通用的代码放入其中即可

  ① 确定主设备号，也可以让内核分配

  ② 定义自己的 file_operations 结构体

  ③ 实现对应的 drv_open/drv_read/drv_write 等函数，填入 file_operations 结构体

  ④ 把 file_operations 结构体告诉内核： register_chrdev

  ⑤ 谁来注册驱动程序啊？得有一个入口函数：安装驱动程序时，就会去调用这个入口函数

  ⑥ 有入口函数就应该有出口函数：卸载驱动程序时，出口函数调用 unregister_chrdev

  ⑦ 其他完善：提供设备信息，自动创建设备节点： class_create, device_create

  ⑧ 将硬件相关的操作传递给入口函数：得到硬件操作相关函数的。

代码演示：

• 硬件相关的操作

#ifndef _LED_OPR_H
#define _LED_OPR_H

struct led_operations {
    int (*init) (int which); /* 初始化LED, which-哪个LED */       
    int (*ctl) (int which, char status); /* 控制LED, which-哪个LED, status:1-亮,0-灭 */
};

struct led_operations *get_board_led_opr(void);


#endif

#include <linux/module.h>

#include <linux/fs.h>
#include <linux/errno.h>
#include <linux/miscdevice.h>
#include <linux/kernel.h>
#include <linux/major.h>
#include <linux/mutex.h>
#include <linux/proc_fs.h>
#include <linux/seq_file.h>
#include <linux/stat.h>
#include <linux/init.h>
#include <linux/device.h>
#include <linux/tty.h>
#include <linux/kmod.h>
#include <linux/gfp.h>
#include "led_opr.h"

static int board_demo_led_init (int which) /* 初始化LED, which-哪个LED */       
{
    
    printk("%s %s line %d, led %d\n", __FILE__, __FUNCTION__, __LINE__, which);
    return 0;
}

static int board_demo_led_ctl (int which, char status) /* 控制LED, which-哪个LED, status:1-亮,0-灭 */
{
    printk("%s %s line %d, led %d, %s\n", __FILE__, __FUNCTION__, __LINE__, which, status ? "on" : "off");
    return 0;
}

static struct led_operations board_demo_led_opr = {
    .init = board_demo_led_init,
    .ctl  = board_demo_led_ctl,
};

struct led_operations *get_board_led_opr(void)
{
    return &board_demo_led_opr;
}

• 硬件无关，框架相关的操作

  #include <linux/module.h>
  
  #include <linux/fs.h>
  #include <linux/errno.h>
  #include <linux/miscdevice.h>
  #include <linux/kernel.h>
  #include <linux/major.h>
  #include <linux/mutex.h>
  #include <linux/proc_fs.h>
  #include <linux/seq_file.h>
  #include <linux/stat.h>
  #include <linux/init.h>
  #include <linux/device.h>
  #include <linux/tty.h>
  #include <linux/kmod.h>
  #include <linux/gfp.h>
  
  #include "led_opr.h"
  
  #define LED_NUM 2
  
  /* 1. 确定主设备号                                                                 */
  static int major = 0;
  static struct class *led_class;
  struct led_operations *p_led_opr;
  
  
  #define MIN(a, b) (a < b ? a : b)
  
  /* 3. 实现对应的open/read/write等函数，填入file_operations结构体                   */
  static ssize_t led_drv_read (struct file *file, char __user *buf, size_t size, loff_t *offset)
  {
    printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
    return 0;
  }
  
  /* write(fd, &val, 1); */
  static ssize_t led_drv_write (struct file *file, const char __user *buf, size_t size, loff_t *offset)
  {
    int err;
    char status;
    struct inode *inode = file_inode(file);
    int minor = iminor(inode);
  
    printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
    err = copy_from_user(&status, buf, 1);
  
    /* 根据次设备号和status控制LED */
    p_led_opr->ctl(minor, status);
  
    return 1;
  }
  
  static int led_drv_open (struct inode *node, struct file *file)
  {
    int minor = iminor(node);
  
    printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
    /* 根据次设备号初始化LED */
    p_led_opr->init(minor);
  
    return 0;
  }
  
  static int led_drv_close (struct inode *node, struct file *file)
  {
    printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
    return 0;
  }
  
  /* 2. 定义自己的file_operations结构体                                              */
  static struct file_operations led_drv = {
    .owner   = THIS_MODULE,
    .open    = led_drv_open,
    .read    = led_drv_read,
    .write   = led_drv_write,
    .release = led_drv_close,
  };
  
  /* 4. 把file_operations结构体告诉内核：注册驱动程序                                */
  /* 5. 谁来注册驱动程序啊？得有一个入口函数：安装驱动程序时，就会去调用这个入口函数 */
  static int __init led_init(void)
  {
    int err;
    int i;
  
    printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
    major = register_chrdev(0, "100ask_led", &led_drv);  /* /dev/led */
  
  
    led_class = class_create(THIS_MODULE, "100ask_led_class");
    err = PTR_ERR(led_class);
    if (IS_ERR(led_class)) {
        printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
        unregister_chrdev(major, "led");
        return -1;
    }
  
    for (i = 0; i < LED_NUM; i++)
        device_create(led_class, NULL, MKDEV(major, i), NULL, "100ask_led%d", i); /* /dev/100ask_led0,1,... */
  
    p_led_opr = get_board_led_opr();
  
    return 0;
  }
  
  /* 6. 有入口函数就应该有出口函数：卸载驱动程序时，就会去调用这个出口函数           */
  static void __exit led_exit(void)
  {
    int i;
    printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
  
    for (i = 0; i < LED_NUM; i++)
        device_destroy(led_class, MKDEV(major, i)); /* /dev/100ask_led0,1,... */
  
    device_destroy(led_class, MKDEV(major, 0));
    class_destroy(led_class);
    unregister_chrdev(major, "100ask_led");
  }
  
  
  /* 7. 其他完善：提供设备信息，自动创建设备节点                                     */
  
  module_init(led_init);
  module_exit(led_exit);
  
  MODULE_LICENSE("GPL");

• 测试用例和Makefile

  #include <sys/types.h>
  #include <sys/stat.h>
  #include <fcntl.h>
  #include <unistd.h>
  #include <stdio.h>
  #include <string.h>
  
  /*
   * ./ledtest /dev/100ask_led0 on
   * ./ledtest /dev/100ask_led0 off
   */
  int main(int argc, char **argv)
  {
    int fd;
    char status;
  
    /* 1. 判断参数 */
    if (argc != 3) 
    {
        printf("Usage: %s <dev> <on | off>\n", argv[0]);
        return -1;
    }
  
    /* 2. 打开文件 */
    fd = open(argv[1], O_RDWR);
    if (fd == -1)
    {
        printf("can not open file %s\n", argv[1]);
        return -1;
    }
  
    /* 3. 写文件 */
    if (0 == strcmp(argv[2], "on"))
    {
        status = 1;
        write(fd, &status, 1);
    }
    else
    {
        status = 0;
        write(fd, &status, 1);
    }
  
    close(fd);
  
    return 0;
  }

  # 1. 使用不同的开发板内核时, 一定要修改KERN_DIR
  # 2. KERN_DIR中的内核要事先配置、编译, 为了能编译内核, 要先设置下列环境变量:
  # 2.1 ARCH,          比如: export ARCH=arm64
  # 2.2 CROSS_COMPILE, 比如: export CROSS_COMPILE=aarch64-linux-gnu-
  # 2.3 PATH,          比如: export PATH=$PATH:/home/book/100ask_roc-rk3399-pc/ToolChain-6.3.1/gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu/bin 
  # 注意: 不同的开发板不同的编译器上述3个环境变量不一定相同,
  #       请参考各开发板的高级用户使用手册
  
  KERN_DIR = /home/book/100ask_roc-rk3399-pc/linux-4.4
  
  all:
    make -C $(KERN_DIR) M=`pwd` modules 
    $(CROSS_COMPILE)gcc -o ledtest ledtest.c 
  
  clean:
    make -C $(KERN_DIR) M=`pwd` modules clean
    rm -rf modules.order
    rm -f ledtest
  
  # 参考内核源码drivers/char/ipmi/Makefile
  # 要想把a.c, b.c编译成ab.ko, 可以这样指定:
  # ab-y := a.o b.o
  # obj-m += ab.o
  
  # leddrv.c board_demo.c 编译成 100ask.ko
  100ask_led-y := leddrv.o board_demo.o
  obj-m += 100ask_led.o