| <!-- |
| 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="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>Memory Technology Device Drivers — NuttX latest documentation</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/sphinx_tabs/semantic-ui-2.4.1/segment.min.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/sphinx_tabs/semantic-ui-2.4.1/menu.min.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/sphinx_tabs/semantic-ui-2.4.1/tab.min.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/sphinx_tabs/tabs.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/custom.css" type="text/css" /> |
| |
| |
| |
| <link rel="shortcut icon" href="../../../_static/favicon.ico"/> |
| |
| |
| |
| |
| |
| <!--[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 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 type="text/javascript" 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="SDIO Device Drivers" href="sdio.html" /> |
| <link rel="prev" title="LCD Drivers" href="lcd.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 |
| |
| |
| |
| |
| <img src="../../../_static/NuttX.png" class="logo" alt="Logo"/> |
| |
| </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" /> |
| <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">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="../../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../quickstart/index.html">Getting Started</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="../../nsh/index.html">NuttShell (NSH)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../power.html">Power Management</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../socketcan.html">SocketCAN Device Drivers</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../syslog.html">SYSLOG</a></li> |
| <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="spi.html">SPI Device 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="ethernet.html">Ethernet Device 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="lcd.html">LCD Drivers</a></li> |
| <li class="toctree-l4 current"><a class="current reference internal" href="#">Memory Technology Device Drivers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="sdio.html">SDIO Device 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="usbdev.html">USB Device-Side Drivers</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../index.html#lower-half-and-upper-half">Lower-half and upper-half</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../filesystem.html">NuttX File System</a></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="../../nxwidgets.html">NxWidgets</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../paging.html">On-Demand Paging</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="../../../boards/index.html">Supported Boards</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="../../../guides/index.html">Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../releases/index.html">Releases</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="../../../glossary.html">Glossary</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">NuttX</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> »</li> |
| |
| <li><a href="../../index.html">OS Components</a> »</li> |
| |
| <li><a href="../index.html">Device Drivers</a> »</li> |
| |
| <li><a href="index.html">Specialized Device Drivers</a> »</li> |
| |
| <li>Memory Technology Device Drivers</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../../../_sources/components/drivers/special/mtd.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="memory-technology-device-drivers"> |
| <h1>Memory Technology Device Drivers<a class="headerlink" href="#memory-technology-device-drivers" title="Permalink to this headline">ΒΆ</a></h1> |
| <ul> |
| <li><p><code class="docutils literal notranslate"><span class="pre">include/nuttx/mtd/mtd.h</span></code>. All structures and APIs needed |
| to work with MTD drivers are provided in this header file.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">struct</span> <span class="pre">mtd_dev_s</span></code>. Each MTD device driver must implement |
| an instance of <code class="docutils literal notranslate"><span class="pre">struct</span> <span class="pre">mtd_dev_s</span></code>. That structure defines a |
| call table with the following methods:</p> |
| <p>Erase the specified erase blocks (units are erase blocks):</p> |
| <p>Read/write from the specified read/write blocks:</p> |
| <p>Some devices may support byte oriented reads (optional). Most |
| MTD devices are inherently block oriented so byte-oriented |
| accesses are not supported. It is recommended that low-level |
| drivers not support read() if it requires buffering.</p> |
| <p>Some devices may also support byte oriented writes (optional). |
| Most MTD devices are inherently block oriented so byte-oriented |
| accesses are not supported. It is recommended that low-level |
| drivers not support read() if it requires buffering. This |
| interface is only available if <code class="docutils literal notranslate"><span class="pre">CONFIG_MTD_BYTE_WRITE</span></code> is |
| defined.</p> |
| <p>Support other, less frequently used commands:</p> |
| <ul class="simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">MTDIOC_GEOMETRY</span></code>: Get MTD geometry</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">MTDIOC_XIPBASE:</span></code>: Convert block to physical address for |
| eXecute-In-Place</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">MTDIOC_BULKERASE</span></code>: Erase the entire device</p></li> |
| </ul> |
| <p>is provided via a single <code class="docutils literal notranslate"><span class="pre">ioctl</span></code> method (see |
| <code class="docutils literal notranslate"><span class="pre">include/nuttx/fs/ioctl.h</span></code>):</p> |
| </li> |
| <li><p><strong>Binding MTD Drivers</strong>. MTD drivers are not normally directly |
| accessed by user code, but are usually bound to another, higher |
| level device driver. In general, the binding sequence is:</p> |
| <ol class="arabic simple"> |
| <li><p>Get an instance of <code class="docutils literal notranslate"><span class="pre">struct</span> <span class="pre">mtd_dev_s</span></code> from the |
| hardware-specific MTD device driver, and</p></li> |
| <li><p>Provide that instance to the initialization method of the |
| higher level device driver.</p></li> |
| </ol> |
| </li> |
| <li><p><strong>Examples</strong>: <code class="docutils literal notranslate"><span class="pre">drivers/mtd/m25px.c</span></code> and <code class="docutils literal notranslate"><span class="pre">drivers/mtd/ftl.c</span></code></p></li> |
| </ul> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| © Copyright 2020, The Apache Software Foundation |
| |
| </p> |
| </div> |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
