urb分析，usb_fill_bulk_urb函数理解

usb request block，简称urb。事实上，可以打一个这样的比喻，usb总线就像一条高速公路，货物、人流之类的可以看成是系统与设备交互的数据，而urb就可以看成是汽车。在一开始对USB规范细节的介绍，我们就说过USB的endpoint有4种不同类型，也就是说能在这条高速公路上流动的数据就有四种。但是这对汽车是没有要求的，所以urb可以运载四种数据，不过你要先告诉司机你要运什么，目的地是什么。我们现在就看看struct urb的具体内容。它的内容很多，为了不让我的理解误导各位，大家最好还是看一看内核源码的注释，具体内容参见源码树下include/linux/usb.h。

int status

     当一个urb把数据送到设备时，这个urb会由系统返回给驱动程序，并调用驱动程序的urb完成回调函数处理。这时，status记录了这次数据传输的有关状态，例如传送成功与否。成功的话会是0。（urb->status）

   要能够运货当然首先要有车，所以第一步当然要创建urb：

    struct urb *usb_alloc_urb(int isoc_packets, int mem_flags);

     第一个参数是等时包的数量，如果不是乘载等时包，应该为0，第二个参数与kmalloc的标志相同。
    参考：http://lxr.free-electrons.com/source/drivers/usb/core/urb.c#L301
    usb_alloc_urb函数实现分析：http://blog.csdn.net/fudan_abc/article/details/1825017

[cpp] view plaincopy

1. 48 /** 
2. 49  * usb_alloc_urb - creates a new urb for a USB driver to use 
3. 50  * @iso_packets: number of iso packets for this urb 
4. 51  * @mem_flags: the type of memory to allocate, see kmalloc() for a list of 
5. 52  *      valid options for this. 
6. 53  * 
7. 54  * Creates an urb for the USB driver to use, initializes a few internal 
8. 55  * structures, incrementes the usage counter, and returns a pointer to it. 
9. 56  * 
10. 57  * If no memory is available, NULL is returned. 
11. 58  * 
12. 59  * If the driver want to use this urb for interrupt, control, or bulk 
13. 60  * endpoints, pass '' as the number of iso packets. 
14. 61  * 
15. 62  * The driver must call usb_free_urb() when it is finished with the urb. 
16. 63  */  
17. 64 struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags)  
18. 65 {  
19. 66         struct urb *urb;  
20. 67   
21. 68         urb = kmalloc(sizeof(struct urb) +  
22. 69                 iso_packets * sizeof(struct usb_iso_packet_descriptor),  
23. 70                 mem_flags);  
24. 71         if (!urb) {  
25. 72                 printk(KERN_ERR "alloc_urb: kmalloc failed\n");  
26. 73                 return NULL;  
27. 74         }  
28. 75         usb_init_urb(urb);  
29. 76         return urb;  
30. 77 }  

     要释放一个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);

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

     控制包有一个特殊参数setup_packet，它指向即将被发送到端点的设置数据报的数据。

     其中，usb_fill_bulk_urb()定义于include/linux/usb.h:

[cpp] view plaincopy

1. /** 
2.  * usb_fill_bulk_urb - macro to help initialize a bulk urb 
3.  * @urb: pointer to the urb to initialize. 
4.  * @dev: pointer to the struct usb_device for this urb. 
5.  * @pipe: the endpoint pipe 
6.  * @transfer_buffer: pointer to the transfer buffer 
7.  * @buffer_length: length of the transfer buffer 
8.  * @complete_fn: pointer to the usb_complete_t function 
9.  * @context: what to set the urb context to. 
10.  * 
11.  * Initializes a bulk urb with the proper information needed to submit it 
12.  * to a device. 
13.  */  
14. static inline void usb_fill_bulk_urb(struct urb *urb,  
15.                      struct usb_device *dev,  
16.                      unsigned int pipe,  
17.                      void *transfer_buffer,  
18.                      int buffer_length,  
19.                      usb_complete_t complete_fn,  
20.                      void *context)  
21. {  
22.     urb->dev = dev;  
23.     urb->pipe = pipe;  
24.     urb->transfer_buffer = transfer_buffer;  
25.     urb->transfer_buffer_length = buffer_length;  
26.     urb->complete = complete_fn;  
27.     urb->context = context;  
28. }  

    urb参数指向要被初始化的urb的指针；

    dev指向这个urb要被发送到哪个USB设备，即目标设备；

    pipe是这个urb要被发送到的USB设备的特定端点，pipe使用usb_sndbulkpipe()或者usb_rcvbulkpipe()函数来创建。

[cpp] view plaincopy

