linux usb驅動架構 1__linux

初次接觸與OS相關的裝置驅動編寫，感覺還挺有意思的，為了不至於忘掉看過的東西，筆記跟總結當然不可缺，更何況我決定為嵌入式賣命了。好，言歸正傳，我說一說這段時間的收穫，跟大家分享一下Linux的驅動開發。但這次只先針對Linux的USB子系統作分析，因為周五研討老闆催貨。當然，還會順帶提一下其他的驅動程式寫法。

　　事實上，Linux的裝置驅動都遵循一個慣例——表徵驅動程式（用driver更貼切一些，應該稱為磁碟機比較好吧）的結構體，結構體裡面應該包含了驅動程式所需要的所有資源。用術語來說，就是這個磁碟機對象所擁有的屬性及成員。由於Linux的核心用c來編寫，所以我們也按照這種結構化的思想來分析代碼，但我還是希望從OO的角度來闡述這些細節。這個結構體的名字有驅動開發人員決定，比如說，滑鼠可能有一個叫做mouse_dev的struct，鍵盤可能由一個keyboard_dev的struct（dev for device，我們做的只是裝置驅動）。而這次我們來分析一下Linux核心源碼中的一個usb-skeleton（就是usb驅動的骨架咯），自然，他定義的裝置結構體就叫做usb-skel：

　　struct usb_skel {

　　struct usb_device *      udev;                 /* the usb device for this device */

　　struct usb_interface *   interface;            /* the interface for this device */

　　struct semaphore       limit_sem;         /* limiting the number of writes in progress */

　　unsigned char *         bulk_in_buffer;     /* the buffer to receive data */

　　size_t         bulk_in_size;                  /* the size of the receive buffer */

　　__u8          bulk_in_endpointAddr;        /* the address of the bulk in endpoint */

　　__u8          bulk_out_endpointAddr;      /* the address of the bulk out endpoint */

　　struct kref   kref;

　　};

　　這裡我們得補充說明一下一些USB的協議規範細節。USB能夠自動監測裝置，並調用相應得驅動程式處理裝置，所以其規範實際上是相當複雜的，幸好，我們不必理會大部分細節問題，因為Linux已經提供相應的解決方案。就我現在的理解來說，USB的驅動分為兩塊，一塊是USB的bus驅動，這個東西，Linux核心已經做好了，我們可以不管，但我們至少要瞭解他的功能。形象得說，USB的bus驅動相當於鋪出一條路來，讓所有的資訊都可以通過這條USB通道到達該到的地方，這部分工作由usb_core來完成。當USB裝置接到USB控制器介面時，usb_core就檢測該裝置的一些資訊，例如生產廠商ID和產品的ID，或者是裝置所屬的class、subclass跟protocol，以便確定應該調用哪一個驅動處理該裝置。裡面複雜細節我們不用管，我們要做的是另一塊工作——usb的裝置驅動。也就是說，我們就等著usb_core告訴我們要工作了，我們才工作。

　　從開發人員的角度看，每一個usb裝置有若干個配置(configuration)組成，每個配置又可以有多個介面(interface)，每個介面又有多個設定(setting圖中沒有給出)，而介面本身可能沒有端點或者多個端點（end point）。USB的資料交換通過端點來進行，主機與各個端點之間建立起單向的管道來傳輸資料。而這些介面可以分為四類：

　　控制（control）

　　用於配置裝置、擷取裝置資訊、發送命令或者擷取裝置的狀態報表

　　中斷（interrupt）

　　當USB宿主要求裝置傳輸資料時，中斷端點會以一個固定的速率傳送少量資料，還用於發送資料到USB裝置以控制裝置，一般不用於傳送大量資料。

　　批量（bulk）

　　用於大量資料的可靠傳輸，如果匯流排上的空間不足以發送整個批量包，它會被分割成多個包傳輸。

　　等時（isochronous）

　　大量資料的不可靠傳輸，不保證資料的到達，但保證恒定的資料流，多用於資料擷取。

　　Linux中用struct usb_host_endpoint來描述USB端點，每個usb_host_endpoint中包含一個struct usb_endpoint_descriptor結構體，當中包含該端點的資訊以及裝置自訂的各種資訊，這些資訊包括：

