235 lines
16 KiB
HTML
235 lines
16 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" data-content_root="../">
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>vendor device 驱动编写 — CherryUSB 1.5.0 documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
|
||
|
||
|
||
<script src="../_static/jquery.js?v=5d32c60e"></script>
|
||
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||
<script src="../_static/documentation_options.js?v=e0a75244"></script>
|
||
<script src="../_static/doctools.js?v=9a2dae69"></script>
|
||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<script src="../_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="vendor host 驱动编写" href="usbh_vendor.html" />
|
||
<link rel="prev" title="usbh_wifi" href="usbh_wifi.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="../index.html" class="icon icon-home">
|
||
CherryUSB
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<p class="caption" role="heading"><span class="caption-text">快速上手</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../quick_start/start.html">入门必看</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../quick_start/demo.html">基于现有 demo 快速验证</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../quick_start/transplant.html">芯片通用移植指南</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../quick_start/rtthread.html">基于 RT-Thread 软件包开发指南</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../quick_start/esp.html">基于 ESP-Registry 开发指南</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../q%26a.html">Q & A</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../opensource.html">官方开源项目分享</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../share.html">开发者经验/开源项目分享</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">USB 基本知识点</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../usb/usb2.0_basic.html">USB 基本概念(2.0 为主)</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../usb/usb3.0_basic.html">USB 基本概念(3.0 为主)</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_ext.html">USB 知识点拓展</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">API 手册</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../api/api_host.html">主机协议栈</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../api/api_port.html">主从驱动</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../api/api_config.html">USB CONFIG 说明</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Class 指南</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../class/class_cdc.html">CDC</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../class/class_hid.html">HID</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../class/class_msc.html">MSC</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../class/class_audio.html">UAC</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../class/class_video.html">UVC</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../class/winusb.html">WINUSB</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">例程说明</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="usbd_cdc_acm.html">usbd_cdc_acm</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usbd_hid.html">usbd_hid</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usbd_msc.html">usbd_msc</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usbd_rndis.html">usbd_rndis</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usbd_ecm.html">usbd_cdc_ecm</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usbd_audiov1.html">usbd_audiov1</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usbd_audiov2.html">usbd_audiov2</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usbd_video.html">usbd_video</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usbd_winusb.html">usbd_winusb</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usbd_webusb.html">usbd_webusb</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usbd_adb.html">usbd_adb</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usbh_serial.html">usbh_serial</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usbh_hid.html">usbh_hid</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usbh_msc.html">usbh_msc</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usbh_net.html">usbh_net</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usbh_bluetooth.html">usbh_bluetooth</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usbh_wifi.html">usbh_wifi</a></li>
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">vendor device 驱动编写</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usbh_vendor.html">vendor host 驱动编写</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">USBIP 介绍</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../usbip/ohci.html">OHCI</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../usbip/ehci.html">EHCI</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../usbip/xhci.html">XHCI</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../usbip/chipidea.html">CHIPIDEA</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../usbip/dwc2.html">DWC2</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../usbip/musb.html">MUSB</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../usbip/fotg210.html">FOTG210</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../usbip/cdns2.html">CDNS2</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../usbip/cdns3.html">CDNS3</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../usbip/dwc3.html">DWC3</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">工具使用</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../tools/index.html">chryusb_configurator</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../tools/index.html#usb-protocol-suite">力科 USB Protocol Suite</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../tools/index.html#wireshark">Wireshark</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../tools/index.html#audacity">Audacity</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">版本说明</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../version.html">版本说明</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">性能展示</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../show/index.html">性能展示</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">商业支持</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../support/index.html">商业支持</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../index.html">CherryUSB</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item active">vendor device 驱动编写</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="../_sources/demo/usbd_vendor.rst.txt" rel="nofollow"> View page source</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="vendor-device">
|
||
<h1>vendor device 驱动编写<a class="headerlink" href="#vendor-device" title="Link to this heading"></a></h1>
|
||
<p>本节主要介绍如何编写一个 vendor device 驱动。</p>
|
||
<ul class="simple">
|
||
<li><p>首先复制一份 class/template/usbd_xxx.c 文件</p></li>
|
||
<li><p>实现以下三个回调函数，通常来说，vendor 驱动只需要实现 vendor_handler</p></li>
|
||
</ul>
|
||
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="n">intf</span><span class="o">-></span><span class="n">class_interface_handler</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">xxx_class_interface_request_handler</span><span class="p">;</span>
|
||
<span class="n">intf</span><span class="o">-></span><span class="n">class_endpoint_handler</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">NULL</span><span class="p">;</span>
|
||
<span class="n">intf</span><span class="o">-></span><span class="n">vendor_handler</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">NULL</span><span class="p">;</span>
|
||
<span class="n">intf</span><span class="o">-></span><span class="n">notify_handler</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">xxx_notify_handler</span><span class="p">;</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p>举例如下</p></li>
|
||
</ul>
|
||
<p>case1 演示对于主机 IN 数据的处理，将数据拷贝到 <a href="#id1"><span class="problematic" id="id2">*</span></a>data 中，并指定*len 的长度。协议栈会自动发送给主机，不需要用户手动调用发送 API。</p>
|
||
<p>case2 演示对于主机 OUT 数据的处理，当执行到此函数时，说明数据都已经接收完成，可以直接读取 <a href="#id3"><span class="problematic" id="id4">*</span></a>data 中的数据，长度为 <a href="#id5"><span class="problematic" id="id6">*</span></a>len。</p>
|
||
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="k">static</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="nf">xxx_vendor_request_handler</span><span class="p">(</span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">busid</span><span class="p">,</span><span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usb_setup_packet</span><span class="w"> </span><span class="o">*</span><span class="n">setup</span><span class="p">,</span><span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">**</span><span class="n">data</span><span class="p">,</span><span class="w"> </span><span class="kt">uint32_t</span><span class="w"> </span><span class="o">*</span><span class="n">len</span><span class="p">)</span>
|
||
<span class="p">{</span>
|
||
<span class="w"> </span><span class="n">USB_LOG_WRN</span><span class="p">(</span><span class="s">"XXX Class request: "</span>
|
||
<span class="w"> </span><span class="s">"bRequest 0x%02x</span><span class="se">\r\n</span><span class="s">"</span><span class="p">,</span>
|
||
<span class="w"> </span><span class="n">setup</span><span class="o">-></span><span class="n">bRequest</span><span class="p">);</span>
|
||
|
||
<span class="w"> </span><span class="k">switch</span><span class="w"> </span><span class="p">(</span><span class="n">setup</span><span class="o">-></span><span class="n">bRequest</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="k">case</span><span class="w"> </span><span class="mi">1</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="n">memcpy</span><span class="p">(</span><span class="o">*</span><span class="n">data</span><span class="p">,</span><span class="w"> </span><span class="n">xxx</span><span class="p">,</span><span class="w"> </span><span class="k">sizeof</span><span class="p">(</span><span class="n">xxx</span><span class="p">));</span>
|
||
<span class="w"> </span><span class="o">*</span><span class="n">len</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">sizeof</span><span class="p">(</span><span class="n">xxx</span><span class="p">);</span>
|
||
<span class="w"> </span><span class="k">case</span><span class="w"> </span><span class="mi">2</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="n">hexdump</span><span class="p">(</span><span class="o">*</span><span class="n">data</span><span class="p">,</span><span class="w"> </span><span class="o">*</span><span class="n">len</span><span class="p">);</span>
|
||
<span class="w"> </span><span class="k">default</span><span class="o">:</span>
|
||
<span class="w"> </span><span class="n">USB_LOG_WRN</span><span class="p">(</span><span class="s">"Unhandled XXX Class bRequest 0x%02x</span><span class="se">\r\n</span><span class="s">"</span><span class="p">,</span><span class="w"> </span><span class="n">setup</span><span class="o">-></span><span class="n">bRequest</span><span class="p">);</span>
|
||
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="mi">-1</span><span class="p">;</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
|
||
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p>最后使用形如 usbd_add_interface(busid, usbd_xxx_init_intf(&intf)) 注册接口</p></li>
|
||
</ul>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="usbh_wifi.html" class="btn btn-neutral float-left" title="usbh_wifi" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="usbh_vendor.html" class="btn btn-neutral float-right" title="vendor host 驱动编写" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2022 ~ 2025, sakumisu.</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |