Deploying to gh-pages from @ cherry-embedded/CherryUSB@a8ef0c4cac 🚀
This commit is contained in:
HalfSweet
430
quick_start/demo.html
Normal file
430
quick_start/demo.html
Normal file
@@ -0,0 +1,430 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>基于现有 demo 快速验证 — CherryUSB 1.4.0 documentation</title><link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<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/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="芯片通用移植指南" href="transplant.html" />
|
||||
<link rel="prev" title="入门必看" href="start.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 class="version">
|
||||
1.4.0
|
||||
</div>
|
||||
<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"><span class="caption-text">快速上手</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="start.html">入门必看</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">基于现有 demo 快速验证</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#bouffalolab">基于 bouffalolab 系列芯片</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#hpmicro">基于 HPMicro 系列芯片</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#esp32s2-s3-p4">基于 esp32s2/s3/p4 系列芯片</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id1">基于飞腾派系列芯片</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#st">基于 ST 系列芯片</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#usb-device">USB Device 移植要点</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#usb-host">USB Host 移植要点</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="transplant.html">芯片通用移植指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="rtthread.html">基于 RT-Thread 软件包开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="esp.html">基于 ESP-Registry 开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../q&a.html">Q & A</a></li>
|
||||
</ul>
|
||||
<p class="caption"><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"><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>
|
||||
<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"><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>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_msc.html">usbd_msc</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_rndis.html">usbd_rndis</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_ecm.html">usbd_cdc_ecm</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_audiov1.html">usbd_audiov1</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_audiov2.html">usbd_audiov2</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_video.html">usbd_video</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_winusb.html">usbd_winusb</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_webusb.html">usbd_webusb</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_serial.html">usbh_serial</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_hid.html">usbh_hid</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_msc.html">usbh_msc</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_net.html">usbh_net</a></li>
|
||||
<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>
|
||||
<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"><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"><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>
|
||||
<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">基于现有 demo 快速验证</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="../_sources/quick_start/demo.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">
|
||||
|
||||
<div class="section" id="demo">
|
||||
<h1>基于现有 demo 快速验证<a class="headerlink" href="#demo" title="Permalink to this headline">¶</a></h1>
|
||||
<p>在学习 USB 或者是学习 CherryUSB 代码之前，我们需要先基于现有的 demo 进行快速验证，为什么？是为了提升对 USB 的兴趣，能有信心进行下一步的动作，如果 demo 都跑不起来，或者自己摸索写代码，或者先看 USB 基本概念，结果看到最后，
|
||||
发现一点都看不懂，概念好多，根本记不住，从而丧失对 USB 的兴趣。因此，先跑 demo 非常重要。下面我将给大家罗列目前支持的 demo 仓库。</p>
|
||||
<div class="section" id="bouffalolab">
|
||||
<h2>基于 bouffalolab 系列芯片<a class="headerlink" href="#bouffalolab" title="Permalink to this headline">¶</a></h2>
|
||||
<p>仓库参考：<a class="reference external" href="https://github.com/CherryUSB/cherryusb_bouffalolab">https://github.com/CherryUSB/cherryusb_bouffalolab</a></p>
|
||||
<ul class="simple">
|
||||
<li><p>BL616/BL808 是一个 USB2.0 并且内置高速 PHY 芯片，共 5个端点（包含端点0）。支持主从机。</p></li>
|
||||
<li><p>USB 的相关应用位于 <cite>examples/usbdev</cite> 和 <cite>examples/usbhost</cite> 目录下，根据官方环境搭建完成后，即可编译使用。</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="hpmicro">
|
||||
<h2>基于 HPMicro 系列芯片<a class="headerlink" href="#hpmicro" title="Permalink to this headline">¶</a></h2>
|
||||
<p>仓库参考：<a class="reference external" href="https://github.com/CherryUSB/cherryusb_hpmicro">https://github.com/CherryUSB/cherryusb_hpmicro</a></p>
|
||||
<ul class="simple">
|
||||
<li><p>HPM 系列芯片均 USB 2.0 并且内置高速 PHY，支持主从机，端点共 8/16 个，并且可以同时使用双向，不同芯片个数有差异</p></li>
|
||||
<li><p>USB 的相关应用位于 <cite>samples/cherryusb</cite> ，根据官方环境搭建完成后，即可编译使用。</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="esp32s2-s3-p4">
|
||||
<h2>基于 esp32s2/s3/p4 系列芯片<a class="headerlink" href="#esp32s2-s3-p4" title="Permalink to this headline">¶</a></h2>
|
||||
<p>仓库参考：<a class="reference external" href="https://github.com/CherryUSB/cherryusb_esp32">https://github.com/CherryUSB/cherryusb_esp32</a></p>
|
||||
<ul class="simple">
|
||||
<li><p>esp32s2/s3 支持全速主从机，esp32p4 支持高速主从机</p></li>
|
||||
<li><p>默认提供主机 demo，并且使用 esp 组件库进行开发， 在 <a class="reference external" href="https://components.espressif.com/">https://components.espressif.com/</a> 中搜索 cherryusb 即可</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id1">
|
||||
<h2>基于飞腾派系列芯片<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
|
||||
<p>仓库参考：<a class="reference external" href="https://gitee.com/phytium_embedded/phytium-free-rtos-sdk">https://gitee.com/phytium_embedded/phytium-free-rtos-sdk</a></p>
|
||||
<ul class="simple">
|
||||
<li><p>飞腾派支持两个 USB3.0 主机， 两个 USB2.0 主从机</p></li>
|
||||
<li><p>USB 的相关应用位于 <cite>example/peripheral/usb</cite> ，根据官方环境搭建完成后，即可编译使用。</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="st">
|
||||
<h2>基于 ST 系列芯片<a class="headerlink" href="#st" title="Permalink to this headline">¶</a></h2>
|
||||
<p>仓库参考：<a class="reference external" href="https://github.com/CherryUSB/cherryusb_stm32">https://github.com/CherryUSB/cherryusb_stm32</a></p>
|
||||
<p>默认提供以下 demo 工程：</p>
|
||||
<ul class="simple">
|
||||
<li><p>F103 使用 fsdev ip</p></li>
|
||||
<li><p>F429 主从使用 USB1, 引脚 pb14/pb15, 并且都使用 dma 模式</p></li>
|
||||
<li><p>H7 设备使用 USB0, 引脚 pa11/pa12，主机使用 USB_OTG_HS ,引脚 pb14/pb15，并且需要做 nocache 处理</p></li>
|
||||
</ul>
|
||||
<p>demo 底下提供了 <strong>stm32xxx.ioc</strong> 文件，双击打开，点击 <strong>Generate Code</strong> 即可。</p>
|
||||
<div class="admonition caution">
|
||||
<p class="admonition-title">Caution</p>
|
||||
<p>生成完以后，请使用 git reset 功能将被覆盖的 <cite>main.c</cite> 和 <cite>stm32xxx_it.c</cite> 文件撤回，禁止被 cubemx 覆盖。</p>
|
||||
</div>
|
||||
<p>涵盖 F1/F4/H7，其余芯片基本类似，不再赘述，具体区别有：</p>
|
||||
<ul class="simple">
|
||||
<li><p>usb ip 区别：F1使用 fsdev，F4/H7使用 dwc2</p></li>
|
||||
<li><p>dwc2 ip 区别： USB0 (引脚是 PA11/PA12) 和 USB1 (引脚是 PB14/PB15), 其中 USB1 默认全速，可以接外部PHY 形成高速主机，并且带 dma 功能</p></li>
|
||||
<li><p>F4 无cache，H7 有 cache</p></li>
|
||||
</ul>
|
||||
<p>如果是 STM32F7/STM32H7 这种带 cache 功能，需要将 usb 使用到的 ram 定位到 no cache ram 区域。举例如下</p>
|
||||
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="n">cpu_mpu_config</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">MPU_Normal_NonCache</span><span class="p">,</span> <span class="mh">0x24070000</span><span class="p">,</span> <span class="n">MPU_REGION_SIZE_64KB</span><span class="p">);</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>对应 keil 中的 sct 脚本修改：</p>
|
||||
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span>LR_IROM1 0x08000000 0x00200000 { ; load region size_region
|
||||
ER_IROM1 0x08000000 0x00200000 { ; load address = execution address
|
||||
*.o (RESET, +First)
|
||||
*(InRoot$$Sections)
|
||||
.ANY (+RO)
|
||||
.ANY (+XO)
|
||||
}
|
||||
RW_IRAM2 0x24000000 0x00070000 { ; RW data
|
||||
.ANY (+RW +ZI)
|
||||
}
|
||||
USB_NOCACHERAM 0x24070000 0x00010000 { ; RW data
|
||||
*(.noncacheable)
|
||||
}
|
||||
}
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="section" id="usb-device">
|
||||
<h3>USB Device 移植要点<a class="headerlink" href="#usb-device" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>使用 <strong>stm32cubemx</strong> 创建工程，配置基本的 RCC、UART (作为log使用)</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_1.png" src="../_images/stm32_1.png" />
|
||||
</div>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_2.png" src="../_images/stm32_2.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>如果使用 fsdev ip，勾选 <strong>USB</strong> 。如果使用 dwc2 ip，勾选 <strong>USB_OTG_FS</strong> 或者勾选 <strong>USB_OTG_HS</strong>。开启 USB 中断，其他配置对我们没用，代码中不会使用任何 st 的 usb 库。</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_3_1.png" src="../_images/stm32_3_1.png" />
|
||||
</div>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_3.png" src="../_images/stm32_3.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>配置 usb clock 为 48M</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_4_1.png" src="../_images/stm32_4_1.png" />
|
||||
</div>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_4.png" src="../_images/stm32_4.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>选择好工程，这里我们选择 keil，设置好 stack 和 heap，如果使用 msc 可以推荐设置大点，然后点击 <strong>Generate Code</strong>。</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_5.png" src="../_images/stm32_5.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>添加 CherryUSB 必须要的源码（ <strong>usbd_core.c</strong> 、 <strong>usb_dc_dwc2.c</strong> 或者是 <strong>usb_dc_fsdev.c</strong> ）,以及想要使用的 class 驱动，可以将对应的 class template 添加方便测试。</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_6.png" src="../_images/stm32_6.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>头文件该加的加</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_7.png" src="../_images/stm32_7.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>复制一份 <strong>cherryusb_config_template.h</strong>，放到 <cite>Core/Inc</cite> 目录下，并命名为 <cite>usb_config.h</cite></p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_8.png" src="../_images/stm32_8.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>如果使用 dwc2 ip，需要增加 <strong>usb_glue_st.c</strong> 文件，并在 <cite>usb_config.h</cite> 中实现以下宏：</p></li>
|
||||
</ul>
|
||||
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="c1">// 以下细节如有出入，请对照 stm32xxx.h 文件修改</span>
|
||||
<span class="c1">// 需要根据硬件实际的 fifo 深度进行修改，默认是最基础的配置</span>
|
||||
<span class="cp">#define CONFIG_USBDEV_EP_NUM 6</span>
|
||||
<span class="cp">#define CONFIG_USB_DWC2_RXALL_FIFO_SIZE (1012 - 16 * 6)</span>
|
||||
<span class="cp">#define CONFIG_USB_DWC2_TX0_FIFO_SIZE (64 / 4)</span>
|
||||
<span class="cp">#define CONFIG_USB_DWC2_TX1_FIFO_SIZE (64 / 4)</span>
|
||||
<span class="cp">#define CONFIG_USB_DWC2_TX2_FIFO_SIZE (64 / 4)</span>
|
||||
<span class="cp">#define CONFIG_USB_DWC2_TX3_FIFO_SIZE (64 / 4)</span>
|
||||
<span class="cp">#define CONFIG_USB_DWC2_TX4_FIFO_SIZE (64 / 4)</span>
|
||||
<span class="cp">#define CONFIG_USB_DWC2_TX5_FIFO_SIZE (64 / 4)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>如果使用 fsdev ip，在 <cite>usb_config.h</cite> 中实现以下宏：</p></li>
|
||||
</ul>
|
||||
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="cp">#define CONFIG_USBDEV_EP_NUM 8</span>
|
||||
<span class="cp">#define CONFIG_USBDEV_FSDEV_PMA_ACCESS 2</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>编译器推荐使用 <strong>AC6</strong>。勾选 <strong>Microlib</strong>，并实现 <strong>printf</strong> ，方便后续查看 log。</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_10.png" src="../_images/stm32_10.png" />
|
||||
</div>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_11.png" src="../_images/stm32_11.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>拷贝 <strong>xxx_msp.c</strong> 中的 <strong>HAL_PCD_MspInit</strong> 函数中的内容到 <strong>usb_dc_low_level_init</strong> 函数中，屏蔽 st 生成的 usb 初始化</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_12.png" src="../_images/stm32_12.png" />
|
||||
</div>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_14.png" src="../_images/stm32_14.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>在中断函数中调用 <cite>USBD_IRQHandler</cite>，并传入 <cite>busid</cite></p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_13.png" src="../_images/stm32_13.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>调用 template 的内容初始化，并填入 <cite>busid</cite> 和 USB IP 的 <cite>reg base</cite>， <cite>busid</cite> 从 0 开始，不能超过 <cite>CONFIG_USBDEV_MAX_BUS</cite></p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_15.png" src="../_images/stm32_15.png" />
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="usb-host">
|
||||
<h3>USB Host 移植要点<a class="headerlink" href="#usb-host" title="Permalink to this headline">¶</a></h3>
|
||||
<p>前面 6 步与 Device 一样。需要注意，host 驱动只支持带 dma 的 hs port (引脚是 PB14/PB15)，所以 fs port (引脚是 PA11/PA12)不做支持（没有 dma 你玩什么主机）。</p>
|
||||
<ul class="simple">
|
||||
<li><p>添加 CherryUSB 必须要的源码（ <strong>usbh_core.c</strong> 、 <strong>usbh_hub.c</strong> 、 <strong>usb_hc_dwc2.c</strong> 、以及 <strong>osal</strong> 目录下的适配层文件）,以及想要使用的 class 驱动，并且可以将对应的 <strong>usb host.c</strong> 添加方便测试。</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_16.png" src="../_images/stm32_16.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>编译器推荐使用 <strong>AC6</strong>。勾选 <strong>Microlib</strong>，并实现 <strong>printf</strong> ，方便后续查看 log。</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_10.png" src="../_images/stm32_10.png" />
|
||||
</div>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_11.png" src="../_images/stm32_11.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>复制一份 <strong>cherryusb_config_template.h</strong>，放到 <cite>Core/Inc</cite> 目录下，并命名为 <cite>usb_config.h</cite></p></li>
|
||||
<li><p>增加 <strong>usb_glue_st.c</strong> 文件，并在 <cite>usb_config.h</cite> 中实现以下宏：</p></li>
|
||||
</ul>
|
||||
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="c1">// 以下细节如有出入，请对照 stm32xxx.h 文件修改</span>
|
||||
<span class="c1">// 需要根据硬件实际的 fifo 深度进行修改，默认是最基础的配置</span>
|
||||
<span class="cp">#define CONFIG_USBHOST_PIPE_NUM 12</span>
|
||||
<span class="cp">#define CONFIG_USB_DWC2_NPTX_FIFO_SIZE (512 / 4)</span>
|
||||
<span class="cp">#define CONFIG_USB_DWC2_PTX_FIFO_SIZE (1024 / 4)</span>
|
||||
<span class="cp">#define CONFIG_USB_DWC2_RX_FIFO_SIZE ((1012 - CONFIG_USB_DWC2_NPTX_FIFO_SIZE - CONFIG_USB_DWC2_PTX_FIFO_SIZE) / 4)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>拷贝 <strong>xxx_msp.c</strong> 中的 <cite>HAL_HCD_MspInit</cite> 函数中的内容到 <cite>usb_hc_low_level_init</cite> 函数中，屏蔽 st 生成的 usb 初始化</p></li>
|
||||
<li><p>在中断函数中调用 <cite>USBH_IRQHandler</cite>，并传入 <cite>busid</cite></p></li>
|
||||
<li><p>调用 <cite>usbh_initialize</cite> 并填入 <cite>busid</cite> 和 USB IP 的 <cite>reg base</cite>， <cite>busid</cite> 从 0 开始，不能超过 <cite>CONFIG_USBHOST_MAX_BUS</cite></p></li>
|
||||
<li><p>启动线程</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_18.png" src="../_images/stm32_18.png" />
|
||||
</div>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_19.png" src="../_images/stm32_19.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>如果使用 <strong>msc</strong>，并且带文件系统，需要自行添加文件系统文件了，对应的 porting 编写参考 <strong>fatfs_usbh.c</strong> 文件。</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_21.png" src="../_images/stm32_21.png" />
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="start.html" class="btn btn-neutral float-left" title="入门必看" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="transplant.html" class="btn btn-neutral float-right" title="芯片通用移植指南" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2024, 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>
|
||||
210
quick_start/esp.html
Normal file
210
quick_start/esp.html
Normal file
@@ -0,0 +1,210 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>基于 ESP-Registry 开发指南 — CherryUSB 1.4.0 documentation</title><link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<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/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="Q & A" href="../q&a.html" />
|
||||
<link rel="prev" title="基于 RT-Thread 软件包开发指南" href="rtthread.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 class="version">
|
||||
1.4.0
|
||||
</div>
|
||||
<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"><span class="caption-text">快速上手</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="start.html">入门必看</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="demo.html">基于现有 demo 快速验证</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="transplant.html">芯片通用移植指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="rtthread.html">基于 RT-Thread 软件包开发指南</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">基于 ESP-Registry 开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../q&a.html">Q & A</a></li>
|
||||
</ul>
|
||||
<p class="caption"><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"><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>
|
||||
<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"><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>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_msc.html">usbd_msc</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_rndis.html">usbd_rndis</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_ecm.html">usbd_cdc_ecm</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_audiov1.html">usbd_audiov1</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_audiov2.html">usbd_audiov2</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_video.html">usbd_video</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_winusb.html">usbd_winusb</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_webusb.html">usbd_webusb</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_serial.html">usbh_serial</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_hid.html">usbh_hid</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_msc.html">usbh_msc</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_net.html">usbh_net</a></li>
|
||||
<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>
|
||||
<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"><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"><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>
|
||||
<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">基于 ESP-Registry 开发指南</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="../_sources/quick_start/esp.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">
|
||||
|
||||
<div class="section" id="esp-registry">
|
||||
<h1>基于 ESP-Registry 开发指南<a class="headerlink" href="#esp-registry" title="Permalink to this headline">¶</a></h1>
|
||||
<p>ESP-Registry 可以参考官方文档，推荐使用 vscode + esp-idf 的开发环境。</p>
|
||||
<ul class="simple">
|
||||
<li><p>ctrl + shift + p 选择 ESP-IDF 欢迎界面，然后选择 Component mananger</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/esp1.png" src="../_images/esp1.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>找到 cherryusb 并安装</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/esp2.png" src="../_images/esp2.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>打开 menuconfig，并打开 cherryusb 的配置，根据实际情况选择主机或者从机模式</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/esp3.png" src="../_images/esp3.png" />
|
||||
</div>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/esp4.png" src="../_images/esp4.png" />
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="rtthread.html" class="btn btn-neutral float-left" title="基于 RT-Thread 软件包开发指南" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="../q&a.html" class="btn btn-neutral float-right" title="Q & A" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2024, 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>
|
||||
328
quick_start/rtthread.html
Normal file
328
quick_start/rtthread.html
Normal file
@@ -0,0 +1,328 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>基于 RT-Thread 软件包开发指南 — CherryUSB 1.4.0 documentation</title><link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<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/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="基于 ESP-Registry 开发指南" href="esp.html" />
|
||||
<link rel="prev" title="芯片通用移植指南" href="transplant.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 class="version">
|
||||
1.4.0
|
||||
</div>
|
||||
<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"><span class="caption-text">快速上手</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="start.html">入门必看</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="demo.html">基于现有 demo 快速验证</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="transplant.html">芯片通用移植指南</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">基于 RT-Thread 软件包开发指南</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id1">从机配置</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id2">主机配置</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#stm32cubemx-usb">借助 STM32CubeMX 生成 USB 初始化</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="esp.html">基于 ESP-Registry 开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../q&a.html">Q & A</a></li>
|
||||
</ul>
|
||||
<p class="caption"><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"><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>
|
||||
<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"><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>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_msc.html">usbd_msc</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_rndis.html">usbd_rndis</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_ecm.html">usbd_cdc_ecm</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_audiov1.html">usbd_audiov1</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_audiov2.html">usbd_audiov2</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_video.html">usbd_video</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_winusb.html">usbd_winusb</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_webusb.html">usbd_webusb</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_serial.html">usbh_serial</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_hid.html">usbh_hid</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_msc.html">usbh_msc</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_net.html">usbh_net</a></li>
|
||||
<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>
|
||||
<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"><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"><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>
|
||||
<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">基于 RT-Thread 软件包开发指南</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="../_sources/quick_start/rtthread.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">
|
||||
|
||||
<div class="section" id="rt-thread">
|
||||
<h1>基于 RT-Thread 软件包开发指南<a class="headerlink" href="#rt-thread" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>CherryUSB 已经加入 RT-Thread 主线，可以选择使用主线版本，配置方式相同。</p>
|
||||
</div>
|
||||
<p>本节主要介绍使用 RT-Thread 提供的软件包管理器来配置工程，以 env 作为演示。本节操作不同芯片都一样，后续不再重复讲解。打开 env 以后使用 menuconfig 进入包管理器，并在如图所示路径中选择 CherryUSB。</p>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/env0.png" src="../_images/env0.png" />
|
||||
</div>
|
||||
<div class="section" id="id1">
|
||||
<h2>从机配置<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>选择 Enable usb device mode 并敲回车进入。</p></li>
|
||||
<li><p>首先第一个配置是配置 USB 的速度，分为 <strong>FS、HS</strong>，表示使用全速还是高速功能。高速功能要求内置高速 PHY 或者外接 PHY</p></li>
|
||||
<li><p>其次第二个配置则是选择 USB device ip，不清楚自己芯片是哪个 ip 的可以参考 <strong>port</strong> 目录下对应的 readme。</p></li>
|
||||
<li><p>选择你想使用的 class</p></li>
|
||||
<li><p>选择是否使用 demo 模板</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/env1.png" src="../_images/env1.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>最后退出保存即可。</p></li>
|
||||
<li><p>拷贝 <cite>cherryusb_config_template.h</cite> 文件到自己工程目录下，命名为 <cite>usb_config.h</cite>，并添加相应的目录头文件路径,并修改以下内容：</p></li>
|
||||
</ul>
|
||||
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span> <span class="cpf">"rtthread.h"</span><span class="cp"></span>
|
||||
|
||||
<span class="cp">#define CONFIG_USB_PRINTF(...) rt_kprintf(__VA_ARGS__)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>USB IP 相关的 config 需要用户自己根据芯片实际情况修改</p></li>
|
||||
<li><p>退出以后不急着编译，需要在代码中实现 <cite>usb_dc_low_level_init</cite> 函数。</p></li>
|
||||
<li><p>调用 <cite>usbd_initialize</cite> 并填入 <cite>busid</cite> 和 USB IP 的 <cite>reg base</cite>， <cite>busid</cite> 从 0 开始，不能超过 <cite>CONFIG_USBDEV_MAX_BUS</cite></p></li>
|
||||
<li><p>以上内容我们推荐放在 <strong>board.c</strong> 中，如下代码：</p></li>
|
||||
</ul>
|
||||
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="kt">void</span> <span class="nf">OTG_HS_IRQHandler</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>
|
||||
<span class="p">{</span>
|
||||
<span class="k">extern</span> <span class="kt">void</span> <span class="n">USBD_IRQHandler</span><span class="p">(</span><span class="kt">uint8_t</span> <span class="n">busid</span><span class="p">);</span>
|
||||
<span class="n">USBD_IRQHandler</span><span class="p">(</span><span class="mi">0</span><span class="p">);</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="kt">int</span> <span class="nf">usbd_init</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>
|
||||
<span class="p">{</span>
|
||||
<span class="n">xxx_template_init</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">USB_OTG_HS_PERIPH_BASE</span><span class="p">);</span>
|
||||
<span class="k">return</span> <span class="mi">0</span><span class="p">;</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="n">INIT_APP_EXPORT</span><span class="p">(</span><span class="n">usbd_init</span><span class="p">);</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>使用 <cite>scons –target=mdk5</cite> 或者 <cite>scons</cite> 进行编译，如果是mdk，需要使用 AC6 编译器</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id2">
|
||||
<h2>主机配置<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>选择 Enable usb host mode 并敲回车进入。</p></li>
|
||||
<li><p>选择 USB host ip，不清楚自己芯片是哪个 ip 的可以参考 <strong>port</strong> 目录下对应的 readme。</p></li>
|
||||
<li><p>根据需要勾选 class 驱动</p></li>
|
||||
<li><p>选择是否开启模板 demo，请注意， msc 禁止使能，因为默认对接到 dfs。</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/env2.png" src="../_images/env2.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>最后退出保存即可。</p></li>
|
||||
<li><p>拷贝 <cite>cherryusb_config_template.h</cite> 文件到自己工程目录下，命名为 <cite>usb_config.h</cite>，并添加相应的目录头文件路径,并实现以下内容：</p></li>
|
||||
</ul>
|
||||
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span> <span class="cpf">"rtthread.h"</span><span class="cp"></span>
|
||||
|
||||
<span class="cp">#define CONFIG_USB_PRINTF(...) rt_kprintf(__VA_ARGS__)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>USB IP 相关的 config 需要用户自己根据芯片实际情况修改</p></li>
|
||||
<li><p>在代码中实现 <cite>usb_hc_low_level_init</cite> 函数</p></li>
|
||||
<li><p>调用 <cite>usbh_initialize</cite> 并填入 <cite>busid</cite> 和 USB IP 的 <cite>reg base</cite>， <cite>busid</cite> 从 0 开始，不能超过 <cite>CONFIG_USBHOST_MAX_BUS</cite></p></li>
|
||||
<li><p>以上内容我们推荐放在 <strong>board.c</strong> 中，如下代码：</p></li>
|
||||
</ul>
|
||||
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="kt">void</span> <span class="nf">OTG_HS_IRQHandler</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>
|
||||
<span class="p">{</span>
|
||||
<span class="k">extern</span> <span class="kt">void</span> <span class="n">USBH_IRQHandler</span><span class="p">(</span><span class="kt">uint8_t</span> <span class="n">busid</span><span class="p">);</span>
|
||||
<span class="n">USBH_IRQHandler</span><span class="p">(</span><span class="mi">0</span><span class="p">);</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="kt">int</span> <span class="nf">usbh_init</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>
|
||||
<span class="p">{</span>
|
||||
<span class="n">usbh_initialize</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">USB_OTG_HS_PERIPH_BASE</span><span class="p">);</span>
|
||||
<span class="k">return</span> <span class="mi">0</span><span class="p">;</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="n">INIT_APP_EXPORT</span><span class="p">(</span><span class="n">usbh_init</span><span class="p">);</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>使用 <cite>scons –target=mdk5</cite> 或者 <cite>scons</cite> 进行编译，如果是mdk，需要使用 AC6 编译器</p></li>
|
||||
<li><p>如果使用的是 GCC ，需要在链接脚本(ld)中添加如下代码：</p></li>
|
||||
</ul>
|
||||
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="cm">/* section information for usbh class */</span>
|
||||
<span class="p">.</span> <span class="o">=</span> <span class="n">ALIGN</span><span class="p">(</span><span class="mi">4</span><span class="p">);</span>
|
||||
<span class="n">__usbh_class_info_start__</span> <span class="o">=</span> <span class="p">.;</span>
|
||||
<span class="n">KEEP</span><span class="p">(</span><span class="o">*</span><span class="p">(.</span><span class="n">usbh_class_info</span><span class="p">))</span>
|
||||
<span class="n">__usbh_class_info_end__</span> <span class="o">=</span> <span class="p">.;</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="stm32cubemx-usb">
|
||||
<h2>借助 STM32CubeMX 生成 USB 初始化<a class="headerlink" href="#stm32cubemx-usb" title="Permalink to this headline">¶</a></h2>
|
||||
<p>使用 STM32CubeMX 主要是用来生成 usb 时钟、引脚、中断的配置。我们需要点击如图所示文件，并配置好 USB 的时钟、中断，点击 <cite>Generate Code</cite>。</p>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32cubemx0.png" src="../_images/stm32cubemx0.png" />
|
||||
</div>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32cubemx1.png" src="../_images/stm32cubemx1.png" />
|
||||
</div>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32cubemx2.png" src="../_images/stm32cubemx2.png" />
|
||||
</div>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32cubemx_clk.png" src="../_images/stm32cubemx_clk.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>将 <cite>main.c</cite> 中的 <cite>SystemClock_Config</cite> 替换掉 <cite>board.c</cite> 中的配置</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_init2.png" src="../_images/stm32_init2.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>将 <cite>stm32xxxx_hal_msp.c</cite> 中的 <cite>HAL_PCD_MspInit</cite> 或者是 <cite>HAL_HCD_MspInit</cite> 中的内容复制到 <cite>usb_dc_low_level_init</cite> 和 <cite>usb_hc_low_level_init</cite> 函数中，举例如下：</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/stm32_init.png" src="../_images/stm32_init.png" />
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="transplant.html" class="btn btn-neutral float-left" title="芯片通用移植指南" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="esp.html" class="btn btn-neutral float-right" title="基于 ESP-Registry 开发指南" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2024, 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>
|
||||
233
quick_start/start.html
Normal file
233
quick_start/start.html
Normal file
@@ -0,0 +1,233 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>入门必看 — CherryUSB 1.4.0 documentation</title><link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<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/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="基于现有 demo 快速验证" href="demo.html" />
|
||||
<link rel="prev" title="CherryUSB 使用指南" href="../index.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 class="version">
|
||||
1.4.0
|
||||
</div>
|
||||
<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"><span class="caption-text">快速上手</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">入门必看</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id2">第一步</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id3">第二步</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id4">第三步</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id5">第四步</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id6">第五步</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id7">第六步</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id8">第七步</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id9">第八步</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="demo.html">基于现有 demo 快速验证</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="transplant.html">芯片通用移植指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="rtthread.html">基于 RT-Thread 软件包开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="esp.html">基于 ESP-Registry 开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../q&a.html">Q & A</a></li>
|
||||
</ul>
|
||||
<p class="caption"><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"><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>
|
||||
<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"><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>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_msc.html">usbd_msc</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_rndis.html">usbd_rndis</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_ecm.html">usbd_cdc_ecm</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_audiov1.html">usbd_audiov1</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_audiov2.html">usbd_audiov2</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_video.html">usbd_video</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_winusb.html">usbd_winusb</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_webusb.html">usbd_webusb</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_serial.html">usbh_serial</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_hid.html">usbh_hid</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_msc.html">usbh_msc</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_net.html">usbh_net</a></li>
|
||||
<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>
|
||||
<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"><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"><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>
|
||||
<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">入门必看</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="../_sources/quick_start/start.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">
|
||||
|
||||
<div class="section" id="id1">
|
||||
<h1>入门必看<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h1>
|
||||
<p>首先欢迎大家来到 usb 的世界，在这里你可以学习到 usb 各种知识以及 cherryusb 的移植使用进阶等等。但是呢，刚进来的你，一定很懵懂，因为 USB 很难（其实当你学会了 cherryusb以后，你会发现，USB 一点都不难），
|
||||
那么这种情况下，你的学习路线，应该是怎么样呢？在这里，我推荐大家是按照我得学习路线来学习，这样对你的 USB 成长是最有帮助的，并且你也不会中途放弃。</p>
|
||||
<p>首先，不允许上来就看概念，有句古诗说的好， <strong>纸上得来终觉浅，绝知此事要躬行</strong> ，光看纸面上的东西，你是学不到什么的，只有当自己实践了，你才能更深入的了解这些概念。那么作为初学者，你应该怎么做呢？请看以下步骤。</p>
|
||||
<div class="section" id="id2">
|
||||
<h2>第一步<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
|
||||
<p>你需要学过 C 语言，UART, DMA，这是基础，如果没学过，请去学习，不然你会很吃力。你会问 USB 跟 UART/DMA 有什么关系？ 我只能说两个字， <strong>等价</strong></p>
|
||||
</div>
|
||||
<div class="section" id="id3">
|
||||
<h2>第二步<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
|
||||
<p>下载 demo 工程并跑通能运行， <strong>建议学习慢的，使用 demo 同型号芯片</strong>，学习快的，可以选择自己移植相关支持的型号的芯片。你连 demo 都跑不通，你学什么 USB，你说对不对？</p>
|
||||
</div>
|
||||
<div class="section" id="id4">
|
||||
<h2>第三步<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
|
||||
<p>非常好，到这步，说明你已经能熟练移植和跑通所有示例了，那么接下来，你应该学习什么呢？请直接跳到 <strong>USB 枚举</strong> 章节，了解下 USB 枚举过程，然后你会知道 USB 的两个概念， <strong>请求</strong> 和 <strong>描述符</strong>。群文件有各类设备枚举的抓包，可以下下来看看。</p>
|
||||
</div>
|
||||
<div class="section" id="id5">
|
||||
<h2>第四步<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h2>
|
||||
<p>当你看了 <strong>USB 枚举</strong> 章节并且知道了一个概念， <strong>描述符</strong> 以后，这个时候，你就可以去简单看看什么是描述符，有哪些描述符，然后你需要记住， <strong>设备、配置、接口、端点描述符的组成</strong>，并背下来，其余的你都不需要知道，因为其他都是固定的，后续都是 CV 。</p>
|
||||
</div>
|
||||
<div class="section" id="id6">
|
||||
<h2>第五步<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h2>
|
||||
<p>然后呢，你可以再去看看请求结构体的组成，看看有哪些请求，简单了解即可，为什么呢？因为它不过就是 8 字节的数据格式，大家都会写一个 UART + 自定义协议，那么 USB 的请求也是一样的，只不过是规定好了而已。</p>
|
||||
</div>
|
||||
<div class="section" id="id7">
|
||||
<h2>第六步<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h2>
|
||||
<p>这个时候，你该去熟悉下协议栈的一些 API 了，参考 API 手册章节，记住，都要看完哦</p>
|
||||
</div>
|
||||
<div class="section" id="id8">
|
||||
<h2>第七步<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h2>
|
||||
<p>到这步呢，你肯定已经非常懂了，然后就可以开始你的一些小功能小项目了，在此期间呢，请查看 <strong>USB 知识点拓展</strong> 章节，因为有些东西，他比较重要，也是需要反复说明的。</p>
|
||||
</div>
|
||||
<div class="section" id="id9">
|
||||
<h2>第八步<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h2>
|
||||
<p>都到这步了，你应该不需要我了，这个时候，你可以去看看 USB 概念，看看 USB 的一些细节，看看 CherryUSB 的代码流程了。然后就是巩固巩固再巩固了。恭喜你，出师了！！！</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="../index.html" class="btn btn-neutral float-left" title="CherryUSB 使用指南" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="demo.html" class="btn btn-neutral float-right" title="基于现有 demo 快速验证" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2024, 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>
|
||||
303
quick_start/transplant.html
Normal file
303
quick_start/transplant.html
Normal file
@@ -0,0 +1,303 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>芯片通用移植指南 — CherryUSB 1.4.0 documentation</title><link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<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/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="基于 RT-Thread 软件包开发指南" href="rtthread.html" />
|
||||
<link rel="prev" title="基于现有 demo 快速验证" href="demo.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 class="version">
|
||||
1.4.0
|
||||
</div>
|
||||
<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"><span class="caption-text">快速上手</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="start.html">入门必看</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="demo.html">基于现有 demo 快速验证</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">芯片通用移植指南</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#usb-device">USB Device 移植要点</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#usb-host">USB Host 移植要点</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#cache">带 cache 功能的芯片使用注意</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="rtthread.html">基于 RT-Thread 软件包开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="esp.html">基于 ESP-Registry 开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../q&a.html">Q & A</a></li>
|
||||
</ul>
|
||||
<p class="caption"><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"><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>
|
||||
<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"><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>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_msc.html">usbd_msc</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_rndis.html">usbd_rndis</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_ecm.html">usbd_cdc_ecm</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_audiov1.html">usbd_audiov1</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_audiov2.html">usbd_audiov2</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_video.html">usbd_video</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_winusb.html">usbd_winusb</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbd_webusb.html">usbd_webusb</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_serial.html">usbh_serial</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_hid.html">usbh_hid</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_msc.html">usbh_msc</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../demo/usbh_net.html">usbh_net</a></li>
|
||||
<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>
|
||||
<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"><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"><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>
|
||||
<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">芯片通用移植指南</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="../_sources/quick_start/transplant.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">
|
||||
|
||||
<div class="section" id="id1">
|
||||
<h1>芯片通用移植指南<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h1>
|
||||
<p>本节主要介绍所有带 USB IP 的芯片，移植 CherryUSB 主从协议栈时的通用步骤和注意事项。在移植之前，需要 <strong>你准备好一个可以打印 helloworld 的基本工程</strong> ，默认打印使用 <cite>printf</cite>, 如果是主机模式， <strong>则需要准备好可以正常执行 os 调度的基本工程</strong>。</p>
|
||||
<div class="section" id="usb-device">
|
||||
<h2>USB Device 移植要点<a class="headerlink" href="#usb-device" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>拷贝 CherryUSB 源码到工程目录下，并按需添加源文件和头文件路径，其中 <cite>usbd_core.c</cite> 和 <cite>usb_dc_xxx.c</cite> 为必须添加项。而 <cite>usb_dc_xxx.c</cite> 是芯片所对应的 USB IP dcd 部分驱动，如果不知道自己芯片属于那个 USB IP，参考 <strong>port</strong> 目录下的不同 USB IP 的 readme。如果使用的 USB IP 没有支持，只能自己实现了</p></li>
|
||||
<li><p>拷贝 <cite>cherryusb_config_template.h</cite> 文件到自己工程目录下，命名为 <cite>usb_config.h</cite>，并添加相应的目录头文件路径</p></li>
|
||||
<li><p>实现 <cite>usb_dc_low_level_init</cite> 函数（该函数主要负责 USB 时钟、引脚、中断的初始化）。该函数可以放在你想要放的任何参与编译的 c 文件中。如何进行 USB 的时钟、引脚、中断等初始化，请自行根据你使用的芯片原厂提供的源码中进行添加。</p></li>
|
||||
<li><p>描述符的注册、class的注册、接口的注册、端点中断的注册。不会的参考 demo 下的 template</p></li>
|
||||
<li><p>调用 <cite>usbd_initialize</cite> 并填入 <cite>busid</cite> 和 USB IP 的 <cite>reg base</cite>， <cite>busid</cite> 从 0 开始，不能超过 <cite>CONFIG_USBDEV_MAX_BUS</cite></p></li>
|
||||
<li><p>在中断函数中调用 <cite>USBD_IRQHandler</cite>，并传入 <cite>busid</cite>, 如果你的 SDK 中中断入口已经存在 <cite>USBD_IRQHandler</cite> ，请更改 USB 协议栈中的名称</p></li>
|
||||
<li><p>编译使用。各个 class 如何使用，参考 demo 下的 template</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="usb-host">
|
||||
<h2>USB Host 移植要点<a class="headerlink" href="#usb-host" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>拷贝 CherryUSB 源码到工程目录下，并按需添加源文件和头文件路径，其中 <cite>usbh_core.c</cite> 、 <cite>usb_hc_xxx.c</cite> 以及 <strong>osal</strong> 目录下源文件（根据不同的 os 选择对应的源文件）为必须添加项。而 <cite>usb_hc_xxx.c</cite> 是芯片所对应的 USB IP hcd 部分驱动，如果不知道自己芯片属于那个 USB IP，参考 <strong>port</strong> 目录下的不同 USB IP 的 readme。如果使用的 USB IP 没有支持，只能自己实现了</p></li>
|
||||
<li><p>拷贝 <cite>cherryusb_config_template.h</cite> 文件到自己工程目录下，命名为 <cite>usb_config.h</cite>，并添加相应的目录头文件路径</p></li>
|
||||
<li><p>实现 <cite>usb_hc_low_level_init</cite> 函数（该函数主要负责 USB 时钟、引脚、中断的初始化）。该函数可以放在你想要放的任何参与编译的 c 文件中。如何进行 USB 的时钟、引脚、中断等初始化，请自行根据你使用的芯片原厂提供的源码中进行添加。</p></li>
|
||||
<li><p>调用 <cite>usbh_initialize</cite> 并填入 <cite>busid</cite> 和 USB IP 的 <cite>reg base</cite>， <cite>busid</cite> 从 0 开始，不能超过 <cite>CONFIG_USBHOST_MAX_BUS</cite></p></li>
|
||||
<li><p>在中断函数中调用 <cite>USBH_IRQHandler</cite>，并传入 <cite>busid</cite>, 如果你的 SDK 中中断入口已经存在 <cite>USBH_IRQHandler</cite> ，请更改 USB 协议栈中的名称</p></li>
|
||||
<li><p>如果使用的是 GCC ，需要在链接脚本中添加如下代码（需要放在 flash 位置）：</p></li>
|
||||
</ul>
|
||||
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="c1">// 在 ld 文件中添加如下代码</span>
|
||||
<span class="p">.</span> <span class="o">=</span> <span class="n">ALIGN</span><span class="p">(</span><span class="mi">4</span><span class="p">);</span>
|
||||
<span class="n">__usbh_class_info_start__</span> <span class="o">=</span> <span class="p">.;</span>
|
||||
<span class="n">KEEP</span><span class="p">(</span><span class="o">*</span><span class="p">(.</span><span class="n">usbh_class_info</span><span class="p">))</span>
|
||||
<span class="n">__usbh_class_info_end__</span> <span class="o">=</span> <span class="p">.;</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>GCC 举例如下：</p>
|
||||
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="cm">/* The program code and other data into "FLASH" Rom type memory */</span>
|
||||
<span class="p">.</span><span class="nl">text</span> <span class="p">:</span>
|
||||
<span class="p">{</span>
|
||||
<span class="p">.</span> <span class="o">=</span> <span class="n">ALIGN</span><span class="p">(</span><span class="mi">4</span><span class="p">);</span>
|
||||
<span class="o">*</span><span class="p">(.</span><span class="n">text</span><span class="p">)</span> <span class="cm">/* .text sections (code) */</span>
|
||||
<span class="o">*</span><span class="p">(.</span><span class="n">text</span><span class="o">*</span><span class="p">)</span> <span class="cm">/* .text* sections (code) */</span>
|
||||
<span class="o">*</span><span class="p">(.</span><span class="n">glue_7</span><span class="p">)</span> <span class="cm">/* glue arm to thumb code */</span>
|
||||
<span class="o">*</span><span class="p">(.</span><span class="n">glue_7t</span><span class="p">)</span> <span class="cm">/* glue thumb to arm code */</span>
|
||||
<span class="o">*</span><span class="p">(.</span><span class="n">eh_frame</span><span class="p">)</span>
|
||||
|
||||
<span class="n">KEEP</span> <span class="p">(</span><span class="o">*</span><span class="p">(.</span><span class="n">init</span><span class="p">))</span>
|
||||
<span class="n">KEEP</span> <span class="p">(</span><span class="o">*</span><span class="p">(.</span><span class="n">fini</span><span class="p">))</span>
|
||||
<span class="p">.</span> <span class="o">=</span> <span class="n">ALIGN</span><span class="p">(</span><span class="mi">4</span><span class="p">);</span>
|
||||
<span class="n">__usbh_class_info_start__</span> <span class="o">=</span> <span class="p">.;</span>
|
||||
<span class="n">KEEP</span><span class="p">(</span><span class="o">*</span><span class="p">(.</span><span class="n">usbh_class_info</span><span class="p">))</span>
|
||||
<span class="n">__usbh_class_info_end__</span> <span class="o">=</span> <span class="p">.;</span>
|
||||
<span class="p">.</span> <span class="o">=</span> <span class="n">ALIGN</span><span class="p">(</span><span class="mi">4</span><span class="p">);</span>
|
||||
<span class="n">_etext</span> <span class="o">=</span> <span class="p">.;</span> <span class="cm">/* define a global symbols at end of code */</span>
|
||||
<span class="p">}</span> <span class="o">></span> <span class="n">FLASH</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>Segger Embedded Studio 举例如下：</p></li>
|
||||
</ul>
|
||||
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="n">define</span> <span class="n">block</span> <span class="n">cherryusb_usbh_class_info</span> <span class="p">{</span> <span class="n">section</span> <span class="p">.</span><span class="n">usbh_class_info</span> <span class="p">};</span>
|
||||
|
||||
<span class="n">define</span> <span class="n">exported</span> <span class="n">symbol</span> <span class="n">__usbh_class_info_start__</span> <span class="o">=</span> <span class="n">start</span> <span class="n">of</span> <span class="n">block</span> <span class="n">cherryusb_usbh_class_info</span><span class="p">;</span>
|
||||
<span class="n">define</span> <span class="n">exported</span> <span class="n">symbol</span> <span class="n">__usbh_class_info_end__</span> <span class="o">=</span> <span class="n">end</span> <span class="n">of</span> <span class="n">block</span> <span class="n">cherryusb_usbh_class_info</span> <span class="o">+</span> <span class="mi">1</span><span class="p">;</span>
|
||||
|
||||
<span class="n">place</span> <span class="n">in</span> <span class="n">AXI_SRAM</span> <span class="p">{</span> <span class="n">block</span> <span class="n">cherryusb_usbh_class_info</span> <span class="p">};</span>
|
||||
<span class="n">keep</span> <span class="p">{</span> <span class="n">section</span> <span class="p">.</span><span class="n">usbh_class_info</span><span class="p">};</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>编译使用。各个 class 如何使用，参考 demo 下的 <cite>usb_host.c</cite> 文件</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="cache">
|
||||
<h2>带 cache 功能的芯片使用注意<a class="headerlink" href="#cache" title="Permalink to this headline">¶</a></h2>
|
||||
<p>协议栈以及 port 中不会对 cache 区域的 ram 进行 clean 或者 invalid，所以需要使用一块非 cache 区域的 ram 来维护。 <cite>USB_NOCACHE_RAM_SECTION</cite> 宏表示将变量指定到非 cache ram上，
|
||||
因此，用户需要在对应的链接脚本中添加 no cache ram 的 section。默认 <cite>USB_NOCACHE_RAM_SECTION</cite> 定义为 <cite>__attribute__((section(“.noncacheable”)))</cite>。</p>
|
||||
<p>GCC:</p>
|
||||
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="n">MEMORY</span>
|
||||
<span class="p">{</span>
|
||||
<span class="n">RAM</span> <span class="p">(</span><span class="n">xrw</span><span class="p">)</span> <span class="o">:</span> <span class="n">ORIGIN</span> <span class="o">=</span> <span class="mh">0x20000000</span><span class="p">,</span> <span class="n">LENGTH</span> <span class="o">=</span> <span class="mi">256</span><span class="n">K</span> <span class="o">-</span> <span class="mi">64</span><span class="n">K</span>
|
||||
<span class="n">RAM_nocache</span> <span class="p">(</span><span class="n">xrw</span><span class="p">)</span> <span class="o">:</span> <span class="n">ORIGIN</span> <span class="o">=</span> <span class="mh">0x20030000</span><span class="p">,</span> <span class="n">LENGTH</span> <span class="o">=</span> <span class="mi">64</span><span class="n">K</span>
|
||||
<span class="n">FLASH</span> <span class="p">(</span><span class="n">rx</span><span class="p">)</span> <span class="o">:</span> <span class="n">ORIGIN</span> <span class="o">=</span> <span class="mh">0x8000000</span><span class="p">,</span> <span class="n">LENGTH</span> <span class="o">=</span> <span class="mi">512</span><span class="n">K</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="p">.</span><span class="nl">_nocache_ram</span> <span class="p">:</span>
|
||||
<span class="p">{</span>
|
||||
<span class="p">.</span> <span class="o">=</span> <span class="n">ALIGN</span><span class="p">(</span><span class="mi">4</span><span class="p">);</span>
|
||||
<span class="o">*</span><span class="p">(.</span><span class="n">noncacheable</span><span class="p">)</span>
|
||||
<span class="p">}</span> <span class="o">></span><span class="n">RAM_nocache</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>SCT:</p>
|
||||
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span>LR_IROM1 0x08000000 0x00200000 { ; load region size_region
|
||||
ER_IROM1 0x08000000 0x00200000 { ; load address = execution address
|
||||
*.o (RESET, +First)
|
||||
*(InRoot$$Sections)
|
||||
.ANY (+RO)
|
||||
.ANY (+XO)
|
||||
}
|
||||
RW_IRAM2 0x24000000 0x00070000 { ; RW data
|
||||
.ANY (+RW +ZI)
|
||||
}
|
||||
USB_NOCACHERAM 0x24070000 0x00010000 { ; RW data
|
||||
*(.noncacheable)
|
||||
}
|
||||
}
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>ICF:</p>
|
||||
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="n">define</span> <span class="n">region</span> <span class="n">NONCACHEABLE_RAM</span> <span class="o">=</span> <span class="p">[</span><span class="n">from</span> <span class="mh">0x1140000</span> <span class="n">size</span> <span class="mi">256</span><span class="n">K</span><span class="p">];</span>
|
||||
<span class="n">place</span> <span class="n">in</span> <span class="n">NONCACHEABLE_RAM</span> <span class="p">{</span> <span class="n">section</span> <span class="p">.</span><span class="n">noncacheable</span><span class="p">,</span> <span class="n">section</span> <span class="p">.</span><span class="n">noncacheable</span><span class="p">.</span><span class="n">init</span><span class="p">,</span> <span class="n">section</span> <span class="p">.</span><span class="n">noncacheable</span><span class="p">.</span><span class="n">bss</span> <span class="p">};</span> <span class="c1">// Noncacheable</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="demo.html" class="btn btn-neutral float-left" title="基于现有 demo 快速验证" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="rtthread.html" class="btn btn-neutral float-right" title="基于 RT-Thread 软件包开发指南" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2024, 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>
|
||||
Reference in New Issue
Block a user