Linux-USB驱动笔记（八）--Gadget Function驱动

r囧r小猫 2022-09-11 06:22 565阅读 0赞

### Linux-USB驱动笔记（八）--Gadget Function驱动 ###

*  1、前言
 *  2、Gadget Function 驱动
 *   *  2.1、usb\_function -- 配置的一个功能
     *  2.2、usb\_request -- I/O请求
     *  2.3、usb\_function\_driver
 *  3、API函数

# 1、前言 #

在[Linux-USB驱动笔记（四）–USB整体框架][Linux-USB_USB]中有説到Gadget Function驱动，下面我们来具体看一下。

Gadget Function就是指设备的功能，比如作为U盘，需要文件存储的功能，则需要File Storage驱动，这个驱动也称为Function驱动。

# 2、Gadget Function 驱动 #

Function驱动只是利用通用的API，并通过usb\_request与底层UDC驱动交互。

Gadget Function 驱动相关的代码位于 /drivers/usb/gadget/function 目录下。

## 2.1、usb\_function – 配置的一个功能 ##

struct usb_function { 
      const char      *name;
      struct usb_gadget_strings  **strings;
      struct usb_descriptor_header  **fs_descriptors; //全速和低速描述符表
      struct usb_descriptor_header  **hs_descriptors; //高速描述符表
      struct usb_descriptor_header  **ss_descriptors; //超高速描述符表
      struct usb_descriptor_header  **ssp_descriptors;//超高速加描述符表
    
      struct usb_configuration  *config; //usb配置
    
      struct usb_os_desc_table  *os_desc_table;
      unsigned      os_desc_n;
    
    
      /* 配置管理: bind/unbind */
       // gadget注册前绑定资源(接口标识，类描述符，端点，IO缓存)
      int      (*bind)(struct usb_configuration *,
              struct usb_function *);
      void      (*unbind)(struct usb_configuration *,
              struct usb_function *);
      void      (*free_func)(struct usb_function *f);
      struct module    *mod;
    
      /* 运行状态管理 */
      int      (*set_alt)(struct usb_function *,
              unsigned interface, unsigned alt);
      int      (*get_alt)(struct usb_function *,
              unsigned interface);
      void      (*disable)(struct usb_function *);
      int      (*setup)(struct usb_function *,
              const struct usb_ctrlrequest *);
      bool      (*req_match)(struct usb_function *,
              const struct usb_ctrlrequest *,
              bool config0);
      void      (*suspend)(struct usb_function *);
      void      (*resume)(struct usb_function *);
    
      /* USB 3.0 附加 */
      int      (*get_status)(struct usb_function *);
      int      (*func_suspend)(struct usb_function *,
                u8 suspend_opt);
      /* private: */
      /* internals */
      struct list_head    list;
      DECLARE_BITMAP(endpoints, 32);
      const struct usb_function_instance *fi;
    
      unsigned int    bind_deactivated:1;
    };

重要字段及其含义如下：

<table> 
 <thead> 
  <tr> 
   <th>字段</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>struct usb_descriptor_header **fs_descriptors;</td> 
   <td>全速和低速描述符表</td> 
  </tr> 
  <tr> 
   <td>struct usb_descriptor_header **hs_descriptors;</td> 
   <td>高速描述符表</td> 
  </tr> 
  <tr> 
   <td>struct usb_descriptor_header **ss_descriptors;</td> 
   <td>超高速描述符表</td> 
  </tr> 
  <tr> 
   <td>struct usb_descriptor_header **ssp_descriptors;</td> 
   <td>超高速加描述符表</td> 
  </tr> 
  <tr> 
   <td>struct usb_configuration *config;</td> 
   <td>usb配置</td> 
  </tr> 
 </tbody> 
</table>

## 2.2、usb\_request – I/O请求 ##

struct usb_request { 
      void      *buf;
      unsigned    length;
      dma_addr_t    dma;
    
      struct scatterlist  *sg;
      unsigned    num_sgs;
      unsigned    num_mapped_sgs;
    
      unsigned    stream_id:16;
      unsigned    no_interrupt:1;
      unsigned    zero:1;
      unsigned    short_not_ok:1;
      unsigned    dma_mapped:1;
    
      void      (*complete)(struct usb_ep *ep,
              struct usb_request *req);
      void      *context;
      struct list_head  list;
    
      int      status;
      unsigned    actual;
    };

