Linux下USB驱动之skeleton分析

From http://www.linuxidc.com/Linux/2008-10/16887.htm
Usb_skeleton.c，是USB驱动的框架，适合USB驱动的初学者。

1．结构体

内核其实就是一坨坨的数据结构，加上一根根链表。

对于初学者，如果直接看USB驱动代码，大概会被那些名字相近的结构体弄得晕头转向，比如usb_host_interface和usb_interface，看着看着就把两个混淆了。所以，在学习USB驱动之前，建议把相关结构体都拎出来看一下，其实，也就那么几个结构体在那装神弄鬼。USB skeleton驱动中用到的主要字段已用蓝色标出：

endpoint：

struct usb_host_endpoint { struct usb_endpoint_descriptor desc; struct list_head urb_list; void *hcpriv; unsigned char *extra; int extralen; };

struct usb_endpoint_descriptor { __u8 bLength; __u8 bDescriptorType; __u8 bEndpointAddress; __u8 bmAttributes; __le16 wMaxPacketSize; __u8 bInterval; __u8 bRefresh; __u8 bSynchAddress; } __attribute__ ((packed));

bEndpointAddress，最高位用来判断传输方向：

#define USB_ENDPOINT_NUMBER_MASK 0x0f #define USB_ENDPOINT_DIR_MASK 0x80 #define USB_DIR_OUT 0 #define USB_DIR_IN 0x80

bmAttributes，表示endpoint的类型：

#define USB_ENDPOINT_XFERTYPE_MASK 0x03 #define USB_ENDPOINT_XFER_CONTROL 0 #define USB_ENDPOINT_XFER_ISOC 1 #define USB_ENDPOINT_XFER_BULK 2 #define USB_ENDPOINT_XFER_INT 3

bInterval，如果该endpoint是interrupt类型的（USB鼠标驱动就是该类型），那么bInterval就表示中断时间间隔，单位毫秒。

interface：

struct usb_interface { struct usb_host_interface *altsetting; struct usb_host_interface *cur_altsetting; unsigned num_altsetting; int minor; enum usb_interface_condition condition; struct device dev; struct class_device *class_dev; };

struct usb_host_interface { struct usb_interface_descriptor desc; struct usb_host_endpoint *endpoint; char *string; unsigned char *extra; int extralen; };

struct usb_interface_descriptor { __u8 bLength; __u8 bDescriptorType; __u8 bInterfaceNumber; __u8 bAlternateSetting; __u8 bNumEndpoints; __u8 bInterfaceClass; __u8 bInterfaceSubClass; __u8 bInterfaceProtocol; __u8 iInterface; } __attribute__ ((packed));

usb_device：

struct usb_device { int devnum; char devpath [16]; enum usb_device_state state; enum usb_device_speed speed; struct usb_tt *tt; int ttport; struct semaphore serialize; unsigned int toggle[2]; struct usb_device *parent; struct usb_bus *bus; struct usb_host_endpoint ep0; struct device dev; struct usb_device_descriptor descriptor; struct usb_host_config *config; struct usb_host_config *actconfig; struct usb_host_endpoint *ep_in[16]; struct usb_host_endpoint *ep_out[16]; char **rawdescriptors; int have_langid; int string_langid; char *product; char *manufacturer; char *serial; struct list_head filelist; struct dentry *usbfs_dentry; int maxchild; struct usb_device *children[USB_MAXCHILDREN]; };

usb_driver：

struct usb_driver { struct module *owner; const char *name; int (*probe) (struct usb_interface *intf, const struct usb_device_id *id); void (*disconnect) (struct usb_interface *intf); int (*ioctl) (struct usb_interface *intf, unsigned int code, void *buf); int (*suspend) (struct usb_interface *intf, pm_message_t message); int (*resume) (struct usb_interface *intf); const struct usb_device_id *id_table; struct device_driver driver; };

2．Init

先来看模块初始化函数，它仅仅完成一个功能，那就是注册USB驱动：

static int __init usb_skel_init(void) { int result; result = usb_register(&skel_driver); if (result) err("usb_register failed. Error number %d", result); return result; }

其中，skel_driver如下：

static struct usb_driver skel_driver = { .owner = THIS_MODULE, .name = "skeleton", .probe = skel_probe, .disconnect = skel_disconnect, .id_table = skel_table, };

