NotePublic/Software/OperatingSystem/Linux/USB/Linux_下的硬件驱动_USB设备_下_驱动开发部分.md

20 KiB
Raw Blame History

Linux 下的硬件驱动——USB设备驱动开发部分

赵明 2003 年 7 月 01 日发布

前言

在上篇《 Linux下的硬件驱动--USB设备驱动配制部分我们知道了在Linux下如何去使用一些最常见的USB设备。但对于做系统设计的程序员来说这是远远不够的我们还需要具有驱动程序的阅读、修改和开发能力。在此下篇中就是要通过简单的USB驱动的例子随您一起进入USB驱动开发的世界。

USB驱动开发

在掌握了USB设备的配置后对于程序员我们就可以尝试进行一些简单的USB驱动的修改和开发了。这一段落我们会讲解一个最基础USB框架的基础上做两个小的USB驱动的例子。

USB骨架

在Linux kernel源码目录中driver/usb/usb-skeleton.c为我们提供了一个最基础的USB驱动程序。我们称为USB骨架。通过它我们仅需要修改极少的部分就可以完成一个USB设备的驱动。我们的USB驱动开发也是从她开始的。

那些linux下不支持的USB设备几乎都是生产厂商特定的产品。如果生产厂商在他们的产品中使用自己定义的协议他们就需要为此设备创建特定的驱动程序。当然我们知道有些生产厂商公开他们的USB协议并帮助Linux驱动程序的开发然而有些生产厂商却根本不公开他们的USB协议。因为每一个不同的协议都会产生一个新的驱动程序所以就有了这个通用的USB驱动骨架程序 它是以pci 骨架为模板的。

如果你准备写一个linux驱动程序首先要熟悉USB协议规范。USB主页上有它的帮助。一些比较典型的驱动可以在上面发现同时还介绍了USB urbs的概念而这个是usb驱动程序中最基本的。

Linux USB 驱动程序需要做的第一件事情就是在Linux USB 子系统里注册并提供一些相关信息例如这个驱动程序支持那种设备当被支持的设备从系统插入或拔出时会有哪些动作。所有这些信息都传送到USB 子系统中在usb骨架驱动程序中是这样来表示的

static struct usb_driver skel_driver = {
     name:        "skeleton",
     probe:       skel_probe,
     disconnect:  skel_disconnect,
     fops:        &skel_fops,
     minor:       USB_SKEL_MINOR_BASE,
     id_table:    skel_table,
};

变量name是一个字符串它对驱动程序进行描述。probe 和disconnect 是函数指针当设备与在id_table 中变量信息匹配时,此函数被调用。

fops和minor变量是可选的。大多usb驱动程序钩住另外一个驱动系统例如SCSI网络或者tty子系统。这些驱动程序在其他驱动系统中注册同时任何用户空间的交互操作通过那些接口提供比如我们把SCSI设备驱动作为我们USB驱动所钩住的另外一个驱动系统那么我们此USB设备的read、write等操作就相应按SCSI设备的read、write函数进行访问。但是对于扫描仪等驱动程序来说并没有一个匹配的驱动系统可以使用那我们就要自己处理与用户空间的read、write等交互函数。Usb子系统提供一种方法去注册一个次设备号和file_operations函数指针这样就可以与用户空间实现方便地交互。

