blob: 859f9ea22148112a71e1e2fdc8ee565d79e4bf6f [file] [log] [blame]
<!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">
<!-- This is broken by doc revisioning.
-->
<link rel="shortcut icon" href="../../../../img/favicon.ico">
<title>flash - Apache Mynewt</title>
<link href="../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
<link rel="stylesheet" href="../../../../css/highlight.css">
<link href="../../../../css/base.css" rel="stylesheet">
<link href="../../../../css/custom.css" rel="stylesheet">
<link href="../../../../css/v2.css" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Lato" rel="stylesheet">
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
<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="flash">
<div class="container">
<div class="row v2-main-banner">
<a class="logo-cell" href="/">
<img class="logo" src="/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>
<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" 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
class=""
>
<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
class=""
>
<a href="/about/">About</a>
</li>
<li
class=""
>
<a href="/talks/">Talks</a>
</li>
<li
class="active"
>
<a href="/documentation/">Documentation</a>
</li>
<li
class=""
>
<a href="/download/">Download</a>
</li>
<li
class=""
>
<a href="/community/">Community</a>
</li>
<li
class=""
>
<a href="/events/">Events</a>
</li>
</ul>
</div>
</div>
</nav>
<div class="container">
<div class="row">
<div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary">
<div class="top">
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search documentation" />
</div>
</form>
</div>
</div>
<ul class="toc-nav">
<li class="doc-version"><select class="form-control" onchange="if (this.value) window.location.href=this.value">
<option value="/latest">
Version: master
</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/" >
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" selected="selected" >
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></li>
<li ><a href="../../../introduction/">Mynewt Documentation</a>
<ul>
<li ><a href="../../../get_started/get_started/">Basic Setup</a>
</li>
<li >
<a href="../../../get_started/vocabulary/">Concepts</a>
</li>
<li ><a href="../../../tutorials/tutorials/">Tutorials</a>
</li>
<li ><a href="../../../os_user_guide/">OS User Guide</a>
<ul>
<li ><a href="../../../core_os/mynewt_os/">OS Core</a>
</li>
<li ><a href="../../../core_os/porting/port_os/">Porting to your Platform</a>
</li>
<li ><a href="../../console/console/">Console</a>
</li>
<li ><a href="../../shell/shell/">Shell</a>
</li>
<li ><a href="../../split/split/">Split Images</a>
</li>
<li ><a href="../../bootloader/bootloader/">Bootloader</a>
</li>
<li><a href="
../../fs/fs/fs/
">File System</a>
</li>
<li ><a href="../../hal/hal/">Hardware Abstraction Layer</a>
</li>
<li ><a href="../../sensor_framework/sensor_framework_overview/">Sensor Framework</a>
</li>
<li ><a href="../driver/">Drivers</a>
<ul>
<li><a href="
./
">Supported Drivers</a>
<ul>
<li class="active">
<a href="./">flash</a>
</li>
<li >
<a href="../mmc/">mmc</a>
</li>
<li >
<a href="../../../../network/ble/ble_intro/">nimBLE</a>
</li>
</ul>
</li>
</ul>
</li>
<li ><a href="../../testutil/testutil/">Test Utilities</a>
</li>
<li ><a href="../../devmgmt/newtmgr/">Device Management with Newt Manager</a>
</li>
<li ><a href="../../imgmgr/imgmgr/">Image Manager</a>
</li>
<li >
<a href="../../baselibc/">Baselibc library</a>
</li>
<li ><a href="../../json/json/">JSON</a>
</li>
<li ><a href="../../fcb/fcb/">Flash Circular Buffer</a>
</li>
<li ><a href="../../stats/stats/">Stats</a>
</li>
<li ><a href="../../logs/logs/">Logs</a>
</li>
<li ><a href="../../sysinitconfig/sysinitconfig/">System Configuration And Initialization</a>
</li>
</ul>
</li>
<li><a href="
../../../../network/ble/ble_intro/
">BLE User Guide</a>
</li>
<li ><a href="../../../../newt/newt_intro/">Newt Tool Guide</a>
</li>
<li ><a href="../../../../newtmgr/overview/">Newt Manager Guide</a>
</li>
<li >
<a href="../../../../known_issues/">Known Issues</a>
</li>
</ul>
</li>
<li><a href="
../../../../faq/go_env/
">Appendix</a>
</li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<div class="doc-header">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="/documentation/">Docs</a></li>
<li>&raquo; Supported Drivers</li>
<li>&raquo; <a href="os/modules/drivers/driver/">Drivers</a></li>
<li>&raquo; <a href="os/os_user_guide/">OS User Guide</a></li>
<li>&raquo; <a href="os/introduction/">Mynewt Documentation</a></li>
<li>&raquo; flash</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/apache/mynewt-site/blob/master/docs/os/modules/drivers/flash.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
</div>
</div>
<div class="alert alert-warning">
<p>
Version 1.1.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>
<h2 id="flash"><font color="#F2853F" style="font-size:24pt">flash</font></h2>
<p>The flash driver subsystem is a work in progress which aims at supporting
common external SPI/I2C flash/eeprom memory chips. This is equivalent
to what Linux calls <code>MTD</code> for <code>Memory Technology Devices</code>.</p>
<p>At the moment the only <code>flash</code> device that is already supported is the
AT45DBxxx SPI flash family with the <code>at45db</code> driver.</p>
<p>The flash driver aims for full compatibility with the <code>hal_flash</code> API,
which means initialization and usage can be performed by any <code>fs</code> that
supports the <code>hal_flash</code> interface.</p>
<h4 id="initialization">Initialization</h4>
<p>To be compatible with the standard <code>hal_flash</code> interface, the <code>at45db</code> driver
embeds a <code>struct hal_flash</code> to its own <code>struct at45db_dev</code>. The whole <code>at45db_dev</code>
struct is shown below.</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code><span style="color: #A90D91">struct</span> <span style="color: #3F6E75">at45db_dev</span> {
<span style="color: #A90D91">struct</span> <span style="color: #3F6E75">hal_flash</span> <span style="color: #000000">hal</span>;
<span style="color: #A90D91">struct</span> <span style="color: #3F6E75">hal_spi_settings</span> <span style="color: #000000">*settings</span>;
<span style="color: #A90D91">int</span> <span style="color: #000000">spi_num</span>;
<span style="color: #A90D91">void</span> <span style="color: #000000">*spi_cfg</span>; <span style="color: #177500">/** Low-level MCU SPI config */</span>
<span style="color: #A90D91">int</span> <span style="color: #000000">ss_pin</span>;
<span style="color: #A90D91">uint32_t</span> <span style="color: #000000">baudrate</span>;
<span style="color: #A90D91">uint16_t</span> <span style="color: #000000">page_size</span>; <span style="color: #177500">/** Page size to be used, valid: 512 and 528 */</span>
<span style="color: #A90D91">uint8_t</span> <span style="color: #000000">disable_auto_erase</span>; <span style="color: #177500">/** Reads and writes auto-erase by default */</span>
};
</code></pre></div>
<p>To ease with initialization a helper function <code>at45db_default_config</code> was added.
It returns an already initialized <code>struct at45db_dev</code> leaving the user with just
having to provide the SPI related config.</p>
<p>To initialize the device, pass the <code>at45db_dev</code> struct to <code>at45db_init</code>.</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code><span style="color: #A90D91">int</span> <span style="color: #000000">at45db_init</span>(<span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #3F6E75">hal_flash</span> <span style="color: #000000">*dev</span>);
</code></pre></div>
<p>For low-level access to the device the following functions are provided:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code><span style="color: #A90D91">int</span> <span style="color: #000000">at45db_read</span>(<span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #3F6E75">hal_flash</span> <span style="color: #000000">*dev</span>, <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">addr</span>, <span style="color: #A90D91">void</span> <span style="color: #000000">*buf</span>,
<span style="color: #A90D91">uint32_t</span> <span style="color: #000000">len</span>);
<span style="color: #A90D91">int</span> <span style="color: #000000">at45db_write</span>(<span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #3F6E75">hal_flash</span> <span style="color: #000000">*dev</span>, <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">addr</span>, <span style="color: #A90D91">const</span> <span style="color: #A90D91">void</span> <span style="color: #000000">*buf</span>,
<span style="color: #A90D91">uint32_t</span> <span style="color: #000000">len</span>);
<span style="color: #A90D91">int</span> <span style="color: #000000">at45db_erase_sector</span>(<span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #3F6E75">hal_flash</span> <span style="color: #000000">*dev</span>, <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">sector_address</span>);
<span style="color: #A90D91">int</span> <span style="color: #000000">at45db_sector_info</span>(<span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #3F6E75">hal_flash</span> <span style="color: #000000">*dev</span>, <span style="color: #A90D91">int</span> <span style="color: #000000">idx</span>, <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">*address</span>,
<span style="color: #A90D91">uint32_t</span> <span style="color: #000000">*sz</span>);
</code></pre></div>
<p>Also, <code>nffs</code> is able to run on the device due to the fact that standard <code>hal_flash</code>
interface compatibility is provided. Due to current limitations of <code>nffs</code>, it can
only run on <code>at45db</code> if the internal flash of the MCU is not being used.</p>
<h4 id="dependencies">Dependencies</h4>
<p>To include the <code>at45db</code> driver on a project, just include it as a dependency in your
pkg.yml:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>pkg.deps:
- hw/drivers/flash/at45db
</code></pre></div>
<h4 id="header-file">Header file</h4>
<p>The <code>at45db</code> SPI flash follows the standard <code>hal_flash</code> interface but requires
that a special struct </p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code><span style="color: #633820">#include</span> <span style="color: #177500">&lt;at45db/at45db.h&gt;</span>
</code></pre></div>
<h4 id="example">Example</h4>
<p>This following examples assume that the <code>at45db</code> is being used on a STM32F4 MCU.</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code><span style="color: #A90D91">static</span> <span style="color: #A90D91">const</span> <span style="color: #A90D91">int</span> <span style="color: #000000">SPI_SS_PIN</span> <span style="color: #000000">=</span> <span style="color: #000000">MCU_GPIO_PORTA</span>(<span style="color: #1C01CE">4</span>);
<span style="color: #A90D91">static</span> <span style="color: #A90D91">const</span> <span style="color: #A90D91">int</span> <span style="color: #000000">SPI_SCK_PIN</span> <span style="color: #000000">=</span> <span style="color: #000000">MCU_GPIO_PORTA</span>(<span style="color: #1C01CE">5</span>);
<span style="color: #A90D91">static</span> <span style="color: #A90D91">const</span> <span style="color: #A90D91">int</span> <span style="color: #000000">SPI_MISO_PIN</span> <span style="color: #000000">=</span> <span style="color: #000000">MCU_GPIO_PORTA</span>(<span style="color: #1C01CE">6</span>);
<span style="color: #A90D91">static</span> <span style="color: #A90D91">const</span> <span style="color: #A90D91">int</span> <span style="color: #000000">SPI_MOSI_PIN</span> <span style="color: #000000">=</span> <span style="color: #000000">MCU_GPIO_PORTA</span>(<span style="color: #1C01CE">7</span>);
<span style="color: #A90D91">struct</span> <span style="color: #3F6E75">stm32f4_hal_spi_cfg</span> <span style="color: #000000">spi_cfg</span> <span style="color: #000000">=</span> {
.<span style="color: #000000">ss_pin</span> <span style="color: #000000">=</span> <span style="color: #000000">SPI_SS_PIN</span>,
.<span style="color: #000000">sck_pin</span> <span style="color: #000000">=</span> <span style="color: #000000">SPI_SCK_PIN</span>,
.<span style="color: #000000">miso_pin</span> <span style="color: #000000">=</span> <span style="color: #000000">SPI_MISO_PIN</span>,
.<span style="color: #000000">mosi_pin</span> <span style="color: #000000">=</span> <span style="color: #000000">SPI_MOSI_PIN</span>,
.<span style="color: #000000">irq_prio</span> <span style="color: #000000">=</span> <span style="color: #1C01CE">2</span>
};
<span style="color: #A90D91">struct</span> <span style="color: #3F6E75">at45db_dev</span> <span style="color: #000000">*my_at45db_dev</span> <span style="color: #000000">=</span> <span style="color: #A90D91">NULL</span>;
<span style="color: #000000">my_at45db_dev</span> <span style="color: #000000">=</span> <span style="color: #000000">at45db_default_config</span>();
<span style="color: #000000">my_at45db_dev-&gt;spi_num</span> <span style="color: #000000">=</span> <span style="color: #1C01CE">0</span>;
<span style="color: #000000">my_at45db_dev-&gt;spi_cfg</span> <span style="color: #000000">=</span> <span style="color: #000000">&amp;spi_cfg</span>;
<span style="color: #000000">my_at45db_dev-&gt;ss_pin</span> <span style="color: #000000">=</span> <span style="color: #000000">spi_cfg</span>.<span style="color: #000000">ss_pin</span>;
<span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">at45db_init</span>((<span style="color: #A90D91">struct</span> <span style="color: #3F6E75">hal_flash</span> <span style="color: #000000">*</span>) <span style="color: #000000">my_at45db_dev</span>);
<span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span>) {
<span style="color: #177500">/* XXX: error handling */</span>
}
</code></pre></div>
<p>The enable <code>nffs</code> to run on the <code>at45db</code>, the <code>flash_id</code> 0 needs to map to
provide a mapping from 0 to this struct.</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code><span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #3F6E75">hal_flash</span> <span style="color: #000000">*</span>
<span style="color: #000000">hal_bsp_flash_dev</span>(<span style="color: #A90D91">uint8_t</span> <span style="color: #000000">id</span>)
{
<span style="color: #A90D91">if</span> (<span style="color: #000000">id</span> <span style="color: #000000">!=</span> <span style="color: #1C01CE">0</span>) {
<span style="color: #A90D91">return</span> <span style="color: #A90D91">NULL</span>;
}
<span style="color: #A90D91">return</span> <span style="color: #000000">&amp;my_at45db_dev</span>;
}
</code></pre></div>
<div class="row">
<ul class="nav nav-pills" style="margin-bottom: 10px">
<li>
</li>
<li class="pull-right">
</li>
</ul>
</div>
<footer 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">
<a href="https://www.apache.org/">
<img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache">
</a>
<p>
Copyright © 2015-2021 The Apache Software Foundation.<br>
<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>
</p>
<a href="">
<img src="https://www.countit.com/images/add_to_slack.png" alt="Slack Icon" title="Join our Slack Community" />
</a>
</div>
</div>
<a href="https://www.apache.org/licenses/">
<button class="button-footer-asf">
License
</button>
</a>
<a href="https://www.apache.org/foundation/sponsorship.html">
<button class="button-footer-asf">
Sponsorship
</button>
</a>
<a href="https://www.apache.org/foundation/thanks.html">
<button class="button-footer-asf">
Thanks
</button>
</a>
<a href="https://www.apache.org/security/">
<button class="button-footer-asf">
Security
</button>
</a>
<a href="https://apache.org/events/current-event">
<button class="button-footer-asf">
ASF Events
</button>
</a>
</footer>
</div>
</div>
</div>
<script src="../../../../js/jquery-1.10.2.min.js"></script>
<script src="../../../../js/bootstrap-3.0.3.min.js"></script>
<script src="../../../../js/highlight.pack.js"></script>
<script src="../../../../js/base.js"></script>
<script src="../../../../js/custom.js"></script>
<script src="search/main.js"></script>
</body>
</html>