| |
| |
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| |
| |
| |
| <title>mmc — Apache Mynewt latest documentation</title> |
| |
| |
| |
| |
| <link rel="shortcut icon" href="../../../_static/mynewt-logo-only-newt32x32.png"/> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> |
| |
| |
| <link rel="stylesheet" href="../../../_static/css/sphinx_theme.css" type="text/css" /> |
| |
| <link rel="stylesheet" href="../../../_static/css/bootstrap-3.0.3.min.css" type="text/css" /> |
| |
| <link rel="stylesheet" href="../../../_static/css/v2.css" type="text/css" /> |
| |
| <link rel="stylesheet" href="../../../_static/css/custom.css" type="text/css" /> |
| |
| <link rel="stylesheet" href="../../../_static/css/restructuredtext.css" type="text/css" /> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../../_static/css/overrides.css" type="text/css" /> |
| <link rel="index" title="Index" |
| href="../../../genindex.html"/> |
| <link rel="search" title="Search" href="../../../search.html"/> |
| <link rel="top" title="Apache Mynewt latest documentation" href="../../../index.html"/> |
| <link rel="up" title="Drivers" href="driver.html"/> |
| <link rel="next" title="Newt Manager" href="../devmgmt/newtmgr.html"/> |
| <link rel="prev" title="flash" href="flash.html"/> |
| |
| |
| <script src="../../../_static/js/modernizr.min.js"></script> |
| |
| |
| <script> |
| (function(i, s, o, g, r, a, m) { |
| i["GoogleAnalyticsObject"] = r; |
| (i[r] = |
| i[r] || |
| function() { |
| (i[r].q = i[r].q || []).push(arguments); |
| }), |
| (i[r].l = 1 * new Date()); |
| (a = s.createElement(o)), (m = s.getElementsByTagName(o)[0]); |
| a.async = 1; |
| a.src = g; |
| m.parentNode.insertBefore(a, m); |
| })(window, document, "script", "//www.google-analytics.com/analytics.js", "ga"); |
| |
| ga("create", "UA-72162311-1", "auto"); |
| ga("send", "pageview"); |
| </script> |
| |
| |
| </head> |
| |
| <body class="not-front page-documentation" role="document" > |
| <div id="wrapper"> |
| <div class="container"> |
| <div id="banner" class="row v2-main-banner"> |
| <a class="logo-cell" href="/"> |
| <img class="logo" src="../../../_static/img/logo.png"> |
| </a> |
| <div class="tagline-cell"> |
| <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> |
| </div> |
| <div class="news-cell"> |
| <div class="well"> |
| <h4>Latest News:</h4> <a href="/download">Apache Mynewt 1.12.0, Apache NimBLE 1.7.0 </a> released April 4, 2024) |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <header> |
| <nav id="navbar" class="navbar navbar-inverse" role="navigation"> |
| <div class="container"> |
| <!-- Collapsed navigation --> |
| <div class="navbar-header"> |
| <!-- Expander button --> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| </div> |
| |
| <!-- Expanded navigation --> |
| <div class="navbar-collapse collapse"> |
| <!-- Main navigation --> |
| <ul class="nav navbar-nav navbar-right"> |
| <li> |
| <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> |
| </li> |
| <li class="important"> |
| <a href="/quick-start/">Quick Start</a> |
| </li> |
| <li> |
| <a href="/about/">About</a> |
| </li> |
| <li> |
| <a href="/talks/">Talks</a> |
| </li> |
| <li class="active"> |
| <a href="/documentation/">Documentation</a> |
| </li> |
| <li> |
| <a href="/download/">Download</a> |
| </li> |
| <li> |
| <a href="/community/">Community</a> |
| </li> |
| <li> |
| <a href="/events/">Events</a> |
| </li> |
| </ul> |
| |
| <!-- Search, Navigation and Repo links --> |
| <ul class="nav navbar-nav navbar-right"> |
| |
| </ul> |
| </div> |
| </div> |
| </nav> |
| </header> |
| <!-- STARTS MAIN CONTENT --> |
| <div id="main-content"> |
| |
| |
| |
| |
| |
| |
| <div id="breadcrumb"> |
| <div class="container"> |
| <a href="/documentation/">Docs</a> / |
| |
| <a href="../../os_user_guide.html">OS User Guide</a> / |
| |
| <a href="driver.html">Drivers</a> / |
| |
| mmc |
| |
| <div class="sourcelink"> |
| <a href="https://github.com/apache/mynewt-core/edit/master/docs/os/modules/drivers/mmc.rst" class="icon icon-github" |
| rel="nofollow"> Edit on GitHub</a> |
| </div> |
| </div> |
| </div> |
| <!-- STARTS CONTAINER --> |
| <div class="container"> |
| <!-- STARTS .content --> |
| <div id="content" class="row"> |
| |
| <!-- STARTS .container-sidebar --> |
| <div class="container-sidebar col-xs-12 col-sm-3"> |
| <div id="docSidebar" class="sticky-container"> |
| <div role="search" class="sphinx-search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search documentation" class="search-documentation" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| <!-- Note: only works when deployed --> |
| <select class="form-control" onchange="if (this.value) window.location.href=this.value"> |
| <option value="/latest" selected> |
| Version: latest |
| </option> |
| <option value="/v1_12_0" > |
| Version: 1.12.0 |
| </option> |
| <option value="/v1_11_0" > |
| Version: 1.11.0 |
| </option> |
| <option value="/v1_10_0" > |
| Version: 1.10.0 |
| </option> |
| <option value="/v1_9_0" > |
| Version: 1.9.0 |
| </option> |
| <option value="/v1_8_0" > |
| Version: 1.8.0 |
| </option> |
| <option value="/v1_7_0" > |
| Version: 1.7.0 |
| </option> |
| <option value="/v1_6_0" selected="selected" > |
| Version: 1.6.0 |
| </option> |
| <option value="/v1_5_0" > |
| Version: 1.5.0 |
| </option> |
| <option value="/v1_4_0" > |
| Version: 1.4.0 |
| </option> |
| <option value="/v1_3_0/os/introduction" > |
| Version: 1.3.0 |
| </option> |
| <option value="/v1_2_0/os/introduction" > |
| Version: 1.2.0 |
| </option> |
| <option value="/v1_1_0/os/introduction" > |
| Version: 1.1.0 |
| </option> |
| <option value="/v1_0_0/os/introduction" > |
| Version: 1.0.0 |
| </option> |
| <option value="/v0_9_0/os/introduction" > |
| Version: 0.9.0 |
| </option> |
| </select> |
| <div class="region region-sidebar"> |
| <div class="docs-menu"> |
| |
| |
| |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../../../index.html">Introduction</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../get_started/index.html">Setup & Get Started</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../tutorials/tutorials.html">Tutorials</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../external_links.html">Third-party Resources</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="../../os_user_guide.html">OS User Guide</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="../../core_os/mynewt_os.html">Kernel</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../system_modules.html">System</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../hal/hal.html">Hardware Abstraction</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../bootloader/bootloader.html">Secure Bootloader</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../split/split.html">Split Images</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../core_os/porting/port_os.html">Porting Guide</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../baselibc.html">Baselibc</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="driver.html">Drivers</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="flash.html">flash</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">mmc</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../devmgmt/newtmgr.html">Device Management with Newt Manager</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../mcumgr/mcumgr.html">Device Management with MCUmgr</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../imgmgr/imgmgr.html">Image Manager</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../sysinitconfig/sysinitconfig.html">Compile-Time Configuration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../fs/fs.html">File System</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../fcb/fcb.html">Flash Circular Buffer</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../sensor_framework/sensor_framework.html">Sensor Framework</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../testutil/testutil.html">Test Utilities</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../json/json.html">JSON</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../mfg/mfg.html">Manufacturing support</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../network/index.html">BLE User Guide</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../newt/index.html">Newt Tool Guide</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../newtmgr/index.html">Newt Manager Guide</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../mynewt_faq/index.html">Mynewt FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../misc/index.html">Appendix</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </div> |
| <!-- ENDS STICKY CONTAINER --> |
| </div> |
| <!-- ENDS .container-sidebar --> |
| |
| <div class="col-xs-12 col-sm-9"> |
| |
| <div class="alert alert-warning"> |
| <p> |
| Version 1.6.0 is not the most recent version of the |
| Apache Mynewt documentation. Click <a href="/latest">here</a> to |
| read the latest version. |
| </p> |
| </div> |
| |
| |
| |
| <div class=""> |
| <div class="rst-content"> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="mmc"> |
| <h1>mmc<a class="headerlink" href="#mmc" title="Permalink to this headline">¶</a></h1> |
| <p>The MMC driver provides support for SPI based MMC/SDcard interfaces. It |
| exports a <code class="docutils literal notranslate"><span class="pre">disk_ops</span></code> struct that can be used by any FS. Currently only |
| <code class="docutils literal notranslate"><span class="pre">fatfs</span></code> can run over MMC.</p> |
| <div class="section" id="initialization"> |
| <h2>Initialization<a class="headerlink" href="#initialization" title="Permalink to this headline">¶</a></h2> |
| <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="kt">int</span><span class="w"> </span><span class="n">mmc_init</span><span class="p">(</span><span class="kt">int</span><span class="w"> </span><span class="n">spi_num</span><span class="p">,</span><span class="w"> </span><span class="kt">void</span><span class="w"> </span><span class="o">*</span><span class="n">spi_cfg</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">ss_pin</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>Initializes the mmc driver to be used by a FS.</p> |
| <p>MMC uses the <code class="docutils literal notranslate"><span class="pre">hal_gpio</span></code> interface to access the SPI <code class="docutils literal notranslate"><span class="pre">ss_pin</span></code> and the |
| <code class="docutils literal notranslate"><span class="pre">hal_spi</span></code> interface for the communication with the card. <code class="docutils literal notranslate"><span class="pre">spi_cfg</span></code> |
| must be a hw dependent structure used by <code class="docutils literal notranslate"><span class="pre">hal_spi_init</span></code> to initialize |
| the SPI subsystem.</p> |
| </div> |
| <div class="section" id="dependencies"> |
| <h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h2> |
| <p>To include the <code class="docutils literal notranslate"><span class="pre">mmc</span></code> driver on a project, just include it as a |
| dependency in your pkg.yml:</p> |
| <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>pkg.deps: |
| - "@apache-mynewt-core/hw/drivers/mmc" |
| </pre></div> |
| </div> |
| </div> |
| <div class="section" id="returned-values"> |
| <h2>Returned values<a class="headerlink" href="#returned-values" title="Permalink to this headline">¶</a></h2> |
| <p>MMC functions return one of the following status codes:</p> |
| <table class="docutils align-default"> |
| <colgroup> |
| <col style="width: 31%" /> |
| <col style="width: 69%" /> |
| </colgroup> |
| <thead> |
| <tr class="row-odd"><th class="head"><p>Return code</p></th> |
| <th class="head"><p>Description</p></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="row-even"><td><p>MMC_OK</p></td> |
| <td><p>Success.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>MMC_CARD_ERROR</p></td> |
| <td><p>General failure on the card.</p></td> |
| </tr> |
| <tr class="row-even"><td><p>MMC_READ_ERROR</p></td> |
| <td><p>Error reading from the card.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>MMC_WRITE_ERROR</p></td> |
| <td><p>Error writing to the card.</p></td> |
| </tr> |
| <tr class="row-even"><td><p>MMC_TIMEOUT</p></td> |
| <td><p>Timed out waiting for the execution of a command.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>MMC_PARAM_ERROR</p></td> |
| <td><p>An invalid parameter was given to a function.</p></td> |
| </tr> |
| <tr class="row-even"><td><p>MMC_CRC_ERROR</p></td> |
| <td><p>CRC error reading card.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>MMC_DEVICE_ERROR</p></td> |
| <td><p>Tried to use an invalid device.</p></td> |
| </tr> |
| <tr class="row-even"><td><p>MMC_RESPONSE_ERROR</p></td> |
| <td><p>A command received an invalid response.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>MMC_VOLTAGE_ERROR</p></td> |
| <td><p>The interface doesn’t support the requested voltage.</p></td> |
| </tr> |
| <tr class="row-even"><td><p>MMC_INVALID_COMMAND</p></td> |
| <td><p>The interface haven’t accepted some command.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>MMC_ERASE_ERROR</p></td> |
| <td><p>Error erasing the current card.</p></td> |
| </tr> |
| <tr class="row-even"><td><p>MMC_ADDR_ERROR</p></td> |
| <td><p>Tried to access an invalid address.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="section" id="header-file"> |
| <h2>Header file<a class="headerlink" href="#header-file" title="Permalink to this headline">¶</a></h2> |
| <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span><span class="w"> </span><span class="cpf">"mmc/mmc.h"</span> |
| </pre></div> |
| </div> |
| </div> |
| <div class="section" id="example"> |
| <h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2> |
| <p>This example runs on the STM32F4-Discovery and prints out a listing of |
| the root directory on the currently installed card.</p> |
| <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="c1">// NOTE: error handling removed for clarity!</span> |
| |
| <span class="k">struct</span><span class="w"> </span><span class="nc">stm32f4_hal_spi_cfg</span><span class="w"> </span><span class="n">spi_cfg</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span> |
| <span class="w"> </span><span class="p">.</span><span class="n">ss_pin</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">SPI_SS_PIN</span><span class="p">,</span> |
| <span class="w"> </span><span class="p">.</span><span class="n">sck_pin</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">SPI_SCK_PIN</span><span class="p">,</span> |
| <span class="w"> </span><span class="p">.</span><span class="n">miso_pin</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">SPI_MISO_PIN</span><span class="p">,</span> |
| <span class="w"> </span><span class="p">.</span><span class="n">mosi_pin</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">SPI_MOSI_PIN</span><span class="p">,</span> |
| <span class="w"> </span><span class="p">.</span><span class="n">irq_prio</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span> |
| <span class="p">};</span> |
| |
| <span class="n">mmc_init</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">spi_cfg</span><span class="p">,</span><span class="w"> </span><span class="n">spi_cfg</span><span class="p">.</span><span class="n">ss_pin</span><span class="p">);</span> |
| <span class="n">disk_register</span><span class="p">(</span><span class="s">"mmc0"</span><span class="p">,</span><span class="w"> </span><span class="s">"fatfs"</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">mmc_ops</span><span class="p">);</span> |
| |
| <span class="n">fs_opendir</span><span class="p">(</span><span class="s">"mmc0:/"</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">dir</span><span class="p">);</span> |
| |
| <span class="k">while</span><span class="w"> </span><span class="p">(</span><span class="mi">1</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> |
| <span class="w"> </span><span class="n">rc</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">fs_readdir</span><span class="p">(</span><span class="n">dir</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">dirent</span><span class="p">);</span> |
| <span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">rc</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="n">FS_ENOENT</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> |
| <span class="w"> </span><span class="k">break</span><span class="p">;</span> |
| <span class="w"> </span><span class="p">}</span> |
| |
| <span class="w"> </span><span class="n">fs_dirent_name</span><span class="p">(</span><span class="n">dirent</span><span class="p">,</span><span class="w"> </span><span class="k">sizeof</span><span class="p">(</span><span class="n">out_name</span><span class="p">),</span><span class="w"> </span><span class="n">out_name</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">u8_len</span><span class="p">);</span> |
| <span class="w"> </span><span class="n">printf</span><span class="p">(</span><span class="s">"%s</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span><span class="w"> </span><span class="n">out_name</span><span class="p">);</span> |
| <span class="p">}</span> |
| |
| <span class="n">fs_closedir</span><span class="p">(</span><span class="n">dir</span><span class="p">);</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| |
| |
| </div> |
| </div> |
| |
| <div class="rst-footer-buttons row" role="navigation" aria-label="footer navigation"> |
| |
| <a href="../devmgmt/newtmgr.html" class="btn btn-neutral float-right" title="Newt Manager" accesskey="n">Next: Newt Manager <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="flash.html" class="btn btn-neutral" title="flash" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous: flash</a> |
| |
| </div> |
| |
| </div> |
| </div> |
| </div> |
| <!-- ENDS CONTENT SECTION --> |
| </div> |
| <!-- ENDS .content --> |
| </div> |
| </div> |
| <footer> |
| <div class="container"> |
| <div class="row"> |
| <div class="col-xs-12"> |
| |
| <p class="copyright">Apache Mynewt is available under Apache License, version 2.0.</p> |
| |
| </div> |
| <div class="col-xs-12"> |
| <div class="logos"> |
| <img src="../../../_static/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> |
| <small class="footnote"> |
| Apache Mynewt, Mynewt, Apache, the Apache feather logo, and the Apache Mynewt project logo are either |
| registered trademarks or trademarks of the Apache Software Foundation in the United States and other countries. |
| </small> |
| <a href=""> |
| <img src="../../../_static/img/add_to_slack.png" alt="Slack Icon" title="Join our Slack Community" /> |
| </a> |
| </div> |
| </div> |
| </div> |
| </div> |
| </footer> |
| </div> |
| <!-- ENDS #wrapper --> |
| |
| |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'../../../', |
| VERSION:'latest', |
| COLLAPSE_INDEX:false, |
| FILE_SUFFIX:'.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt', |
| LINK_SUFFIX: '.html' |
| }; |
| </script> |
| <script type="text/javascript" src="../../../_static/jquery.js"></script> |
| <script type="text/javascript" src="../../../_static/underscore.js"></script> |
| <script type="text/javascript" src="../../../_static/doctools.js"></script> |
| <script type="text/javascript" src="../../../_static/js/bootstrap-3.0.3.min.js"></script> |
| <script type="text/javascript" src="../../../_static/js/affix.js"></script> |
| <script type="text/javascript" src="../../../_static/js/main.js"></script> |
| |
| |
| |
| </body> |
| </html> |