USB骨架程序的关键几点如下

  1. USB驱动的注册和注销

    Usb驱动程序在注册时会发送一个命令给usb_register通常在驱动程序的初始化函数里。

    当要从系统卸载驱动程序时需要注销usb子系统。即需要usb_unregister 函数处理:

    static void __exit usb_skel_exit(void)
    {
        /* deregister this driver with the USB subsystem */
        usb_deregister(&skel_driver);
    }
    module_exit(usb_skel_exit);
    

    当usb设备插入时为了使linux-hotplugLinux中PCI、USB等设备热插拔支持系统自动装载驱动程序你需要创建一个MODULE_DEVICE_TABLE。代码如下这个模块仅支持某一特定设备

    /* table of devices that work with this driver */
    static struct usb_device_id skel_table [] = {
        { USB_DEVICE(USB_SKEL_VENDOR_ID,
        USB_SKEL_PRODUCT_ID) },
        { }                      /* Terminating entry */
    };
    MODULE_DEVICE_TABLE (usb, skel_table);
    

    USB_DEVICE宏利用厂商ID和产品ID为我们提供了一个设备的唯一标识。当系统插入一个ID匹配的USB设备到USB总线时驱动会在USB core中注册。驱动程序中probe 函数也就会被调用。usb_device 结构指针、接口号和接口ID都会被传递到函数中。

    static void * skel_probe(struct usb_device *dev,
    unsigned int ifnum, const struct usb_device_id *id)
    

    驱动程序需要确认插入的设备是否可以被接受如果不接受或者在初始化的过程中发生任何错误probe函数返回一个NULL值。否则返回一个含有设备驱动程序状态的指针。通过这个指针就可以访问所有结构中的回调函数。

    在骨架驱动程序里最后一点是我们要注册devfs。我们创建一个缓冲用来保存那些被发送给usb设备的数据和那些从设备上接受的数据同时USB urb 被初始化并且我们在devfs子系统中注册设备允许devfs用户访问我们的设备。注册过程如下

    /* initialize the devfs node for this device
    and register it */
    sprintf(name, "skel%d", skel->minor);
    skel->devfs = devfs_register
            (usb_devfs_handle, name,
            DEVFS_FL_DEFAULT, USB_MAJOR,
            USB_SKEL_MINOR_BASE + skel->minor,
            S_IFCHR | S_IRUSR | S_IWUSR |
            S_IRGRP | S_IWGRP | S_IROTH,
            &skel_fops, NULL);
    

    如果devfs_register函数失败不用担心devfs子系统会将此情况报告给用户。

    当然最后如果设备从usb总线拔掉设备指针会调用disconnect 函数。驱动程序就需要清除那些被分配了的所有私有数据、关闭urbs并且从devfs上注销调自己。

    /* remove our devfs node */
    devfs_unregister(skel->devfs);
    

    现在skeleton驱动就已经和设备绑定上了任何用户态程序要操作此设备都可以通过file_operations结构所定义的函数进行了。首先我们要open此设备。在open函数中MODULE_INC_USE_COUNT 宏是一个关键它的作用是起到一个计数的作用有一个用户态程序打开一个设备计数器就加一例如我们以模块方式加入一个驱动若计数器不为零就说明仍然有用户程序在使用此驱动这时候你就不能通过rmmod命令卸载驱动模块了。

    /* increment our usage count for the module */
    MOD_INC_USE_COUNT;
    ++skel->open_count;
    /* save our object in the file's private structure */
    file->private_data = skel;
    

    当open完设备后read、write函数就可以收、发数据了。

  2. skel的write、和read函数

    他们是完成驱动对读写等操作的响应。

    在skel_write中一个FILL_BULK_URB函数就完成了urb 系统callbak和我们自己的skel_write_bulk_callback之间的联系。注意skel_write_bulk_callback是中断方式所以要注意时间不能太久本程序中它就只是报告一些urb的状态等。

    read 函数与write 函数稍有不同在于程序并没有用urb 将数据从设备传送到驱动程序而是我们用usb_bulk_msg 函数代替这个函数能够不需要创建urbs 和操作urb函数的情况下来发送数据给设备或者从设备来接收数据。我们调用usb_bulk_msg函数并传提一个存储空间用来缓冲和放置驱动收到的数据若没有收到数据就失败并返回一个错误信息。

  3. usb_bulk_msg函数

    当对usb设备进行一次读或者写时usb_bulk_msg 函数是非常有用的; 然而, 当你需要连续地对设备进行读/写时建议你建立一个自己的urbs同时将urbs 提交给usb子系统。

  4. skel_disconnect函数

    当我们释放设备文件句柄时这个函数会被调用。MOD_DEC_USE_COUNT宏会被用到和MOD_INC_USE_COUNT刚好对应它减少一个计数器首先确认当前是否有其它的程序正在访问这个设备如果是最后一个用户在使用我们可以关闭任何正在发生的写操作如下

    /* decrement our usage count for the device */
    --skel->open_count;
    if (skel->open_count <= 0) {
    /* shutdown any bulk writes that might be
        going on */
    usb_unlink_urb (skel->write_urb);
    skel->open_count = 0;
    }
    /* decrement our usage count for the module */
    MOD_DEC_USE_COUNT;
    

    最困难的是usb 设备可以在任何时间点从系统中取走即使程序目前正在访问它。usb驱动程序必须要能够很好地处理解决此问题它需要能够切断任何当前的读写同时通知用户空间程序usb设备已经被取走。

    如果程序有一个打开的设备句柄在当前结构里我们只要把它赋值为空就像它已经消失了。对于每一次设备读写等其它函数操作我们都要检查usb_device结构是否存在。如果不存在就表明设备已经消失并返回一个-ENODEV错误给用户程序。当最终我们调用release 函数时在没有文件打开这个设备时无论usb_device结构是否存在、它都会清空skel_disconnect函数所作工作。

    Usb 骨架驱动程序提供足够的例子来帮助初始人员在最短的时间里开发一个驱动程序。更多信息你可以到linux usb开发新闻组去寻找。