1. unsigned int pipe  
2.      一个管道号码，该管道记录了目标设备的端点以及管道的类型。每个管道只有一种类型和一个方向，它与他的目标设备的端点相对应，我们可以通过以下几个函数来获得管道号并设置管道类型：  
3.      unsigned int usb_sndctrlpipe(struct usb_device *dev, unsigned int endpoint)  
4.            把指定USB设备的指定端点设置为一个控制OUT端点。  
5.      unsigned int usb_rcvctrlpipe(struct usb_device *dev, unsigned int endpoint)  
6.            把指定USB设备的指定端点设置为一个控制IN端点。  
7.      unsigned int usb_sndbulkpipe(struct usb_device *dev, unsigned int endpoint)  
8.            把指定USB设备的指定端点设置为一个批量OUT端点。 /* <span style="font-family:宋体;">把数据从批量</span><span style="font-family:Times New Roman;">OUT</span><span style="font-family:宋体;">端口发出 </span><span style="font-family:Times New Roman;"&gt;*/</span>  
9.      unsigned int usb_rcvbulkpipe(struct usb_device *dev, unsigned int endpoint)  
10.            把指定USB设备的指定端点设置为一个批量IN端点。  
11.      unsigned int usb_sndintpipe(struct usb_device *dev, unsigned int endpoint)  
12.          把指定USB设备的指定端点设置为一个中断OUT端点。  
13.      unsigned int usb_rcvintpipe(struct usb_device *dev, unsigned int endpoint)  
14.            把指定USB设备的指定端点设置为一个中断IN端点。  
15.      unsigned int usb_sndisocpipe(struct usb_device *dev, unsigned int endpoint)  
16.            把指定USB设备的指定端点设置为一个等时OUT端点。  
17.      unsigned int usb_rcvisocpipe(struct usb_device *dev, unsigned int endpoint)  
18.            把指定USB设备的指定端点设置为一个等时IN端点。   

    transfer_buffer是指向发送数据或接收数据的缓冲区的指针，和urb一样，它也不能是静态缓冲区，必须使用kmalloc()来分配；

    buffer_length是transfer_buffer指针所指向缓冲区的大小；

    complete指针指向当这个 urb完成时被调用的完成处理函数；

    context是完成处理函数的“上下文”；

    函数主要完成：初始化urb，被安排给一个特定USB设备的特定端点。然后可通过函数usb_submit_urb()提交给usb核心。

详细可参考：http://book.51cto.com/art/200803/66930.htm

有了汽车，有了司机，下一步就是要开始运货了，我们可以用下面的函数来提交urb

    int usb_submit_urb(struct urb *urb, int mem_flags);

    mem_flags有几种：GFP_ATOMIC、GFP_NOIO、GFP_KERNEL，通常在中断上下文环境我们会用GFP_ATOMIC。

    当我们的卡车运货之后，系统会把它调回来，并调用urb完成回调函数，并把这辆车作为函数传递给驱动程序。我们应该在回调函数里面检查status字段，以确定数据的成功传输与否。下面是用urb来传送数据的细节。

[cpp] view plaincopy

1. /* initialize the urb properly */  
2. usb_fill_bulk_urb(urb, dev->udev,  
3.                     usb_sndbulkpipe(dev->udev, dev->bulk_out_endpointAddr),  
4.                    buf, writesize, skel_write_bulk_callback, dev);  
5. urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;  
6. /* send the data out the bulk port */  
7. retval = usb_submit_urb(urb, GFP_KERNEL);   

     这里skel_write_bulk_callback就是一个完成回调函数，而他做的主要事情就是检查数据传输状态和释放urb：

[cpp] view plaincopy

1. /*当urb被成功传输到USB设备之后，urb回调函数将被USB核心调用，在我们的例子中，我们初始化urb，使它指向skel_write_bulk_callback函数*/  
2.   
3. static void skel_write_bulk_callback(struct urb *urb)  
4.   
5. {  
6.         struct usb_skel *dev;  
7.         dev = (struct usb_skel *)urb->context;  
8.   
9.         /* sync/async unlink faults aren't errors */  
10.         if (urb->status && !(urb->status == -ENOENT || urb->status == -ECONNRESET || urb->status == -ESHUTDOWN)) {  
11.                 err("%s - nonzero write bulk status received: %d",  
12.                  __FUNCTION__, urb->status);  
13.         }  
14.   
15.         / * free up our allocated buffer */  
16.         usb_buffer_free(urb->dev, urb->transfer_buffer_length,  
17.         urb->transfer_buffer, urb->transfer_dma);  
18.         up(&dev->limit_sem);  
19. }  

    对于驱动来说，usb_submit_urb是异步的，也就是说不用等传输完全完成就返回了，只要usb_submit_urb的返回值表示为0，就表示已经提交成功了，你的urb已经被core和HCD认可了，接下来core和HCD怎么处理就是它们的事了，驱动该干吗干吗去   只要你提交成功了，不管是中间出了差错还是顺利完成，你指定的结束处理函数总是会调用，只有到这个时候，你才能够重新拿到urb的控制权，检查它是不是出错了，需要不需要释放或者是重新提交。