cherry-embedded
/
CherryUSB
зеркало из https://github-proxy.rt-thread.io/cherry-embedded/CherryUSB.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327
							

<!DOCTYPE html>
<html class="writer-html5" lang="zh-CN" >
<head>
  <meta charset="utf-8" />
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  
  <title>RT-Thread based Software Package Development Guide &mdash; CherryUSB 使用指南  文档</title>
  

  <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />

  
  <!--[if lt IE 9]>
    <script src="../../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
        <script data-url_root="../../" id="documentation_options" 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/translations.js"></script>
    
    <script type="text/javascript" src="../../_static/js/theme.js"></script>

    
    <link rel="index" title="索引" href="../../genindex.html" />
    <link rel="search" title="搜索" href="../../search.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

            <a href="../../index.html" class="icon icon-home"> CherryUSB 使用指南
          

          </a>

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
    <input type="text" name="q" placeholder="在文档中搜索" />
    <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="main navigation">
          
            
              <p class="caption"><span class="caption-text">快速入门</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../bl702.html">基于 BL702 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../stm32f429.html">基于 STM32F429 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../usb/usb_basic.html">USB 基本概念</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>
</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_common.html">其他</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/usb2uart.html">USB 转串口</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../demo/mouse_keyboard.html">键盘与鼠标</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../demo/msc_boot.html">U盘制作 BootLoader</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../demo/video.html">USB 摄像头</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../porting.html">Porting 编写说明</a></li>
</ul>

            
        </div>
        
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <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="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
        
      <li>RT-Thread based Software Package Development Guide</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="../../_sources/quick_start/rt-thread/rt-thread.md.txt" rel="nofollow"> 查看页面源码</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-based-software-package-development-guide">
<h1>RT-Thread based Software Package Development Guide<a class="headerlink" href="#rt-thread-based-software-package-development-guide" title="永久链接至标题">¶</a></h1>
<p><a class="reference internal" href="rt-thread_zh.html"><span class="doc">中文版</span></a></p>
<p>To use CherryUSB package, you need to select it in the RT-Thread package manager. The specific path is as follows:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-&gt;</span> <span class="n">RT</span><span class="o">-</span><span class="n">Thread</span> <span class="n">online</span> <span class="n">packages</span>
    <span class="o">-&gt;</span> <span class="n">system</span> <span class="n">packages</span>
        <span class="o">---</span> <span class="n">CherryUSB</span><span class="p">:</span> <span class="n">tiny</span> <span class="ow">and</span> <span class="n">portable</span> <span class="n">USB</span> <span class="n">stack</span> <span class="k">for</span> <span class="n">embedded</span> <span class="n">system</span> <span class="k">with</span> <span class="n">USB</span> <span class="n">IP</span>

            <span class="n">CherryUSB</span> <span class="n">Options</span>  <span class="o">----&gt;</span>
                    <span class="n">USB</span> <span class="n">Speed</span> <span class="p">(</span><span class="n">FS</span><span class="p">)</span>  <span class="o">---&gt;</span>
                    <span class="p">[</span><span class="o">*</span><span class="p">]</span> <span class="n">Enable</span> <span class="n">usb</span> <span class="n">device</span> <span class="n">mode</span>
                    <span class="p">[</span><span class="o">*</span><span class="p">]</span>   <span class="n">Enable</span> <span class="n">usb</span> <span class="n">cdc</span> <span class="n">acm</span> <span class="n">device</span>
                    <span class="p">[</span> <span class="p">]</span>   <span class="n">Enable</span> <span class="n">usb</span> <span class="n">hid</span> <span class="n">device</span>
                    <span class="p">[</span> <span class="p">]</span>   <span class="n">Enable</span> <span class="n">usb</span> <span class="n">dfu</span> <span class="n">device</span>
                    <span class="p">[</span> <span class="p">]</span>   <span class="n">Enable</span> <span class="n">usb</span> <span class="n">msc</span> <span class="n">device</span>
                    <span class="p">[</span> <span class="p">]</span>   <span class="n">Enable</span> <span class="n">usb</span> <span class="n">hub</span> <span class="n">device</span>
                    <span class="p">[</span> <span class="p">]</span>   <span class="n">Enable</span> <span class="n">usb</span> <span class="n">audio</span> <span class="n">device</span>
                    <span class="p">[</span> <span class="p">]</span>   <span class="n">Enable</span> <span class="n">usb</span> <span class="n">video</span> <span class="n">device</span>

            <span class="n">Version</span> <span class="p">(</span><span class="n">latest</span><span class="p">)</span>  <span class="o">---&gt;</span>