U盘、USB读卡器、MP3、数码相机驱动

对于一款windows下用的很爽的U盘、USB读卡器、MP3或数码相机可能Linux下却不能支持。怎么办其实不用伤心也许经过一点点的工作你就可以很方便地使用它了。通常是此U盘、USB读卡器、MP3或数码相机在WindowsXP中不需要厂商专门的驱动就可以识别为移动存储设备这样的设备才能保证成功其他的就看你的运气了。

USB存储设备他们的read、write等操作都是通过上章节中提到的钩子把自己的操作钩到SCSI设备上去的。我们就不需要对其进行具体的数据读写处理了。

第一步我们通过cat /proc/bus/usb/devices得到当前系统探测到的USB总线上的设备信息。它包括Vendor、ProdID、Product等。下面是我买的一款杂牌CF卡读卡器插入后的信息片断

T: Bus=01 Lev=01 Prnt=01 Port=01 Cnt=02 Dev#= 5 Spd=12 MxCh= 0
D: Ver= 1.10 Cls=00(>ifc ) Sub=00 Prot=00 MxPS=8 #Cfgs= 1
P: Vendor=07c4 ProdID=a400 Rev= 1.13
S: Manufacturer=USB
S: Product=Mass Storage
C:* #Ifs= 1 Cfg#= 1 Atr=80 MxPwr=70mA
I: If#= 0 Alt= 0 #EPs= 2 Cls=08(vend.) Sub=06 Prot=50 Driver=usb-storage
E: Ad=81(I) Atr=02(Bulk) MxPS= 64 Ivl= 0ms
E: Ad=02(O) Atr=02(Bulk) MxPS= 64 Ivl= 0ms

其中我们最关心的是Vendor=07c4 ProdID=a400和Manufacturer=USB果然是杂牌厂商名都看不到Product= Mass Storage。

对于这些移动存储设备我们知道Linux下都是通过usb-storage.o驱动模拟成scsi设备去支持的之所以不支持通常是usb-storage驱动未包括此厂商识别和产品识别信息在类似skel_probe的USB最初探测时被屏蔽了。对于USB存储设备的硬件访问部分通常是一致的。所以我们要支持它仅需要修改usb-storage中关于厂商识别和产品识别列表部分。

第二部打开drivers/usb/storage/unusual_devs.h文件我们可以看到所有已知的产品登记表都是以UNUSUAL_DEVidVendor, idProduct, bcdDeviceMin, bcdDeviceMax, vendor_name, product_name, use_protocol, use_transport, init_function, Flags方式登记的。其中相应的涵义你就可以根据命名来判断了。所以只要我们如下填入我们自己的注册就可以让usb-storage驱动去认识和发现它。

UNUSUAL_DEV(07c4, a400, 0x0000, 0xffff,
" USB ", " Mass Storage ",
US_SC_SCSI, US_PR_BULK, NULL,
US_FL_FIX_INQUIRY | US_FL_START_STOP |US_FL_MODE_XLATE )

注意添加以上几句的位置一定要正确。比较发现usb-storage驱动对所有注册都是按idVendor, idProduct数值从小到大排列的。我们也要放在相应位置。

最后填入以上信息我们就可以重新编译生成内核或usb-storage.o模块。这时候插入我们的设备就可以跟其他U盘一样作为SCSI设备去访问了。

键盘飞梭支持

目前很多键盘都有飞梭和手写板下面我们就尝试为一款键盘飞梭加入一个驱动。在通常情况当我们插入USB接口键盘时在/proc/bus/usb/devices会看到多个USB设备。比如你的USB键盘上的飞梭会是一个你的手写板会是一个若是你的USB键盘有USB扩展连接埠也会看到。

下面是具体看到的信息

