Linux USB驅(qū)動(dòng)框架分析(六)
說(shuō)的usb子系統(tǒng)的IO操作,不得不說(shuō)usb requestblock,簡(jiǎn)稱urb。事實(shí)上,可以打一個(gè)這樣的比喻,usb總線就像一條高速公路,貨物、人流之類的可以看成是系統(tǒng)與設(shè)備交互的數(shù)據(jù),而urb就可以看成是交通工具。在一開(kāi)始對(duì)USB規(guī)范細(xì)節(jié)的介紹,我們就說(shuō)過(guò)USB的endpoint有4種不同類型,于是能在這條高速公路上流動(dòng)的數(shù)據(jù)也就有四種。但對(duì)車是沒(méi)有要求的,urb可以運(yùn)載四種數(shù)據(jù),不過(guò)你要先告訴司機(jī)你要運(yùn)什么,目的地是什么。我們現(xiàn)在就看看structurb的具體內(nèi)容。它的內(nèi)容很多,為了不讓我的理解誤導(dǎo)各位,大家最好還是看一看內(nèi)核源碼的注釋,具體內(nèi)容參見(jiàn)源碼樹(shù)下include/linux/usb.h。
在這里我們重點(diǎn)介紹程序中出現(xiàn)的幾個(gè)關(guān)鍵字段:
struct usb_device *dev
urb所發(fā)送的目標(biāo)設(shè)備。
unsigned int pipe
???? 一個(gè)管道號(hào)碼,該管道記錄了目標(biāo)設(shè)備的端點(diǎn)以及管道的類型。每個(gè)管道只有一種類型和一個(gè)方向,它與他的目標(biāo)設(shè)備的端點(diǎn)向?qū)?yīng),我們可以通過(guò)以下幾個(gè)函數(shù)來(lái)獲得管道號(hào)并設(shè)置管道類型:
???? unsigned int usb_sndctrlpipe(struct usb_device *dev, unsigned int endpoint)
???????? 把指定USB設(shè)備指定端點(diǎn)設(shè)置為一個(gè)控制OUT端點(diǎn)。
???? unsigned int usb_rcvctrlpipe(struct usb_device *dev, unsigned int endpoint)
???????? 把指定USB設(shè)備指定端點(diǎn)設(shè)置為一個(gè)控制IN端點(diǎn)。
???? unsigned int usb_sndbulkpipe(struct usb_device *dev, unsigned int endpoint)
???????? 把指定USB設(shè)備指定端點(diǎn)設(shè)置為一個(gè)批量OUT端點(diǎn)。
???? unsigned int usb_rcvbulkpipe(struct usb_device *dev, unsigned int endpoint)
???????? 把指定USB設(shè)備指定端點(diǎn)設(shè)置為一個(gè)批量OUT端點(diǎn)。
???? unsigned int usb_sndintpipe(struct usb_device *dev, unsigned int endpoint)
???????? 把指定USB設(shè)備指定端點(diǎn)設(shè)置為一個(gè)中斷OUT端點(diǎn)。
???? unsigned int usb_rcvintpipe(struct usb_device *dev, unsigned int endpoint)
???????? 把指定USB設(shè)備指定端點(diǎn)設(shè)置為一個(gè)中斷OUT端點(diǎn)。
???? unsigned int usb_sndisocpipe(struct usb_device *dev, unsigned int endpoint)
???????? 把指定USB設(shè)備指定端點(diǎn)設(shè)置為一個(gè)等時(shí)OUT端點(diǎn)。
???? unsigned int usb_rcvisocpipe(struct usb_device *dev, unsigned int endpoint)
???????? 把指定USB設(shè)備指定端點(diǎn)設(shè)置為一個(gè)等時(shí)OUT端點(diǎn)。
unsigned int transfer_flags
當(dāng)不使用DMA時(shí),應(yīng)該transfer_flags |= URB_NO_TRANSFER_DMA_MAP(按照代碼的理解,希望沒(méi)有錯(cuò))。
Int status
???? 當(dāng)一個(gè)urb把數(shù)據(jù)送到設(shè)備時(shí),這個(gè)urb會(huì)由系統(tǒng)返回給驅(qū)動(dòng)程序,并調(diào)用驅(qū)動(dòng)程序的urb完成回調(diào)函數(shù)處理。這時(shí),status記錄了這次數(shù)據(jù)傳輸?shù)挠嘘P(guān)狀態(tài),例如傳送成功與否。成功的話會(huì)是0。
???? 要能夠運(yùn)貨當(dāng)然首先要有車,所以第一步當(dāng)然要?jiǎng)?chuàng)建urb:
???? struct urb *usb_alloc_urb(int isoc_packets, int mem_flags);
???? 第一個(gè)參數(shù)是等時(shí)包的數(shù)量,如果不是乘載等時(shí)包,應(yīng)該為0,第二個(gè)參數(shù)與kmalloc的標(biāo)志相同。
???? 要釋放一個(gè)urb可以用:
???? void usb_free_urb(struct urb *urb);
???? 要承載數(shù)據(jù),還要告訴司機(jī)目的地信息跟要運(yùn)的貨物,對(duì)于不同的數(shù)據(jù),系統(tǒng)提供了不同的函數(shù),對(duì)于中斷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是一要送/收的數(shù)據(jù)的緩沖,buffer_length是它的長(zhǎng)度,complete是urb完成回調(diào)函數(shù)的入口,context有用戶定義,可能會(huì)在回調(diào)函數(shù)中使用的數(shù)據(jù),interval就是urb被調(diào)度的間隔。
???? 對(duì)于批量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);
void usb_fill_bulk_urb(struct urb *urb, struct usb_device *dev, unsigned int pipe,
??????????????????????????? unsigned char* setup_packet,void *transfer_buffer,
int buffer_length, usb_complete_t complete,void *context);
控制包有一個(gè)特殊參數(shù)setup_packet,它指向即將被發(fā)送到端點(diǎn)的設(shè)置數(shù)據(jù)報(bào)的數(shù)據(jù)。
對(duì)于等時(shí)urb,系統(tǒng)沒(méi)有專門的fill函數(shù),只能對(duì)各urb字段顯示賦值。
有了汽車,有了司機(jī),下一步就是要開(kāi)始運(yùn)貨了,我們可以用下面的函數(shù)來(lái)提交urb
???? int usb_submit_urb(struct urb *urb, int mem_flags);
mem_flags有幾種:GFP_ATOMIC、GFP_NOIO、GFP_KERNEL,通常在中斷上下文環(huán)境我們會(huì)用GFP_ATOMIC。
當(dāng)我們的卡車運(yùn)貨之后,系統(tǒng)會(huì)把它調(diào)回來(lái),并調(diào)用urb完成回調(diào)函數(shù),并把這輛車作為函數(shù)傳遞給驅(qū)動(dòng)程序。我們應(yīng)該在回調(diào)函數(shù)里面檢查status字段,以確定數(shù)據(jù)的成功傳輸與否。下面是用urb來(lái)傳送數(shù)據(jù)的細(xì)節(jié)。
???? /* 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就是一個(gè)完成回調(diào)函數(shù),而他做的主要事情就是檢查數(shù)據(jù)傳輸狀態(tài)和釋放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);
事實(shí)上,如果數(shù)據(jù)的量不大,那么可以不一定用卡車來(lái)運(yùn)貨,系統(tǒng)還提供了一種不用urb的傳輸方式,而usb-skeleton的讀操作正是采用這種方式實(shí)現(xiàn):
???? /* 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),
????????????? ????? &bytes_read, 10000);
?
???? /* if the read was successful, copy the data to userspace */
???? if (!retval) {
???????? if (copy_to_user(buffer, dev->bulk_in_buffer, bytes_read))
????????????? retval = -EFAULT;
???????? else
????????????? retval = bytes_read;
???? }
程序使用了usb_bulk_msg來(lái)傳送數(shù)據(jù),它的原型如下:
???? int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,void *data,
int len, int *actual length, int timeout)
???? 這個(gè)函數(shù)會(huì)阻塞等待數(shù)據(jù)傳輸完成或者等到超時(shí),data是輸入/輸出緩沖,len是它的大小,actual length是實(shí)際傳送的數(shù)據(jù)大小,timeout是阻塞超時(shí)。
???? 對(duì)于控制數(shù)據(jù),系統(tǒng)提供了另外一個(gè)函數(shù),他的原型是:
???????? Int usb_contrl_msg(struct usb_device *dev, unsigned int pipe, __u8 request,
??????????????????????????? __u8 requesttype, __u16 value, __u16 index, void *data,
??????????????????????????? __u16 size, int timeout);
Request是控制消息的USB請(qǐng)求值、requesttype是控制消息的USB請(qǐng)求類型,value是控制消息的USB消息值,index是控制消息的USB消息索引。具體是什么,暫時(shí)不是很清楚,希望大家提供說(shuō)明。
至此,Linux下的USB驅(qū)動(dòng)框架分析基本完成了。