Linux下PCI设备驱动程序开发 --- PCI驱动程序实现（三）

三、 PCI驱动程序实现

1. 关键数据结构

PCI 设备上有三种地址空间： PCI 的 I/O 空间、 PCI 的存储空间和 PCI 的配置空间。 CPU 可以访问 PCI 设备上的所有地址空间，其中 I/O 空间和存储空间提供给设备驱动程序使用，而配置空间则由 Linux 内核中的 PCI 初始化代码使用。内核在启动时负责对所有 PCI 设备进行初始化，配置好所有的 PCI 设备，包括中断号以及 I/O 基址，并在文件 /proc/pci 中列出所有找到的 PCI 设备，以及这些设备的参数和属性。

Linux 驱动程序通常使用结构（ struct ）来表示一种设备，而结构体中的变量则代表某一具体设备，该变量存放了与该设备相关的所有信息。好的驱动程序都应该能驱动多个同种设备，每个设备之间用次设备号进行区分，如果采用结构数据来代表所有能由该驱动程序驱动的设备，那么就可以简单地使用数组下标来表示次设备号。

在 PCI 驱动程序中，下面几个关键数据结构起着非常核心的作用：

• pci_driver

这个数据结构在文件 include/linux/pci.h 里，这是 Linux 内核版本 2.4 之后为新型的 PCI 设备驱动程序所添加的，其中最主要的是用于识别设备的 id_table 结构，以及用于检测设备的函数 probe( ) 和卸载设备的函数 remove( ) ：

struct pci_driver {    struct list_head node;     char *name;     const struct pci_device_id *id_table;     int (*probe) (struct pci_dev *dev, const struct pci_device_id *id);     void (*remove) (struct pci_dev *dev);     int (*save_state) (struct pci_dev *dev, u32 state);     int (*suspend)(struct pci_dev *dev, u32 state);     int (*resume) (struct pci_dev *dev);     int (*enable_wake) (struct pci_dev *dev, u32 state, int enable); };

 

• pci_dev

这个数据结构也在文件 include/linux/pci.h 里，它详细描述了一个 PCI 设备几乎所有的硬件信息，包括厂商 ID 、设备 ID 、各种资源等：

struct pci_dev {     struct list_head global_list;     struct list_head bus_list;     struct pci_bus *bus;     struct pci_bus *subordinate;       void        *sysdata;     struct proc_dir_entry *procent;       unsigned int    devfn;     unsigned short vendor;     unsigned short device;     unsigned short subsystem_vendor;     unsigned short subsystem_device;     unsigned int    class;     u8      hdr_type;     u8      rom_base_reg;       struct pci_driver *driver;     void        *driver_data;     u64     dma_mask;     u32             current_state;       unsigned short vendor_compatible[DEVICE_COUNT_COMPATIBLE];     unsigned short device_compatible[DEVICE_COUNT_COMPATIBLE];       unsigned int    irq;     struct resource resource[DEVICE_COUNT_RESOURCE];     struct resource dma_resource[DEVICE_COUNT_DMA];     struct resource irq_resource[DEVICE_COUNT_IRQ];       char        name[80];     char        slot_name[8];     int     active;     int     ro;     unsigned short regs;       int (*prepare)(struct pci_dev *dev);     int (*activate)(struct pci_dev *dev);     int (*deactivate)(struct pci_dev *dev); };

2. 基本框架

在用模块方式实现 PCI 设备驱动程序时，通常至少要实现以下几个部分：初始化设备模块、设备打开模块、数据读写和控制模块、中断处理模块、设备释放模块、设备卸载模块。下面给出一个典型的 PCI 设备驱动程序的基本框架，从中不难体会到这几个关键模块是如何组织起来的。