T:  Bus=02 Lev=00 Prnt=00 Port=00 Cnt=00 Dev#=  1 Spd=12  MxCh= 2
B:  Alloc= 11/900 us ( 1%), #Int=  1, #Iso=  0
D:  Ver= 1.00 Cls=09(hub  ) Sub=00 Prot=00 MxPS= 8 #Cfgs=  1
P:  Vendor=0000 ProdID=0000 Rev= 0.00
S:  Product=USB UHCI Root Hub
S:  SerialNumber=d800
C:* #Ifs= 1 Cfg#= 1 Atr=40 MxPwr=  0mA
I:  If#= 0 Alt= 0 #EPs= 1 Cls=09(hub  ) Sub=00 Prot=00 Driver=hub
E:  Ad=81(I) Atr=03(Int.) MxPS=   8 Ivl=255ms
T:  Bus=02 Lev=01 Prnt=01 Port=01 Cnt=01 Dev#=  3 Spd=12  MxCh= 3
D:  Ver= 1.10 Cls=09(hub  ) Sub=00 Prot=00 MxPS= 8 #Cfgs=  1
P:  Vendor=07e4 ProdID=9473 Rev= 0.02
S:  Manufacturer=ALCOR
S:  Product=Movado USB Keyboard
C:* #Ifs= 1 Cfg#= 1 Atr=e0 MxPwr=100mA
I:  If#= 0 Alt= 0 #EPs= 1 Cls=09(hub  ) Sub=00 Prot=00 Driver=hub
E:  Ad=81(I) Atr=03(Int.) MxPS=   1 Ivl=255ms

找到相应的信息后就可开始工作了。实际上飞梭的定义和键盘键码通常是一样的所以我们参照drivers/usb/usbkbd..c代码进行一些改动就可以了。因为没能拿到相应的硬件USB协议我无从知道飞梭在按下时通讯协议众到底发什么我只能把它的信息打出来进行分析。幸好它比较简单在下面代码的usb_kbd_irq函数中if(kbd->new[0] == (char)0x01)和if(((kbd->new[1]>>4)&0x0f)!=0x7)就是判断飞梭左旋。usb_kbd_irq函数就是键盘中断响应函数。他的挂接就是在usb_kbd_probe函数中

FILL_INT_URB(&kbd->irq, dev, pipe, kbd->new, maxp > 8 ? 8 : maxp,
        usb_kbd_irq, kbd, endpoint->bInterval);

一句中实现。

从usb骨架中我们知道usb_kbd_probe函数就是在USB设备被系统发现是运行的。其他部分就都不是关键了。你可以根据具体的探测值Vendor=07e4 ProdID=9473等进行一些修改就可以了。值得一提的是在键盘中断中我们的做法是收到USB飞梭消息后把它模拟成左方向键和右方向键在这里就看你想怎么去响应它了。当然你也可以响应模拟成F14、F15等扩展键码。

在了解了此基本的驱动后,对于一个你已经拿到通讯协议的键盘所带手写板,你就应该能进行相应驱动的开发了吧。

程序见附录1 键盘飞梭驱动。

使用此驱动要注意的问题在加载此驱动时你必须先把hid设备卸载加载完usbhkey.o模块后再加载hid.o。因为若hid存在它的probe会屏蔽系统去利用我们的驱动发现我们的设备。其实飞梭本来就是一个hid设备正确的方法或许你应该修改hid的probe函数然后把我们的驱动融入其中。

参考资料

  1. 《LINUX设备驱动程序》 ALESSANDRO RUBINI著 LISOLEG 译
  2. 《Linux系统分析与高级编程技术》 周巍松 编著
  3. Linux Kernel-2.4.20 源码和文档说明

附录1键盘飞梭驱动

#include <linux/kernel.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/input.h>
#include <linux/init.h>
#include <linux/usb.h>
#include <linux/kbd_ll.h>
/*
 * Version Information
 */
