一、引言
USB(Universal Serial Bus)即通用串行總線,是一種全新的雙向同步傳輸的支持熱插拔的數據傳輸總線,其目的是為了提供一種兼容不同速度的、可擴充的并且使用方便的外圍設備接口,同時也是為了解決計算機接口的太多的弊端而設計的。一個USB系統主要有三部分組成:USB互連、USB主機、USB設備三部分組成的,其結構如圖1 所示。在編寫USB設備驅動程序設計時,可以分為三部分編寫:主機端設備驅動程序、主機控制器驅動程序設計和設備端驅動程序三部分,在本文中重點介紹主機端驅動程序的設計。
二、USB設備驅動程序的設計
USB設備驅動程序的設計包括主機端設備驅動程序設計、主機控制器驅動程序設計和設備端驅動程序設計三部分組成。主機端設備驅動程序就是通常說的設備驅動程序,它是主機環境中為用戶應用程序提供一個訪問USB外設的接口。Linux為這部分驅動程序提供編程接口,驅動程序設計者只要按照需求編寫驅動程序框架,通過調用操作系統提供的API接口函數可以完成對USB外設的特定訪問。
主機控制驅動主要是對USB主機控制器的驅動,在大多數PC環境下,主機控制器都是由操作系統提供。嵌入式設備一般都沒有USB主機控制器,只是工作在 Slave模式下。如果要使USB具有主機功能,那么設備中需要選用一個帶主機控制器的USB接口控制芯片,同時自己還要有實現該主機控制器的驅動程序。目前Linux內核中只提供USB主機控制器的開放主機控制器和通用主機控制器接口兩種規格,而這兩種規格主要用在PC架構中。USB主機端驅動程序與主機控制器的結構如圖2所示。其中USB核是Linux的一個子模塊,集中定義了一組USB相關的數據結構、宏以及API函數。
USB設備驅動程序是常說的設備固件程序的一部分,提供設備信息與主機的通信接口。設備端USB驅動程序設計由以下幾部分處理程序組成。初始化例程:完成描述符指針、端點、配置改變等操作。數據傳輸例程:完成控制傳輸、批量傳輸、中斷傳輸及同步傳輸等傳輸方式下的數據收發工作。標準設備處理請求:處理標準設備請求。廠商請求處理:處理生產商指定請求。其他操作:處理主機發出的端口復位、配置改變等操作。
1.USB設備驅動程序框架
USB驅動程序首先要向Linux內核注冊自己,并告訴系統它所支持的設備類型以及它所支持的操作。這些信息通過一個usb_driver結構來傳遞。usb_driver結構如下:
static struct usb_driver skel_driver = {
name: "skeleton";/*驅動程序的名稱*/
probe: skel_probe; /*設備列舉時被調用*/
disconnect: skel_disconnect; /*設備被卸載時被調用*/
fops: &skel_fops; /*指向一個file_operation結構,內核通過它來訪問驅動程序的文件操作函數,與用戶程序的read、write等操作進行交互*/
minor USB_SKEL_MINOR_BASE; /*指向設備的次設備號,用于系統識別主設備號相同的設備(即一個驅動程序可以同時支持多個USB設備*/
id_table: skel_table; /*保存設備的廠商ID和產品ID,作為該設備的唯一標識,驅動程序向系統注冊后,當下次插入時,系統根據這個標識查找正確的驅動程序,實現設備的即插即用*/
};
static struct file_operation skel_fops={
{
owner:THIS_MODULE,
read:skel_read,
write:skel_write,
ioctl:skel_ioctl,
open:skel_open,
release:skel_release,
};
(1)注冊和注銷
USB驅動程序注冊,就是把在初始化函數中填好的use_driver結構作為參數傳遞給
use_register()函數即可,函數的調用方法為:
result=usb_register(&skel_driver);
當要從系統卸載驅動程序時,也是將use_driver結構作為參數傳遞給usb_deregister 函數處理。 函數的調用格式為:
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-hotplug(Linux中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都會被傳遞到函數中。
(2)probe()函數
probe()函數的編寫格式為:static void * skel_probe(struct usb_device *dev, unsigned int ifnum, const struct usb_device_id *id);驅動程序需要確認插入的設備是否可以被接受,如果不接受,或者在初始化的過程中發生任何錯誤,probe()函數返回一個NULL值。否則返回一個含有設備驅動程序狀態的指針,通過這個指針,就可以訪問所有結構中的回調函數。
在驅動程序里,最后一點是要注冊devfs(設備文件系統)。首先創建一個緩沖用來保存那些被發送給USB設備的數據和那些從設備上接受的數據,并為設備傳輸創建一個USB請求塊(URB)以向設備寫入數據,同時USB urb 被初始化,然后在devfs子系統中注冊設備,允許devfs用戶訪問USB的設備。注冊過程如下:
/* 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結構所定義的函數進行了。
(3)open()、write()和read()函數
首先,要打開此設備。在open()函數中MODULE_INC_USE_COUNT 宏是一個關鍵,它起到一個計數的作用,有一個用戶態程序打開一個設備,計數器就加1。例如,以模塊方式加入一個驅動,若計數器不為零,就說明仍然有用戶程序在使用此驅動,這時候,就不能通過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()函數就可以收、發數據了。
read()函數首先從open()函數中保存的fi。
Write()函數和read()函數是完成驅動對讀寫等操作的響應。在skel_write中,一個FILL_BULK_URB函數,就完成了urb 系統callbak和的skel_write_bulk_callback之間的聯系。注意skel_write_bulkcallback是中斷方式,所以要注意時間不能太久,本程序中它就只是報告一些urb的狀態等。 read 函數與write 函數稍有不同在于:程序并沒有用urb 將數據從設備傳送到驅動程序,而是用usb_bulk_msg 函數代替,這個函數能夠不需要創建urbs 和操作urb函數的情況下,來發送數據給設備,或者從設備來接收數據。調用usb_bulk_msg函數并傳到一個存儲空間,用來緩沖和放置驅動收到的數據,若沒有收到數據表示失敗并返回一個錯誤信息。
usb_bulk_msg函數:當對usb設備進行一次讀或者寫時,usb_bulk_msg 函數是非常有用的; 然而, 當需要連續地對設備進行讀/寫時,應建立一個自己的urbs,同時將urbs 提交給USB子系統。
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設備已經被取走。
2.設計實例
下面通過介紹鍵盤飛梭驅動程序的實例來讓讀者更好的理解USB驅動程序的工作原理,實現代碼如下:
/*需要的頭文件*/
#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>
/* 驅動程序版本信息*/
#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中看到的值,通過cat/proc/bus/usb/devices得到當前系統探測到的USB總線上的設備信息。它包括Vendor、ProdID、Product等*/
MODULE_AUTHOR( DRIVER_AUTHOR );
MODULE_DESCRIPTION( DRIVER_DESC );
/*此結構來自內核中drivers/usb/usbkbd.c*/
struct usb_kbd {
struct input_dev dev;
struct usb_device *usbdev;
unsigned char new[8];
unsigned char old[8];
struct urb irq, led;
struct usb_ctrlrequest dr;
unsigned char leds, newleds;
char name[128];
int open;
};
static void usb_kbd_irq(struct urb *urb) /*urb為USB請求塊*/
{
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);
三、結語
USB規范是一門比較新的技術,接口使用方便,但是驅動程序的設計較復雜。上面介紹了USB設備驅動程序的設計,主要分析了主機端驅動程序的設計,并且給出了一個編寫USB驅動程序的實例。
參考文獻
1.劉崢嶸.嵌入式Linux應用開發詳界解.機械工業出版社,2004
2.周立功.ARM嵌入式Linux系統構件與驅動開發范例.北京航天航空大學出版社,2006
3.劉淼.嵌入式系統接口設計與Linux驅動程序開發.北京航天航空大學出版社,2006