/* 指明该驱动程序适用于哪一些 PCI 设备 */ static struct pci_device_id demo_pci_tbl [] __initdata = {     {PCI_VENDOR_ID_DEMO, PCI_DEVICE_ID_DEMO,      PCI_ANY_ID, PCI_ANY_ID, 0, 0, DEMO},     {0,} };   /* 对特定 PCI 设备进行描述的数据结构 */ struct demo_card {     unsigned int magic;       /* 使用链表保存所有同类的 PCI 设备 */     struct demo_card *next;         /* ... */ }   /* 中断处理模块 */ static void demo_interrupt(int irq, void *dev_id, struct pt_regs *regs) {     /* ... */ }   /* 设备文件操作接口 */ static struct file_operations demo_fops = {     owner:      THIS_MODULE,   /* demo_fops 所属的设备模块 */     read:       demo_read,    /* 读设备操作 */     write:      demo_write,    /* 写设备操作 */     ioctl:      demo_ioctl,    /* 控制设备操作 */     mmap:       demo_mmap,    /* 内存重映射操作 */     open:       demo_open,    /* 打开设备操作 */     release:    demo_release    /* 释放设备操作 */     /* ... */ };   /* 设备模块信息 */ static struct pci_driver demo_pci_driver = {     name:       demo_MODULE_NAME,    /* 设备模块名称 */     id_table:   demo_pci_tbl,    /* 能够驱动的设备列表 */     probe:      demo_probe,    /* 查找并初始化设备 */     remove:     demo_remove    /* 卸载设备模块 */     /* ... */ };   static int __init demo_init_module (void) {     /* ... */ }   static void __exit demo_cleanup_module (void) {     pci_unregister_driver(&demo_pci_driver); }   /* 加载驱动程序模块入口 */ module_init(demo_init_module);   /* 卸载驱动程序模块入口 */ module_exit(demo_cleanup_module);

 

上面这段代码给出了一个典型的 PCI 设备驱动程序的框架，是一种相对固定的模式。需要注意的是，同加载和卸载模块相关的函数或数据结构都要在前面加上 __init 、 __exit 等标志符，以使同普通函数区分开来。构造出这样一个框架之后，接下去的工作就是如何完成框架内的各个功能模块了。

3. 初始化设备模块

在 Linux 系统下，想要完成对一个 PCI 设备的初始化，需要完成以下工作：

• 检查PCI总线是否被Linux内核支持；
• 检查设备是否插在总线插槽上，如果在的话则保存它所占用的插槽的位置等信息。
• 读出配置头中的信息提供给驱动程序使用。

当 Linux 内核启动并完成对所有 PCI 设备进行扫描、登录和分配资源等初始化操作的同时，会建立起系统中所有 PCI 设备的拓扑结构，此后当 PCI 驱动程序需要对设备进行初始化时，一般都会调用如下的代码：

static int __init demo_init_module (void) {     /* 检查系统是否支持 PCI 总线 */     if (!pci_present())         return -ENODEV;       /* 注册硬件驱动程序 */     if (!pci_register_driver(&demo_pci_driver)) {         pci_unregister_driver(&demo_pci_driver);                 return -ENODEV;     }       /* ... */        return 0; }

 

驱动程序首先调用函数 pci_present( ) 检查 PCI 总线是否已经被 Linux 内核支持，如果系统支持 PCI 总线结构，这个函数的返回值为 0 ，如果驱动程序在调用这个函数时得到了一个非 0 的返回值，那么驱动程序就必须得中止自己的任务了。在 2.4 以前的内核中，需要手工调用 pci_find_device( ) 函数来查找 PCI 设备，但在 2.4 以后更好的办法是调用 pci_register_driver( ) 函数来注册 PCI 设备的驱动程序，此时需要提供一个 pci_driver 结构，在该结构中给出的 probe 探测例程将负责完成对硬件的检测工作。

static int __init demo_probe(struct pci_dev *pci_dev, const struct pci_device_id *pci_id) {     struct demo_card *card;       /* 启动 PCI 设备 */     if (pci_enable_device(pci_dev))         return -EIO;       /* 设备 DMA 标识 */     if (pci_set_dma_mask(pci_dev, DEMO_DMA_MASK)) {         return -ENODEV;     }       /* 在内核空间中动态申请内存 */     if ((card = kmalloc(sizeof(struct demo_card), GFP_KERNEL)) == NULL) {         printk(KERN_ERR "pci_demo: out of memory/n");         return -ENOMEM;     }     memset(card, 0, sizeof(*card));       /* 读取 PCI 配置信息 */     card->iobase = pci_resource_start (pci_dev, 1);     card->pci_dev = pci_dev;     card->pci_id = pci_id->device;     card->irq = pci_dev->irq;     card->next = devs;     card->magic = DEMO_CARD_MAGIC;       /* 设置成总线主 DMA 模式 */        pci_set_master(pci_dev);       /* 申请 I/O 资源 */     request_region(card->iobase, 64, card_names[pci_id->driver_data]);       return 0; }

 

4. 打开设备模块

在这个模块里主要实现申请中断、检查读写模式以及申请对设备的控制权等。在申请控制权的时候，非阻塞方式遇忙返回，否则进程主动接受调度，进入睡眠状态，等待其它进程释放对设备的控制权。

