Usb_skeleton.c，是USB驅(qū)動的框架，適合USB驅(qū)動的初學者。
1．結(jié)構(gòu)體
內(nèi)核其實就是一坨坨的數(shù)據(jù)結(jié)構(gòu)，加上一根根鏈表。
對于初學者，如果直接看USB驅(qū)動代碼，大概會被那些名字相近的結(jié)構(gòu)體弄得暈頭轉(zhuǎn)向，比如usb_host_interface和usb_interface，看著看著就把兩個混淆了。所以，在學習USB驅(qū)動之前，建議把相關(guān)結(jié)構(gòu)體都拎出來看一下，其實，也就那么幾個結(jié)構(gòu)體在那裝神弄鬼。USB skeleton驅(qū)動中用到的主要字段已用藍色標出：
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鼠標驅(qū)動就是該類型），那么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
先來看模塊初始化函數(shù)，它僅僅完成一個功能，那就是注冊USB驅(qū)動：
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用來告訴內(nèi)核該模塊支持的所有設備。usb子系統(tǒng)通過設備的production ID和vendor ID的組合或者設備的class、subclass跟protocol的組合來識別設備，并調(diào)用相關(guān)的驅(qū)動程序作處理。不同設備的這些組合，當然是不一樣的，這由USB協(xié)會統(tǒng)一管理、分配。
skeleton中，使用production ID和vendor ID的組合來識別設備。
注意，還要使用MODULE_DEVICE_TABLE把這個id_table注冊到系統(tǒng)中去：
MODULE_DEVICE_TABLE (usb, skel_table);
3．Probe
probe是usb子系統(tǒng)自動調(diào)用的一個函數(shù)，有USB設備連接到主機時，usb子系統(tǒng)會根據(jù)production ID和vendor ID的組合或者設備的class、subclass跟protocol的組合（也就是根據(jù)id_table）來識別設備，并調(diào)用相應驅(qū)動程序的probe（探測）函數(shù)。
不同的USB驅(qū)動模塊，會注冊不同的id_table，比如現(xiàn)在有Usb_skeleton.c、Usb_driver1.c、Usb_driver2.c和Usb_driver3.c這么四個USB驅(qū)動模塊，它們都會調(diào)用MODULE_DEVICE_TABLE (usb, xxx_table)。這樣，系統(tǒng)中就有四個id_table。當一個USB設備連接到主機時，系統(tǒng)會從這四個id_table中，找到能夠匹配該USB設備的id_table，并調(diào)用該id_table所屬的USB驅(qū)動模塊。
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;
先介紹幾個函數(shù)：
usb_get_dev和usb_put_dev分別是遞增/遞減usb_device的reference count。
kref_init，初始化kref，并將其置設成1。
kref_get和kref_put分別遞增/遞減kref。
在初始化了一些資源之后，可以看到第一個關(guān)鍵的函數(shù)調(diào)用——interface_to_usbdev。他從一個usb_interface來得到該接口所在設備的usb_device。本來，要得到一個usb_device只要用interface_to_usbdev就夠了，但因為要增加對該usb_device的引用計數(shù)，我們應該在做一個usb_get_dev的操作，來增加引用計數(shù)，并在釋放設備時用usb_put_dev來減少引用計數(shù)。
這里要解釋的是，usb_get_dev是對該usb_device的計數(shù)，并不是對本模塊的計數(shù)，本模塊的計數(shù)要由kref來維護。所以，probe一開始就有初始化kref，kref_init(&dev->kref)。事實上，kref_init操作不單只初始化kref，還將其置設成1。所以在出錯處理代碼中有kref_put，它把kref的計數(shù)減1，如果kref計數(shù)已經(jīng)為0，那么kref會被釋放。kref_put的第二個參數(shù)是一個函數(shù)指針，指向一個清理函數(shù)。注意，該指針不能為空，或者kfree。該函數(shù)會在最后一個對kref的引用釋放時被調(diào)用。
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");//當批量傳輸?shù)木彺娴扔?
goto error;
}
//監(jiān)測端點是否正確
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;
}
上面這段函數(shù)，主要是通過usb_endpoint_descriptor里的信息，初始化dev（usb_skel類型）中的字段。
這里列一下各個結(jié)構(gòu)體之間的關(guān)系，幫助大家理一下層次：
usb_interface->usb_host_interface->usb_host_endpoint->usb_endpoint_descriptor
usb_set_intfdata(interface, dev);//什么意思，設置數(shù)據(jù)端口？是保存設備dev信息到usb_interface中，方便其他程序使用如：open
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中，以便其他函數(shù)使用。這樣做是因為，dev是一個局部變量，其他函數(shù)沒法獲得，但其他函數(shù)（比如open）可以訪問usb_interface，這樣，也就可以訪問usb_skel里的具體字段了。如open函數(shù)中，dev = usb_get_intfdata(interface)。
下面講一下usb_register_dev相關(guān)的內(nèi)容。
一個USB interface對應一種USB邏輯設備，比如鼠標、鍵盤、音頻流。所以，在USB范疇中，device一般就是指一個interface。一個驅(qū)動只控制一個interface。這樣，usb_register_dev自然是注冊一個interface，所以usb_register_dev的第一個參數(shù)是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 = {//skel_fops是真正完成對設備IO操作的函數(shù)集。
.owner = THIS_MODULE,
.read = skel_read,
.write = skel_write,
.open = skel_open,
.release = skel_release,
};
skel_fops是真正完成對設備IO操作的函數(shù)集。
usb_register_dev注冊一次，獲取一個次設備號。該次設備號從usb_class_driver -> minor_base開始分配。
usb_register_dev(interface, &skel_class)，也就是說，一個usb_interface對應一個次設備號。結(jié)合上面舉的interface例子，可以知道，鼠標、鍵盤各自對應一個不同的次設備號。
4．Disconnect
當設備從主機拔出時，usb子系統(tǒng)會自動地調(diào)用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，和我們通常見到的文件操作一樣，當用戶調(diào)用open、read或write這三個系統(tǒng)調(diào)用時，系統(tǒng)會分別調(diào)用這三個函數(shù)。
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);//獲取設備信息，從interface結(jié)構(gòu)中，就是從接口中，usb_skell結(jié)構(gòu)體
if (!dev) {
retval = -ENODEV;
goto exit;
kref_get(&dev->kref);//為設備添加kref計數(shù)
file->private_data = dev;
exit:
return retval;
}
open函數(shù)很簡單，主要是遞增usb_skel的kref，并把該結(jié)構(gòu)體存入file的private_data中，以便其他函數(shù)（如read、write）調(diào)用。
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),//建立pipe管道
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))//將數(shù)據(jù)保存到用戶空間的buffer里
retval = -EFAULT;
else
retval = bytes_read;
return retval;
}
先從file->private_data中取出在open函數(shù)中存入的usb_skel結(jié)構(gòu)體。
介紹下usb_rcvbulkpipe這個函數(shù)：
該函數(shù)建立一個“receive、bulk類型”的pipe。
pipe是一個32位的值，記錄了如下內(nèi)容：
bit31～30，表示類型，bulk、interrupt、control或isochronous
bit23～16，記錄usb_device-> devnum，它表示USB總線上的地址。
bit15～8，表示目標（要發(fā)送給誰）的endpoint地址
bit7～0，表示方向，USB_DIR_IN或USB_DIR_OUT
這里要說明一下IN和OUT：
在USB中，一切都是以Host為中心的，所以，在Host一方，IN是用來收數(shù)據(jù)的，而在Device一方正好相反，它的IN endpoint是用來發(fā)送數(shù)據(jù)的，OUT endpoint用來接受數(shù)據(jù)。筆者曾用過STR7x、STR9x和STM32（這些都是作為Device）上的USB做應用，當時很疑惑，為什么總是要在端點的OUT中斷函數(shù)中收數(shù)據(jù)，在IN中斷函數(shù)里發(fā)數(shù)據(jù)，現(xiàn)在終于明白了。
把思路拉回來，剛才通過usb_rcvbulkpipe建立了一個pipe，現(xiàn)在就要發(fā)送這個pipe，從目標設備讀取數(shù)據(jù)。
usb_bulk_msg按照pipe值，從指定的目標設備讀取數(shù)據(jù)，放入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;//定義urb指針類型
char *buf = NULL;
dev = (struct usb_skel *)file->private_data;//在open函數(shù)中保存的
if (count == 0)
goto exit;
urb = usb_alloc_urb(0, GFP_KERNEL);//創(chuàng)建urb，自動分配方式
if (!urb) {
retval = -ENOMEM;
goto error;
buf = usb_buffer_alloc(dev->udev, count, GFP_KERNEL, &urb->transfer_dma);///dma方式傳輸
if (!buf) {
retval = -ENOMEM;
goto error;
if (copy_from_user(buf, user_buffer, count)) {//將數(shù)據(jù)拷貝到內(nèi)核空間中
retval = -EFAULT;
goto error;
usb_fill_bulk_urb(urb, dev->udev, //urb批量傳輸
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);//提交urb
if (retval) {
err("%s - failed submitting write urb, error %d", __FUNCTION__, retval);
goto error;
usb_free_urb(urb);//urb空閑
exit:
return count;
error:
usb_buffer_free(dev->udev, count, buf, urb->transfer_dma);
usb_free_urb(urb);
return retval;
}
?。P(guān)于urb的知識，這里就不介紹了，大家可以google一下或者參考Linux驅(qū)動的寶典級讀物《Linux Device Drivers 3rd》）
如果讀懂了read函數(shù)，那么這個write就也能理解的差不多了。
不同的地方是，這里使用了usb_alloc_urb 、usb_fill_bulk_urb和usb_submit_urb、usb_free_urb這套組合，取代之前usb_bulk_msg這個比較偷懶、簡化的方法。使用這套組合的優(yōu)點是：
1、它不阻塞，usb_submit_urb后，直接返回，而usb_bulk_msg要等發(fā)送/接收全部完成后，才返回。
2、因為usb_submit_urb是直接返回的，所以當傳輸完成后，需要有一個回調(diào)函數(shù)來通知驅(qū)動，它就是complete函數(shù)，這里就是skel_write_bulk_callback。
其實大家有興趣看看usb_bulk_msg的實現(xiàn)源碼，會發(fā)現(xiàn)，它其實也是通過調(diào)用usb_alloc_urb 、usb_fill_bulk_urb和usb_submit_urb、usb_free_urb來實現(xiàn)的，不過它的complete回調(diào)函數(shù)是由系統(tǒng)自己處理的，而不是用戶自己來編寫代碼。
最后一個函數(shù)，也就是complete回調(diào)函數(shù)，為了全文的完整，這里象征性地貼一下代碼。兄弟你都讀到這里了，應該很輕松就能讀懂這個函數(shù)的，我就不多解釋了：
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);
}
