Deploying to gh-pages from @ cherry-embedded/CherryUSB@8712e2c03c 🚀

This commit is contained in:
sakumisu
2024-10-10 09:14:31 +00:00
parent 249ee43b89
commit 4d2aa4db55
71 changed files with 3469 additions and 14585 deletions

View File

@@ -1,17 +1,21 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en">
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<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>chryusb_configurator &mdash; CherryUSB 1.4.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"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<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=9172181d"></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" />
@@ -38,16 +42,16 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">快速上手</span></p>
<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&amp;a.html">Q &amp; A</a></li>
<li class="toctree-l1"><a class="reference internal" href="../q%26a.html">Q &amp; A</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<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>
@@ -56,14 +60,14 @@
<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"><span class="caption-text">API 手册</span></p>
<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"><span class="caption-text">Class 指南</span></p>
<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>
@@ -72,7 +76,7 @@
<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"><span class="caption-text">例程说明</span></p>
<p class="caption" role="heading"><span class="caption-text">例程说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_cdc_acm.html">usbd_cdc_acm</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_hid.html">usbd_hid</a></li>
@@ -91,7 +95,7 @@
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_bluetooth.html">usbh_bluetooth</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_wifi.html">usbh_wifi</a></li>
</ul>
<p class="caption"><span class="caption-text">USBIP 介绍</span></p>
<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>
@@ -104,18 +108,18 @@
<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"><span class="caption-text">工具使用</span></p>
<p class="caption" role="heading"><span class="caption-text">工具使用</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">chryusb_configurator</a></li>
<li class="toctree-l1"><a class="reference internal" href="#usb-protocol-suite">力科 USB Protocol Suite</a></li>
<li class="toctree-l1"><a class="reference internal" href="#wireshark">Wireshark</a></li>
<li class="toctree-l1"><a class="reference internal" href="#audacity">Audacity</a></li>
</ul>
<p class="caption"><span class="caption-text">版本说明</span></p>
<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"><span class="caption-text">商业支持</span></p>
<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>
@@ -144,68 +148,68 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="chryusb-configurator">
<h1>chryusb_configurator<a class="headerlink" href="#chryusb-configurator" title="Permalink to this headline"></a></h1>
<section id="chryusb-configurator">
<h1>chryusb_configurator<a class="headerlink" href="#chryusb-configurator" title="Link to this heading"></a></h1>
<p><a class="reference external" href="https://github.com/CherryUSB/chryusb_configurator/releases/tag/1.0.0">chryusb_configurator</a> 主要服务在使用设备协议栈时,生成描述符数组,从而调用 <cite>usbd_desc_register</cite> 进行注册。</p>
<ul class="simple">
<li><p>首先我们从 github 下载 chryusb_configurator.exe然后一路安装就可以了。然后双击打开点击 <cite>工程</cite>,并点击 <cite>新建工程</cite></p></li>
</ul>
<div class="figure align-default">
<figure class="align-default">
<img alt="../_images/chrytool1.png" src="../_images/chrytool1.png" />
</div>
</figure>
<ul class="simple">
<li><p>新建完成以后,会生成默认的描述符配置,包含 <strong>设备描述符</strong><strong>配置描述符</strong><strong>字符串描述符</strong>,并且 <strong>字符串描述符</strong> 默认支持三个</p></li>
</ul>
<div class="figure align-default">
<figure class="align-default">
<img alt="../_images/chrytool2.png" src="../_images/chrytool2.png" />
</div>
</figure>
<ul class="simple">
<li><p>然后我们可以根据需要修改相关描述符的信息,比如 <strong>设备描述符</strong> 中的 vid、pidclass 参数, <strong>配置描述符</strong> 中的 <strong>Power</strong> 等等</p></li>
<li><p>然后是 class 的添加,需要点击 <cite>文件</cite>,并点击 <cite>新建文件</cite></p></li>
</ul>
<div class="figure align-default">
<figure class="align-default">
<img alt="../_images/chrytool3.png" src="../_images/chrytool3.png" />
</div>
</figure>
<ul class="simple">
<li><p>然后右侧提供了一些 class 的描述符模板,选择一个进行初始化</p></li>
</ul>
<div class="figure align-default">
<figure class="align-default">
<img alt="../_images/chrytool4.png" src="../_images/chrytool4.png" />
</div>
</figure>
<ul class="simple">
<li><p>如果是多个 class ,则上述两步重复操作就可以了</p></li>
<li><p>然后我们根据需要修改相关端点的参数比如方向、地址、size、interval</p></li>
</ul>
<div class="figure align-default">
<figure class="align-default">
<img alt="../_images/chrytool5.png" src="../_images/chrytool5.png" />
</div>
</figure>
<ul class="simple">
<li><p>最后点击 <cite>文件</cite> 并保存文件,后缀为 <cite>.chry</cite></p></li>
<li><p>切换到工程文件,后缀是 <cite>.chrybase</cite>, 然后点击 <cite>添加分组配置</cite> 导入刚刚配置好的 class 文件</p></li>
</ul>
<div class="figure align-default">
<figure class="align-default">
<img alt="../_images/chrytool6.png" src="../_images/chrytool6.png" />
</div>
</figure>
<ul class="simple">
<li><p>点击 <cite>工程</cite> 并点击 <cite>保存工程</cite></p></li>
<li><p>点击 <cite>编译</cite>,生成描述符数组</p></li>
</ul>
<div class="figure align-default">
<figure class="align-default">
<img alt="../_images/chrytool7.png" src="../_images/chrytool7.png" />
</div>
</figure>
<ul class="simple">
<li><p>复制编译后的文件到自己的工程中使用即可</p></li>
</ul>
</div>
<div class="section" id="usb-protocol-suite">
<h1>力科 USB Protocol Suite<a class="headerlink" href="#usb-protocol-suite" title="Permalink to this headline"></a></h1>
</div>
<div class="section" id="wireshark">
<h1>Wireshark<a class="headerlink" href="#wireshark" title="Permalink to this headline"></a></h1>
</div>
<div class="section" id="audacity">
<h1>Audacity<a class="headerlink" href="#audacity" title="Permalink to this headline"></a></h1>
</div>
</section>
<section id="usb-protocol-suite">
<h1>力科 USB Protocol Suite<a class="headerlink" href="#usb-protocol-suite" title="Link to this heading"></a></h1>
</section>
<section id="wireshark">
<h1>Wireshark<a class="headerlink" href="#wireshark" title="Link to this heading"></a></h1>
</section>
<section id="audacity">
<h1>Audacity<a class="headerlink" href="#audacity" title="Link to this heading"></a></h1>
</section>
</div>