Files
luban-lite-t3e-pro/doc/topics/sdk/usb/usb-host-interface-driver_struct_usb_driver.html
2025-01-23 16:37:00 +08:00

364 lines
22 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="zh-cn" lang="zh-cn" data-whc_version="26.0">
<head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta name="description" content="USB Interface 这一层次的驱动就非常的多了,这一层主要是在 USB 传输层之上,针对 USB Device 的某个功能 Function 开发对应的 USB 功能业务驱动,即常说的 USB Client Software 。在 USB 定义中,一个 Interface 就是一个 Function 。 USB Interface Driver 对应的数据结构为 struct ..."/><meta name="DC.rights.owner" content="(C) 版权 2025"/><meta name="copyright" content="(C) 版权 2025"/><meta name="generator" content="DITA-OT"/><meta name="DC.type" content="concept"/><meta name="DC.contributor" content="yan.wang"/><meta name="DC.date.modified" content="2024-01-31"/><meta name="DC.format" content="HTML5"/><meta name="DC.identifier" content="usb_host_interface_driver_struct_usb_driver"/><meta name="DC.language" content="zh-CN"/><title>Driver (struct usb_driver)</title><!-- Build number 2023110923. --><meta name="wh-path2root" content="../../../"/><meta name="wh-toc-id" content=""/><meta name="wh-source-relpath" content="topics/sdk/usb/usb-host-interface-driver_struct_usb_driver.dita"/><meta name="wh-out-relpath" content="topics/sdk/usb/usb-host-interface-driver_struct_usb_driver.html"/>
<link rel="stylesheet" type="text/css" href="../../../webhelp/app/commons.css?buildId=2023110923"/>
<link rel="stylesheet" type="text/css" href="../../../webhelp/app/topic.css?buildId=2023110923"/>
<script src="../../../webhelp/app/options/properties.js?buildId=20250121171154"></script>
<script src="../../../webhelp/app/localization/strings.js?buildId=2023110923"></script>
<script src="../../../webhelp/app/search/index/keywords.js?buildId=20250121171154"></script>
<script defer="defer" src="../../../webhelp/app/commons.js?buildId=2023110923"></script>
<script defer="defer" src="../../../webhelp/app/topic.js?buildId=2023110923"></script>
<link rel="stylesheet" type="text/css" href="../../../webhelp/template/aic-styles-web.css?buildId=2023110923"/><link rel="stylesheet" type="text/css" href="../../../webhelp/template/notes.css?buildId=2023110923"/><link rel="stylesheet" type="text/css" href="../../../webhelp/template/aic-common.css?buildId=2023110923"/><link rel="stylesheet" type="text/css" href="../../../webhelp/template/aic-images.css?buildId=2023110923"/><link rel="stylesheet" type="text/css" href="../../../webhelp/template/footnote.css?buildId=2023110923"/><link rel="stylesheet" type="text/css" href="../../../webhelp/template/aic-web-watermark.css?buildId=2023110923"/><link rel="stylesheet" type="text/css" href="../../../webhelp/template/topic-body-list.css?buildId=2023110923"/></head>
<body id="usb_host_interface_driver_struct_usb_driver" class="wh_topic_page frmBody">
<a href="#wh_topic_body" class="sr-only sr-only-focusable">
跳转到主要内容
</a>
<header class="navbar navbar-default wh_header">
<div class="container-fluid">
<div class="wh_header_flex_container navbar-nav navbar-expand-md navbar-dark">
<div class="wh_logo_and_publication_title_container">
<div class="wh_logo_and_publication_title">
<a href="http://www.artinchip.com" class=" wh_logo d-none d-sm-block "><img src="../../../company-logo-white.png" alt="RTOS SDK 使用指南SDK 指南文件"/></a>
<div class=" wh_publication_title "><a href="../../../index.html"><span class="booktitle"><span class="ph mainbooktitle">RTOS SDK 使用指南</span><span class="ph booktitlealt">SDK 指南文件</span></span></a></div>
</div>
</div>
<div class="wh_top_menu_and_indexterms_link collapse navbar-collapse" id="wh_top_menu_and_indexterms_link">
</div>
</div>
</div>
</header>
<div class=" wh_search_input navbar-form wh_topic_page_search search " role="form">
<form id="searchForm" method="get" role="search" action="../../../search.html"><div><input type="search" placeholder="搜索 " class="wh_search_textfield" id="textToSearch" name="searchQuery" aria-label="搜索查询" required="required"/><button type="submit" class="wh_search_button" aria-label="搜索"><span class="search_input_text">搜索</span></button></div></form>
</div>
<div class="container-fluid" id="wh_topic_container">
<div class="row">
<nav class="wh_tools d-print-none navbar-expand-md" aria-label="Tools">
<div data-tooltip-position="bottom" class=" wh_breadcrumb "></div>
<div class="wh_right_tools">
<button class="wh_hide_highlight" aria-label="切换搜索突出显示" title="切换搜索突出显示"></button>
<button class="webhelp_expand_collapse_sections" data-next-state="collapsed" aria-label="折叠截面" title="折叠截面"></button>
<div class=" wh_print_link print d-none d-md-inline-block "><button onClick="window.print()" title="打印此页" aria-label="打印此页"></button></div>
</div>
</nav>
</div>
<div class="wh_content_area">
<div class="row">
<div class="col-12" id="wh_topic_body">
<div class=" wh_topic_content body "><main role="main"><article class="- topic/topic concept/concept topic concept" role="article" aria-labelledby="ariaid-title1"><span class="edit-link" style="font-size:12px; opacity:0.6; text-align:right; vertical-align:middle"><a target="_blank" href="http://172.16.35.88/tasks/jdssno1uvvbf2mltu9kb9v3if05d5gopuakboe8hlud18rma/edit/F:/aicdita/aicdita-cn/topics/sdk/usb/usb-host-interface-driver_struct_usb_driver.dita">Edit online</a></span><h1 class="- topic/title title topictitle1" id="ariaid-title1">Driver (struct usb_driver)</h1><div class="date inPage">31 Jan 2024</div><div style="color: gray;">
Read time: 6 minute(s)
</div><div class="- topic/body concept/conbody body conbody"><p class="- topic/p p" data-ofbid="d105671e22__20250121171540"><code class="+ topic/ph pr-d/codeph ph codeph">USB Interface</code> 这一层次的驱动就非常的多了,这一层主要是在 USB 传输层之上,针对 USB Device 的某个功能
<code class="+ topic/ph pr-d/codeph ph codeph">Function</code> 开发对应的 USB 功能业务驱动,即常说的 <code class="+ topic/ph pr-d/codeph ph codeph">USB Client
Software</code>。在 USB 定义中,一个 <code class="+ topic/ph pr-d/codeph ph codeph">Interface</code> 就是一个
<code class="+ topic/ph pr-d/codeph ph codeph">Function</code></p><div class="- topic/p p" data-ofbid="d105671e38__20250121171540"><code class="+ topic/ph pr-d/codeph ph codeph">USB Interface</code> Driver 对应的数据结构为 <code class="+ topic/ph pr-d/codeph ph codeph">struct usb_driver</code> ,使用
<code class="+ topic/ph pr-d/codeph ph codeph">usb_register_driver()</code>
函数进行注册:<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="usb_host_interface_driver_struct_usb_driver__pre_ums_14z_21c" data-ofbid="usb_host_interface_driver_struct_usb_driver__pre_ums_14z_21c"><strong class="hl-keyword">int</strong> usb_register_driver(<strong class="hl-keyword">struct</strong> usb_driver *new_driver, <strong class="hl-keyword">struct</strong> module *owner,
<strong class="hl-keyword">const</strong> <strong class="hl-keyword">char</strong> *mod_name)
{
<em class="hl-comment">/* (1) 设置 devices 标志为 0表面这个驱动时给 usb interface 使用的 */</em>
new_driver-&gt;drvwrap.for_devices = <span class="hl-number">0</span>;
new_driver-&gt;drvwrap.driver.name = new_driver-&gt;name;
new_driver-&gt;drvwrap.driver.bus = &amp;usb_bus_type;
new_driver-&gt;drvwrap.driver.probe = usb_probe_interface;
new_driver-&gt;drvwrap.driver.remove = usb_unbind_interface;
new_driver-&gt;drvwrap.driver.owner = owner;
new_driver-&gt;drvwrap.driver.mod_name = mod_name;
new_driver-&gt;drvwrap.driver.dev_groups = new_driver-&gt;dev_groups;
spin_lock_init(&amp;new_driver-&gt;dynids.lock);
INIT_LIST_HEAD(&amp;new_driver-&gt;dynids.list);
retval = driver_register(&amp;new_driver-&gt;drvwrap.driver);
}
</pre></div><div class="- topic/p p" data-ofbid="d105671e50__20250121171540">一个最简单的 <code class="+ topic/ph pr-d/codeph ph codeph">Usb Interface Driver</code><code class="+ topic/ph pr-d/codeph ph codeph">usb_mouse_driver</code>
:<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="usb_host_interface_driver_struct_usb_driver__codeblock_ors_24z_21c" data-ofbid="usb_host_interface_driver_struct_usb_driver__codeblock_ors_24z_21c"><strong class="hl-keyword">static</strong> <strong class="hl-keyword">const</strong> <strong class="hl-keyword">struct</strong> usb_device_id usb_mouse_id_table[] = {
{ USB_INTERFACE_INFO(USB_INTERFACE_CLASS_HID, USB_INTERFACE_SUBCLASS_BOOT,
USB_INTERFACE_PROTOCOL_MOUSE) },
{ } <em class="hl-comment">/* Terminating entry */</em>
};
MODULE_DEVICE_TABLE (usb, usb_mouse_id_table);
<strong class="hl-keyword">static</strong> <strong class="hl-keyword">struct</strong> usb_driver usb_mouse_driver = {
.name = <span class="hl-string">"usbmouse"</span>,
.probe = usb_mouse_probe,
.disconnect = usb_mouse_disconnect,
.id_table = usb_mouse_id_table,
};
module_usb_driver(usb_mouse_driver);</pre></div><ul class="- topic/ul ul" id="usb_host_interface_driver_struct_usb_driver__ul_wms_14z_21c" data-ofbid="usb_host_interface_driver_struct_usb_driver__ul_wms_14z_21c"><li class="- topic/li li" data-ofbid="d105671e61__20250121171540">
<div class="- topic/p p" data-ofbid="d105671e63__20250121171540">首先根据得到的 endpoint 准备好 urb创建好 input
设备:<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="usb_host_interface_driver_struct_usb_driver__pre_xms_14z_21c" data-ofbid="usb_host_interface_driver_struct_usb_driver__pre_xms_14z_21c"><strong class="hl-keyword">static</strong> <strong class="hl-keyword">int</strong> usb_mouse_probe(<strong class="hl-keyword">struct</strong> usb_interface *intf, <strong class="hl-keyword">const</strong> <strong class="hl-keyword">struct</strong> usb_device_id *id)
{
<strong class="hl-keyword">struct</strong> usb_device *dev = interface_to_usbdev(intf);
<strong class="hl-keyword">struct</strong> usb_host_interface *interface;
<strong class="hl-keyword">struct</strong> usb_endpoint_descriptor *endpoint;
<strong class="hl-keyword">struct</strong> usb_mouse *mouse;
<strong class="hl-keyword">struct</strong> input_dev *input_dev;
<strong class="hl-keyword">int</strong> pipe, maxp;
<strong class="hl-keyword">int</strong> error = -ENOMEM;
interface = intf-&gt;cur_altsetting;
<strong class="hl-keyword">if</strong> (interface-&gt;desc.bNumEndpoints != <span class="hl-number">1</span>)
<strong class="hl-keyword">return</strong> -ENODEV;
<em class="hl-comment">/* (1) 得到当前 interface 中的第一个 endpointmouse 设备只需一个 endpoint */</em>
endpoint = &amp;interface-&gt;endpoint[<span class="hl-number">0</span>].desc;
<strong class="hl-keyword">if</strong> (!usb_endpoint_is_int_in(endpoint))
<strong class="hl-keyword">return</strong> -ENODEV;
pipe = usb_rcvintpipe(dev, endpoint-&gt;bEndpointAddress);
maxp = usb_maxpacket(dev, pipe, usb_pipeout(pipe));
mouse = kzalloc(<strong class="hl-keyword">sizeof</strong>(<strong class="hl-keyword">struct</strong> usb_mouse), GFP_KERNEL);
<em class="hl-comment">/* (2.1) 分配 input device */</em>
input_dev = input_allocate_device();
<strong class="hl-keyword">if</strong> (!mouse || !input_dev)
<strong class="hl-keyword">goto</strong> fail1;
mouse-&gt;data = usb_alloc_coherent(dev, <span class="hl-number">8</span>, GFP_ATOMIC, &amp;mouse-&gt;data_dma);
<strong class="hl-keyword">if</strong> (!mouse-&gt;data)
<strong class="hl-keyword">goto</strong> fail1;
<em class="hl-comment">/* (3.1) 分配 urb */</em>
mouse-&gt;irq = usb_alloc_urb(<span class="hl-number">0</span>, GFP_KERNEL);
<strong class="hl-keyword">if</strong> (!mouse-&gt;irq)
<strong class="hl-keyword">goto</strong> fail2;
mouse-&gt;usbdev = dev;
mouse-&gt;dev = input_dev;
<strong class="hl-keyword">if</strong> (dev-&gt;manufacturer)
strlcpy(mouse-&gt;name, dev-&gt;manufacturer, <strong class="hl-keyword">sizeof</strong>(mouse-&gt;name));
<strong class="hl-keyword">if</strong> (dev-&gt;product) {
<strong class="hl-keyword">if</strong> (dev-&gt;manufacturer)
strlcat(mouse-&gt;name, <span class="hl-string">" "</span>, <strong class="hl-keyword">sizeof</strong>(mouse-&gt;name));
strlcat(mouse-&gt;name, dev-&gt;product, <strong class="hl-keyword">sizeof</strong>(mouse-&gt;name));
}
<strong class="hl-keyword">if</strong> (!strlen(mouse-&gt;name))
snprintf(mouse-&gt;name, <strong class="hl-keyword">sizeof</strong>(mouse-&gt;name),
<span class="hl-string">"USB HIDBP Mouse %04x:%04x"</span>,
le16_to_cpu(dev-&gt;descriptor.idVendor),
le16_to_cpu(dev-&gt;descriptor.idProduct));
usb_make_path(dev, mouse-&gt;phys, <strong class="hl-keyword">sizeof</strong>(mouse-&gt;phys));
strlcat(mouse-&gt;phys, <span class="hl-string">"/input0"</span>, <strong class="hl-keyword">sizeof</strong>(mouse-&gt;phys));
<em class="hl-comment">/* (2.2) 初始化 input device */</em>
input_dev-&gt;name = mouse-&gt;name;
input_dev-&gt;phys = mouse-&gt;phys;
usb_to_input_id(dev, &amp;input_dev-&gt;id);
input_dev-&gt;dev.parent = &amp;intf-&gt;dev;
input_dev-&gt;evbit[<span class="hl-number">0</span>] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
input_dev-&gt;keybit[BIT_WORD(BTN_MOUSE)] = BIT_MASK(BTN_LEFT) |
BIT_MASK(BTN_RIGHT) | BIT_MASK(BTN_MIDDLE);
input_dev-&gt;relbit[<span class="hl-number">0</span>] = BIT_MASK(REL_X) | BIT_MASK(REL_Y);
input_dev-&gt;keybit[BIT_WORD(BTN_MOUSE)] |= BIT_MASK(BTN_SIDE) |
BIT_MASK(BTN_EXTRA);
input_dev-&gt;relbit[<span class="hl-number">0</span>] |= BIT_MASK(REL_WHEEL);
input_set_drvdata(input_dev, mouse);
input_dev-&gt;open = usb_mouse_open;
input_dev-&gt;close = usb_mouse_close;
<em class="hl-comment">/* (3.2) 初始化 urb */</em>
usb_fill_int_urb(mouse-&gt;irq, dev, pipe, mouse-&gt;data,
(maxp &gt; <span class="hl-number">8</span> ? <span class="hl-number">8</span> : maxp),
usb_mouse_irq, mouse, endpoint-&gt;bInterval);
mouse-&gt;irq-&gt;transfer_dma = mouse-&gt;data_dma;
mouse-&gt;irq-&gt;transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
<em class="hl-comment">/* (2.3) 注册 input device */</em>
error = input_register_device(mouse-&gt;dev);
<strong class="hl-keyword">if</strong> (error)
<strong class="hl-keyword">goto</strong> fail3;
usb_set_intfdata(intf, mouse);
<strong class="hl-keyword">return</strong> <span class="hl-number">0</span>;
fail3:
usb_free_urb(mouse-&gt;irq);
fail2:
usb_free_coherent(dev, <span class="hl-number">8</span>, mouse-&gt;data, mouse-&gt;data_dma);
fail1:
input_free_device(input_dev);
kfree(mouse);
<strong class="hl-keyword">return</strong> error;
}
</pre></div>
</li><li class="- topic/li li" data-ofbid="d105671e68__20250121171540">
<div class="- topic/p p" data-ofbid="d105671e70__20250121171540">在 input device 被 open 时提交 urb
启动传输:<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="usb_host_interface_driver_struct_usb_driver__pre_zms_14z_21c" data-ofbid="usb_host_interface_driver_struct_usb_driver__pre_zms_14z_21c"><strong class="hl-keyword">static</strong> <strong class="hl-keyword">int</strong> usb_mouse_open(<strong class="hl-keyword">struct</strong> input_dev *dev)
{
<strong class="hl-keyword">struct</strong> usb_mouse *mouse = input_get_drvdata(dev);
mouse-&gt;irq-&gt;dev = mouse-&gt;usbdev;
<em class="hl-comment">/* (1) 提交初始化好的 usb开始查询数据 */</em>
<strong class="hl-keyword">if</strong> (usb_submit_urb(mouse-&gt;irq, GFP_KERNEL))
<strong class="hl-keyword">return</strong> -EIO;
<strong class="hl-keyword">return</strong> <span class="hl-number">0</span>;
}
</pre></div>
</li><li class="- topic/li li" data-ofbid="d105671e75__20250121171540">
<div class="- topic/p p" data-ofbid="d105671e77__20250121171540">在传输完 urb 的回调函数中,根据读回的数据上报 input 事件,并且重新提交 urb
继续查询:<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="usb_host_interface_driver_struct_usb_driver__pre_bns_14z_21c" data-ofbid="usb_host_interface_driver_struct_usb_driver__pre_bns_14z_21c"><strong class="hl-keyword">static</strong> <strong class="hl-keyword">void</strong> usb_mouse_irq(<strong class="hl-keyword">struct</strong> urb *urb)
{
<strong class="hl-keyword">struct</strong> usb_mouse *mouse = urb-&gt;context;
<strong class="hl-keyword">signed</strong> <strong class="hl-keyword">char</strong> *data = mouse-&gt;data;
<strong class="hl-keyword">struct</strong> input_dev *dev = mouse-&gt;dev;
<strong class="hl-keyword">int</strong> status;
<strong class="hl-keyword">switch</strong> (urb-&gt;status) {
<strong class="hl-keyword">case</strong> <span class="hl-number">0</span>: <em class="hl-comment">/* success */</em>
<strong class="hl-keyword">break</strong>;
<strong class="hl-keyword">case</strong> -ECONNRESET: <em class="hl-comment">/* unlink */</em>
<strong class="hl-keyword">case</strong> -ENOENT:
<strong class="hl-keyword">case</strong> -ESHUTDOWN:
<strong class="hl-keyword">return</strong>;
<em class="hl-comment">/* -EPIPE: should clear the halt */</em>
<strong class="hl-keyword">default</strong>: <em class="hl-comment">/* error */</em>
<strong class="hl-keyword">goto</strong> resubmit;
}
<em class="hl-comment">/* (1) 根据 urb 读回的数据,上报 input event */</em>
input_report_key(dev, BTN_LEFT, data[<span class="hl-number">0</span>] &amp; <span class="hl-number">0x01</span>);
input_report_key(dev, BTN_RIGHT, data[<span class="hl-number">0</span>] &amp; <span class="hl-number">0x02</span>);
input_report_key(dev, BTN_MIDDLE, data[<span class="hl-number">0</span>] &amp; <span class="hl-number">0x04</span>);
input_report_key(dev, BTN_SIDE, data[<span class="hl-number">0</span>] &amp; <span class="hl-number">0x08</span>);
input_report_key(dev, BTN_EXTRA, data[<span class="hl-number">0</span>] &amp; <span class="hl-number">0x10</span>);
input_report_rel(dev, REL_X, data[<span class="hl-number">1</span>]);
input_report_rel(dev, REL_Y, data[<span class="hl-number">2</span>]);
input_report_rel(dev, REL_WHEEL, data[<span class="hl-number">3</span>]);
input_sync(dev);
resubmit:
<em class="hl-comment">/* (2) 重新提交 urb 继续查询 */</em>
status = usb_submit_urb (urb, GFP_ATOMIC);
<strong class="hl-keyword">if</strong> (status)
dev_err(&amp;mouse-&gt;usbdev-&gt;dev,
<span class="hl-string">"can't resubmit intr, %s-%s/input0, status %d\n"</span>,
mouse-&gt;usbdev-&gt;bus-&gt;bus_name,
mouse-&gt;usbdev-&gt;devpath, status);
}
</pre></div>
</li></ul></div></article></main></div>
</div>
</div>
</div>
</div>
<footer class="navbar navbar-default wh_footer">
<div class=" footer-container mx-auto ">
<title>footer def</title>
<style><!--
.p1 {
font-family: FangZhengShuSong, Times, serif;
}
.p2 {
font-family: Arial, Helvetica, sans-serif;
}
.p3 {
font-family: "Lucida Console", "Courier New", monospace;
}
--></style>
<div class="webhelp.fragment.footer">
<p class="p1">Copyright © 2019-2024 广东匠芯创科技有限公司. All rights reserved.</p>
</div><div>
<div class="generation_time">
Update Time: 2025-01-21
</div>
</div>
</div>
</footer>
<div id="go2top" class="d-print-none">
<span class="oxy-icon oxy-icon-up"></span>
</div>
<div id="modal_img_large" class="modal">
<span class="close oxy-icon oxy-icon-remove"></span>
<div id="modal_img_container"></div>
<div id="caption"></div>
</div>
<script src="${pd}/publishing/publishing-styles-AIC-template/js/custom.js" defer="defer"></script>
</body>
</html>