　　bEndpointAddress（b for byte）

　　8位端點地址，其地址還隱藏了端點方向的資訊（之前說過，端點是單向的），可以用掩碼USB_DIR_OUT和USB_DIR_IN來確定。

　　bmAttributes

　　端點的類型，結合USB_ENDPOINT_XFERTYPE_MASK可以確定端點是USB_ENDPOINT_XFER_ISOC（等時）、USB_ENDPOINT_XFER_BULK（批量）還是USB_ENDPOINT_XFER_INT（中斷）。

　　wMaxPacketSize

　　端點一次處理的最大位元組數。發送的BULK包可以大於這個數值，但會被分割傳送。

　　bInterval

　　如果端點是中斷類型，該值是端點的間隔設定，以毫秒為單位。

　　在邏輯上，一個USB裝置的功能劃分是通過介面來完成的。比如說一個USB擴音器，可能會包括有兩個介面：一個用於鍵盤控制，另外一個用於音頻流傳輸。而事實上，這種裝置需要用到不同的兩個驅動程式來操作，一個修飾鍵盤，一個控制音頻流。但也有例外，比如藍牙裝置，要求有兩個介面，第一用於ACL跟EVENT的傳輸，另外一個用於SCO鏈路，但兩者通過一個驅動控制。在Linux上，介面使用struct usb_interface來描述，以下是該結構體中比較重要的欄位：

　　struct usb_host_interface *altsetting（注意不是usb_interface）

　　其實據我理解，他應該是每個介面的設定，雖然名字上有點奇怪。該欄位是一個設定的數組（一個介面可以有多個設定），每個usb_host_interface都包含一套由struct usb_host_endpoint定義的端點配置。但這些配置次序是不定的。

　　unsigned num_altstting

　　可選設定的數量，即altsetting所指數組的元素個數。

　　struct usb_host_interface *cur_altsetting

　　當前活動的設定，指向altsetting數組中的一個。

　　int minor

　　當捆綁到該介面的USB驅動程式使用USB主裝置號時，USB core分配的次裝置號。僅在成功調用usb_register_dev之後才有效。

　　除了它可以用struct usb_host_config來描述之外，到現在為止，我對配置的瞭解不多。而整個USB裝置則可以用struct usb_device來描述，但基本上只會用它來初始化函數的介面，真正用到的應該是我們之前所提到的自訂的一個結構體。

　　好，瞭解過USB一些規範細節之後，我們現在來看看Linux的驅動架構。事實上，Linux的裝置驅動，特別是這種hotplug的USB裝置驅動，會被編譯成模組，然後在需要時掛在到核心。要寫一個Linux的模組並不複雜，以一個helloworld為例：

　　#include <linux/init.h>

　　#include <linux/module.h>

　　MODULE_LICENSE(“GPL”);

　　static int hello_init(void)

　　{

　　printk(KERN_ALERT “Hello World!/n”);

　　return 0;

　　}

　　static int hello_exit(void)

　　{

　　printk(KERN_ALERT “GOODBYE!/n”);

　　}

　　module_init(hello_init);

　　module_exit(hello_exit);

　　這個簡單的程式告訴大家應該怎麼寫一個模組，MODULE_LICENSE告訴核心該模組的著作權資訊，很多情況下，用GPL或者BSD，或者兩個，因為一個私人模組一般很難得到社區的協助。module_init和module_exit用於向核心註冊模組的初始化函數和模組推出函數。如程式所示，初始化函數是hello_init，而退出函數是hello_exit。

　　另外，要編譯一個模組通常還需要用到核心源碼樹中的makefile，所以模組的Makefile可以寫成：

　　ifneq ($(KERNELRELEASE),)

　　obj-m:= hello.o#usb-dongle.o

　　else

　　KDIR:= /usr/src/linux-headers-$(shell uname -r)

　　BDIR:= $(shell pwd)

　　default:

　　$(MAKE) -C $(KDIR) M=$(PWD) modules

　　.PHONY: clean

　　clean:

　　make -C $(KDIR) M=$(BDIR) clean

　　endif

　　可以用insmod跟rmmod來驗證模組的掛在跟卸載，但必須用root的身份登陸命令列，用普通使用者加su或者sudo在Ubuntu上的測試是不行的。

