| <!-- |
| Documentation/_templates/layout.html |
| |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. The |
| ASF licenses this file to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance with the |
| License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| License for the specific language governing permissions and limitations |
| under the License. |
| --> |
| |
| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en"> |
| <head> |
| <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>USB Device-Side Drivers — NuttX latest documentation</title> |
| <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" /> |
| <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css" /> |
| <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" /> |
| <link rel="stylesheet" type="text/css" href="../../../_static/custom.css" /> |
| |
| |
| <link rel="shortcut icon" href="../../../_static/favicon.ico"/> |
| <script src="../../../_static/jquery.js"></script> |
| <script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script> |
| <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> |
| <script src="../../../_static/doctools.js"></script> |
| <script src="../../../_static/sphinx_highlight.js"></script> |
| <script src="../../../_static/clipboard.min.js"></script> |
| <script src="../../../_static/copybutton.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="USB Host-Side Drivers" href="usbhost.html" /> |
| <link rel="prev" title="SDIO Device Drivers" href="sdio.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"> NuttX |
| |
| |
| |
| </a> |
| |
| <!-- this version selector is quite ugly, should be probably replaced by something |
| more modern --> |
| |
| <div class="version-selector"> |
| <select onchange="javascript:location.href = this.value;"> |
| |
| <option value="../../../../latest" selected="selected">latest</option> |
| |
| <option value="../../../../10.0.0" >10.0.0</option> |
| |
| <option value="../../../../10.0.1" >10.0.1</option> |
| |
| <option value="../../../../10.1.0" >10.1.0</option> |
| |
| <option value="../../../../10.2.0" >10.2.0</option> |
| |
| <option value="../../../../10.3.0" >10.3.0</option> |
| |
| <option value="../../../../11.0.0" >11.0.0</option> |
| |
| <option value="../../../../12.0.0" >12.0.0</option> |
| |
| <option value="../../../../12.1.0" >12.1.0</option> |
| |
| <option value="../../../../12.2.0" >12.2.0</option> |
| |
| <option value="../../../../12.2.1" >12.2.1</option> |
| |
| <option value="../../../../12.3.0" >12.3.0</option> |
| |
| <option value="../../../../12.4.0" >12.4.0</option> |
| |
| <option value="../../../../12.5.0" >12.5.0</option> |
| |
| <option value="../../../../12.5.1" >12.5.1</option> |
| |
| <option value="../../../../12.6.0" >12.6.0</option> |
| |
| <option value="../../../../12.7.0" >12.7.0</option> |
| |
| <option value="../../../../12.8.0" >12.8.0</option> |
| |
| <option value="../../../../12.9.0" >12.9.0</option> |
| |
| <option value="../../../../12.10.0" >12.10.0</option> |
| |
| <option value="../../../../12.11.0" >12.11.0</option> |
| |
| </select> |
| </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" role="heading"><span class="caption-text">Table of Contents</span></p> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../../../index.html">Home</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../introduction/index.html">Introduction</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../quickstart/index.html">Getting Started</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../contributing/index.html">Contributing</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../platforms/index.html">Supported Platforms</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">OS Components</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="../../binfmt.html">Binary Loader</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="../index.html">Device Drivers</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="../character/index.html">Character Device Drivers</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../block/index.html">Block Device Drivers</a></li> |
| <li class="toctree-l3 current"><a class="reference internal" href="index.html">Specialized Device Drivers</a><ul class="current"> |
| <li class="toctree-l4"><a class="reference internal" href="audio.html">Audio Device Drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="clk.html">Clock management (CLK)</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="devicetree.html">Device Tree support</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="devmem.html">DEVMEM Drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="dma.html">DMA Drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="framebuffer.html">Frame Buffer Drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="i2c.html">I2C Device Drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="ioexpander.html">IO Expander Device Drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="lcd.html">LCD Character Drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="mtd.html">Memory Technology Device Drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="regmap.html">drivers/regmap</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="reset.html">Reset Driver</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="rptun.html">Remote Proc Tunnel Drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="rwbuffer.html"><code class="docutils literal notranslate"><span class="pre">rwbuffer.c</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="sensors.html">Sensor Drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="segger.html">Segger RTT drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="spi.html">SPI Device Drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="syslog.html">SYSLOG</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="sdio.html">SDIO Device Drivers</a></li> |
| <li class="toctree-l4 current"><a class="current reference internal" href="#">USB Device-Side Drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="usbhost.html">USB Host-Side Drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="usbmisc.html">USB Miscellaneous Drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="usbmonitor.html">USB Monitor support</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="usrsock.html">Usrsock Driver</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="mmcsd.html">MMCSD Device Drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="net/index.html">Network interface drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="pinctrl.html">Pinctrl Device Drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="pipes.html">FIFO and named pipe drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="power/index.html">Power-related Drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="virtio.html">Virtio Device Drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="video.html">Video Device Drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="wireless.html">Wireless Drivers</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../thermal/index.html">Thermal Framework</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../index.html#lower-half-and-upper-half">Lower-half and upper-half</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../index.html#subdirectories-of-nuttx-drivers">Subdirectories of <code class="docutils literal notranslate"><span class="pre">nuttx/drivers</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../index.html#skeleton-files">Skeleton Files</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../index.html#drivers-early-initialization">Drivers Early Initialization</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../nxflat.html">NXFLAT</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../nxgraphics/index.html">NX Graphics Subsystem</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../paging.html">On-Demand Paging</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../audio/index.html">Audio Subsystem</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../filesystem/index.html">NuttX File System</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../libs/index.html">NuttX libraries</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../net/index.html">Network Support</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../mm/index.html">Memory Management</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../syscall.html">Syscall Layer</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../tools/index.html"><code class="docutils literal notranslate"><span class="pre">/tools</span></code> Host Tools</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../arch/index.html">Architecture-Specific Code</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../boards.html">Boards Support</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../cmake.html">CMake Support</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../openamp.html">OpenAMP Support</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../video.html">Video Subsystem</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../crypto.html">Crypto API Subsystem</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../wireless.html">Wireless Subsystem</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../applications/index.html">Applications</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../implementation/index.html">Implementation Details</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../reference/index.html">API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../faq/index.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../guides/index.html">Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../logos/index.html">NuttX Logos</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">NuttX</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"><a href="../../index.html">OS Components</a></li> |
| <li class="breadcrumb-item"><a href="../index.html">Device Drivers</a></li> |
| <li class="breadcrumb-item"><a href="index.html">Specialized Device Drivers</a></li> |
| <li class="breadcrumb-item active">USB Device-Side Drivers</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="../../../_sources/components/drivers/special/usbdev.rst.txt" rel="nofollow"> View page source</a> |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <section id="usb-device-side-drivers"> |
| <h1>USB Device-Side Drivers<a class="headerlink" href="#usb-device-side-drivers" title="Permalink to this heading"></a></h1> |
| <ul> |
| <li><p><code class="docutils literal notranslate"><span class="pre">include/nuttx/usb/usbdev.h</span></code>. All structures and APIs |
| needed to work with USB device-side drivers are provided in |
| this header file.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">include/nuttx/usb/usbdev_trace.h</span></code>. Declarations needed |
| to work with the NuttX USB device driver trace capability. That |
| USB trace capability is detailed in <a class="reference internal" href="../../../guides/usbtrace.html#usbtrace"><span class="std std-ref">separate |
| document</span></a>.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">struct</span> <span class="pre">usbdev_s</span></code>. Each USB device controller driver must |
| implement an instance of <code class="docutils literal notranslate"><span class="pre">struct</span> <span class="pre">usbdev_s</span></code>. This structure is |
| defined in <code class="docutils literal notranslate"><span class="pre">include/nuttx/usb/usbdev.h</span></code>.</p> |
| <p><strong>Examples</strong>: <code class="docutils literal notranslate"><span class="pre">arch/arm/src/dm320/dm320_usbdev.c</span></code>, |
| <code class="docutils literal notranslate"><span class="pre">arch/arm/src/lpc17xx_40xx/lpc17_40_usbdev.c</span></code>, |
| <code class="docutils literal notranslate"><span class="pre">arch/arm/src/lpc214x/lpc214x_usbdev.c</span></code>, |
| <code class="docutils literal notranslate"><span class="pre">arch/arm/src/lpc313x/lpc313x_usbdev.c</span></code>, and |
| <code class="docutils literal notranslate"><span class="pre">arch/arm/src/stm32/stm32_usbdev.c</span></code>.</p> |
| </li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">struct</span> <span class="pre">usbdevclass_driver_s</span></code>. Each USB device class |
| driver must implement an instance of |
| <code class="docutils literal notranslate"><span class="pre">struct</span> <span class="pre">usbdevclass_driver_s</span></code>. This structure is also defined |
| in <code class="docutils literal notranslate"><span class="pre">include/nuttx/usb/usbdev.h</span></code>.</p> |
| <p><strong>Examples</strong>: <code class="docutils literal notranslate"><span class="pre">drivers/usbdev/pl2303.c</span></code> and |
| <code class="docutils literal notranslate"><span class="pre">drivers/usbdev/usbmsc.c</span></code></p> |
| </li> |
| <li><p><strong>Binding USB Device-Side Drivers</strong>. USB device-side controller |
| drivers are not normally directly accessed by user code, but |
| are usually bound to another, higher level USB device class |
| driver. The class driver is then configured to export the USB |
| device functionality. In general, the binding sequence is:</p> |
| <ol class="arabic"> |
| <li><p>Each USB device class driver includes an initialization |
| entry point that is called from the application at |
| initialization time.</p> |
| <p><strong>Examples</strong>: The function <code class="docutils literal notranslate"><span class="pre">usbdev_serialinitialize()</span></code> in |
| the file <code class="docutils literal notranslate"><span class="pre">drivers/usbdev/pl2303.c</span></code> and the function |
| in the file <code class="docutils literal notranslate"><span class="pre">drivers/usbdev/usbmsc.c</span></code></p> |
| </li> |
| <li><p>These initialization functions called the driver API, |
| <code class="docutils literal notranslate"><span class="pre">usbdev_register()</span></code>. This driver function will <em>bind</em> the |
| USB class driver to the USB device controller driver, |
| completing the initialization.</p></li> |
| </ol> |
| </li> |
| </ul> |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="sdio.html" class="btn btn-neutral float-left" title="SDIO Device Drivers" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="usbhost.html" class="btn btn-neutral float-right" title="USB Host-Side Drivers" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright 2023, The Apache Software Foundation.</p> |
| </div> |
| |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