#define DRIVER_VERSION ""
#define DRIVER_AUTHOR "TGE HOTKEY "
#define DRIVER_DESC "USB HID Tge hotkey driver"
#define USB_HOTKEY_VENDOR_ID 0x07e4
#define USB_HOTKEY_PRODUCT_ID 0x9473
//厂商和产品ID信息就是/proc/bus/usb/devices中看到的值
MODULE_AUTHOR( DRIVER_AUTHOR );
MODULE_DESCRIPTION( DRIVER_DESC );
struct usb_kbd {
  struct input_dev dev;
  struct usb_device *usbdev;
  unsigned char new[8];
  unsigned char old[8];
  struct urb irq, led;
//  devrequest dr;
//这一行和下一行的区别在于kernel2.4.20版本对usb_kbd键盘结构定义发生了变化
      struct usb_ctrlrequest dr;
  unsigned char leds, newleds;
  char name[128];
  int open;
};
//此结构来自内核中drivers/usb/usbkbd..c
static void usb_kbd_irq(struct urb *urb)
{
  struct usb_kbd *kbd = urb->context;
        int *new;
        new = (int *) kbd->new;
  if(kbd->new[0] == (char)0x01)
  {
    if(((kbd->new[1]>>4)&0x0f)!=0x7)
    {
handle_scancode(0xe0,1);
handle_scancode(0x4b,1);
                handle_scancode(0xe0,0);
                handle_scancode(0x4b,0);
    }
    else
    {
        handle_scancode(0xe0,1);
                handle_scancode(0x4d,1);
                handle_scancode(0xe0,0);
                handle_scancode(0x4d,0);
    }
  }


  printk("new=%x %x %x %x %x %x %x %x",
    kbd->new[0],kbd->new[1],kbd->new[2],kbd->new[3],
    kbd->new[4],kbd->new[5],kbd->new[6],kbd->new[7]);

}
static void *usb_kbd_probe(struct usb_device *dev, unsigned int ifnum,
                           const struct usb_device_id *id)
{
  struct usb_interface *iface;
        struct usb_interface_descriptor *interface;
  struct usb_endpoint_descriptor *endpoint;
        struct usb_kbd *kbd;
        int  pipe, maxp;
  iface = &dev->actconfig->interface[ifnum];
        interface = &iface->altsetting[iface->act_altsetting];
  if ((dev->descriptor.idVendor != USB_HOTKEY_VENDOR_ID) ||
    (dev->descriptor.idProduct != USB_HOTKEY_PRODUCT_ID) ||
    (ifnum != 1))
  {
    return NULL;
  }
  if (dev->actconfig->bNumInterfaces != 2)
  {
    return NULL;  
  }
  if (interface->bNumEndpoints != 1) return NULL;
        endpoint = interface->endpoint + 0;
        pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
        maxp = usb_maxpacket(dev, pipe, usb_pipeout(pipe));
        usb_set_protocol(dev, interface->bInterfaceNumber, 0);
        usb_set_idle(dev, interface->bInterfaceNumber, 0, 0);
  printk(KERN_INFO "GUO: Vid = %.4x, Pid = %.4x, Device = %.2x,
                     ifnum = %.2x, bufCount = %.8x\\n",
  dev->descriptor.idVendor,dev->descriptor.idProduct,
                dev->descriptor.bcdDevice, ifnum, maxp);
        if (!(kbd = kmalloc(sizeof(struct usb_kbd), GFP_KERNEL))) return NULL;
        memset(kbd, 0, sizeof(struct usb_kbd));
        kbd->usbdev = dev;
        FILL_INT_URB(&kbd->irq, dev, pipe, kbd->new, maxp > 8 ? 8 : maxp,
    usb_kbd_irq, kbd, endpoint->bInterval);
  kbd->irq.dev = kbd->usbdev;
  if (dev->descriptor.iManufacturer)
                usb_string(dev, dev->descriptor.iManufacturer, kbd->name, 63);
  if (usb_submit_urb(&kbd->irq)) {
                kfree(kbd);
                return NULL;
        }

  printk(KERN_INFO "input%d: %s on usb%d:%d.%d\\n",
                 kbd->dev.number, kbd->name, dev->bus->busnum,
                             dev->devnum, ifnum);
        return kbd;
}
static void usb_kbd_disconnect(struct usb_device *dev, void *ptr)
{
  struct usb_kbd *kbd = ptr;
        usb_unlink_urb(&kbd->irq);
        kfree(kbd);
}
static struct usb_device_id usb_kbd_id_table [] = {
  { USB_DEVICE(USB_HOTKEY_VENDOR_ID, USB_HOTKEY_PRODUCT_ID) },
  { }            /* Terminating entry */
};
MODULE_DEVICE_TABLE (usb, usb_kbd_id_table);
static struct usb_driver usb_kbd_driver = {
  name:    "Hotkey",
  probe:    usb_kbd_probe,
  disconnect:  usb_kbd_disconnect,
  id_table:  usb_kbd_id_table,
  NULL,
};
static int __init usb_kbd_init(void)
{
  usb_register(&usb_kbd_driver);
  info(DRIVER_VERSION ":" DRIVER_DESC);
  return 0;
}
static void __exit usb_kbd_exit(void)
{
  usb_deregister(&usb_kbd_driver);
}
module_init(usb_kbd_init);
module_exit(usb_kbd_exit);