前面几个字段很好理解，这里就说下id_table。先看skel_table的定义：

static struct usb_device_id skel_table [] = { { USB_DEVICE(USB_SKEL_VENDOR_ID, USB_SKEL_PRODUCT_ID) }, { } };

id_table用来告诉内核该模块支持的所有设备。usb子系统通过设备的production ID和vendor ID的组合或者设备的class、subclass跟protocol的组合来识别设备，并调用相关的驱动程序作处理。不同设备的这些组合，当然是不一样的，这由USB协会统一管理、分配。

skeleton中，使用production ID和vendor ID的组合来识别设备。

注意，还要使用MODULE_DEVICE_TABLE把这个id_table注册到系统中去：

MODULE_DEVICE_TABLE (usb, skel_table);

3．Probe

probe是usb子系统自动调用的一个函数，有USB设备连接到主机时，usb子系统会根据production ID和vendor ID的组合或者设备的class、subclass跟protocol的组合（也就是根据id_table）来识别设备，并调用相应驱动程序的probe（探测）函数。

不同的USB驱动模块，会注册不同的id_table，比如现在有Usb_skeleton.c、Usb_driver1.c、Usb_driver2.c和Usb_driver3.c这么四个USB驱动模块，它们都会调用MODULE_DEVICE_TABLE (usb, xxx_table)。这样，系统中就有四个id_table。当一个USB设备连接到主机时，系统会从这四个id_table中，找到能够匹配该USB设备的id_table，并调用该id_table所属的USB驱动模块。

Probe代码很长，分段分析：

static int skel_probe(struct usb_interface *interface, const struct usb_device_id *id) { struct usb_skel *dev = NULL; struct usb_host_interface *iface_desc; struct usb_endpoint_descriptor *endpoint; size_t buffer_size; int i; int retval = -ENOMEM; dev = kmalloc(sizeof(*dev), GFP_KERNEL); if (dev == NULL) { err("Out of memory"); goto error; } memset(dev, 0x00, sizeof(*dev)); kref_init(&dev->kref); dev->udev = usb_get_dev(interface_to_usbdev(interface)); dev->interface = interface; …… error: if (dev) kref_put(&dev->kref, skel_delete); return retval;

先介绍几个函数：

usb_get_dev和usb_put_dev分别是递增/递减usb_device的reference count。

kref_init，初始化kref，并将其置设成1。

kref_get和kref_put分别递增/递减kref。

在初始化了一些资源之后，可以看到第一个关键的函数调用——interface_to_usbdev。他从一个usb_interface来得到该接口所在设备的usb_device。本来，要得到一个usb_device只要用interface_to_usbdev就够了，但因为要增加对该usb_device的引用计数，我们应该在做一个usb_get_dev的操作，来增加引用计数，并在释放设备时用usb_put_dev来减少引用计数。

这里要解释的是，usb_get_dev是对该usb_device的计数，并不是对本模块的计数，本模块的计数要由kref来维护。所以，probe一开始就有初始化kref，kref_init(&dev->kref)。事实上，kref_init操作不单只初始化kref，还将其置设成1。所以在出错处理代码中有kref_put，它把kref的计数减1，如果kref计数已经为0，那么kref会被释放。kref_put的第二个参数是一个函数指针，指向一个清理函数。注意，该指针不能为空，或者kfree。该函数会在最后一个对kref的引用释放时被调用。

iface_desc = interface->cur_altsetting; for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) { endpoint = &iface_desc->endpoint[i].desc; if (!dev->bulk_in_endpointAddr && ((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN) && ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_BULK)) { buffer_size = le16_to_cpu(endpoint->wMaxPacketSize); dev->bulk_in_size = buffer_size; dev->bulk_in_endpointAddr = endpoint->bEndpointAddress; dev->bulk_in_buffer = kmalloc(buffer_size, GFP_KERNEL); if (!dev->bulk_in_buffer) { err("Could not allocate bulk_in_buffer"); goto error; } } if (!dev->bulk_out_endpointAddr && ((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT) && ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_BULK)) { dev->bulk_out_endpointAddr = endpoint->bEndpointAddress; } } if (!(dev->bulk_in_endpointAddr && dev->bulk_out_endpointAddr)) { err("Could not find both bulk-in and bulk-out endpoints"); goto error; }