</pre></div>
</div>
<div class="section" id="based-on-stm32-platform">
<h2>Based ON STM32 Platform<a class="headerlink" href="#based-on-stm32-platform" title="永久链接至标题">¶</a></h2>
<p>Please note that stm32 series have two usb ip. For usb ip, like stm32f0、stm32f1、stm32f3, for usb otg ip(as we know it is from <strong>synopsys</strong>),like stm32f4、stm32f7 and so on.</p>
<div class="section" id="use-usb-device">
<h3>Use USB Device<a class="headerlink" href="#use-usb-device" title="永久链接至标题">¶</a></h3>
<ul class="simple">
<li><p>Firstly,you should have a bsp project,and then go to <code class="docutils literal notranslate"><span class="pre">board\CubeMX_Config</span></code> directory, open file that suffix name with <code class="docutils literal notranslate"><span class="pre">.ioc</span></code> in <strong>STM32CubeMX</strong>.</p></li>
<li><p>Enable <strong>USB</strong> or <strong>USB_OTG_FS</strong> or <strong>USB_OTG_HS</strong> in <strong>Connectivity</strong> List,enable USB IRQ in <strong>NVIC Setting</strong>.</p></li>
</ul>
<p><img alt="STM32CubeMX USB setting" src="../../_images/stm32cubemx.png" /></p>
<ul class="simple">
<li><p>Enable USB Clock for 48Mhz in <strong>Clock configuration</strong>.</p></li>
</ul>
<p><img alt="STM32CubeMX USB clock" src="../../_images/stm32cubemx_clk.png" /></p>
<ul class="simple">
<li><p>Generate code.</p></li>
<li><p>Copy <strong>SystemClock_Config</strong> into <strong>board.c</strong>.</p></li>
<li><p>~~Copy <strong>MX_USB_OTG_FS_PCD_Init</strong> or <strong>MX_USB_OTG_HS_PCD_Init</strong> into <strong>main.c</strong> if you use <strong>usb_dc_hal.c</strong>.Also, USB Irq from <strong>it.c</strong> needs the same.~~</p></li>
<li><p>Implement <strong>usb_dc_low_level_init</strong> and copy codes in from <code class="docutils literal notranslate"><span class="pre">HAL_PCD_MspInit</span></code>.</p></li>
</ul>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">void</span> <span class="n">usb_dc_low_level_init</span><span class="p">(</span><span class="n">void</span><span class="p">)</span>
<span class="p">{</span>
    <span class="o">/*</span> <span class="n">Peripheral</span> <span class="n">clock</span> <span class="n">enable</span> <span class="o">*/</span>
    <span class="n">__HAL_RCC_USB_CLK_ENABLE</span><span class="p">();</span>
    <span class="o">/*</span> <span class="n">USB</span> <span class="n">interrupt</span> <span class="n">Init</span> <span class="o">*/</span>
    <span class="n">HAL_NVIC_SetPriority</span><span class="p">(</span><span class="n">USB_LP_CAN1_RX0_IRQn</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
    <span class="n">HAL_NVIC_EnableIRQ</span><span class="p">(</span><span class="n">USB_LP_CAN1_RX0_IRQn</span><span class="p">);</span>

<span class="p">}</span>
</pre></div>
</div>
<ul class="simple">
<li><p>Implement <strong>printf</strong> or modify with <strong>rt_kprintf</strong> in <strong>usb_utils.h</strong>, usb stack needs.</p></li>
<li><p>Now we can call some functions provided by <strong>usb_stack</strong>.Your should register descriptors、interfaces and endpoint callback firstly, and then call <code class="docutils literal notranslate"><span class="pre">usb_dc_init</span></code>. Example is as follows:</p></li>
</ul>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">int</span> <span class="n">main</span><span class="p">(</span><span class="n">void</span><span class="p">)</span>
<span class="p">{</span>
    <span class="n">extern</span> <span class="n">void</span> <span class="n">cdc_init</span><span class="p">(</span><span class="n">void</span><span class="p">);</span>
    <span class="n">cdc_init</span><span class="p">();</span>
    <span class="n">usb_dc_init</span><span class="p">();</span>
    <span class="k">while</span> <span class="p">(</span><span class="mi">1</span><span class="p">)</span>
    <span class="p">{</span>
        <span class="n">uint8_t</span> <span class="n">data_buffer</span><span class="p">[</span><span class="mi">10</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span> <span class="mh">0x31</span><span class="p">,</span> <span class="mh">0x32</span><span class="p">,</span> <span class="mh">0x33</span><span class="p">,</span> <span class="mh">0x34</span><span class="p">,</span> <span class="mh">0x35</span><span class="p">,</span> <span class="mh">0x31</span><span class="p">,</span> <span class="mh">0x32</span><span class="p">,</span> <span class="mh">0x33</span><span class="p">,</span> <span class="mh">0x34</span><span class="p">,</span> <span class="mh">0x35</span> <span class="p">};</span>
        <span class="n">usbd_ep_write</span><span class="p">(</span><span class="mh">0x81</span><span class="p">,</span> <span class="n">data_buffer</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="n">NULL</span><span class="p">);</span>
        <span class="n">rt_thread_mdelay</span><span class="p">(</span><span class="mi">500</span><span class="p">);</span>
    <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<ul class="simple">
<li><p>How to register class you can go to <a class="reference external" href="https://github.com/sakumisu/usb_stack/tree/master/demo/stm32/stm32f103c8t6/example">stm32 class examples</a> for a reference.</p></li>
</ul>
</div>
<div class="section" id="cdc-demo-demonstration">
<h3>CDC Demo Demonstration<a class="headerlink" href="#cdc-demo-demonstration" title="永久链接至标题">¶</a></h3>
<p><img alt="CDC Demo" src="../../_images/rtt_cdc_demo.png" /></p>
</div>
<div class="section" id="video-manual">
<h3>Video manual<a class="headerlink" href="#video-manual" title="永久链接至标题">¶</a></h3>
<p>If you have problem from steps above, you can see this video：<a class="reference external" href="https://www.bilibili.com/video/BV1Ef4y1t73d?p=26">Use USB Stack in RT-Thread package manager</a>。</p>
</div>
</div>
</div>


           </div>
           
          </div>
          <footer>

  <hr/>

  <div role="contentinfo">
    <p>
        &#169; 版权所有 2022, sakumisu.

    </p>
  </div>
    
    
    利用 <a href="https://www.sphinx-doc.org/">Sphinx</a> 构建，使用了 
    
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">主题</a>
    
    由 <a href="https://readthedocs.org">Read the Docs</a>开发. 

</footer>
        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
</body>
</html>