　　下面分析一下usb-skeleton的源碼。這個範常式序可以在linux-2.6.17/drivers/usb下找到，其他版本的核心程式源碼可能有所不同，但相差不大。大家可以先找到源碼看一看，先有個整體印象。

　　之前已經提到，模組先要向核心註冊初始化跟銷毀函數：

　　static int __init usb_skel_init(void)

　　{

　　int result;

　　/* register this driver with the USB subsystem */

　　result = usb_register(&skel_driver);

　　if (result)

　　err("usb_register failed. Error number %d", result);

　　return result;

　　}

　　static void __exit usb_skel_exit(void)

　　{

　　/* deregister this driver with the USB subsystem */

　　usb_deregister(&skel_driver);

　　}

　　module_init (usb_skel_init);

　　module_exit (usb_skel_exit);

　　MODULE_LICENSE("GPL");

　　從代碼開來，這個init跟exit函數的作用只是用來註冊驅動程式，這個描述驅動程式的結構體是系統定義的標準結構struct usb_driver,註冊和登出的方法很簡單，usb_register（struct *usb_driver）, usb_deregister（struct *usb_driver）。那這個結構體需要做些什麼呢。他要向系統提供幾個函數入口，跟驅動的名字：

　　static struct usb_driver skel_driver = {

　　.name =      "skeleton",

　　.probe =     skel_probe,

　　.disconnect = skel_disconnect,

　　.id_table =    skel_table,

　　};

　　從代碼看來，usb_driver需要初始化四個東西：模組的名字skeleton，probe函數skel_probe,disconnect函數skel_disconnect,以及id_table。

　　在解釋skel_driver各個成員之前，我們先來看看另外一個結構體。這個結構體的名字有開發人員自訂，它描述的是該驅動擁有的所有資源及狀態：

　　struct usb_skel {

　　struct usb_device *      udev;                 /* the usb device for this device */

　　struct usb_interface *   interface;            /* the interface for this device */

　　struct semaphore       limit_sem;         /* limiting the number of writes in progress */

　　unsigned char *         bulk_in_buffer;     /* the buffer to receive data */

　　size_t         bulk_in_size;                  /* the size of the receive buffer */

　　__u8          bulk_in_endpointAddr;        /* the address of the bulk in endpoint */

　　__u8          bulk_out_endpointAddr;      /* the address of the bulk out endpoint */

　　struct kref   kref;

　　};

　　我們先來對這個usb_skel作個簡單分析，他擁有一個描述usb裝置的結構體udev，一個介面interface，用於並發存取控制的semaphore(訊號量) limit_sem，用於接收資料的緩衝bulk_in_buffer及其尺寸bulk_in_size，然後是批量輸入輸出連接埠地址bulk_in_endpointAddr、bulk_out_endpointAddr，最後是一個核心使用的引用計數器。他們的作用我們將在後面的代碼中看到。

　　我們再回過頭來看看skel_driver。

　　name用來告訴核心模組的名字是什麼，這個註冊之後有系統來使用，跟我們關係不大。

　　id_table用來告訴核心該模組支援的裝置。usb子系統通過裝置的production ID和vendor ID的組合或者裝置的class、subclass跟protocol的組合來識別裝置，並調用相關的驅動程式作處理。我們可以看看這個id_table到底是什麼東西：

　　/* Define these values to match your devices */

　　#define USB_SKEL_VENDOR_ID  0xfff0

　　#define USB_SKEL_PRODUCT_ID 0xfff0