上面这段函数，主要是通过usb_endpoint_descriptor里的信息，初始化dev（usb_skel类型）中的字段。

这里列一下各个结构体之间的关系，帮助大家理一下层次：

usb_interface->usb_host_interface->usb_host_endpoint->usb_endpoint_descriptor

usb_set_intfdata(interface, dev); retval = usb_register_dev(interface, &skel_class); if (retval) { err("Not able to get a minor for this device."); usb_set_intfdata(interface, NULL); goto error; } info("USB Skeleton device now attached to USBSkel-%d", interface->minor); return 0;

usb_set_intfdata, 把刚才初始化得到的dev（usb_skel类型）保存在usb_interface中，以便其他函数使用。这样做是因为，dev是一个局部变量，其他函数没法获得，但其他函数（比如open）可以访问usb_interface，这样，也就可以访问usb_skel里的具体字段了。如open函数中，dev = usb_get_intfdata(interface)。

下面讲一下usb_register_dev相关的内容。

一个USB interface对应一种USB逻辑设备，比如鼠标、键盘、音频流。所以，在USB范畴中，device一般就是指一个interface。一个驱动只控制一个interface。这样，usb_register_dev自然是注册一个interface，所以usb_register_dev的第一个参数是interface（usb_interface类型）。

接着介绍下skel_class：

static struct usb_class_driver skel_class = { .name = "usb/skel%d", .fops = &skel_fops, .mode = S_IFCHR | S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH, .minor_base = USB_SKEL_MINOR_BASE, };

其中，skel_fops定义为：

static struct file_operations skel_fops = { .owner = THIS_MODULE, .read = skel_read, .write = skel_write, .open = skel_open, .release = skel_release, };

skel_fops是真正完成对设备IO操作的函数集。

usb_register_dev注册一次，获取一个次设备号。该次设备号从usb_class_driver -> minor_base开始分配。

usb_register_dev(interface, &skel_class)，也就是说，一个usb_interface对应一个次设备号。结合上面举的interface例子，可以知道，鼠标、键盘各自对应一个不同的次设备号。

4．Disconnect

当设备从主机拔出时，usb子系统会自动地调用disconnect，他做的事情不多，最重要的是注销class_driver（交还次设备号）和interface的data。然后用kref_put(&dev->kref, skel_delete)进行清

理。

static void skel_disconnect(struct usb_interface *interface) { struct usb_skel *dev; int minor = interface->minor; lock_kernel(); dev = usb_get_intfdata(interface); usb_set_intfdata(interface, NULL); usb_deregister_dev(interface, &skel_class); unlock_kernel(); kref_put(&dev->kref, skel_delete); info("USB Skeleton #%d now disconnected", minor); }

5．Open、Read、Write
skel_open、skel_read、skel_write，和我们通常见到的文件操作一样，当用户调用open、read或write这三个系统调用时，系统会分别调用这三个函数。
5．1 Open