static int demo_open(struct inode *inode, struct file *file) {     /* 申请中断，注册中断处理程序 */     request_irq(card->irq, &demo_interrupt, SA_SHIRQ,         card_names[pci_id->driver_data], card)) {       /* 检查读写模式 */     if(file->f_mode & FMODE_READ) {         /* ... */     }     if(file->f_mode & FMODE_WRITE) {        /* ... */     }         /* 申请对设备的控制权 */     down(&card->open_sem);     while(card->open_mode & file->f_mode) {         if (file->f_flags & O_NONBLOCK) {             /* NONBLOCK 模式，返回 -EBUSY */             up(&card->open_sem);             return -EBUSY;         } else {             /* 等待调度，获得控制权 */             card->open_mode |= f_mode & (FMODE_READ | FMODE_WRITE);             up(&card->open_sem);               /* 设备打开计数增 1 */             MOD_INC_USE_COUNT;               /* ... */         }     } }

 

5. 数据读写和控制信息模块

PCI 设备驱动程序可以通过 demo_fops 结构中的函数 demo_ioctl( ) ，向应用程序提供对硬件进行控制的接口。例如，通过它可以从 I/O 寄存器里读取一个数据，并传送到用户空间里：

static int demo_ioctl(struct inode *inode, struct file *file, unsigned int cmd, unsigned long arg) {     /* ... */         switch(cmd) {         case DEMO_RDATA:             /* 从 I/O 端口读取 4 字节的数据 */             val = inl(card->iobae + 0x10);              /* 将读取的数据传输到用户空间 */             return 0;     }         /* ... */ }

 

事实上，在 demo_fops 里还可以实现诸如 demo_read( ) 、 demo_mmap( ) 等操作， Linux 内核源码中的 driver 目录里提供了许多设备驱动程序的源代码，找那里可以找到类似的例子。在对资源的访问方式上，除了有 I/O 指令以外，还有对外设 I/O 内存的访问。对这些内存的操作一方面可以通过把 I/O 内存重新映射后作为普通内存进行操作，另一方面也可以通过总线主 DMA （ Bus Master DMA ）的方式让设备把数据通过 DMA 传送到系统内存中。

6. 中断处理模块

PC 的中断资源比较有限，只有 0~15 的中断号，因此大部分外部设备都是以共享的形式申请中断号的。当中断发生的时候，中断处理程序首先负责对中断进行识别，然后再做进一步的处理。

static void demo_interrupt(int irq, void *dev_id, struct pt_regs *regs) {     struct demo_card *card = (struct demo_card *)dev_id;     u32 status;       spin_lock(&card->lock);       /* 识别中断 */     status = inl(card->iobase + GLOB_STA);     if(!(status & INT_MASK))     {         spin_unlock(&card->lock);         return; /* not for us */     }       /* 告诉设备已经收到中断 */     outl(status & INT_MASK, card->iobase + GLOB_STA);     spin_unlock(&card->lock);         /* 其它进一步的处理，如更新 DMA 缓冲区指针等 */ }

7. 释放设备模块

释放设备模块主要负责释放对设备的控制权，释放占用的内存和中断等，所做的事情正好与打开设备模块相反：

static int demo_release(struct inode *inode, struct file *file) {     /* ... */         /* 释放对设备的控制权 */     card->open_mode &= (FMODE_READ | FMODE_WRITE);         /* 唤醒其它等待获取控制权的进程 */     wake_up(&card->open_wait);     up(&card->open_sem);         /* 释放中断 */     free_irq(card->irq, card);         /* 设备打开计数增 1 */     MOD_DEC_USE_COUNT;         /* ... */  }

8. 卸载设备模块

卸载设备模块与初始化设备模块是相对应的，实现起来相对比较简单，主要是调用函数 pci_unregister_driver( ) 从 Linux 内核中注销设备驱动程序：

static void __exit demo_cleanup_module (void) {     pci_unregister_driver(&demo_pci_driver); }

 

四、小结

PCI 总线不仅是目前应用广泛的计算机总线标准，而且是一种兼容性最强、功能最全的计算机总线。而 Linux 作为一种新的操作系统，其发展前景是无法估量的，同时也为 PCI 总线与各种新型设备互连成为可能。由于 Linux 源码开放，因此给连接到 PCI 总线上的任何设备编写驱动程序变得相对容易。本文介绍如何编译 Linux 下的 PCI 驱动程序，针对的内核版本是 2.4 。

上一篇：《Linux下PCI设备驱动程序开发 --- linux 驱动框架（二）》
下一篇：《一个动态内存管理模块的实现》