首先我們按照順序,看核心子產品的注冊以及釋放函數如下:
點選(此處)折疊或打開
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");
這個注冊與銷毀使用了usb_register(struct *usb_driver)以及usb_deregister(struct *usb_driver);那這個結構體需要做些什麼呢?他要向系統提供幾個函數入口,跟驅動的名字:
static struct usb_driver skel_driver = {
.owner = THIS_MODULE,
.name = "skeleton",
.id_table = skel_table,
.probe = skel_probe,
.disconnect = skel_disconnect,
};
從代碼看來,usb_driver需要初始化四個東西:子產品的名字skeleton,probe函數kel_probe, disconnect函數skel_disconnect,以及id_table。對于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);
打個比方就是我們要出去走親戚,肯定知道是去看哪個親戚,當然我們也肯定知道去他家的路怎麼走,而這個函數,就是在我們插入usb裝置時,usb子系統就會檢查裝置的vendor ID和product ID,如果它們的值是0xfff0時,那麼子系統就會調用這個skeleton子產品作為裝置的驅動。
于是,就開始調用prode函數,做一些int (*probe) (struct usb_interface *intf,const struct usb_device_id *id);函數作用如下:
Called to see if the driver is willing to manage a particular interface on a device. If it is, probe returns zero and uses * usb_set_intfdata() to associate driver-specific data with the * interface. It may also use usb_set_interface() to specify the appropriate altsetting. If unwilling to manage the interface,return -ENODEV, if genuine IO errors occured, an appropriate negative errno value.
就是根據id_table入口中的内容與插入的裝置是否比對,來決定是否處理裝置上的特定接口。
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等)。
(2)我們來看prode函數:
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;
/* allocate memory for our device state and initialize it */
dev = kmalloc(sizeof(struct usb_skel), 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;
/* 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[i].desc;
if (!dev->bulk_in_endpointAddr &&
(endpoint->bEndpointAddress & USB_DIR_IN) &&
((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
== USB_ENDPOINT_XFER_BULK)) {
/* we found a bulk in endpoint */
buffer_size = 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_DIR_IN) &&
/* 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");
/* save our data pointer in this interface device */
usb_set_intfdata(interface, dev);
/* we can register the device now, as it is ready */
retval = usb_register_dev(interface, &skel_class);
if (retval) {
/* something prevented us from registering this driver */
err("Not able to get a minor for this device.");
usb_set_intfdata(interface, NULL);
/* let the user know what node this device is now attached to */
info("USB Skeleton device now attached to USBSkel-%d", interface->minor);
return 0;
error:
if (dev)
kref_put(&dev->kref, skel_delete);
return retval;
2-9:對函數的變量定義以及初始化。
10-16:對裝置的申請記憶體處理。
首先我們看下skeleton函數的自定義結構體:
/* Structure to hold all of our device specific stuff */
struct usb_skel {
struct usb_device * udev; /* the usb device for this device */
struct usb_interface * interface; /* the interface for this device */
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,最後是一個核心使用的引用計數器kref。這個引用計數在我們的prode函數中正好被設定,
17:kref_init(&dev->kref);
19:dev->udev = usb_get_dev(interface_to_usbdev(interface));
20:dev->interface = interface;
在17行,我們對usb_skel中的kref結構體進行初始化,設定這個引用計數器的值,這個值用來說明對子產品的引用次數,初始化函數如下:
/***
* kref_init - initialize object.
* @kref: object in question.
*/
void kref_init(struct kref *kref)
{
atomic_set(&kref->refcount,1);
smp_mb();
這個函數不僅用來初始化kref,而且用原子的方式設定refcount的值為1。是以在出錯處理代碼中有kref_put,它把kref的計數減1,如果kref計數已經為0,那麼kref會被釋放,kref的釋放會在下面分析。
在初始化了一些資源之後,可以看到第一個關鍵的函數調用——interface_to_usbdev。他同uo一個usb_interface來得到該接口所在裝置的裝置描述結構。本來,要得到一個usb_device隻要用interface_to_usbdev就夠了,但因為要增加對該usb_device的引用計數,我們應該在做一個usb_get_dev的操作,來增加引用計數,并在釋放裝置時用usb_put_dev來減少引用計數。
其中對interface_to_usbdev(interface)函數的定義如下:
#define interface_to_usbdev(intf) \
container_of(intf->dev.parent, struct usb_device, dev)
21-55:對我們自定義的usb_skel各個狀态跟資源作初始化。這部分工作的任務主要是向usb_skel注冊該usb裝置的端點。這裡可能要補充以下一些關于usb_interface_descriptor的知識,但因為核心源碼對該結構體的注釋不多,是以隻能靠個人猜測。在一個usb_host_interface結構裡面有一個usb_interface_descriptor叫做desc的成員,他應該是用于描述該interface的一些屬性,其中bNumEndpoints是一個8位(b for byte)的數字,他代表了該接口的端點數。probe然後周遊所有的端點,檢查他們的類型跟方向,注冊到usb_skel中。
56-58:向系統注冊一些以後會用的的資訊。首先我們來說明一下usb_set_intfdata(),他向核心注冊一個data,這個data的結構可以是任意的,這段程式向核心注冊了一個usb_skel結構。就是我們剛剛看到的被初始化的那個。之是以要把他注冊,是因為我們定義的usb_skel結構不是全局變量,其他的函數需要使用的時候,可以後用usb_get_intfdata來得到。我們可以再核心源碼中找到對它的定義:(/linux/usb.h)
static inline void usb_set_intfdata(struct usb_interface *intf, void *data)
dev_set_drvdata(&intf->dev, data);
這個内聯函數又調用了dev_set_drvdata(&intf->dev, data)
我們接着找這個函數的定義:()
static inline unsigned int dev_set_drvdata(struct device *dev, void *data)
dev->driver_data = data;;
這下我們就明白,我們是把dev的裝置資訊儲存到了interface->dev->driver_data中。在以後使用的時候,隻需要調用usb_get_intfdata就可以得到dev的資訊。
59-67:我們向這個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,
它其實是一個系統定義的結構,裡面包含了一名字、一個檔案操作結構體還有一個次裝置号的基準值。事實上它才是定義 真正完成對裝置IO操作的函數。是以他的核心内容應該是skel_fops。其原形如下:
static struct file_operations skel_fops = {
.owner = THIS_MODULE,
.read = skel_read,
.write = skel_write,
.open = skel_open,
.release = skel_release,
這是我們比較常見的file_operations函數。 這個檔案操作結構中定義了對裝置的讀寫、打開、釋放(USB裝置通常使用這個術語release)。他們都是函數指針,分别指向skel_read、skel_write、skel_open、skel_release這四個函數,這四個函數應該有開發人員自己實作。
prode函數最後部分是對錯誤的相關處理。此時我們看到了:
kref_put(&dev->kref, skel_delete);它把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的操作都有核心代碼確定其原子性。
(2)我們繼續來看skel_disconnect函數:
static void skel_disconnect(struct usb_interface *interface)
struct usb_skel *dev;
int minor = interface->minor;
/* prevent skel_open() from racing skel_disconnect() */
lock_kernel();
dev = usb_get_intfdata(interface);
usb_set_intfdata(interface, NULL);
/* give back our minor */
usb_deregister_dev(interface, &skel_class);
unlock_kernel();
/* decrement our usage count */
kref_put(&dev->kref, skel_delete);
info("USB Skeleton #%d now disconnected", minor);
當裝置被拔出集線器時,usb子系統會自動地調用disconnect,他做的事情不多,最重要的是登出class_driver(交還次裝置号)和interface的data:
dev = usb_get_intfdata(interface);
usb_set_intfdata(interface, NULL);
/* give back our minor */
usb_deregister_dev(interface, &skel_class);
然後他會用kref_put(&dev->kref, skel_delete)進行清理,kref_put的細節參見前文。
到目前為止,我們已經分析完usb子系統要求的各個主要操作,下一部分我們在讨論一下對USB裝置的IO操作。
接下來我們進行IO操作的分析。
(1)open函數:
static int skel_open(struct inode *inode, struct file *file)
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); //擷取注冊到接口的usb——skel資料。
if (!dev) {
/* increment our usage count for the device */
kref_get(&dev->kref); //對usb_skel子產品的使用計數
/* save our object in the file's private structure */
file->private_data = dev; //儲存usb_skel結構的資料以便read,write函數使用
exit:
open函數很簡單。主要是遞增usb_skel的kref,并把該結構體存入file的private_data中,以便其他函數(如read、write)調用。
在open函數中有個函數:
interface = usb_find_interface(&skel_driver, subminor);
我們在/linux/usb.c中找到它的定義,在/driver/usb/core/usb.c中找到對它的源碼:
/**
* usb_find_interface - find usb_interface pointer for driver and device
* @drv: the driver whose current configuration is considered
* @minor: the minor number of the desired device
*
* This walks the bus device list and returns a pointer to the interface
* with the matching minor and driver. Note, this only works for devices
* that share the USB major number.
*/
struct usb_interface *usb_find_interface(struct usb_driver *drv, int minor)
struct find_interface_arg argb;
struct device *dev;
argb.minor = minor;
argb.drv = &drv->drvwrap.driver;
dev = bus_find_device(&usb_bus_type, NULL, &argb, __find_interface);
/* Drop reference count from bus_find_device */
put_device(dev);
return dev ? to_usb_interface(dev) : NULL;
EXPORT_SYMBOL_GPL(usb_find_interface);
由于在open函數中,無法得到在prode函數中注冊的裝置的詳細資訊,而我們隻能得到注冊到接口的次裝置号(通過subminor = iminor(inode);)以及我們注冊的驅動skel_driver。
通過這個函數,周遊總線裝置清單,查找和我們的驅動與次裝置号比對的interface指針。
我們定義了find_interface_arg的結構argb,這個結構如下:
struct find_interface_arg {
int minor;
struct device_driver *drv;
我們把傳入參數的相關内容傳遞整合到這個結構體中,如15,16所示。18行就是通過疊代查找裝置,尋找我們需要的那個接口裝置。
(2)release函數
static int skel_release(struct inode *inode, struct file *file)
dev = (struct usb_skel *)file->private_data;
if (dev == NULL)
return -ENODEV;
/* decrement the count on our device */
release函數做一些清理工作,主要是把對裝置的引用計數減1,如果等于零的話,調用skel_delete函數。
#define to_skel_dev(d) container_of(d, struct usb_skel, kref)
static struct usb_driver skel_driver;
static void skel_delete(struct kref *kref)
struct usb_skel *dev = to_skel_dev(kref);
usb_put_dev(dev->udev);
kfree (dev->bulk_in_buffer);
kfree (dev);
5-12行,當引用計數的值(kref->recount)為0值,就會調用這個skel_delete函數,做相應的清理工作。
(3)write函數
說到usb子系統的IO操作,不得不說usb request block,簡稱urb。事實上,可以打一個這樣的比喻,usb總線就像一條高速公路,貨物、人流之類的可以看成是系統與裝置互動的資料,而urb就可以看成是汽車。在一開始對USB規範細節的介紹,我們就說過USB的endpoint有4種不同類型,也就是說能在這條高速公路上流動的資料就有四種。但是這對汽車是沒有要求的,是以urb可以運載四種資料,不過你要先告訴司機你要運什麼,目的地是什麼。我們現在就看看struct urb的具體内容。它的内容很多,為了不讓我的了解誤導各位,大家最好還是看一看核心源碼的注釋,具體内容參見源碼樹下include/linux/usb.h。
在這裡我們重點介紹程式中出現的幾個關鍵字段:
struct usb_device *dev
urb所發送的目标裝置。
unsigned int pipe
一個管道号碼,該管道記錄了目标裝置的端點以及管道的類型。每個管道隻有一種類型和一個方向,它與他的目标裝置的端點相對應,我們可以通過以下幾個函數來獲得管道号并設定管道類型:
unsigned int usb_sndctrlpipe(struct usb_device *dev, unsigned int endpoint)
把指定USB裝置的指定端點設定為一個控制OUT端點。
unsigned int usb_rcvctrlpipe(struct usb_device *dev, unsigned int endpoint)
把指定USB裝置的指定端點設定為一個控制IN端點。
unsigned int usb_sndbulkpipe(struct usb_device *dev, unsigned int endpoint)
把指定USB裝置的指定端點設定為一個批量OUT端點。
unsigned int usb_rcvbulkpipe(struct usb_device *dev, unsigned int endpoint)
把指定USB裝置的指定端點設定為一個批量OUT端點。
unsigned int usb_sndintpipe(struct usb_device *dev, unsigned int endpoint)
把指定USB裝置的指定端點設定為一個中斷OUT端點。
unsigned int usb_rcvintpipe(struct usb_device *dev, unsigned int endpoint)
把指定USB裝置的指定端點設定為一個中斷OUT端點。
unsigned int usb_sndisocpipe(struct usb_device *dev, unsigned int endpoint)
把指定USB裝置的指定端點設定為一個等時OUT端點。
unsigned int usb_rcvisocpipe(struct usb_device *dev, unsigned int endpoint)
把指定USB裝置的指定端點設定為一個等時OUT端點。
unsigned int transfer_flags
當不使用DMA時,應該transfer_flags |= URB_NO_TRANSFER_DMA_MAP(按照代碼的了解,希望沒有錯)。
int status
當一個urb把資料送到裝置時,這個urb會由系統傳回給驅動程式,并調用驅動程式的urb完成回調函數處理。這時,status記錄了這次資料傳輸的有關狀态,例如傳送成功與否。成功的話會是0。
要能夠運貨當然首先要有車,是以第一步當然要建立urb:
struct urb *usb_alloc_urb(int isoc_packets, int mem_flags);
第一個參數是等時包的數量,如果不是乘載等時包,應該為0,第二個參數與kmalloc的标志相同。
要釋放一個urb可以用:
void usb_free_urb(struct urb *urb);
要承載資料,還要告訴司機目的地資訊跟要運的貨物,對于不同的資料,系統提供了不同的函數,對于中斷urb,我們用
void usb_fill_int_urb(struct urb *urb, struct usb_device *dev, unsigned int pipe,
void *transfer_buffer, int buffer_length,
usb_complete_t complete, void *context, int interval);
這裡要解釋一下,transfer_buffer是一個要送/收的資料的緩沖,buffer_length是它的長度,complete是urb完成回調函數的入口,context由使用者定義,可能會在回調函數中使用的資料,interval就是urb被排程的間隔。
對于批量urb和控制urb,我們用:
void usb_fill_bulk_urb(struct urb *urb, struct usb_device *dev, unsigned int pipe,
void *transfer_buffer, int buffer_length, usb_complete_t complete,
void *context);
unsigned char* setup_packet,void *transfer_buffer,
int buffer_length, usb_complete_t complete,void *context);
控制包有一個特殊參數setup_packet,它指向即将被發送到端點的設定資料報的資料。
對于等時urb,系統沒有專門的fill函數,隻能對各urb字段顯示指派。
有了汽車,有了司機,下一步就是要開始運貨了,我們可以用下面的函數來送出urb
int usb_submit_urb(struct urb *urb, int mem_flags);
mem_flags有幾種:GFP_ATOMIC、GFP_NOIO、GFP_KERNEL,通常在中斷上下文環境我們會用GFP_ATOMIC。
當我們的卡車運貨之後,系統會把它調回來,并調用urb完成回調函數,并把這輛車作為函數傳遞給驅動程式。我們應該在回調函數裡面檢查status字段,以确定資料的成功傳輸與否。下面是用urb來傳送資料的細節。
/* initialize the urb properly */
usb_fill_bulk_urb(urb, dev->udev,
usb_sndbulkpipe(dev->udev, dev->bulk_out_endpointAddr),
buf, writesize, skel_write_bulk_callback, dev);
urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
/* send the data out the bulk port */
retval = usb_submit_urb(urb, GFP_KERNEL);
這裡skel_write_bulk_callback就是一個完成回調函數,而他做的主要事情就是檢查資料傳輸狀态和釋放urb:
dev = (struct usb_skel *)urb->context;
/* sync/async unlink faults aren't errors */
if (urb->status && !(urb->status = = -ENOENT || urb->status == -ECONNRESET || urb->status = = -ESHUTDOWN)) {
dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
/* free up our allocated buffer */
usb_buffer_free(urb->dev, urb->transfer_buffer_length,
urb->transfer_buffer, urb->transfer_dma);
(4)read函數
static ssize_t skel_read(struct file *file, char __user *buffer, size_t count, loff_t *ppos)
dev = (struct usb_skel *)file->private_data; //擷取裝置的資訊
/* do a blocking bulk read to get data from the device */
retval = usb_bulk_msg(dev->udev,
usb_rcvbulkpipe(dev->udev, dev->bulk_in_endpointAddr),
dev->bulk_in_buffer,
min(dev->bulk_in_size, count),
&count, HZ*10);
/* if the read was successful, copy the data to userspace */
if (!retval) {
if (copy_to_user(buffer, dev->bulk_in_buffer, count))
retval = -EFAULT;
else
retval = count;
這個read函數,就是擷取裝置的資訊(6行)以及讀裝置的資訊,傳送到使用者空間(copy_to_user成功傳回0,失敗傳回沒有成功拷貝的位元組數)。
值得我們看是8-13行。
/* do a blocking bulk read to get data from the device */
retval = usb_bulk_msg(dev->udev, //需要發送的裝置
usb_rcvbulkpipe(dev->udev, dev->bulk_in_endpointAddr), //設定端點的資訊
dev->bulk_in_buffer, //緩存的位置
min(dev->bulk_in_size, count), //緩存的大小
&count, HZ*10); //實際傳送資料的大小,以及阻塞逾時時間
程式使用了usb_bulk_msg來傳送資料,它的原型如下:
int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,void *data,
int len, int *actual length, int timeout)
這個函數會阻塞等待資料傳輸完成或者等到逾時,data是輸入/輸出緩沖,len是它的大小,actual length是實際傳送的資料大小,timeout是阻塞逾時。如果成功傳回0,失敗傳回一個負的錯誤值
介紹下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用來接受資料。
本文轉自張昺華-sky部落格園部落格,原文連結:http://www.cnblogs.com/sky-heaven/p/5068833.html,如需轉載請自行聯系原作者