static int skel_open(struct inode *inode, struct file *file) { struct usb_skel *dev; struct usb_interface *interface; int subminor; int retval = 0; subminor = iminor(inode); interface = usb_find_interface(&skel_driver, subminor); if (!interface) { err ("%s - error, can't find device for minor %d", __FUNCTION__, subminor); retval = -ENODEV; goto exit; dev = usb_get_intfdata(interface); if (!dev) { retval = -ENODEV; goto exit; kref_get(&dev->kref); file->private_data = dev; exit: return retval; }

open函数很简单，主要是递增usb_skel的kref，并把该结构体存入file的private_data中，以便其他函数（如read、write）调用。
5．2 Read

static ssize_t skel_read(struct file *file, char *buffer, size_t count, loff_t *ppos) { struct usb_skel *dev; int retval = 0; int bytes_read; dev = (struct usb_skel *)file->private_data; retval = usb_bulk_msg(dev->udev, usb_rcvbulkpipe(dev->udev, dev->bulk_in_endpointAddr), dev->bulk_in_buffer, min(dev->bulk_in_size, count), &bytes_read, 10000); if (!retval) { if (copy_to_user(buffer, dev->bulk_in_buffer, bytes_read)) retval = -EFAULT; else retval = bytes_read; return retval; }

先从file->private_data中取出在open函数中存入的usb_skel结构体。
介绍下usb_rcvbulkpipe这个函数：
该函数建立一个“receive、bulk类型”的pipe。
pipe是一个32位的值，记录了如下内容：
bit31～30，表示类型，bulk、interrupt、control或isochronous
bit23～16，记录usb_device-> devnum，它表示USB总线上的地址。
bit15～8，表示目标（要发送给谁）的endpoint地址
bit7～0，表示方向，USB_DIR_IN或USB_DIR_OUT
这里要说明一下IN和OUT：
在USB中，一切都是以Host为中心的，所以，在Host一方，IN是用来收数据的，而在Device一方正好相反，它的IN endpoint是用来发送数据的，OUT endpoint用来接受数据。笔者曾用过STR7x、STR9x和STM32（这些都是作为Device）上的USB做应用，当时很疑惑，为什么总是要在端点的OUT中断函数中收数据，在IN中断函数里发数据，现在终于明白了。
把思路拉回来，刚才通过usb_rcvbulkpipe建立了一个pipe，现在就要发送这个pipe，从目标设备读取数据。
usb_bulk_msg按照pipe值，从指定的目标设备读取数据，放入dev->bulk_in_buffer。
5．3 Write

static ssize_t skel_write(struct file *file, const char *user_buffer, size_t count, loff_t *ppos) { struct usb_skel *dev; int retval = 0; struct urb *urb = NULL; char *buf = NULL; dev = (struct usb_skel *)file->private_data; if (count == 0) goto exit; urb = usb_alloc_urb(0, GFP_KERNEL); if (!urb) { retval = -ENOMEM; goto error; buf = usb_buffer_alloc(dev->udev, count, GFP_KERNEL, &urb->transfer_dma); if (!buf) { retval = -ENOMEM; goto error; if (copy_from_user(buf, user_buffer, count)) { retval = -EFAULT; goto error; usb_fill_bulk_urb(urb, dev->udev, usb_sndbulkpipe(dev->udev, dev->bulk_out_endpointAddr), buf, count, skel_write_bulk_callback, dev); urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP; retval = usb_submit_urb(urb, GFP_KERNEL); if (retval) { err("%s - failed submitting write urb, error %d", __FUNCTION__, retval); goto error; usb_free_urb(urb); exit: return count; error: usb_buffer_free(dev->udev, count, buf, urb->transfer_dma); usb_free_urb(urb); return retval; }

（关于urb的知识，这里就不介绍了，大家可以google一下或者参考Linux驱动的宝典级读物《Linux Device Drivers 3rd》）
如果读懂了read函数，那么这个write就也能理解的差不多了。
不同的地方是，这里使用了usb_alloc_urb 、usb_fill_bulk_urb和usb_submit_urb、usb_free_urb这套组合，取代之前usb_bulk_msg这个比较偷懒、简化的方法。使用这套组合的优点是：
1、它不阻塞，usb_submit_urb后，直接返回，而usb_bulk_msg要等发送/接收全部完成后，才返回。
2、因为usb_submit_urb是直接返回的，所以当传输完成后，需要有一个回调函数来通知驱动，它就是complete函数，这里就是skel_write_bulk_callback。
其实大家有兴趣看看usb_bulk_msg的实现源码，会发现，它其实也是通过调用usb_alloc_urb 、usb_fill_bulk_urb和usb_submit_urb、usb_free_urb来实现的，不过它的complete回调函数是由系统自己处理的，而不是用户自己来编写代码。
最后一个函数，也就是complete回调函数，为了全文的完整，这里象征性地贴一下代码。兄弟你都读到这里了，应该很轻松就能读懂这个函数的，我就不多解释了：

static void skel_write_bulk_callback(struct urb *urb, struct pt_regs *regs) { struct usb_skel *dev; dev = (struct usb_skel *)urb->context; if (urb->status && !(urb->status == -ENOENT || urb->status == -ECONNRESET || urb->status == -ESHUTDOWN)) { dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status); usb_buffer_free(urb->dev, urb->transfer_buffer_length, urb->transfer_buffer, urb->transfer_dma); }