　　/* 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);

　　MODULE_DEVICE_TABLE的第一個參數是裝置的類型，如果是USB裝置，那自然是usb（如果是PCI裝置，那將是pci，這兩個子系統用同一個宏來註冊所支援的裝置。這涉及PCI裝置的驅動了，在此先不深究）。後面一個參數是裝置表，這個裝置表的最後一個元素是空的，用於標識結束。代碼定義了USB_SKEL_VENDOR_ID是0xfff0，USB_SKEL_PRODUCT_ID是0xfff0，也就是說，當有一個裝置接到集線器時，usb子系統就會檢查這個裝置的vendor ID和product ID，如果它們的值是0xfff0時，那麼子系統就會調用這個skeleton模組作為裝置的驅動。

　　probe是usb子系統自動調用的一個函數，有USB裝置接到硬體集線器時，usb子系統會根據production ID和vendor ID的組合或者裝置的class、subclass跟protocol的組合來識別裝置調用相應驅動程式的probe（探測）函數，對於skeleton來說，就是skel_probe。系統會傳遞給探測函數一個usb_interface *跟一個struct usb_device_id *作為參數。他們分別是該USB裝置的介面描述（一般會是該裝置的第0號介面，該介面的預設設定也是第0號設定）跟它的裝置ID描述（包括Vendor ID、Production ID等）。probe函數比較長，我們分段來分析這個函數：

　　dev->udev = usb_get_dev(interface_to_usbdev(interface));

　　dev->interface = interface;

　　在初始化了一些資源之後，可以看到第一個關鍵的函數調用——interface_to_usbdev。他同uo一個usb_interface來得到該介面所在裝置的裝置描述結構。本來，要得到一個usb_device只要用interface_to_usbdev就夠了，但因為要增加對該usb_device的引用計數，我們應該在做一個usb_get_dev的操作，來增加引用計數，並在釋放裝置時用usb_put_dev來減少引用計數。這裡要解釋的是，該引用計數值是對該usb_device的計數，並不是對本模組的計數，本模組的計數要由kref來維護。所以，probe一開始就有初始化kref。事實上，kref_init操作不單只初始化kref，還將其置設成1。所以在出錯處理代碼中有kref_put，它把kref的計數減1，如果kref計數已經為0，那麼kref會被釋放。kref_put的第二個參數是一個函數指標，指向一個清理函數。注意，該指標不可為空，或者kfree。該函數會在最後一個對kref的引用釋放時被調用（如果我的理解不準確，請指正）。下面是核心源碼中的一段注釋及代碼：

　　/**

　　* kref_put - decrement refcount for object.

　　* @kref: object.

　　* @release: pointer to the function that will clean up the object when the

　　*        last reference to the object is released.

　　*        This pointer is required, and it is not acceptable to pass kfree

　　*        in as this function.

　　*

　　* Decrement the refcount, and if 0, call release().

　　* Return 1 if the object was removed, otherwise return 0.  Beware, if this

　　* function returns 0, you still can not count on the kref from remaining in

　　* memory.  Only use the return value if you want to see if the kref is now

　　* gone, not present.

　　*/

　　int kref_put(struct kref *kref, void (*release)(struct kref *kref))

　　{

　　WARN_ON(release == NULL);

　　WARN_ON(release == (void (*)(struct kref *))kfree);

　　/*

　　* if current count is one, we are the last user and can release object

　　* right now, avoiding an atomic operation on 'refcount'

　　*/

　　if ((atomic_read(&kref->refcount) == 1) ||

　　(atomic_dec_and_test(&kref->refcount))) {

　　release(kref);

　　return 1;

　　}

　　return 0;

　　}

　　當我們執行開啟操作時，我們要增加kref的計數，我們可以用kref_get，來完成。所有對struct kref的操作都有核心代碼確保其原子性。

　　得到了該usb_device之後，我們要對我們自訂的usb_skel各個狀態跟資源作初始化。這部分工作的任務主要是向usb_skel註冊該usb裝置的端點。這裡可能要補充以下一些關於usb_interface_descriptor的知識，但因為核心源碼對該結構體的注釋不多，所以只能靠個人猜測。在一個usb_host_interface結構裡面有一個usb_interface_descriptor叫做desc的成員，他應該是用於描述該interface的一些屬性，其中bNumEndpoints是一個8位（b for byte）的數字，他代表了該介面的端點數。probe然後遍曆所有的端點，檢查他們的類型跟方向，註冊到usb_skel中。

　　/* set up the endpoint information */

　　/* use only the first bulk-in and bulk-out endpoints */

　　iface_desc = interface->cur_altsetting;

　　for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {

　　endpoint = &iface_desc->endpoint.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)) {

　　/* we found a bulk in endpoint */

　　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)) {

　　/* we found a bulk out endpoint */

　　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;

　　}