在Gadget驱动中，用usb\_request结构体来描述一次传输请求。这个和主机侧的URB类似，只是它更轻量，可以有更多的预分配。

## 2.3、usb\_function\_driver ##

struct usb_function_driver { 
      const char *name;
      struct module *mod;
      struct list_head list;
      struct usb_function_instance *(*alloc_inst)(void);
      struct usb_function *(*alloc_func)(struct usb_function_instance *inst);
    };

和platform\_driver类似，用来注册usb\_function驱动。

# 3、API函数 #

<table> 
 <thead> 
  <tr> 
   <th>API</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>int usb_function_register(struct usb_function_driver *newf)</td> 
   <td>注册usb_function_driver（只是把usb_function_driver加入func_list链表）</td> 
  </tr> 
  <tr> 
   <td>void usb_function_unregister(struct usb_function_driver *fd)</td> 
   <td>注销usb_function_driver</td> 
  </tr> 
  <tr> 
   <td>int usb_add_function(struct usb_configuration *, struct usb_function *);</td> 
   <td>添加一个功能到配置</td> 
  </tr> 
  <tr> 
   <td>void usb_remove_function(struct usb_configuration *c, struct usb_function *f)</td> 
   <td>从配置中移除功能</td> 
  </tr> 
  <tr> 
   <td>int usb_ep_enable(struct usb_ep *ep);</td> 
   <td>使能端点</td> 
  </tr> 
  <tr> 
   <td>int usb_ep_disable(struct usb_ep *ep);</td> 
   <td>禁用端点</td> 
  </tr> 
  <tr> 
   <td>struct usb_request *usb_ep_alloc_request(struct usb_ep *ep, gfp_t gfp_flags);</td> 
   <td>分配usb_request</td> 
  </tr> 
  <tr> 
   <td>void usb_ep_free_request(struct usb_ep *ep, struct usb_request *req);</td> 
   <td>释放usb_request</td> 
  </tr> 
  <tr> 
   <td>struct usb_request *alloc_ep_req(struct usb_ep *ep, size_t len);</td> 
   <td>分配usb_request</td> 
  </tr> 
  <tr> 
   <td>int usb_ep_queue(struct usb_ep *ep,struct usb_request *req, gfp_t gfp_flags);</td> 
   <td>提交usb_request</td> 
  </tr> 
  <tr> 
   <td>int usb_ep_dequeue(struct usb_ep *ep, struct usb_request *req);</td> 
   <td>取消usb_request</td> 
  </tr> 
  <tr> 
   <td>int usb_ep_fifo_status(struct usb_ep *ep)</td> 
   <td>返回端点FIFO字节数</td> 
  </tr> 
  <tr> 
   <td>void usb_ep_fifo_flush(struct usb_ep *ep)</td> 
   <td>刷新FIFO数据</td> 
  </tr> 
  <tr> 
   <td>struct usb_ep *usb_ep_autoconfig(struct usb_gadget *,struct usb_endpoint_descriptor *);</td> 
   <td>端点自动配置</td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <thead> 
  <tr> 
   <th>函数</th> 
   <th>实现</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>usb_ep_enable</td> 
   <td>最终调用 ep-&gt;ops-&gt;enable(ep, desc);</td> 
  </tr> 
  <tr> 
   <td>usb_ep_disable</td> 
   <td>最终调用 ep-&gt;ops-&gt;disable(ep, desc);</td> 
  </tr> 
  <tr> 
   <td>usb_ep_alloc_request</td> 
   <td>最终调用 ep-&gt;ops-&gt;alloc_request(ep, gfp_flags);</td> 
  </tr> 
  <tr> 
   <td>usb_ep_free_request</td> 
   <td>最终调用 ep-&gt;ops-&gt;free_request(ep, req);</td> 
  </tr> 
  <tr> 
   <td>usb_ep_queue 最终调用</td> 
   <td>ep-&gt;ops-&gt;queue(ep, req, gfp_flags);</td> 
  </tr> 
  <tr> 
   <td>usb_ep_dequeue</td> 
   <td>最终调用 ep-&gt;ops-&gt;dequeue(ep, req);</td> 
  </tr> 
 </tbody> 
</table>

上面这些通用的API都是调用到UDC驱动中的函数，然后进行硬件操作。

USB驱动框架到此就结束了。

[Linux-USB_USB]: https://blog.csdn.net/weixin_45309916/article/details/119979199