code stringlengths 1 1.05M | repo_name stringlengths 6 83 | path stringlengths 3 242 | language stringclasses 222
values | license stringclasses 20
values | size int64 1 1.05M |
|---|---|---|---|---|---|
var group__execution__status =
[
[ "ARM_DRIVER_OK", "group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7", null ],
[ "ARM_DRIVER_ERROR", "group__execution__status.html#ga2f627075447749bb368d3b768be107cb", null ],
[ "ARM_DRIVER_ERROR_BUSY", "group__execution__status.html#ga13c1123319c7b9a4735d63447f35116b", null ],
[ "ARM_DRIVER_ERROR_TIMEOUT", "group__execution__status.html#ga0bac892205bb2d586b822e8b178ab310", null ],
[ "ARM_DRIVER_ERROR_UNSUPPORTED", "group__execution__status.html#ga2efa59e480d82697795439220e6884e4", null ],
[ "ARM_DRIVER_ERROR_PARAMETER", "group__execution__status.html#gac781d4b70ce17c4c2efe2db045be751c", null ],
[ "ARM_DRIVER_ERROR_SPECIFIC", "group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__execution__status.js | JavaScript | apache-2.0 | 789 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Flash Interface</title>
<title>CMSIS-Driver: Flash Interface</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__flash__interface__gr.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Content</a> |
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Flash Interface</div> </div>
</div><!--header-->
<div class="contents">
<p>Driver API for Flash Device Interface (Driver_Flash.h)
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Content</h2></td></tr>
<tr class="memitem:group__Flash__events"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Flash__events.html">Flash Events</a></td></tr>
<tr class="memdesc:group__Flash__events"><td class="mdescLeft"> </td><td class="mdescRight">The Flash driver generates call back events that are notified via the function <a class="el" href="group__flash__interface__gr.html#ga97b75555b5433b268add81f2e60f095a">ARM_Flash_SignalEvent</a>. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:structARM__FLASH__SECTOR"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__SECTOR">ARM_FLASH_SECTOR</a></td></tr>
<tr class="memdesc:structARM__FLASH__SECTOR"><td class="mdescLeft"> </td><td class="mdescRight">Flash Sector information. <a href="group__flash__interface__gr.html#structARM__FLASH__SECTOR">More...</a><br/></td></tr>
<tr class="separator:structARM__FLASH__SECTOR"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__FLASH__INFO"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__INFO">ARM_FLASH_INFO</a></td></tr>
<tr class="memdesc:structARM__FLASH__INFO"><td class="mdescLeft"> </td><td class="mdescRight">Flash information. <a href="group__flash__interface__gr.html#structARM__FLASH__INFO">More...</a><br/></td></tr>
<tr class="separator:structARM__FLASH__INFO"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__DRIVER__FLASH"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#structARM__DRIVER__FLASH">ARM_DRIVER_FLASH</a></td></tr>
<tr class="memdesc:structARM__DRIVER__FLASH"><td class="mdescLeft"> </td><td class="mdescRight">Access structure of the Flash Driver. <a href="group__flash__interface__gr.html#structARM__DRIVER__FLASH">More...</a><br/></td></tr>
<tr class="separator:structARM__DRIVER__FLASH"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__FLASH__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__CAPABILITIES">ARM_FLASH_CAPABILITIES</a></td></tr>
<tr class="memdesc:structARM__FLASH__CAPABILITIES"><td class="mdescLeft"> </td><td class="mdescRight">Flash Driver Capabilities. <a href="group__flash__interface__gr.html#structARM__FLASH__CAPABILITIES">More...</a><br/></td></tr>
<tr class="separator:structARM__FLASH__CAPABILITIES"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__FLASH__STATUS"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__STATUS">ARM_FLASH_STATUS</a></td></tr>
<tr class="memdesc:structARM__FLASH__STATUS"><td class="mdescLeft"> </td><td class="mdescRight">Flash Status. <a href="group__flash__interface__gr.html#structARM__FLASH__STATUS">More...</a><br/></td></tr>
<tr class="separator:structARM__FLASH__STATUS"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gabeb4ad43b1e6fa4ed956cd5c9371d327"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#gabeb4ad43b1e6fa4ed956cd5c9371d327">ARM_Flash_SignalEvent_t</a> )(uint32_t event)</td></tr>
<tr class="memdesc:gabeb4ad43b1e6fa4ed956cd5c9371d327"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__flash__interface__gr.html#ga97b75555b5433b268add81f2e60f095a">ARM_Flash_SignalEvent</a> : Signal Flash Event. <a href="#gabeb4ad43b1e6fa4ed956cd5c9371d327">More...</a><br/></td></tr>
<tr class="separator:gabeb4ad43b1e6fa4ed956cd5c9371d327"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga1cfe24b2ffa571ee50ae544bd922b604"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#ga1cfe24b2ffa571ee50ae544bd922b604">ARM_Flash_GetVersion</a> (void)</td></tr>
<tr class="memdesc:ga1cfe24b2ffa571ee50ae544bd922b604"><td class="mdescLeft"> </td><td class="mdescRight">Get driver version. <a href="#ga1cfe24b2ffa571ee50ae544bd922b604">More...</a><br/></td></tr>
<tr class="separator:ga1cfe24b2ffa571ee50ae544bd922b604"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga27c23c998032cd47cb47293c0185ee5d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__CAPABILITIES">ARM_FLASH_CAPABILITIES</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#ga27c23c998032cd47cb47293c0185ee5d">ARM_Flash_GetCapabilities</a> (void)</td></tr>
<tr class="memdesc:ga27c23c998032cd47cb47293c0185ee5d"><td class="mdescLeft"> </td><td class="mdescRight">Get driver capabilities. <a href="#ga27c23c998032cd47cb47293c0185ee5d">More...</a><br/></td></tr>
<tr class="separator:ga27c23c998032cd47cb47293c0185ee5d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa5b4bbe529d620d4ad4825588a4c4cf0"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#gaa5b4bbe529d620d4ad4825588a4c4cf0">ARM_Flash_Initialize</a> (<a class="el" href="group__flash__interface__gr.html#gabeb4ad43b1e6fa4ed956cd5c9371d327">ARM_Flash_SignalEvent_t</a> cb_event)</td></tr>
<tr class="memdesc:gaa5b4bbe529d620d4ad4825588a4c4cf0"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the Flash Interface. <a href="#gaa5b4bbe529d620d4ad4825588a4c4cf0">More...</a><br/></td></tr>
<tr class="separator:gaa5b4bbe529d620d4ad4825588a4c4cf0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae23af293e9f8a67cdb19c7d0d562d415"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#gae23af293e9f8a67cdb19c7d0d562d415">ARM_Flash_Uninitialize</a> (void)</td></tr>
<tr class="memdesc:gae23af293e9f8a67cdb19c7d0d562d415"><td class="mdescLeft"> </td><td class="mdescRight">De-initialize the Flash Interface. <a href="#gae23af293e9f8a67cdb19c7d0d562d415">More...</a><br/></td></tr>
<tr class="separator:gae23af293e9f8a67cdb19c7d0d562d415"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa8baa4618ea33568f8b3752afb2ab5a2"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#gaa8baa4618ea33568f8b3752afb2ab5a2">ARM_Flash_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:gaa8baa4618ea33568f8b3752afb2ab5a2"><td class="mdescLeft"> </td><td class="mdescRight">Control the Flash interface power. <a href="#gaa8baa4618ea33568f8b3752afb2ab5a2">More...</a><br/></td></tr>
<tr class="separator:gaa8baa4618ea33568f8b3752afb2ab5a2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga223138342383219896ed7e255faeb99a"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#ga223138342383219896ed7e255faeb99a">ARM_Flash_ReadData</a> (uint32_t addr, void *data, uint32_t cnt)</td></tr>
<tr class="memdesc:ga223138342383219896ed7e255faeb99a"><td class="mdescLeft"> </td><td class="mdescRight">Read data from Flash. <a href="#ga223138342383219896ed7e255faeb99a">More...</a><br/></td></tr>
<tr class="separator:ga223138342383219896ed7e255faeb99a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga947f24ea4042093fdb5605a68ae74f9d"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#ga947f24ea4042093fdb5605a68ae74f9d">ARM_Flash_ProgramData</a> (uint32_t addr, const void *data, uint32_t cnt)</td></tr>
<tr class="memdesc:ga947f24ea4042093fdb5605a68ae74f9d"><td class="mdescLeft"> </td><td class="mdescRight">Program data to Flash. <a href="#ga947f24ea4042093fdb5605a68ae74f9d">More...</a><br/></td></tr>
<tr class="separator:ga947f24ea4042093fdb5605a68ae74f9d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0b2b4fe5a7be579cf3644995a765ea20"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#ga0b2b4fe5a7be579cf3644995a765ea20">ARM_Flash_EraseSector</a> (uint32_t addr)</td></tr>
<tr class="memdesc:ga0b2b4fe5a7be579cf3644995a765ea20"><td class="mdescLeft"> </td><td class="mdescRight">Erase Flash Sector. <a href="#ga0b2b4fe5a7be579cf3644995a765ea20">More...</a><br/></td></tr>
<tr class="separator:ga0b2b4fe5a7be579cf3644995a765ea20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6cbaebe069d31d56c70b1f8f847e2d55"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#ga6cbaebe069d31d56c70b1f8f847e2d55">ARM_Flash_EraseChip</a> (void)</td></tr>
<tr class="memdesc:ga6cbaebe069d31d56c70b1f8f847e2d55"><td class="mdescLeft"> </td><td class="mdescRight">Erase complete Flash. Optional function for faster full chip erase. <a href="#ga6cbaebe069d31d56c70b1f8f847e2d55">More...</a><br/></td></tr>
<tr class="separator:ga6cbaebe069d31d56c70b1f8f847e2d55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga06885c0d4587d5a23f97614a8b849ef1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__STATUS">ARM_FLASH_STATUS</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#ga06885c0d4587d5a23f97614a8b849ef1">ARM_Flash_GetStatus</a> (void)</td></tr>
<tr class="memdesc:ga06885c0d4587d5a23f97614a8b849ef1"><td class="mdescLeft"> </td><td class="mdescRight">Get Flash status. <a href="#ga06885c0d4587d5a23f97614a8b849ef1">More...</a><br/></td></tr>
<tr class="separator:ga06885c0d4587d5a23f97614a8b849ef1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac047b7509356e888502e0424a9d189ae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__INFO">ARM_FLASH_INFO</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#gac047b7509356e888502e0424a9d189ae">ARM_Flash_GetInfo</a> (void)</td></tr>
<tr class="memdesc:gac047b7509356e888502e0424a9d189ae"><td class="mdescLeft"> </td><td class="mdescRight">Get Flash information. <a href="#gac047b7509356e888502e0424a9d189ae">More...</a><br/></td></tr>
<tr class="separator:gac047b7509356e888502e0424a9d189ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga97b75555b5433b268add81f2e60f095a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#ga97b75555b5433b268add81f2e60f095a">ARM_Flash_SignalEvent</a> (uint32_t event)</td></tr>
<tr class="memdesc:ga97b75555b5433b268add81f2e60f095a"><td class="mdescLeft"> </td><td class="mdescRight">Signal Flash event. <a href="#ga97b75555b5433b268add81f2e60f095a">More...</a><br/></td></tr>
<tr class="separator:ga97b75555b5433b268add81f2e60f095a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Driver API for Flash Device Interface (Driver_Flash.h) </p>
<p><a href="http://en.wikipedia.org/wiki/Flash_memory" target="_blank">Flash devices</a> based on NOR memory cells are the preferred technology for embedded applications requiring a discrete non-volatile memory device. The low read latency characteristic of these Flash devices allow a direct code execution (<a href="http://en.wikipedia.org/wiki/Execute_in_place" target="_blank">XIP</a>) and data storage in a single memory product.</p>
<p><b>Flash API</b></p>
<p>The Flash API provides a generic API suitable for Flashes with NOR memory cells independent from the actual interface to the MCU (memory bus, SPI, ...). <a href="http://en.wikipedia.org/wiki/Flash_memory#Serial_flash" target="_blank">SPI</a> flashes are typically not named NOR flashes but have usually same flash cell properties.</p>
<p>The following header files define the Application Programming Interface (API) for the Flash interface:</p>
<ul>
<li><b>Driver_Flash.h</b> : Driver API for Flash Device Interface</li>
</ul>
<p><b>Driver Functions</b></p>
<p>The driver functions are published in the access struct as explained in <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a></p>
<ul>
<li><a class="el" href="group__flash__interface__gr.html#structARM__DRIVER__FLASH">ARM_DRIVER_FLASH</a> : access struct for Flash driver functions</li>
</ul>
<p>A typical setup sequence for the driver is shown below:</p>
<p><b>Example Code:</b></p>
<div class="fragment"><div class="line"><span class="preprocessor">#include "<a class="code" href="Driver__Flash_8h.html">Driver_Flash.h</a>"</span></div>
<div class="line"><span class="preprocessor">#include "cmsis_os2.h"</span> <span class="comment">// ARM::CMSIS:RTOS2:Keil RTX5</span></div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Flash driver instance */</span></div>
<div class="line"><span class="keyword">extern</span> <a class="code" href="group__flash__interface__gr.html#structARM__DRIVER__FLASH">ARM_DRIVER_FLASH</a> Driver_Flash0;</div>
<div class="line"><span class="keyword">static</span> <a class="code" href="group__flash__interface__gr.html#structARM__DRIVER__FLASH">ARM_DRIVER_FLASH</a> * flashDev = &Driver_Flash0;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* CMSIS-RTOS2 Thread Id */</span></div>
<div class="line">osThreadId_t Flash_Thread_Id;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Flash signal event */</span></div>
<div class="line"><span class="keywordtype">void</span> Flash_Callback(uint32_t event)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">if</span> (event & <a class="code" href="group__Flash__events.html#gaf7a9c4ad125ee90df35907d861151e23">ARM_FLASH_EVENT_READY</a>) {</div>
<div class="line"> <span class="comment">/* The read/program/erase operation is completed */</span></div>
<div class="line"> osThreadFlagsSet(Flash_Thread_Id, 1U);</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">if</span> (event & <a class="code" href="group__Flash__events.html#ga0dfea52761c0eed83e5d73e7a7f69962">ARM_FLASH_EVENT_ERROR</a>) {</div>
<div class="line"> <span class="comment">/* The read/program/erase operation is completed with errors */</span></div>
<div class="line"> <span class="comment">/* Call debugger or replace with custom error handling */</span></div>
<div class="line"> __breakpoint(0); </div>
<div class="line"> }</div>
<div class="line">} </div>
<div class="line"> </div>
<div class="line"><span class="comment">/* CMSIS-RTOS2 Thread */</span> </div>
<div class="line"><span class="keywordtype">void</span> Flash_Thread (<span class="keywordtype">void</span> *argument)</div>
<div class="line">{</div>
<div class="line"> <span class="comment">/* Query drivers capabilities */</span></div>
<div class="line"> <span class="keyword">const</span> <a class="code" href="group__flash__interface__gr.html#structARM__FLASH__CAPABILITIES">ARM_FLASH_CAPABILITIES</a> capabilities = flashDev-><a class="code" href="group__flash__interface__gr.html#a25076bd7274af5d3b0af6380ed1f0331">GetCapabilities</a>();</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Initialize Flash device */</span></div>
<div class="line"> <span class="keywordflow">if</span> (capabilities.<a class="code" href="group__flash__interface__gr.html#add296ba516c8fc17ba51e30f2a00f0a9">event_ready</a>) {</div>
<div class="line"> flashDev-><a class="code" href="group__flash__interface__gr.html#a2d1eb2b5c3ee21ba5c92c37e89412567">Initialize</a> (&Flash_Callback);</div>
<div class="line"> } <span class="keywordflow">else</span> {</div>
<div class="line"> flashDev-><a class="code" href="group__flash__interface__gr.html#a2d1eb2b5c3ee21ba5c92c37e89412567">Initialize</a> (NULL);</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Power-on Flash device */</span></div>
<div class="line"> flashDev-><a class="code" href="group__flash__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> (<a class="code" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a>);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Read data taking data_width into account */</span></div>
<div class="line"> uint8_t buf[256U];</div>
<div class="line"> flashDev-><a class="code" href="group__flash__interface__gr.html#adec45569a2f6f0d915a206f8f19107bd">ReadData</a> (0x1000U, buf, <span class="keyword">sizeof</span>(buf)>>capabilities.<a class="code" href="group__flash__interface__gr.html#a04c173610dd0a545ecae308e342aafb0">data_width</a>);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Wait operation to be completed */</span></div>
<div class="line"> <span class="keywordflow">if</span> (capabilities.<a class="code" href="group__flash__interface__gr.html#add296ba516c8fc17ba51e30f2a00f0a9">event_ready</a>) {</div>
<div class="line"> osThreadFlagsWait (1U, osFlagsWaitAny, 100U);</div>
<div class="line"> } <span class="keywordflow">else</span> {</div>
<div class="line"> osDelay(100U);</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Switch off gracefully */</span></div>
<div class="line"> flashDev-><a class="code" href="group__flash__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> (<a class="code" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35">ARM_POWER_OFF</a>);</div>
<div class="line"> flashDev-><a class="code" href="group__flash__interface__gr.html#adcf20681a1402869ecb5c6447fada17b">Uninitialize</a> ();</div>
<div class="line">}</div>
</div><!-- fragment --> <hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structARM__FLASH__SECTOR" id="structARM__FLASH__SECTOR"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_FLASH_SECTOR</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Flash Sector information. </p>
<p>Specifies sector start and end address.</p>
<p><b>Element of</b>:</p>
<ul>
<li><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__INFO">ARM_FLASH_INFO</a> structure </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a61eb63d26b2fa6c2971603ceccffb14b"></a>uint32_t</td>
<td class="fieldname">
start</td>
<td class="fielddoc">
Sector Start address. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a204a3f4fa39b9c007f9784d3e4af4667"></a>uint32_t</td>
<td class="fieldname">
end</td>
<td class="fielddoc">
Sector End address (start+size-1) </td></tr>
</table>
</div>
</div>
<a name="structARM__FLASH__INFO" id="structARM__FLASH__INFO"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_FLASH_INFO</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Flash information. </p>
<p>Stores the characteristics of a Flash device. This includes sector layout, programming size and a default value for erased memory. This information can be obtained from the Flash device datasheet and is used by the middleware in order to properly interact with the Flash device.</p>
<p>Sector layout is described by specifying the <em>sector_info</em> which points to an array of sector information (start and end address) and by specifying the <em>sector_count</em> which defines the number of sectors. The element <em>sector_size</em> is not used in this case and needs to be <em>0</em>. Flash sectors need not to be aligned continuously. Gaps are allowed in the device memory space in order to reserve sectors for other usage (for example application code).</p>
<p>When the device has uniform sector size than the sector layout can be described by specifying the <em>sector_size</em> which defines the size of a single sector and by specifying the <em>sector_count</em> which defines the number of sectors. The element <em>sector_info</em> is not used in this case and needs to be <em>NULL</em>.</p>
<p>The smallest programmable unit within a sector is specified by the <em>program_unit</em>. It defines the granularity for programming data.</p>
<p>Optimal programming page size is specified by the <em>page_size</em> and defines the amount of data that should be programmed in one step to achieve maximum programming speed.</p>
<p>Contents of erased memory is specified by the <em>erased_value</em> and is typically <em>0xFF</em>. This value can be used before erasing a sector to check if the sector is blank and erase can be skipped. </p>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a8dfb9d5160358e45293bba527762238d"></a><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__SECTOR">ARM_FLASH_SECTOR</a> *</td>
<td class="fieldname">
sector_info</td>
<td class="fielddoc">
Sector layout information (NULL=Uniform sectors) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a50947f9a42bbaa2d68d6e5079150d7bf"></a>uint32_t</td>
<td class="fieldname">
sector_count</td>
<td class="fielddoc">
Number of sectors. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a7d37def484362c6e97a2d75144080b1d"></a>uint32_t</td>
<td class="fieldname">
sector_size</td>
<td class="fielddoc">
Uniform sector size in bytes (0=sector_info used) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a9dd3e47e968a8f6beb5d88c6d1b7ebe9"></a>uint32_t</td>
<td class="fieldname">
page_size</td>
<td class="fielddoc">
Optimal programming page size in bytes. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a483c41066757e2865bf3a27a2a627a54"></a>uint32_t</td>
<td class="fieldname">
program_unit</td>
<td class="fielddoc">
Smallest programmable unit in bytes. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a85c3826bf20669d38e466dfd376994db"></a>uint8_t</td>
<td class="fieldname">
erased_value</td>
<td class="fielddoc">
Contents of erased memory (usually 0xFF) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a72aca6ea6d8153b28ea8f139b932ec3e"></a>uint8_t</td>
<td class="fieldname">
reserved[3]</td>
<td class="fielddoc">
Reserved (must be zero) </td></tr>
</table>
</div>
</div>
<a name="structARM__DRIVER__FLASH" id="structARM__DRIVER__FLASH"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_DRIVER_FLASH</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Access structure of the Flash Driver. </p>
<p>The functions of the Flash driver are accessed by function pointers exposed by this structure. Refer to <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a> for overview information.</p>
<p>Each instance of a Flash interface provides such an access structure. The instance is identified by a postfix number in the symbol name of the access structure, for example:</p>
<ul>
<li><b>Driver_Flash0</b> is the name of the access struct of the first instance (no. 0).</li>
<li><b>Driver_Flash1</b> is the name of the access struct of the second instance (no. 1).</li>
</ul>
<p>A middleware configuration setting allows connecting the middleware to a specific driver instance <b>Driver_Flash<em>n</em></b>. The default is <span class="XML-Token">0</span>, which connects a middleware to the first instance of a driver. </p>
</div><table class="memberdecls">
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
<tr class="memitem:a8834b281da48583845c044a81566c1b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#a8834b281da48583845c044a81566c1b3">GetVersion</a> )(void)</td></tr>
<tr class="memdesc:a8834b281da48583845c044a81566c1b3"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__flash__interface__gr.html#ga1cfe24b2ffa571ee50ae544bd922b604">ARM_Flash_GetVersion</a> : Get driver version. <a href="#a8834b281da48583845c044a81566c1b3">More...</a><br/></td></tr>
<tr class="separator:a8834b281da48583845c044a81566c1b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a25076bd7274af5d3b0af6380ed1f0331"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__CAPABILITIES">ARM_FLASH_CAPABILITIES</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#a25076bd7274af5d3b0af6380ed1f0331">GetCapabilities</a> )(void)</td></tr>
<tr class="memdesc:a25076bd7274af5d3b0af6380ed1f0331"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__flash__interface__gr.html#ga27c23c998032cd47cb47293c0185ee5d">ARM_Flash_GetCapabilities</a> : Get driver capabilities. <a href="#a25076bd7274af5d3b0af6380ed1f0331">More...</a><br/></td></tr>
<tr class="separator:a25076bd7274af5d3b0af6380ed1f0331"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2d1eb2b5c3ee21ba5c92c37e89412567"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#a2d1eb2b5c3ee21ba5c92c37e89412567">Initialize</a> )(<a class="el" href="group__flash__interface__gr.html#gabeb4ad43b1e6fa4ed956cd5c9371d327">ARM_Flash_SignalEvent_t</a> cb_event)</td></tr>
<tr class="memdesc:a2d1eb2b5c3ee21ba5c92c37e89412567"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__flash__interface__gr.html#gaa5b4bbe529d620d4ad4825588a4c4cf0">ARM_Flash_Initialize</a> : Initialize Flash Interface. <a href="#a2d1eb2b5c3ee21ba5c92c37e89412567">More...</a><br/></td></tr>
<tr class="separator:a2d1eb2b5c3ee21ba5c92c37e89412567"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adcf20681a1402869ecb5c6447fada17b"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#adcf20681a1402869ecb5c6447fada17b">Uninitialize</a> )(void)</td></tr>
<tr class="memdesc:adcf20681a1402869ecb5c6447fada17b"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__flash__interface__gr.html#gae23af293e9f8a67cdb19c7d0d562d415">ARM_Flash_Uninitialize</a> : De-initialize Flash Interface. <a href="#adcf20681a1402869ecb5c6447fada17b">More...</a><br/></td></tr>
<tr class="separator:adcf20681a1402869ecb5c6447fada17b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba8f1c8019af95ffe19c32403e3240ef"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> )(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:aba8f1c8019af95ffe19c32403e3240ef"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__flash__interface__gr.html#gaa8baa4618ea33568f8b3752afb2ab5a2">ARM_Flash_PowerControl</a> : Control Flash Interface Power. <a href="#aba8f1c8019af95ffe19c32403e3240ef">More...</a><br/></td></tr>
<tr class="separator:aba8f1c8019af95ffe19c32403e3240ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adec45569a2f6f0d915a206f8f19107bd"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#adec45569a2f6f0d915a206f8f19107bd">ReadData</a> )(uint32_t addr, void *data, uint32_t cnt)</td></tr>
<tr class="memdesc:adec45569a2f6f0d915a206f8f19107bd"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__flash__interface__gr.html#ga223138342383219896ed7e255faeb99a">ARM_Flash_ReadData</a> : Read data from Flash. <a href="#adec45569a2f6f0d915a206f8f19107bd">More...</a><br/></td></tr>
<tr class="separator:adec45569a2f6f0d915a206f8f19107bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a429fc193f1ec62858219ab8749c563ae"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#a429fc193f1ec62858219ab8749c563ae">ProgramData</a> )(uint32_t addr, const void *data, uint32_t cnt)</td></tr>
<tr class="memdesc:a429fc193f1ec62858219ab8749c563ae"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__flash__interface__gr.html#ga947f24ea4042093fdb5605a68ae74f9d">ARM_Flash_ProgramData</a> : Program data to Flash. <a href="#a429fc193f1ec62858219ab8749c563ae">More...</a><br/></td></tr>
<tr class="separator:a429fc193f1ec62858219ab8749c563ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9d78f9fe07aabf12b23b95239818b55"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#ad9d78f9fe07aabf12b23b95239818b55">EraseSector</a> )(uint32_t addr)</td></tr>
<tr class="memdesc:ad9d78f9fe07aabf12b23b95239818b55"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__flash__interface__gr.html#ga0b2b4fe5a7be579cf3644995a765ea20">ARM_Flash_EraseSector</a> : Erase Flash Sector. <a href="#ad9d78f9fe07aabf12b23b95239818b55">More...</a><br/></td></tr>
<tr class="separator:ad9d78f9fe07aabf12b23b95239818b55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae873705c743d94572fb6500421e15760"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#ae873705c743d94572fb6500421e15760">EraseChip</a> )(void)</td></tr>
<tr class="memdesc:ae873705c743d94572fb6500421e15760"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__flash__interface__gr.html#ga6cbaebe069d31d56c70b1f8f847e2d55">ARM_Flash_EraseChip</a> : Erase complete Flash. <a href="#ae873705c743d94572fb6500421e15760">More...</a><br/></td></tr>
<tr class="separator:ae873705c743d94572fb6500421e15760"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc1db6f33f777784f3c95efc816d4856"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__STATUS">ARM_FLASH_STATUS</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#afc1db6f33f777784f3c95efc816d4856">GetStatus</a> )(void)</td></tr>
<tr class="memdesc:afc1db6f33f777784f3c95efc816d4856"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__flash__interface__gr.html#ga06885c0d4587d5a23f97614a8b849ef1">ARM_Flash_GetStatus</a> : Get Flash status. <a href="#afc1db6f33f777784f3c95efc816d4856">More...</a><br/></td></tr>
<tr class="separator:afc1db6f33f777784f3c95efc816d4856"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae64d4ee61b7a7ee0b38a0ef2b61f1db2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__INFO">ARM_FLASH_INFO</a> *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#ae64d4ee61b7a7ee0b38a0ef2b61f1db2">GetInfo</a> )(void)</td></tr>
<tr class="memdesc:ae64d4ee61b7a7ee0b38a0ef2b61f1db2"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__flash__interface__gr.html#gac047b7509356e888502e0424a9d189ae">ARM_Flash_GetInfo</a> : Get Flash information. <a href="#ae64d4ee61b7a7ee0b38a0ef2b61f1db2">More...</a><br/></td></tr>
<tr class="separator:ae64d4ee61b7a7ee0b38a0ef2b61f1db2"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h4 class="groupheader">Field Documentation</h4>
<a class="anchor" id="a8834b281da48583845c044a81566c1b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* GetVersion)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__flash__interface__gr.html#ga1cfe24b2ffa571ee50ae544bd922b604">ARM_Flash_GetVersion</a> : Get driver version. </p>
</div>
</div>
<a class="anchor" id="a25076bd7274af5d3b0af6380ed1f0331"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__CAPABILITIES">ARM_FLASH_CAPABILITIES</a>(* GetCapabilities)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__flash__interface__gr.html#ga27c23c998032cd47cb47293c0185ee5d">ARM_Flash_GetCapabilities</a> : Get driver capabilities. </p>
</div>
</div>
<a class="anchor" id="a2d1eb2b5c3ee21ba5c92c37e89412567"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Initialize)(<a class="el" href="group__flash__interface__gr.html#gabeb4ad43b1e6fa4ed956cd5c9371d327">ARM_Flash_SignalEvent_t</a> cb_event)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__flash__interface__gr.html#gaa5b4bbe529d620d4ad4825588a4c4cf0">ARM_Flash_Initialize</a> : Initialize Flash Interface. </p>
</div>
</div>
<a class="anchor" id="adcf20681a1402869ecb5c6447fada17b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Uninitialize)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__flash__interface__gr.html#gae23af293e9f8a67cdb19c7d0d562d415">ARM_Flash_Uninitialize</a> : De-initialize Flash Interface. </p>
</div>
</div>
<a class="anchor" id="aba8f1c8019af95ffe19c32403e3240ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* PowerControl)(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__flash__interface__gr.html#gaa8baa4618ea33568f8b3752afb2ab5a2">ARM_Flash_PowerControl</a> : Control Flash Interface Power. </p>
</div>
</div>
<a class="anchor" id="adec45569a2f6f0d915a206f8f19107bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* ReadData)(uint32_t addr, void *data, uint32_t cnt)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__flash__interface__gr.html#ga223138342383219896ed7e255faeb99a">ARM_Flash_ReadData</a> : Read data from Flash. </p>
</div>
</div>
<a class="anchor" id="a429fc193f1ec62858219ab8749c563ae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* ProgramData)(uint32_t addr, const void *data, uint32_t cnt)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__flash__interface__gr.html#ga947f24ea4042093fdb5605a68ae74f9d">ARM_Flash_ProgramData</a> : Program data to Flash. </p>
</div>
</div>
<a class="anchor" id="ad9d78f9fe07aabf12b23b95239818b55"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* EraseSector)(uint32_t addr)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__flash__interface__gr.html#ga0b2b4fe5a7be579cf3644995a765ea20">ARM_Flash_EraseSector</a> : Erase Flash Sector. </p>
</div>
</div>
<a class="anchor" id="ae873705c743d94572fb6500421e15760"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* EraseChip)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__flash__interface__gr.html#ga6cbaebe069d31d56c70b1f8f847e2d55">ARM_Flash_EraseChip</a> : Erase complete Flash. </p>
</div>
</div>
<a class="anchor" id="afc1db6f33f777784f3c95efc816d4856"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__STATUS">ARM_FLASH_STATUS</a>(* GetStatus)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__flash__interface__gr.html#ga06885c0d4587d5a23f97614a8b849ef1">ARM_Flash_GetStatus</a> : Get Flash status. </p>
</div>
</div>
<a class="anchor" id="ae64d4ee61b7a7ee0b38a0ef2b61f1db2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__INFO">ARM_FLASH_INFO</a>*(* GetInfo)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__flash__interface__gr.html#gac047b7509356e888502e0424a9d189ae">ARM_Flash_GetInfo</a> : Get Flash information. </p>
</div>
</div>
</div>
</div>
<a name="structARM__FLASH__CAPABILITIES" id="structARM__FLASH__CAPABILITIES"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_FLASH_CAPABILITIES</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Flash Driver Capabilities. </p>
<p>A Flash driver can be implemented with different capabilities. The data fields of this struct encode the capabilities implemented by this driver.</p>
<p>The element <em>event_ready</em> indicates that the driver is able to generate the <a class="el" href="group__Flash__events.html#gaf7a9c4ad125ee90df35907d861151e23">ARM_FLASH_EVENT_READY</a> event. In case that this event is not available it is possible to poll the driver status by calling the <a class="el" href="group__flash__interface__gr.html#ga06885c0d4587d5a23f97614a8b849ef1">ARM_Flash_GetStatus</a> and check the <em>busy</em> flag.</p>
<p>The element <em>data_width</em> specifies the data access size and also defines the data type (uint8_t, uint16_t or uint32_t) for the <em>data</em> parameter in <a class="el" href="group__flash__interface__gr.html#ga223138342383219896ed7e255faeb99a">ARM_Flash_ReadData</a> and <a class="el" href="group__flash__interface__gr.html#ga947f24ea4042093fdb5605a68ae74f9d">ARM_Flash_ProgramData</a> functions.</p>
<p>The element <em>erase_chip</em> specifies that the <a class="el" href="group__flash__interface__gr.html#ga6cbaebe069d31d56c70b1f8f847e2d55">ARM_Flash_EraseChip</a> function is supported. Typically full chip erase is much faster than erasing the whole device sector per sector.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__flash__interface__gr.html#ga27c23c998032cd47cb47293c0185ee5d">ARM_Flash_GetCapabilities</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="add296ba516c8fc17ba51e30f2a00f0a9"></a>uint32_t</td>
<td class="fieldname">
event_ready: 1</td>
<td class="fielddoc">
Signal Flash Ready event. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a04c173610dd0a545ecae308e342aafb0"></a>uint32_t</td>
<td class="fieldname">
data_width: 2</td>
<td class="fielddoc">
Data width: 0=8-bit, 1=16-bit, 2=32-bit. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="af5ec2b569c193fc5024c2739f46b328a"></a>uint32_t</td>
<td class="fieldname">
erase_chip: 1</td>
<td class="fielddoc">
Supports EraseChip operation. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 28</td>
<td class="fielddoc">
Reserved (must be zero) </td></tr>
</table>
</div>
</div>
<a name="structARM__FLASH__STATUS" id="structARM__FLASH__STATUS"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_FLASH_STATUS</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Flash Status. </p>
<p>Structure with information about the status of the Flash.</p>
<p>The flag <em>busy</em> indicates that the driver is busy executing read/program/erase operation.</p>
<p>The flag <em>error</em> flag is cleared on start of read/program/erase operation and is set at the end of the current operation in case of error.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__flash__interface__gr.html#ga06885c0d4587d5a23f97614a8b849ef1">ARM_Flash_GetStatus</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a50c88f3c1d787773e2ac1b59533f034a"></a>uint32_t</td>
<td class="fieldname">
busy: 1</td>
<td class="fielddoc">
Flash busy flag. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa8d183302fdfa4a6892f1d80300cdb32"></a>uint32_t</td>
<td class="fieldname">
error: 1</td>
<td class="fielddoc">
Read/Program/Erase error flag (cleared on start of next operation) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 30</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gabeb4ad43b1e6fa4ed956cd5c9371d327"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ARM_Flash_SignalEvent_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__flash__interface__gr.html#ga97b75555b5433b268add81f2e60f095a">ARM_Flash_SignalEvent</a> : Signal Flash Event. </p>
<p>Provides the typedef for the callback function <a class="el" href="group__flash__interface__gr.html#ga97b75555b5433b268add81f2e60f095a">ARM_Flash_SignalEvent</a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__flash__interface__gr.html#gaa5b4bbe529d620d4ad4825588a4c4cf0">ARM_Flash_Initialize</a> </li>
</ul>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga1cfe24b2ffa571ee50ae544bd922b604"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> ARM_Flash_GetVersion </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get driver version. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></dd></dl>
<p>The function <b>ARM_Flash_GetVersion</b> returns version information of the driver implementation in <a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></p>
<ul>
<li>API version is the version of the CMSIS-Driver specification used to implement this driver.</li>
<li>Driver version is source code version of the actual driver implementation.</li>
</ul>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__flash__interface__gr.html#structARM__DRIVER__FLASH">ARM_DRIVER_FLASH</a> Driver_Flash0;</div>
<div class="line"><a class="code" href="group__flash__interface__gr.html#structARM__DRIVER__FLASH">ARM_DRIVER_FLASH</a> *drv_info;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> read_version (<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> version;</div>
<div class="line"> </div>
<div class="line"> drv_info = &Driver_Flash0; </div>
<div class="line"> version = drv_info-><a class="code" href="group__flash__interface__gr.html#a8834b281da48583845c044a81566c1b3">GetVersion</a> ();</div>
<div class="line"> <span class="keywordflow">if</span> (version.<a class="code" href="group__common__drv__gr.html#ad180da20fbde1d3dafc074af87c19540">api</a> < 0x10A) { <span class="comment">// requires at minimum API version 1.10 or higher</span></div>
<div class="line"> <span class="comment">// error handling</span></div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga27c23c998032cd47cb47293c0185ee5d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__CAPABILITIES">ARM_FLASH_CAPABILITIES</a> ARM_Flash_GetCapabilities </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get driver capabilities. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__CAPABILITIES">ARM_FLASH_CAPABILITIES</a></dd></dl>
<p>The function <b>ARM_Flash_GetCapabilities</b> returns information about capabilities in this driver implementation. The data fields of the struct <a class="el" href="group__flash__interface__gr.html#structARM__FLASH__CAPABILITIES">ARM_FLASH_CAPABILITIES</a> encode various capabilities, for example if a hardware is able to create signal events using the <a class="el" href="group__flash__interface__gr.html#ga97b75555b5433b268add81f2e60f095a">ARM_Flash_SignalEvent</a> callback function.</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__flash__interface__gr.html#structARM__DRIVER__FLASH">ARM_DRIVER_FLASH</a> Driver_Flash0;</div>
<div class="line"><a class="code" href="group__flash__interface__gr.html#structARM__DRIVER__FLASH">ARM_DRIVER_FLASH</a> *drv_info;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> read_capabilities (<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__flash__interface__gr.html#structARM__FLASH__CAPABILITIES">ARM_FLASH_CAPABILITIES</a> drv_capabilities;</div>
<div class="line"> </div>
<div class="line"> drv_info = &Driver_Flash0; </div>
<div class="line"> drv_capabilities = drv_info-><a class="code" href="group__flash__interface__gr.html#a25076bd7274af5d3b0af6380ed1f0331">GetCapabilities</a> ();</div>
<div class="line"> <span class="comment">// interrogate capabilities</span></div>
<div class="line"> </div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="gaa5b4bbe529d620d4ad4825588a4c4cf0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_Flash_Initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__flash__interface__gr.html#gabeb4ad43b1e6fa4ed956cd5c9371d327">ARM_Flash_SignalEvent_t</a> </td>
<td class="paramname"><em>cb_event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the Flash Interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cb_event</td><td>Pointer to <a class="el" href="group__flash__interface__gr.html#ga97b75555b5433b268add81f2e60f095a">ARM_Flash_SignalEvent</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_Flash_Initialize</b> initializes the Flash interface. It is called when the middleware component starts operation.</p>
<p>The function performs the following operations:</p>
<ul>
<li>Initializes the resources needed for the Flash interface.</li>
<li>Registers the <a class="el" href="group__flash__interface__gr.html#ga97b75555b5433b268add81f2e60f095a">ARM_Flash_SignalEvent</a> callback function.</li>
</ul>
<p>The parameter <em>cb_event</em> is a pointer to the <a class="el" href="group__flash__interface__gr.html#ga97b75555b5433b268add81f2e60f095a">ARM_Flash_SignalEvent</a> callback function; use a NULL pointer when no callback signals are required.</p>
<p><b>Example:</b> </p>
<ul>
<li>see <a class="el" href="group__flash__interface__gr.html">Flash Interface</a> - Driver Functions </li>
</ul>
</div>
</div>
<a class="anchor" id="gae23af293e9f8a67cdb19c7d0d562d415"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_Flash_Uninitialize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>De-initialize the Flash Interface. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_Flash_Uninitialize</b> de-initializes the resources of Flash interface.</p>
<p>It is called when the middleware component stops operation and releases the software resources used by the interface. </p>
</div>
</div>
<a class="anchor" id="gaa8baa4618ea33568f8b3752afb2ab5a2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_Flash_PowerControl </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> </td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control the Flash interface power. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>Power state </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_Flash_PowerControl</b> operates the power modes of the Flash interface.</p>
<p>The parameter <em>state</em> can have the following values:</p>
<ul>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a> : set-up peripheral for data transfers, enable interrupts (NVIC) and optionally DMA. Can be called multiple times. If the peripheral is already in this mode, then the function performs no operation and returns with <a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>.</li>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5a9ef9e57cbcc948d0e22314e73dc8c434">ARM_POWER_LOW</a> : may use power saving. Returns <a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> when not implemented.</li>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35">ARM_POWER_OFF</a> : terminates any pending data transfers, disables peripheral, disables related interrupts and DMA.</li>
</ul>
<p>Refer to <a class="el" href="theoryOperation.html#CallSequence">Function Call Sequence</a> for more information. </p>
</div>
</div>
<a class="anchor" id="ga223138342383219896ed7e255faeb99a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_Flash_ReadData </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>cnt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data from Flash. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>Data address. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Pointer to a buffer storing the data read from Flash. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cnt</td><td>Number of data items to read. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of data items read or <a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>This function <b>ARM_Flash_ReadData</b> reads data from the Flash device.</p>
<p>The parameter <em>addr</em> specifies the address from where to read data (needs to be aligned to data type size). <br/>
The parameter <em>data</em> specifies the pointer to a buffer storing the data read. The data type is <em>uint8_t</em>, <em>uint16_t</em> or <em>uint32_t</em> and is specified by the <em>data_width</em> in <a class="el" href="group__flash__interface__gr.html#structARM__FLASH__CAPABILITIES">ARM_FLASH_CAPABILITIES</a>. <br/>
The parameter <em>cnt</em> specifies the number of data items to read.</p>
<p>The function executes in the following ways:</p>
<ul>
<li>When the operation is non-blocking (typical for SPI Flash) then the function only starts the operation and returns with zero number of data items read. When the operation is completed the <a class="el" href="group__Flash__events.html#gaf7a9c4ad125ee90df35907d861151e23">ARM_FLASH_EVENT_READY</a> event is generated (if supported and reported by <a class="el" href="group__flash__interface__gr.html#ga27c23c998032cd47cb47293c0185ee5d">ARM_Flash_GetCapabilities</a>). In case of errors the <a class="el" href="group__Flash__events.html#ga0dfea52761c0eed83e5d73e7a7f69962">ARM_FLASH_EVENT_ERROR</a> event is generated at the same time. Progress of the operation can also be monitored by calling the <a class="el" href="group__flash__interface__gr.html#ga06885c0d4587d5a23f97614a8b849ef1">ARM_Flash_GetStatus</a> function and checking the <em>busy</em> flag.</li>
<li>When the operation is blocking (typical for memory mapped Flash) then the function returns after the data is read and returns the number of data items read. </li>
</ul>
</div>
</div>
<a class="anchor" id="ga947f24ea4042093fdb5605a68ae74f9d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_Flash_ProgramData </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>cnt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Program data to Flash. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>Data address. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to a buffer containing the data to be programmed to Flash. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cnt</td><td>Number of data items to program. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of data items programmed or <a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>This function <b>ARM_Flash_ProgramData</b> programs data to the Flash device.</p>
<p>The parameter <em>addr</em> specifies the address to where to program data (needs to be aligned to <em>program_unit</em> specified in <a class="el" href="group__flash__interface__gr.html#structARM__FLASH__INFO">ARM_FLASH_INFO</a>). <br/>
The parameter <em>data</em> specifies the pointer to a buffer containing data to be programmed. The data type is <em>uint8_t</em>, <em>uint16_t</em> or <em>uint32_t</em> and is specified by the <em>data_width</em> in <a class="el" href="group__flash__interface__gr.html#structARM__FLASH__CAPABILITIES">ARM_FLASH_CAPABILITIES</a>. <br/>
The parameter <em>cnt</em> specifies the number of data items to program (data size needs to be a multiple of <em>program_unit</em>).</p>
<p>The function executes in the following ways:</p>
<ul>
<li>When the operation is non-blocking (typically) then the function only starts the operation and returns with zero number of data items programmed. When the operation is completed the <a class="el" href="group__Flash__events.html#gaf7a9c4ad125ee90df35907d861151e23">ARM_FLASH_EVENT_READY</a> event is generated (if supported and reported by <a class="el" href="group__flash__interface__gr.html#ga27c23c998032cd47cb47293c0185ee5d">ARM_Flash_GetCapabilities</a>). In case of errors the <a class="el" href="group__Flash__events.html#ga0dfea52761c0eed83e5d73e7a7f69962">ARM_FLASH_EVENT_ERROR</a> event is generated at the same time. Progress of the operation can also be monitored by calling the <a class="el" href="group__flash__interface__gr.html#ga06885c0d4587d5a23f97614a8b849ef1">ARM_Flash_GetStatus</a> function and checking the <em>busy</em> flag.</li>
<li>When the operation is blocking then the function returns after the data is programmed and returns the number of data items programmed. </li>
</ul>
</div>
</div>
<a class="anchor" id="ga0b2b4fe5a7be579cf3644995a765ea20"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_Flash_EraseSector </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>addr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Erase Flash Sector. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>Sector address </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>This function <b>ARM_Flash_EraseSector</b> erases a flash sector specified by the parameter <em>adr</em> (points to start of the sector).</p>
<p>The function is non-blocking and returns as soon as the driver has started the operation. When the operation is completed the <a class="el" href="group__Flash__events.html#gaf7a9c4ad125ee90df35907d861151e23">ARM_FLASH_EVENT_READY</a> event is generated (if supported and reported by <a class="el" href="group__flash__interface__gr.html#ga27c23c998032cd47cb47293c0185ee5d">ARM_Flash_GetCapabilities</a>). In case of errors the <a class="el" href="group__Flash__events.html#ga0dfea52761c0eed83e5d73e7a7f69962">ARM_FLASH_EVENT_ERROR</a> event is generated at the same time. Progress of the operation can also be monitored by calling the <a class="el" href="group__flash__interface__gr.html#ga06885c0d4587d5a23f97614a8b849ef1">ARM_Flash_GetStatus</a> function and checking the <em>busy</em> flag. </p>
</div>
</div>
<a class="anchor" id="ga6cbaebe069d31d56c70b1f8f847e2d55"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_Flash_EraseChip </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Erase complete Flash. Optional function for faster full chip erase. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The optional function <b>ARM_Flash_EraseChip</b> erases the complete device. If the device does not support global erase or only a portion of the Flash memory space is used for storing files, then the functions returns the error value <a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a>. The data field <em>eras_chip</em> = <span class="XML-Token">1</span> of the structure <a class="el" href="group__flash__interface__gr.html#structARM__FLASH__CAPABILITIES">ARM_FLASH_CAPABILITIES</a> encodes that <b>ARM_Flash_EraseChip</b> is supported. The field can be verified with the function <a class="el" href="group__flash__interface__gr.html#ga27c23c998032cd47cb47293c0185ee5d">ARM_Flash_GetCapabilities</a>.</p>
<p>The function is non-blocking and returns as soon as the driver has started the operation. When the operation is completed, the <a class="el" href="group__Flash__events.html#gaf7a9c4ad125ee90df35907d861151e23">ARM_FLASH_EVENT_READY</a> event is generated (if supported and reported by <a class="el" href="group__flash__interface__gr.html#ga27c23c998032cd47cb47293c0185ee5d">ARM_Flash_GetCapabilities</a>). In case of errors, the <a class="el" href="group__Flash__events.html#ga0dfea52761c0eed83e5d73e7a7f69962">ARM_FLASH_EVENT_ERROR</a> event is generated at the same time. Progress of the operation can also be monitored by calling the <a class="el" href="group__flash__interface__gr.html#ga06885c0d4587d5a23f97614a8b849ef1">ARM_Flash_GetStatus</a> function and checking the <em>busy</em> flag.</p>
<p><b>See also:</b></p>
<ul>
<li>ARM_Flash_SignalEvent </li>
</ul>
</div>
</div>
<a class="anchor" id="ga06885c0d4587d5a23f97614a8b849ef1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__STATUS">ARM_FLASH_STATUS</a> ARM_Flash_GetStatus </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get Flash status. </p>
<dl class="section return"><dt>Returns</dt><dd>Flash status <a class="el" href="group__flash__interface__gr.html#structARM__FLASH__STATUS">ARM_FLASH_STATUS</a></dd></dl>
<p>The function <b>ARM_Flash_GetStatus</b> returns the current Flash interface status stored in the structure <a class="el" href="group__flash__interface__gr.html#structARM__FLASH__STATUS">ARM_FLASH_STATUS</a>. </p>
</div>
</div>
<a class="anchor" id="gac047b7509356e888502e0424a9d189ae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__INFO">ARM_FLASH_INFO</a> * ARM_Flash_GetInfo </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get Flash information. </p>
<dl class="section return"><dt>Returns</dt><dd>Pointer to Flash information <a class="el" href="group__flash__interface__gr.html#structARM__FLASH__INFO">ARM_FLASH_INFO</a></dd></dl>
<p>The function <b>ARM_Flash_GetInfo</b> returns information about the Flash device. </p>
</div>
</div>
<a class="anchor" id="ga97b75555b5433b268add81f2e60f095a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARM_Flash_SignalEvent </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signal Flash event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td>Event notification mask </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<p>The function <b>ARM_Flash_SignalEvent</b> is a callback function registered by the function <a class="el" href="group__flash__interface__gr.html#gaa5b4bbe529d620d4ad4825588a4c4cf0">ARM_Flash_Initialize</a>. The function is called automatically after read/program/erase operation completes.</p>
<p>The parameter <em>event</em> indicates one or more events that occurred during driver operation. Each event is coded in a separate bit and therefore it is possible to signal multiple events in the event call back function.</p>
<p>Not every event is necessarily generated by the driver. This depends on the implemented capabilities stored in the data fields of the structure <a class="el" href="group__flash__interface__gr.html#structARM__FLASH__CAPABILITIES">ARM_FLASH_CAPABILITIES</a>, which can be retrieved with the function <a class="el" href="group__flash__interface__gr.html#ga27c23c998032cd47cb47293c0185ee5d">ARM_Flash_GetCapabilities</a>.</p>
<p>The following events can be generated:</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>event</em> </th><th align="center">Bit </th><th align="left">Description </th></tr>
<tr>
<td align="left"><a class="el" href="group__Flash__events.html#gaf7a9c4ad125ee90df35907d861151e23">ARM_FLASH_EVENT_READY</a> </td><td align="center">0 </td><td align="left">Occurs after read/program/erase operation completes. </td></tr>
<tr>
<td align="left"><a class="el" href="group__Flash__events.html#ga0dfea52761c0eed83e5d73e7a7f69962">ARM_FLASH_EVENT_ERROR</a> </td><td align="center">1 </td><td align="left">Occurs together with <a class="el" href="group__Flash__events.html#gaf7a9c4ad125ee90df35907d861151e23">ARM_FLASH_EVENT_READY</a> when operation completes with errors. </td></tr>
</table>
<p><b>See also:</b></p>
<ul>
<li><a class="el" href="group__flash__interface__gr.html#ga6cbaebe069d31d56c70b1f8f847e2d55">ARM_Flash_EraseChip</a> </li>
</ul>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__flash__interface__gr.html | HTML | apache-2.0 | 76,872 |
var group__flash__interface__gr =
[
[ "Flash Events", "group__Flash__events.html", "group__Flash__events" ],
[ "ARM_FLASH_SECTOR", "group__flash__interface__gr.html#structARM__FLASH__SECTOR", [
[ "start", "group__flash__interface__gr.html#a61eb63d26b2fa6c2971603ceccffb14b", null ],
[ "end", "group__flash__interface__gr.html#a204a3f4fa39b9c007f9784d3e4af4667", null ]
] ],
[ "ARM_FLASH_INFO", "group__flash__interface__gr.html#structARM__FLASH__INFO", [
[ "sector_info", "group__flash__interface__gr.html#a8dfb9d5160358e45293bba527762238d", null ],
[ "sector_count", "group__flash__interface__gr.html#a50947f9a42bbaa2d68d6e5079150d7bf", null ],
[ "sector_size", "group__flash__interface__gr.html#a7d37def484362c6e97a2d75144080b1d", null ],
[ "page_size", "group__flash__interface__gr.html#a9dd3e47e968a8f6beb5d88c6d1b7ebe9", null ],
[ "program_unit", "group__flash__interface__gr.html#a483c41066757e2865bf3a27a2a627a54", null ],
[ "erased_value", "group__flash__interface__gr.html#a85c3826bf20669d38e466dfd376994db", null ],
[ "reserved", "group__flash__interface__gr.html#a72aca6ea6d8153b28ea8f139b932ec3e", null ]
] ],
[ "ARM_DRIVER_FLASH", "group__flash__interface__gr.html#structARM__DRIVER__FLASH", [
[ "GetVersion", "group__flash__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__flash__interface__gr.html#a25076bd7274af5d3b0af6380ed1f0331", null ],
[ "Initialize", "group__flash__interface__gr.html#a2d1eb2b5c3ee21ba5c92c37e89412567", null ],
[ "Uninitialize", "group__flash__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__flash__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "ReadData", "group__flash__interface__gr.html#adec45569a2f6f0d915a206f8f19107bd", null ],
[ "ProgramData", "group__flash__interface__gr.html#a429fc193f1ec62858219ab8749c563ae", null ],
[ "EraseSector", "group__flash__interface__gr.html#ad9d78f9fe07aabf12b23b95239818b55", null ],
[ "EraseChip", "group__flash__interface__gr.html#ae873705c743d94572fb6500421e15760", null ],
[ "GetStatus", "group__flash__interface__gr.html#afc1db6f33f777784f3c95efc816d4856", null ],
[ "GetInfo", "group__flash__interface__gr.html#ae64d4ee61b7a7ee0b38a0ef2b61f1db2", null ]
] ],
[ "ARM_FLASH_CAPABILITIES", "group__flash__interface__gr.html#structARM__FLASH__CAPABILITIES", [
[ "event_ready", "group__flash__interface__gr.html#add296ba516c8fc17ba51e30f2a00f0a9", null ],
[ "data_width", "group__flash__interface__gr.html#a04c173610dd0a545ecae308e342aafb0", null ],
[ "erase_chip", "group__flash__interface__gr.html#af5ec2b569c193fc5024c2739f46b328a", null ],
[ "reserved", "group__flash__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_FLASH_STATUS", "group__flash__interface__gr.html#structARM__FLASH__STATUS", [
[ "busy", "group__flash__interface__gr.html#a50c88f3c1d787773e2ac1b59533f034a", null ],
[ "error", "group__flash__interface__gr.html#aa8d183302fdfa4a6892f1d80300cdb32", null ],
[ "reserved", "group__flash__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_Flash_SignalEvent_t", "group__flash__interface__gr.html#gabeb4ad43b1e6fa4ed956cd5c9371d327", null ],
[ "ARM_Flash_GetVersion", "group__flash__interface__gr.html#ga1cfe24b2ffa571ee50ae544bd922b604", null ],
[ "ARM_Flash_GetCapabilities", "group__flash__interface__gr.html#ga27c23c998032cd47cb47293c0185ee5d", null ],
[ "ARM_Flash_Initialize", "group__flash__interface__gr.html#gaa5b4bbe529d620d4ad4825588a4c4cf0", null ],
[ "ARM_Flash_Uninitialize", "group__flash__interface__gr.html#gae23af293e9f8a67cdb19c7d0d562d415", null ],
[ "ARM_Flash_PowerControl", "group__flash__interface__gr.html#gaa8baa4618ea33568f8b3752afb2ab5a2", null ],
[ "ARM_Flash_ReadData", "group__flash__interface__gr.html#ga223138342383219896ed7e255faeb99a", null ],
[ "ARM_Flash_ProgramData", "group__flash__interface__gr.html#ga947f24ea4042093fdb5605a68ae74f9d", null ],
[ "ARM_Flash_EraseSector", "group__flash__interface__gr.html#ga0b2b4fe5a7be579cf3644995a765ea20", null ],
[ "ARM_Flash_EraseChip", "group__flash__interface__gr.html#ga6cbaebe069d31d56c70b1f8f847e2d55", null ],
[ "ARM_Flash_GetStatus", "group__flash__interface__gr.html#ga06885c0d4587d5a23f97614a8b849ef1", null ],
[ "ARM_Flash_GetInfo", "group__flash__interface__gr.html#gac047b7509356e888502e0424a9d189ae", null ],
[ "ARM_Flash_SignalEvent", "group__flash__interface__gr.html#ga97b75555b5433b268add81f2e60f095a", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__flash__interface__gr.js | JavaScript | apache-2.0 | 4,715 |
var group__flash__interface__gr_structARM__DRIVER__FLASH =
[
[ "GetVersion", "group__flash__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__flash__interface__gr.html#a25076bd7274af5d3b0af6380ed1f0331", null ],
[ "Initialize", "group__flash__interface__gr.html#a2d1eb2b5c3ee21ba5c92c37e89412567", null ],
[ "Uninitialize", "group__flash__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__flash__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "ReadData", "group__flash__interface__gr.html#adec45569a2f6f0d915a206f8f19107bd", null ],
[ "ProgramData", "group__flash__interface__gr.html#a429fc193f1ec62858219ab8749c563ae", null ],
[ "EraseSector", "group__flash__interface__gr.html#ad9d78f9fe07aabf12b23b95239818b55", null ],
[ "EraseChip", "group__flash__interface__gr.html#ae873705c743d94572fb6500421e15760", null ],
[ "GetStatus", "group__flash__interface__gr.html#afc1db6f33f777784f3c95efc816d4856", null ],
[ "GetInfo", "group__flash__interface__gr.html#ae64d4ee61b7a7ee0b38a0ef2b61f1db2", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__flash__interface__gr_structARM__DRIVER__FLASH.js | JavaScript | apache-2.0 | 1,144 |
var group__flash__interface__gr_structARM__FLASH__CAPABILITIES =
[
[ "event_ready", "group__flash__interface__gr.html#add296ba516c8fc17ba51e30f2a00f0a9", null ],
[ "data_width", "group__flash__interface__gr.html#a04c173610dd0a545ecae308e342aafb0", null ],
[ "erase_chip", "group__flash__interface__gr.html#af5ec2b569c193fc5024c2739f46b328a", null ],
[ "reserved", "group__flash__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__flash__interface__gr_structARM__FLASH__CAPABILITIES.js | JavaScript | apache-2.0 | 459 |
var group__flash__interface__gr_structARM__FLASH__INFO =
[
[ "sector_info", "group__flash__interface__gr.html#a8dfb9d5160358e45293bba527762238d", null ],
[ "sector_count", "group__flash__interface__gr.html#a50947f9a42bbaa2d68d6e5079150d7bf", null ],
[ "sector_size", "group__flash__interface__gr.html#a7d37def484362c6e97a2d75144080b1d", null ],
[ "page_size", "group__flash__interface__gr.html#a9dd3e47e968a8f6beb5d88c6d1b7ebe9", null ],
[ "program_unit", "group__flash__interface__gr.html#a483c41066757e2865bf3a27a2a627a54", null ],
[ "erased_value", "group__flash__interface__gr.html#a85c3826bf20669d38e466dfd376994db", null ],
[ "reserved", "group__flash__interface__gr.html#a72aca6ea6d8153b28ea8f139b932ec3e", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__flash__interface__gr_structARM__FLASH__INFO.js | JavaScript | apache-2.0 | 751 |
var group__flash__interface__gr_structARM__FLASH__SECTOR =
[
[ "start", "group__flash__interface__gr.html#a61eb63d26b2fa6c2971603ceccffb14b", null ],
[ "end", "group__flash__interface__gr.html#a204a3f4fa39b9c007f9784d3e4af4667", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__flash__interface__gr_structARM__FLASH__SECTOR.js | JavaScript | apache-2.0 | 246 |
var group__flash__interface__gr_structARM__FLASH__STATUS =
[
[ "busy", "group__flash__interface__gr.html#a50c88f3c1d787773e2ac1b59533f034a", null ],
[ "error", "group__flash__interface__gr.html#aa8d183302fdfa4a6892f1d80300cdb32", null ],
[ "reserved", "group__flash__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__flash__interface__gr_structARM__FLASH__STATUS.js | JavaScript | apache-2.0 | 343 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>I2C Address Flags</title>
<title>CMSIS-Driver: I2C Address Flags</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__i2c__address__flags.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">I2C Address Flags<div class="ingroups"><a class="el" href="group__i2c__interface__gr.html">I2C Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify address flags.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga16be1861b90774bf062feab2dbb829a4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__address__flags.html#ga16be1861b90774bf062feab2dbb829a4">ARM_I2C_ADDRESS_10BIT</a>   (0x0400)</td></tr>
<tr class="memdesc:ga16be1861b90774bf062feab2dbb829a4"><td class="mdescLeft"> </td><td class="mdescRight">10-bit address flag <a href="#ga16be1861b90774bf062feab2dbb829a4">More...</a><br/></td></tr>
<tr class="separator:ga16be1861b90774bf062feab2dbb829a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga337f4f1aa082e9b593b2dcd43c50134e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__address__flags.html#ga337f4f1aa082e9b593b2dcd43c50134e">ARM_I2C_ADDRESS_GC</a>   (0x8000)</td></tr>
<tr class="memdesc:ga337f4f1aa082e9b593b2dcd43c50134e"><td class="mdescLeft"> </td><td class="mdescRight">General Call flag. <a href="#ga337f4f1aa082e9b593b2dcd43c50134e">More...</a><br/></td></tr>
<tr class="separator:ga337f4f1aa082e9b593b2dcd43c50134e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify address flags. </p>
<p>Specifies the address type for the functions <a class="el" href="group__i2c__interface__gr.html#gafa22504bcf88a85584dfe6e0dd270ad5">ARM_I2C_MasterReceive</a>, <a class="el" href="group__i2c__interface__gr.html#ga8bf4214580149d5a5d2360f71f0feb94">ARM_I2C_MasterTransmit</a> and <a class="el" href="group__i2c__control__codes.html#ga69d130b9f8aa34d6df5334ab67c74307">ARM_I2C_OWN_ADDRESS</a>. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga16be1861b90774bf062feab2dbb829a4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_ADDRESS_10BIT   (0x0400)</td>
</tr>
</table>
</div><div class="memdoc">
<p>10-bit address flag </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__i2c__control__codes.html#ga69d130b9f8aa34d6df5334ab67c74307" title="Set Own Slave Address; arg = address. ">ARM_I2C_OWN_ADDRESS</a> </dd>
<dd>
<a class="el" href="group__i2c__interface__gr.html#ga8bf4214580149d5a5d2360f71f0feb94" title="Start transmitting data as I2C Master. ">ARM_I2C_MasterTransmit</a> </dd>
<dd>
<a class="el" href="group__i2c__interface__gr.html#gafa22504bcf88a85584dfe6e0dd270ad5" title="Start receiving data as I2C Master. ">ARM_I2C_MasterReceive</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga337f4f1aa082e9b593b2dcd43c50134e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_ADDRESS_GC   (0x8000)</td>
</tr>
</table>
</div><div class="memdoc">
<p>General Call flag. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__i2c__control__codes.html#ga69d130b9f8aa34d6df5334ab67c74307" title="Set Own Slave Address; arg = address. ">ARM_I2C_OWN_ADDRESS</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__i2c__address__flags.html | HTML | apache-2.0 | 9,865 |
var group__i2c__address__flags =
[
[ "ARM_I2C_ADDRESS_10BIT", "group__i2c__address__flags.html#ga16be1861b90774bf062feab2dbb829a4", null ],
[ "ARM_I2C_ADDRESS_GC", "group__i2c__address__flags.html#ga337f4f1aa082e9b593b2dcd43c50134e", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__i2c__address__flags.js | JavaScript | apache-2.0 | 251 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>I2C Bus Speed</title>
<title>CMSIS-Driver: I2C Bus Speed</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__i2c__bus__speed__ctrls.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">I2C Bus Speed<div class="ingroups"><a class="el" href="group__i2c__control__gr.html">I2C Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify the I2C bus speed.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga0aaa6398280fdd7ad651d7d6d44c863f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__bus__speed__ctrls.html#ga0aaa6398280fdd7ad651d7d6d44c863f">ARM_I2C_BUS_SPEED_STANDARD</a>   (0x01)</td></tr>
<tr class="memdesc:ga0aaa6398280fdd7ad651d7d6d44c863f"><td class="mdescLeft"> </td><td class="mdescRight">Standard Speed (100kHz) <a href="#ga0aaa6398280fdd7ad651d7d6d44c863f">More...</a><br/></td></tr>
<tr class="separator:ga0aaa6398280fdd7ad651d7d6d44c863f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga39f49ef4cd1100a8d9dc9003329e5ecd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__bus__speed__ctrls.html#ga39f49ef4cd1100a8d9dc9003329e5ecd">ARM_I2C_BUS_SPEED_FAST</a>   (0x02)</td></tr>
<tr class="memdesc:ga39f49ef4cd1100a8d9dc9003329e5ecd"><td class="mdescLeft"> </td><td class="mdescRight">Fast Speed (400kHz) <a href="#ga39f49ef4cd1100a8d9dc9003329e5ecd">More...</a><br/></td></tr>
<tr class="separator:ga39f49ef4cd1100a8d9dc9003329e5ecd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2615262062e0327ab478ec85675ca649"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__bus__speed__ctrls.html#ga2615262062e0327ab478ec85675ca649">ARM_I2C_BUS_SPEED_FAST_PLUS</a>   (0x03)</td></tr>
<tr class="memdesc:ga2615262062e0327ab478ec85675ca649"><td class="mdescLeft"> </td><td class="mdescRight">Fast+ Speed ( 1MHz) <a href="#ga2615262062e0327ab478ec85675ca649">More...</a><br/></td></tr>
<tr class="separator:ga2615262062e0327ab478ec85675ca649"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga10aae5a8c7fcc90e514c5fb7393056ec"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__bus__speed__ctrls.html#ga10aae5a8c7fcc90e514c5fb7393056ec">ARM_I2C_BUS_SPEED_HIGH</a>   (0x04)</td></tr>
<tr class="memdesc:ga10aae5a8c7fcc90e514c5fb7393056ec"><td class="mdescLeft"> </td><td class="mdescRight">High Speed (3.4MHz) <a href="#ga10aae5a8c7fcc90e514c5fb7393056ec">More...</a><br/></td></tr>
<tr class="separator:ga10aae5a8c7fcc90e514c5fb7393056ec"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify the I2C bus speed. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga0aaa6398280fdd7ad651d7d6d44c863f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_BUS_SPEED_STANDARD   (0x01)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Standard Speed (100kHz) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc" title="Control I2C Interface. ">ARM_I2C_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga39f49ef4cd1100a8d9dc9003329e5ecd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_BUS_SPEED_FAST   (0x02)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Fast Speed (400kHz) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc" title="Control I2C Interface. ">ARM_I2C_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga2615262062e0327ab478ec85675ca649"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_BUS_SPEED_FAST_PLUS   (0x03)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Fast+ Speed ( 1MHz) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc" title="Control I2C Interface. ">ARM_I2C_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga10aae5a8c7fcc90e514c5fb7393056ec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_BUS_SPEED_HIGH   (0x04)</td>
</tr>
</table>
</div><div class="memdoc">
<p>High Speed (3.4MHz) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc" title="Control I2C Interface. ">ARM_I2C_Control</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__i2c__bus__speed__ctrls.html | HTML | apache-2.0 | 11,460 |
var group__i2c__bus__speed__ctrls =
[
[ "ARM_I2C_BUS_SPEED_STANDARD", "group__i2c__bus__speed__ctrls.html#ga0aaa6398280fdd7ad651d7d6d44c863f", null ],
[ "ARM_I2C_BUS_SPEED_FAST", "group__i2c__bus__speed__ctrls.html#ga39f49ef4cd1100a8d9dc9003329e5ecd", null ],
[ "ARM_I2C_BUS_SPEED_FAST_PLUS", "group__i2c__bus__speed__ctrls.html#ga2615262062e0327ab478ec85675ca649", null ],
[ "ARM_I2C_BUS_SPEED_HIGH", "group__i2c__bus__speed__ctrls.html#ga10aae5a8c7fcc90e514c5fb7393056ec", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__i2c__bus__speed__ctrls.js | JavaScript | apache-2.0 | 500 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>I2C Control Codes</title>
<title>CMSIS-Driver: I2C Control Codes</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__i2c__control__codes.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">I2C Control Codes<div class="ingroups"><a class="el" href="group__i2c__control__gr.html">I2C Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify operation parameters and various controls.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga69d130b9f8aa34d6df5334ab67c74307"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__control__codes.html#ga69d130b9f8aa34d6df5334ab67c74307">ARM_I2C_OWN_ADDRESS</a>   (0x01)</td></tr>
<tr class="memdesc:ga69d130b9f8aa34d6df5334ab67c74307"><td class="mdescLeft"> </td><td class="mdescRight">Set Own Slave Address; arg = address. <a href="#ga69d130b9f8aa34d6df5334ab67c74307">More...</a><br/></td></tr>
<tr class="separator:ga69d130b9f8aa34d6df5334ab67c74307"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga35733133237d65146abd9449f5353a7f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__control__codes.html#ga35733133237d65146abd9449f5353a7f">ARM_I2C_BUS_SPEED</a>   (0x02)</td></tr>
<tr class="memdesc:ga35733133237d65146abd9449f5353a7f"><td class="mdescLeft"> </td><td class="mdescRight">Set Bus Speed; arg = speed. <a href="#ga35733133237d65146abd9449f5353a7f">More...</a><br/></td></tr>
<tr class="separator:ga35733133237d65146abd9449f5353a7f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadacf04578770faca4b3eaae34b2c5f03"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__control__codes.html#gadacf04578770faca4b3eaae34b2c5f03">ARM_I2C_BUS_CLEAR</a>   (0x03)</td></tr>
<tr class="memdesc:gadacf04578770faca4b3eaae34b2c5f03"><td class="mdescLeft"> </td><td class="mdescRight">Execute Bus clear: send nine clock pulses. <a href="#gadacf04578770faca4b3eaae34b2c5f03">More...</a><br/></td></tr>
<tr class="separator:gadacf04578770faca4b3eaae34b2c5f03"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga661e91aaa642d10ba80e3cc72f263040"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__control__codes.html#ga661e91aaa642d10ba80e3cc72f263040">ARM_I2C_ABORT_TRANSFER</a>   (0x04)</td></tr>
<tr class="memdesc:ga661e91aaa642d10ba80e3cc72f263040"><td class="mdescLeft"> </td><td class="mdescRight">Abort Master/Slave Transmit/Receive. <a href="#ga661e91aaa642d10ba80e3cc72f263040">More...</a><br/></td></tr>
<tr class="separator:ga661e91aaa642d10ba80e3cc72f263040"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify operation parameters and various controls. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga69d130b9f8aa34d6df5334ab67c74307"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_OWN_ADDRESS   (0x01)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Own Slave Address; arg = address. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc" title="Control I2C Interface. ">ARM_I2C_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga35733133237d65146abd9449f5353a7f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_BUS_SPEED   (0x02)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Bus Speed; arg = speed. </p>
<p>Speed is specified using the following values: <a class="el" href="group__i2c__bus__speed__ctrls.html">I2C Bus Speed</a> </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc" title="Control I2C Interface. ">ARM_I2C_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gadacf04578770faca4b3eaae34b2c5f03"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_BUS_CLEAR   (0x03)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Execute Bus clear: send nine clock pulses. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc" title="Control I2C Interface. ">ARM_I2C_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga661e91aaa642d10ba80e3cc72f263040"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_ABORT_TRANSFER   (0x04)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Abort Master/Slave Transmit/Receive. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc" title="Control I2C Interface. ">ARM_I2C_Control</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__i2c__control__codes.html | HTML | apache-2.0 | 11,714 |
var group__i2c__control__codes =
[
[ "ARM_I2C_OWN_ADDRESS", "group__i2c__control__codes.html#ga69d130b9f8aa34d6df5334ab67c74307", null ],
[ "ARM_I2C_BUS_SPEED", "group__i2c__control__codes.html#ga35733133237d65146abd9449f5353a7f", null ],
[ "ARM_I2C_BUS_CLEAR", "group__i2c__control__codes.html#gadacf04578770faca4b3eaae34b2c5f03", null ],
[ "ARM_I2C_ABORT_TRANSFER", "group__i2c__control__codes.html#ga661e91aaa642d10ba80e3cc72f263040", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__i2c__control__codes.js | JavaScript | apache-2.0 | 463 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>I2C Control Codes</title>
<title>CMSIS-Driver: I2C Control Codes</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__i2c__control__gr.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Content</a> </div>
<div class="headertitle">
<div class="title">I2C Control Codes<div class="ingroups"><a class="el" href="group__i2c__interface__gr.html">I2C Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Many parameters of the I2C driver are configured using the <a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc">ARM_I2C_Control</a> function.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Content</h2></td></tr>
<tr class="memitem:group__i2c__control__codes"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__control__codes.html">I2C Control Codes</a></td></tr>
<tr class="memdesc:group__i2c__control__codes"><td class="mdescLeft"> </td><td class="mdescRight">Specify operation parameters and various controls. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__i2c__bus__speed__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__bus__speed__ctrls.html">I2C Bus Speed</a></td></tr>
<tr class="memdesc:group__i2c__bus__speed__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Specify the I2C bus speed. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Many parameters of the I2C driver are configured using the <a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc">ARM_I2C_Control</a> function. </p>
<p>The various I2C control codes define:</p>
<ul>
<li><a class="el" href="group__i2c__control__codes.html">I2C Control Codes</a> specify operation parameters and various controls</li>
<li><a class="el" href="group__i2c__bus__speed__ctrls.html">I2C Bus Speed</a> specify the I2C bus speed</li>
</ul>
<p>Refer to the <a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc">ARM_I2C_Control</a> function for further details. </p>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__i2c__control__gr.html | HTML | apache-2.0 | 8,388 |
var group__i2c__control__gr =
[
[ "I2C Control Codes", "group__i2c__control__codes.html", "group__i2c__control__codes" ],
[ "I2C Bus Speed", "group__i2c__bus__speed__ctrls.html", "group__i2c__bus__speed__ctrls" ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__i2c__control__gr.js | JavaScript | apache-2.0 | 223 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>I2C Interface</title>
<title>CMSIS-Driver: I2C Interface</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__i2c__interface__gr.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Content</a> |
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">I2C Interface</div> </div>
</div><!--header-->
<div class="contents">
<p>Driver API for I2C Bus Peripheral (Driver_I2C.h)
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Content</h2></td></tr>
<tr class="memitem:group__I2C__events"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html">I2C Events</a></td></tr>
<tr class="memdesc:group__I2C__events"><td class="mdescLeft"> </td><td class="mdescRight">The I2C driver generates call back events that are notified via the function <a class="el" href="group__i2c__interface__gr.html#gad4f93d2895794b416dc8d8e9de91c05e">ARM_I2C_SignalEvent</a>. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__i2c__control__gr"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__control__gr.html">I2C Control Codes</a></td></tr>
<tr class="memdesc:group__i2c__control__gr"><td class="mdescLeft"> </td><td class="mdescRight">Many parameters of the I2C driver are configured using the <a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc">ARM_I2C_Control</a> function. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__i2c__address__flags"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__address__flags.html">I2C Address Flags</a></td></tr>
<tr class="memdesc:group__i2c__address__flags"><td class="mdescLeft"> </td><td class="mdescRight">Specify address flags. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:structARM__DRIVER__I2C"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#structARM__DRIVER__I2C">ARM_DRIVER_I2C</a></td></tr>
<tr class="memdesc:structARM__DRIVER__I2C"><td class="mdescLeft"> </td><td class="mdescRight">Access structure of the I2C Driver. <a href="group__i2c__interface__gr.html#structARM__DRIVER__I2C">More...</a><br/></td></tr>
<tr class="separator:structARM__DRIVER__I2C"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__I2C__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#structARM__I2C__CAPABILITIES">ARM_I2C_CAPABILITIES</a></td></tr>
<tr class="memdesc:structARM__I2C__CAPABILITIES"><td class="mdescLeft"> </td><td class="mdescRight">I2C Driver Capabilities. <a href="group__i2c__interface__gr.html#structARM__I2C__CAPABILITIES">More...</a><br/></td></tr>
<tr class="separator:structARM__I2C__CAPABILITIES"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__I2C__STATUS"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#structARM__I2C__STATUS">ARM_I2C_STATUS</a></td></tr>
<tr class="memdesc:structARM__I2C__STATUS"><td class="mdescLeft"> </td><td class="mdescRight">I2C Status. <a href="group__i2c__interface__gr.html#structARM__I2C__STATUS">More...</a><br/></td></tr>
<tr class="separator:structARM__I2C__STATUS"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga24277c48248a09b0dd7f12bbe22ce13c"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#ga24277c48248a09b0dd7f12bbe22ce13c">ARM_I2C_SignalEvent_t</a> )(uint32_t event)</td></tr>
<tr class="memdesc:ga24277c48248a09b0dd7f12bbe22ce13c"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__i2c__interface__gr.html#gad4f93d2895794b416dc8d8e9de91c05e">ARM_I2C_SignalEvent</a> : Signal I2C Event. <a href="#ga24277c48248a09b0dd7f12bbe22ce13c">More...</a><br/></td></tr>
<tr class="separator:ga24277c48248a09b0dd7f12bbe22ce13c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga956bd87590c7fb6e23609a0abfb5412c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#ga956bd87590c7fb6e23609a0abfb5412c">ARM_I2C_GetVersion</a> (void)</td></tr>
<tr class="memdesc:ga956bd87590c7fb6e23609a0abfb5412c"><td class="mdescLeft"> </td><td class="mdescRight">Get driver version. <a href="#ga956bd87590c7fb6e23609a0abfb5412c">More...</a><br/></td></tr>
<tr class="separator:ga956bd87590c7fb6e23609a0abfb5412c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad20e6731f627aa7b9d6e99a50806122e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__i2c__interface__gr.html#structARM__I2C__CAPABILITIES">ARM_I2C_CAPABILITIES</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#gad20e6731f627aa7b9d6e99a50806122e">ARM_I2C_GetCapabilities</a> (void)</td></tr>
<tr class="memdesc:gad20e6731f627aa7b9d6e99a50806122e"><td class="mdescLeft"> </td><td class="mdescRight">Get driver capabilities. <a href="#gad20e6731f627aa7b9d6e99a50806122e">More...</a><br/></td></tr>
<tr class="separator:gad20e6731f627aa7b9d6e99a50806122e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga79d2f7d01b3a681d1cf0d70ac6692696"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#ga79d2f7d01b3a681d1cf0d70ac6692696">ARM_I2C_Initialize</a> (<a class="el" href="group__i2c__interface__gr.html#ga24277c48248a09b0dd7f12bbe22ce13c">ARM_I2C_SignalEvent_t</a> cb_event)</td></tr>
<tr class="memdesc:ga79d2f7d01b3a681d1cf0d70ac6692696"><td class="mdescLeft"> </td><td class="mdescRight">Initialize I2C Interface. <a href="#ga79d2f7d01b3a681d1cf0d70ac6692696">More...</a><br/></td></tr>
<tr class="separator:ga79d2f7d01b3a681d1cf0d70ac6692696"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga30d8bf600b6b3182a1f867407b3d6e75"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#ga30d8bf600b6b3182a1f867407b3d6e75">ARM_I2C_Uninitialize</a> (void)</td></tr>
<tr class="memdesc:ga30d8bf600b6b3182a1f867407b3d6e75"><td class="mdescLeft"> </td><td class="mdescRight">De-initialize I2C Interface. <a href="#ga30d8bf600b6b3182a1f867407b3d6e75">More...</a><br/></td></tr>
<tr class="separator:ga30d8bf600b6b3182a1f867407b3d6e75"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga734a69200e063fdbfb5110062afe9329"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#ga734a69200e063fdbfb5110062afe9329">ARM_I2C_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:ga734a69200e063fdbfb5110062afe9329"><td class="mdescLeft"> </td><td class="mdescRight">Control I2C Interface Power. <a href="#ga734a69200e063fdbfb5110062afe9329">More...</a><br/></td></tr>
<tr class="separator:ga734a69200e063fdbfb5110062afe9329"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8bf4214580149d5a5d2360f71f0feb94"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#ga8bf4214580149d5a5d2360f71f0feb94">ARM_I2C_MasterTransmit</a> (uint32_t addr, const uint8_t *data, uint32_t num, bool xfer_pending)</td></tr>
<tr class="memdesc:ga8bf4214580149d5a5d2360f71f0feb94"><td class="mdescLeft"> </td><td class="mdescRight">Start transmitting data as I2C Master. <a href="#ga8bf4214580149d5a5d2360f71f0feb94">More...</a><br/></td></tr>
<tr class="separator:ga8bf4214580149d5a5d2360f71f0feb94"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafa22504bcf88a85584dfe6e0dd270ad5"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#gafa22504bcf88a85584dfe6e0dd270ad5">ARM_I2C_MasterReceive</a> (uint32_t addr, uint8_t *data, uint32_t num, bool xfer_pending)</td></tr>
<tr class="memdesc:gafa22504bcf88a85584dfe6e0dd270ad5"><td class="mdescLeft"> </td><td class="mdescRight">Start receiving data as I2C Master. <a href="#gafa22504bcf88a85584dfe6e0dd270ad5">More...</a><br/></td></tr>
<tr class="separator:gafa22504bcf88a85584dfe6e0dd270ad5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafe164f30eba78f066272373b98a62cd4"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#gafe164f30eba78f066272373b98a62cd4">ARM_I2C_SlaveTransmit</a> (const uint8_t *data, uint32_t num)</td></tr>
<tr class="memdesc:gafe164f30eba78f066272373b98a62cd4"><td class="mdescLeft"> </td><td class="mdescRight">Start transmitting data as I2C Slave. <a href="#gafe164f30eba78f066272373b98a62cd4">More...</a><br/></td></tr>
<tr class="separator:gafe164f30eba78f066272373b98a62cd4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae3c9abccd1d377385d3d4cfe29035164"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#gae3c9abccd1d377385d3d4cfe29035164">ARM_I2C_SlaveReceive</a> (uint8_t *data, uint32_t num)</td></tr>
<tr class="memdesc:gae3c9abccd1d377385d3d4cfe29035164"><td class="mdescLeft"> </td><td class="mdescRight">Start receiving data as I2C Slave. <a href="#gae3c9abccd1d377385d3d4cfe29035164">More...</a><br/></td></tr>
<tr class="separator:gae3c9abccd1d377385d3d4cfe29035164"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga19db20ad8d7fde84d07f6db4d75f4b7c"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#ga19db20ad8d7fde84d07f6db4d75f4b7c">ARM_I2C_GetDataCount</a> (void)</td></tr>
<tr class="memdesc:ga19db20ad8d7fde84d07f6db4d75f4b7c"><td class="mdescLeft"> </td><td class="mdescRight">Get transferred data count. <a href="#ga19db20ad8d7fde84d07f6db4d75f4b7c">More...</a><br/></td></tr>
<tr class="separator:ga19db20ad8d7fde84d07f6db4d75f4b7c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga828f5fa289d065675ef78a9a73d129dc"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc">ARM_I2C_Control</a> (uint32_t control, uint32_t arg)</td></tr>
<tr class="memdesc:ga828f5fa289d065675ef78a9a73d129dc"><td class="mdescLeft"> </td><td class="mdescRight">Control I2C Interface. <a href="#ga828f5fa289d065675ef78a9a73d129dc">More...</a><br/></td></tr>
<tr class="separator:ga828f5fa289d065675ef78a9a73d129dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaba4e0f3eb4018e7dafd51b675c465f3e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__i2c__interface__gr.html#structARM__I2C__STATUS">ARM_I2C_STATUS</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#gaba4e0f3eb4018e7dafd51b675c465f3e">ARM_I2C_GetStatus</a> (void)</td></tr>
<tr class="memdesc:gaba4e0f3eb4018e7dafd51b675c465f3e"><td class="mdescLeft"> </td><td class="mdescRight">Get I2C status. <a href="#gaba4e0f3eb4018e7dafd51b675c465f3e">More...</a><br/></td></tr>
<tr class="separator:gaba4e0f3eb4018e7dafd51b675c465f3e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad4f93d2895794b416dc8d8e9de91c05e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#gad4f93d2895794b416dc8d8e9de91c05e">ARM_I2C_SignalEvent</a> (uint32_t event)</td></tr>
<tr class="memdesc:gad4f93d2895794b416dc8d8e9de91c05e"><td class="mdescLeft"> </td><td class="mdescRight">Signal I2C Events. <a href="#gad4f93d2895794b416dc8d8e9de91c05e">More...</a><br/></td></tr>
<tr class="separator:gad4f93d2895794b416dc8d8e9de91c05e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Driver API for I2C Bus Peripheral (Driver_I2C.h) </p>
<p>I<sup>2</sup>C (Inter-Integrated Circuit, referred to as I-squared-C, I-two-C, or IIC) is a multi-master serial single-ended bus and is mostly used on single boards, but can also connect to components which are linked via cable.</p>
<p>Most significant features of the I<sup>2</sup>C bus include:</p>
<ul>
<li>Only two bus lines are required</li>
<li>I<sup>2</sup>C is a true multi-master bus. Simple master/slave relationships exist between all components</li>
<li>A baud rate is not required; the master device determines a bus clock</li>
<li>Each connected device is addressable by a unique address</li>
<li>Providing arbitration and collision detection</li>
</ul>
<p>For more information about I<sup>2</sup>C refer to the following web pages:</p>
<ul>
<li>Wikipedia: <a href="http://en.wikipedia.org/wiki/I%C2%B2C" target="_blank">I<sup>2</sup>C</a></li>
<li><a href="http://www.i2c-bus.org" target="_blank">www.i2c-bus.org</a>.</li>
</ul>
<p>Devices can operation in Master or Slave mode:</p>
<ul>
<li>To operate in Master mode call the functions <a class="el" href="group__i2c__interface__gr.html#ga8bf4214580149d5a5d2360f71f0feb94">ARM_I2C_MasterTransmit</a> or <a class="el" href="group__i2c__interface__gr.html#gafa22504bcf88a85584dfe6e0dd270ad5">ARM_I2C_MasterReceive</a>. These functions get as argument a <em>slave address</em>.</li>
<li>To operate in Slave mode set the <em>slave address</em> using the function <a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc">ARM_I2C_Control</a>. The functions <a class="el" href="group__i2c__interface__gr.html#gafe164f30eba78f066272373b98a62cd4">ARM_I2C_SlaveTransmit</a> or <a class="el" href="group__i2c__interface__gr.html#gae3c9abccd1d377385d3d4cfe29035164">ARM_I2C_SlaveReceive</a> are used to transfer data in Slave mode.</li>
</ul>
<p><b>I<sup>2</sup>C Slave Address</b></p>
<p>Depending on the device, I<sup>2</sup>C supports 7-bit and 10-bit Slaves addresses. The element <em>address_10_bit</em> in <a class="el" href="group__i2c__interface__gr.html#structARM__I2C__CAPABILITIES">ARM_I2C_CAPABILITIES</a> indicates that the driver is able to handle 10-bit addresses. A 10-bit Slave address is ORed with <a class="el" href="group__i2c__address__flags.html#ga16be1861b90774bf062feab2dbb829a4">ARM_I2C_ADDRESS_10BIT</a>.</p>
<p>I<sup>2</sup>C also supports a General Call to all Slaves by using the slave address value <span class="XML-Token">0</span>. A General Call is recognized by Slaves have a slave address value <a class="el" href="group__i2c__address__flags.html#ga337f4f1aa082e9b593b2dcd43c50134e">ARM_I2C_ADDRESS_GC</a> registered with the function <a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc">ARM_I2C_Control</a>.</p>
<p><b>Block Diagram</b></p>
<p>The I2C driver allows you to connect low-speed peripherals to a motherboard, embedded system, cellphone, or other electronic device.</p>
<div class="image">
<img src="I2C_BlockDiagram.png" alt="I2C_BlockDiagram.png"/>
<div class="caption">
Master/Slave connected via I2C interface</div></div>
<p><b>I<sup>2</sup>C API</b></p>
<p>The following header files define the Application Programming Interface (API) for the I<sup>2</sup>C interface:</p>
<ul>
<li><b>Driver_I2C.h</b> : Driver API for I2C Bus Peripheral</li>
</ul>
<p>The driver implementation is a typical part of the Device Family Pack (DFP) that supports the peripherals of the microcontroller family.</p>
<p><b>Driver Functions</b></p>
<p>The driver functions are published in the access struct as explained in <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a></p>
<ul>
<li><a class="el" href="group__i2c__interface__gr.html#structARM__DRIVER__I2C">ARM_DRIVER_I2C</a> : access struct for I2C driver functions</li>
</ul>
<p><a class="anchor" id="example"></a><b>Example Code</b></p>
<p>The following example code shows the usage of the I<sup>2</sup>C interface in Master mode.</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include "<a class="code" href="Driver__I2C_8h.html">Driver_I2C.h</a>"</span></div>
<div class="line"> </div>
<div class="line"><span class="preprocessor">#define EEPROM_I2C_ADDR 0x51 </span><span class="comment">/* EEPROM I2C address */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor"></span> </div>
<div class="line"><span class="comment">/* I2C driver instance */</span></div>
<div class="line"><span class="keyword">extern</span> <a class="code" href="group__i2c__interface__gr.html#structARM__DRIVER__I2C">ARM_DRIVER_I2C</a> Driver_I2C0;</div>
<div class="line"><span class="keyword">static</span> <a class="code" href="group__i2c__interface__gr.html#structARM__DRIVER__I2C">ARM_DRIVER_I2C</a> *I2Cdrv = &Driver_I2C0;</div>
<div class="line"> </div>
<div class="line"><span class="keyword">static</span> <span class="keyword">volatile</span> uint32_t I2C_Event;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* I2C Signal Event function callback */</span></div>
<div class="line"><span class="keywordtype">void</span> I2C_SignalEvent (uint32_t event) {</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Save received events */</span></div>
<div class="line"> I2C_Event |= event;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Optionally, user can define specific actions for an event */</span></div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (event & <a class="code" href="group__I2C__events.html#gafac3989c7b57727e1bed4ee9f2496ac9">ARM_I2C_EVENT_TRANSFER_INCOMPLETE</a>) {</div>
<div class="line"> <span class="comment">/* Less data was transferred than requested */</span></div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (event & <a class="code" href="group__I2C__events.html#ga5992dc0f6e839c4d066cfa83d535f30d">ARM_I2C_EVENT_TRANSFER_DONE</a>) {</div>
<div class="line"> <span class="comment">/* Transfer or receive is finished */</span></div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (event & <a class="code" href="group__I2C__events.html#ga98b815769634d9578526b43589caa017">ARM_I2C_EVENT_ADDRESS_NACK</a>) {</div>
<div class="line"> <span class="comment">/* Slave address was not acknowledged */</span></div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (event & <a class="code" href="group__I2C__events.html#gac9000f44a578e2117d64dbc2093cec6d">ARM_I2C_EVENT_ARBITRATION_LOST</a>) {</div>
<div class="line"> <span class="comment">/* Master lost bus arbitration */</span></div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (event & <a class="code" href="group__I2C__events.html#gaeef542840355131c18b53fd9ed1904a8">ARM_I2C_EVENT_BUS_ERROR</a>) {</div>
<div class="line"> <span class="comment">/* Invalid start/stop position detected */</span></div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (event & <a class="code" href="group__I2C__events.html#ga81ca21fad73dac1ffaff58921f848ea9">ARM_I2C_EVENT_BUS_CLEAR</a>) {</div>
<div class="line"> <span class="comment">/* Bus clear operation completed */</span></div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (event & <a class="code" href="group__I2C__events.html#ga3ab54410b6410ed3a58762ff0c0d68b9">ARM_I2C_EVENT_GENERAL_CALL</a>) {</div>
<div class="line"> <span class="comment">/* Slave was addressed with a general call address */</span></div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (event & <a class="code" href="group__I2C__events.html#gabd875b57ce39dadd849c53b885ad6661">ARM_I2C_EVENT_SLAVE_RECEIVE</a>) {</div>
<div class="line"> <span class="comment">/* Slave addressed as receiver but SlaveReceive operation is not started */</span></div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (event & <a class="code" href="group__I2C__events.html#gacfbbec9af083d35e8ea87ad16e9c6ec2">ARM_I2C_EVENT_SLAVE_TRANSMIT</a>) {</div>
<div class="line"> <span class="comment">/* Slave addressed as transmitter but SlaveTransmit operation is not started */</span></div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="comment">/* Read I2C connected EEPROM (event driven example) */</span></div>
<div class="line">int32_t EEPROM_Read_Event (uint16_t addr, uint8_t *buf, uint32_t len) {</div>
<div class="line"> uint8_t a[2];</div>
<div class="line"> </div>
<div class="line"> a[0] = (uint8_t)(addr >> 8);</div>
<div class="line"> a[1] = (uint8_t)(addr & 0xFF);</div>
<div class="line"></div>
<div class="line"> <span class="comment">/* Clear event flags before new transfer */</span></div>
<div class="line"> I2C_Event = 0U;</div>
<div class="line"> </div>
<div class="line"> I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#a9e58f7ea5fd9476e06b45c70b6696b95">MasterTransmit</a> (EEPROM_I2C_ADDR, a, 2, <span class="keyword">true</span>);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Wait until transfer completed */</span></div>
<div class="line"> <span class="keywordflow">while</span> ((I2C_Event & ARM_I2C_EVENT_TRANSFER_DONE) == 0U);</div>
<div class="line"> <span class="comment">/* Check if all data transferred */</span></div>
<div class="line"> <span class="keywordflow">if</span> ((I2C_Event & ARM_I2C_EVENT_TRANSFER_INCOMPLETE) != 0U) <span class="keywordflow">return</span> -1;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Clear event flags before new transfer */</span></div>
<div class="line"> I2C_Event = 0U;</div>
<div class="line"> </div>
<div class="line"> I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#aa135ff2f4832d35ceb5d7e248159b981">MasterReceive</a> (EEPROM_I2C_ADDR, buf, len, <span class="keyword">false</span>);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Wait until transfer completed */</span></div>
<div class="line"> <span class="keywordflow">while</span> ((I2C_Event & ARM_I2C_EVENT_TRANSFER_DONE) == 0U);</div>
<div class="line"> <span class="comment">/* Check if all data transferred */</span></div>
<div class="line"> <span class="keywordflow">if</span> ((I2C_Event & ARM_I2C_EVENT_TRANSFER_INCOMPLETE) != 0U) <span class="keywordflow">return</span> -1;</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="comment">/* Read I2C connected EEPROM (pooling example) */</span></div>
<div class="line">int32_t EEPROM_Read_Pool (uint16_t addr, uint8_t *buf, uint32_t len) {</div>
<div class="line"> uint8_t a[2];</div>
<div class="line"> </div>
<div class="line"> a[0] = (uint8_t)(addr >> 8);</div>
<div class="line"> a[1] = (uint8_t)(addr & 0xFF);</div>
<div class="line"> </div>
<div class="line"> I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#a9e58f7ea5fd9476e06b45c70b6696b95">MasterTransmit</a> (EEPROM_I2C_ADDR, a, 2, <span class="keyword">true</span>);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Wait until transfer completed */</span></div>
<div class="line"> <span class="keywordflow">while</span> (I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#ad4b47653bc47cdb02965dd311e88b96a">GetStatus</a>().<a class="code" href="group__i2c__interface__gr.html#a50c88f3c1d787773e2ac1b59533f034a">busy</a>);</div>
<div class="line"> <span class="comment">/* Check if all data transferred */</span></div>
<div class="line"> <span class="keywordflow">if</span> (I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#ad421a9b9b07fd6d3e6537396c2b98788">GetDataCount</a> () != len) <span class="keywordflow">return</span> -1;</div>
<div class="line"> </div>
<div class="line"> I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#aa135ff2f4832d35ceb5d7e248159b981">MasterReceive</a> (EEPROM_I2C_ADDR, buf, len, <span class="keyword">false</span>);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Wait until transfer completed */</span></div>
<div class="line"> <span class="keywordflow">while</span> (I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#ad4b47653bc47cdb02965dd311e88b96a">GetStatus</a>().<a class="code" href="group__i2c__interface__gr.html#a50c88f3c1d787773e2ac1b59533f034a">busy</a>);</div>
<div class="line"> <span class="comment">/* Check if all data transferred */</span></div>
<div class="line"> <span class="keywordflow">if</span> (I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#ad421a9b9b07fd6d3e6537396c2b98788">GetDataCount</a> () != len) <span class="keywordflow">return</span> -1;</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Initialize I2C connected EEPROM */</span></div>
<div class="line">int32_t EEPROM_Initialize (<span class="keywordtype">bool</span> pooling) {</div>
<div class="line"> int32_t status;</div>
<div class="line"> uint8_t val;</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (pooling == <span class="keyword">true</span>) {</div>
<div class="line"> I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#ab0480980f67e0ebe0461ccea7873a65b">Initialize</a> (NULL);</div>
<div class="line"> } <span class="keywordflow">else</span> {</div>
<div class="line"> I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#ab0480980f67e0ebe0461ccea7873a65b">Initialize</a> (I2C_SignalEvent);</div>
<div class="line"> }</div>
<div class="line"> I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> (<a class="code" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a>);</div>
<div class="line"> I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a> (<a class="code" href="group__i2c__control__codes.html#ga35733133237d65146abd9449f5353a7f">ARM_I2C_BUS_SPEED</a>, <a class="code" href="group__i2c__bus__speed__ctrls.html#ga39f49ef4cd1100a8d9dc9003329e5ecd">ARM_I2C_BUS_SPEED_FAST</a>);</div>
<div class="line"> I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a> (<a class="code" href="group__i2c__control__codes.html#gadacf04578770faca4b3eaae34b2c5f03">ARM_I2C_BUS_CLEAR</a>, 0);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Check if EEPROM can be accessed */</span></div>
<div class="line"> <span class="keywordflow">if</span> (pooling == <span class="keyword">true</span>) {</div>
<div class="line"> status = EEPROM_Read_Pool (0x00, &val, 1);</div>
<div class="line"> } <span class="keywordflow">else</span> {</div>
<div class="line"> status = EEPROM_Read_Event (0x00, &val, 1);</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span> (status);</div>
<div class="line">}</div>
</div><!-- fragment --><p>The following example code shows the usage of the I<sup>2</sup>C interface in Slave mode.</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include "<a class="code" href="Driver__I2C_8h.html">Driver_I2C.h</a>"</span></div>
<div class="line"> </div>
<div class="line"><span class="comment">/* I2C driver instance */</span></div>
<div class="line"><span class="keyword">extern</span> <a class="code" href="group__i2c__interface__gr.html#structARM__DRIVER__I2C">ARM_DRIVER_I2C</a> Driver_I2C0; </div>
<div class="line"><span class="keyword">static</span> <a class="code" href="group__i2c__interface__gr.html#structARM__DRIVER__I2C">ARM_DRIVER_I2C</a> *I2Cdrv = &Driver_I2C0;</div>
<div class="line"> </div>
<div class="line"><span class="keyword">static</span> <span class="keyword">volatile</span> uint32_t I2C_Event;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* I2C Signal Event function callback */</span></div>
<div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> I2C_SignalEvent (uint32_t event) {</div>
<div class="line"> I2C_Event |= event;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
<div class="line"> uint8_t cnt = 0;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Initialize I2C peripheral */</span></div>
<div class="line"> I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#ab0480980f67e0ebe0461ccea7873a65b">Initialize</a>(I2C_SignalEvent);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Power-on I2C peripheral */</span></div>
<div class="line"> I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a>(<a class="code" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a>);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Configure I2C bus */</span></div>
<div class="line"> I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__i2c__control__codes.html#ga69d130b9f8aa34d6df5334ab67c74307">ARM_I2C_OWN_ADDRESS</a>, 0x78);</div>
<div class="line"> </div>
<div class="line"> I2C_Event = 0;</div>
<div class="line"></div>
<div class="line"> <span class="keywordflow">while</span> (1) {</div>
<div class="line"> <span class="comment">/* Receive chunk */</span></div>
<div class="line"> I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#a12d2689d6e93985e64b9561a8e4e917b">SlaveReceive</a>(&cnt, 1);</div>
<div class="line"> <span class="keywordflow">while</span> ((I2C_Event & ARM_I2C_EVENT_TRANSFER_DONE) == 0);</div>
<div class="line"> <span class="comment">/* Clear transfer done flag */</span></div>
<div class="line"> I2C_Event &= ~ARM_I2C_EVENT_TRANSFER_DONE;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Transmit chunk back */</span></div>
<div class="line"> I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#ae9e3b81b352d4564fd2337fdf0e5488c">SlaveTransmit</a>(&cnt, 1);</div>
<div class="line"> <span class="keywordflow">while</span> ((I2C_Event & ARM_I2C_EVENT_TRANSFER_DONE) == 0);</div>
<div class="line"> <span class="comment">/* Clear transfer done flag */</span></div>
<div class="line"> I2C_Event &= ~ARM_I2C_EVENT_TRANSFER_DONE;</div>
<div class="line"> }</div>
<div class="line">}</div>
</div><!-- fragment --> <hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structARM__DRIVER__I2C" id="structARM__DRIVER__I2C"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_DRIVER_I2C</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Access structure of the I2C Driver. </p>
<p>The functions of the I2C interface are accessed by function pointers exposed by this structure. Refer to <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a> for overview information.</p>
<p>Each instance of an I2C provides such an access structure. The instance is indicated by a postfix in the symbol name of the access structure, for example:</p>
<ul>
<li><b>Driver_I2C0</b> is the name of the access struct of the first instance (no. 0).</li>
<li><b>Driver_I2C1</b> is the name of the access struct of the second instance (no. 1).</li>
</ul>
<p>A configuration setting in the middleware allows connecting the middleware to a specific driver instance <b>Driver_I2C<em>n</em></b>. The default is <span class="XML-Token">0</span>, which connects a middleware to the first instance of a driver. </p>
</div><table class="memberdecls">
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
<tr class="memitem:a8834b281da48583845c044a81566c1b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#a8834b281da48583845c044a81566c1b3">GetVersion</a> )(void)</td></tr>
<tr class="memdesc:a8834b281da48583845c044a81566c1b3"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__i2c__interface__gr.html#ga956bd87590c7fb6e23609a0abfb5412c">ARM_I2C_GetVersion</a> : Get driver version. <a href="#a8834b281da48583845c044a81566c1b3">More...</a><br/></td></tr>
<tr class="separator:a8834b281da48583845c044a81566c1b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5dfa74ca82e0af995d43da61e08c3103"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__i2c__interface__gr.html#structARM__I2C__CAPABILITIES">ARM_I2C_CAPABILITIES</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#a5dfa74ca82e0af995d43da61e08c3103">GetCapabilities</a> )(void)</td></tr>
<tr class="memdesc:a5dfa74ca82e0af995d43da61e08c3103"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__i2c__interface__gr.html#gad20e6731f627aa7b9d6e99a50806122e">ARM_I2C_GetCapabilities</a> : Get driver capabilities. <a href="#a5dfa74ca82e0af995d43da61e08c3103">More...</a><br/></td></tr>
<tr class="separator:a5dfa74ca82e0af995d43da61e08c3103"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab0480980f67e0ebe0461ccea7873a65b"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#ab0480980f67e0ebe0461ccea7873a65b">Initialize</a> )(<a class="el" href="group__i2c__interface__gr.html#ga24277c48248a09b0dd7f12bbe22ce13c">ARM_I2C_SignalEvent_t</a> cb_event)</td></tr>
<tr class="memdesc:ab0480980f67e0ebe0461ccea7873a65b"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__i2c__interface__gr.html#ga79d2f7d01b3a681d1cf0d70ac6692696">ARM_I2C_Initialize</a> : Initialize I2C Interface. <a href="#ab0480980f67e0ebe0461ccea7873a65b">More...</a><br/></td></tr>
<tr class="separator:ab0480980f67e0ebe0461ccea7873a65b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adcf20681a1402869ecb5c6447fada17b"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#adcf20681a1402869ecb5c6447fada17b">Uninitialize</a> )(void)</td></tr>
<tr class="memdesc:adcf20681a1402869ecb5c6447fada17b"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__i2c__interface__gr.html#ga30d8bf600b6b3182a1f867407b3d6e75">ARM_I2C_Uninitialize</a> : De-initialize I2C Interface. <a href="#adcf20681a1402869ecb5c6447fada17b">More...</a><br/></td></tr>
<tr class="separator:adcf20681a1402869ecb5c6447fada17b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba8f1c8019af95ffe19c32403e3240ef"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> )(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:aba8f1c8019af95ffe19c32403e3240ef"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__i2c__interface__gr.html#ga734a69200e063fdbfb5110062afe9329">ARM_I2C_PowerControl</a> : Control I2C Interface Power. <a href="#aba8f1c8019af95ffe19c32403e3240ef">More...</a><br/></td></tr>
<tr class="separator:aba8f1c8019af95ffe19c32403e3240ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9e58f7ea5fd9476e06b45c70b6696b95"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#a9e58f7ea5fd9476e06b45c70b6696b95">MasterTransmit</a> )(uint32_t addr, const uint8_t *data, uint32_t num, bool xfer_pending)</td></tr>
<tr class="memdesc:a9e58f7ea5fd9476e06b45c70b6696b95"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__i2c__interface__gr.html#ga8bf4214580149d5a5d2360f71f0feb94">ARM_I2C_MasterTransmit</a> : Start transmitting data as I2C Master. <a href="#a9e58f7ea5fd9476e06b45c70b6696b95">More...</a><br/></td></tr>
<tr class="separator:a9e58f7ea5fd9476e06b45c70b6696b95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa135ff2f4832d35ceb5d7e248159b981"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#aa135ff2f4832d35ceb5d7e248159b981">MasterReceive</a> )(uint32_t addr, uint8_t *data, uint32_t num, bool xfer_pending)</td></tr>
<tr class="memdesc:aa135ff2f4832d35ceb5d7e248159b981"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__i2c__interface__gr.html#gafa22504bcf88a85584dfe6e0dd270ad5">ARM_I2C_MasterReceive</a> : Start receiving data as I2C Master. <a href="#aa135ff2f4832d35ceb5d7e248159b981">More...</a><br/></td></tr>
<tr class="separator:aa135ff2f4832d35ceb5d7e248159b981"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9e3b81b352d4564fd2337fdf0e5488c"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#ae9e3b81b352d4564fd2337fdf0e5488c">SlaveTransmit</a> )(const uint8_t *data, uint32_t num)</td></tr>
<tr class="memdesc:ae9e3b81b352d4564fd2337fdf0e5488c"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__i2c__interface__gr.html#gafe164f30eba78f066272373b98a62cd4">ARM_I2C_SlaveTransmit</a> : Start transmitting data as I2C Slave. <a href="#ae9e3b81b352d4564fd2337fdf0e5488c">More...</a><br/></td></tr>
<tr class="separator:ae9e3b81b352d4564fd2337fdf0e5488c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a12d2689d6e93985e64b9561a8e4e917b"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#a12d2689d6e93985e64b9561a8e4e917b">SlaveReceive</a> )(uint8_t *data, uint32_t num)</td></tr>
<tr class="memdesc:a12d2689d6e93985e64b9561a8e4e917b"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__i2c__interface__gr.html#gae3c9abccd1d377385d3d4cfe29035164">ARM_I2C_SlaveReceive</a> : Start receiving data as I2C Slave. <a href="#a12d2689d6e93985e64b9561a8e4e917b">More...</a><br/></td></tr>
<tr class="separator:a12d2689d6e93985e64b9561a8e4e917b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad421a9b9b07fd6d3e6537396c2b98788"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#ad421a9b9b07fd6d3e6537396c2b98788">GetDataCount</a> )(void)</td></tr>
<tr class="memdesc:ad421a9b9b07fd6d3e6537396c2b98788"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__i2c__interface__gr.html#ga19db20ad8d7fde84d07f6db4d75f4b7c">ARM_I2C_GetDataCount</a> : Get transferred data count. <a href="#ad421a9b9b07fd6d3e6537396c2b98788">More...</a><br/></td></tr>
<tr class="separator:ad421a9b9b07fd6d3e6537396c2b98788"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e0f47a92f626a971c5197fca6545505"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a> )(uint32_t control, uint32_t arg)</td></tr>
<tr class="memdesc:a6e0f47a92f626a971c5197fca6545505"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc">ARM_I2C_Control</a> : Control I2C Interface. <a href="#a6e0f47a92f626a971c5197fca6545505">More...</a><br/></td></tr>
<tr class="separator:a6e0f47a92f626a971c5197fca6545505"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad4b47653bc47cdb02965dd311e88b96a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__i2c__interface__gr.html#structARM__I2C__STATUS">ARM_I2C_STATUS</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__interface__gr.html#ad4b47653bc47cdb02965dd311e88b96a">GetStatus</a> )(void)</td></tr>
<tr class="memdesc:ad4b47653bc47cdb02965dd311e88b96a"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__i2c__interface__gr.html#gaba4e0f3eb4018e7dafd51b675c465f3e">ARM_I2C_GetStatus</a> : Get I2C status. <a href="#ad4b47653bc47cdb02965dd311e88b96a">More...</a><br/></td></tr>
<tr class="separator:ad4b47653bc47cdb02965dd311e88b96a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h4 class="groupheader">Field Documentation</h4>
<a class="anchor" id="a8834b281da48583845c044a81566c1b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* GetVersion)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__i2c__interface__gr.html#ga956bd87590c7fb6e23609a0abfb5412c">ARM_I2C_GetVersion</a> : Get driver version. </p>
</div>
</div>
<a class="anchor" id="a5dfa74ca82e0af995d43da61e08c3103"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__i2c__interface__gr.html#structARM__I2C__CAPABILITIES">ARM_I2C_CAPABILITIES</a>(* GetCapabilities)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__i2c__interface__gr.html#gad20e6731f627aa7b9d6e99a50806122e">ARM_I2C_GetCapabilities</a> : Get driver capabilities. </p>
</div>
</div>
<a class="anchor" id="ab0480980f67e0ebe0461ccea7873a65b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Initialize)(<a class="el" href="group__i2c__interface__gr.html#ga24277c48248a09b0dd7f12bbe22ce13c">ARM_I2C_SignalEvent_t</a> cb_event)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__i2c__interface__gr.html#ga79d2f7d01b3a681d1cf0d70ac6692696">ARM_I2C_Initialize</a> : Initialize I2C Interface. </p>
</div>
</div>
<a class="anchor" id="adcf20681a1402869ecb5c6447fada17b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Uninitialize)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__i2c__interface__gr.html#ga30d8bf600b6b3182a1f867407b3d6e75">ARM_I2C_Uninitialize</a> : De-initialize I2C Interface. </p>
</div>
</div>
<a class="anchor" id="aba8f1c8019af95ffe19c32403e3240ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* PowerControl)(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__i2c__interface__gr.html#ga734a69200e063fdbfb5110062afe9329">ARM_I2C_PowerControl</a> : Control I2C Interface Power. </p>
</div>
</div>
<a class="anchor" id="a9e58f7ea5fd9476e06b45c70b6696b95"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* MasterTransmit)(uint32_t addr, const uint8_t *data, uint32_t num, bool xfer_pending)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__i2c__interface__gr.html#ga8bf4214580149d5a5d2360f71f0feb94">ARM_I2C_MasterTransmit</a> : Start transmitting data as I2C Master. </p>
</div>
</div>
<a class="anchor" id="aa135ff2f4832d35ceb5d7e248159b981"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* MasterReceive)(uint32_t addr, uint8_t *data, uint32_t num, bool xfer_pending)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__i2c__interface__gr.html#gafa22504bcf88a85584dfe6e0dd270ad5">ARM_I2C_MasterReceive</a> : Start receiving data as I2C Master. </p>
</div>
</div>
<a class="anchor" id="ae9e3b81b352d4564fd2337fdf0e5488c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SlaveTransmit)(const uint8_t *data, uint32_t num)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__i2c__interface__gr.html#gafe164f30eba78f066272373b98a62cd4">ARM_I2C_SlaveTransmit</a> : Start transmitting data as I2C Slave. </p>
</div>
</div>
<a class="anchor" id="a12d2689d6e93985e64b9561a8e4e917b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SlaveReceive)(uint8_t *data, uint32_t num)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__i2c__interface__gr.html#gae3c9abccd1d377385d3d4cfe29035164">ARM_I2C_SlaveReceive</a> : Start receiving data as I2C Slave. </p>
</div>
</div>
<a class="anchor" id="ad421a9b9b07fd6d3e6537396c2b98788"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* GetDataCount)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__i2c__interface__gr.html#ga19db20ad8d7fde84d07f6db4d75f4b7c">ARM_I2C_GetDataCount</a> : Get transferred data count. </p>
</div>
</div>
<a class="anchor" id="a6e0f47a92f626a971c5197fca6545505"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Control)(uint32_t control, uint32_t arg)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc">ARM_I2C_Control</a> : Control I2C Interface. </p>
</div>
</div>
<a class="anchor" id="ad4b47653bc47cdb02965dd311e88b96a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__i2c__interface__gr.html#structARM__I2C__STATUS">ARM_I2C_STATUS</a>(* GetStatus)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__i2c__interface__gr.html#gaba4e0f3eb4018e7dafd51b675c465f3e">ARM_I2C_GetStatus</a> : Get I2C status. </p>
</div>
</div>
</div>
</div>
<a name="structARM__I2C__CAPABILITIES" id="structARM__I2C__CAPABILITIES"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_I2C_CAPABILITIES</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>I2C Driver Capabilities. </p>
<p>An I2C driver can be implemented with different capabilities. The data fields of this struct encode the capabilities implemented by this driver.</p>
<p>The element <em>address_10_bit</em> indicates that the driver is able to handle 10-bit addressing natively. User can still emulate the 10-bit addressing in software if the driver does not support it.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__i2c__interface__gr.html#gad20e6731f627aa7b9d6e99a50806122e">ARM_I2C_GetCapabilities</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a4ffaaf168a9f43e98d710abff5861ed5"></a>uint32_t</td>
<td class="fieldname">
address_10_bit: 1</td>
<td class="fielddoc">
supports 10-bit addressing </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 31</td>
<td class="fielddoc">
Reserved (must be zero) </td></tr>
</table>
</div>
</div>
<a name="structARM__I2C__STATUS" id="structARM__I2C__STATUS"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_I2C_STATUS</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>I2C Status. </p>
<p>Structure with information about the status of the I2C.</p>
<p>The flag <em>busy</em> indicates that the driver is busy executing Master/Slave Transmit/Receive operation.</p>
<p>It is set:</p>
<ul>
<li>when Master operation starts: after calling <a class="el" href="group__i2c__interface__gr.html#ga8bf4214580149d5a5d2360f71f0feb94">ARM_I2C_MasterTransmit</a> or <a class="el" href="group__i2c__interface__gr.html#gafa22504bcf88a85584dfe6e0dd270ad5">ARM_I2C_MasterReceive</a></li>
<li>when Slave operation starts: after calling <a class="el" href="group__i2c__interface__gr.html#gafe164f30eba78f066272373b98a62cd4">ARM_I2C_SlaveTransmit</a> or <a class="el" href="group__i2c__interface__gr.html#gae3c9abccd1d377385d3d4cfe29035164">ARM_I2C_SlaveReceive</a> and after being addressed by a Master as the Slave</li>
</ul>
<p>It is cleared when Master/Slave operation has finished.</p>
<p>The flag <em>mode</em> indicates the current mode which is Master when Master Transmit/Receive is active or Slave otherwise.</p>
<p>The flag <em>direction</em> indicates either Transmitter or Receiver mode. It is updated during Master/Slave operation when the Slave is addressed by a Master.</p>
<p>The flag <em>general_call</em> indicates a General call (address <span class="XML-Token">0</span>) when in Slave mode.</p>
<p>The flag <em>arbitration_lost</em> indicates that the Master has lost arbitration. The current Master operation is aborted.</p>
<p>The flag <em>bus_error</em> indicates that a bus error has been detected. The current Master/Slave operation is aborted.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__i2c__interface__gr.html#gaba4e0f3eb4018e7dafd51b675c465f3e">ARM_I2C_GetStatus</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a50c88f3c1d787773e2ac1b59533f034a"></a>uint32_t</td>
<td class="fieldname">
busy: 1</td>
<td class="fielddoc">
Busy flag. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a6b29e4f37f4482274af785ad5ffe96a7"></a>uint32_t</td>
<td class="fieldname">
mode: 1</td>
<td class="fielddoc">
Mode: 0=Slave, 1=Master. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a2148ffb99828aeaced6a5655502434ac"></a>uint32_t</td>
<td class="fieldname">
direction: 1</td>
<td class="fielddoc">
Direction: 0=Transmitter, 1=Receiver. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ab65804439f6f5beda8da30381b0ad22d"></a>uint32_t</td>
<td class="fieldname">
general_call: 1</td>
<td class="fielddoc">
General Call indication (cleared on start of next Slave operation) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ab3e3c8eeeae7fbe3c51dcb3d4104af24"></a>uint32_t</td>
<td class="fieldname">
arbitration_lost: 1</td>
<td class="fielddoc">
Master lost arbitration (cleared on start of next Master operation) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a43b1d210c48f4361c5054ba69bcae702"></a>uint32_t</td>
<td class="fieldname">
bus_error: 1</td>
<td class="fielddoc">
Bus error detected (cleared on start of next Master/Slave operation) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 26</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga24277c48248a09b0dd7f12bbe22ce13c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ARM_I2C_SignalEvent_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__i2c__interface__gr.html#gad4f93d2895794b416dc8d8e9de91c05e">ARM_I2C_SignalEvent</a> : Signal I2C Event. </p>
<p>Provides the typedef for the callback function <a class="el" href="group__i2c__interface__gr.html#gad4f93d2895794b416dc8d8e9de91c05e">ARM_I2C_SignalEvent</a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__i2c__interface__gr.html#ga79d2f7d01b3a681d1cf0d70ac6692696">ARM_I2C_Initialize</a> </li>
</ul>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga956bd87590c7fb6e23609a0abfb5412c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> ARM_I2C_GetVersion </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get driver version. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></dd></dl>
<p>The function <b>ARM_I2C_GetVersion</b> returns version information of the driver implementation in <a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></p>
<ul>
<li>API version is the version of the CMSIS-Driver specification used to implement this driver.</li>
<li>Driver version is source code version of the actual driver implementation.</li>
</ul>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__i2c__interface__gr.html#structARM__DRIVER__I2C">ARM_DRIVER_I2C</a> Driver_I2C0;</div>
<div class="line"><a class="code" href="group__i2c__interface__gr.html#structARM__DRIVER__I2C">ARM_DRIVER_I2C</a> *drv_info;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> setup_i2c (<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> version;</div>
<div class="line"> </div>
<div class="line"> drv_info = &Driver_I2C0; </div>
<div class="line"> version = drv_info-><a class="code" href="group__i2c__interface__gr.html#a8834b281da48583845c044a81566c1b3">GetVersion</a> ();</div>
<div class="line"> <span class="keywordflow">if</span> (version.<a class="code" href="group__common__drv__gr.html#ad180da20fbde1d3dafc074af87c19540">api</a> < 0x10A) { <span class="comment">// requires at minimum API version 1.10 or higher</span></div>
<div class="line"> <span class="comment">// error handling</span></div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="gad20e6731f627aa7b9d6e99a50806122e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__i2c__interface__gr.html#structARM__I2C__CAPABILITIES">ARM_I2C_CAPABILITIES</a> ARM_I2C_GetCapabilities </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get driver capabilities. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__i2c__interface__gr.html#structARM__I2C__CAPABILITIES">ARM_I2C_CAPABILITIES</a></dd></dl>
<p>The function <b>ARM_I2C_GetCapabilities</b> returns information about capabilities of this driver implementation. The data fields of the struct <a class="el" href="group__i2c__interface__gr.html#structARM__I2C__CAPABILITIES">ARM_I2C_CAPABILITIES</a> encodes the driver capabilities.</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__i2c__interface__gr.html#structARM__DRIVER__I2C">ARM_DRIVER_I2C</a> Driver_I2C0;</div>
<div class="line"><a class="code" href="group__i2c__interface__gr.html#structARM__DRIVER__I2C">ARM_DRIVER_I2C</a> *drv_info;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> read_capabilities (<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__i2c__interface__gr.html#structARM__I2C__CAPABILITIES">ARM_I2C_CAPABILITIES</a> drv_capabilities;</div>
<div class="line"> </div>
<div class="line"> drv_info = &Driver_I2C0; </div>
<div class="line"> drv_capabilities = drv_info-><a class="code" href="group__i2c__interface__gr.html#a5dfa74ca82e0af995d43da61e08c3103">GetCapabilities</a> ();</div>
<div class="line"> <span class="comment">// interrogate capabilities</span></div>
<div class="line"> </div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga79d2f7d01b3a681d1cf0d70ac6692696"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_I2C_Initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__i2c__interface__gr.html#ga24277c48248a09b0dd7f12bbe22ce13c">ARM_I2C_SignalEvent_t</a> </td>
<td class="paramname"><em>cb_event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize I2C Interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cb_event</td><td>Pointer to <a class="el" href="group__i2c__interface__gr.html#gad4f93d2895794b416dc8d8e9de91c05e">ARM_I2C_SignalEvent</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_I2C_Initialize</b> initializes the I2C interface. It is called when the middleware component starts operation.</p>
<p>The function performs the following operations:</p>
<ul>
<li>Initializes and the I/O resources for the I2C interface.</li>
<li>Registers the <a class="el" href="group__i2c__interface__gr.html#gad4f93d2895794b416dc8d8e9de91c05e">ARM_I2C_SignalEvent</a> callback function.</li>
</ul>
<p>The parameter <em>cb_event</em> is a pointer to the <a class="el" href="group__i2c__interface__gr.html#gad4f93d2895794b416dc8d8e9de91c05e">ARM_I2C_SignalEvent</a> callback function. Use a NULL pointer when no callback events are required.</p>
<p>Can be called multiple times. If the peripheral is already initialized the function performs no operation and returns with <a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>. Refer to <a class="el" href="theoryOperation.html#CallSequence">Function Call Sequence</a> for more information.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__i2c__interface__gr.html#ga734a69200e063fdbfb5110062afe9329" title="Control I2C Interface Power. ">ARM_I2C_PowerControl</a> </dd>
<dd>
<a class="el" href="group__i2c__interface__gr.html#ga30d8bf600b6b3182a1f867407b3d6e75" title="De-initialize I2C Interface. ">ARM_I2C_Uninitialize</a></dd></dl>
<p><b>Example:</b> </p>
<ul>
<li>refer to <a class="el" href="group__nand__interface__gr.html#example">Example Code</a> </li>
</ul>
</div>
</div>
<a class="anchor" id="ga30d8bf600b6b3182a1f867407b3d6e75"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_I2C_Uninitialize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>De-initialize I2C Interface. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_I2C_Uninitialize</b> releases the I/O resources of I2C interface.</p>
<p>It is called when the middleware component stops operation and releases the I/O resources used by the I2C interface. Refer to <a class="el" href="theoryOperation.html#CallSequence">Function Call Sequence</a> for more information.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__i2c__interface__gr.html#ga79d2f7d01b3a681d1cf0d70ac6692696" title="Initialize I2C Interface. ">ARM_I2C_Initialize</a> </dd>
<dd>
<a class="el" href="group__i2c__interface__gr.html#ga734a69200e063fdbfb5110062afe9329" title="Control I2C Interface Power. ">ARM_I2C_PowerControl</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga734a69200e063fdbfb5110062afe9329"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_I2C_PowerControl </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> </td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control I2C Interface Power. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>Power state </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_I2C_PowerControl</b> operates the power modes of the I2C interface.</p>
<p>The parameter <em>state</em> can have the following values:</p>
<ul>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a> : set-up peripheral for data transfers, enable interrupts (NVIC) and optionally DMA. Can be called multiple times. If the peripheral is already in this mode, then the function performs no operation and returns with <a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>.</li>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5a9ef9e57cbcc948d0e22314e73dc8c434">ARM_POWER_LOW</a> : may use power saving. Returns <a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> when not implemented.</li>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35">ARM_POWER_OFF</a> : terminates any pending data transfers, disables peripheral, disables related interrupts and DMA.</li>
</ul>
<p>Refer to <a class="el" href="theoryOperation.html#CallSequence">Function Call Sequence</a> for more information.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__i2c__interface__gr.html#ga79d2f7d01b3a681d1cf0d70ac6692696" title="Initialize I2C Interface. ">ARM_I2C_Initialize</a> </dd>
<dd>
<a class="el" href="group__i2c__interface__gr.html#ga30d8bf600b6b3182a1f867407b3d6e75" title="De-initialize I2C Interface. ">ARM_I2C_Uninitialize</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga8bf4214580149d5a5d2360f71f0feb94"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_I2C_MasterTransmit </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>xfer_pending</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start transmitting data as I2C Master. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>Slave address (7-bit or 10-bit) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to buffer with data to transmit to I2C Slave </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Number of data bytes to transmit </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">xfer_pending</td><td>Transfer operation is pending - Stop condition will not be generated </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>This function <b>ARM_I2C_MasterTransmit</b> transmits data as Master to the selected Slave.</p>
<p>The operation consists of:</p>
<ul>
<li>Master generates START condition</li>
<li>Master addresses the Slave as Master Transmitter</li>
<li>Master transmits data to the addressed Slave</li>
<li>Master generates STOP condition (if <em>xfer_pending</em> is "false")</li>
</ul>
<p>The parameter <em>addr</em> is the address of the slave to transmit the data to. The value can be ORed with <a class="el" href="group__i2c__address__flags.html#ga16be1861b90774bf062feab2dbb829a4">ARM_I2C_ADDRESS_10BIT</a> to identify a 10-bit address value. <br/>
The parameter <em>data</em> and <em>num</em> specify the address of a data buffer and the number of bytes to transmit. <br/>
Set the parameter <em>xfer_pending</em> to 'true' if another transfer operation follows. With <em>xfer_pending</em> set to 'false' a STOP condition is generated.</p>
<p>The function is non-blocking and returns as soon as the driver has started the operation. During the operation it is not allowed to call any Master function again. Also the data buffer must stay allocated and the contents of data must not be modified. When transmit operation has finished the <a class="el" href="group__I2C__events.html#ga5992dc0f6e839c4d066cfa83d535f30d">ARM_I2C_EVENT_TRANSFER_DONE</a> event is generated. When not all the data is transferred then the <a class="el" href="group__I2C__events.html#gafac3989c7b57727e1bed4ee9f2496ac9">ARM_I2C_EVENT_TRANSFER_INCOMPLETE</a> flag is set at the same time.</p>
<p>Number of data bytes transmitted and acknowledged is returned by the function <a class="el" href="group__i2c__interface__gr.html#ga19db20ad8d7fde84d07f6db4d75f4b7c">ARM_I2C_GetDataCount</a> during and after the operation has finished.</p>
<p>The operation is aborted in the following cases (<a class="el" href="group__I2C__events.html#ga5992dc0f6e839c4d066cfa83d535f30d">ARM_I2C_EVENT_TRANSFER_DONE</a> event is generated together with):</p>
<ul>
<li>selected slave has not acknowledged the address: <a class="el" href="group__I2C__events.html#ga98b815769634d9578526b43589caa017">ARM_I2C_EVENT_ADDRESS_NACK</a> event</li>
<li>arbitration has been lost: <a class="el" href="group__I2C__events.html#gac9000f44a578e2117d64dbc2093cec6d">ARM_I2C_EVENT_ARBITRATION_LOST</a> event</li>
<li>bus error has been detected: <a class="el" href="group__I2C__events.html#gaeef542840355131c18b53fd9ed1904a8">ARM_I2C_EVENT_BUS_ERROR</a> event</li>
</ul>
<p>Status can be monitored by calling the <a class="el" href="group__i2c__interface__gr.html#gaba4e0f3eb4018e7dafd51b675c465f3e">ARM_I2C_GetStatus</a> and checking the flags.</p>
<p>Transmit operation can be aborted also by calling <a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc">ARM_I2C_Control</a> with the parameter <em>control</em> <a class="el" href="group__i2c__control__codes.html#ga661e91aaa642d10ba80e3cc72f263040">ARM_I2C_ABORT_TRANSFER</a>. </p>
</div>
</div>
<a class="anchor" id="gafa22504bcf88a85584dfe6e0dd270ad5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_I2C_MasterReceive </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>xfer_pending</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start receiving data as I2C Master. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>Slave address (7-bit or 10-bit) </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Pointer to buffer for data to receive from I2C Slave </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Number of data bytes to receive </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">xfer_pending</td><td>Transfer operation is pending - Stop condition will not be generated </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>This function <b>ARM_I2C_MasterReceive</b> is used to receive data as Master from the selected Slave.</p>
<p>The operation consists of:</p>
<ul>
<li>Master generates START condition</li>
<li>Master addresses the Slave as Master Receiver</li>
<li>Master receives data from the addressed Slave</li>
<li>Master generates STOP condition (if <em>xfer_pending</em> is "false")</li>
</ul>
<p>The parameter <em>addr</em> is the address of the slave to receive the data from. The value can be ORed with <a class="el" href="group__i2c__address__flags.html#ga16be1861b90774bf062feab2dbb829a4">ARM_I2C_ADDRESS_10BIT</a> to identify a 10-bit address value. <br/>
The parameter <em>data</em> and <em>num</em> specify the address of a data buffer and the number of bytes to receive. <br/>
Set the parameter <em>xfer_pending</em> to 'true' if another transfer operation follows. With <em>xfer_pending</em> set to 'false' a STOP condition is generated.</p>
<p>The function is non-blocking and returns as soon as the driver has started the operation. During the operation it is not allowed to call any Master function again. Also the data buffer must stay allocated. When receive operation has finished the <a class="el" href="group__I2C__events.html#ga5992dc0f6e839c4d066cfa83d535f30d">ARM_I2C_EVENT_TRANSFER_DONE</a> event is generated. When not all the data is transferred then the <a class="el" href="group__I2C__events.html#gafac3989c7b57727e1bed4ee9f2496ac9">ARM_I2C_EVENT_TRANSFER_INCOMPLETE</a> flag is set at the same time.</p>
<p>Number of data bytes received is returned by the function <a class="el" href="group__i2c__interface__gr.html#ga19db20ad8d7fde84d07f6db4d75f4b7c">ARM_I2C_GetDataCount</a> during and after the operation has finished.</p>
<p>The operation is aborted in the following cases (<a class="el" href="group__I2C__events.html#ga5992dc0f6e839c4d066cfa83d535f30d">ARM_I2C_EVENT_TRANSFER_DONE</a> event is generated together with):</p>
<ul>
<li>selected slave has not acknowledged the address: <a class="el" href="group__I2C__events.html#ga98b815769634d9578526b43589caa017">ARM_I2C_EVENT_ADDRESS_NACK</a> event</li>
<li>arbitration has been lost: <a class="el" href="group__I2C__events.html#gac9000f44a578e2117d64dbc2093cec6d">ARM_I2C_EVENT_ARBITRATION_LOST</a> event</li>
<li>bus error has been detected: <a class="el" href="group__I2C__events.html#gaeef542840355131c18b53fd9ed1904a8">ARM_I2C_EVENT_BUS_ERROR</a> event</li>
</ul>
<p>Status can be monitored by calling the <a class="el" href="group__i2c__interface__gr.html#gaba4e0f3eb4018e7dafd51b675c465f3e">ARM_I2C_GetStatus</a> and checking the flags.</p>
<p>Receive operation can be aborted also by calling <a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc">ARM_I2C_Control</a> with the parameter <em>control</em> = <a class="el" href="group__i2c__control__codes.html#ga661e91aaa642d10ba80e3cc72f263040">ARM_I2C_ABORT_TRANSFER</a>. </p>
</div>
</div>
<a class="anchor" id="gafe164f30eba78f066272373b98a62cd4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_I2C_SlaveTransmit </td>
<td>(</td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>num</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start transmitting data as I2C Slave. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to buffer with data to transmit to I2C Master </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Number of data bytes to transmit </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>This function <b>ARM_I2C_SlaveTransmit</b> is used to transmit data as Slave to the Master.</p>
<p>The parameter <em>data</em> is a pointer to the data to transmit. <br/>
The parameter <em>num</em> specifies the number of bytes to transmit.</p>
<p>The function is non-blocking and returns as soon as the driver has registered the operation. The actual operation will start after being addressed by the master as a Slave Transmitter. If the operation has not been registered at that point the <a class="el" href="group__I2C__events.html#gacfbbec9af083d35e8ea87ad16e9c6ec2">ARM_I2C_EVENT_SLAVE_TRANSMIT</a> event is generated. The same event is also generated if the operation has finished (specified number of bytes transmitted) but more data is requested by the master.</p>
<p>It is not allowed to call this function again if the operation has started until it finishes. Also the data buffer must stay allocated and the contents of data must not be modified. When transmit operation has finished the <a class="el" href="group__I2C__events.html#ga5992dc0f6e839c4d066cfa83d535f30d">ARM_I2C_EVENT_TRANSFER_DONE</a> event is generated. When not all the data is transferred then the <a class="el" href="group__I2C__events.html#gafac3989c7b57727e1bed4ee9f2496ac9">ARM_I2C_EVENT_TRANSFER_INCOMPLETE</a> flag is set at the same time.</p>
<p>Number of data bytes transmitted is returned by the function <a class="el" href="group__i2c__interface__gr.html#ga19db20ad8d7fde84d07f6db4d75f4b7c">ARM_I2C_GetDataCount</a> during and after the operation has finished.</p>
<p>In case that a General call has been detected the <a class="el" href="group__I2C__events.html#ga3ab54410b6410ed3a58762ff0c0d68b9">ARM_I2C_EVENT_GENERAL_CALL</a> flag is indicated together with the <a class="el" href="group__I2C__events.html#ga5992dc0f6e839c4d066cfa83d535f30d">ARM_I2C_EVENT_TRANSFER_DONE</a> event (also with <a class="el" href="group__I2C__events.html#gacfbbec9af083d35e8ea87ad16e9c6ec2">ARM_I2C_EVENT_SLAVE_TRANSMIT</a> event).</p>
<p>In case that bus error has been detected then the operation is aborted and the <a class="el" href="group__I2C__events.html#gaeef542840355131c18b53fd9ed1904a8">ARM_I2C_EVENT_BUS_ERROR</a> event is generated together with <a class="el" href="group__I2C__events.html#ga5992dc0f6e839c4d066cfa83d535f30d">ARM_I2C_EVENT_TRANSFER_DONE</a>.</p>
<p>Slave will only respond to its own address (or General call if enabled) that is specified by calling <a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc">ARM_I2C_Control</a> with <a class="el" href="group__i2c__control__codes.html#ga69d130b9f8aa34d6df5334ab67c74307">ARM_I2C_OWN_ADDRESS</a> as control parameter. Using address <span class="XML-Token">0</span> disables the slave.</p>
<p>Status can be monitored by calling the <a class="el" href="group__i2c__interface__gr.html#gaba4e0f3eb4018e7dafd51b675c465f3e">ARM_I2C_GetStatus</a> and checking the flags.</p>
<p>Transmit operation can be canceled or aborted by calling <a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc">ARM_I2C_Control</a> with the parameter <em>control</em> = <a class="el" href="group__i2c__control__codes.html#ga661e91aaa642d10ba80e3cc72f263040">ARM_I2C_ABORT_TRANSFER</a>. </p>
</div>
</div>
<a class="anchor" id="gae3c9abccd1d377385d3d4cfe29035164"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_I2C_SlaveReceive </td>
<td>(</td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>num</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start receiving data as I2C Slave. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Pointer to buffer for data to receive from I2C Master </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Number of data bytes to receive </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>This function <b>ARM_I2C_SlaveReceive</b> receives data as Slave from the Master.</p>
<p>The parameter <em>data</em> is a pointer to the data to receive. <br/>
The parameter <em>num</em> specifies the number of bytes to receive.</p>
<p>The function is non-blocking and returns as soon as the driver has registered the operation. The actual operation will start after being addressed by the master as a Slave Receiver. If the operation has not been registered at that point the <a class="el" href="group__I2C__events.html#gabd875b57ce39dadd849c53b885ad6661">ARM_I2C_EVENT_SLAVE_RECEIVE</a> event is generated.</p>
<p>It is not allowed to call this function again if the operation has started until it finishes. Also the data buffer must stay allocated. When receive operation has finished the <a class="el" href="group__I2C__events.html#ga5992dc0f6e839c4d066cfa83d535f30d">ARM_I2C_EVENT_TRANSFER_DONE</a> event is generated. When not all the data is transferred then the <a class="el" href="group__I2C__events.html#gafac3989c7b57727e1bed4ee9f2496ac9">ARM_I2C_EVENT_TRANSFER_INCOMPLETE</a> flag is set at the same time.</p>
<p>Number of data bytes received and acknowledged is returned by the function <a class="el" href="group__i2c__interface__gr.html#ga19db20ad8d7fde84d07f6db4d75f4b7c">ARM_I2C_GetDataCount</a> during and after the operation has finished.</p>
<p>In case that a General call has been detected the <a class="el" href="group__I2C__events.html#ga3ab54410b6410ed3a58762ff0c0d68b9">ARM_I2C_EVENT_GENERAL_CALL</a> flag is indicated together with the <a class="el" href="group__I2C__events.html#ga5992dc0f6e839c4d066cfa83d535f30d">ARM_I2C_EVENT_TRANSFER_DONE</a> event (also with <a class="el" href="group__I2C__events.html#gabd875b57ce39dadd849c53b885ad6661">ARM_I2C_EVENT_SLAVE_RECEIVE</a> event).</p>
<p>In case that bus error has been detected then the operation is aborted and the <a class="el" href="group__I2C__events.html#gaeef542840355131c18b53fd9ed1904a8">ARM_I2C_EVENT_BUS_ERROR</a> event is generated together with <a class="el" href="group__I2C__events.html#ga5992dc0f6e839c4d066cfa83d535f30d">ARM_I2C_EVENT_TRANSFER_DONE</a>.</p>
<p>Slave will only respond to its own address (or General call if enabled) that is specified by calling <a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc">ARM_I2C_Control</a> with <a class="el" href="group__i2c__control__codes.html#ga69d130b9f8aa34d6df5334ab67c74307">ARM_I2C_OWN_ADDRESS</a> as control parameter. Using address <span class="XML-Token">0</span> disables the slave.</p>
<p>Status can be monitored by calling the <a class="el" href="group__i2c__interface__gr.html#gaba4e0f3eb4018e7dafd51b675c465f3e">ARM_I2C_GetStatus</a> and checking the flags.</p>
<p>Receive operation can be canceled or aborted by calling <a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc">ARM_I2C_Control</a> with the parameter <em>control</em> = <a class="el" href="group__i2c__control__codes.html#ga661e91aaa642d10ba80e3cc72f263040">ARM_I2C_ABORT_TRANSFER</a>. </p>
</div>
</div>
<a class="anchor" id="ga19db20ad8d7fde84d07f6db4d75f4b7c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_I2C_GetDataCount </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get transferred data count. </p>
<dl class="section return"><dt>Returns</dt><dd>number of data bytes transferred; -1 when Slave is not addressed by Master</dd></dl>
<p>The function <b>ARM_I2C_GetDataCount</b> returns the number of currently transferred data bytes during and after:</p>
<ul>
<li><a class="el" href="group__i2c__interface__gr.html#ga8bf4214580149d5a5d2360f71f0feb94">ARM_I2C_MasterTransmit</a> : number of data bytes transmitted and acknowledged</li>
<li><a class="el" href="group__i2c__interface__gr.html#gafa22504bcf88a85584dfe6e0dd270ad5">ARM_I2C_MasterReceive</a> : number of data bytes received</li>
<li><a class="el" href="group__i2c__interface__gr.html#gafe164f30eba78f066272373b98a62cd4">ARM_I2C_SlaveTransmit</a> : number of data bytes transmitted</li>
<li><a class="el" href="group__i2c__interface__gr.html#gae3c9abccd1d377385d3d4cfe29035164">ARM_I2C_SlaveReceive</a> : number of data bytes received and acknowledged</li>
</ul>
<p>When the Slave is not yet addressed by the Master then <span class="XML-Token">-1</span> is returned. </p>
</div>
</div>
<a class="anchor" id="ga828f5fa289d065675ef78a9a73d129dc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_I2C_Control </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>control</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control I2C Interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">control</td><td>Operation </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">arg</td><td>Argument of operation (optional) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_I2C_Control</b> operates the I2C interface and executes various operations.</p>
<p>The parameter <em>control</em> specifies various operations as listed in the table below. <br/>
The parameter <em>arg</em> provides, depending on the operation, additional information. <br/>
</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>control</em> </th><th align="left">Operation </th></tr>
<tr>
<td align="left"><a class="el" href="group__i2c__control__codes.html#ga69d130b9f8aa34d6df5334ab67c74307">ARM_I2C_OWN_ADDRESS</a> </td><td align="left">Set Own Slave Address; <em>arg</em> = slave address </td></tr>
<tr>
<td align="left"><a class="el" href="group__i2c__control__codes.html#ga35733133237d65146abd9449f5353a7f">ARM_I2C_BUS_SPEED</a> </td><td align="left">Set Bus Speed; <em>arg</em> = bus speed </td></tr>
<tr>
<td align="left"><a class="el" href="group__i2c__control__codes.html#gadacf04578770faca4b3eaae34b2c5f03">ARM_I2C_BUS_CLEAR</a> </td><td align="left">Clear the bus by sending nine clock pulses </td></tr>
<tr>
<td align="left"><a class="el" href="group__i2c__control__codes.html#ga661e91aaa642d10ba80e3cc72f263040">ARM_I2C_ABORT_TRANSFER</a> </td><td align="left">Aborts the data transfer between Master and Slave for Transmit or Receive </td></tr>
</table>
<p><b>Set Own Slave Address</b></p>
<p>After initialization, the I2C Device has no slave address assigned and does not accept any requests from an I2C Master.</p>
<p>The <em>control</em> operation <a class="el" href="group__i2c__control__codes.html#ga69d130b9f8aa34d6df5334ab67c74307">ARM_I2C_OWN_ADDRESS</a> sets the slave address with the parameter <em>arg</em>. The slave address can be ORed with <a class="el" href="group__i2c__address__flags.html#ga16be1861b90774bf062feab2dbb829a4">ARM_I2C_ADDRESS_10BIT</a> to indicate a 10-bit address.</p>
<p>The slave address can be ORed with <a class="el" href="group__i2c__address__flags.html#ga337f4f1aa082e9b593b2dcd43c50134e">ARM_I2C_ADDRESS_GC</a> to indicate that the slave accepts a General Call. If the slave address value is only <a class="el" href="group__i2c__address__flags.html#ga337f4f1aa082e9b593b2dcd43c50134e">ARM_I2C_ADDRESS_GC</a>, then the slave only accepts a General Call.</p>
<p>The slave address value <span class="XML-Token">0</span> disables Slave mode and clears any assigned slave address.</p>
<p>Examples:**</p>
<p>Set the Slave address value <span class="XML-Token">0x45</span> as 7-bit address. </p>
<div class="fragment"><div class="line">I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a> (<a class="code" href="group__i2c__control__codes.html#ga69d130b9f8aa34d6df5334ab67c74307">ARM_I2C_OWN_ADDRESS</a>, 0x45);</div>
</div><!-- fragment --><p>Set the Slave address value <span class="XML-Token">0x135</span> as 10-bit address and accept a General Call. </p>
<div class="fragment"><div class="line">I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a> (<a class="code" href="group__i2c__control__codes.html#ga69d130b9f8aa34d6df5334ab67c74307">ARM_I2C_OWN_ADDRESS</a>, 0x135 | <a class="code" href="group__i2c__address__flags.html#ga16be1861b90774bf062feab2dbb829a4">ARM_I2C_ADDRESS_10BIT</a> | <a class="code" href="group__i2c__address__flags.html#ga337f4f1aa082e9b593b2dcd43c50134e">ARM_I2C_ADDRESS_GC</a>);</div>
</div><!-- fragment --><p><b>Bus Speed</b></p>
<p>The <em>control</em> operation <a class="el" href="group__i2c__control__codes.html#ga35733133237d65146abd9449f5353a7f">ARM_I2C_BUS_SPEED</a> sets the bus speed using the parameter <em>arg</em>.</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>arg</em> </th><th align="left">Bus Speed </th></tr>
<tr>
<td align="left"><a class="el" href="group__i2c__bus__speed__ctrls.html#ga0aaa6398280fdd7ad651d7d6d44c863f">ARM_I2C_BUS_SPEED_STANDARD</a> </td><td align="left">Standard Speed to (<span class="XML-Token">100 kHz</span>) </td></tr>
<tr>
<td align="left"><a class="el" href="group__i2c__bus__speed__ctrls.html#ga39f49ef4cd1100a8d9dc9003329e5ecd">ARM_I2C_BUS_SPEED_FAST</a> </td><td align="left">Fast Speed (<span class="XML-Token">400kHz</span>) </td></tr>
<tr>
<td align="left"><a class="el" href="group__i2c__bus__speed__ctrls.html#ga2615262062e0327ab478ec85675ca649">ARM_I2C_BUS_SPEED_FAST_PLUS</a> </td><td align="left">Fast + Speed (<span class="XML-Token">1MHz</span>) </td></tr>
<tr>
<td align="left"><a class="el" href="group__i2c__bus__speed__ctrls.html#ga10aae5a8c7fcc90e514c5fb7393056ec">ARM_I2C_BUS_SPEED_HIGH</a> </td><td align="left">High Speed (<span class="XML-Token">3.4MHz</span>) </td></tr>
</table>
<p>Example:**</p>
<div class="fragment"><div class="line">I2Cdrv-><a class="code" href="group__i2c__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a> (<a class="code" href="group__i2c__control__codes.html#ga35733133237d65146abd9449f5353a7f">ARM_I2C_BUS_SPEED</a>, I2C_BUS_SPEED_FAST);</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="gaba4e0f3eb4018e7dafd51b675c465f3e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__i2c__interface__gr.html#structARM__I2C__STATUS">ARM_I2C_STATUS</a> ARM_I2C_GetStatus </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get I2C status. </p>
<dl class="section return"><dt>Returns</dt><dd>I2C status <a class="el" href="group__i2c__interface__gr.html#structARM__I2C__STATUS">ARM_I2C_STATUS</a></dd></dl>
<p>The function <b>ARM_I2C_GetStatus</b> returns the current I2C interface status.</p>
<p>Refer to <a class="el" href="group__i2c__interface__gr.html#structARM__I2C__STATUS">ARM_I2C_STATUS</a> for details. </p>
</div>
</div>
<a class="anchor" id="gad4f93d2895794b416dc8d8e9de91c05e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARM_I2C_SignalEvent </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signal I2C Events. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td><a class="el" href="group__I2C__events.html">I2C Events</a> notification mask</td></tr>
</table>
</dd>
</dl>
<p>The function <b>ARM_I2C_SignalEvent</b> is a callback function registered by the function <a class="el" href="group__i2c__interface__gr.html#ga79d2f7d01b3a681d1cf0d70ac6692696">ARM_I2C_Initialize</a>.. It is called by the I2C driver to notify the application about <a class="el" href="group__I2C__events.html">I2C Events</a> occured during operation.</p>
<p>The parameter <em>event</em> indicates one or more events that occurred during driver operation. Each event is encoded in a separate bit and therefore it is possible to signal multiple events within the same call.</p>
<p>The following events can be generated:</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>event</em> </th><th align="center">Bit </th><th align="left">Description </th></tr>
<tr>
<td align="left"><a class="el" href="group__I2C__events.html#ga5992dc0f6e839c4d066cfa83d535f30d">ARM_I2C_EVENT_TRANSFER_DONE</a> </td><td align="center">1UL << 0 </td><td align="left">Occurs after Master/Slave Transmit/Receive operation has finished. </td></tr>
<tr>
<td align="left"><a class="el" href="group__I2C__events.html#gafac3989c7b57727e1bed4ee9f2496ac9">ARM_I2C_EVENT_TRANSFER_INCOMPLETE</a> </td><td align="center">1UL << 1 </td><td align="left">Occurs together with <a class="el" href="group__I2C__events.html#ga5992dc0f6e839c4d066cfa83d535f30d">ARM_I2C_EVENT_TRANSFER_DONE</a> when less data is transferred then requested. </td></tr>
<tr>
<td align="left"><a class="el" href="group__I2C__events.html#gacfbbec9af083d35e8ea87ad16e9c6ec2">ARM_I2C_EVENT_SLAVE_TRANSMIT</a> </td><td align="center">1UL << 2 </td><td align="left">Occurs when addressed as Slave Transmitter and <a class="el" href="group__i2c__interface__gr.html#gafe164f30eba78f066272373b98a62cd4">ARM_I2C_SlaveTransmit</a> has not been started. </td></tr>
<tr>
<td align="left"><a class="el" href="group__I2C__events.html#gabd875b57ce39dadd849c53b885ad6661">ARM_I2C_EVENT_SLAVE_RECEIVE</a> </td><td align="center">1UL << 3 </td><td align="left">Occurs when addressed as Slave Receiver and <a class="el" href="group__i2c__interface__gr.html#gae3c9abccd1d377385d3d4cfe29035164">ARM_I2C_SlaveReceive</a> has not been started. </td></tr>
<tr>
<td align="left"><a class="el" href="group__I2C__events.html#ga98b815769634d9578526b43589caa017">ARM_I2C_EVENT_ADDRESS_NACK</a> </td><td align="center">1UL << 4 </td><td align="left">Occurs in master mode when address is not acknowledged from slave. </td></tr>
<tr>
<td align="left"><a class="el" href="group__I2C__events.html#ga3ab54410b6410ed3a58762ff0c0d68b9">ARM_I2C_EVENT_GENERAL_CALL</a> </td><td align="center">1UL << 5 </td><td align="left">Indicates General Call in slave mode together with <a class="el" href="group__I2C__events.html#ga5992dc0f6e839c4d066cfa83d535f30d">ARM_I2C_EVENT_TRANSFER_DONE</a>, <a class="el" href="group__I2C__events.html#gacfbbec9af083d35e8ea87ad16e9c6ec2">ARM_I2C_EVENT_SLAVE_TRANSMIT</a> and <a class="el" href="group__I2C__events.html#gabd875b57ce39dadd849c53b885ad6661">ARM_I2C_EVENT_SLAVE_RECEIVE</a>. </td></tr>
<tr>
<td align="left"><a class="el" href="group__I2C__events.html#gac9000f44a578e2117d64dbc2093cec6d">ARM_I2C_EVENT_ARBITRATION_LOST</a> </td><td align="center">1UL << 6 </td><td align="left">Occurs in master mode when arbitration is lost. </td></tr>
<tr>
<td align="left"><a class="el" href="group__I2C__events.html#gaeef542840355131c18b53fd9ed1904a8">ARM_I2C_EVENT_BUS_ERROR</a> </td><td align="center">1UL << 7 </td><td align="left">Occurs when bus error is detected. </td></tr>
<tr>
<td align="left"><a class="el" href="group__I2C__events.html#ga81ca21fad73dac1ffaff58921f848ea9">ARM_I2C_EVENT_BUS_CLEAR</a> </td><td align="center">1UL << 8 </td><td align="left">Occurs after <a class="el" href="group__i2c__control__codes.html#gadacf04578770faca4b3eaae34b2c5f03">ARM_I2C_BUS_CLEAR</a> Control operation has finished. </td></tr>
</table>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__i2c__interface__gr.html | HTML | apache-2.0 | 105,194 |
var group__i2c__interface__gr =
[
[ "I2C Events", "group__I2C__events.html", "group__I2C__events" ],
[ "I2C Control Codes", "group__i2c__control__gr.html", "group__i2c__control__gr" ],
[ "I2C Address Flags", "group__i2c__address__flags.html", "group__i2c__address__flags" ],
[ "ARM_DRIVER_I2C", "group__i2c__interface__gr.html#structARM__DRIVER__I2C", [
[ "GetVersion", "group__i2c__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__i2c__interface__gr.html#a5dfa74ca82e0af995d43da61e08c3103", null ],
[ "Initialize", "group__i2c__interface__gr.html#ab0480980f67e0ebe0461ccea7873a65b", null ],
[ "Uninitialize", "group__i2c__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__i2c__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "MasterTransmit", "group__i2c__interface__gr.html#a9e58f7ea5fd9476e06b45c70b6696b95", null ],
[ "MasterReceive", "group__i2c__interface__gr.html#aa135ff2f4832d35ceb5d7e248159b981", null ],
[ "SlaveTransmit", "group__i2c__interface__gr.html#ae9e3b81b352d4564fd2337fdf0e5488c", null ],
[ "SlaveReceive", "group__i2c__interface__gr.html#a12d2689d6e93985e64b9561a8e4e917b", null ],
[ "GetDataCount", "group__i2c__interface__gr.html#ad421a9b9b07fd6d3e6537396c2b98788", null ],
[ "Control", "group__i2c__interface__gr.html#a6e0f47a92f626a971c5197fca6545505", null ],
[ "GetStatus", "group__i2c__interface__gr.html#ad4b47653bc47cdb02965dd311e88b96a", null ]
] ],
[ "ARM_I2C_CAPABILITIES", "group__i2c__interface__gr.html#structARM__I2C__CAPABILITIES", [
[ "address_10_bit", "group__i2c__interface__gr.html#a4ffaaf168a9f43e98d710abff5861ed5", null ],
[ "reserved", "group__i2c__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_I2C_STATUS", "group__i2c__interface__gr.html#structARM__I2C__STATUS", [
[ "busy", "group__i2c__interface__gr.html#a50c88f3c1d787773e2ac1b59533f034a", null ],
[ "mode", "group__i2c__interface__gr.html#a6b29e4f37f4482274af785ad5ffe96a7", null ],
[ "direction", "group__i2c__interface__gr.html#a2148ffb99828aeaced6a5655502434ac", null ],
[ "general_call", "group__i2c__interface__gr.html#ab65804439f6f5beda8da30381b0ad22d", null ],
[ "arbitration_lost", "group__i2c__interface__gr.html#ab3e3c8eeeae7fbe3c51dcb3d4104af24", null ],
[ "bus_error", "group__i2c__interface__gr.html#a43b1d210c48f4361c5054ba69bcae702", null ],
[ "reserved", "group__i2c__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_I2C_SignalEvent_t", "group__i2c__interface__gr.html#ga24277c48248a09b0dd7f12bbe22ce13c", null ],
[ "ARM_I2C_GetVersion", "group__i2c__interface__gr.html#ga956bd87590c7fb6e23609a0abfb5412c", null ],
[ "ARM_I2C_GetCapabilities", "group__i2c__interface__gr.html#gad20e6731f627aa7b9d6e99a50806122e", null ],
[ "ARM_I2C_Initialize", "group__i2c__interface__gr.html#ga79d2f7d01b3a681d1cf0d70ac6692696", null ],
[ "ARM_I2C_Uninitialize", "group__i2c__interface__gr.html#ga30d8bf600b6b3182a1f867407b3d6e75", null ],
[ "ARM_I2C_PowerControl", "group__i2c__interface__gr.html#ga734a69200e063fdbfb5110062afe9329", null ],
[ "ARM_I2C_MasterTransmit", "group__i2c__interface__gr.html#ga8bf4214580149d5a5d2360f71f0feb94", null ],
[ "ARM_I2C_MasterReceive", "group__i2c__interface__gr.html#gafa22504bcf88a85584dfe6e0dd270ad5", null ],
[ "ARM_I2C_SlaveTransmit", "group__i2c__interface__gr.html#gafe164f30eba78f066272373b98a62cd4", null ],
[ "ARM_I2C_SlaveReceive", "group__i2c__interface__gr.html#gae3c9abccd1d377385d3d4cfe29035164", null ],
[ "ARM_I2C_GetDataCount", "group__i2c__interface__gr.html#ga19db20ad8d7fde84d07f6db4d75f4b7c", null ],
[ "ARM_I2C_Control", "group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc", null ],
[ "ARM_I2C_GetStatus", "group__i2c__interface__gr.html#gaba4e0f3eb4018e7dafd51b675c465f3e", null ],
[ "ARM_I2C_SignalEvent", "group__i2c__interface__gr.html#gad4f93d2895794b416dc8d8e9de91c05e", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__i2c__interface__gr.js | JavaScript | apache-2.0 | 4,137 |
var group__i2c__interface__gr_structARM__DRIVER__I2C =
[
[ "GetVersion", "group__i2c__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__i2c__interface__gr.html#a5dfa74ca82e0af995d43da61e08c3103", null ],
[ "Initialize", "group__i2c__interface__gr.html#ab0480980f67e0ebe0461ccea7873a65b", null ],
[ "Uninitialize", "group__i2c__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__i2c__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "MasterTransmit", "group__i2c__interface__gr.html#a9e58f7ea5fd9476e06b45c70b6696b95", null ],
[ "MasterReceive", "group__i2c__interface__gr.html#aa135ff2f4832d35ceb5d7e248159b981", null ],
[ "SlaveTransmit", "group__i2c__interface__gr.html#ae9e3b81b352d4564fd2337fdf0e5488c", null ],
[ "SlaveReceive", "group__i2c__interface__gr.html#a12d2689d6e93985e64b9561a8e4e917b", null ],
[ "GetDataCount", "group__i2c__interface__gr.html#ad421a9b9b07fd6d3e6537396c2b98788", null ],
[ "Control", "group__i2c__interface__gr.html#a6e0f47a92f626a971c5197fca6545505", null ],
[ "GetStatus", "group__i2c__interface__gr.html#ad4b47653bc47cdb02965dd311e88b96a", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__i2c__interface__gr_structARM__DRIVER__I2C.js | JavaScript | apache-2.0 | 1,229 |
var group__i2c__interface__gr_structARM__I2C__CAPABILITIES =
[
[ "address_10_bit", "group__i2c__interface__gr.html#a4ffaaf168a9f43e98d710abff5861ed5", null ],
[ "reserved", "group__i2c__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__i2c__interface__gr_structARM__I2C__CAPABILITIES.js | JavaScript | apache-2.0 | 258 |
var group__i2c__interface__gr_structARM__I2C__STATUS =
[
[ "busy", "group__i2c__interface__gr.html#a50c88f3c1d787773e2ac1b59533f034a", null ],
[ "mode", "group__i2c__interface__gr.html#a6b29e4f37f4482274af785ad5ffe96a7", null ],
[ "direction", "group__i2c__interface__gr.html#a2148ffb99828aeaced6a5655502434ac", null ],
[ "general_call", "group__i2c__interface__gr.html#ab65804439f6f5beda8da30381b0ad22d", null ],
[ "arbitration_lost", "group__i2c__interface__gr.html#ab3e3c8eeeae7fbe3c51dcb3d4104af24", null ],
[ "bus_error", "group__i2c__interface__gr.html#a43b1d210c48f4361c5054ba69bcae702", null ],
[ "reserved", "group__i2c__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__i2c__interface__gr_structARM__I2C__STATUS.js | JavaScript | apache-2.0 | 722 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>MCI Bus Data Width</title>
<title>CMSIS-Driver: MCI Bus Data Width</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__mci__bus__data__width__ctrls.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">MCI Bus Data Width<div class="ingroups"><a class="el" href="group__mci__control__gr.html">MCI Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify the data bus width.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaa09a00d810a4dfd1d1824311ee290585"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__bus__data__width__ctrls.html#gaa09a00d810a4dfd1d1824311ee290585">ARM_MCI_BUS_DATA_WIDTH_1</a>   (0x00)</td></tr>
<tr class="memdesc:gaa09a00d810a4dfd1d1824311ee290585"><td class="mdescLeft"> </td><td class="mdescRight">Bus data width: 1 bit (default) <a href="#gaa09a00d810a4dfd1d1824311ee290585">More...</a><br/></td></tr>
<tr class="separator:gaa09a00d810a4dfd1d1824311ee290585"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa28150d8c3789e8cf1bcda318f74a28c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__bus__data__width__ctrls.html#gaa28150d8c3789e8cf1bcda318f74a28c">ARM_MCI_BUS_DATA_WIDTH_4</a>   (0x01)</td></tr>
<tr class="memdesc:gaa28150d8c3789e8cf1bcda318f74a28c"><td class="mdescLeft"> </td><td class="mdescRight">Bus data width: 4 bits. <a href="#gaa28150d8c3789e8cf1bcda318f74a28c">More...</a><br/></td></tr>
<tr class="separator:gaa28150d8c3789e8cf1bcda318f74a28c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3bb99a2d98ba9fb8c5bc97fa2b8ef469"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__bus__data__width__ctrls.html#ga3bb99a2d98ba9fb8c5bc97fa2b8ef469">ARM_MCI_BUS_DATA_WIDTH_8</a>   (0x02)</td></tr>
<tr class="memdesc:ga3bb99a2d98ba9fb8c5bc97fa2b8ef469"><td class="mdescLeft"> </td><td class="mdescRight">Bus data width: 8 bits. <a href="#ga3bb99a2d98ba9fb8c5bc97fa2b8ef469">More...</a><br/></td></tr>
<tr class="separator:ga3bb99a2d98ba9fb8c5bc97fa2b8ef469"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaccb174bd131f8fd8cd9a56439a8ebb60"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__bus__data__width__ctrls.html#gaccb174bd131f8fd8cd9a56439a8ebb60">ARM_MCI_BUS_DATA_WIDTH_4_DDR</a>   (0x03)</td></tr>
<tr class="memdesc:gaccb174bd131f8fd8cd9a56439a8ebb60"><td class="mdescLeft"> </td><td class="mdescRight">Bus data width: 4 bits, DDR (Dual Data Rate) - MMC only. <a href="#gaccb174bd131f8fd8cd9a56439a8ebb60">More...</a><br/></td></tr>
<tr class="separator:gaccb174bd131f8fd8cd9a56439a8ebb60"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7b31f81ae703229095fe9efcfbe80b47"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__bus__data__width__ctrls.html#ga7b31f81ae703229095fe9efcfbe80b47">ARM_MCI_BUS_DATA_WIDTH_8_DDR</a>   (0x04)</td></tr>
<tr class="memdesc:ga7b31f81ae703229095fe9efcfbe80b47"><td class="mdescLeft"> </td><td class="mdescRight">Bus data width: 8 bits, DDR (Dual Data Rate) - MMC only. <a href="#ga7b31f81ae703229095fe9efcfbe80b47">More...</a><br/></td></tr>
<tr class="separator:ga7b31f81ae703229095fe9efcfbe80b47"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify the data bus width. </p>
<p>The function <a class="el" href="group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30">ARM_MCI_Control</a> with <em>control</em> = <a class="el" href="group__mci__mode__ctrls.html#ga876d964d0eeacdb16e93f7558a544587">ARM_MCI_BUS_DATA_WIDTH</a> specifies with <em>arg</em> the number of data I/O pins on the SD/MMC interface.</p>
<p>For high-speed memory cards, a 4-bit bus data width should be used (or 8-bit for eMMC). The data fields <em>data_width_4</em> and <em>data_width_8</em> of the structure <a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES" title="MCI Driver Capabilities. ">ARM_MCI_CAPABILITIES</a> encode whether the driver supports a specific bus data with.</p>
<p>The following codes are defined: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gaa09a00d810a4dfd1d1824311ee290585"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BUS_DATA_WIDTH_1   (0x00)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Bus data width: 1 bit (default) </p>
</div>
</div>
<a class="anchor" id="gaa28150d8c3789e8cf1bcda318f74a28c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BUS_DATA_WIDTH_4   (0x01)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Bus data width: 4 bits. </p>
</div>
</div>
<a class="anchor" id="ga3bb99a2d98ba9fb8c5bc97fa2b8ef469"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BUS_DATA_WIDTH_8   (0x02)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Bus data width: 8 bits. </p>
</div>
</div>
<a class="anchor" id="gaccb174bd131f8fd8cd9a56439a8ebb60"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BUS_DATA_WIDTH_4_DDR   (0x03)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Bus data width: 4 bits, DDR (Dual Data Rate) - MMC only. </p>
</div>
</div>
<a class="anchor" id="ga7b31f81ae703229095fe9efcfbe80b47"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BUS_DATA_WIDTH_8_DDR   (0x04)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Bus data width: 8 bits, DDR (Dual Data Rate) - MMC only. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__bus__data__width__ctrls.html | HTML | apache-2.0 | 12,667 |
var group__mci__bus__data__width__ctrls =
[
[ "ARM_MCI_BUS_DATA_WIDTH_1", "group__mci__bus__data__width__ctrls.html#gaa09a00d810a4dfd1d1824311ee290585", null ],
[ "ARM_MCI_BUS_DATA_WIDTH_4", "group__mci__bus__data__width__ctrls.html#gaa28150d8c3789e8cf1bcda318f74a28c", null ],
[ "ARM_MCI_BUS_DATA_WIDTH_8", "group__mci__bus__data__width__ctrls.html#ga3bb99a2d98ba9fb8c5bc97fa2b8ef469", null ],
[ "ARM_MCI_BUS_DATA_WIDTH_4_DDR", "group__mci__bus__data__width__ctrls.html#gaccb174bd131f8fd8cd9a56439a8ebb60", null ],
[ "ARM_MCI_BUS_DATA_WIDTH_8_DDR", "group__mci__bus__data__width__ctrls.html#ga7b31f81ae703229095fe9efcfbe80b47", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__bus__data__width__ctrls.js | JavaScript | apache-2.0 | 658 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>MCI Bus Speed Mode</title>
<title>CMSIS-Driver: MCI Bus Speed Mode</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__mci__bus__speed__ctrls.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">MCI Bus Speed Mode<div class="ingroups"><a class="el" href="group__mci__control__gr.html">MCI Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify the bus speed mode.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga601fa8b27ab2e5f6d90c93d54c8f412d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__bus__speed__ctrls.html#ga601fa8b27ab2e5f6d90c93d54c8f412d">ARM_MCI_BUS_DEFAULT_SPEED</a>   (0x00)</td></tr>
<tr class="memdesc:ga601fa8b27ab2e5f6d90c93d54c8f412d"><td class="mdescLeft"> </td><td class="mdescRight">SD/MMC: Default Speed mode up to 25/26MHz. <a href="#ga601fa8b27ab2e5f6d90c93d54c8f412d">More...</a><br/></td></tr>
<tr class="separator:ga601fa8b27ab2e5f6d90c93d54c8f412d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaabda746ac7d6b4497358ff655a8ea6be"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__bus__speed__ctrls.html#gaabda746ac7d6b4497358ff655a8ea6be">ARM_MCI_BUS_HIGH_SPEED</a>   (0x01)</td></tr>
<tr class="memdesc:gaabda746ac7d6b4497358ff655a8ea6be"><td class="mdescLeft"> </td><td class="mdescRight">SD/MMC: High Speed mode up to 50/52MHz. <a href="#gaabda746ac7d6b4497358ff655a8ea6be">More...</a><br/></td></tr>
<tr class="separator:gaabda746ac7d6b4497358ff655a8ea6be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0473c44a7b65044b3c6a8e7012009a4a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__bus__speed__ctrls.html#ga0473c44a7b65044b3c6a8e7012009a4a">ARM_MCI_BUS_UHS_SDR12</a>   (0x02)</td></tr>
<tr class="memdesc:ga0473c44a7b65044b3c6a8e7012009a4a"><td class="mdescLeft"> </td><td class="mdescRight">SD: SDR12 (Single Data Rate) up to 25MHz, 12.5MB/s: UHS-I (Ultra High Speed) 1.8V signaling. <a href="#ga0473c44a7b65044b3c6a8e7012009a4a">More...</a><br/></td></tr>
<tr class="separator:ga0473c44a7b65044b3c6a8e7012009a4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae32422631052307b3c4d269b25415907"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__bus__speed__ctrls.html#gae32422631052307b3c4d269b25415907">ARM_MCI_BUS_UHS_SDR25</a>   (0x03)</td></tr>
<tr class="memdesc:gae32422631052307b3c4d269b25415907"><td class="mdescLeft"> </td><td class="mdescRight">SD: SDR25 (Single Data Rate) up to 50MHz, 25 MB/s: UHS-I (Ultra High Speed) 1.8V signaling. <a href="#gae32422631052307b3c4d269b25415907">More...</a><br/></td></tr>
<tr class="separator:gae32422631052307b3c4d269b25415907"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9f326c02391d965918ae619b912b81e7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__bus__speed__ctrls.html#ga9f326c02391d965918ae619b912b81e7">ARM_MCI_BUS_UHS_SDR50</a>   (0x04)</td></tr>
<tr class="memdesc:ga9f326c02391d965918ae619b912b81e7"><td class="mdescLeft"> </td><td class="mdescRight">SD: SDR50 (Single Data Rate) up to 100MHz, 50 MB/s: UHS-I (Ultra High Speed) 1.8V signaling. <a href="#ga9f326c02391d965918ae619b912b81e7">More...</a><br/></td></tr>
<tr class="separator:ga9f326c02391d965918ae619b912b81e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad2bab563e7bbb4bcf6bdabe6a13dadf4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__bus__speed__ctrls.html#gad2bab563e7bbb4bcf6bdabe6a13dadf4">ARM_MCI_BUS_UHS_SDR104</a>   (0x05)</td></tr>
<tr class="memdesc:gad2bab563e7bbb4bcf6bdabe6a13dadf4"><td class="mdescLeft"> </td><td class="mdescRight">SD: SDR104 (Single Data Rate) up to 208MHz, 104 MB/s: UHS-I (Ultra High Speed) 1.8V signaling. <a href="#gad2bab563e7bbb4bcf6bdabe6a13dadf4">More...</a><br/></td></tr>
<tr class="separator:gad2bab563e7bbb4bcf6bdabe6a13dadf4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga04da920a5cac99eab9784527057f1b9c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__bus__speed__ctrls.html#ga04da920a5cac99eab9784527057f1b9c">ARM_MCI_BUS_UHS_DDR50</a>   (0x06)</td></tr>
<tr class="memdesc:ga04da920a5cac99eab9784527057f1b9c"><td class="mdescLeft"> </td><td class="mdescRight">SD: DDR50 (Dual Data Rate) up to 50MHz, 50 MB/s: UHS-I (Ultra High Speed) 1.8V signaling. <a href="#ga04da920a5cac99eab9784527057f1b9c">More...</a><br/></td></tr>
<tr class="separator:ga04da920a5cac99eab9784527057f1b9c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify the bus speed mode. </p>
<p>The function <a class="el" href="group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30">ARM_MCI_Control</a> with <em>control</em> = <a class="el" href="group__mci__mode__ctrls.html#ga7f982d2e5aec768307d35a83c65fb3ef">ARM_MCI_BUS_SPEED</a> configures the bus speed of the MCI to the requested bits/s specified with <em>arg</em>.</p>
<p>The function <a class="el" href="group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30">ARM_MCI_Control</a> with <em>control</em> = <a class="el" href="group__mci__mode__ctrls.html#gaf7ede525eabc618fbbb9f7a294c8ed96">ARM_MCI_BUS_SPEED_MODE</a> configures the bus speed mode of the MCI as specified with <em>arg</em> listed bellow.</p>
<p>The function <a class="el" href="group__mci__interface__gr.html#ga7e5a78b6e6409189833a0b72a0a3c48a">ARM_MCI_GetCapabilities</a> lists the supported bus speed modes. Initially, all SD cards use a 3.3 volt electrical interface. Some SD cards can switch to 1.8 volt operation. For example, the use of ultra-high-speed (UHS) SD cards requires 1.8 volt operation and a 4-bit bus data width. The data field <em>uhs_signaling</em> of the structure <a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES" title="MCI Driver Capabilities. ">ARM_MCI_CAPABILITIES</a> encodes whether the driver supports 1.8 volt UHS signaling.</p>
<dl class="section see"><dt>See Also</dt><dd><ul>
<li><a class="el" href="group__mci__driver__strength__ctrls.html">MCI Driver Strength</a></li>
</ul>
</dd></dl>
<p>The following codes are defined: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga601fa8b27ab2e5f6d90c93d54c8f412d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BUS_DEFAULT_SPEED   (0x00)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SD/MMC: Default Speed mode up to 25/26MHz. </p>
</div>
</div>
<a class="anchor" id="gaabda746ac7d6b4497358ff655a8ea6be"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BUS_HIGH_SPEED   (0x01)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SD/MMC: High Speed mode up to 50/52MHz. </p>
</div>
</div>
<a class="anchor" id="ga0473c44a7b65044b3c6a8e7012009a4a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BUS_UHS_SDR12   (0x02)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SD: SDR12 (Single Data Rate) up to 25MHz, 12.5MB/s: UHS-I (Ultra High Speed) 1.8V signaling. </p>
</div>
</div>
<a class="anchor" id="gae32422631052307b3c4d269b25415907"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BUS_UHS_SDR25   (0x03)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SD: SDR25 (Single Data Rate) up to 50MHz, 25 MB/s: UHS-I (Ultra High Speed) 1.8V signaling. </p>
</div>
</div>
<a class="anchor" id="ga9f326c02391d965918ae619b912b81e7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BUS_UHS_SDR50   (0x04)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SD: SDR50 (Single Data Rate) up to 100MHz, 50 MB/s: UHS-I (Ultra High Speed) 1.8V signaling. </p>
</div>
</div>
<a class="anchor" id="gad2bab563e7bbb4bcf6bdabe6a13dadf4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BUS_UHS_SDR104   (0x05)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SD: SDR104 (Single Data Rate) up to 208MHz, 104 MB/s: UHS-I (Ultra High Speed) 1.8V signaling. </p>
</div>
</div>
<a class="anchor" id="ga04da920a5cac99eab9784527057f1b9c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BUS_UHS_DDR50   (0x06)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SD: DDR50 (Dual Data Rate) up to 50MHz, 50 MB/s: UHS-I (Ultra High Speed) 1.8V signaling. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__bus__speed__ctrls.html | HTML | apache-2.0 | 15,951 |
var group__mci__bus__speed__ctrls =
[
[ "ARM_MCI_BUS_DEFAULT_SPEED", "group__mci__bus__speed__ctrls.html#ga601fa8b27ab2e5f6d90c93d54c8f412d", null ],
[ "ARM_MCI_BUS_HIGH_SPEED", "group__mci__bus__speed__ctrls.html#gaabda746ac7d6b4497358ff655a8ea6be", null ],
[ "ARM_MCI_BUS_UHS_SDR12", "group__mci__bus__speed__ctrls.html#ga0473c44a7b65044b3c6a8e7012009a4a", null ],
[ "ARM_MCI_BUS_UHS_SDR25", "group__mci__bus__speed__ctrls.html#gae32422631052307b3c4d269b25415907", null ],
[ "ARM_MCI_BUS_UHS_SDR50", "group__mci__bus__speed__ctrls.html#ga9f326c02391d965918ae619b912b81e7", null ],
[ "ARM_MCI_BUS_UHS_SDR104", "group__mci__bus__speed__ctrls.html#gad2bab563e7bbb4bcf6bdabe6a13dadf4", null ],
[ "ARM_MCI_BUS_UHS_DDR50", "group__mci__bus__speed__ctrls.html#ga04da920a5cac99eab9784527057f1b9c", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__bus__speed__ctrls.js | JavaScript | apache-2.0 | 829 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>MCI Card Power Controls</title>
<title>CMSIS-Driver: MCI Card Power Controls</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__mci__card__power__ctrls.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">MCI Card Power Controls<div class="ingroups"><a class="el" href="group__mci__interface__gr.html">MCI Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify Memory Card Power supply voltage.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga288fbd80b384739a80e8f3ec31205cf5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__card__power__ctrls.html#ga288fbd80b384739a80e8f3ec31205cf5">ARM_MCI_POWER_VDD_OFF</a>   (0x01UL << ARM_MCI_POWER_VDD_Pos)</td></tr>
<tr class="memdesc:ga288fbd80b384739a80e8f3ec31205cf5"><td class="mdescLeft"> </td><td class="mdescRight">VDD (VCC) turned off. <a href="#ga288fbd80b384739a80e8f3ec31205cf5">More...</a><br/></td></tr>
<tr class="separator:ga288fbd80b384739a80e8f3ec31205cf5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga565ecd36c8d0379fb4172da577cc540d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__card__power__ctrls.html#ga565ecd36c8d0379fb4172da577cc540d">ARM_MCI_POWER_VDD_3V3</a>   (0x02UL << ARM_MCI_POWER_VDD_Pos)</td></tr>
<tr class="memdesc:ga565ecd36c8d0379fb4172da577cc540d"><td class="mdescLeft"> </td><td class="mdescRight">VDD (VCC) = 3.3V. <a href="#ga565ecd36c8d0379fb4172da577cc540d">More...</a><br/></td></tr>
<tr class="separator:ga565ecd36c8d0379fb4172da577cc540d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2ce8e379c3691da3b51c9c97d61770ef"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__card__power__ctrls.html#ga2ce8e379c3691da3b51c9c97d61770ef">ARM_MCI_POWER_VDD_1V8</a>   (0x03UL << ARM_MCI_POWER_VDD_Pos)</td></tr>
<tr class="memdesc:ga2ce8e379c3691da3b51c9c97d61770ef"><td class="mdescLeft"> </td><td class="mdescRight">VDD (VCC) = 1.8V. <a href="#ga2ce8e379c3691da3b51c9c97d61770ef">More...</a><br/></td></tr>
<tr class="separator:ga2ce8e379c3691da3b51c9c97d61770ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6929c98a6bc8d898939a95111509220b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__card__power__ctrls.html#ga6929c98a6bc8d898939a95111509220b">ARM_MCI_POWER_VCCQ_OFF</a>   (0x01UL << ARM_MCI_POWER_VCCQ_Pos)</td></tr>
<tr class="memdesc:ga6929c98a6bc8d898939a95111509220b"><td class="mdescLeft"> </td><td class="mdescRight">eMMC VCCQ turned off <a href="#ga6929c98a6bc8d898939a95111509220b">More...</a><br/></td></tr>
<tr class="separator:ga6929c98a6bc8d898939a95111509220b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga91a7201173cc092eaf7f0bcee028871e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__card__power__ctrls.html#ga91a7201173cc092eaf7f0bcee028871e">ARM_MCI_POWER_VCCQ_3V3</a>   (0x02UL << ARM_MCI_POWER_VCCQ_Pos)</td></tr>
<tr class="memdesc:ga91a7201173cc092eaf7f0bcee028871e"><td class="mdescLeft"> </td><td class="mdescRight">eMMC VCCQ = 3.3V <a href="#ga91a7201173cc092eaf7f0bcee028871e">More...</a><br/></td></tr>
<tr class="separator:ga91a7201173cc092eaf7f0bcee028871e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaf389e0a139d5808dff8ebb6897d4c7b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__card__power__ctrls.html#gaaf389e0a139d5808dff8ebb6897d4c7b">ARM_MCI_POWER_VCCQ_1V8</a>   (0x03UL << ARM_MCI_POWER_VCCQ_Pos)</td></tr>
<tr class="memdesc:gaaf389e0a139d5808dff8ebb6897d4c7b"><td class="mdescLeft"> </td><td class="mdescRight">eMMC VCCQ = 1.8V <a href="#gaaf389e0a139d5808dff8ebb6897d4c7b">More...</a><br/></td></tr>
<tr class="separator:gaaf389e0a139d5808dff8ebb6897d4c7b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5304b3b6cadc5113f841c3d526ab5db6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__card__power__ctrls.html#ga5304b3b6cadc5113f841c3d526ab5db6">ARM_MCI_POWER_VCCQ_1V2</a>   (0x04UL << ARM_MCI_POWER_VCCQ_Pos)</td></tr>
<tr class="memdesc:ga5304b3b6cadc5113f841c3d526ab5db6"><td class="mdescLeft"> </td><td class="mdescRight">eMMC VCCQ = 1.2V <a href="#ga5304b3b6cadc5113f841c3d526ab5db6">More...</a><br/></td></tr>
<tr class="separator:ga5304b3b6cadc5113f841c3d526ab5db6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify Memory Card Power supply voltage. </p>
<p>Specifies the power supply volatge for a memory card. Used with the function <a class="el" href="group__mci__interface__gr.html#gab161f80e0eda2815f3e0ebbba1314ff0">ARM_MCI_CardPower</a> as the parameter <em>voltage</em>.</p>
<p>The following codes are defined: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga288fbd80b384739a80e8f3ec31205cf5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_POWER_VDD_OFF   (0x01UL << ARM_MCI_POWER_VDD_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>VDD (VCC) turned off. </p>
</div>
</div>
<a class="anchor" id="ga565ecd36c8d0379fb4172da577cc540d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_POWER_VDD_3V3   (0x02UL << ARM_MCI_POWER_VDD_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>VDD (VCC) = 3.3V. </p>
</div>
</div>
<a class="anchor" id="ga2ce8e379c3691da3b51c9c97d61770ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_POWER_VDD_1V8   (0x03UL << ARM_MCI_POWER_VDD_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>VDD (VCC) = 1.8V. </p>
</div>
</div>
<a class="anchor" id="ga6929c98a6bc8d898939a95111509220b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_POWER_VCCQ_OFF   (0x01UL << ARM_MCI_POWER_VCCQ_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>eMMC VCCQ turned off </p>
</div>
</div>
<a class="anchor" id="ga91a7201173cc092eaf7f0bcee028871e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_POWER_VCCQ_3V3   (0x02UL << ARM_MCI_POWER_VCCQ_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>eMMC VCCQ = 3.3V </p>
</div>
</div>
<a class="anchor" id="gaaf389e0a139d5808dff8ebb6897d4c7b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_POWER_VCCQ_1V8   (0x03UL << ARM_MCI_POWER_VCCQ_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>eMMC VCCQ = 1.8V </p>
</div>
</div>
<a class="anchor" id="ga5304b3b6cadc5113f841c3d526ab5db6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_POWER_VCCQ_1V2   (0x04UL << ARM_MCI_POWER_VCCQ_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>eMMC VCCQ = 1.2V </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__card__power__ctrls.html | HTML | apache-2.0 | 14,355 |
var group__mci__card__power__ctrls =
[
[ "ARM_MCI_POWER_VDD_OFF", "group__mci__card__power__ctrls.html#ga288fbd80b384739a80e8f3ec31205cf5", null ],
[ "ARM_MCI_POWER_VDD_3V3", "group__mci__card__power__ctrls.html#ga565ecd36c8d0379fb4172da577cc540d", null ],
[ "ARM_MCI_POWER_VDD_1V8", "group__mci__card__power__ctrls.html#ga2ce8e379c3691da3b51c9c97d61770ef", null ],
[ "ARM_MCI_POWER_VCCQ_OFF", "group__mci__card__power__ctrls.html#ga6929c98a6bc8d898939a95111509220b", null ],
[ "ARM_MCI_POWER_VCCQ_3V3", "group__mci__card__power__ctrls.html#ga91a7201173cc092eaf7f0bcee028871e", null ],
[ "ARM_MCI_POWER_VCCQ_1V8", "group__mci__card__power__ctrls.html#gaaf389e0a139d5808dff8ebb6897d4c7b", null ],
[ "ARM_MCI_POWER_VCCQ_1V2", "group__mci__card__power__ctrls.html#ga5304b3b6cadc5113f841c3d526ab5db6", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__card__power__ctrls.js | JavaScript | apache-2.0 | 835 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>MCI CMD Line Mode</title>
<title>CMSIS-Driver: MCI CMD Line Mode</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__mci__cmd__line__ctrls.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">MCI CMD Line Mode<div class="ingroups"><a class="el" href="group__mci__control__gr.html">MCI Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify the CMD line mode (Push-Pull or Open Drain).
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaaed404312d9bc073e3489779a911c7dc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__cmd__line__ctrls.html#gaaed404312d9bc073e3489779a911c7dc">ARM_MCI_BUS_CMD_PUSH_PULL</a>   (0x00)</td></tr>
<tr class="memdesc:gaaed404312d9bc073e3489779a911c7dc"><td class="mdescLeft"> </td><td class="mdescRight">Push-Pull CMD line (default) <a href="#gaaed404312d9bc073e3489779a911c7dc">More...</a><br/></td></tr>
<tr class="separator:gaaed404312d9bc073e3489779a911c7dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaadf8667985731964d57d1ed672e90fd3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__cmd__line__ctrls.html#gaadf8667985731964d57d1ed672e90fd3">ARM_MCI_BUS_CMD_OPEN_DRAIN</a>   (0x01)</td></tr>
<tr class="memdesc:gaadf8667985731964d57d1ed672e90fd3"><td class="mdescLeft"> </td><td class="mdescRight">Open Drain CMD line (MMC only) <a href="#gaadf8667985731964d57d1ed672e90fd3">More...</a><br/></td></tr>
<tr class="separator:gaadf8667985731964d57d1ed672e90fd3"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify the CMD line mode (Push-Pull or Open Drain). </p>
<p>Set the CMD line type with the function <a class="el" href="group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30">ARM_MCI_Control</a>. The CMD line mode is push-pull (default) or open drain (needed for older MMC). </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gaaed404312d9bc073e3489779a911c7dc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BUS_CMD_PUSH_PULL   (0x00)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Push-Pull CMD line (default) </p>
</div>
</div>
<a class="anchor" id="gaadf8667985731964d57d1ed672e90fd3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BUS_CMD_OPEN_DRAIN   (0x01)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Open Drain CMD line (MMC only) </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__cmd__line__ctrls.html | HTML | apache-2.0 | 9,056 |
var group__mci__cmd__line__ctrls =
[
[ "ARM_MCI_BUS_CMD_PUSH_PULL", "group__mci__cmd__line__ctrls.html#gaaed404312d9bc073e3489779a911c7dc", null ],
[ "ARM_MCI_BUS_CMD_OPEN_DRAIN", "group__mci__cmd__line__ctrls.html#gaadf8667985731964d57d1ed672e90fd3", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__cmd__line__ctrls.js | JavaScript | apache-2.0 | 269 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>MCI Control Codes</title>
<title>CMSIS-Driver: MCI Control Codes</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__mci__control__gr.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Content</a> </div>
<div class="headertitle">
<div class="title">MCI Control Codes<div class="ingroups"><a class="el" href="group__mci__interface__gr.html">MCI Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Configure and control the MCI using the <a class="el" href="group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30">ARM_MCI_Control</a>.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Content</h2></td></tr>
<tr class="memitem:group__mci__mode__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__mode__ctrls.html">MCI Controls</a></td></tr>
<tr class="memdesc:group__mci__mode__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Configure and control the MCI interface. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__mci__bus__speed__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__bus__speed__ctrls.html">MCI Bus Speed Mode</a></td></tr>
<tr class="memdesc:group__mci__bus__speed__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Specify the bus speed mode. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__mci__bus__data__width__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__bus__data__width__ctrls.html">MCI Bus Data Width</a></td></tr>
<tr class="memdesc:group__mci__bus__data__width__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Specify the data bus width. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__mci__cmd__line__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__cmd__line__ctrls.html">MCI CMD Line Mode</a></td></tr>
<tr class="memdesc:group__mci__cmd__line__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Specify the CMD line mode (Push-Pull or Open Drain). <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__mci__driver__strength__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__driver__strength__ctrls.html">MCI Driver Strength</a></td></tr>
<tr class="memdesc:group__mci__driver__strength__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Specify the driver strength. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Configure and control the MCI using the <a class="el" href="group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30">ARM_MCI_Control</a>. </p>
<p>Many parameters of the MCI driver are configured using the <a class="el" href="group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30">ARM_MCI_Control</a> function.</p>
<p>The various MCI control codes define:</p>
<ul>
<li><a class="el" href="group__mci__mode__ctrls.html">MCI Controls</a> configures and controls the MCI interface</li>
<li><a class="el" href="group__mci__bus__speed__ctrls.html">MCI Bus Speed Mode</a> specifies the bus speed mode</li>
<li><a class="el" href="group__mci__bus__data__width__ctrls.html">MCI Bus Data Width</a> specifies the data bus width</li>
<li><a class="el" href="group__mci__cmd__line__ctrls.html">MCI CMD Line Mode</a> specifies the CMD line mode</li>
<li><a class="el" href="group__mci__driver__strength__ctrls.html">MCI Driver Strength</a> specifies the driver strength</li>
</ul>
<p>Refer to the function <a class="el" href="group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30">ARM_MCI_Control</a> for further details. </p>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__control__gr.html | HTML | apache-2.0 | 10,317 |
var group__mci__control__gr =
[
[ "MCI Controls", "group__mci__mode__ctrls.html", "group__mci__mode__ctrls" ],
[ "MCI Bus Speed Mode", "group__mci__bus__speed__ctrls.html", "group__mci__bus__speed__ctrls" ],
[ "MCI Bus Data Width", "group__mci__bus__data__width__ctrls.html", "group__mci__bus__data__width__ctrls" ],
[ "MCI CMD Line Mode", "group__mci__cmd__line__ctrls.html", "group__mci__cmd__line__ctrls" ],
[ "MCI Driver Strength", "group__mci__driver__strength__ctrls.html", "group__mci__driver__strength__ctrls" ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__control__gr.js | JavaScript | apache-2.0 | 542 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>MCI Driver Strength</title>
<title>CMSIS-Driver: MCI Driver Strength</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__mci__driver__strength__ctrls.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">MCI Driver Strength<div class="ingroups"><a class="el" href="group__mci__control__gr.html">MCI Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify the driver strength.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga64eb1c4847711a262f084c361b60a912"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__driver__strength__ctrls.html#ga64eb1c4847711a262f084c361b60a912">ARM_MCI_DRIVER_TYPE_A</a>   (0x01)</td></tr>
<tr class="memdesc:ga64eb1c4847711a262f084c361b60a912"><td class="mdescLeft"> </td><td class="mdescRight">SD UHS-I Driver Type A. <a href="#ga64eb1c4847711a262f084c361b60a912">More...</a><br/></td></tr>
<tr class="separator:ga64eb1c4847711a262f084c361b60a912"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga078d3c3bc7c9335b92e6445a0abafc46"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__driver__strength__ctrls.html#ga078d3c3bc7c9335b92e6445a0abafc46">ARM_MCI_DRIVER_TYPE_B</a>   (0x00)</td></tr>
<tr class="memdesc:ga078d3c3bc7c9335b92e6445a0abafc46"><td class="mdescLeft"> </td><td class="mdescRight">SD UHS-I Driver Type B (default) <a href="#ga078d3c3bc7c9335b92e6445a0abafc46">More...</a><br/></td></tr>
<tr class="separator:ga078d3c3bc7c9335b92e6445a0abafc46"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3da11696d1fcd3930eb7e70fe097d747"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__driver__strength__ctrls.html#ga3da11696d1fcd3930eb7e70fe097d747">ARM_MCI_DRIVER_TYPE_C</a>   (0x02)</td></tr>
<tr class="memdesc:ga3da11696d1fcd3930eb7e70fe097d747"><td class="mdescLeft"> </td><td class="mdescRight">SD UHS-I Driver Type C. <a href="#ga3da11696d1fcd3930eb7e70fe097d747">More...</a><br/></td></tr>
<tr class="separator:ga3da11696d1fcd3930eb7e70fe097d747"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8185f82b1d8857a3f0eb461d664f2b3d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__driver__strength__ctrls.html#ga8185f82b1d8857a3f0eb461d664f2b3d">ARM_MCI_DRIVER_TYPE_D</a>   (0x03)</td></tr>
<tr class="memdesc:ga8185f82b1d8857a3f0eb461d664f2b3d"><td class="mdescLeft"> </td><td class="mdescRight">SD UHS-I Driver Type D. <a href="#ga8185f82b1d8857a3f0eb461d664f2b3d">More...</a><br/></td></tr>
<tr class="separator:ga8185f82b1d8857a3f0eb461d664f2b3d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify the driver strength. </p>
<p>The function <a class="el" href="group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30">ARM_MCI_Control</a> with <em>control</em> = <a class="el" href="group__mci__mode__ctrls.html#ga78068f519139f2ae7b09e0608070aaf6">ARM_MCI_DRIVER_STRENGTH</a> specifies with <em>arg</em> the driver type of the SD interface.</p>
<dl class="section see"><dt>See Also</dt><dd><ul>
<li><a class="el" href="group__mci__bus__speed__ctrls.html">MCI Bus Speed Mode</a></li>
</ul>
</dd></dl>
<p>The following codes are defined: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga64eb1c4847711a262f084c361b60a912"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_DRIVER_TYPE_A   (0x01)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SD UHS-I Driver Type A. </p>
</div>
</div>
<a class="anchor" id="ga078d3c3bc7c9335b92e6445a0abafc46"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_DRIVER_TYPE_B   (0x00)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SD UHS-I Driver Type B (default) </p>
</div>
</div>
<a class="anchor" id="ga3da11696d1fcd3930eb7e70fe097d747"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_DRIVER_TYPE_C   (0x02)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SD UHS-I Driver Type C. </p>
</div>
</div>
<a class="anchor" id="ga8185f82b1d8857a3f0eb461d664f2b3d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_DRIVER_TYPE_D   (0x03)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SD UHS-I Driver Type D. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__driver__strength__ctrls.html | HTML | apache-2.0 | 11,273 |
var group__mci__driver__strength__ctrls =
[
[ "ARM_MCI_DRIVER_TYPE_A", "group__mci__driver__strength__ctrls.html#ga64eb1c4847711a262f084c361b60a912", null ],
[ "ARM_MCI_DRIVER_TYPE_B", "group__mci__driver__strength__ctrls.html#ga078d3c3bc7c9335b92e6445a0abafc46", null ],
[ "ARM_MCI_DRIVER_TYPE_C", "group__mci__driver__strength__ctrls.html#ga3da11696d1fcd3930eb7e70fe097d747", null ],
[ "ARM_MCI_DRIVER_TYPE_D", "group__mci__driver__strength__ctrls.html#ga8185f82b1d8857a3f0eb461d664f2b3d", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__driver__strength__ctrls.js | JavaScript | apache-2.0 | 517 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>MCI Events</title>
<title>CMSIS-Driver: MCI Events</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__mci__event__gr.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">MCI Events<div class="ingroups"><a class="el" href="group__mci__interface__gr.html">MCI Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>The MCI driver generates call back events that are notified via the function <a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a>.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gae2cf8ef238c092e94e96a01602f3a23c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#gae2cf8ef238c092e94e96a01602f3a23c">ARM_MCI_EVENT_CARD_INSERTED</a>   (1UL << 0)</td></tr>
<tr class="memdesc:gae2cf8ef238c092e94e96a01602f3a23c"><td class="mdescLeft"> </td><td class="mdescRight">Memory Card inserted. <a href="#gae2cf8ef238c092e94e96a01602f3a23c">More...</a><br/></td></tr>
<tr class="separator:gae2cf8ef238c092e94e96a01602f3a23c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga92ba748f9324ec13898f10456f17c8cc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#ga92ba748f9324ec13898f10456f17c8cc">ARM_MCI_EVENT_CARD_REMOVED</a>   (1UL << 1)</td></tr>
<tr class="memdesc:ga92ba748f9324ec13898f10456f17c8cc"><td class="mdescLeft"> </td><td class="mdescRight">Memory Card removed. <a href="#ga92ba748f9324ec13898f10456f17c8cc">More...</a><br/></td></tr>
<tr class="separator:ga92ba748f9324ec13898f10456f17c8cc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae69356c75d55103d93ef91ac1bc02b49"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#gae69356c75d55103d93ef91ac1bc02b49">ARM_MCI_EVENT_COMMAND_COMPLETE</a>   (1UL << 2)</td></tr>
<tr class="memdesc:gae69356c75d55103d93ef91ac1bc02b49"><td class="mdescLeft"> </td><td class="mdescRight">Command completed. <a href="#gae69356c75d55103d93ef91ac1bc02b49">More...</a><br/></td></tr>
<tr class="separator:gae69356c75d55103d93ef91ac1bc02b49"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab79b3ab4dcd03c38df1e173fa903d822"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#gab79b3ab4dcd03c38df1e173fa903d822">ARM_MCI_EVENT_COMMAND_TIMEOUT</a>   (1UL << 3)</td></tr>
<tr class="memdesc:gab79b3ab4dcd03c38df1e173fa903d822"><td class="mdescLeft"> </td><td class="mdescRight">Command timeout. <a href="#gab79b3ab4dcd03c38df1e173fa903d822">More...</a><br/></td></tr>
<tr class="separator:gab79b3ab4dcd03c38df1e173fa903d822"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga373aeb3eca0e4c6d159312488a130442"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#ga373aeb3eca0e4c6d159312488a130442">ARM_MCI_EVENT_COMMAND_ERROR</a>   (1UL << 4)</td></tr>
<tr class="memdesc:ga373aeb3eca0e4c6d159312488a130442"><td class="mdescLeft"> </td><td class="mdescRight">Command response error (CRC error or invalid response) <a href="#ga373aeb3eca0e4c6d159312488a130442">More...</a><br/></td></tr>
<tr class="separator:ga373aeb3eca0e4c6d159312488a130442"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabc3c468dedaed890683360f2c5c65bea"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#gabc3c468dedaed890683360f2c5c65bea">ARM_MCI_EVENT_TRANSFER_COMPLETE</a>   (1UL << 5)</td></tr>
<tr class="memdesc:gabc3c468dedaed890683360f2c5c65bea"><td class="mdescLeft"> </td><td class="mdescRight">Data transfer completed. <a href="#gabc3c468dedaed890683360f2c5c65bea">More...</a><br/></td></tr>
<tr class="separator:gabc3c468dedaed890683360f2c5c65bea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga614e7c7226adbaa8ec4165bf8b87ef27"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#ga614e7c7226adbaa8ec4165bf8b87ef27">ARM_MCI_EVENT_TRANSFER_TIMEOUT</a>   (1UL << 6)</td></tr>
<tr class="memdesc:ga614e7c7226adbaa8ec4165bf8b87ef27"><td class="mdescLeft"> </td><td class="mdescRight">Data transfer timeout. <a href="#ga614e7c7226adbaa8ec4165bf8b87ef27">More...</a><br/></td></tr>
<tr class="separator:ga614e7c7226adbaa8ec4165bf8b87ef27"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5d2cee5ba6d0e40ad505983155706c29"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#ga5d2cee5ba6d0e40ad505983155706c29">ARM_MCI_EVENT_TRANSFER_ERROR</a>   (1UL << 7)</td></tr>
<tr class="memdesc:ga5d2cee5ba6d0e40ad505983155706c29"><td class="mdescLeft"> </td><td class="mdescRight">Data transfer CRC failed. <a href="#ga5d2cee5ba6d0e40ad505983155706c29">More...</a><br/></td></tr>
<tr class="separator:ga5d2cee5ba6d0e40ad505983155706c29"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga75a050fdfe04e6816e96c938d6a6c197"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#ga75a050fdfe04e6816e96c938d6a6c197">ARM_MCI_EVENT_SDIO_INTERRUPT</a>   (1UL << 8)</td></tr>
<tr class="memdesc:ga75a050fdfe04e6816e96c938d6a6c197"><td class="mdescLeft"> </td><td class="mdescRight">SD I/O Interrupt. <a href="#ga75a050fdfe04e6816e96c938d6a6c197">More...</a><br/></td></tr>
<tr class="separator:ga75a050fdfe04e6816e96c938d6a6c197"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8161f3960ddf2a3cdc3c4c83148c6099"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#ga8161f3960ddf2a3cdc3c4c83148c6099">ARM_MCI_EVENT_CCS</a>   (1UL << 9)</td></tr>
<tr class="memdesc:ga8161f3960ddf2a3cdc3c4c83148c6099"><td class="mdescLeft"> </td><td class="mdescRight">Command Completion Signal (CCS) <a href="#ga8161f3960ddf2a3cdc3c4c83148c6099">More...</a><br/></td></tr>
<tr class="separator:ga8161f3960ddf2a3cdc3c4c83148c6099"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafa8cbcd597a05c64901eeb777cc0b74f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#gafa8cbcd597a05c64901eeb777cc0b74f">ARM_MCI_EVENT_CCS_TIMEOUT</a>   (1UL << 10)</td></tr>
<tr class="memdesc:gafa8cbcd597a05c64901eeb777cc0b74f"><td class="mdescLeft"> </td><td class="mdescRight">Command Completion Signal (CCS) Timeout. <a href="#gafa8cbcd597a05c64901eeb777cc0b74f">More...</a><br/></td></tr>
<tr class="separator:gafa8cbcd597a05c64901eeb777cc0b74f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>The MCI driver generates call back events that are notified via the function <a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a>. </p>
<p>This section provides the event values for the <a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> callback function.</p>
<p>The following call back notification events are generated: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gae2cf8ef238c092e94e96a01602f3a23c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_EVENT_CARD_INSERTED   (1UL << 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Memory Card inserted. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga92ba748f9324ec13898f10456f17c8cc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_EVENT_CARD_REMOVED   (1UL << 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Memory Card removed. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gae69356c75d55103d93ef91ac1bc02b49"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_EVENT_COMMAND_COMPLETE   (1UL << 2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Command completed. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gab79b3ab4dcd03c38df1e173fa903d822"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_EVENT_COMMAND_TIMEOUT   (1UL << 3)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Command timeout. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga373aeb3eca0e4c6d159312488a130442"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_EVENT_COMMAND_ERROR   (1UL << 4)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Command response error (CRC error or invalid response) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gabc3c468dedaed890683360f2c5c65bea"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_EVENT_TRANSFER_COMPLETE   (1UL << 5)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Data transfer completed. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga614e7c7226adbaa8ec4165bf8b87ef27"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_EVENT_TRANSFER_TIMEOUT   (1UL << 6)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Data transfer timeout. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga5d2cee5ba6d0e40ad505983155706c29"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_EVENT_TRANSFER_ERROR   (1UL << 7)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Data transfer CRC failed. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga75a050fdfe04e6816e96c938d6a6c197"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_EVENT_SDIO_INTERRUPT   (1UL << 8)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SD I/O Interrupt. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga8161f3960ddf2a3cdc3c4c83148c6099"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_EVENT_CCS   (1UL << 9)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Command Completion Signal (CCS) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gafa8cbcd597a05c64901eeb777cc0b74f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_EVENT_CCS_TIMEOUT   (1UL << 10)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Command Completion Signal (CCS) Timeout. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__event__gr.html | HTML | apache-2.0 | 20,269 |
var group__mci__event__gr =
[
[ "ARM_MCI_EVENT_CARD_INSERTED", "group__mci__event__gr.html#gae2cf8ef238c092e94e96a01602f3a23c", null ],
[ "ARM_MCI_EVENT_CARD_REMOVED", "group__mci__event__gr.html#ga92ba748f9324ec13898f10456f17c8cc", null ],
[ "ARM_MCI_EVENT_COMMAND_COMPLETE", "group__mci__event__gr.html#gae69356c75d55103d93ef91ac1bc02b49", null ],
[ "ARM_MCI_EVENT_COMMAND_TIMEOUT", "group__mci__event__gr.html#gab79b3ab4dcd03c38df1e173fa903d822", null ],
[ "ARM_MCI_EVENT_COMMAND_ERROR", "group__mci__event__gr.html#ga373aeb3eca0e4c6d159312488a130442", null ],
[ "ARM_MCI_EVENT_TRANSFER_COMPLETE", "group__mci__event__gr.html#gabc3c468dedaed890683360f2c5c65bea", null ],
[ "ARM_MCI_EVENT_TRANSFER_TIMEOUT", "group__mci__event__gr.html#ga614e7c7226adbaa8ec4165bf8b87ef27", null ],
[ "ARM_MCI_EVENT_TRANSFER_ERROR", "group__mci__event__gr.html#ga5d2cee5ba6d0e40ad505983155706c29", null ],
[ "ARM_MCI_EVENT_SDIO_INTERRUPT", "group__mci__event__gr.html#ga75a050fdfe04e6816e96c938d6a6c197", null ],
[ "ARM_MCI_EVENT_CCS", "group__mci__event__gr.html#ga8161f3960ddf2a3cdc3c4c83148c6099", null ],
[ "ARM_MCI_EVENT_CCS_TIMEOUT", "group__mci__event__gr.html#gafa8cbcd597a05c64901eeb777cc0b74f", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__event__gr.js | JavaScript | apache-2.0 | 1,242 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>MCI Interface</title>
<title>CMSIS-Driver: MCI Interface</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__mci__interface__gr.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Content</a> |
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">MCI Interface</div> </div>
</div><!--header-->
<div class="contents">
<p>Driver API for Memory Card Interface using SD/MMC interface (Driver_MCI.h)
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Content</h2></td></tr>
<tr class="memitem:group__mci__event__gr"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html">MCI Events</a></td></tr>
<tr class="memdesc:group__mci__event__gr"><td class="mdescLeft"> </td><td class="mdescRight">The MCI driver generates call back events that are notified via the function <a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a>. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__mci__control__gr"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__control__gr.html">MCI Control Codes</a></td></tr>
<tr class="memdesc:group__mci__control__gr"><td class="mdescLeft"> </td><td class="mdescRight">Configure and control the MCI using the <a class="el" href="group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30">ARM_MCI_Control</a>. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__mci__send__command__flags__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__send__command__flags__ctrls.html">MCI Send Command Flags</a></td></tr>
<tr class="memdesc:group__mci__send__command__flags__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Specify various options for sending commands to the card and the expected response. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__mci__transfer__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__transfer__ctrls.html">MCI Transfer Controls</a></td></tr>
<tr class="memdesc:group__mci__transfer__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Specify data transfer mode. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__mci__card__power__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__card__power__ctrls.html">MCI Card Power Controls</a></td></tr>
<tr class="memdesc:group__mci__card__power__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Specify Memory Card Power supply voltage. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:structARM__DRIVER__MCI"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a></td></tr>
<tr class="memdesc:structARM__DRIVER__MCI"><td class="mdescLeft"> </td><td class="mdescRight">Access structure of the MCI Driver. <a href="group__mci__interface__gr.html#structARM__DRIVER__MCI">More...</a><br/></td></tr>
<tr class="separator:structARM__DRIVER__MCI"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__MCI__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a></td></tr>
<tr class="memdesc:structARM__MCI__CAPABILITIES"><td class="mdescLeft"> </td><td class="mdescRight">MCI Driver Capabilities. <a href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">More...</a><br/></td></tr>
<tr class="separator:structARM__MCI__CAPABILITIES"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__MCI__STATUS"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#structARM__MCI__STATUS">ARM_MCI_STATUS</a></td></tr>
<tr class="memdesc:structARM__MCI__STATUS"><td class="mdescLeft"> </td><td class="mdescRight">MCI Status. <a href="group__mci__interface__gr.html#structARM__MCI__STATUS">More...</a><br/></td></tr>
<tr class="separator:structARM__MCI__STATUS"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga0d14651f6788c1ffd81544602565faf1"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ga0d14651f6788c1ffd81544602565faf1">ARM_MCI_SignalEvent_t</a> )(uint32_t event)</td></tr>
<tr class="memdesc:ga0d14651f6788c1ffd81544602565faf1"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> : Signal MCI Card Event. <a href="#ga0d14651f6788c1ffd81544602565faf1">More...</a><br/></td></tr>
<tr class="separator:ga0d14651f6788c1ffd81544602565faf1"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga3418183015dbf3025b94eebaedb00ab1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ga3418183015dbf3025b94eebaedb00ab1">ARM_MCI_GetVersion</a> (void)</td></tr>
<tr class="memdesc:ga3418183015dbf3025b94eebaedb00ab1"><td class="mdescLeft"> </td><td class="mdescRight">Get driver version. <a href="#ga3418183015dbf3025b94eebaedb00ab1">More...</a><br/></td></tr>
<tr class="separator:ga3418183015dbf3025b94eebaedb00ab1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7e5a78b6e6409189833a0b72a0a3c48a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ga7e5a78b6e6409189833a0b72a0a3c48a">ARM_MCI_GetCapabilities</a> (void)</td></tr>
<tr class="memdesc:ga7e5a78b6e6409189833a0b72a0a3c48a"><td class="mdescLeft"> </td><td class="mdescRight">Get driver capabilities. <a href="#ga7e5a78b6e6409189833a0b72a0a3c48a">More...</a><br/></td></tr>
<tr class="separator:ga7e5a78b6e6409189833a0b72a0a3c48a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6f34d4ab362e596ddaf23aac093268cf"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ga6f34d4ab362e596ddaf23aac093268cf">ARM_MCI_Initialize</a> (<a class="el" href="group__mci__interface__gr.html#ga0d14651f6788c1ffd81544602565faf1">ARM_MCI_SignalEvent_t</a> cb_event)</td></tr>
<tr class="memdesc:ga6f34d4ab362e596ddaf23aac093268cf"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the Memory Card Interface. <a href="#ga6f34d4ab362e596ddaf23aac093268cf">More...</a><br/></td></tr>
<tr class="separator:ga6f34d4ab362e596ddaf23aac093268cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaef8183e77797e74997551d03646d42c2"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#gaef8183e77797e74997551d03646d42c2">ARM_MCI_Uninitialize</a> (void)</td></tr>
<tr class="memdesc:gaef8183e77797e74997551d03646d42c2"><td class="mdescLeft"> </td><td class="mdescRight">De-initialize Memory Card Interface. <a href="#gaef8183e77797e74997551d03646d42c2">More...</a><br/></td></tr>
<tr class="separator:gaef8183e77797e74997551d03646d42c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga19752749d04ed22dc91c4294645e0244"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ga19752749d04ed22dc91c4294645e0244">ARM_MCI_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:ga19752749d04ed22dc91c4294645e0244"><td class="mdescLeft"> </td><td class="mdescRight">Control Memory Card Interface Power. <a href="#ga19752749d04ed22dc91c4294645e0244">More...</a><br/></td></tr>
<tr class="separator:ga19752749d04ed22dc91c4294645e0244"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab161f80e0eda2815f3e0ebbba1314ff0"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#gab161f80e0eda2815f3e0ebbba1314ff0">ARM_MCI_CardPower</a> (uint32_t voltage)</td></tr>
<tr class="memdesc:gab161f80e0eda2815f3e0ebbba1314ff0"><td class="mdescLeft"> </td><td class="mdescRight">Set Memory Card Power supply voltage. <a href="#gab161f80e0eda2815f3e0ebbba1314ff0">More...</a><br/></td></tr>
<tr class="separator:gab161f80e0eda2815f3e0ebbba1314ff0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga012fca8f1ce5366fce14b708c771c635"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ga012fca8f1ce5366fce14b708c771c635">ARM_MCI_ReadCD</a> (void)</td></tr>
<tr class="memdesc:ga012fca8f1ce5366fce14b708c771c635"><td class="mdescLeft"> </td><td class="mdescRight">Read Card Detect (CD) state. <a href="#ga012fca8f1ce5366fce14b708c771c635">More...</a><br/></td></tr>
<tr class="separator:ga012fca8f1ce5366fce14b708c771c635"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3d70286918405ac81fa795c7d09dc6fd"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ga3d70286918405ac81fa795c7d09dc6fd">ARM_MCI_ReadWP</a> (void)</td></tr>
<tr class="memdesc:ga3d70286918405ac81fa795c7d09dc6fd"><td class="mdescLeft"> </td><td class="mdescRight">Read Write Protect (WP) state. <a href="#ga3d70286918405ac81fa795c7d09dc6fd">More...</a><br/></td></tr>
<tr class="separator:ga3d70286918405ac81fa795c7d09dc6fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5a431da89feabc2b4bc0c27943dff6f2"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ga5a431da89feabc2b4bc0c27943dff6f2">ARM_MCI_SendCommand</a> (uint32_t cmd, uint32_t arg, uint32_t flags, uint32_t *response)</td></tr>
<tr class="memdesc:ga5a431da89feabc2b4bc0c27943dff6f2"><td class="mdescLeft"> </td><td class="mdescRight">Send Command to card and get the response. <a href="#ga5a431da89feabc2b4bc0c27943dff6f2">More...</a><br/></td></tr>
<tr class="separator:ga5a431da89feabc2b4bc0c27943dff6f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaec681bcd8e6811c5743e33ee0f35ed1"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#gaaec681bcd8e6811c5743e33ee0f35ed1">ARM_MCI_SetupTransfer</a> (uint8_t *data, uint32_t block_count, uint32_t block_size, uint32_t mode)</td></tr>
<tr class="memdesc:gaaec681bcd8e6811c5743e33ee0f35ed1"><td class="mdescLeft"> </td><td class="mdescRight">Setup read or write transfer operation. <a href="#gaaec681bcd8e6811c5743e33ee0f35ed1">More...</a><br/></td></tr>
<tr class="separator:gaaec681bcd8e6811c5743e33ee0f35ed1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3dfcf7b7186b711f9b63a096be816fe5"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ga3dfcf7b7186b711f9b63a096be816fe5">ARM_MCI_AbortTransfer</a> (void)</td></tr>
<tr class="memdesc:ga3dfcf7b7186b711f9b63a096be816fe5"><td class="mdescLeft"> </td><td class="mdescRight">Abort current read/write data transfer. <a href="#ga3dfcf7b7186b711f9b63a096be816fe5">More...</a><br/></td></tr>
<tr class="separator:ga3dfcf7b7186b711f9b63a096be816fe5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaec0506a2aa4ae75cf6bc02528f36fe30"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30">ARM_MCI_Control</a> (uint32_t control, uint32_t arg)</td></tr>
<tr class="memdesc:gaec0506a2aa4ae75cf6bc02528f36fe30"><td class="mdescLeft"> </td><td class="mdescRight">Control MCI Interface. <a href="#gaec0506a2aa4ae75cf6bc02528f36fe30">More...</a><br/></td></tr>
<tr class="separator:gaec0506a2aa4ae75cf6bc02528f36fe30"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8d61aa42ce78d1864fa928c1f273cbd9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__mci__interface__gr.html#structARM__MCI__STATUS">ARM_MCI_STATUS</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ga8d61aa42ce78d1864fa928c1f273cbd9">ARM_MCI_GetStatus</a> (void)</td></tr>
<tr class="memdesc:ga8d61aa42ce78d1864fa928c1f273cbd9"><td class="mdescLeft"> </td><td class="mdescRight">Get MCI status. <a href="#ga8d61aa42ce78d1864fa928c1f273cbd9">More...</a><br/></td></tr>
<tr class="separator:ga8d61aa42ce78d1864fa928c1f273cbd9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaac2dbd1c1a98436938c5d0d6248cb700"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> (uint32_t event)</td></tr>
<tr class="memdesc:gaac2dbd1c1a98436938c5d0d6248cb700"><td class="mdescLeft"> </td><td class="mdescRight">Callback function that signals a MCI Card Event. <a href="#gaac2dbd1c1a98436938c5d0d6248cb700">More...</a><br/></td></tr>
<tr class="separator:gaac2dbd1c1a98436938c5d0d6248cb700"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Driver API for Memory Card Interface using SD/MMC interface (Driver_MCI.h) </p>
<p>The <b>Memory Card Interface</b> (MCI) implements the hardware abstraction layer for Secure Digital (SD) and Multi Media Card (MMC) memory that is typically used as file storage. For embedded systems, SD/MMC devices are available as memory cards in several forms (SD, miniSD, microSD, MMC, MMCmicro) or as non-removable devic es that are directly soldered to the PCB (eMMC).</p>
<p><b>References:</b> </p>
<ul>
<li>Wikipedia offers more information about the <a href="http://en.wikipedia.org/wiki/SD_card" target="_blank"><b>Secure Digital</b> memory</a>.</li>
<li>Wikipedia offers more information about the <a href="http://en.wikipedia.org/wiki/MultiMediaCard" target="_blank"><b>MultiMediaCard</b></a>.</li>
<li>The SD Association provides detailed documentation under <a href="http://www.sdcard.org">www.sdcard.org</a>.</li>
<li>The MultiMediaCard Association (merged with JEDEC) provides detailed documentation under <a href="http://www.jedec.org">www.jedec.org</a>.</li>
</ul>
<p><b>Block Diagram</b></p>
<p>The MCI driver allows you to exchange data of the SD/MMC memory via SD/MMC interface.</p>
<p>The following modes are supported by SD/MMC memory cards:</p>
<ul>
<li>SPI bus mode: Serial Peripheral Interface Bus supported by most microcontrollers.</li>
<li>1-bit SD/MMC Bus mode: proprietary data transfer protocol supported by SD/MMC interfaces.</li>
<li>4-bit SD/MMC Bus mode: high-speed version of the SD/MMC interface using 4 data I/O pins.</li>
<li>8-bit SD/MMC Bus mode: high-speed version of the SD/MMC interface using 8 data I/O pins.</li>
</ul>
<div class="image">
<img src="SPI_BusMode.png" alt="SPI_BusMode.png"/>
<div class="caption">
SD memory connected via SPI interface</div></div>
<p> </p>
<div class="image">
<img src="SD_1BitBusMode.png" alt="SD_1BitBusMode.png"/>
<div class="caption">
SD memory connected via 1-bit SD Bus Mode</div></div>
<p> </p>
<div class="image">
<img src="SD_4BitBusMode.png" alt="SD_4BitBusMode.png"/>
<div class="caption">
SD memory connected via 4-bit SD Bus Mode</div></div>
<p><b>MCI API</b></p>
<p>The following header files define the Application Programming Interface (API) for the MCI interface:</p>
<ul>
<li><b>Driver_MCI.h</b> : Driver API for Memory Card Interface using SD/MMC interface</li>
</ul>
<p>The driver implementation is a typical part of the Device Family Pack (DFP) that supports the peripherals of the microcontroller family.</p>
<dl class="section note"><dt>Note</dt><dd>For parameters, the value marked with (default) is the setting after the driver initialization.</dd></dl>
<p><b>Driver Functions</b></p>
<p>The driver functions are published in the access struct as explained in <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a></p>
<ul>
<li><a class="el" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> : access struct for MCI driver functions</li>
</ul>
<p><b>Example Code</b></p>
<p>The following example code shows the usage of the MCI interface.</p>
<div class="fragment"><div class="line"></div>
<div class="line"><span class="preprocessor">#include "<a class="code" href="Driver__MCI_8h.html">Driver_MCI.h</a>"</span></div>
<div class="line"></div>
<div class="line"></div>
<div class="line"><span class="comment">/* Usage example: ARM_MCI_Initialize ----------------------------------------*/</span></div>
<div class="line"></div>
<div class="line"><span class="comment">// ARM_MCI_SignalEvent callback function prototype</span></div>
<div class="line"><span class="keywordtype">void</span> MCI_SignalEvent_Callback (uint32_t event);</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> init_driver (<a class="code" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv) {</div>
<div class="line"> int32_t status;</div>
<div class="line"> </div>
<div class="line"> status = drv-><a class="code" href="group__mci__interface__gr.html#ae51ec82c310aff0edda6220f9ebfd822">Initialize</a> (&MCI_SignalEvent_Callback);</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
<div class="line"> <span class="comment">// Initialization and event callback registration failed</span></div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="comment">/* Usage example: ARM_MCI_Uninitialize --------------------------------------*/</span></div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> uninit_driver (<a class="code" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv) {</div>
<div class="line"> int32_t status;</div>
<div class="line"> </div>
<div class="line"> status = drv-><a class="code" href="group__mci__interface__gr.html#adcf20681a1402869ecb5c6447fada17b">Uninitialize</a> ();</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (status == <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
<div class="line"> <span class="comment">// Driver successfully uninitialized</span></div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="comment">/* Usage example: ARM_MCI_PowerControl --------------------------------------*/</span></div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> control_driver_power (<a class="code" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv, <span class="keywordtype">bool</span> enable) {</div>
<div class="line"> int32_t status;</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (enable == <span class="keyword">true</span>) {</div>
<div class="line"> status = drv-><a class="code" href="group__mci__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> (<a class="code" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a>);</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">else</span> {</div>
<div class="line"> status = drv-><a class="code" href="group__mci__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> (<a class="code" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35">ARM_POWER_OFF</a>);</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (status == <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
<div class="line"> <span class="comment">// Driver power enabled/disabled</span></div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="comment">/* Usage example: ARM_MCI_CardPower -----------------------------------------*/</span></div>
<div class="line"></div>
<div class="line"><a class="code" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a> drv_capabilities;</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> set_card_vdd_3v3 (<a class="code" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv) {</div>
<div class="line"> int32_t status;</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (drv_capabilities.<a class="code" href="group__mci__interface__gr.html#a414baec222a72be862e262f02b821dce">vdd</a> == 1U) {</div>
<div class="line"> <span class="comment">// Power switching to 3.3V supported</span></div>
<div class="line"> status = drv-><a class="code" href="group__mci__interface__gr.html#a73334c737658b227ef3097343d5c78bb">CardPower</a> (<a class="code" href="group__mci__card__power__ctrls.html#ga565ecd36c8d0379fb4172da577cc540d">ARM_MCI_POWER_VDD_3V3</a>);</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (status == <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
<div class="line"> <span class="comment">// Card power set to 3.3V</span></div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="comment">/* Usage example: ARM_MCI_ReadCD --------------------------------------------*/</span></div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> read_card_detect_state (<a class="code" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv) {</div>
<div class="line"> int32_t status;</div>
<div class="line"> </div>
<div class="line"> status = drv-><a class="code" href="group__mci__interface__gr.html#aa4285dd6b0f9b8ca41b6710a478ad641">ReadCD</a>();</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (status == 1) {</div>
<div class="line"> <span class="comment">// Memory card is detected</span></div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">else</span> {</div>
<div class="line"> <span class="keywordflow">if</span> (status == 0) {</div>
<div class="line"> <span class="comment">// Memory card is not detected</span></div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">else</span> {</div>
<div class="line"> <span class="comment">// Error reading card detect pin state</span></div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="comment">/* Usage example: ARM_MCI_ReadWP --------------------------------------------*/</span></div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> read_write_protect_state (<a class="code" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv) {</div>
<div class="line"> int32_t status;</div>
<div class="line"> </div>
<div class="line"> status = drv-><a class="code" href="group__mci__interface__gr.html#aee6f8b38f83a51ac05cc4841524b708d">ReadWP</a>();</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (status == 1) {</div>
<div class="line"> <span class="comment">// Memory card write protection is enabled</span></div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">else</span> {</div>
<div class="line"> <span class="keywordflow">if</span> (status == 0) {</div>
<div class="line"> <span class="comment">// Memory card write protection is disabled</span></div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">else</span> {</div>
<div class="line"> <span class="comment">// Error reading write protect pin state</span></div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="comment">/* Usage example: ARM_MCI_SendCommand ---------------------------------------*/</span></div>
<div class="line"></div>
<div class="line"><span class="keyword">volatile</span> uint32_t MCI_Events;</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> MCI_SignalEvent_Callback (uint32_t event) {</div>
<div class="line"> <span class="comment">// Save current event</span></div>
<div class="line"> MCI_Events |= event;</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> send_CMD0 (<a class="code" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv) {</div>
<div class="line"> int32_t status;</div>
<div class="line"> uint32_t cmd;</div>
<div class="line"></div>
<div class="line"> MCI_Events = 0U; <span class="comment">//Clear MCI driver event flags</span></div>
<div class="line"> cmd = 0U; <span class="comment">// Set GO_IDLE_STATE command code</span></div>
<div class="line"></div>
<div class="line"> status = drv-><a class="code" href="group__mci__interface__gr.html#affefb5c1d352082933c2fb0620b37212">SendCommand</a> (cmd, 0U, <a class="code" href="group__mci__send__command__flags__ctrls.html#ga81606bd94ce782e2c3764b913f929f60">ARM_MCI_CARD_INITIALIZE</a> | <a class="code" href="group__mci__send__command__flags__ctrls.html#ga70934cef80884e8c75fb4eebf8452118">ARM_MCI_RESPONSE_NONE</a>, NULL);</div>
<div class="line"></div>
<div class="line"> <span class="keywordflow">if</span> (status == <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
<div class="line"> <span class="comment">/* Wait for event */</span></div>
<div class="line"> <span class="keywordflow">while</span> ((MCI_Events & <a class="code" href="group__mci__event__gr.html#gae69356c75d55103d93ef91ac1bc02b49">ARM_MCI_EVENT_COMMAND_COMPLETE</a>) == 0U);</div>
<div class="line"> <span class="comment">// Command was successfully sent to memory card</span></div>
<div class="line"> <span class="comment">// ..</span></div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">else</span> {</div>
<div class="line"> <span class="comment">// Error</span></div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="comment">/* Usage example: ARM_MCI_SetupTransfer -------------------------------------*/</span></div>
<div class="line"></div>
<div class="line"><span class="keyword">volatile</span> uint32_t MCI_Events;</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> MCI_SignalEvent_Callback (uint32_t event) {</div>
<div class="line"> MCI_Events |= event; <span class="comment">// Save current event</span></div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> read_sector (<a class="code" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv, uint8_t *buf, uint32_t sz) {</div>
<div class="line"> int32_t status;</div>
<div class="line"> uint32_t cmd, arg;</div>
<div class="line"> uint32_t resp;</div>
<div class="line"></div>
<div class="line"> <span class="keywordflow">if</span> (sz < 512U) {</div>
<div class="line"> <span class="comment">// Invalid buffer size, sector consists of 512 bytes</span></div>
<div class="line"> <span class="comment">//...</span></div>
<div class="line"> }</div>
<div class="line"></div>
<div class="line"> status = drv-><a class="code" href="group__mci__interface__gr.html#adc63bab660e8304d78faa1ac429e792b">SetupTransfer</a> (buf, 1U, 512U, <a class="code" href="group__mci__transfer__ctrls.html#gaa6f3be235a9dce5c66be8fe64f399846">ARM_MCI_TRANSFER_READ</a> | <a class="code" href="group__mci__transfer__ctrls.html#ga4ced782e7c0c70d5f0edbddd1e48323b">ARM_MCI_TRANSFER_BLOCK</a>);</div>
<div class="line"></div>
<div class="line"> <span class="keywordflow">if</span> (status == <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
<div class="line"> MCI_Events = 0U; <span class="comment">//Clear MCI driver event flags</span></div>
<div class="line"></div>
<div class="line"> cmd = 17U; <span class="comment">// Set READ_SINGLE_BLOCK command</span></div>
<div class="line"> arg = 0U; <span class="comment">// Set sector number</span></div>
<div class="line"></div>
<div class="line"> status = drv-><a class="code" href="group__mci__interface__gr.html#affefb5c1d352082933c2fb0620b37212">SendCommand</a> (cmd, arg, <a class="code" href="group__mci__send__command__flags__ctrls.html#gaa5ddf1cf772b234e3c247039effd0e7b">ARM_MCI_RESPONSE_SHORT</a> | <a class="code" href="group__mci__send__command__flags__ctrls.html#ga6ab3f4c1a2bf0fdb81fbcf7a5698f2de">ARM_MCI_RESPONSE_CRC</a> | <a class="code" href="group__mci__send__command__flags__ctrls.html#ga8aa566f69aa74ed416213df6ca3267bd">ARM_MCI_TRANSFER_DATA</a>, &resp);</div>
<div class="line"></div>
<div class="line"> <span class="keywordflow">if</span> (status == <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
<div class="line"> <span class="comment">/* Wait for event */</span></div>
<div class="line"> <span class="keywordflow">while</span> ((MCI_Events & <a class="code" href="group__mci__event__gr.html#gae69356c75d55103d93ef91ac1bc02b49">ARM_MCI_EVENT_COMMAND_COMPLETE</a>) == 0U);</div>
<div class="line"> <span class="comment">// Command was successfully sent to memory card</span></div>
<div class="line"> <span class="keywordflow">if</span> ((resp & 0x03U) == 0U) {</div>
<div class="line"> <span class="comment">// Sector number is valid, wait until data transfer completes</span></div>
<div class="line"> <span class="keywordflow">while</span> ((MCI_Events & <a class="code" href="group__mci__event__gr.html#gabc3c468dedaed890683360f2c5c65bea">ARM_MCI_EVENT_TRANSFER_COMPLETE</a>) == 0U);</div>
<div class="line"> <span class="comment">// Data was successfully read from memory card</span></div>
<div class="line"> <span class="comment">// ...</span></div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="comment">/* Usage example: ARM_MCI_AbortTransfer -------------------------------------*/</span></div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> abort_data_transfer (<a class="code" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv) {</div>
<div class="line"> <a class="code" href="group__mci__interface__gr.html#structARM__MCI__STATUS">ARM_MCI_STATUS</a> drv_status;</div>
<div class="line"></div>
<div class="line"> drv_status = drv-><a class="code" href="group__mci__interface__gr.html#a2dc63353d6869c0ea2d3d29155c88b49">GetStatus</a>();</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (drv_status.<a class="code" href="group__mci__interface__gr.html#a2655d3422b720097b091a28e8bbcea8f">transfer_active</a> == 1U) {</div>
<div class="line"> <span class="comment">// Data transfer is active, abort the transfer</span></div>
<div class="line"> <span class="keywordflow">if</span> (drv-><a class="code" href="group__mci__interface__gr.html#afa8103cc20ba96420b7471455bbb87e4">AbortTransfer</a>() == <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
<div class="line"> <span class="comment">// Transfer aborted</span></div>
<div class="line"> <span class="comment">// ...</span></div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="comment">/* Usage example: ARM_MCI_GetStatus -----------------------------------------*/</span></div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> check_transfer_status (<a class="code" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv) {</div>
<div class="line"> <a class="code" href="group__mci__interface__gr.html#structARM__MCI__STATUS">ARM_MCI_STATUS</a> drv_status;</div>
<div class="line"></div>
<div class="line"> drv_status = drv-><a class="code" href="group__mci__interface__gr.html#a2dc63353d6869c0ea2d3d29155c88b49">GetStatus</a>();</div>
<div class="line"></div>
<div class="line"> <span class="keywordflow">if</span> (drv_status.<a class="code" href="group__mci__interface__gr.html#a2655d3422b720097b091a28e8bbcea8f">transfer_active</a> == 1U) {</div>
<div class="line"> <span class="comment">// Data transfer is active</span></div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (drv_status.<a class="code" href="group__mci__interface__gr.html#a598ae4a196316d6dcb97d07fd337ecdd">transfer_timeout</a> == 1U) {</div>
<div class="line"> <span class="comment">// Data not received, timeout expired</span></div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (drv_status.<a class="code" href="group__mci__interface__gr.html#a21d4bc1a03e161bd33693619039a6afa">transfer_error</a> == 1U) {</div>
<div class="line"> <span class="comment">// Data transfer ended with error</span></div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="comment">/* Usage example: ARM_MCI_SignalEvent ---------------------------------------*/</span></div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> MCI_SignalEvent_Callback (uint32_t event) {</div>
<div class="line"> <span class="keywordflow">if</span> ((event & <a class="code" href="group__mci__event__gr.html#gae2cf8ef238c092e94e96a01602f3a23c">ARM_MCI_EVENT_CARD_INSERTED</a>) != 0U) {</div>
<div class="line"> <span class="comment">// Memory card was inserted into socket</span></div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">if</span> ((event & <a class="code" href="group__mci__event__gr.html#ga92ba748f9324ec13898f10456f17c8cc">ARM_MCI_EVENT_CARD_REMOVED</a>) != 0U) {</div>
<div class="line"> <span class="comment">// Memory card was removed from socket</span></div>
<div class="line"> }</div>
<div class="line"></div>
<div class="line"> <span class="keywordflow">if</span> ((event & ARM_MCI_EVENT_COMMAND_COMPLETE) != 0U) {</div>
<div class="line"> <span class="comment">// Command was successfully sent to memory card</span></div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">if</span> ((event & <a class="code" href="group__mci__event__gr.html#gab79b3ab4dcd03c38df1e173fa903d822">ARM_MCI_EVENT_COMMAND_TIMEOUT</a>) != 0U) {</div>
<div class="line"> <span class="comment">// Command response was not received in time</span></div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">if</span> ((event & <a class="code" href="group__mci__event__gr.html#ga373aeb3eca0e4c6d159312488a130442">ARM_MCI_EVENT_COMMAND_ERROR</a>) != 0U) {</div>
<div class="line"> <span class="comment">// Command response was invalid</span></div>
<div class="line"> }</div>
<div class="line"></div>
<div class="line"> <span class="keywordflow">if</span> ((event & <a class="code" href="group__mci__event__gr.html#gabc3c468dedaed890683360f2c5c65bea">ARM_MCI_EVENT_TRANSFER_COMPLETE</a>) != 0U) {</div>
<div class="line"> <span class="comment">// Data successfully transferred from/to memory card</span></div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">if</span> ((event & <a class="code" href="group__mci__event__gr.html#ga614e7c7226adbaa8ec4165bf8b87ef27">ARM_MCI_EVENT_TRANSFER_TIMEOUT</a>) != 0U) {</div>
<div class="line"> <span class="comment">// Data not transferred from/to memory card, timeout expired</span></div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">if</span> ((event & <a class="code" href="group__mci__event__gr.html#ga5d2cee5ba6d0e40ad505983155706c29">ARM_MCI_EVENT_TRANSFER_ERROR</a>) != 0U) {</div>
<div class="line"> <span class="comment">// Data transfer ended with errors</span></div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> ((event & <a class="code" href="group__mci__event__gr.html#ga75a050fdfe04e6816e96c938d6a6c197">ARM_MCI_EVENT_SDIO_INTERRUPT</a>) != 0U) {</div>
<div class="line"> <span class="comment">// SD I/O card sent interrupt request</span></div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> ((event & <a class="code" href="group__mci__event__gr.html#ga8161f3960ddf2a3cdc3c4c83148c6099">ARM_MCI_EVENT_CCS</a>) != 0U) {</div>
<div class="line"> <span class="comment">// CE-ATA command completion signal received</span></div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">if</span> ((event & <a class="code" href="group__mci__event__gr.html#gafa8cbcd597a05c64901eeb777cc0b74f">ARM_MCI_EVENT_CCS_TIMEOUT</a>) != 0U) {</div>
<div class="line"> <span class="comment">// CE-ATA command completion signal wait timeout expired</span></div>
<div class="line"> }</div>
<div class="line">}</div>
</div><!-- fragment --> <hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structARM__DRIVER__MCI" id="structARM__DRIVER__MCI"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_DRIVER_MCI</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Access structure of the MCI Driver. </p>
<p>The functions of the MCI are accessed by function pointers exposed by this structure. Refer to <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a> for overview information.</p>
<p>Each instance of an MCI provides such an access structure. The instance is identified by a postfix number in the symbol name of the access structure, for example:</p>
<ul>
<li><b>Driver_MCI0</b> is the name of the access struct of the first instance (no. 0).</li>
<li><b>Driver_MCI1</b> is the name of the access struct of the second instance (no. 1).</li>
</ul>
<p>A configuration setting in the middleware allows connecting the middleware to a specific driver instance <b>Driver_MCI<em>n</em></b>. The default is <span class="XML-Token">0</span>, which connects a middleware to the first instance of a driver. </p>
</div><table class="memberdecls">
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
<tr class="memitem:a8834b281da48583845c044a81566c1b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#a8834b281da48583845c044a81566c1b3">GetVersion</a> )(void)</td></tr>
<tr class="memdesc:a8834b281da48583845c044a81566c1b3"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#ga3418183015dbf3025b94eebaedb00ab1">ARM_MCI_GetVersion</a> : Get driver version. <a href="#a8834b281da48583845c044a81566c1b3">More...</a><br/></td></tr>
<tr class="separator:a8834b281da48583845c044a81566c1b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5648b4224e0346ba5e20fefc7e83aee8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#a5648b4224e0346ba5e20fefc7e83aee8">GetCapabilities</a> )(void)</td></tr>
<tr class="memdesc:a5648b4224e0346ba5e20fefc7e83aee8"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#ga7e5a78b6e6409189833a0b72a0a3c48a">ARM_MCI_GetCapabilities</a> : Get driver capabilities. <a href="#a5648b4224e0346ba5e20fefc7e83aee8">More...</a><br/></td></tr>
<tr class="separator:a5648b4224e0346ba5e20fefc7e83aee8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae51ec82c310aff0edda6220f9ebfd822"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ae51ec82c310aff0edda6220f9ebfd822">Initialize</a> )(<a class="el" href="group__mci__interface__gr.html#ga0d14651f6788c1ffd81544602565faf1">ARM_MCI_SignalEvent_t</a> cb_event)</td></tr>
<tr class="memdesc:ae51ec82c310aff0edda6220f9ebfd822"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#ga6f34d4ab362e596ddaf23aac093268cf">ARM_MCI_Initialize</a> : Initialize MCI Interface. <a href="#ae51ec82c310aff0edda6220f9ebfd822">More...</a><br/></td></tr>
<tr class="separator:ae51ec82c310aff0edda6220f9ebfd822"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adcf20681a1402869ecb5c6447fada17b"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#adcf20681a1402869ecb5c6447fada17b">Uninitialize</a> )(void)</td></tr>
<tr class="memdesc:adcf20681a1402869ecb5c6447fada17b"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#gaef8183e77797e74997551d03646d42c2">ARM_MCI_Uninitialize</a> : De-initialize MCI Interface. <a href="#adcf20681a1402869ecb5c6447fada17b">More...</a><br/></td></tr>
<tr class="separator:adcf20681a1402869ecb5c6447fada17b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba8f1c8019af95ffe19c32403e3240ef"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> )(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:aba8f1c8019af95ffe19c32403e3240ef"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#ga19752749d04ed22dc91c4294645e0244">ARM_MCI_PowerControl</a> : Control MCI Interface Power. <a href="#aba8f1c8019af95ffe19c32403e3240ef">More...</a><br/></td></tr>
<tr class="separator:aba8f1c8019af95ffe19c32403e3240ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73334c737658b227ef3097343d5c78bb"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#a73334c737658b227ef3097343d5c78bb">CardPower</a> )(uint32_t voltage)</td></tr>
<tr class="memdesc:a73334c737658b227ef3097343d5c78bb"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#gab161f80e0eda2815f3e0ebbba1314ff0">ARM_MCI_CardPower</a> : Set card power supply voltage. <a href="#a73334c737658b227ef3097343d5c78bb">More...</a><br/></td></tr>
<tr class="separator:a73334c737658b227ef3097343d5c78bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa4285dd6b0f9b8ca41b6710a478ad641"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#aa4285dd6b0f9b8ca41b6710a478ad641">ReadCD</a> )(void)</td></tr>
<tr class="memdesc:aa4285dd6b0f9b8ca41b6710a478ad641"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#ga012fca8f1ce5366fce14b708c771c635">ARM_MCI_ReadCD</a> : Read Card Detect (CD) state. <a href="#aa4285dd6b0f9b8ca41b6710a478ad641">More...</a><br/></td></tr>
<tr class="separator:aa4285dd6b0f9b8ca41b6710a478ad641"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee6f8b38f83a51ac05cc4841524b708d"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#aee6f8b38f83a51ac05cc4841524b708d">ReadWP</a> )(void)</td></tr>
<tr class="memdesc:aee6f8b38f83a51ac05cc4841524b708d"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#ga3d70286918405ac81fa795c7d09dc6fd">ARM_MCI_ReadWP</a> : Read Write Protect (WP) state. <a href="#aee6f8b38f83a51ac05cc4841524b708d">More...</a><br/></td></tr>
<tr class="separator:aee6f8b38f83a51ac05cc4841524b708d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:affefb5c1d352082933c2fb0620b37212"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#affefb5c1d352082933c2fb0620b37212">SendCommand</a> )(uint32_t cmd, uint32_t arg, uint32_t flags, uint32_t *response)</td></tr>
<tr class="memdesc:affefb5c1d352082933c2fb0620b37212"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#ga5a431da89feabc2b4bc0c27943dff6f2">ARM_MCI_SendCommand</a> : Send Command to card and get the response. <a href="#affefb5c1d352082933c2fb0620b37212">More...</a><br/></td></tr>
<tr class="separator:affefb5c1d352082933c2fb0620b37212"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc63bab660e8304d78faa1ac429e792b"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#adc63bab660e8304d78faa1ac429e792b">SetupTransfer</a> )(uint8_t *data, uint32_t block_count, uint32_t block_size, uint32_t mode)</td></tr>
<tr class="memdesc:adc63bab660e8304d78faa1ac429e792b"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#gaaec681bcd8e6811c5743e33ee0f35ed1">ARM_MCI_SetupTransfer</a> : Setup data transfer operation. <a href="#adc63bab660e8304d78faa1ac429e792b">More...</a><br/></td></tr>
<tr class="separator:adc63bab660e8304d78faa1ac429e792b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afa8103cc20ba96420b7471455bbb87e4"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#afa8103cc20ba96420b7471455bbb87e4">AbortTransfer</a> )(void)</td></tr>
<tr class="memdesc:afa8103cc20ba96420b7471455bbb87e4"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#ga3dfcf7b7186b711f9b63a096be816fe5">ARM_MCI_AbortTransfer</a> : Abort current data transfer. <a href="#afa8103cc20ba96420b7471455bbb87e4">More...</a><br/></td></tr>
<tr class="separator:afa8103cc20ba96420b7471455bbb87e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e0f47a92f626a971c5197fca6545505"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a> )(uint32_t control, uint32_t arg)</td></tr>
<tr class="memdesc:a6e0f47a92f626a971c5197fca6545505"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30">ARM_MCI_Control</a> : Control MCI Interface. <a href="#a6e0f47a92f626a971c5197fca6545505">More...</a><br/></td></tr>
<tr class="separator:a6e0f47a92f626a971c5197fca6545505"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2dc63353d6869c0ea2d3d29155c88b49"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__mci__interface__gr.html#structARM__MCI__STATUS">ARM_MCI_STATUS</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#a2dc63353d6869c0ea2d3d29155c88b49">GetStatus</a> )(void)</td></tr>
<tr class="memdesc:a2dc63353d6869c0ea2d3d29155c88b49"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#ga8d61aa42ce78d1864fa928c1f273cbd9">ARM_MCI_GetStatus</a> : Get MCI status. <a href="#a2dc63353d6869c0ea2d3d29155c88b49">More...</a><br/></td></tr>
<tr class="separator:a2dc63353d6869c0ea2d3d29155c88b49"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h4 class="groupheader">Field Documentation</h4>
<a class="anchor" id="a8834b281da48583845c044a81566c1b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* GetVersion)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__mci__interface__gr.html#ga3418183015dbf3025b94eebaedb00ab1">ARM_MCI_GetVersion</a> : Get driver version. </p>
</div>
</div>
<a class="anchor" id="a5648b4224e0346ba5e20fefc7e83aee8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a>(* GetCapabilities)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__mci__interface__gr.html#ga7e5a78b6e6409189833a0b72a0a3c48a">ARM_MCI_GetCapabilities</a> : Get driver capabilities. </p>
</div>
</div>
<a class="anchor" id="ae51ec82c310aff0edda6220f9ebfd822"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Initialize)(<a class="el" href="group__mci__interface__gr.html#ga0d14651f6788c1ffd81544602565faf1">ARM_MCI_SignalEvent_t</a> cb_event)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__mci__interface__gr.html#ga6f34d4ab362e596ddaf23aac093268cf">ARM_MCI_Initialize</a> : Initialize MCI Interface. </p>
</div>
</div>
<a class="anchor" id="adcf20681a1402869ecb5c6447fada17b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Uninitialize)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__mci__interface__gr.html#gaef8183e77797e74997551d03646d42c2">ARM_MCI_Uninitialize</a> : De-initialize MCI Interface. </p>
</div>
</div>
<a class="anchor" id="aba8f1c8019af95ffe19c32403e3240ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* PowerControl)(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__mci__interface__gr.html#ga19752749d04ed22dc91c4294645e0244">ARM_MCI_PowerControl</a> : Control MCI Interface Power. </p>
</div>
</div>
<a class="anchor" id="a73334c737658b227ef3097343d5c78bb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* CardPower)(uint32_t voltage)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__mci__interface__gr.html#gab161f80e0eda2815f3e0ebbba1314ff0">ARM_MCI_CardPower</a> : Set card power supply voltage. </p>
</div>
</div>
<a class="anchor" id="aa4285dd6b0f9b8ca41b6710a478ad641"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* ReadCD)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__mci__interface__gr.html#ga012fca8f1ce5366fce14b708c771c635">ARM_MCI_ReadCD</a> : Read Card Detect (CD) state. </p>
</div>
</div>
<a class="anchor" id="aee6f8b38f83a51ac05cc4841524b708d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* ReadWP)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__mci__interface__gr.html#ga3d70286918405ac81fa795c7d09dc6fd">ARM_MCI_ReadWP</a> : Read Write Protect (WP) state. </p>
</div>
</div>
<a class="anchor" id="affefb5c1d352082933c2fb0620b37212"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SendCommand)(uint32_t cmd, uint32_t arg, uint32_t flags, uint32_t *response)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__mci__interface__gr.html#ga5a431da89feabc2b4bc0c27943dff6f2">ARM_MCI_SendCommand</a> : Send Command to card and get the response. </p>
</div>
</div>
<a class="anchor" id="adc63bab660e8304d78faa1ac429e792b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SetupTransfer)(uint8_t *data, uint32_t block_count, uint32_t block_size, uint32_t mode)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__mci__interface__gr.html#gaaec681bcd8e6811c5743e33ee0f35ed1">ARM_MCI_SetupTransfer</a> : Setup data transfer operation. </p>
</div>
</div>
<a class="anchor" id="afa8103cc20ba96420b7471455bbb87e4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* AbortTransfer)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__mci__interface__gr.html#ga3dfcf7b7186b711f9b63a096be816fe5">ARM_MCI_AbortTransfer</a> : Abort current data transfer. </p>
</div>
</div>
<a class="anchor" id="a6e0f47a92f626a971c5197fca6545505"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Control)(uint32_t control, uint32_t arg)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30">ARM_MCI_Control</a> : Control MCI Interface. </p>
</div>
</div>
<a class="anchor" id="a2dc63353d6869c0ea2d3d29155c88b49"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__mci__interface__gr.html#structARM__MCI__STATUS">ARM_MCI_STATUS</a>(* GetStatus)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__mci__interface__gr.html#ga8d61aa42ce78d1864fa928c1f273cbd9">ARM_MCI_GetStatus</a> : Get MCI status. </p>
</div>
</div>
</div>
</div>
<a name="structARM__MCI__CAPABILITIES" id="structARM__MCI__CAPABILITIES"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_MCI_CAPABILITIES</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>MCI Driver Capabilities. </p>
<p>A MCI driver can be implemented with different capabilities. The data fields of this struct encode the capabilities implemented by this driver.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__mci__interface__gr.html#ga7e5a78b6e6409189833a0b72a0a3c48a">ARM_MCI_GetCapabilities</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="af47e73979b028c86c7c1fbe39b095140"></a>uint32_t</td>
<td class="fieldname">
cd_state: 1</td>
<td class="fielddoc">
Card Detect State available. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="abcabfa504d3226c723d9bf5debe2f164"></a>uint32_t</td>
<td class="fieldname">
cd_event: 1</td>
<td class="fielddoc">
Signal Card Detect change event. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a02df0162d3a653c36158a7b6a76f6175"></a>uint32_t</td>
<td class="fieldname">
wp_state: 1</td>
<td class="fielddoc">
Write Protect State available. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a414baec222a72be862e262f02b821dce"></a>uint32_t</td>
<td class="fieldname">
vdd: 1</td>
<td class="fielddoc">
Supports VDD Card Power Supply Control. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="abeb0330f882ebed8cabde782652233dd"></a>uint32_t</td>
<td class="fieldname">
vdd_1v8: 1</td>
<td class="fielddoc">
Supports 1.8 VDD Card Power Supply. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ab1cdfce6eb051bed7b904e0fd1719afa"></a>uint32_t</td>
<td class="fieldname">
vccq: 1</td>
<td class="fielddoc">
Supports VCCQ Card Power Supply Control (eMMC) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a1896a7548bb6fab285f23cc0d0b23d7d"></a>uint32_t</td>
<td class="fieldname">
vccq_1v8: 1</td>
<td class="fielddoc">
Supports 1.8 VCCQ Card Power Supply (eMMC) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="af4f95215005e38700ef527714932b361"></a>uint32_t</td>
<td class="fieldname">
vccq_1v2: 1</td>
<td class="fielddoc">
Supports 1.2 VCCQ Card Power Supply (eMMC) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a950669a8c88b49c8da4c56163b45a79d"></a>uint32_t</td>
<td class="fieldname">
data_width_4: 1</td>
<td class="fielddoc">
Supports 4-bit data. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a808703d6c70a501464e156e55f5cabd2"></a>uint32_t</td>
<td class="fieldname">
data_width_8: 1</td>
<td class="fielddoc">
Supports 8-bit data. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="abb1a604b0ee4f7e3510409747890e41e"></a>uint32_t</td>
<td class="fieldname">
data_width_4_ddr: 1</td>
<td class="fielddoc">
Supports 4-bit data, DDR (Dual Data Rate) - MMC only. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="acd5f6dce3a548d12c292e8cd17e4e9e2"></a>uint32_t</td>
<td class="fieldname">
data_width_8_ddr: 1</td>
<td class="fielddoc">
Supports 8-bit data, DDR (Dual Data Rate) - MMC only. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a83ecf7d4472c55362750ef72d8f8f47d"></a>uint32_t</td>
<td class="fieldname">
high_speed: 1</td>
<td class="fielddoc">
Supports SD/MMC High Speed Mode. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a084188480d589cdc8d3e164b9f41bea9"></a>uint32_t</td>
<td class="fieldname">
uhs_signaling: 1</td>
<td class="fielddoc">
Supports SD UHS-I (Ultra High Speed) 1.8V signaling. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a617bf7fb73b49a20398b90098ecc3ec0"></a>uint32_t</td>
<td class="fieldname">
uhs_tuning: 1</td>
<td class="fielddoc">
Supports SD UHS-I tuning. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a5c3dcb2f8aa6f65408d9a6741abb7b3e"></a>uint32_t</td>
<td class="fieldname">
uhs_sdr50: 1</td>
<td class="fielddoc">
Supports SD UHS-I SDR50 (Single Data Rate) up to 50MB/s. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ae07ceef1800252495a79f225142740e7"></a>uint32_t</td>
<td class="fieldname">
uhs_sdr104: 1</td>
<td class="fielddoc">
Supports SD UHS-I SDR104 (Single Data Rate) up to 104MB/s. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a1ee73c19020d5f1bedf7c013d0e5f730"></a>uint32_t</td>
<td class="fieldname">
uhs_ddr50: 1</td>
<td class="fielddoc">
Supports SD UHS-I DDR50 (Dual Data Rate) up to 50MB/s. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="afe5de4fdc6657aa19fa87577a8d460e5"></a>uint32_t</td>
<td class="fieldname">
uhs_driver_type_a: 1</td>
<td class="fielddoc">
Supports SD UHS-I Driver Type A. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a3c3df9641e7216dd20d3bc395dc4948f"></a>uint32_t</td>
<td class="fieldname">
uhs_driver_type_c: 1</td>
<td class="fielddoc">
Supports SD UHS-I Driver Type C. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a639bebbcb9a3a743f4f232fec82e2bfc"></a>uint32_t</td>
<td class="fieldname">
uhs_driver_type_d: 1</td>
<td class="fielddoc">
Supports SD UHS-I Driver Type D. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a61e2a440b27d7d22c866ad4427f4b825"></a>uint32_t</td>
<td class="fieldname">
sdio_interrupt: 1</td>
<td class="fielddoc">
Supports SD I/O Interrupt. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a5e38e4ee9cebcc99904e287adc8e6217"></a>uint32_t</td>
<td class="fieldname">
read_wait: 1</td>
<td class="fielddoc">
Supports Read Wait (SD I/O) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="abb03f0187e4658f417b5a24cac33eed9"></a>uint32_t</td>
<td class="fieldname">
suspend_resume: 1</td>
<td class="fielddoc">
Supports Suspend/Resume (SD I/O) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a3303194ea68bd1094841d4f958f6dbbf"></a>uint32_t</td>
<td class="fieldname">
mmc_interrupt: 1</td>
<td class="fielddoc">
Supports MMC Interrupt. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a072a194948489d4dbd2409b94fdca56b"></a>uint32_t</td>
<td class="fieldname">
mmc_boot: 1</td>
<td class="fielddoc">
Supports MMC Boot. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a2e8bd27f2c5c3093c4fec557890b97d4"></a>uint32_t</td>
<td class="fieldname">
rst_n: 1</td>
<td class="fielddoc">
Supports RST_n Pin Control (eMMC) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a13c956ba993083f1e59379968e2badbe"></a>uint32_t</td>
<td class="fieldname">
ccs: 1</td>
<td class="fielddoc">
Supports Command Completion Signal (CCS) for CE-ATA. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a9739c230a13b46482feb5475d257e482"></a>uint32_t</td>
<td class="fieldname">
ccs_timeout: 1</td>
<td class="fielddoc">
Supports Command Completion Signal (CCS) timeout for CE-ATA. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 3</td>
<td class="fielddoc">
Reserved (must be zero) </td></tr>
</table>
</div>
</div>
<a name="structARM__MCI__STATUS" id="structARM__MCI__STATUS"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_MCI_STATUS</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>MCI Status. </p>
<p>Structure with information about the status of the MCI.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__mci__interface__gr.html#ga8d61aa42ce78d1864fa928c1f273cbd9">ARM_MCI_GetStatus</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa22ef7c7597e90835bd67d5795ba757e"></a>uint32_t</td>
<td class="fieldname">
command_active: 1</td>
<td class="fielddoc">
Command active flag. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a56e426979c3872254c156e9ae7eead5b"></a>uint32_t</td>
<td class="fieldname">
command_timeout: 1</td>
<td class="fielddoc">
Command timeout flag (cleared on start of next command) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="afca11cd2ce661c67455a6d75328848cc"></a>uint32_t</td>
<td class="fieldname">
command_error: 1</td>
<td class="fielddoc">
Command error flag (cleared on start of next command) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a2655d3422b720097b091a28e8bbcea8f"></a>uint32_t</td>
<td class="fieldname">
transfer_active: 1</td>
<td class="fielddoc">
Transfer active flag. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a598ae4a196316d6dcb97d07fd337ecdd"></a>uint32_t</td>
<td class="fieldname">
transfer_timeout: 1</td>
<td class="fielddoc">
Transfer timeout flag (cleared on start of next command) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a21d4bc1a03e161bd33693619039a6afa"></a>uint32_t</td>
<td class="fieldname">
transfer_error: 1</td>
<td class="fielddoc">
Transfer error flag (cleared on start of next command) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a61e2a440b27d7d22c866ad4427f4b825"></a>uint32_t</td>
<td class="fieldname">
sdio_interrupt: 1</td>
<td class="fielddoc">
SD I/O Interrupt flag (cleared on start of monitoring) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a13c956ba993083f1e59379968e2badbe"></a>uint32_t</td>
<td class="fieldname">
ccs: 1</td>
<td class="fielddoc">
CCS flag (cleared on start of next command) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 24</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga0d14651f6788c1ffd81544602565faf1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ARM_MCI_SignalEvent_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> : Signal MCI Card Event. </p>
<p>Provides the typedef for the callback function <a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__mci__interface__gr.html#ga6f34d4ab362e596ddaf23aac093268cf">ARM_MCI_Initialize</a> </li>
</ul>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga3418183015dbf3025b94eebaedb00ab1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> ARM_MCI_GetVersion </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get driver version. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></dd></dl>
<p>The function <b>ARM_MCI_GetVersion</b> returns version information of the driver implementation in <a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></p>
<ul>
<li>API version is the version of the CMSIS-Driver specification used to implement this driver.</li>
<li>Driver version is source code version of the actual driver implementation.</li>
</ul>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> Driver_MCI0;</div>
<div class="line"><a class="code" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv_info;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> setup_mci (<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> version;</div>
<div class="line"> </div>
<div class="line"> drv_info = &Driver_MCI0;</div>
<div class="line"> version = drv_info-><a class="code" href="group__mci__interface__gr.html#a8834b281da48583845c044a81566c1b3">GetVersion</a> ();</div>
<div class="line"> <span class="keywordflow">if</span> (version.<a class="code" href="group__common__drv__gr.html#ad180da20fbde1d3dafc074af87c19540">api</a> < 0x10A) { <span class="comment">// requires at minimum API version 1.10 or higher</span></div>
<div class="line"> <span class="comment">// error handling</span></div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga7e5a78b6e6409189833a0b72a0a3c48a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a> ARM_MCI_GetCapabilities </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get driver capabilities. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a></dd></dl>
<p>The function <b>ARM_MCI_GetCapabilities</b> returns information about capabilities in this driver implementation. The data fields of the structure <a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a> encode various capabilities, for example supported bus modes ...</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> Driver_MCI0;</div>
<div class="line"><a class="code" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv_info;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> read_capabilities (<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a> drv_capabilities;</div>
<div class="line"> </div>
<div class="line"> drv_info = &Driver_MCI0; </div>
<div class="line"> drv_capabilities = drv_info-><a class="code" href="group__mci__interface__gr.html#a5648b4224e0346ba5e20fefc7e83aee8">GetCapabilities</a> ();</div>
<div class="line"> <span class="comment">// interrogate capabilities</span></div>
<div class="line"> </div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga6f34d4ab362e596ddaf23aac093268cf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_MCI_Initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__mci__interface__gr.html#ga0d14651f6788c1ffd81544602565faf1">ARM_MCI_SignalEvent_t</a> </td>
<td class="paramname"><em>cb_event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the Memory Card Interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cb_event</td><td>Pointer to <a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_MCI_Initialize</b> initializes the MCI interface. It is called when the middleware component starts operation.</p>
<p>The function performs the following operations:</p>
<ul>
<li>Initializes the resources needed for the MCI interface.</li>
<li>Registers the <a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> callback function.</li>
</ul>
<p>The parameter <em>cb_event</em> is a pointer to the <a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> callback function; use a NULL pointer when no callback signals are required.</p>
<p><b>Example:</b> </p>
<ul>
<li>see <a class="el" href="group__mci__interface__gr.html">MCI Interface</a> - Driver Functions </li>
</ul>
</div>
</div>
<a class="anchor" id="gaef8183e77797e74997551d03646d42c2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_MCI_Uninitialize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>De-initialize Memory Card Interface. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_MCI_Uninitialize</b> de-initializes the resources of I2C interface.</p>
<p>It is called when the middleware component stops operation and releases the software resources used by the interface. </p>
</div>
</div>
<a class="anchor" id="ga19752749d04ed22dc91c4294645e0244"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_MCI_PowerControl </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> </td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control Memory Card Interface Power. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>Power state <a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_MCI_PowerControl</b> operates the power modes of the MCI interface.</p>
<p>The parameter <em>state</em> can have the following values:</p>
<ul>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a> : set-up peripheral for data transfers, enable interrupts (NVIC) and optionally DMA. Can be called multiple times. If the peripheral is already in this mode, then the function performs no operation and returns with <a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>.</li>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5a9ef9e57cbcc948d0e22314e73dc8c434">ARM_POWER_LOW</a> : may use power saving. Returns <a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> when not implemented.</li>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35">ARM_POWER_OFF</a> : terminates any pending data transfers, disables peripheral, disables related interrupts and DMA.</li>
</ul>
<p>Refer to <a class="el" href="theoryOperation.html#CallSequence">Function Call Sequence</a> for more information. </p>
</div>
</div>
<a class="anchor" id="gab161f80e0eda2815f3e0ebbba1314ff0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_MCI_CardPower </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>voltage</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Memory Card Power supply voltage. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">voltage</td><td>Memory Card Power supply voltage </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_MCI_CardPower</b> operates the memory card power supply voltage.</p>
<p>The parameter <em>voltage</em> sets the voltage. Not every voltage might be supported by the driver implementation. The structure <a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a> encodes the supported voltage. Retrieve the information with the function <a class="el" href="group__mci__interface__gr.html#ga7e5a78b6e6409189833a0b72a0a3c48a">ARM_MCI_GetCapabilities</a> and verify the data fields.</p>
<p>The following values:</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>voltage</em> </th><th align="left">Description </th><th>supported when <a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES" title="MCI Driver Capabilities. ">ARM_MCI_CAPABILITIES</a> </th></tr>
<tr>
<td align="left"><a class="el" href="group__mci__card__power__ctrls.html#ga288fbd80b384739a80e8f3ec31205cf5">ARM_MCI_POWER_VDD_OFF</a> </td><td align="left">VDD (VCC) turned off </td><td><em>always supported</em> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__card__power__ctrls.html#ga565ecd36c8d0379fb4172da577cc540d">ARM_MCI_POWER_VDD_3V3</a> </td><td align="left">VDD (VCC) = <span class="XML-Token">3.3V</span> </td><td>data field <em>vdd</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__card__power__ctrls.html#ga2ce8e379c3691da3b51c9c97d61770ef">ARM_MCI_POWER_VDD_1V8</a> </td><td align="left">VDD (VCC) = <span class="XML-Token">1.8V</span> </td><td>data field <em>vdd_1v8</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__card__power__ctrls.html#ga6929c98a6bc8d898939a95111509220b">ARM_MCI_POWER_VCCQ_OFF</a> </td><td align="left">eMMC VCCQ turned off </td><td><em>always supported</em> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__card__power__ctrls.html#ga91a7201173cc092eaf7f0bcee028871e">ARM_MCI_POWER_VCCQ_3V3</a> </td><td align="left">eMMC VCCQ = <span class="XML-Token">3.3V</span> </td><td>data field <em>vccq</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__card__power__ctrls.html#gaaf389e0a139d5808dff8ebb6897d4c7b">ARM_MCI_POWER_VCCQ_1V8</a> </td><td align="left">eMMC VCCQ = <span class="XML-Token">1.8V</span> </td><td>data field <em>vccq_1v8</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__card__power__ctrls.html#ga5304b3b6cadc5113f841c3d526ab5db6">ARM_MCI_POWER_VCCQ_1V2</a> </td><td align="left">eMMC VCCQ = <span class="XML-Token">1.2V</span> </td><td>data field <em>vccq_1v2</em> = <span class="XML-Token">1</span> </td></tr>
</table>
</div>
</div>
<a class="anchor" id="ga012fca8f1ce5366fce14b708c771c635"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_MCI_ReadCD </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read Card Detect (CD) state. </p>
<dl class="section return"><dt>Returns</dt><dd>1:card detected, 0:card not detected, or error</dd></dl>
<p>The function <b>ARM_MCI_ReadCD</b> reads the status of the Card Detect (CD) pin. </p>
</div>
</div>
<a class="anchor" id="ga3d70286918405ac81fa795c7d09dc6fd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_MCI_ReadWP </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read Write Protect (WP) state. </p>
<dl class="section return"><dt>Returns</dt><dd>1:write protected, 0:not write protected, or error</dd></dl>
<p>The function <b>ARM_MCI_ReadWP</b> reads the status of the Write Protect (WP) pin. </p>
</div>
</div>
<a class="anchor" id="ga5a431da89feabc2b4bc0c27943dff6f2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_MCI_SendCommand </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>cmd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>arg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t * </td>
<td class="paramname"><em>response</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Command to card and get the response. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>Memory Card command </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">arg</td><td>Command argument </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>Command flags </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">response</td><td>Pointer to buffer for response </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_MCI_SendCommand</b> </p>
<ul>
<li>sends commands to the memory card</li>
<li>retrieve the response from the card</li>
<li>optionally, start the data transfer.</li>
</ul>
<p>The parameter <em>cmd</em> is the command sent to the card. <br/>
The parameter <em>arg</em> contains arguments for the command <em>cmd</em>. <br/>
The parameter <em>flags</em> controls the behavior of the operation and takes predefined values listed in the table below. <br/>
The parameter <em>response</em> is a pointer to receive data.</p>
<p>The parameter <em>flags</em> can have the following values:</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>flags</em> </th><th align="left">Description </th></tr>
<tr>
<td align="left"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga70934cef80884e8c75fb4eebf8452118">ARM_MCI_RESPONSE_NONE</a> </td><td align="left">No response expected (default) </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__send__command__flags__ctrls.html#gaa5ddf1cf772b234e3c247039effd0e7b">ARM_MCI_RESPONSE_SHORT</a> </td><td align="left">Short response (<span class="XML-Token">48</span>-bit) expected </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__send__command__flags__ctrls.html#gaa1d541b0edf32ec05e68d623c727ef9c">ARM_MCI_RESPONSE_SHORT_BUSY</a> </td><td align="left">Short response with busy signal (<span class="XML-Token">48</span>-bit) expected </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__send__command__flags__ctrls.html#gac49c7b39a7c51bd2193e048835bec2fb">ARM_MCI_RESPONSE_LONG</a> </td><td align="left">Long response (<span class="XML-Token">136</span>-bit) expected </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga497abf878c6e12f54cc7ddb92da76c4a">ARM_MCI_RESPONSE_INDEX</a> </td><td align="left">Check command index in response </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga6ab3f4c1a2bf0fdb81fbcf7a5698f2de">ARM_MCI_RESPONSE_CRC</a> </td><td align="left">Check CRC in response </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga68e879799bb27a1b13baf57ed19d719d">ARM_MCI_WAIT_BUSY</a> </td><td align="left">Wait until busy before sending the command </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga8aa566f69aa74ed416213df6ca3267bd">ARM_MCI_TRANSFER_DATA</a> </td><td align="left">Activate Data transfer </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga81606bd94ce782e2c3764b913f929f60">ARM_MCI_CARD_INITIALIZE</a> </td><td align="left">Execute Memory Card initialization sequence </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__send__command__flags__ctrls.html#gab2bfeedf1dc2df1872ebbcc559a7385a">ARM_MCI_INTERRUPT_COMMAND</a> </td><td align="left">Send Interrupt command (CMD40 - MMC only) </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__send__command__flags__ctrls.html#gabc31b6b26988998c84c92a9a698fd5dc">ARM_MCI_INTERRUPT_RESPONSE</a> </td><td align="left">Send Interrupt response (CMD40 - MMC only) </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__send__command__flags__ctrls.html#gae04254f51dfd9838583206cae0a5f8f7">ARM_MCI_BOOT_OPERATION</a> </td><td align="left">Execute Boot operation (MMC only) </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga30bd304652d4f870ee7ce61c266a9348">ARM_MCI_BOOT_ALTERNATIVE</a> </td><td align="left">Execute Alternative Boot operation (MMC only) </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga8c55bc0a310630d49810802ccd1bb10d">ARM_MCI_BOOT_ACK</a> </td><td align="left">Expect Boot Acknowledge (MMC only) </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__send__command__flags__ctrls.html#gab9df5169b37621764f8bb0f93db5281a">ARM_MCI_CCSD</a> </td><td align="left">Send Command Completion Signal Disable (CCSD) for CE-ATA device </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__send__command__flags__ctrls.html#gab82c472e4ca3fca12ae3291e25997f00">ARM_MCI_CCS</a> </td><td align="left">Expect Command Completion Signal (CCS) for CE-ATA device </td></tr>
</table>
<p>Calling the function <b>ARM_MCI_SendCommand</b> only starts the operation. The function is non-blocking and returns as soon as the driver has started the operation. It is not allowed to call this function again until the operation is in progress.</p>
<p>After the command is sent the response is retrieved if specified with <b>ARM_MCI_RESPONSE_xxx</b> flags. When the command completes successfully (requested response is received without errors) the <a class="el" href="group__mci__event__gr.html#gae69356c75d55103d93ef91ac1bc02b49">ARM_MCI_EVENT_COMMAND_COMPLETE</a> event is generated. In case that response is requested but not received the <a class="el" href="group__mci__event__gr.html#gab79b3ab4dcd03c38df1e173fa903d822">ARM_MCI_EVENT_COMMAND_TIMEOUT</a> event is generated instead. In case of invalid response (or CRC error) the <a class="el" href="group__mci__event__gr.html#ga373aeb3eca0e4c6d159312488a130442">ARM_MCI_EVENT_COMMAND_ERROR</a> event is generated instead. Progress of command operation can be monitored by calling the <a class="el" href="group__mci__interface__gr.html#ga8d61aa42ce78d1864fa928c1f273cbd9">ARM_MCI_GetStatus</a> and checking the <em>command_active</em> flag.</p>
<p>After the command operation the data transfer operation is started if specified with <b>ARM_MCI_TRANSFER_DATA</b> flag. The data transfer needs to be configured before that by calling the <a class="el" href="group__mci__interface__gr.html#gaaec681bcd8e6811c5743e33ee0f35ed1">ARM_MCI_SetupTransfer</a>. When the data transfer completes successfully the <a class="el" href="group__mci__event__gr.html#gabc3c468dedaed890683360f2c5c65bea">ARM_MCI_EVENT_TRANSFER_COMPLETE</a> event is generated. In case that data transfer is not completed in-time (specified by <a class="el" href="group__mci__mode__ctrls.html#ga09a58821e42595f0c2e55f8cc2d32ceb">ARM_MCI_DATA_TIMEOUT</a>) the <a class="el" href="group__mci__event__gr.html#ga614e7c7226adbaa8ec4165bf8b87ef27">ARM_MCI_EVENT_TRANSFER_TIMEOUT</a> event is generated instead. In case of CRC errors the <a class="el" href="group__mci__event__gr.html#ga5d2cee5ba6d0e40ad505983155706c29">ARM_MCI_EVENT_TRANSFER_ERROR</a> event is generated instead. Progress of data transfer operation can be monitored by calling the <a class="el" href="group__mci__interface__gr.html#ga8d61aa42ce78d1864fa928c1f273cbd9">ARM_MCI_GetStatus</a> and checking the <em>transfer_active</em> flag.</p>
<p><b>See also:</b></p>
<ul>
<li><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </li>
</ul>
</div>
</div>
<a class="anchor" id="gaaec681bcd8e6811c5743e33ee0f35ed1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_MCI_SetupTransfer </td>
<td>(</td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>block_count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>block_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>mode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Setup read or write transfer operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">data</td><td>Pointer to data block(s) to be written or read </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">block_count</td><td>Number of blocks </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">block_size</td><td>Size of a block in bytes </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>Transfer mode </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_MCI_SetupTransfer</b> prepares the data transfer operation that is initiated by calling the function <a class="el" href="group__mci__interface__gr.html#ga5a431da89feabc2b4bc0c27943dff6f2">ARM_MCI_SendCommand</a> with the parameter <em>flags</em> = <a class="el" href="group__mci__send__command__flags__ctrls.html#ga8aa566f69aa74ed416213df6ca3267bd">ARM_MCI_TRANSFER_DATA</a>.</p>
<p>The parameter <em>data</em> is a pointer to the data to transfer. <br/>
The parameter <em>block_count</em> is the number of blocks to transfer. <br/>
The parameter <em>block_size</em> is the size of a block. <br/>
The parameter <em>mode</em> sets the transfer mode and can have the values liste in the table below:</p>
<table class="doxtable">
<tr>
<th align="left">Transfer Directions </th><th align="left">Description </th></tr>
<tr>
<td align="left"><a class="el" href="group__mci__transfer__ctrls.html#gaa6f3be235a9dce5c66be8fe64f399846">ARM_MCI_TRANSFER_READ</a> </td><td align="left">Read data from MCI </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__transfer__ctrls.html#gaddc60aab15f75993a99f98f71ddbd50c">ARM_MCI_TRANSFER_WRITE</a> </td><td align="left">Write data to MCI </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__transfer__ctrls.html#ga4ced782e7c0c70d5f0edbddd1e48323b">ARM_MCI_TRANSFER_BLOCK</a> (default) </td><td align="left">Block Data transfer </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__transfer__ctrls.html#gac7db0cffd571e60758627d889ba7a432">ARM_MCI_TRANSFER_STREAM</a> </td><td align="left">Stream Data transfer (MMC only) </td></tr>
</table>
</div>
</div>
<a class="anchor" id="ga3dfcf7b7186b711f9b63a096be816fe5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_MCI_AbortTransfer </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Abort current read/write data transfer. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_MCI_AbortTransfer</b> aborts the active data transfer operation initiated with <a class="el" href="group__mci__interface__gr.html#ga5a431da89feabc2b4bc0c27943dff6f2">ARM_MCI_SendCommand</a>. </p>
</div>
</div>
<a class="anchor" id="gaec0506a2aa4ae75cf6bc02528f36fe30"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_MCI_Control </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>control</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control MCI Interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">control</td><td>Operation </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">arg</td><td>Argument of operation (optional) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>Th function <b>ARM_MCI_Control</b> controls the MCI interface and executes various operations.</p>
<p>The parameter <em>control</em> specifies the operation. Values for <em>control</em> cannot be ORed, but must be called separately in the code. <br/>
The parameter <em>arg</em> provides, depending on the operation, additional information or sets values.</p>
<dl class="section note"><dt>Note</dt><dd>For parameters, the values marked with (default) are the setting after the driver initialization.</dd></dl>
<p>The table lists values for the parameter <em>control</em>.</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>control</em> </th><th align="left">Operation </th></tr>
<tr>
<td align="left"><a class="el" href="group__mci__mode__ctrls.html#ga7f982d2e5aec768307d35a83c65fb3ef">ARM_MCI_BUS_SPEED</a> </td><td align="left">Set the Bus Speed. The parameter <em>arg</em> specifies the speed in bits/s; The function returns the bus speed configured in bits/s. </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__mode__ctrls.html#gaf7ede525eabc618fbbb9f7a294c8ed96">ARM_MCI_BUS_SPEED_MODE</a> </td><td align="left">Set the Bus Speed Mode. Predefined values for <em>arg</em> are listed in the table <b>Bus Speed Mode</b>. </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__mode__ctrls.html#ga8b7571e37520c07d8ef4f697f3886715">ARM_MCI_BUS_CMD_MODE</a> </td><td align="left">Set the CMD Line Mode. Predefined values for <em>arg</em> are listed in the table <b>Bus CMD Line Mode</b>. </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__mode__ctrls.html#ga876d964d0eeacdb16e93f7558a544587">ARM_MCI_BUS_DATA_WIDTH</a> </td><td align="left">Set data bus width. Predefined values for <em>arg</em> are encoded in <b>Bus Data Width</b>. </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__mode__ctrls.html#ga78068f519139f2ae7b09e0608070aaf6">ARM_MCI_DRIVER_STRENGTH</a> </td><td align="left">Set driver strength. Predefined values for <em>arg</em> are listed in the table <b>Driver Type</b> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__mode__ctrls.html#ga21e403e8c3fa8cc75431a513813f0a16">ARM_MCI_CONTROL_RESET</a> </td><td align="left">Control optional RST_n Pin (eMMC). The parameter <em>arg</em> can have the values <span class="XML-Token">[0:inactive(default); 1:active]</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__mode__ctrls.html#ga889473fbfbdcb89aab4d53cc8a13f615">ARM_MCI_CONTROL_CLOCK_IDLE</a> </td><td align="left">Control clock generation on CLK Pin when idle. The parameter <em>arg</em> can have the values <span class="XML-Token">[0:disabled; 1:enabled]</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__mode__ctrls.html#ga98853f60bdc085aeeccd66f7bdf22d3d">ARM_MCI_UHS_TUNING_OPERATION</a> </td><td align="left">Sampling clock Tuning operation (SD UHS-I). The parameter <em>arg</em> can have the values <span class="XML-Token">[0:reset; 1:execute]</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__mode__ctrls.html#gabd3af448e26da5657c1c5a03330476b7">ARM_MCI_UHS_TUNING_RESULT</a> </td><td align="left">Sampling clock Tuning result (SD UHS-I). Returns <span class="XML-Token">[0:done; 1:in progress; -1:error]</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__mode__ctrls.html#ga09a58821e42595f0c2e55f8cc2d32ceb">ARM_MCI_DATA_TIMEOUT</a> </td><td align="left">Set Data timeout; The parameter <em>arg</em> sets the timeout in bus cycles. </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__mode__ctrls.html#gae97b1a819a5d326b1f1009b0d6d48b5a">ARM_MCI_CSS_TIMEOUT</a> </td><td align="left">Set Command Completion Signal (CCS) timeout. The parameter <em>arg</em> sets timeout in bus cycles. </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__mode__ctrls.html#ga19fd7d3b74ac48ca74a2e138b3ee9963">ARM_MCI_MONITOR_SDIO_INTERRUPT</a> </td><td align="left">Monitor SD I/O interrupt. The parameter <em>arg</em> can have the values <span class="XML-Token">[0:disabled(default); 1:enabled]</span>. Monitoring is automatically disabled when an interrupt is recognized. </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__mode__ctrls.html#gaaa10c5aa7a8108aa59c3734b3eec2e3a">ARM_MCI_CONTROL_READ_WAIT</a> </td><td align="left">Control Read/Wait states for SD I/O. The parameter <em>arg</em> can have the values <span class="XML-Token">[0:disabled(default); 1:enabled]</span>. </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__mode__ctrls.html#ga04cf174b0ef13240f26225bf8e45a4a0">ARM_MCI_SUSPEND_TRANSFER</a> </td><td align="left">Suspend Data transfer (SD I/O). Returns the number of remaining bytes to transfer. </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__mode__ctrls.html#gac4907319499072fddf61f2f83b0dd966">ARM_MCI_RESUME_TRANSFER</a> </td><td align="left">Resume Data transfer (SD I/O). </td></tr>
</table>
<p><b>Bus Speed Mode</b></p>
<p>The function <a class="el" href="group__mci__interface__gr.html#ga7e5a78b6e6409189833a0b72a0a3c48a">ARM_MCI_GetCapabilities</a> lists the supported bus speed modes. Initially, all SD cards use a 3.3 volt electrical interface. Some SD cards can switch to 1.8 volt operation. For example, the use of ultra-high-speed (UHS) SD cards requires 1.8 volt operation and a 4-bit bus data width. The bit field <a class="el" href="group__mci__interface__gr.html#a084188480d589cdc8d3e164b9f41bea9" title="Supports SD UHS-I (Ultra High Speed) 1.8V signaling. ">ARM_MCI_CAPABILITIES.uhs_signaling</a> encodes whether the driver supports 1.8 volt UHS signaling.</p>
<p>The <em>control</em> operation <b>ARM_MCI_BUS_SPEED_MODE</b> sets the bus speed mode using the parameter <em>arg</em>.</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>arg</em> </th><th align="left">Bus Speed Mode </th></tr>
<tr>
<td align="left"><a class="el" href="group__mci__bus__speed__ctrls.html#ga601fa8b27ab2e5f6d90c93d54c8f412d">ARM_MCI_BUS_DEFAULT_SPEED</a> (default) </td><td align="left">Set the bus speed for SD/MMC cards: Default Speed mode up to <span class="XML-Token">[25;26]MHz</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__bus__speed__ctrls.html#gaabda746ac7d6b4497358ff655a8ea6be">ARM_MCI_BUS_HIGH_SPEED</a> </td><td align="left">Set the bus speed for SD/MMC: High Speed mode up to <span class="XML-Token">[50;52]MHz</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__bus__speed__ctrls.html#ga0473c44a7b65044b3c6a8e7012009a4a">ARM_MCI_BUS_UHS_SDR12</a> </td><td align="left">Set the bus speed for SD: SDR12 (Single Data Rate) up to <span class="XML-Token">25MHz, 12.5MB/s: UHS-I (Ultra High Speed) 1.8V signalling</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__bus__speed__ctrls.html#gae32422631052307b3c4d269b25415907">ARM_MCI_BUS_UHS_SDR25</a> </td><td align="left">Set the bus speed for SD: SDR25 (Single Data Rate) up to <span class="XML-Token">50MHz, 25 MB/s: UHS-I (Ultra High Speed) 1.8V signalling</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__bus__speed__ctrls.html#ga9f326c02391d965918ae619b912b81e7">ARM_MCI_BUS_UHS_SDR50</a> </td><td align="left">Set the bus speed for SD: SDR50 (Single Data Rate) up to <span class="XML-Token">100MHz, 50 MB/s: UHS-I (Ultra High Speed) 1.8V signalling</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__bus__speed__ctrls.html#gad2bab563e7bbb4bcf6bdabe6a13dadf4">ARM_MCI_BUS_UHS_SDR104</a> </td><td align="left">Set the bus speed for SD: SDR104 (Single Data Rate) up to <span class="XML-Token">208MHz, 104 MB/s: UHS-I (Ultra High Speed) 1.8V signalling</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__bus__speed__ctrls.html#ga04da920a5cac99eab9784527057f1b9c">ARM_MCI_BUS_UHS_DDR50</a> </td><td align="left">Set the bus speed for SD: DDR50 (Dual Data Rate) up to <span class="XML-Token">50MHz, 50 MB/s: UHS-I (Ultra High Speed) 1.8V signalling</span> </td></tr>
</table>
<p><b>Bus CMD Line Mode</b></p>
<p>The <em>control</em> operation <b>ARM_MCI_BUS_CMD_MODE</b> sets the bus command line mode using the parameter <em>arg</em>.</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>arg</em> </th><th align="left">Bus CMD Line Mode </th></tr>
<tr>
<td align="left"><a class="el" href="group__mci__cmd__line__ctrls.html#gaaed404312d9bc073e3489779a911c7dc">ARM_MCI_BUS_CMD_PUSH_PULL</a> (default) </td><td align="left">Set the Push-Pull CMD line </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__cmd__line__ctrls.html#gaadf8667985731964d57d1ed672e90fd3">ARM_MCI_BUS_CMD_OPEN_DRAIN</a> </td><td align="left">Set the Open Drain CMD line (MMC only) </td></tr>
</table>
<p><b>Bus Data Width</b></p>
<p>Specifies the bus data width (the number of data I/O pins on the SD/MMC interface).</p>
<p>For high speed memory cards, a 4-bit bus data width should be used (or 8-bit for eMMC). The bit fields <a class="el" href="group__mci__interface__gr.html#a950669a8c88b49c8da4c56163b45a79d" title="Supports 4-bit data. ">ARM_MCI_CAPABILITIES.data_width_4</a> and <a class="el" href="group__mci__interface__gr.html#a808703d6c70a501464e156e55f5cabd2" title="Supports 8-bit data. ">ARM_MCI_CAPABILITIES.data_width_8</a> encode whether the driver supports a specific bus data with.</p>
<p>The <em>control</em> operation <b>ARM_MCI_BUS_DATA_WIDTH</b> sets the bus data width using the parameter <em>arg</em>.</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>arg</em> </th><th align="left">Bus Data Width </th></tr>
<tr>
<td align="left"><a class="el" href="group__mci__bus__data__width__ctrls.html#gaa09a00d810a4dfd1d1824311ee290585">ARM_MCI_BUS_DATA_WIDTH_1</a> (default) </td><td align="left">Set the Bus data width to <span class="XML-Token">1 bit</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__bus__data__width__ctrls.html#gaa28150d8c3789e8cf1bcda318f74a28c">ARM_MCI_BUS_DATA_WIDTH_4</a> </td><td align="left">Set the Bus data width to <span class="XML-Token">4 bits</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__bus__data__width__ctrls.html#ga3bb99a2d98ba9fb8c5bc97fa2b8ef469">ARM_MCI_BUS_DATA_WIDTH_8</a> </td><td align="left">Set the Bus data width to <span class="XML-Token">8 bits</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__bus__data__width__ctrls.html#gaccb174bd131f8fd8cd9a56439a8ebb60">ARM_MCI_BUS_DATA_WIDTH_4_DDR</a> </td><td align="left">Set the Bus data width to <span class="XML-Token">4 bits</span>, DDR (Dual Data Rate) - MMC only </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__bus__data__width__ctrls.html#ga7b31f81ae703229095fe9efcfbe80b47">ARM_MCI_BUS_DATA_WIDTH_8_DDR</a> </td><td align="left">Set the Bus data width to <span class="XML-Token">8 bits</span>, DDR (Dual Data Rate) - MMC only </td></tr>
</table>
<p><b>Driver Type</b></p>
<p>Specifies the interface driver type.</p>
<p>The <em>control</em> operation <b>ARM_MCI_DRIVER_STRENGTH</b> sets the interface driver type using the parameter <em>arg</em>.</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>arg</em> </th><th align="left">Driver Type </th></tr>
<tr>
<td align="left"><a class="el" href="group__mci__driver__strength__ctrls.html#ga64eb1c4847711a262f084c361b60a912">ARM_MCI_DRIVER_TYPE_A</a> </td><td align="left">Set the interface to SD UHS-I Driver Type A </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__driver__strength__ctrls.html#ga078d3c3bc7c9335b92e6445a0abafc46">ARM_MCI_DRIVER_TYPE_B</a> (default) </td><td align="left">Set the interface to SD UHS-I Driver Type B </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__driver__strength__ctrls.html#ga3da11696d1fcd3930eb7e70fe097d747">ARM_MCI_DRIVER_TYPE_C</a> </td><td align="left">Set the interface to SD UHS-I Driver Type C </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__driver__strength__ctrls.html#ga8185f82b1d8857a3f0eb461d664f2b3d">ARM_MCI_DRIVER_TYPE_D</a> </td><td align="left">Set the interface to SD UHS-I Driver Type D </td></tr>
</table>
<p><b>Examples:</b> </p>
<div class="fragment"><div class="line"><span class="comment">// Set Bus Speed to 25MHz</span></div>
<div class="line">MCIdrv->Control(<a class="code" href="group__mci__mode__ctrls.html#ga7f982d2e5aec768307d35a83c65fb3ef">ARM_MCI_BUS_SPEED</a>, 25000000);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Set High Speed mode</span></div>
<div class="line">MCIdrv->Control(<a class="code" href="group__mci__mode__ctrls.html#gaf7ede525eabc618fbbb9f7a294c8ed96">ARM_MCI_BUS_SPEED_MODE</a>, <a class="code" href="group__mci__bus__speed__ctrls.html#gaabda746ac7d6b4497358ff655a8ea6be">ARM_MCI_BUS_HIGH_SPEED</a>);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Configure CMD line as Open Drain (MMC only)</span></div>
<div class="line">MCIdrv->Control(<a class="code" href="group__mci__mode__ctrls.html#ga8b7571e37520c07d8ef4f697f3886715">ARM_MCI_BUS_CMD_MODE</a>, <a class="code" href="group__mci__cmd__line__ctrls.html#gaadf8667985731964d57d1ed672e90fd3">ARM_MCI_BUS_CMD_OPEN_DRAIN</a>);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Set Bus Data Width = 4bits</span></div>
<div class="line">MCIdrv->Control(<a class="code" href="group__mci__mode__ctrls.html#ga876d964d0eeacdb16e93f7558a544587">ARM_MCI_BUS_DATA_WIDTH</a>, <a class="code" href="group__mci__bus__data__width__ctrls.html#gaa28150d8c3789e8cf1bcda318f74a28c">ARM_MCI_BUS_DATA_WIDTH_4</a>);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Set SD UHS-I Driver Type B</span></div>
<div class="line">MCIdrv->Control(<a class="code" href="group__mci__mode__ctrls.html#ga78068f519139f2ae7b09e0608070aaf6">ARM_MCI_DRIVER_STRENGTH</a>, <a class="code" href="group__mci__driver__strength__ctrls.html#ga078d3c3bc7c9335b92e6445a0abafc46">ARM_MCI_DRIVER_TYPE_B</a>);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// RTS_n Pin is not active by default</span></div>
<div class="line"><span class="comment">// Assert RTS_n Pin (eMMC)</span></div>
<div class="line">MCIdrv->Control(<a class="code" href="group__mci__mode__ctrls.html#ga21e403e8c3fa8cc75431a513813f0a16">ARM_MCI_CONTROL_RESET</a>, 1);</div>
<div class="line"><span class="comment">// De-assert RTS_n Pin (eMMC)</span></div>
<div class="line">MCIdrv->Control(<a class="code" href="group__mci__mode__ctrls.html#ga21e403e8c3fa8cc75431a513813f0a16">ARM_MCI_CONTROL_RESET</a>, 0);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Clock generation on CLK when Idle: hardware specific default behavior</span></div>
<div class="line"><span class="comment">// Enable Clock generation on CLK when Idle</span></div>
<div class="line">MCIdrv->Control(<a class="code" href="group__mci__mode__ctrls.html#ga889473fbfbdcb89aab4d53cc8a13f615">ARM_MCI_CONTROL_CLOCK_IDLE</a>, 1);</div>
<div class="line"><span class="comment">// Disable Clock generation on CLK when Idle</span></div>
<div class="line">MCIdrv->Control(<a class="code" href="group__mci__mode__ctrls.html#ga889473fbfbdcb89aab4d53cc8a13f615">ARM_MCI_CONTROL_CLOCK_IDLE</a>, 0);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// UHS Tuning</span></div>
<div class="line">MCIdrv->Control(<a class="code" href="group__mci__mode__ctrls.html#ga98853f60bdc085aeeccd66f7bdf22d3d">ARM_MCI_UHS_TUNING_OPERATION</a>, 1); <span class="comment">// start tuning</span></div>
<div class="line"><span class="keywordflow">do</span> {</div>
<div class="line"> status = MCIdrv->Control(<a class="code" href="group__mci__mode__ctrls.html#gabd3af448e26da5657c1c5a03330476b7">ARM_MCI_UHS_TUNING_RESULT</a>, 0<span class="comment">/*argument not used*/</span>);</div>
<div class="line"> <span class="keywordflow">if</span> (status == -1) { <span class="keywordflow">break</span>; <span class="comment">/* tuning failed */</span> }</div>
<div class="line">} <span class="keywordflow">while</span> (status == 1);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Set Data Timeout to 12500000 bus cycles (0.5s @25MHz Bus Speed)</span></div>
<div class="line"><span class="comment">// Default value is hardware specific (typically 2^32-1)</span></div>
<div class="line">MCIdrv->Control(<a class="code" href="group__mci__mode__ctrls.html#ga09a58821e42595f0c2e55f8cc2d32ceb">ARM_MCI_DATA_TIMEOUT</a>, 12500000);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Set CSS Timeout to 1000000 bus cycles</span></div>
<div class="line"><span class="comment">// Default value is hardware specific</span></div>
<div class="line">MCIdrv->Control(<a class="code" href="group__mci__mode__ctrls.html#gae97b1a819a5d326b1f1009b0d6d48b5a">ARM_MCI_CSS_TIMEOUT</a>, 1000000);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// SD I/O Interrupt Monitoring is disabled by default</span></div>
<div class="line"><span class="comment">// Enable SD I/O Interrupt Monitoring</span></div>
<div class="line">MCIdrv->Control(<a class="code" href="group__mci__mode__ctrls.html#ga19fd7d3b74ac48ca74a2e138b3ee9963">ARM_MCI_MONITOR_SDIO_INTERRUPT</a>, 1);</div>
<div class="line"><span class="comment">// Disable SD I/O Interrupt Monitoring</span></div>
<div class="line">MCIdrv->Control(<a class="code" href="group__mci__mode__ctrls.html#ga19fd7d3b74ac48ca74a2e138b3ee9963">ARM_MCI_MONITOR_SDIO_INTERRUPT</a>, 0);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Read/Wait for SD I/O is disabled by default</span></div>
<div class="line"><span class="comment">// Enable Read/Wait for SD I/O</span></div>
<div class="line">MCIdrv->Control(<a class="code" href="group__mci__mode__ctrls.html#gaaa10c5aa7a8108aa59c3734b3eec2e3a">ARM_MCI_CONTROL_READ_WAIT</a>, 1);</div>
<div class="line"><span class="comment">// Disable Read/Wait for SD I/O</span></div>
<div class="line">MCIdrv->Control(<a class="code" href="group__mci__mode__ctrls.html#gaaa10c5aa7a8108aa59c3734b3eec2e3a">ARM_MCI_CONTROL_READ_WAIT</a>, 0);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Suspend Data transfer (SD I/O)</span></div>
<div class="line">MCIdrv->Control(<a class="code" href="group__mci__mode__ctrls.html#ga04cf174b0ef13240f26225bf8e45a4a0">ARM_MCI_SUSPEND_TRANSFER</a>, 0<span class="comment">/*argument not used*/</span>);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Resume Data transfer (SD I/O)</span></div>
<div class="line">MCIdrv->Control(<a class="code" href="group__mci__mode__ctrls.html#gac4907319499072fddf61f2f83b0dd966">ARM_MCI_RESUME_TRANSFER</a>, 0<span class="comment">/*argument not used*/</span>);</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga8d61aa42ce78d1864fa928c1f273cbd9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__mci__interface__gr.html#structARM__MCI__STATUS">ARM_MCI_STATUS</a> ARM_MCI_GetStatus </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get MCI status. </p>
<dl class="section return"><dt>Returns</dt><dd>MCI status <a class="el" href="group__mci__interface__gr.html#structARM__MCI__STATUS">ARM_MCI_STATUS</a></dd></dl>
<p>The function <b>ARM_MCI_GetStatus</b> returns the current MCI interface status. </p>
</div>
</div>
<a class="anchor" id="gaac2dbd1c1a98436938c5d0d6248cb700"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARM_MCI_SignalEvent </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback function that signals a MCI Card Event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td><a class="el" href="group__mci__event__gr.html">MCI Events</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<p>The function <b>ARM_MCI_SignalEvent</b> is a callback function registered by the function <a class="el" href="group__mci__interface__gr.html#ga6f34d4ab362e596ddaf23aac093268cf">ARM_MCI_Initialize</a>.</p>
<p>The parameter <em>event</em> indicates one or more events that occurred during driver operation. Each event is encoded in a separate bit and therefore it is possible to signal multiple events within the same call.</p>
<p>Not every event is necessarily generated by the driver. This depends on the implemented capabilities stored in the data fields of the structure <a class="el" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a>, which can be retrieved with the function <a class="el" href="group__nand__interface__gr.html#ga9f2609975c2008d21b9ae28f15daf147">ARM_NAND_GetCapabilities</a>.</p>
<p>The following events can be generated:</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>event</em> </th><th align="right">Bit </th><th align="left">Description </th><th align="left">supported when <a class="el" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a> </th></tr>
<tr>
<td align="left"><a class="el" href="group__mci__event__gr.html#gae2cf8ef238c092e94e96a01602f3a23c">ARM_MCI_EVENT_CARD_INSERTED</a> </td><td align="right">0 </td><td align="left">Occurs after Memory Card inserted </td><td align="left"><em>always supported</em> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__event__gr.html#ga92ba748f9324ec13898f10456f17c8cc">ARM_MCI_EVENT_CARD_REMOVED</a> </td><td align="right">1 </td><td align="left">Occurs after Memory Card removal </td><td align="left"><em>always supported</em> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__event__gr.html#gae69356c75d55103d93ef91ac1bc02b49">ARM_MCI_EVENT_COMMAND_COMPLETE</a> </td><td align="right">2 </td><td align="left">Occurs after command completed successfully </td><td align="left"><em>always supported</em> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__event__gr.html#gab79b3ab4dcd03c38df1e173fa903d822">ARM_MCI_EVENT_COMMAND_TIMEOUT</a> </td><td align="right">3 </td><td align="left">Occurs after command timeout </td><td align="left"><em>always supported</em> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__event__gr.html#ga373aeb3eca0e4c6d159312488a130442">ARM_MCI_EVENT_COMMAND_ERROR</a> </td><td align="right">4 </td><td align="left">Occurs after command response error (CRC error or invalid response) </td><td align="left"><em>always supported</em> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__event__gr.html#gabc3c468dedaed890683360f2c5c65bea">ARM_MCI_EVENT_TRANSFER_COMPLETE</a> </td><td align="right">5 </td><td align="left">Occurs after data transfer completed successfully </td><td align="left"><em>always supported</em> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__event__gr.html#ga614e7c7226adbaa8ec4165bf8b87ef27">ARM_MCI_EVENT_TRANSFER_TIMEOUT</a> </td><td align="right">6 </td><td align="left">Occurs after data transfer timeout </td><td align="left"><em>always supported</em> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__event__gr.html#ga5d2cee5ba6d0e40ad505983155706c29">ARM_MCI_EVENT_TRANSFER_ERROR</a> </td><td align="right">7 </td><td align="left">Occurs after data transfer error (CRC failed) </td><td align="left"><em>always supported</em> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__event__gr.html#ga75a050fdfe04e6816e96c938d6a6c197">ARM_MCI_EVENT_SDIO_INTERRUPT</a> </td><td align="right">8 </td><td align="left">Indicates SD I/O Interrupt </td><td align="left">data field <em>sdio_interrupt</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__event__gr.html#ga8161f3960ddf2a3cdc3c4c83148c6099">ARM_MCI_EVENT_CCS</a> </td><td align="right">9 </td><td align="left">Indicates a Command Completion Signal (CCS) </td><td align="left">data field <em>ccs</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__mci__event__gr.html#gafa8cbcd597a05c64901eeb777cc0b74f">ARM_MCI_EVENT_CCS_TIMEOUT</a> </td><td align="right">10 </td><td align="left">Indicates a Command Completion Signal (CCS) Timeout </td><td align="left">data field <em>css_timeout</em> = <span class="XML-Token">1</span> </td></tr>
</table>
<p><b>See also:</b></p>
<ul>
<li><a class="el" href="group__mci__interface__gr.html#ga5a431da89feabc2b4bc0c27943dff6f2">ARM_MCI_SendCommand</a> </li>
</ul>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__interface__gr.html | HTML | apache-2.0 | 129,197 |
var group__mci__interface__gr =
[
[ "MCI Events", "group__mci__event__gr.html", "group__mci__event__gr" ],
[ "MCI Control Codes", "group__mci__control__gr.html", "group__mci__control__gr" ],
[ "MCI Send Command Flags", "group__mci__send__command__flags__ctrls.html", "group__mci__send__command__flags__ctrls" ],
[ "MCI Transfer Controls", "group__mci__transfer__ctrls.html", "group__mci__transfer__ctrls" ],
[ "MCI Card Power Controls", "group__mci__card__power__ctrls.html", "group__mci__card__power__ctrls" ],
[ "ARM_DRIVER_MCI", "group__mci__interface__gr.html#structARM__DRIVER__MCI", [
[ "GetVersion", "group__mci__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__mci__interface__gr.html#a5648b4224e0346ba5e20fefc7e83aee8", null ],
[ "Initialize", "group__mci__interface__gr.html#ae51ec82c310aff0edda6220f9ebfd822", null ],
[ "Uninitialize", "group__mci__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__mci__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "CardPower", "group__mci__interface__gr.html#a73334c737658b227ef3097343d5c78bb", null ],
[ "ReadCD", "group__mci__interface__gr.html#aa4285dd6b0f9b8ca41b6710a478ad641", null ],
[ "ReadWP", "group__mci__interface__gr.html#aee6f8b38f83a51ac05cc4841524b708d", null ],
[ "SendCommand", "group__mci__interface__gr.html#affefb5c1d352082933c2fb0620b37212", null ],
[ "SetupTransfer", "group__mci__interface__gr.html#adc63bab660e8304d78faa1ac429e792b", null ],
[ "AbortTransfer", "group__mci__interface__gr.html#afa8103cc20ba96420b7471455bbb87e4", null ],
[ "Control", "group__mci__interface__gr.html#a6e0f47a92f626a971c5197fca6545505", null ],
[ "GetStatus", "group__mci__interface__gr.html#a2dc63353d6869c0ea2d3d29155c88b49", null ]
] ],
[ "ARM_MCI_CAPABILITIES", "group__mci__interface__gr.html#structARM__MCI__CAPABILITIES", [
[ "cd_state", "group__mci__interface__gr.html#af47e73979b028c86c7c1fbe39b095140", null ],
[ "cd_event", "group__mci__interface__gr.html#abcabfa504d3226c723d9bf5debe2f164", null ],
[ "wp_state", "group__mci__interface__gr.html#a02df0162d3a653c36158a7b6a76f6175", null ],
[ "vdd", "group__mci__interface__gr.html#a414baec222a72be862e262f02b821dce", null ],
[ "vdd_1v8", "group__mci__interface__gr.html#abeb0330f882ebed8cabde782652233dd", null ],
[ "vccq", "group__mci__interface__gr.html#ab1cdfce6eb051bed7b904e0fd1719afa", null ],
[ "vccq_1v8", "group__mci__interface__gr.html#a1896a7548bb6fab285f23cc0d0b23d7d", null ],
[ "vccq_1v2", "group__mci__interface__gr.html#af4f95215005e38700ef527714932b361", null ],
[ "data_width_4", "group__mci__interface__gr.html#a950669a8c88b49c8da4c56163b45a79d", null ],
[ "data_width_8", "group__mci__interface__gr.html#a808703d6c70a501464e156e55f5cabd2", null ],
[ "data_width_4_ddr", "group__mci__interface__gr.html#abb1a604b0ee4f7e3510409747890e41e", null ],
[ "data_width_8_ddr", "group__mci__interface__gr.html#acd5f6dce3a548d12c292e8cd17e4e9e2", null ],
[ "high_speed", "group__mci__interface__gr.html#a83ecf7d4472c55362750ef72d8f8f47d", null ],
[ "uhs_signaling", "group__mci__interface__gr.html#a084188480d589cdc8d3e164b9f41bea9", null ],
[ "uhs_tuning", "group__mci__interface__gr.html#a617bf7fb73b49a20398b90098ecc3ec0", null ],
[ "uhs_sdr50", "group__mci__interface__gr.html#a5c3dcb2f8aa6f65408d9a6741abb7b3e", null ],
[ "uhs_sdr104", "group__mci__interface__gr.html#ae07ceef1800252495a79f225142740e7", null ],
[ "uhs_ddr50", "group__mci__interface__gr.html#a1ee73c19020d5f1bedf7c013d0e5f730", null ],
[ "uhs_driver_type_a", "group__mci__interface__gr.html#afe5de4fdc6657aa19fa87577a8d460e5", null ],
[ "uhs_driver_type_c", "group__mci__interface__gr.html#a3c3df9641e7216dd20d3bc395dc4948f", null ],
[ "uhs_driver_type_d", "group__mci__interface__gr.html#a639bebbcb9a3a743f4f232fec82e2bfc", null ],
[ "sdio_interrupt", "group__mci__interface__gr.html#a61e2a440b27d7d22c866ad4427f4b825", null ],
[ "read_wait", "group__mci__interface__gr.html#a5e38e4ee9cebcc99904e287adc8e6217", null ],
[ "suspend_resume", "group__mci__interface__gr.html#abb03f0187e4658f417b5a24cac33eed9", null ],
[ "mmc_interrupt", "group__mci__interface__gr.html#a3303194ea68bd1094841d4f958f6dbbf", null ],
[ "mmc_boot", "group__mci__interface__gr.html#a072a194948489d4dbd2409b94fdca56b", null ],
[ "rst_n", "group__mci__interface__gr.html#a2e8bd27f2c5c3093c4fec557890b97d4", null ],
[ "ccs", "group__mci__interface__gr.html#a13c956ba993083f1e59379968e2badbe", null ],
[ "ccs_timeout", "group__mci__interface__gr.html#a9739c230a13b46482feb5475d257e482", null ],
[ "reserved", "group__mci__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_MCI_STATUS", "group__mci__interface__gr.html#structARM__MCI__STATUS", [
[ "command_active", "group__mci__interface__gr.html#aa22ef7c7597e90835bd67d5795ba757e", null ],
[ "command_timeout", "group__mci__interface__gr.html#a56e426979c3872254c156e9ae7eead5b", null ],
[ "command_error", "group__mci__interface__gr.html#afca11cd2ce661c67455a6d75328848cc", null ],
[ "transfer_active", "group__mci__interface__gr.html#a2655d3422b720097b091a28e8bbcea8f", null ],
[ "transfer_timeout", "group__mci__interface__gr.html#a598ae4a196316d6dcb97d07fd337ecdd", null ],
[ "transfer_error", "group__mci__interface__gr.html#a21d4bc1a03e161bd33693619039a6afa", null ],
[ "sdio_interrupt", "group__mci__interface__gr.html#a61e2a440b27d7d22c866ad4427f4b825", null ],
[ "ccs", "group__mci__interface__gr.html#a13c956ba993083f1e59379968e2badbe", null ],
[ "reserved", "group__mci__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_MCI_SignalEvent_t", "group__mci__interface__gr.html#ga0d14651f6788c1ffd81544602565faf1", null ],
[ "ARM_MCI_GetVersion", "group__mci__interface__gr.html#ga3418183015dbf3025b94eebaedb00ab1", null ],
[ "ARM_MCI_GetCapabilities", "group__mci__interface__gr.html#ga7e5a78b6e6409189833a0b72a0a3c48a", null ],
[ "ARM_MCI_Initialize", "group__mci__interface__gr.html#ga6f34d4ab362e596ddaf23aac093268cf", null ],
[ "ARM_MCI_Uninitialize", "group__mci__interface__gr.html#gaef8183e77797e74997551d03646d42c2", null ],
[ "ARM_MCI_PowerControl", "group__mci__interface__gr.html#ga19752749d04ed22dc91c4294645e0244", null ],
[ "ARM_MCI_CardPower", "group__mci__interface__gr.html#gab161f80e0eda2815f3e0ebbba1314ff0", null ],
[ "ARM_MCI_ReadCD", "group__mci__interface__gr.html#ga012fca8f1ce5366fce14b708c771c635", null ],
[ "ARM_MCI_ReadWP", "group__mci__interface__gr.html#ga3d70286918405ac81fa795c7d09dc6fd", null ],
[ "ARM_MCI_SendCommand", "group__mci__interface__gr.html#ga5a431da89feabc2b4bc0c27943dff6f2", null ],
[ "ARM_MCI_SetupTransfer", "group__mci__interface__gr.html#gaaec681bcd8e6811c5743e33ee0f35ed1", null ],
[ "ARM_MCI_AbortTransfer", "group__mci__interface__gr.html#ga3dfcf7b7186b711f9b63a096be816fe5", null ],
[ "ARM_MCI_Control", "group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30", null ],
[ "ARM_MCI_GetStatus", "group__mci__interface__gr.html#ga8d61aa42ce78d1864fa928c1f273cbd9", null ],
[ "ARM_MCI_SignalEvent", "group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__interface__gr.js | JavaScript | apache-2.0 | 7,528 |
var group__mci__interface__gr_structARM__DRIVER__MCI =
[
[ "GetVersion", "group__mci__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__mci__interface__gr.html#a5648b4224e0346ba5e20fefc7e83aee8", null ],
[ "Initialize", "group__mci__interface__gr.html#ae51ec82c310aff0edda6220f9ebfd822", null ],
[ "Uninitialize", "group__mci__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__mci__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "CardPower", "group__mci__interface__gr.html#a73334c737658b227ef3097343d5c78bb", null ],
[ "ReadCD", "group__mci__interface__gr.html#aa4285dd6b0f9b8ca41b6710a478ad641", null ],
[ "ReadWP", "group__mci__interface__gr.html#aee6f8b38f83a51ac05cc4841524b708d", null ],
[ "SendCommand", "group__mci__interface__gr.html#affefb5c1d352082933c2fb0620b37212", null ],
[ "SetupTransfer", "group__mci__interface__gr.html#adc63bab660e8304d78faa1ac429e792b", null ],
[ "AbortTransfer", "group__mci__interface__gr.html#afa8103cc20ba96420b7471455bbb87e4", null ],
[ "Control", "group__mci__interface__gr.html#a6e0f47a92f626a971c5197fca6545505", null ],
[ "GetStatus", "group__mci__interface__gr.html#a2dc63353d6869c0ea2d3d29155c88b49", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__interface__gr_structARM__DRIVER__MCI.js | JavaScript | apache-2.0 | 1,309 |
var group__mci__interface__gr_structARM__MCI__CAPABILITIES =
[
[ "cd_state", "group__mci__interface__gr.html#af47e73979b028c86c7c1fbe39b095140", null ],
[ "cd_event", "group__mci__interface__gr.html#abcabfa504d3226c723d9bf5debe2f164", null ],
[ "wp_state", "group__mci__interface__gr.html#a02df0162d3a653c36158a7b6a76f6175", null ],
[ "vdd", "group__mci__interface__gr.html#a414baec222a72be862e262f02b821dce", null ],
[ "vdd_1v8", "group__mci__interface__gr.html#abeb0330f882ebed8cabde782652233dd", null ],
[ "vccq", "group__mci__interface__gr.html#ab1cdfce6eb051bed7b904e0fd1719afa", null ],
[ "vccq_1v8", "group__mci__interface__gr.html#a1896a7548bb6fab285f23cc0d0b23d7d", null ],
[ "vccq_1v2", "group__mci__interface__gr.html#af4f95215005e38700ef527714932b361", null ],
[ "data_width_4", "group__mci__interface__gr.html#a950669a8c88b49c8da4c56163b45a79d", null ],
[ "data_width_8", "group__mci__interface__gr.html#a808703d6c70a501464e156e55f5cabd2", null ],
[ "data_width_4_ddr", "group__mci__interface__gr.html#abb1a604b0ee4f7e3510409747890e41e", null ],
[ "data_width_8_ddr", "group__mci__interface__gr.html#acd5f6dce3a548d12c292e8cd17e4e9e2", null ],
[ "high_speed", "group__mci__interface__gr.html#a83ecf7d4472c55362750ef72d8f8f47d", null ],
[ "uhs_signaling", "group__mci__interface__gr.html#a084188480d589cdc8d3e164b9f41bea9", null ],
[ "uhs_tuning", "group__mci__interface__gr.html#a617bf7fb73b49a20398b90098ecc3ec0", null ],
[ "uhs_sdr50", "group__mci__interface__gr.html#a5c3dcb2f8aa6f65408d9a6741abb7b3e", null ],
[ "uhs_sdr104", "group__mci__interface__gr.html#ae07ceef1800252495a79f225142740e7", null ],
[ "uhs_ddr50", "group__mci__interface__gr.html#a1ee73c19020d5f1bedf7c013d0e5f730", null ],
[ "uhs_driver_type_a", "group__mci__interface__gr.html#afe5de4fdc6657aa19fa87577a8d460e5", null ],
[ "uhs_driver_type_c", "group__mci__interface__gr.html#a3c3df9641e7216dd20d3bc395dc4948f", null ],
[ "uhs_driver_type_d", "group__mci__interface__gr.html#a639bebbcb9a3a743f4f232fec82e2bfc", null ],
[ "sdio_interrupt", "group__mci__interface__gr.html#a61e2a440b27d7d22c866ad4427f4b825", null ],
[ "read_wait", "group__mci__interface__gr.html#a5e38e4ee9cebcc99904e287adc8e6217", null ],
[ "suspend_resume", "group__mci__interface__gr.html#abb03f0187e4658f417b5a24cac33eed9", null ],
[ "mmc_interrupt", "group__mci__interface__gr.html#a3303194ea68bd1094841d4f958f6dbbf", null ],
[ "mmc_boot", "group__mci__interface__gr.html#a072a194948489d4dbd2409b94fdca56b", null ],
[ "rst_n", "group__mci__interface__gr.html#a2e8bd27f2c5c3093c4fec557890b97d4", null ],
[ "ccs", "group__mci__interface__gr.html#a13c956ba993083f1e59379968e2badbe", null ],
[ "ccs_timeout", "group__mci__interface__gr.html#a9739c230a13b46482feb5475d257e482", null ],
[ "reserved", "group__mci__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__interface__gr_structARM__MCI__CAPABILITIES.js | JavaScript | apache-2.0 | 2,951 |
var group__mci__interface__gr_structARM__MCI__STATUS =
[
[ "command_active", "group__mci__interface__gr.html#aa22ef7c7597e90835bd67d5795ba757e", null ],
[ "command_timeout", "group__mci__interface__gr.html#a56e426979c3872254c156e9ae7eead5b", null ],
[ "command_error", "group__mci__interface__gr.html#afca11cd2ce661c67455a6d75328848cc", null ],
[ "transfer_active", "group__mci__interface__gr.html#a2655d3422b720097b091a28e8bbcea8f", null ],
[ "transfer_timeout", "group__mci__interface__gr.html#a598ae4a196316d6dcb97d07fd337ecdd", null ],
[ "transfer_error", "group__mci__interface__gr.html#a21d4bc1a03e161bd33693619039a6afa", null ],
[ "sdio_interrupt", "group__mci__interface__gr.html#a61e2a440b27d7d22c866ad4427f4b825", null ],
[ "ccs", "group__mci__interface__gr.html#a13c956ba993083f1e59379968e2badbe", null ],
[ "reserved", "group__mci__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__interface__gr_structARM__MCI__STATUS.js | JavaScript | apache-2.0 | 944 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>MCI Controls</title>
<title>CMSIS-Driver: MCI Controls</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__mci__mode__ctrls.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">MCI Controls<div class="ingroups"><a class="el" href="group__mci__control__gr.html">MCI Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Configure and control the MCI interface.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga7f982d2e5aec768307d35a83c65fb3ef"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__mode__ctrls.html#ga7f982d2e5aec768307d35a83c65fb3ef">ARM_MCI_BUS_SPEED</a>   (0x01)</td></tr>
<tr class="memdesc:ga7f982d2e5aec768307d35a83c65fb3ef"><td class="mdescLeft"> </td><td class="mdescRight">Set Bus Speed; arg = requested speed in bits/s; returns configured speed in bits/s. <a href="#ga7f982d2e5aec768307d35a83c65fb3ef">More...</a><br/></td></tr>
<tr class="separator:ga7f982d2e5aec768307d35a83c65fb3ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf7ede525eabc618fbbb9f7a294c8ed96"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__mode__ctrls.html#gaf7ede525eabc618fbbb9f7a294c8ed96">ARM_MCI_BUS_SPEED_MODE</a>   (0x02)</td></tr>
<tr class="memdesc:gaf7ede525eabc618fbbb9f7a294c8ed96"><td class="mdescLeft"> </td><td class="mdescRight">Set Bus Speed Mode as specified with arg. <a href="#gaf7ede525eabc618fbbb9f7a294c8ed96">More...</a><br/></td></tr>
<tr class="separator:gaf7ede525eabc618fbbb9f7a294c8ed96"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8b7571e37520c07d8ef4f697f3886715"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__mode__ctrls.html#ga8b7571e37520c07d8ef4f697f3886715">ARM_MCI_BUS_CMD_MODE</a>   (0x03)</td></tr>
<tr class="memdesc:ga8b7571e37520c07d8ef4f697f3886715"><td class="mdescLeft"> </td><td class="mdescRight">Set CMD Line Mode as specified with arg. <a href="#ga8b7571e37520c07d8ef4f697f3886715">More...</a><br/></td></tr>
<tr class="separator:ga8b7571e37520c07d8ef4f697f3886715"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga876d964d0eeacdb16e93f7558a544587"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__mode__ctrls.html#ga876d964d0eeacdb16e93f7558a544587">ARM_MCI_BUS_DATA_WIDTH</a>   (0x04)</td></tr>
<tr class="memdesc:ga876d964d0eeacdb16e93f7558a544587"><td class="mdescLeft"> </td><td class="mdescRight">Set Bus Data Width as specified with arg. <a href="#ga876d964d0eeacdb16e93f7558a544587">More...</a><br/></td></tr>
<tr class="separator:ga876d964d0eeacdb16e93f7558a544587"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga78068f519139f2ae7b09e0608070aaf6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__mode__ctrls.html#ga78068f519139f2ae7b09e0608070aaf6">ARM_MCI_DRIVER_STRENGTH</a>   (0x05)</td></tr>
<tr class="memdesc:ga78068f519139f2ae7b09e0608070aaf6"><td class="mdescLeft"> </td><td class="mdescRight">Set SD UHS-I Driver Strength as specified with arg. <a href="#ga78068f519139f2ae7b09e0608070aaf6">More...</a><br/></td></tr>
<tr class="separator:ga78068f519139f2ae7b09e0608070aaf6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga21e403e8c3fa8cc75431a513813f0a16"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__mode__ctrls.html#ga21e403e8c3fa8cc75431a513813f0a16">ARM_MCI_CONTROL_RESET</a>   (0x06)</td></tr>
<tr class="memdesc:ga21e403e8c3fa8cc75431a513813f0a16"><td class="mdescLeft"> </td><td class="mdescRight">Control optional RST_n Pin (eMMC); arg: 0=inactive, 1=active. <a href="#ga21e403e8c3fa8cc75431a513813f0a16">More...</a><br/></td></tr>
<tr class="separator:ga21e403e8c3fa8cc75431a513813f0a16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga889473fbfbdcb89aab4d53cc8a13f615"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__mode__ctrls.html#ga889473fbfbdcb89aab4d53cc8a13f615">ARM_MCI_CONTROL_CLOCK_IDLE</a>   (0x07)</td></tr>
<tr class="memdesc:ga889473fbfbdcb89aab4d53cc8a13f615"><td class="mdescLeft"> </td><td class="mdescRight">Control Clock generation on CLK Pin when idle; arg: 0=disabled, 1=enabled. <a href="#ga889473fbfbdcb89aab4d53cc8a13f615">More...</a><br/></td></tr>
<tr class="separator:ga889473fbfbdcb89aab4d53cc8a13f615"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga98853f60bdc085aeeccd66f7bdf22d3d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__mode__ctrls.html#ga98853f60bdc085aeeccd66f7bdf22d3d">ARM_MCI_UHS_TUNING_OPERATION</a>   (0x08)</td></tr>
<tr class="memdesc:ga98853f60bdc085aeeccd66f7bdf22d3d"><td class="mdescLeft"> </td><td class="mdescRight">Sampling clock Tuning operation (SD UHS-I); arg: 0=reset, 1=execute. <a href="#ga98853f60bdc085aeeccd66f7bdf22d3d">More...</a><br/></td></tr>
<tr class="separator:ga98853f60bdc085aeeccd66f7bdf22d3d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabd3af448e26da5657c1c5a03330476b7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__mode__ctrls.html#gabd3af448e26da5657c1c5a03330476b7">ARM_MCI_UHS_TUNING_RESULT</a>   (0x09)</td></tr>
<tr class="memdesc:gabd3af448e26da5657c1c5a03330476b7"><td class="mdescLeft"> </td><td class="mdescRight">Sampling clock Tuning result (SD UHS-I); returns: 0=done, 1=in progress, -1=error. <a href="#gabd3af448e26da5657c1c5a03330476b7">More...</a><br/></td></tr>
<tr class="separator:gabd3af448e26da5657c1c5a03330476b7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga09a58821e42595f0c2e55f8cc2d32ceb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__mode__ctrls.html#ga09a58821e42595f0c2e55f8cc2d32ceb">ARM_MCI_DATA_TIMEOUT</a>   (0x0A)</td></tr>
<tr class="memdesc:ga09a58821e42595f0c2e55f8cc2d32ceb"><td class="mdescLeft"> </td><td class="mdescRight">Set Data timeout; arg = timeout in bus cycles. <a href="#ga09a58821e42595f0c2e55f8cc2d32ceb">More...</a><br/></td></tr>
<tr class="separator:ga09a58821e42595f0c2e55f8cc2d32ceb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae97b1a819a5d326b1f1009b0d6d48b5a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__mode__ctrls.html#gae97b1a819a5d326b1f1009b0d6d48b5a">ARM_MCI_CSS_TIMEOUT</a>   (0x0B)</td></tr>
<tr class="memdesc:gae97b1a819a5d326b1f1009b0d6d48b5a"><td class="mdescLeft"> </td><td class="mdescRight">Set Command Completion Signal (CCS) timeout; arg = timeout in bus cycles. <a href="#gae97b1a819a5d326b1f1009b0d6d48b5a">More...</a><br/></td></tr>
<tr class="separator:gae97b1a819a5d326b1f1009b0d6d48b5a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga19fd7d3b74ac48ca74a2e138b3ee9963"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__mode__ctrls.html#ga19fd7d3b74ac48ca74a2e138b3ee9963">ARM_MCI_MONITOR_SDIO_INTERRUPT</a>   (0x0C)</td></tr>
<tr class="memdesc:ga19fd7d3b74ac48ca74a2e138b3ee9963"><td class="mdescLeft"> </td><td class="mdescRight">Monitor SD I/O interrupt: arg: 0=disabled, 1=enabled. <a href="#ga19fd7d3b74ac48ca74a2e138b3ee9963">More...</a><br/></td></tr>
<tr class="separator:ga19fd7d3b74ac48ca74a2e138b3ee9963"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaa10c5aa7a8108aa59c3734b3eec2e3a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__mode__ctrls.html#gaaa10c5aa7a8108aa59c3734b3eec2e3a">ARM_MCI_CONTROL_READ_WAIT</a>   (0x0D)</td></tr>
<tr class="memdesc:gaaa10c5aa7a8108aa59c3734b3eec2e3a"><td class="mdescLeft"> </td><td class="mdescRight">Control Read/Wait for SD I/O; arg: 0=disabled, 1=enabled. <a href="#gaaa10c5aa7a8108aa59c3734b3eec2e3a">More...</a><br/></td></tr>
<tr class="separator:gaaa10c5aa7a8108aa59c3734b3eec2e3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga04cf174b0ef13240f26225bf8e45a4a0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__mode__ctrls.html#ga04cf174b0ef13240f26225bf8e45a4a0">ARM_MCI_SUSPEND_TRANSFER</a>   (0x0E)</td></tr>
<tr class="memdesc:ga04cf174b0ef13240f26225bf8e45a4a0"><td class="mdescLeft"> </td><td class="mdescRight">Suspend Data transfer (SD I/O); returns number of remaining bytes to transfer. <a href="#ga04cf174b0ef13240f26225bf8e45a4a0">More...</a><br/></td></tr>
<tr class="separator:ga04cf174b0ef13240f26225bf8e45a4a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac4907319499072fddf61f2f83b0dd966"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__mode__ctrls.html#gac4907319499072fddf61f2f83b0dd966">ARM_MCI_RESUME_TRANSFER</a>   (0x0F)</td></tr>
<tr class="memdesc:gac4907319499072fddf61f2f83b0dd966"><td class="mdescLeft"> </td><td class="mdescRight">Resume Data transfer (SD I/O) <a href="#gac4907319499072fddf61f2f83b0dd966">More...</a><br/></td></tr>
<tr class="separator:gac4907319499072fddf61f2f83b0dd966"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Configure and control the MCI interface. </p>
<p>The following codes are used as values for the parameter <em>control</em> of the function <a class="el" href="group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30">ARM_MCI_Control</a> to setup the MCI interface. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga7f982d2e5aec768307d35a83c65fb3ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BUS_SPEED   (0x01)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Bus Speed; arg = requested speed in bits/s; returns configured speed in bits/s. </p>
</div>
</div>
<a class="anchor" id="gaf7ede525eabc618fbbb9f7a294c8ed96"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BUS_SPEED_MODE   (0x02)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Bus Speed Mode as specified with arg. </p>
</div>
</div>
<a class="anchor" id="ga8b7571e37520c07d8ef4f697f3886715"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BUS_CMD_MODE   (0x03)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set CMD Line Mode as specified with arg. </p>
</div>
</div>
<a class="anchor" id="ga876d964d0eeacdb16e93f7558a544587"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BUS_DATA_WIDTH   (0x04)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Bus Data Width as specified with arg. </p>
</div>
</div>
<a class="anchor" id="ga78068f519139f2ae7b09e0608070aaf6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_DRIVER_STRENGTH   (0x05)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set SD UHS-I Driver Strength as specified with arg. </p>
</div>
</div>
<a class="anchor" id="ga21e403e8c3fa8cc75431a513813f0a16"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_CONTROL_RESET   (0x06)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Control optional RST_n Pin (eMMC); arg: 0=inactive, 1=active. </p>
</div>
</div>
<a class="anchor" id="ga889473fbfbdcb89aab4d53cc8a13f615"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_CONTROL_CLOCK_IDLE   (0x07)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Control Clock generation on CLK Pin when idle; arg: 0=disabled, 1=enabled. </p>
</div>
</div>
<a class="anchor" id="ga98853f60bdc085aeeccd66f7bdf22d3d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_UHS_TUNING_OPERATION   (0x08)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sampling clock Tuning operation (SD UHS-I); arg: 0=reset, 1=execute. </p>
</div>
</div>
<a class="anchor" id="gabd3af448e26da5657c1c5a03330476b7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_UHS_TUNING_RESULT   (0x09)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sampling clock Tuning result (SD UHS-I); returns: 0=done, 1=in progress, -1=error. </p>
</div>
</div>
<a class="anchor" id="ga09a58821e42595f0c2e55f8cc2d32ceb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_DATA_TIMEOUT   (0x0A)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Data timeout; arg = timeout in bus cycles. </p>
</div>
</div>
<a class="anchor" id="gae97b1a819a5d326b1f1009b0d6d48b5a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_CSS_TIMEOUT   (0x0B)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Command Completion Signal (CCS) timeout; arg = timeout in bus cycles. </p>
</div>
</div>
<a class="anchor" id="ga19fd7d3b74ac48ca74a2e138b3ee9963"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_MONITOR_SDIO_INTERRUPT   (0x0C)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Monitor SD I/O interrupt: arg: 0=disabled, 1=enabled. </p>
</div>
</div>
<a class="anchor" id="gaaa10c5aa7a8108aa59c3734b3eec2e3a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_CONTROL_READ_WAIT   (0x0D)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Control Read/Wait for SD I/O; arg: 0=disabled, 1=enabled. </p>
</div>
</div>
<a class="anchor" id="ga04cf174b0ef13240f26225bf8e45a4a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_SUSPEND_TRANSFER   (0x0E)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Suspend Data transfer (SD I/O); returns number of remaining bytes to transfer. </p>
</div>
</div>
<a class="anchor" id="gac4907319499072fddf61f2f83b0dd966"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_RESUME_TRANSFER   (0x0F)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Resume Data transfer (SD I/O) </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__mode__ctrls.html | HTML | apache-2.0 | 22,744 |
var group__mci__mode__ctrls =
[
[ "ARM_MCI_BUS_SPEED", "group__mci__mode__ctrls.html#ga7f982d2e5aec768307d35a83c65fb3ef", null ],
[ "ARM_MCI_BUS_SPEED_MODE", "group__mci__mode__ctrls.html#gaf7ede525eabc618fbbb9f7a294c8ed96", null ],
[ "ARM_MCI_BUS_CMD_MODE", "group__mci__mode__ctrls.html#ga8b7571e37520c07d8ef4f697f3886715", null ],
[ "ARM_MCI_BUS_DATA_WIDTH", "group__mci__mode__ctrls.html#ga876d964d0eeacdb16e93f7558a544587", null ],
[ "ARM_MCI_DRIVER_STRENGTH", "group__mci__mode__ctrls.html#ga78068f519139f2ae7b09e0608070aaf6", null ],
[ "ARM_MCI_CONTROL_RESET", "group__mci__mode__ctrls.html#ga21e403e8c3fa8cc75431a513813f0a16", null ],
[ "ARM_MCI_CONTROL_CLOCK_IDLE", "group__mci__mode__ctrls.html#ga889473fbfbdcb89aab4d53cc8a13f615", null ],
[ "ARM_MCI_UHS_TUNING_OPERATION", "group__mci__mode__ctrls.html#ga98853f60bdc085aeeccd66f7bdf22d3d", null ],
[ "ARM_MCI_UHS_TUNING_RESULT", "group__mci__mode__ctrls.html#gabd3af448e26da5657c1c5a03330476b7", null ],
[ "ARM_MCI_DATA_TIMEOUT", "group__mci__mode__ctrls.html#ga09a58821e42595f0c2e55f8cc2d32ceb", null ],
[ "ARM_MCI_CSS_TIMEOUT", "group__mci__mode__ctrls.html#gae97b1a819a5d326b1f1009b0d6d48b5a", null ],
[ "ARM_MCI_MONITOR_SDIO_INTERRUPT", "group__mci__mode__ctrls.html#ga19fd7d3b74ac48ca74a2e138b3ee9963", null ],
[ "ARM_MCI_CONTROL_READ_WAIT", "group__mci__mode__ctrls.html#gaaa10c5aa7a8108aa59c3734b3eec2e3a", null ],
[ "ARM_MCI_SUSPEND_TRANSFER", "group__mci__mode__ctrls.html#ga04cf174b0ef13240f26225bf8e45a4a0", null ],
[ "ARM_MCI_RESUME_TRANSFER", "group__mci__mode__ctrls.html#gac4907319499072fddf61f2f83b0dd966", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__mode__ctrls.js | JavaScript | apache-2.0 | 1,653 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>MCI Send Command Flags</title>
<title>CMSIS-Driver: MCI Send Command Flags</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__mci__send__command__flags__ctrls.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">MCI Send Command Flags<div class="ingroups"><a class="el" href="group__mci__interface__gr.html">MCI Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify various options for sending commands to the card and the expected response.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga70934cef80884e8c75fb4eebf8452118"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga70934cef80884e8c75fb4eebf8452118">ARM_MCI_RESPONSE_NONE</a>   (0UL << ARM_MCI_RESPONSE_Pos)</td></tr>
<tr class="memdesc:ga70934cef80884e8c75fb4eebf8452118"><td class="mdescLeft"> </td><td class="mdescRight">No response expected (default) <a href="#ga70934cef80884e8c75fb4eebf8452118">More...</a><br/></td></tr>
<tr class="separator:ga70934cef80884e8c75fb4eebf8452118"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa5ddf1cf772b234e3c247039effd0e7b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__send__command__flags__ctrls.html#gaa5ddf1cf772b234e3c247039effd0e7b">ARM_MCI_RESPONSE_SHORT</a>   (1UL << ARM_MCI_RESPONSE_Pos)</td></tr>
<tr class="memdesc:gaa5ddf1cf772b234e3c247039effd0e7b"><td class="mdescLeft"> </td><td class="mdescRight">Short response (48-bit) <a href="#gaa5ddf1cf772b234e3c247039effd0e7b">More...</a><br/></td></tr>
<tr class="separator:gaa5ddf1cf772b234e3c247039effd0e7b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa1d541b0edf32ec05e68d623c727ef9c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__send__command__flags__ctrls.html#gaa1d541b0edf32ec05e68d623c727ef9c">ARM_MCI_RESPONSE_SHORT_BUSY</a>   (2UL << ARM_MCI_RESPONSE_Pos)</td></tr>
<tr class="memdesc:gaa1d541b0edf32ec05e68d623c727ef9c"><td class="mdescLeft"> </td><td class="mdescRight">Short response with busy signal (48-bit) <a href="#gaa1d541b0edf32ec05e68d623c727ef9c">More...</a><br/></td></tr>
<tr class="separator:gaa1d541b0edf32ec05e68d623c727ef9c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac49c7b39a7c51bd2193e048835bec2fb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__send__command__flags__ctrls.html#gac49c7b39a7c51bd2193e048835bec2fb">ARM_MCI_RESPONSE_LONG</a>   (3UL << ARM_MCI_RESPONSE_Pos)</td></tr>
<tr class="memdesc:gac49c7b39a7c51bd2193e048835bec2fb"><td class="mdescLeft"> </td><td class="mdescRight">Long response (136-bit) <a href="#gac49c7b39a7c51bd2193e048835bec2fb">More...</a><br/></td></tr>
<tr class="separator:gac49c7b39a7c51bd2193e048835bec2fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga497abf878c6e12f54cc7ddb92da76c4a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga497abf878c6e12f54cc7ddb92da76c4a">ARM_MCI_RESPONSE_INDEX</a>   (1UL << 2)</td></tr>
<tr class="memdesc:ga497abf878c6e12f54cc7ddb92da76c4a"><td class="mdescLeft"> </td><td class="mdescRight">Check command index in response. <a href="#ga497abf878c6e12f54cc7ddb92da76c4a">More...</a><br/></td></tr>
<tr class="separator:ga497abf878c6e12f54cc7ddb92da76c4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6ab3f4c1a2bf0fdb81fbcf7a5698f2de"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga6ab3f4c1a2bf0fdb81fbcf7a5698f2de">ARM_MCI_RESPONSE_CRC</a>   (1UL << 3)</td></tr>
<tr class="memdesc:ga6ab3f4c1a2bf0fdb81fbcf7a5698f2de"><td class="mdescLeft"> </td><td class="mdescRight">Check CRC in response. <a href="#ga6ab3f4c1a2bf0fdb81fbcf7a5698f2de">More...</a><br/></td></tr>
<tr class="separator:ga6ab3f4c1a2bf0fdb81fbcf7a5698f2de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga68e879799bb27a1b13baf57ed19d719d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga68e879799bb27a1b13baf57ed19d719d">ARM_MCI_WAIT_BUSY</a>   (1UL << 4)</td></tr>
<tr class="memdesc:ga68e879799bb27a1b13baf57ed19d719d"><td class="mdescLeft"> </td><td class="mdescRight">Wait until busy before sending the command. <a href="#ga68e879799bb27a1b13baf57ed19d719d">More...</a><br/></td></tr>
<tr class="separator:ga68e879799bb27a1b13baf57ed19d719d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8aa566f69aa74ed416213df6ca3267bd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga8aa566f69aa74ed416213df6ca3267bd">ARM_MCI_TRANSFER_DATA</a>   (1UL << 5)</td></tr>
<tr class="memdesc:ga8aa566f69aa74ed416213df6ca3267bd"><td class="mdescLeft"> </td><td class="mdescRight">Activate Data transfer. <a href="#ga8aa566f69aa74ed416213df6ca3267bd">More...</a><br/></td></tr>
<tr class="separator:ga8aa566f69aa74ed416213df6ca3267bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga81606bd94ce782e2c3764b913f929f60"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga81606bd94ce782e2c3764b913f929f60">ARM_MCI_CARD_INITIALIZE</a>   (1UL << 6)</td></tr>
<tr class="memdesc:ga81606bd94ce782e2c3764b913f929f60"><td class="mdescLeft"> </td><td class="mdescRight">Execute Memory Card initialization sequence. <a href="#ga81606bd94ce782e2c3764b913f929f60">More...</a><br/></td></tr>
<tr class="separator:ga81606bd94ce782e2c3764b913f929f60"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab2bfeedf1dc2df1872ebbcc559a7385a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__send__command__flags__ctrls.html#gab2bfeedf1dc2df1872ebbcc559a7385a">ARM_MCI_INTERRUPT_COMMAND</a>   (1UL << 7)</td></tr>
<tr class="memdesc:gab2bfeedf1dc2df1872ebbcc559a7385a"><td class="mdescLeft"> </td><td class="mdescRight">Send Interrupt command (CMD40 - MMC only) <a href="#gab2bfeedf1dc2df1872ebbcc559a7385a">More...</a><br/></td></tr>
<tr class="separator:gab2bfeedf1dc2df1872ebbcc559a7385a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabc31b6b26988998c84c92a9a698fd5dc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__send__command__flags__ctrls.html#gabc31b6b26988998c84c92a9a698fd5dc">ARM_MCI_INTERRUPT_RESPONSE</a>   (1UL << 8)</td></tr>
<tr class="memdesc:gabc31b6b26988998c84c92a9a698fd5dc"><td class="mdescLeft"> </td><td class="mdescRight">Send Interrupt response (CMD40 - MMC only) <a href="#gabc31b6b26988998c84c92a9a698fd5dc">More...</a><br/></td></tr>
<tr class="separator:gabc31b6b26988998c84c92a9a698fd5dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae04254f51dfd9838583206cae0a5f8f7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__send__command__flags__ctrls.html#gae04254f51dfd9838583206cae0a5f8f7">ARM_MCI_BOOT_OPERATION</a>   (1UL << 9)</td></tr>
<tr class="memdesc:gae04254f51dfd9838583206cae0a5f8f7"><td class="mdescLeft"> </td><td class="mdescRight">Execute Boot operation (MMC only) <a href="#gae04254f51dfd9838583206cae0a5f8f7">More...</a><br/></td></tr>
<tr class="separator:gae04254f51dfd9838583206cae0a5f8f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga30bd304652d4f870ee7ce61c266a9348"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga30bd304652d4f870ee7ce61c266a9348">ARM_MCI_BOOT_ALTERNATIVE</a>   (1UL << 10)</td></tr>
<tr class="memdesc:ga30bd304652d4f870ee7ce61c266a9348"><td class="mdescLeft"> </td><td class="mdescRight">Execute Alternative Boot operation (MMC only) <a href="#ga30bd304652d4f870ee7ce61c266a9348">More...</a><br/></td></tr>
<tr class="separator:ga30bd304652d4f870ee7ce61c266a9348"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8c55bc0a310630d49810802ccd1bb10d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga8c55bc0a310630d49810802ccd1bb10d">ARM_MCI_BOOT_ACK</a>   (1UL << 11)</td></tr>
<tr class="memdesc:ga8c55bc0a310630d49810802ccd1bb10d"><td class="mdescLeft"> </td><td class="mdescRight">Expect Boot Acknowledge (MMC only) <a href="#ga8c55bc0a310630d49810802ccd1bb10d">More...</a><br/></td></tr>
<tr class="separator:ga8c55bc0a310630d49810802ccd1bb10d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab9df5169b37621764f8bb0f93db5281a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__send__command__flags__ctrls.html#gab9df5169b37621764f8bb0f93db5281a">ARM_MCI_CCSD</a>   (1UL << 12)</td></tr>
<tr class="memdesc:gab9df5169b37621764f8bb0f93db5281a"><td class="mdescLeft"> </td><td class="mdescRight">Send Command Completion Signal Disable (CCSD) for CE-ATA device. <a href="#gab9df5169b37621764f8bb0f93db5281a">More...</a><br/></td></tr>
<tr class="separator:gab9df5169b37621764f8bb0f93db5281a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab82c472e4ca3fca12ae3291e25997f00"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__send__command__flags__ctrls.html#gab82c472e4ca3fca12ae3291e25997f00">ARM_MCI_CCS</a>   (1UL << 13)</td></tr>
<tr class="memdesc:gab82c472e4ca3fca12ae3291e25997f00"><td class="mdescLeft"> </td><td class="mdescRight">Expect Command Completion Signal (CCS) for CE-ATA device. <a href="#gab82c472e4ca3fca12ae3291e25997f00">More...</a><br/></td></tr>
<tr class="separator:gab82c472e4ca3fca12ae3291e25997f00"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify various options for sending commands to the card and the expected response. </p>
<p><b>ARM_MCI_xxx</b> flags are sent with the function <a class="el" href="group__mci__interface__gr.html#ga5a431da89feabc2b4bc0c27943dff6f2">ARM_MCI_SendCommand</a> as the parameter <em>flag</em>. It controls the behavior of the command sent to the card and provides information about the expected response from the card.</p>
<p>The following codes are defined: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga70934cef80884e8c75fb4eebf8452118"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_RESPONSE_NONE   (0UL << ARM_MCI_RESPONSE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>No response expected (default) </p>
</div>
</div>
<a class="anchor" id="gaa5ddf1cf772b234e3c247039effd0e7b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_RESPONSE_SHORT   (1UL << ARM_MCI_RESPONSE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Short response (48-bit) </p>
</div>
</div>
<a class="anchor" id="gaa1d541b0edf32ec05e68d623c727ef9c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_RESPONSE_SHORT_BUSY   (2UL << ARM_MCI_RESPONSE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Short response with busy signal (48-bit) </p>
</div>
</div>
<a class="anchor" id="gac49c7b39a7c51bd2193e048835bec2fb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_RESPONSE_LONG   (3UL << ARM_MCI_RESPONSE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Long response (136-bit) </p>
</div>
</div>
<a class="anchor" id="ga497abf878c6e12f54cc7ddb92da76c4a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_RESPONSE_INDEX   (1UL << 2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Check command index in response. </p>
</div>
</div>
<a class="anchor" id="ga6ab3f4c1a2bf0fdb81fbcf7a5698f2de"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_RESPONSE_CRC   (1UL << 3)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Check CRC in response. </p>
</div>
</div>
<a class="anchor" id="ga68e879799bb27a1b13baf57ed19d719d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_WAIT_BUSY   (1UL << 4)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Wait until busy before sending the command. </p>
</div>
</div>
<a class="anchor" id="ga8aa566f69aa74ed416213df6ca3267bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_TRANSFER_DATA   (1UL << 5)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Activate Data transfer. </p>
</div>
</div>
<a class="anchor" id="ga81606bd94ce782e2c3764b913f929f60"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_CARD_INITIALIZE   (1UL << 6)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Execute Memory Card initialization sequence. </p>
</div>
</div>
<a class="anchor" id="gab2bfeedf1dc2df1872ebbcc559a7385a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_INTERRUPT_COMMAND   (1UL << 7)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Interrupt command (CMD40 - MMC only) </p>
</div>
</div>
<a class="anchor" id="gabc31b6b26988998c84c92a9a698fd5dc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_INTERRUPT_RESPONSE   (1UL << 8)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Interrupt response (CMD40 - MMC only) </p>
</div>
</div>
<a class="anchor" id="gae04254f51dfd9838583206cae0a5f8f7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BOOT_OPERATION   (1UL << 9)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Execute Boot operation (MMC only) </p>
</div>
</div>
<a class="anchor" id="ga30bd304652d4f870ee7ce61c266a9348"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BOOT_ALTERNATIVE   (1UL << 10)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Execute Alternative Boot operation (MMC only) </p>
</div>
</div>
<a class="anchor" id="ga8c55bc0a310630d49810802ccd1bb10d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_BOOT_ACK   (1UL << 11)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Expect Boot Acknowledge (MMC only) </p>
</div>
</div>
<a class="anchor" id="gab9df5169b37621764f8bb0f93db5281a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_CCSD   (1UL << 12)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Command Completion Signal Disable (CCSD) for CE-ATA device. </p>
</div>
</div>
<a class="anchor" id="gab82c472e4ca3fca12ae3291e25997f00"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_CCS   (1UL << 13)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Expect Command Completion Signal (CCS) for CE-ATA device. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__send__command__flags__ctrls.html | HTML | apache-2.0 | 24,039 |
var group__mci__send__command__flags__ctrls =
[
[ "ARM_MCI_RESPONSE_NONE", "group__mci__send__command__flags__ctrls.html#ga70934cef80884e8c75fb4eebf8452118", null ],
[ "ARM_MCI_RESPONSE_SHORT", "group__mci__send__command__flags__ctrls.html#gaa5ddf1cf772b234e3c247039effd0e7b", null ],
[ "ARM_MCI_RESPONSE_SHORT_BUSY", "group__mci__send__command__flags__ctrls.html#gaa1d541b0edf32ec05e68d623c727ef9c", null ],
[ "ARM_MCI_RESPONSE_LONG", "group__mci__send__command__flags__ctrls.html#gac49c7b39a7c51bd2193e048835bec2fb", null ],
[ "ARM_MCI_RESPONSE_INDEX", "group__mci__send__command__flags__ctrls.html#ga497abf878c6e12f54cc7ddb92da76c4a", null ],
[ "ARM_MCI_RESPONSE_CRC", "group__mci__send__command__flags__ctrls.html#ga6ab3f4c1a2bf0fdb81fbcf7a5698f2de", null ],
[ "ARM_MCI_WAIT_BUSY", "group__mci__send__command__flags__ctrls.html#ga68e879799bb27a1b13baf57ed19d719d", null ],
[ "ARM_MCI_TRANSFER_DATA", "group__mci__send__command__flags__ctrls.html#ga8aa566f69aa74ed416213df6ca3267bd", null ],
[ "ARM_MCI_CARD_INITIALIZE", "group__mci__send__command__flags__ctrls.html#ga81606bd94ce782e2c3764b913f929f60", null ],
[ "ARM_MCI_INTERRUPT_COMMAND", "group__mci__send__command__flags__ctrls.html#gab2bfeedf1dc2df1872ebbcc559a7385a", null ],
[ "ARM_MCI_INTERRUPT_RESPONSE", "group__mci__send__command__flags__ctrls.html#gabc31b6b26988998c84c92a9a698fd5dc", null ],
[ "ARM_MCI_BOOT_OPERATION", "group__mci__send__command__flags__ctrls.html#gae04254f51dfd9838583206cae0a5f8f7", null ],
[ "ARM_MCI_BOOT_ALTERNATIVE", "group__mci__send__command__flags__ctrls.html#ga30bd304652d4f870ee7ce61c266a9348", null ],
[ "ARM_MCI_BOOT_ACK", "group__mci__send__command__flags__ctrls.html#ga8c55bc0a310630d49810802ccd1bb10d", null ],
[ "ARM_MCI_CCSD", "group__mci__send__command__flags__ctrls.html#gab9df5169b37621764f8bb0f93db5281a", null ],
[ "ARM_MCI_CCS", "group__mci__send__command__flags__ctrls.html#gab82c472e4ca3fca12ae3291e25997f00", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__send__command__flags__ctrls.js | JavaScript | apache-2.0 | 1,995 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>MCI Transfer Controls</title>
<title>CMSIS-Driver: MCI Transfer Controls</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__mci__transfer__ctrls.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">MCI Transfer Controls<div class="ingroups"><a class="el" href="group__mci__interface__gr.html">MCI Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify data transfer mode.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaa6f3be235a9dce5c66be8fe64f399846"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__transfer__ctrls.html#gaa6f3be235a9dce5c66be8fe64f399846">ARM_MCI_TRANSFER_READ</a>   (0UL << 0)</td></tr>
<tr class="memdesc:gaa6f3be235a9dce5c66be8fe64f399846"><td class="mdescLeft"> </td><td class="mdescRight">Data Read Transfer (from MCI) <a href="#gaa6f3be235a9dce5c66be8fe64f399846">More...</a><br/></td></tr>
<tr class="separator:gaa6f3be235a9dce5c66be8fe64f399846"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaddc60aab15f75993a99f98f71ddbd50c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__transfer__ctrls.html#gaddc60aab15f75993a99f98f71ddbd50c">ARM_MCI_TRANSFER_WRITE</a>   (1UL << 0)</td></tr>
<tr class="memdesc:gaddc60aab15f75993a99f98f71ddbd50c"><td class="mdescLeft"> </td><td class="mdescRight">Data Write Transfer (to MCI) <a href="#gaddc60aab15f75993a99f98f71ddbd50c">More...</a><br/></td></tr>
<tr class="separator:gaddc60aab15f75993a99f98f71ddbd50c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4ced782e7c0c70d5f0edbddd1e48323b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__transfer__ctrls.html#ga4ced782e7c0c70d5f0edbddd1e48323b">ARM_MCI_TRANSFER_BLOCK</a>   (0UL << 1)</td></tr>
<tr class="memdesc:ga4ced782e7c0c70d5f0edbddd1e48323b"><td class="mdescLeft"> </td><td class="mdescRight">Block Data transfer (default) <a href="#ga4ced782e7c0c70d5f0edbddd1e48323b">More...</a><br/></td></tr>
<tr class="separator:ga4ced782e7c0c70d5f0edbddd1e48323b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac7db0cffd571e60758627d889ba7a432"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__transfer__ctrls.html#gac7db0cffd571e60758627d889ba7a432">ARM_MCI_TRANSFER_STREAM</a>   (1UL << 1)</td></tr>
<tr class="memdesc:gac7db0cffd571e60758627d889ba7a432"><td class="mdescLeft"> </td><td class="mdescRight">Stream Data transfer (MMC only) <a href="#gac7db0cffd571e60758627d889ba7a432">More...</a><br/></td></tr>
<tr class="separator:gac7db0cffd571e60758627d889ba7a432"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify data transfer mode. </p>
<p>Data transfer codes specifies the transfer direction and type and are used with the function <a class="el" href="group__mci__interface__gr.html#gaaec681bcd8e6811c5743e33ee0f35ed1">ARM_MCI_SetupTransfer</a> as the parameter <em>mode</em>.</p>
<p>The following codes are defined: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gaa6f3be235a9dce5c66be8fe64f399846"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_TRANSFER_READ   (0UL << 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Data Read Transfer (from MCI) </p>
</div>
</div>
<a class="anchor" id="gaddc60aab15f75993a99f98f71ddbd50c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_TRANSFER_WRITE   (1UL << 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Data Write Transfer (to MCI) </p>
</div>
</div>
<a class="anchor" id="ga4ced782e7c0c70d5f0edbddd1e48323b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_TRANSFER_BLOCK   (0UL << 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Block Data transfer (default) </p>
</div>
</div>
<a class="anchor" id="gac7db0cffd571e60758627d889ba7a432"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_MCI_TRANSFER_STREAM   (1UL << 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Stream Data transfer (MMC only) </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__transfer__ctrls.html | HTML | apache-2.0 | 11,116 |
var group__mci__transfer__ctrls =
[
[ "ARM_MCI_TRANSFER_READ", "group__mci__transfer__ctrls.html#gaa6f3be235a9dce5c66be8fe64f399846", null ],
[ "ARM_MCI_TRANSFER_WRITE", "group__mci__transfer__ctrls.html#gaddc60aab15f75993a99f98f71ddbd50c", null ],
[ "ARM_MCI_TRANSFER_BLOCK", "group__mci__transfer__ctrls.html#ga4ced782e7c0c70d5f0edbddd1e48323b", null ],
[ "ARM_MCI_TRANSFER_STREAM", "group__mci__transfer__ctrls.html#gac7db0cffd571e60758627d889ba7a432", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__mci__transfer__ctrls.js | JavaScript | apache-2.0 | 481 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>NAND Bus Modes</title>
<title>CMSIS-Driver: NAND Bus Modes</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__nand__bus__mode__codes.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">NAND Bus Modes<div class="ingroups"><a class="el" href="group__nand__control__gr.html">NAND Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify bus mode of the NAND interface.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gac7743aeb6411b97f9fc6a24b556f4963"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#gac7743aeb6411b97f9fc6a24b556f4963">ARM_NAND_BUS_SDR</a>   (0x00UL << ARM_NAND_BUS_INTERFACE_Pos)</td></tr>
<tr class="memdesc:gac7743aeb6411b97f9fc6a24b556f4963"><td class="mdescLeft"> </td><td class="mdescRight">Data Interface: SDR (Single Data Rate) - Traditional interface (default) <a href="#gac7743aeb6411b97f9fc6a24b556f4963">More...</a><br/></td></tr>
<tr class="separator:gac7743aeb6411b97f9fc6a24b556f4963"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga82b8261b3d0d85881535adada318a7df"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#ga82b8261b3d0d85881535adada318a7df">ARM_NAND_BUS_DDR</a>   (0x01UL << ARM_NAND_BUS_INTERFACE_Pos)</td></tr>
<tr class="memdesc:ga82b8261b3d0d85881535adada318a7df"><td class="mdescLeft"> </td><td class="mdescRight">Data Interface: NV-DDR (Double Data Rate) <a href="#ga82b8261b3d0d85881535adada318a7df">More...</a><br/></td></tr>
<tr class="separator:ga82b8261b3d0d85881535adada318a7df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga13c102201d6021db184a2f068656c518"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#ga13c102201d6021db184a2f068656c518">ARM_NAND_BUS_DDR2</a>   (0x02UL << ARM_NAND_BUS_INTERFACE_Pos)</td></tr>
<tr class="memdesc:ga13c102201d6021db184a2f068656c518"><td class="mdescLeft"> </td><td class="mdescRight">Data Interface: NV-DDR2 (Double Data Rate) <a href="#ga13c102201d6021db184a2f068656c518">More...</a><br/></td></tr>
<tr class="separator:ga13c102201d6021db184a2f068656c518"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga971e574ac412bbba445055e9afc384ba"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#ga971e574ac412bbba445055e9afc384ba">ARM_NAND_BUS_TIMING_MODE_0</a>   (0x00UL << ARM_NAND_BUS_TIMING_MODE_Pos)</td></tr>
<tr class="memdesc:ga971e574ac412bbba445055e9afc384ba"><td class="mdescLeft"> </td><td class="mdescRight">Timing Mode 0 (default) <a href="#ga971e574ac412bbba445055e9afc384ba">More...</a><br/></td></tr>
<tr class="separator:ga971e574ac412bbba445055e9afc384ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga475a339e929eca46e11bc8a7b330aa45"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#ga475a339e929eca46e11bc8a7b330aa45">ARM_NAND_BUS_TIMING_MODE_1</a>   (0x01UL << ARM_NAND_BUS_TIMING_MODE_Pos)</td></tr>
<tr class="memdesc:ga475a339e929eca46e11bc8a7b330aa45"><td class="mdescLeft"> </td><td class="mdescRight">Timing Mode 1. <a href="#ga475a339e929eca46e11bc8a7b330aa45">More...</a><br/></td></tr>
<tr class="separator:ga475a339e929eca46e11bc8a7b330aa45"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaed6154fb03b5516faf0bfd11d7a46309"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#gaed6154fb03b5516faf0bfd11d7a46309">ARM_NAND_BUS_TIMING_MODE_2</a>   (0x02UL << ARM_NAND_BUS_TIMING_MODE_Pos)</td></tr>
<tr class="memdesc:gaed6154fb03b5516faf0bfd11d7a46309"><td class="mdescLeft"> </td><td class="mdescRight">Timing Mode 2. <a href="#gaed6154fb03b5516faf0bfd11d7a46309">More...</a><br/></td></tr>
<tr class="separator:gaed6154fb03b5516faf0bfd11d7a46309"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacbc4e07e1af6ef0e4c656428e81464a9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#gacbc4e07e1af6ef0e4c656428e81464a9">ARM_NAND_BUS_TIMING_MODE_3</a>   (0x03UL << ARM_NAND_BUS_TIMING_MODE_Pos)</td></tr>
<tr class="memdesc:gacbc4e07e1af6ef0e4c656428e81464a9"><td class="mdescLeft"> </td><td class="mdescRight">Timing Mode 3. <a href="#gacbc4e07e1af6ef0e4c656428e81464a9">More...</a><br/></td></tr>
<tr class="separator:gacbc4e07e1af6ef0e4c656428e81464a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga709d51a5215cd23ce2d85aec57141456"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#ga709d51a5215cd23ce2d85aec57141456">ARM_NAND_BUS_TIMING_MODE_4</a>   (0x04UL << ARM_NAND_BUS_TIMING_MODE_Pos)</td></tr>
<tr class="memdesc:ga709d51a5215cd23ce2d85aec57141456"><td class="mdescLeft"> </td><td class="mdescRight">Timing Mode 4 (SDR EDO capable) <a href="#ga709d51a5215cd23ce2d85aec57141456">More...</a><br/></td></tr>
<tr class="separator:ga709d51a5215cd23ce2d85aec57141456"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaee3cad14ce2b8b9af69149bf74597791"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#gaee3cad14ce2b8b9af69149bf74597791">ARM_NAND_BUS_TIMING_MODE_5</a>   (0x05UL << ARM_NAND_BUS_TIMING_MODE_Pos)</td></tr>
<tr class="memdesc:gaee3cad14ce2b8b9af69149bf74597791"><td class="mdescLeft"> </td><td class="mdescRight">Timing Mode 5 (SDR EDO capable) <a href="#gaee3cad14ce2b8b9af69149bf74597791">More...</a><br/></td></tr>
<tr class="separator:gaee3cad14ce2b8b9af69149bf74597791"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4a3524e0eba994b3a66e06cde877f0f6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#ga4a3524e0eba994b3a66e06cde877f0f6">ARM_NAND_BUS_TIMING_MODE_6</a>   (0x06UL << ARM_NAND_BUS_TIMING_MODE_Pos)</td></tr>
<tr class="memdesc:ga4a3524e0eba994b3a66e06cde877f0f6"><td class="mdescLeft"> </td><td class="mdescRight">Timing Mode 6 (NV-DDR2 only) <a href="#ga4a3524e0eba994b3a66e06cde877f0f6">More...</a><br/></td></tr>
<tr class="separator:ga4a3524e0eba994b3a66e06cde877f0f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa63d75f5f2b48a7345a066d58de1bd23"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#gaa63d75f5f2b48a7345a066d58de1bd23">ARM_NAND_BUS_TIMING_MODE_7</a>   (0x07UL << ARM_NAND_BUS_TIMING_MODE_Pos)</td></tr>
<tr class="memdesc:gaa63d75f5f2b48a7345a066d58de1bd23"><td class="mdescLeft"> </td><td class="mdescRight">Timing Mode 7 (NV-DDR2 only) <a href="#gaa63d75f5f2b48a7345a066d58de1bd23">More...</a><br/></td></tr>
<tr class="separator:gaa63d75f5f2b48a7345a066d58de1bd23"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga77348df5f5c2c96bcaeec60b6da02c1b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#ga77348df5f5c2c96bcaeec60b6da02c1b">ARM_NAND_BUS_DDR2_DO_WCYC_0</a>   (0x00UL << ARM_NAND_BUS_DDR2_DO_WCYC_Pos)</td></tr>
<tr class="memdesc:ga77348df5f5c2c96bcaeec60b6da02c1b"><td class="mdescLeft"> </td><td class="mdescRight">DDR2 Data Output Warm-up cycles: 0 (default) <a href="#ga77348df5f5c2c96bcaeec60b6da02c1b">More...</a><br/></td></tr>
<tr class="separator:ga77348df5f5c2c96bcaeec60b6da02c1b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5839be0b4b2eb930ec039a3403b5e89e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#ga5839be0b4b2eb930ec039a3403b5e89e">ARM_NAND_BUS_DDR2_DO_WCYC_1</a>   (0x01UL << ARM_NAND_BUS_DDR2_DO_WCYC_Pos)</td></tr>
<tr class="memdesc:ga5839be0b4b2eb930ec039a3403b5e89e"><td class="mdescLeft"> </td><td class="mdescRight">DDR2 Data Output Warm-up cycles: 1. <a href="#ga5839be0b4b2eb930ec039a3403b5e89e">More...</a><br/></td></tr>
<tr class="separator:ga5839be0b4b2eb930ec039a3403b5e89e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga10a1ef3be69bfa7e6cc657bee751a077"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#ga10a1ef3be69bfa7e6cc657bee751a077">ARM_NAND_BUS_DDR2_DO_WCYC_2</a>   (0x02UL << ARM_NAND_BUS_DDR2_DO_WCYC_Pos)</td></tr>
<tr class="memdesc:ga10a1ef3be69bfa7e6cc657bee751a077"><td class="mdescLeft"> </td><td class="mdescRight">DDR2 Data Output Warm-up cycles: 2. <a href="#ga10a1ef3be69bfa7e6cc657bee751a077">More...</a><br/></td></tr>
<tr class="separator:ga10a1ef3be69bfa7e6cc657bee751a077"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7f9e8416c4a4e20c4a04323e39f2100d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#ga7f9e8416c4a4e20c4a04323e39f2100d">ARM_NAND_BUS_DDR2_DO_WCYC_4</a>   (0x03UL << ARM_NAND_BUS_DDR2_DO_WCYC_Pos)</td></tr>
<tr class="memdesc:ga7f9e8416c4a4e20c4a04323e39f2100d"><td class="mdescLeft"> </td><td class="mdescRight">DDR2 Data Output Warm-up cycles: 4. <a href="#ga7f9e8416c4a4e20c4a04323e39f2100d">More...</a><br/></td></tr>
<tr class="separator:ga7f9e8416c4a4e20c4a04323e39f2100d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaeee1853dea5e96cb19d2596cc0e70169"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#gaeee1853dea5e96cb19d2596cc0e70169">ARM_NAND_BUS_DDR2_DI_WCYC_0</a>   (0x00UL << ARM_NAND_BUS_DDR2_DI_WCYC_Pos)</td></tr>
<tr class="memdesc:gaeee1853dea5e96cb19d2596cc0e70169"><td class="mdescLeft"> </td><td class="mdescRight">DDR2 Data Input Warm-up cycles: 0 (default) <a href="#gaeee1853dea5e96cb19d2596cc0e70169">More...</a><br/></td></tr>
<tr class="separator:gaeee1853dea5e96cb19d2596cc0e70169"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga42560a1f046e20cc4956276156c4ce25"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#ga42560a1f046e20cc4956276156c4ce25">ARM_NAND_BUS_DDR2_DI_WCYC_1</a>   (0x01UL << ARM_NAND_BUS_DDR2_DI_WCYC_Pos)</td></tr>
<tr class="memdesc:ga42560a1f046e20cc4956276156c4ce25"><td class="mdescLeft"> </td><td class="mdescRight">DDR2 Data Input Warm-up cycles: 1. <a href="#ga42560a1f046e20cc4956276156c4ce25">More...</a><br/></td></tr>
<tr class="separator:ga42560a1f046e20cc4956276156c4ce25"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaad2e7807292d84a5070143626f5c2756"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#gaad2e7807292d84a5070143626f5c2756">ARM_NAND_BUS_DDR2_DI_WCYC_2</a>   (0x02UL << ARM_NAND_BUS_DDR2_DI_WCYC_Pos)</td></tr>
<tr class="memdesc:gaad2e7807292d84a5070143626f5c2756"><td class="mdescLeft"> </td><td class="mdescRight">DDR2 Data Input Warm-up cycles: 2. <a href="#gaad2e7807292d84a5070143626f5c2756">More...</a><br/></td></tr>
<tr class="separator:gaad2e7807292d84a5070143626f5c2756"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3ebb54a1ae971cd34f3c8fc9ff3ab6d5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#ga3ebb54a1ae971cd34f3c8fc9ff3ab6d5">ARM_NAND_BUS_DDR2_DI_WCYC_4</a>   (0x03UL << ARM_NAND_BUS_DDR2_DI_WCYC_Pos)</td></tr>
<tr class="memdesc:ga3ebb54a1ae971cd34f3c8fc9ff3ab6d5"><td class="mdescLeft"> </td><td class="mdescRight">DDR2 Data Input Warm-up cycles: 4. <a href="#ga3ebb54a1ae971cd34f3c8fc9ff3ab6d5">More...</a><br/></td></tr>
<tr class="separator:ga3ebb54a1ae971cd34f3c8fc9ff3ab6d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga465ae06a6e097959620346304182e273"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#ga465ae06a6e097959620346304182e273">ARM_NAND_BUS_DDR2_VEN</a>   (1UL << 16)</td></tr>
<tr class="memdesc:ga465ae06a6e097959620346304182e273"><td class="mdescLeft"> </td><td class="mdescRight">DDR2 Enable external VREFQ as reference. <a href="#ga465ae06a6e097959620346304182e273">More...</a><br/></td></tr>
<tr class="separator:ga465ae06a6e097959620346304182e273"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad38354e4a34adbf881afc7f89ff06e89"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#gad38354e4a34adbf881afc7f89ff06e89">ARM_NAND_BUS_DDR2_CMPD</a>   (1UL << 17)</td></tr>
<tr class="memdesc:gad38354e4a34adbf881afc7f89ff06e89"><td class="mdescLeft"> </td><td class="mdescRight">DDR2 Enable complementary DQS (DQS_c) signal. <a href="#gad38354e4a34adbf881afc7f89ff06e89">More...</a><br/></td></tr>
<tr class="separator:gad38354e4a34adbf881afc7f89ff06e89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8a2d599082b9fe56cee1c6454bb3c6a1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html#ga8a2d599082b9fe56cee1c6454bb3c6a1">ARM_NAND_BUS_DDR2_CMPR</a>   (1UL << 18)</td></tr>
<tr class="memdesc:ga8a2d599082b9fe56cee1c6454bb3c6a1"><td class="mdescLeft"> </td><td class="mdescRight">DDR2 Enable complementary RE_n (RE_c) signal. <a href="#ga8a2d599082b9fe56cee1c6454bb3c6a1">More...</a><br/></td></tr>
<tr class="separator:ga8a2d599082b9fe56cee1c6454bb3c6a1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify bus mode of the NAND interface. </p>
<p>The defines can be used in the function <a class="el" href="group__nand__interface__gr.html#ga83061d6d53ffb148853efbc87a864607">ARM_NAND_Control</a> for the parameter <em>arg</em> and with the <a class="el" href="group__nand__control__codes.html#ga9b063c3078e86b50d4aa892518b2e2d8">ARM_NAND_BUS_MODE</a> as the <em>control</em> code. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gac7743aeb6411b97f9fc6a24b556f4963"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_SDR   (0x00UL << ARM_NAND_BUS_INTERFACE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Data Interface: SDR (Single Data Rate) - Traditional interface (default) </p>
</div>
</div>
<a class="anchor" id="ga82b8261b3d0d85881535adada318a7df"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_DDR   (0x01UL << ARM_NAND_BUS_INTERFACE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Data Interface: NV-DDR (Double Data Rate) </p>
</div>
</div>
<a class="anchor" id="ga13c102201d6021db184a2f068656c518"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_DDR2   (0x02UL << ARM_NAND_BUS_INTERFACE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Data Interface: NV-DDR2 (Double Data Rate) </p>
</div>
</div>
<a class="anchor" id="ga971e574ac412bbba445055e9afc384ba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_TIMING_MODE_0   (0x00UL << ARM_NAND_BUS_TIMING_MODE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Timing Mode 0 (default) </p>
</div>
</div>
<a class="anchor" id="ga475a339e929eca46e11bc8a7b330aa45"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_TIMING_MODE_1   (0x01UL << ARM_NAND_BUS_TIMING_MODE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Timing Mode 1. </p>
</div>
</div>
<a class="anchor" id="gaed6154fb03b5516faf0bfd11d7a46309"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_TIMING_MODE_2   (0x02UL << ARM_NAND_BUS_TIMING_MODE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Timing Mode 2. </p>
</div>
</div>
<a class="anchor" id="gacbc4e07e1af6ef0e4c656428e81464a9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_TIMING_MODE_3   (0x03UL << ARM_NAND_BUS_TIMING_MODE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Timing Mode 3. </p>
</div>
</div>
<a class="anchor" id="ga709d51a5215cd23ce2d85aec57141456"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_TIMING_MODE_4   (0x04UL << ARM_NAND_BUS_TIMING_MODE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Timing Mode 4 (SDR EDO capable) </p>
</div>
</div>
<a class="anchor" id="gaee3cad14ce2b8b9af69149bf74597791"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_TIMING_MODE_5   (0x05UL << ARM_NAND_BUS_TIMING_MODE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Timing Mode 5 (SDR EDO capable) </p>
</div>
</div>
<a class="anchor" id="ga4a3524e0eba994b3a66e06cde877f0f6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_TIMING_MODE_6   (0x06UL << ARM_NAND_BUS_TIMING_MODE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Timing Mode 6 (NV-DDR2 only) </p>
</div>
</div>
<a class="anchor" id="gaa63d75f5f2b48a7345a066d58de1bd23"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_TIMING_MODE_7   (0x07UL << ARM_NAND_BUS_TIMING_MODE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Timing Mode 7 (NV-DDR2 only) </p>
</div>
</div>
<a class="anchor" id="ga77348df5f5c2c96bcaeec60b6da02c1b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_DDR2_DO_WCYC_0   (0x00UL << ARM_NAND_BUS_DDR2_DO_WCYC_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>DDR2 Data Output Warm-up cycles: 0 (default) </p>
</div>
</div>
<a class="anchor" id="ga5839be0b4b2eb930ec039a3403b5e89e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_DDR2_DO_WCYC_1   (0x01UL << ARM_NAND_BUS_DDR2_DO_WCYC_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>DDR2 Data Output Warm-up cycles: 1. </p>
</div>
</div>
<a class="anchor" id="ga10a1ef3be69bfa7e6cc657bee751a077"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_DDR2_DO_WCYC_2   (0x02UL << ARM_NAND_BUS_DDR2_DO_WCYC_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>DDR2 Data Output Warm-up cycles: 2. </p>
</div>
</div>
<a class="anchor" id="ga7f9e8416c4a4e20c4a04323e39f2100d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_DDR2_DO_WCYC_4   (0x03UL << ARM_NAND_BUS_DDR2_DO_WCYC_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>DDR2 Data Output Warm-up cycles: 4. </p>
</div>
</div>
<a class="anchor" id="gaeee1853dea5e96cb19d2596cc0e70169"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_DDR2_DI_WCYC_0   (0x00UL << ARM_NAND_BUS_DDR2_DI_WCYC_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>DDR2 Data Input Warm-up cycles: 0 (default) </p>
</div>
</div>
<a class="anchor" id="ga42560a1f046e20cc4956276156c4ce25"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_DDR2_DI_WCYC_1   (0x01UL << ARM_NAND_BUS_DDR2_DI_WCYC_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>DDR2 Data Input Warm-up cycles: 1. </p>
</div>
</div>
<a class="anchor" id="gaad2e7807292d84a5070143626f5c2756"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_DDR2_DI_WCYC_2   (0x02UL << ARM_NAND_BUS_DDR2_DI_WCYC_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>DDR2 Data Input Warm-up cycles: 2. </p>
</div>
</div>
<a class="anchor" id="ga3ebb54a1ae971cd34f3c8fc9ff3ab6d5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_DDR2_DI_WCYC_4   (0x03UL << ARM_NAND_BUS_DDR2_DI_WCYC_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>DDR2 Data Input Warm-up cycles: 4. </p>
</div>
</div>
<a class="anchor" id="ga465ae06a6e097959620346304182e273"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_DDR2_VEN   (1UL << 16)</td>
</tr>
</table>
</div><div class="memdoc">
<p>DDR2 Enable external VREFQ as reference. </p>
</div>
</div>
<a class="anchor" id="gad38354e4a34adbf881afc7f89ff06e89"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_DDR2_CMPD   (1UL << 17)</td>
</tr>
</table>
</div><div class="memdoc">
<p>DDR2 Enable complementary DQS (DQS_c) signal. </p>
</div>
</div>
<a class="anchor" id="ga8a2d599082b9fe56cee1c6454bb3c6a1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_DDR2_CMPR   (1UL << 18)</td>
</tr>
</table>
</div><div class="memdoc">
<p>DDR2 Enable complementary RE_n (RE_c) signal. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__bus__mode__codes.html | HTML | apache-2.0 | 30,945 |
var group__nand__bus__mode__codes =
[
[ "ARM_NAND_BUS_SDR", "group__nand__bus__mode__codes.html#gac7743aeb6411b97f9fc6a24b556f4963", null ],
[ "ARM_NAND_BUS_DDR", "group__nand__bus__mode__codes.html#ga82b8261b3d0d85881535adada318a7df", null ],
[ "ARM_NAND_BUS_DDR2", "group__nand__bus__mode__codes.html#ga13c102201d6021db184a2f068656c518", null ],
[ "ARM_NAND_BUS_TIMING_MODE_0", "group__nand__bus__mode__codes.html#ga971e574ac412bbba445055e9afc384ba", null ],
[ "ARM_NAND_BUS_TIMING_MODE_1", "group__nand__bus__mode__codes.html#ga475a339e929eca46e11bc8a7b330aa45", null ],
[ "ARM_NAND_BUS_TIMING_MODE_2", "group__nand__bus__mode__codes.html#gaed6154fb03b5516faf0bfd11d7a46309", null ],
[ "ARM_NAND_BUS_TIMING_MODE_3", "group__nand__bus__mode__codes.html#gacbc4e07e1af6ef0e4c656428e81464a9", null ],
[ "ARM_NAND_BUS_TIMING_MODE_4", "group__nand__bus__mode__codes.html#ga709d51a5215cd23ce2d85aec57141456", null ],
[ "ARM_NAND_BUS_TIMING_MODE_5", "group__nand__bus__mode__codes.html#gaee3cad14ce2b8b9af69149bf74597791", null ],
[ "ARM_NAND_BUS_TIMING_MODE_6", "group__nand__bus__mode__codes.html#ga4a3524e0eba994b3a66e06cde877f0f6", null ],
[ "ARM_NAND_BUS_TIMING_MODE_7", "group__nand__bus__mode__codes.html#gaa63d75f5f2b48a7345a066d58de1bd23", null ],
[ "ARM_NAND_BUS_DDR2_DO_WCYC_0", "group__nand__bus__mode__codes.html#ga77348df5f5c2c96bcaeec60b6da02c1b", null ],
[ "ARM_NAND_BUS_DDR2_DO_WCYC_1", "group__nand__bus__mode__codes.html#ga5839be0b4b2eb930ec039a3403b5e89e", null ],
[ "ARM_NAND_BUS_DDR2_DO_WCYC_2", "group__nand__bus__mode__codes.html#ga10a1ef3be69bfa7e6cc657bee751a077", null ],
[ "ARM_NAND_BUS_DDR2_DO_WCYC_4", "group__nand__bus__mode__codes.html#ga7f9e8416c4a4e20c4a04323e39f2100d", null ],
[ "ARM_NAND_BUS_DDR2_DI_WCYC_0", "group__nand__bus__mode__codes.html#gaeee1853dea5e96cb19d2596cc0e70169", null ],
[ "ARM_NAND_BUS_DDR2_DI_WCYC_1", "group__nand__bus__mode__codes.html#ga42560a1f046e20cc4956276156c4ce25", null ],
[ "ARM_NAND_BUS_DDR2_DI_WCYC_2", "group__nand__bus__mode__codes.html#gaad2e7807292d84a5070143626f5c2756", null ],
[ "ARM_NAND_BUS_DDR2_DI_WCYC_4", "group__nand__bus__mode__codes.html#ga3ebb54a1ae971cd34f3c8fc9ff3ab6d5", null ],
[ "ARM_NAND_BUS_DDR2_VEN", "group__nand__bus__mode__codes.html#ga465ae06a6e097959620346304182e273", null ],
[ "ARM_NAND_BUS_DDR2_CMPD", "group__nand__bus__mode__codes.html#gad38354e4a34adbf881afc7f89ff06e89", null ],
[ "ARM_NAND_BUS_DDR2_CMPR", "group__nand__bus__mode__codes.html#ga8a2d599082b9fe56cee1c6454bb3c6a1", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__bus__mode__codes.js | JavaScript | apache-2.0 | 2,579 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>NAND Mode Controls</title>
<title>CMSIS-Driver: NAND Mode Controls</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__nand__control__codes.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">NAND Mode Controls<div class="ingroups"><a class="el" href="group__nand__control__gr.html">NAND Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify operation modes of the NAND interface.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga9b063c3078e86b50d4aa892518b2e2d8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__control__codes.html#ga9b063c3078e86b50d4aa892518b2e2d8">ARM_NAND_BUS_MODE</a>   (0x01)</td></tr>
<tr class="memdesc:ga9b063c3078e86b50d4aa892518b2e2d8"><td class="mdescLeft"> </td><td class="mdescRight">Set Bus Mode as specified with arg. <a href="#ga9b063c3078e86b50d4aa892518b2e2d8">More...</a><br/></td></tr>
<tr class="separator:ga9b063c3078e86b50d4aa892518b2e2d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2d3356f5b47871c465ae7136a2c533f4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__control__codes.html#ga2d3356f5b47871c465ae7136a2c533f4">ARM_NAND_BUS_DATA_WIDTH</a>   (0x02)</td></tr>
<tr class="memdesc:ga2d3356f5b47871c465ae7136a2c533f4"><td class="mdescLeft"> </td><td class="mdescRight">Set Bus Data Width as specified with arg. <a href="#ga2d3356f5b47871c465ae7136a2c533f4">More...</a><br/></td></tr>
<tr class="separator:ga2d3356f5b47871c465ae7136a2c533f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5d1d46198404fe115b013bdae7af2a2f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__control__codes.html#ga5d1d46198404fe115b013bdae7af2a2f">ARM_NAND_DRIVER_STRENGTH</a>   (0x03)</td></tr>
<tr class="memdesc:ga5d1d46198404fe115b013bdae7af2a2f"><td class="mdescLeft"> </td><td class="mdescRight">Set Driver Strength as specified with arg. <a href="#ga5d1d46198404fe115b013bdae7af2a2f">More...</a><br/></td></tr>
<tr class="separator:ga5d1d46198404fe115b013bdae7af2a2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1bffc9f341e704ee0e845d86a2989921"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__control__codes.html#ga1bffc9f341e704ee0e845d86a2989921">ARM_NAND_DEVICE_READY_EVENT</a>   (0x04)</td></tr>
<tr class="memdesc:ga1bffc9f341e704ee0e845d86a2989921"><td class="mdescLeft"> </td><td class="mdescRight">Generate <a class="el" href="group__NAND__events.html#gae0be7e1b41188def905de0a1568d442d">ARM_NAND_EVENT_DEVICE_READY</a>; arg: 0=disabled (default), 1=enabled. <a href="#ga1bffc9f341e704ee0e845d86a2989921">More...</a><br/></td></tr>
<tr class="separator:ga1bffc9f341e704ee0e845d86a2989921"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaab6dea1b565aeb53e360876a4e50783c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__control__codes.html#gaab6dea1b565aeb53e360876a4e50783c">ARM_NAND_DRIVER_READY_EVENT</a>   (0x05)</td></tr>
<tr class="memdesc:gaab6dea1b565aeb53e360876a4e50783c"><td class="mdescLeft"> </td><td class="mdescRight">Generate <a class="el" href="group__NAND__events.html#ga7b390a906db42c5ea4db38e0e85bb9e9">ARM_NAND_EVENT_DRIVER_READY</a>; arg: 0=disabled (default), 1=enabled. <a href="#gaab6dea1b565aeb53e360876a4e50783c">More...</a><br/></td></tr>
<tr class="separator:gaab6dea1b565aeb53e360876a4e50783c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify operation modes of the NAND interface. </p>
<p>These controls can be used in the function <a class="el" href="group__nand__interface__gr.html#ga83061d6d53ffb148853efbc87a864607">ARM_NAND_Control</a> for the parameter <em>control</em>. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga9b063c3078e86b50d4aa892518b2e2d8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_MODE   (0x01)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Bus Mode as specified with arg. </p>
</div>
</div>
<a class="anchor" id="ga2d3356f5b47871c465ae7136a2c533f4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_DATA_WIDTH   (0x02)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Bus Data Width as specified with arg. </p>
</div>
</div>
<a class="anchor" id="ga5d1d46198404fe115b013bdae7af2a2f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_DRIVER_STRENGTH   (0x03)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Driver Strength as specified with arg. </p>
</div>
</div>
<a class="anchor" id="ga1bffc9f341e704ee0e845d86a2989921"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_DEVICE_READY_EVENT   (0x04)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate <a class="el" href="group__NAND__events.html#gae0be7e1b41188def905de0a1568d442d">ARM_NAND_EVENT_DEVICE_READY</a>; arg: 0=disabled (default), 1=enabled. </p>
</div>
</div>
<a class="anchor" id="gaab6dea1b565aeb53e360876a4e50783c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_DRIVER_READY_EVENT   (0x05)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate <a class="el" href="group__NAND__events.html#ga7b390a906db42c5ea4db38e0e85bb9e9">ARM_NAND_EVENT_DRIVER_READY</a>; arg: 0=disabled (default), 1=enabled. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__control__codes.html | HTML | apache-2.0 | 12,571 |
var group__nand__control__codes =
[
[ "ARM_NAND_BUS_MODE", "group__nand__control__codes.html#ga9b063c3078e86b50d4aa892518b2e2d8", null ],
[ "ARM_NAND_BUS_DATA_WIDTH", "group__nand__control__codes.html#ga2d3356f5b47871c465ae7136a2c533f4", null ],
[ "ARM_NAND_DRIVER_STRENGTH", "group__nand__control__codes.html#ga5d1d46198404fe115b013bdae7af2a2f", null ],
[ "ARM_NAND_DEVICE_READY_EVENT", "group__nand__control__codes.html#ga1bffc9f341e704ee0e845d86a2989921", null ],
[ "ARM_NAND_DRIVER_READY_EVENT", "group__nand__control__codes.html#gaab6dea1b565aeb53e360876a4e50783c", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__control__codes.js | JavaScript | apache-2.0 | 600 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>NAND Control Codes</title>
<title>CMSIS-Driver: NAND Control Codes</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__nand__control__gr.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Content</a> </div>
<div class="headertitle">
<div class="title">NAND Control Codes<div class="ingroups"><a class="el" href="group__nand__interface__gr.html">NAND Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Many parameters of the NAND driver are configured using the <a class="el" href="group__nand__interface__gr.html#ga83061d6d53ffb148853efbc87a864607">ARM_NAND_Control</a> function.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Content</h2></td></tr>
<tr class="memitem:group__nand__control__codes"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__control__codes.html">NAND Mode Controls</a></td></tr>
<tr class="memdesc:group__nand__control__codes"><td class="mdescLeft"> </td><td class="mdescRight">Specify operation modes of the NAND interface. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__nand__bus__mode__codes"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__bus__mode__codes.html">NAND Bus Modes</a></td></tr>
<tr class="memdesc:group__nand__bus__mode__codes"><td class="mdescLeft"> </td><td class="mdescRight">Specify bus mode of the NAND interface. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__nand__data__bus__width__codes"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__data__bus__width__codes.html">NAND Data Bus Width</a></td></tr>
<tr class="memdesc:group__nand__data__bus__width__codes"><td class="mdescLeft"> </td><td class="mdescRight">Specify data bus width of the NAND interface. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__nand__driver__strength__codes"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__strength__codes.html">NAND Driver Strength</a></td></tr>
<tr class="memdesc:group__nand__driver__strength__codes"><td class="mdescLeft"> </td><td class="mdescRight">Specify driver strength of the NAND interface. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Many parameters of the NAND driver are configured using the <a class="el" href="group__nand__interface__gr.html#ga83061d6d53ffb148853efbc87a864607">ARM_NAND_Control</a> function. </p>
<p>Refer to the function <a class="el" href="group__nand__interface__gr.html#ga83061d6d53ffb148853efbc87a864607">ARM_NAND_Control</a> for further details. </p>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__control__gr.html | HTML | apache-2.0 | 9,137 |
var group__nand__control__gr =
[
[ "NAND Mode Controls", "group__nand__control__codes.html", "group__nand__control__codes" ],
[ "NAND Bus Modes", "group__nand__bus__mode__codes.html", "group__nand__bus__mode__codes" ],
[ "NAND Data Bus Width", "group__nand__data__bus__width__codes.html", "group__nand__data__bus__width__codes" ],
[ "NAND Driver Strength", "group__nand__driver__strength__codes.html", "group__nand__driver__strength__codes" ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__control__gr.js | JavaScript | apache-2.0 | 461 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>NAND Data Bus Width</title>
<title>CMSIS-Driver: NAND Data Bus Width</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__nand__data__bus__width__codes.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">NAND Data Bus Width<div class="ingroups"><a class="el" href="group__nand__control__gr.html">NAND Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify data bus width of the NAND interface.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga578051cc193ae0b7125aec8007071d21"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__data__bus__width__codes.html#ga578051cc193ae0b7125aec8007071d21">ARM_NAND_BUS_DATA_WIDTH_8</a>   (0x00)</td></tr>
<tr class="memdesc:ga578051cc193ae0b7125aec8007071d21"><td class="mdescLeft"> </td><td class="mdescRight">Bus Data Width: 8 bit (default) <a href="#ga578051cc193ae0b7125aec8007071d21">More...</a><br/></td></tr>
<tr class="separator:ga578051cc193ae0b7125aec8007071d21"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga49e0e3a946a4d9f26dbd5b32ccc3b2f3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__data__bus__width__codes.html#ga49e0e3a946a4d9f26dbd5b32ccc3b2f3">ARM_NAND_BUS_DATA_WIDTH_16</a>   (0x01)</td></tr>
<tr class="memdesc:ga49e0e3a946a4d9f26dbd5b32ccc3b2f3"><td class="mdescLeft"> </td><td class="mdescRight">Bus Data Width: 16 bit. <a href="#ga49e0e3a946a4d9f26dbd5b32ccc3b2f3">More...</a><br/></td></tr>
<tr class="separator:ga49e0e3a946a4d9f26dbd5b32ccc3b2f3"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify data bus width of the NAND interface. </p>
<p>The defines can be used in the function <a class="el" href="group__nand__interface__gr.html#ga83061d6d53ffb148853efbc87a864607">ARM_NAND_Control</a> for the parameter <em>arg</em> and with the <a class="el" href="group__nand__control__codes.html#ga2d3356f5b47871c465ae7136a2c533f4">ARM_NAND_BUS_DATA_WIDTH</a> as the <em>control</em> code. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga578051cc193ae0b7125aec8007071d21"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_DATA_WIDTH_8   (0x00)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Bus Data Width: 8 bit (default) </p>
</div>
</div>
<a class="anchor" id="ga49e0e3a946a4d9f26dbd5b32ccc3b2f3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_BUS_DATA_WIDTH_16   (0x01)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Bus Data Width: 16 bit. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__data__bus__width__codes.html | HTML | apache-2.0 | 9,179 |
var group__nand__data__bus__width__codes =
[
[ "ARM_NAND_BUS_DATA_WIDTH_8", "group__nand__data__bus__width__codes.html#ga578051cc193ae0b7125aec8007071d21", null ],
[ "ARM_NAND_BUS_DATA_WIDTH_16", "group__nand__data__bus__width__codes.html#ga49e0e3a946a4d9f26dbd5b32ccc3b2f3", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__data__bus__width__codes.js | JavaScript | apache-2.0 | 293 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>NAND ECC Codes</title>
<title>CMSIS-Driver: NAND ECC Codes</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__nand__driver__ecc__codes.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">NAND ECC Codes<div class="ingroups"><a class="el" href="group__nand__interface__gr.html">NAND Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify ECC codes.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gac2eb4475f12a443209165d29fe200030"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__ecc__codes.html#gac2eb4475f12a443209165d29fe200030">ARM_NAND_ECC</a>(n)   ((n) & <a class="el" href="Driver__NAND_8h.html#a656537439264ab495c86e4c36051a3c1">ARM_NAND_ECC_INDEX_Msk</a>)</td></tr>
<tr class="memdesc:gac2eb4475f12a443209165d29fe200030"><td class="mdescLeft"> </td><td class="mdescRight">Select ECC. <a href="#gac2eb4475f12a443209165d29fe200030">More...</a><br/></td></tr>
<tr class="separator:gac2eb4475f12a443209165d29fe200030"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga15c79a12200c16f953936635f930df1d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__ecc__codes.html#ga15c79a12200c16f953936635f930df1d">ARM_NAND_ECC0</a>   (1UL << 8)</td></tr>
<tr class="memdesc:ga15c79a12200c16f953936635f930df1d"><td class="mdescLeft"> </td><td class="mdescRight">Use ECC0 of selected ECC. <a href="#ga15c79a12200c16f953936635f930df1d">More...</a><br/></td></tr>
<tr class="separator:ga15c79a12200c16f953936635f930df1d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaee653288a88318ee33d1db81baa69bbc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__ecc__codes.html#gaee653288a88318ee33d1db81baa69bbc">ARM_NAND_ECC1</a>   (1UL << 9)</td></tr>
<tr class="memdesc:gaee653288a88318ee33d1db81baa69bbc"><td class="mdescLeft"> </td><td class="mdescRight">Use ECC1 of selected ECC. <a href="#gaee653288a88318ee33d1db81baa69bbc">More...</a><br/></td></tr>
<tr class="separator:gaee653288a88318ee33d1db81baa69bbc"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify ECC codes. </p>
<p>The defines can be used in the function <a class="el" href="group__nand__interface__gr.html#gae1899a20ef107400c8bf84fad477a8ce">ARM_NAND_ReadData</a> and <a class="el" href="group__nand__interface__gr.html#ga1fa497dd51a86fc308e946b4419fd006">ARM_NAND_WriteData</a> for the parameter <em>mode</em> and in the function <a class="el" href="group__nand__interface__gr.html#ga8a0108dba757a4610475151144b52825">ARM_NAND_ExecuteSequence</a> for the parameter <em>code</em>. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gac2eb4475f12a443209165d29fe200030"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_ECC</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">n</td><td>)</td>
<td>   ((n) & <a class="el" href="Driver__NAND_8h.html#a656537439264ab495c86e4c36051a3c1">ARM_NAND_ECC_INDEX_Msk</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Select ECC. </p>
</div>
</div>
<a class="anchor" id="ga15c79a12200c16f953936635f930df1d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_ECC0   (1UL << 8)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Use ECC0 of selected ECC. </p>
</div>
</div>
<a class="anchor" id="gaee653288a88318ee33d1db81baa69bbc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_ECC1   (1UL << 9)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Use ECC1 of selected ECC. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__driver__ecc__codes.html | HTML | apache-2.0 | 10,495 |
var group__nand__driver__ecc__codes =
[
[ "ARM_NAND_ECC", "group__nand__driver__ecc__codes.html#gac2eb4475f12a443209165d29fe200030", null ],
[ "ARM_NAND_ECC0", "group__nand__driver__ecc__codes.html#ga15c79a12200c16f953936635f930df1d", null ],
[ "ARM_NAND_ECC1", "group__nand__driver__ecc__codes.html#gaee653288a88318ee33d1db81baa69bbc", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__driver__ecc__codes.js | JavaScript | apache-2.0 | 358 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>NAND Flags</title>
<title>CMSIS-Driver: NAND Flags</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__nand__driver__flag__codes.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">NAND Flags<div class="ingroups"><a class="el" href="group__nand__interface__gr.html">NAND Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify Flag codes.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaf40631ba62411e0ac06c3a945d608581"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__flag__codes.html#gaf40631ba62411e0ac06c3a945d608581">ARM_NAND_DRIVER_DONE_EVENT</a>   (1UL << 16)</td></tr>
<tr class="memdesc:gaf40631ba62411e0ac06c3a945d608581"><td class="mdescLeft"> </td><td class="mdescRight">Generate <a class="el" href="group__NAND__events.html#gac774a334871789d24107b843d1ebd00c">ARM_NAND_EVENT_DRIVER_DONE</a>. <a href="#gaf40631ba62411e0ac06c3a945d608581">More...</a><br/></td></tr>
<tr class="separator:gaf40631ba62411e0ac06c3a945d608581"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify Flag codes. </p>
<p>The defines can be used in the function <a class="el" href="group__nand__interface__gr.html#gae1899a20ef107400c8bf84fad477a8ce">ARM_NAND_ReadData</a> and <a class="el" href="group__nand__interface__gr.html#ga1fa497dd51a86fc308e946b4419fd006">ARM_NAND_WriteData</a> for the parameter <em>mode</em> and in the function <a class="el" href="group__nand__interface__gr.html#ga8a0108dba757a4610475151144b52825">ARM_NAND_ExecuteSequence</a> for the parameter <em>code</em>. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gaf40631ba62411e0ac06c3a945d608581"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_DRIVER_DONE_EVENT   (1UL << 16)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate <a class="el" href="group__NAND__events.html#gac774a334871789d24107b843d1ebd00c">ARM_NAND_EVENT_DRIVER_DONE</a>. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__driver__flag__codes.html | HTML | apache-2.0 | 8,424 |
var group__nand__driver__flag__codes =
[
[ "ARM_NAND_DRIVER_DONE_EVENT", "group__nand__driver__flag__codes.html#gaf40631ba62411e0ac06c3a945d608581", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__driver__flag__codes.js | JavaScript | apache-2.0 | 162 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>NAND Sequence Execution Codes</title>
<title>CMSIS-Driver: NAND Sequence Execution Codes</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__nand__driver__seq__exec__codes.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">NAND Sequence Execution Codes<div class="ingroups"><a class="el" href="group__nand__interface__gr.html">NAND Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify execution codes.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaef90c96cd4f2309044d7d438c6b0930a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#gaef90c96cd4f2309044d7d438c6b0930a">ARM_NAND_CODE_SEND_CMD1</a>   (1UL << 17)</td></tr>
<tr class="memdesc:gaef90c96cd4f2309044d7d438c6b0930a"><td class="mdescLeft"> </td><td class="mdescRight">Send Command 1. <a href="#gaef90c96cd4f2309044d7d438c6b0930a">More...</a><br/></td></tr>
<tr class="separator:gaef90c96cd4f2309044d7d438c6b0930a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga891bcba60ebb1195ec80c00c9bec748a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga891bcba60ebb1195ec80c00c9bec748a">ARM_NAND_CODE_SEND_ADDR_COL1</a>   (1UL << 18)</td></tr>
<tr class="memdesc:ga891bcba60ebb1195ec80c00c9bec748a"><td class="mdescLeft"> </td><td class="mdescRight">Send Column Address 1. <a href="#ga891bcba60ebb1195ec80c00c9bec748a">More...</a><br/></td></tr>
<tr class="separator:ga891bcba60ebb1195ec80c00c9bec748a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga62a3f6ddcfb9ee317655bbec9e09bc10"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga62a3f6ddcfb9ee317655bbec9e09bc10">ARM_NAND_CODE_SEND_ADDR_COL2</a>   (1UL << 19)</td></tr>
<tr class="memdesc:ga62a3f6ddcfb9ee317655bbec9e09bc10"><td class="mdescLeft"> </td><td class="mdescRight">Send Column Address 2. <a href="#ga62a3f6ddcfb9ee317655bbec9e09bc10">More...</a><br/></td></tr>
<tr class="separator:ga62a3f6ddcfb9ee317655bbec9e09bc10"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadc001e69d1e81dc28a542237c6fe11ff"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#gadc001e69d1e81dc28a542237c6fe11ff">ARM_NAND_CODE_SEND_ADDR_ROW1</a>   (1UL << 20)</td></tr>
<tr class="memdesc:gadc001e69d1e81dc28a542237c6fe11ff"><td class="mdescLeft"> </td><td class="mdescRight">Send Row Address 1. <a href="#gadc001e69d1e81dc28a542237c6fe11ff">More...</a><br/></td></tr>
<tr class="separator:gadc001e69d1e81dc28a542237c6fe11ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5e55628cb59f5d7d35c529f04ebfcd10"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga5e55628cb59f5d7d35c529f04ebfcd10">ARM_NAND_CODE_SEND_ADDR_ROW2</a>   (1UL << 21)</td></tr>
<tr class="memdesc:ga5e55628cb59f5d7d35c529f04ebfcd10"><td class="mdescLeft"> </td><td class="mdescRight">Send Row Address 2. <a href="#ga5e55628cb59f5d7d35c529f04ebfcd10">More...</a><br/></td></tr>
<tr class="separator:ga5e55628cb59f5d7d35c529f04ebfcd10"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaeb5d1be9c13b7ad2ad246d5db10cd419"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#gaeb5d1be9c13b7ad2ad246d5db10cd419">ARM_NAND_CODE_SEND_ADDR_ROW3</a>   (1UL << 22)</td></tr>
<tr class="memdesc:gaeb5d1be9c13b7ad2ad246d5db10cd419"><td class="mdescLeft"> </td><td class="mdescRight">Send Row Address 3. <a href="#gaeb5d1be9c13b7ad2ad246d5db10cd419">More...</a><br/></td></tr>
<tr class="separator:gaeb5d1be9c13b7ad2ad246d5db10cd419"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga959522c98183036da32984dd5e07979b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga959522c98183036da32984dd5e07979b">ARM_NAND_CODE_INC_ADDR_ROW</a>   (1UL << 23)</td></tr>
<tr class="memdesc:ga959522c98183036da32984dd5e07979b"><td class="mdescLeft"> </td><td class="mdescRight">Auto-increment Row Address. <a href="#ga959522c98183036da32984dd5e07979b">More...</a><br/></td></tr>
<tr class="separator:ga959522c98183036da32984dd5e07979b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1b40fc5fbf22dc4fa8130f5836e30d12"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga1b40fc5fbf22dc4fa8130f5836e30d12">ARM_NAND_CODE_WRITE_DATA</a>   (1UL << 24)</td></tr>
<tr class="memdesc:ga1b40fc5fbf22dc4fa8130f5836e30d12"><td class="mdescLeft"> </td><td class="mdescRight">Write Data. <a href="#ga1b40fc5fbf22dc4fa8130f5836e30d12">More...</a><br/></td></tr>
<tr class="separator:ga1b40fc5fbf22dc4fa8130f5836e30d12"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacffafbbbca74f7ffa4cd3bb6b067c4ef"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#gacffafbbbca74f7ffa4cd3bb6b067c4ef">ARM_NAND_CODE_SEND_CMD2</a>   (1UL << 25)</td></tr>
<tr class="memdesc:gacffafbbbca74f7ffa4cd3bb6b067c4ef"><td class="mdescLeft"> </td><td class="mdescRight">Send Command 2. <a href="#gacffafbbbca74f7ffa4cd3bb6b067c4ef">More...</a><br/></td></tr>
<tr class="separator:gacffafbbbca74f7ffa4cd3bb6b067c4ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0f4a8b1e97656e09f1c383852f290a37"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga0f4a8b1e97656e09f1c383852f290a37">ARM_NAND_CODE_WAIT_BUSY</a>   (1UL << 26)</td></tr>
<tr class="memdesc:ga0f4a8b1e97656e09f1c383852f290a37"><td class="mdescLeft"> </td><td class="mdescRight">Wait while R/Bn busy. <a href="#ga0f4a8b1e97656e09f1c383852f290a37">More...</a><br/></td></tr>
<tr class="separator:ga0f4a8b1e97656e09f1c383852f290a37"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab524d840ab57c720ce8560144651dc9d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#gab524d840ab57c720ce8560144651dc9d">ARM_NAND_CODE_READ_DATA</a>   (1UL << 27)</td></tr>
<tr class="memdesc:gab524d840ab57c720ce8560144651dc9d"><td class="mdescLeft"> </td><td class="mdescRight">Read Data. <a href="#gab524d840ab57c720ce8560144651dc9d">More...</a><br/></td></tr>
<tr class="separator:gab524d840ab57c720ce8560144651dc9d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga20f96743ab77bda14ba391dc0c3cdba5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga20f96743ab77bda14ba391dc0c3cdba5">ARM_NAND_CODE_SEND_CMD3</a>   (1UL << 28)</td></tr>
<tr class="memdesc:ga20f96743ab77bda14ba391dc0c3cdba5"><td class="mdescLeft"> </td><td class="mdescRight">Send Command 3. <a href="#ga20f96743ab77bda14ba391dc0c3cdba5">More...</a><br/></td></tr>
<tr class="separator:ga20f96743ab77bda14ba391dc0c3cdba5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2250f6a532d2c0834bfdc618761ddc86"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga2250f6a532d2c0834bfdc618761ddc86">ARM_NAND_CODE_READ_STATUS</a>   (1UL << 29)</td></tr>
<tr class="memdesc:ga2250f6a532d2c0834bfdc618761ddc86"><td class="mdescLeft"> </td><td class="mdescRight">Read Status byte and check FAIL bit (bit 0) <a href="#ga2250f6a532d2c0834bfdc618761ddc86">More...</a><br/></td></tr>
<tr class="separator:ga2250f6a532d2c0834bfdc618761ddc86"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify execution codes. </p>
<p>The defines can be used in the function <a class="el" href="group__nand__interface__gr.html#ga8a0108dba757a4610475151144b52825">ARM_NAND_ExecuteSequence</a> for the parameter <em>code</em>. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gaef90c96cd4f2309044d7d438c6b0930a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_SEND_CMD1   (1UL << 17)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Command 1. </p>
</div>
</div>
<a class="anchor" id="ga891bcba60ebb1195ec80c00c9bec748a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_SEND_ADDR_COL1   (1UL << 18)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Column Address 1. </p>
</div>
</div>
<a class="anchor" id="ga62a3f6ddcfb9ee317655bbec9e09bc10"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_SEND_ADDR_COL2   (1UL << 19)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Column Address 2. </p>
</div>
</div>
<a class="anchor" id="gadc001e69d1e81dc28a542237c6fe11ff"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_SEND_ADDR_ROW1   (1UL << 20)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Row Address 1. </p>
</div>
</div>
<a class="anchor" id="ga5e55628cb59f5d7d35c529f04ebfcd10"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_SEND_ADDR_ROW2   (1UL << 21)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Row Address 2. </p>
</div>
</div>
<a class="anchor" id="gaeb5d1be9c13b7ad2ad246d5db10cd419"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_SEND_ADDR_ROW3   (1UL << 22)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Row Address 3. </p>
</div>
</div>
<a class="anchor" id="ga959522c98183036da32984dd5e07979b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_INC_ADDR_ROW   (1UL << 23)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Auto-increment Row Address. </p>
</div>
</div>
<a class="anchor" id="ga1b40fc5fbf22dc4fa8130f5836e30d12"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_WRITE_DATA   (1UL << 24)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Write Data. </p>
</div>
</div>
<a class="anchor" id="gacffafbbbca74f7ffa4cd3bb6b067c4ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_SEND_CMD2   (1UL << 25)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Command 2. </p>
</div>
</div>
<a class="anchor" id="ga0f4a8b1e97656e09f1c383852f290a37"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_WAIT_BUSY   (1UL << 26)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Wait while R/Bn busy. </p>
</div>
</div>
<a class="anchor" id="gab524d840ab57c720ce8560144651dc9d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_READ_DATA   (1UL << 27)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Read Data. </p>
</div>
</div>
<a class="anchor" id="ga20f96743ab77bda14ba391dc0c3cdba5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_SEND_CMD3   (1UL << 28)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Command 3. </p>
</div>
</div>
<a class="anchor" id="ga2250f6a532d2c0834bfdc618761ddc86"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_READ_STATUS   (1UL << 29)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Read Status byte and check FAIL bit (bit 0) </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__driver__seq__exec__codes.html | HTML | apache-2.0 | 20,170 |
var group__nand__driver__seq__exec__codes =
[
[ "ARM_NAND_CODE_SEND_CMD1", "group__nand__driver__seq__exec__codes.html#gaef90c96cd4f2309044d7d438c6b0930a", null ],
[ "ARM_NAND_CODE_SEND_ADDR_COL1", "group__nand__driver__seq__exec__codes.html#ga891bcba60ebb1195ec80c00c9bec748a", null ],
[ "ARM_NAND_CODE_SEND_ADDR_COL2", "group__nand__driver__seq__exec__codes.html#ga62a3f6ddcfb9ee317655bbec9e09bc10", null ],
[ "ARM_NAND_CODE_SEND_ADDR_ROW1", "group__nand__driver__seq__exec__codes.html#gadc001e69d1e81dc28a542237c6fe11ff", null ],
[ "ARM_NAND_CODE_SEND_ADDR_ROW2", "group__nand__driver__seq__exec__codes.html#ga5e55628cb59f5d7d35c529f04ebfcd10", null ],
[ "ARM_NAND_CODE_SEND_ADDR_ROW3", "group__nand__driver__seq__exec__codes.html#gaeb5d1be9c13b7ad2ad246d5db10cd419", null ],
[ "ARM_NAND_CODE_INC_ADDR_ROW", "group__nand__driver__seq__exec__codes.html#ga959522c98183036da32984dd5e07979b", null ],
[ "ARM_NAND_CODE_WRITE_DATA", "group__nand__driver__seq__exec__codes.html#ga1b40fc5fbf22dc4fa8130f5836e30d12", null ],
[ "ARM_NAND_CODE_SEND_CMD2", "group__nand__driver__seq__exec__codes.html#gacffafbbbca74f7ffa4cd3bb6b067c4ef", null ],
[ "ARM_NAND_CODE_WAIT_BUSY", "group__nand__driver__seq__exec__codes.html#ga0f4a8b1e97656e09f1c383852f290a37", null ],
[ "ARM_NAND_CODE_READ_DATA", "group__nand__driver__seq__exec__codes.html#gab524d840ab57c720ce8560144651dc9d", null ],
[ "ARM_NAND_CODE_SEND_CMD3", "group__nand__driver__seq__exec__codes.html#ga20f96743ab77bda14ba391dc0c3cdba5", null ],
[ "ARM_NAND_CODE_READ_STATUS", "group__nand__driver__seq__exec__codes.html#ga2250f6a532d2c0834bfdc618761ddc86", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__driver__seq__exec__codes.js | JavaScript | apache-2.0 | 1,664 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>NAND Driver Strength</title>
<title>CMSIS-Driver: NAND Driver Strength</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__nand__driver__strength__codes.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">NAND Driver Strength<div class="ingroups"><a class="el" href="group__nand__control__gr.html">NAND Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify driver strength of the NAND interface.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga942e20df12022f3bbd0e9a558ec1c7a0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__strength__codes.html#ga942e20df12022f3bbd0e9a558ec1c7a0">ARM_NAND_DRIVER_STRENGTH_18</a>   (0x00)</td></tr>
<tr class="memdesc:ga942e20df12022f3bbd0e9a558ec1c7a0"><td class="mdescLeft"> </td><td class="mdescRight">Driver Strength 2.0x = 18 Ohms. <a href="#ga942e20df12022f3bbd0e9a558ec1c7a0">More...</a><br/></td></tr>
<tr class="separator:ga942e20df12022f3bbd0e9a558ec1c7a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga17188e039f5f87c581033327399a057d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__strength__codes.html#ga17188e039f5f87c581033327399a057d">ARM_NAND_DRIVER_STRENGTH_25</a>   (0x01)</td></tr>
<tr class="memdesc:ga17188e039f5f87c581033327399a057d"><td class="mdescLeft"> </td><td class="mdescRight">Driver Strength 1.4x = 25 Ohms. <a href="#ga17188e039f5f87c581033327399a057d">More...</a><br/></td></tr>
<tr class="separator:ga17188e039f5f87c581033327399a057d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga33562a66a5bf328eea82b2f1893a7874"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__strength__codes.html#ga33562a66a5bf328eea82b2f1893a7874">ARM_NAND_DRIVER_STRENGTH_35</a>   (0x02)</td></tr>
<tr class="memdesc:ga33562a66a5bf328eea82b2f1893a7874"><td class="mdescLeft"> </td><td class="mdescRight">Driver Strength 1.0x = 35 Ohms (default) <a href="#ga33562a66a5bf328eea82b2f1893a7874">More...</a><br/></td></tr>
<tr class="separator:ga33562a66a5bf328eea82b2f1893a7874"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa502e2c995447037d266f939faa43223"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__strength__codes.html#gaa502e2c995447037d266f939faa43223">ARM_NAND_DRIVER_STRENGTH_50</a>   (0x03)</td></tr>
<tr class="memdesc:gaa502e2c995447037d266f939faa43223"><td class="mdescLeft"> </td><td class="mdescRight">Driver Strength 0.7x = 50 Ohms. <a href="#gaa502e2c995447037d266f939faa43223">More...</a><br/></td></tr>
<tr class="separator:gaa502e2c995447037d266f939faa43223"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify driver strength of the NAND interface. </p>
<p>The defines can be used in the function <a class="el" href="group__nand__interface__gr.html#ga83061d6d53ffb148853efbc87a864607">ARM_NAND_Control</a> for the parameter <em>arg</em> and with the <a class="el" href="group__nand__control__codes.html#ga5d1d46198404fe115b013bdae7af2a2f">ARM_NAND_DRIVER_STRENGTH</a> as the <em>control</em> code. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga942e20df12022f3bbd0e9a558ec1c7a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_DRIVER_STRENGTH_18   (0x00)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Driver Strength 2.0x = 18 Ohms. </p>
</div>
</div>
<a class="anchor" id="ga17188e039f5f87c581033327399a057d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_DRIVER_STRENGTH_25   (0x01)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Driver Strength 1.4x = 25 Ohms. </p>
</div>
</div>
<a class="anchor" id="ga33562a66a5bf328eea82b2f1893a7874"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_DRIVER_STRENGTH_35   (0x02)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Driver Strength 1.0x = 35 Ohms (default) </p>
</div>
</div>
<a class="anchor" id="gaa502e2c995447037d266f939faa43223"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_DRIVER_STRENGTH_50   (0x03)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Driver Strength 0.7x = 50 Ohms. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__driver__strength__codes.html | HTML | apache-2.0 | 11,255 |
var group__nand__driver__strength__codes =
[
[ "ARM_NAND_DRIVER_STRENGTH_18", "group__nand__driver__strength__codes.html#ga942e20df12022f3bbd0e9a558ec1c7a0", null ],
[ "ARM_NAND_DRIVER_STRENGTH_25", "group__nand__driver__strength__codes.html#ga17188e039f5f87c581033327399a057d", null ],
[ "ARM_NAND_DRIVER_STRENGTH_35", "group__nand__driver__strength__codes.html#ga33562a66a5bf328eea82b2f1893a7874", null ],
[ "ARM_NAND_DRIVER_STRENGTH_50", "group__nand__driver__strength__codes.html#gaa502e2c995447037d266f939faa43223", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__driver__strength__codes.js | JavaScript | apache-2.0 | 546 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Status Error Codes</title>
<title>CMSIS-Driver: Status Error Codes</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__nand__execution__status.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Status Error Codes<div class="ingroups"><a class="el" href="group__nand__interface__gr.html">NAND Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Negative values indicate errors (NAND has specific codes in addition to common <a class="el" href="group__execution__status.html">Status Error Codes</a>).
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gafebec6ac091750a47b1d59bc843c15b0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__execution__status.html#gafebec6ac091750a47b1d59bc843c15b0">ARM_NAND_ERROR_ECC</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 1)</td></tr>
<tr class="memdesc:gafebec6ac091750a47b1d59bc843c15b0"><td class="mdescLeft"> </td><td class="mdescRight">ECC generation/correction failed. <a href="#gafebec6ac091750a47b1d59bc843c15b0">More...</a><br/></td></tr>
<tr class="separator:gafebec6ac091750a47b1d59bc843c15b0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Negative values indicate errors (NAND has specific codes in addition to common <a class="el" href="group__execution__status.html">Status Error Codes</a>). </p>
<p>The NAND driver has additional status error codes that are listed below. Note that the NAND driver also returns the common <a class="el" href="group__execution__status.html">Status Error Codes</a>. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gafebec6ac091750a47b1d59bc843c15b0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_ERROR_ECC   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>ECC generation/correction failed. </p>
<p>ECC generation or correction failed during <a class="el" href="group__nand__interface__gr.html#gae1899a20ef107400c8bf84fad477a8ce">ARM_NAND_ReadData</a>, <a class="el" href="group__nand__interface__gr.html#ga1fa497dd51a86fc308e946b4419fd006">ARM_NAND_WriteData</a> or <a class="el" href="group__nand__interface__gr.html#ga8a0108dba757a4610475151144b52825">ARM_NAND_ExecuteSequence</a>. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__execution__status.html | HTML | apache-2.0 | 8,855 |
var group__nand__execution__status =
[
[ "ARM_NAND_ERROR_ECC", "group__nand__execution__status.html#gafebec6ac091750a47b1d59bc843c15b0", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__execution__status.js | JavaScript | apache-2.0 | 150 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>NAND Interface</title>
<title>CMSIS-Driver: NAND Interface</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__nand__interface__gr.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Content</a> |
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">NAND Interface</div> </div>
</div><!--header-->
<div class="contents">
<p>Driver API for NAND Flash Device Interface (Driver_NAND.h).
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Content</h2></td></tr>
<tr class="memitem:group__nand__execution__status"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__execution__status.html">Status Error Codes</a></td></tr>
<tr class="memdesc:group__nand__execution__status"><td class="mdescLeft"> </td><td class="mdescRight">Negative values indicate errors (NAND has specific codes in addition to common <a class="el" href="group__execution__status.html">Status Error Codes</a>). <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__NAND__events"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__NAND__events.html">NAND Events</a></td></tr>
<tr class="memdesc:group__NAND__events"><td class="mdescLeft"> </td><td class="mdescRight">The NAND driver generates call back events that are notified via the function <a class="el" href="group__nand__interface__gr.html#gaf4ce80b0fd6717de7ddfb1cfaf7dd754">ARM_NAND_SignalEvent</a>. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__nand__driver__flag__codes"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__flag__codes.html">NAND Flags</a></td></tr>
<tr class="memdesc:group__nand__driver__flag__codes"><td class="mdescLeft"> </td><td class="mdescRight">Specify Flag codes. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__nand__control__gr"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__control__gr.html">NAND Control Codes</a></td></tr>
<tr class="memdesc:group__nand__control__gr"><td class="mdescLeft"> </td><td class="mdescRight">Many parameters of the NAND driver are configured using the <a class="el" href="group__nand__interface__gr.html#ga83061d6d53ffb148853efbc87a864607">ARM_NAND_Control</a> function. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__nand__driver__ecc__codes"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__ecc__codes.html">NAND ECC Codes</a></td></tr>
<tr class="memdesc:group__nand__driver__ecc__codes"><td class="mdescLeft"> </td><td class="mdescRight">Specify ECC codes. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__nand__driver__seq__exec__codes"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html">NAND Sequence Execution Codes</a></td></tr>
<tr class="memdesc:group__nand__driver__seq__exec__codes"><td class="mdescLeft"> </td><td class="mdescRight">Specify execution codes. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:structARM__NAND__STATUS"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#structARM__NAND__STATUS">ARM_NAND_STATUS</a></td></tr>
<tr class="memdesc:structARM__NAND__STATUS"><td class="mdescLeft"> </td><td class="mdescRight">NAND Status. <a href="group__nand__interface__gr.html#structARM__NAND__STATUS">More...</a><br/></td></tr>
<tr class="separator:structARM__NAND__STATUS"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__DRIVER__NAND"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#structARM__DRIVER__NAND">ARM_DRIVER_NAND</a></td></tr>
<tr class="memdesc:structARM__DRIVER__NAND"><td class="mdescLeft"> </td><td class="mdescRight">Access structure of the NAND Driver. <a href="group__nand__interface__gr.html#structARM__DRIVER__NAND">More...</a><br/></td></tr>
<tr class="separator:structARM__DRIVER__NAND"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__NAND__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a></td></tr>
<tr class="memdesc:structARM__NAND__CAPABILITIES"><td class="mdescLeft"> </td><td class="mdescRight">NAND Driver Capabilities. <a href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">More...</a><br/></td></tr>
<tr class="separator:structARM__NAND__CAPABILITIES"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__NAND__ECC__INFO"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#structARM__NAND__ECC__INFO">ARM_NAND_ECC_INFO</a></td></tr>
<tr class="memdesc:structARM__NAND__ECC__INFO"><td class="mdescLeft"> </td><td class="mdescRight">NAND ECC (Error Correction Code) Information. <a href="group__nand__interface__gr.html#structARM__NAND__ECC__INFO">More...</a><br/></td></tr>
<tr class="separator:structARM__NAND__ECC__INFO"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga09f4cf2f2df0bb690bce38b13d77e50f"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#ga09f4cf2f2df0bb690bce38b13d77e50f">ARM_NAND_SignalEvent_t</a> )(uint32_t dev_num, uint32_t event)</td></tr>
<tr class="memdesc:ga09f4cf2f2df0bb690bce38b13d77e50f"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__nand__interface__gr.html#gaf4ce80b0fd6717de7ddfb1cfaf7dd754">ARM_NAND_SignalEvent</a> : Signal NAND Event. <a href="#ga09f4cf2f2df0bb690bce38b13d77e50f">More...</a><br/></td></tr>
<tr class="separator:ga09f4cf2f2df0bb690bce38b13d77e50f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga01255fd4f15e7fa4751c7ea59648ef5a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#ga01255fd4f15e7fa4751c7ea59648ef5a">ARM_NAND_GetVersion</a> (void)</td></tr>
<tr class="memdesc:ga01255fd4f15e7fa4751c7ea59648ef5a"><td class="mdescLeft"> </td><td class="mdescRight">Get driver version. <a href="#ga01255fd4f15e7fa4751c7ea59648ef5a">More...</a><br/></td></tr>
<tr class="separator:ga01255fd4f15e7fa4751c7ea59648ef5a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9f2609975c2008d21b9ae28f15daf147"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#ga9f2609975c2008d21b9ae28f15daf147">ARM_NAND_GetCapabilities</a> (void)</td></tr>
<tr class="memdesc:ga9f2609975c2008d21b9ae28f15daf147"><td class="mdescLeft"> </td><td class="mdescRight">Get driver capabilities. <a href="#ga9f2609975c2008d21b9ae28f15daf147">More...</a><br/></td></tr>
<tr class="separator:ga9f2609975c2008d21b9ae28f15daf147"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga74ad34718a595e7a4375b90f33e72750"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#ga74ad34718a595e7a4375b90f33e72750">ARM_NAND_Initialize</a> (<a class="el" href="group__nand__interface__gr.html#ga09f4cf2f2df0bb690bce38b13d77e50f">ARM_NAND_SignalEvent_t</a> cb_event)</td></tr>
<tr class="memdesc:ga74ad34718a595e7a4375b90f33e72750"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the NAND Interface. <a href="#ga74ad34718a595e7a4375b90f33e72750">More...</a><br/></td></tr>
<tr class="separator:ga74ad34718a595e7a4375b90f33e72750"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa788b638ab696b166fee2f4a4bc8d97a"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#gaa788b638ab696b166fee2f4a4bc8d97a">ARM_NAND_Uninitialize</a> (void)</td></tr>
<tr class="memdesc:gaa788b638ab696b166fee2f4a4bc8d97a"><td class="mdescLeft"> </td><td class="mdescRight">De-initialize the NAND Interface. <a href="#gaa788b638ab696b166fee2f4a4bc8d97a">More...</a><br/></td></tr>
<tr class="separator:gaa788b638ab696b166fee2f4a4bc8d97a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9c9975637980b5d42db7baba0191fda1"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#ga9c9975637980b5d42db7baba0191fda1">ARM_NAND_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:ga9c9975637980b5d42db7baba0191fda1"><td class="mdescLeft"> </td><td class="mdescRight">Control the NAND interface power. <a href="#ga9c9975637980b5d42db7baba0191fda1">More...</a><br/></td></tr>
<tr class="separator:ga9c9975637980b5d42db7baba0191fda1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga11adcbaaace09746581a36befbd563c9"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#ga11adcbaaace09746581a36befbd563c9">ARM_NAND_DevicePower</a> (uint32_t voltage)</td></tr>
<tr class="memdesc:ga11adcbaaace09746581a36befbd563c9"><td class="mdescLeft"> </td><td class="mdescRight">Set device power supply voltage. <a href="#ga11adcbaaace09746581a36befbd563c9">More...</a><br/></td></tr>
<tr class="separator:ga11adcbaaace09746581a36befbd563c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1987e65a4e756d748db86332c9fb1cec"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#ga1987e65a4e756d748db86332c9fb1cec">ARM_NAND_WriteProtect</a> (uint32_t dev_num, bool enable)</td></tr>
<tr class="memdesc:ga1987e65a4e756d748db86332c9fb1cec"><td class="mdescLeft"> </td><td class="mdescRight">Control WPn (Write Protect). <a href="#ga1987e65a4e756d748db86332c9fb1cec">More...</a><br/></td></tr>
<tr class="separator:ga1987e65a4e756d748db86332c9fb1cec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1c0cba87cb7b706ad5986dc67c831ad1"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#ga1c0cba87cb7b706ad5986dc67c831ad1">ARM_NAND_ChipEnable</a> (uint32_t dev_num, bool enable)</td></tr>
<tr class="memdesc:ga1c0cba87cb7b706ad5986dc67c831ad1"><td class="mdescLeft"> </td><td class="mdescRight">Control CEn (Chip Enable). <a href="#ga1c0cba87cb7b706ad5986dc67c831ad1">More...</a><br/></td></tr>
<tr class="separator:ga1c0cba87cb7b706ad5986dc67c831ad1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga43011066306bd716b580e6aa9a80cf65"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#ga43011066306bd716b580e6aa9a80cf65">ARM_NAND_GetDeviceBusy</a> (uint32_t dev_num)</td></tr>
<tr class="memdesc:ga43011066306bd716b580e6aa9a80cf65"><td class="mdescLeft"> </td><td class="mdescRight">Get Device Busy pin state. <a href="#ga43011066306bd716b580e6aa9a80cf65">More...</a><br/></td></tr>
<tr class="separator:ga43011066306bd716b580e6aa9a80cf65"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9f70b89ba478eadfe7f5dee7453a4fb7"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#ga9f70b89ba478eadfe7f5dee7453a4fb7">ARM_NAND_SendCommand</a> (uint32_t dev_num, uint8_t cmd)</td></tr>
<tr class="memdesc:ga9f70b89ba478eadfe7f5dee7453a4fb7"><td class="mdescLeft"> </td><td class="mdescRight">Send command to NAND device. <a href="#ga9f70b89ba478eadfe7f5dee7453a4fb7">More...</a><br/></td></tr>
<tr class="separator:ga9f70b89ba478eadfe7f5dee7453a4fb7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga00e195031e03d364db7595858a7e76f3"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#ga00e195031e03d364db7595858a7e76f3">ARM_NAND_SendAddress</a> (uint32_t dev_num, uint8_t addr)</td></tr>
<tr class="memdesc:ga00e195031e03d364db7595858a7e76f3"><td class="mdescLeft"> </td><td class="mdescRight">Send address to NAND device. <a href="#ga00e195031e03d364db7595858a7e76f3">More...</a><br/></td></tr>
<tr class="separator:ga00e195031e03d364db7595858a7e76f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae1899a20ef107400c8bf84fad477a8ce"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#gae1899a20ef107400c8bf84fad477a8ce">ARM_NAND_ReadData</a> (uint32_t dev_num, void *data, uint32_t cnt, uint32_t mode)</td></tr>
<tr class="memdesc:gae1899a20ef107400c8bf84fad477a8ce"><td class="mdescLeft"> </td><td class="mdescRight">Read data from NAND device. <a href="#gae1899a20ef107400c8bf84fad477a8ce">More...</a><br/></td></tr>
<tr class="separator:gae1899a20ef107400c8bf84fad477a8ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1fa497dd51a86fc308e946b4419fd006"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#ga1fa497dd51a86fc308e946b4419fd006">ARM_NAND_WriteData</a> (uint32_t dev_num, const void *data, uint32_t cnt, uint32_t mode)</td></tr>
<tr class="memdesc:ga1fa497dd51a86fc308e946b4419fd006"><td class="mdescLeft"> </td><td class="mdescRight">Write data to NAND device. <a href="#ga1fa497dd51a86fc308e946b4419fd006">More...</a><br/></td></tr>
<tr class="separator:ga1fa497dd51a86fc308e946b4419fd006"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8a0108dba757a4610475151144b52825"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#ga8a0108dba757a4610475151144b52825">ARM_NAND_ExecuteSequence</a> (uint32_t dev_num, uint32_t code, uint32_t cmd, uint32_t addr_col, uint32_t addr_row, void *data, uint32_t data_cnt, uint8_t *status, uint32_t *count)</td></tr>
<tr class="memdesc:ga8a0108dba757a4610475151144b52825"><td class="mdescLeft"> </td><td class="mdescRight">Execute sequence of operations. <a href="#ga8a0108dba757a4610475151144b52825">More...</a><br/></td></tr>
<tr class="separator:ga8a0108dba757a4610475151144b52825"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga00832861f018db0d8368900b099ecd30"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#ga00832861f018db0d8368900b099ecd30">ARM_NAND_AbortSequence</a> (uint32_t dev_num)</td></tr>
<tr class="memdesc:ga00832861f018db0d8368900b099ecd30"><td class="mdescLeft"> </td><td class="mdescRight">Abort sequence execution. <a href="#ga00832861f018db0d8368900b099ecd30">More...</a><br/></td></tr>
<tr class="separator:ga00832861f018db0d8368900b099ecd30"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga83061d6d53ffb148853efbc87a864607"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#ga83061d6d53ffb148853efbc87a864607">ARM_NAND_Control</a> (uint32_t dev_num, uint32_t control, uint32_t arg)</td></tr>
<tr class="memdesc:ga83061d6d53ffb148853efbc87a864607"><td class="mdescLeft"> </td><td class="mdescRight">Control NAND Interface. <a href="#ga83061d6d53ffb148853efbc87a864607">More...</a><br/></td></tr>
<tr class="separator:ga83061d6d53ffb148853efbc87a864607"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4578642f37a556b58b0bba0ad5d42641"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nand__interface__gr.html#structARM__NAND__STATUS">ARM_NAND_STATUS</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#ga4578642f37a556b58b0bba0ad5d42641">ARM_NAND_GetStatus</a> (uint32_t dev_num)</td></tr>
<tr class="memdesc:ga4578642f37a556b58b0bba0ad5d42641"><td class="mdescLeft"> </td><td class="mdescRight">Get NAND status. <a href="#ga4578642f37a556b58b0bba0ad5d42641">More...</a><br/></td></tr>
<tr class="separator:ga4578642f37a556b58b0bba0ad5d42641"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac21425454d586ef48fdfc35e7bd78947"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#gac21425454d586ef48fdfc35e7bd78947">ARM_NAND_InquireECC</a> (int32_t index, <a class="el" href="group__nand__interface__gr.html#structARM__NAND__ECC__INFO">ARM_NAND_ECC_INFO</a> *info)</td></tr>
<tr class="memdesc:gac21425454d586ef48fdfc35e7bd78947"><td class="mdescLeft"> </td><td class="mdescRight">Inquire about available ECC. <a href="#gac21425454d586ef48fdfc35e7bd78947">More...</a><br/></td></tr>
<tr class="separator:gac21425454d586ef48fdfc35e7bd78947"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf4ce80b0fd6717de7ddfb1cfaf7dd754"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#gaf4ce80b0fd6717de7ddfb1cfaf7dd754">ARM_NAND_SignalEvent</a> (uint32_t dev_num, uint32_t event)</td></tr>
<tr class="memdesc:gaf4ce80b0fd6717de7ddfb1cfaf7dd754"><td class="mdescLeft"> </td><td class="mdescRight">Signal NAND event. <a href="#gaf4ce80b0fd6717de7ddfb1cfaf7dd754">More...</a><br/></td></tr>
<tr class="separator:gaf4ce80b0fd6717de7ddfb1cfaf7dd754"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Driver API for NAND Flash Device Interface (Driver_NAND.h). </p>
<p><b>NAND</b> devices are a type of non-volatile storage and do not require power to hold data. Wikipedia offers more information about the <a href="http://en.wikipedia.org/wiki/Flash_memory#ARM_NAND_memories" target="_blank"><b>Flash Memories</b></a>, including NAND.</p>
<p><b>Block Diagram</b></p>
<p> </p>
<div class="image">
<img src="NAND_Schematics.png" alt="NAND_Schematics.png"/>
<div class="caption">
Simplified NAND Flash Schematic</div></div>
<p> </p>
<p><b>NAND API</b></p>
<p>The following header files define the Application Programming Interface (API) for the NAND interface:</p>
<ul>
<li><b>Driver_NAND.h</b> : Driver API for NAND Flash Device Interface</li>
</ul>
<p>The driver implementation is a typical part of the Device Family Pack (DFP) that supports the peripherals of the microcontroller family.</p>
<p>NAND Flash is organized in pages, grouped into blocks as the smallest erasable unit. The addressing of data is archieved by <code>byte_address = block * block_size + page_in_block * page_size + offset_in_page</code>. In terms of this NAND API blocks and pages are referrd to as <code>row</code> and the byte offset within the page as <code>col</code>. Thus one can calculate the <code>byte_address = row * page_size + col</code>. The parameters <code>page_size</code> and <code>block_size</code> are device specific and must be handled by the driver user appropriately.</p>
<p><b>Driver Functions</b></p>
<p>The driver functions are published in the access struct as explained in <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a></p>
<ul>
<li><a class="el" href="group__nand__interface__gr.html#structARM__DRIVER__NAND">ARM_DRIVER_NAND</a> : access struct for NAND driver functions</li>
</ul>
<p><a class="anchor" id="example"></a><b>Example Code:</b></p>
<div class="fragment"><div class="line"><span class="preprocessor">#include "<a class="code" href="Driver__NAND_8h.html">Driver_NAND.h</a>"</span></div>
<div class="line"> </div>
<div class="line"><span class="comment">/* ONFI commands */</span></div>
<div class="line"><span class="preprocessor">#define ONFI_CMD_READ_1ST 0x00 </span><span class="comment">///< Read 1st Cycle</span></div>
<div class="line"><span class="comment"></span>#define ONFI_CMD_PROGRAM_2ND 0x10 <span class="comment">///< Page Program 2nd Cycle</span></div>
<div class="line"><span class="comment"></span>#define ONFI_CMD_READ_2ND 0x30 <span class="comment">///< Read 2nd Cycle</span></div>
<div class="line"><span class="comment"></span>#define ONFI_CMD_PROGRAM_1ST 0x80 <span class="comment">///< Page Program 1st Cycle</span></div>
<div class="line"><span class="comment"></span>#define ONFI_CMD_RESET 0xFF <span class="comment">///< Reset Command</span></div>
<div class="line"><span class="comment"></span> </div>
<div class="line"><span class="comment">/* NAND Signal Event callback function */</span></div>
<div class="line"><span class="keyword">volatile</span> uint32_t NAND_Events;</div>
<div class="line"><span class="keywordtype">void</span> NAND_SignalEventCallback (uint32_t dev_num, uint32_t event) {</div>
<div class="line"> <span class="keywordflow">if</span> (dev_num == 0) {</div>
<div class="line"> NAND_Events |= event;</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">else</span> {</div>
<div class="line"> <span class="comment">// ..</span></div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* NAND device Power ON */</span></div>
<div class="line"><span class="keywordtype">void</span> PowerOn (<a class="code" href="group__nand__interface__gr.html#structARM__DRIVER__NAND">ARM_DRIVER_NAND</a> *drv, uint32_t dev_num) {</div>
<div class="line"> <a class="code" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a> capabilities;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Query drivers capabilities</span></div>
<div class="line"> capabilities = drv-><a class="code" href="group__nand__interface__gr.html#adab9d081aee3e5d1f83c6911e45ceaa6">GetCapabilities</a>();</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Initialize NAND device</span></div>
<div class="line"> drv-><a class="code" href="group__nand__interface__gr.html#a28b29ab7b6114bb97175bd40d18854ac">Initialize</a> (NAND_SignalEventCallback);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Power-on NAND driver</span></div>
<div class="line"> drv-><a class="code" href="group__nand__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> (<a class="code" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a>);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Turn ON device power</span></div>
<div class="line"> uint32_t volt = 0U;</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (capabilities.<a class="code" href="group__nand__interface__gr.html#a35cfa22b2140b109fe24b97c42d5a5ed">vcc</a>) { volt |= <a class="code" href="Driver__NAND_8h.html#ad15355d67bc239ff49cceac69c2024b3">ARM_NAND_POWER_VCC_3V3</a>; }</div>
<div class="line"> <span class="keywordflow">if</span> (capabilities.<a class="code" href="group__nand__interface__gr.html#a0e7d3b9258d468492b22de55d855a06e">vcc_1v8</a>) { volt |= <a class="code" href="Driver__NAND_8h.html#aa7b9d5a71125b745caba5c1d7aff6385">ARM_NAND_POWER_VCC_1V8</a>; }</div>
<div class="line"> <span class="keywordflow">if</span> (capabilities.<a class="code" href="group__nand__interface__gr.html#ab1cdfce6eb051bed7b904e0fd1719afa">vccq</a>) { volt |= <a class="code" href="Driver__NAND_8h.html#a6d5a8a33a0fdaaff2e57e1ac53c984c2">ARM_NAND_POWER_VCCQ_3V3</a>; }</div>
<div class="line"> <span class="keywordflow">if</span> (capabilities.<a class="code" href="group__nand__interface__gr.html#a1896a7548bb6fab285f23cc0d0b23d7d">vccq_1v8</a>) { volt |= <a class="code" href="Driver__NAND_8h.html#a653d9b4d7bee173beb49d8fec0469476">ARM_NAND_POWER_VCCQ_1V8</a>; }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (volt != 0U) { </div>
<div class="line"> drv-><a class="code" href="group__nand__interface__gr.html#a9ba6f3066cda5c8d781c309a17315a58">DevicePower</a> (volt);</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Setting bus mode</span></div>
<div class="line"> drv-><a class="code" href="group__nand__interface__gr.html#a706fedbc88921808e210d75b7b5da168">Control</a> (0U, <a class="code" href="group__nand__control__codes.html#ga9b063c3078e86b50d4aa892518b2e2d8">ARM_NAND_BUS_MODE</a>, <a class="code" href="group__nand__bus__mode__codes.html#gac7743aeb6411b97f9fc6a24b556f4963">ARM_NAND_BUS_SDR</a>);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Setting bus data width</span></div>
<div class="line"> drv-><a class="code" href="group__nand__interface__gr.html#a706fedbc88921808e210d75b7b5da168">Control</a> (0U, <a class="code" href="group__nand__control__codes.html#ga2d3356f5b47871c465ae7136a2c533f4">ARM_NAND_BUS_DATA_WIDTH</a>, <a class="code" href="group__nand__data__bus__width__codes.html#ga578051cc193ae0b7125aec8007071d21">ARM_NAND_BUS_DATA_WIDTH_8</a>);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Enable chip manually if needed</span></div>
<div class="line"> <span class="keywordflow">if</span> (capabilities.<a class="code" href="group__nand__interface__gr.html#a2b8044d986995b183b057217643466bf">ce_manual</a>) {</div>
<div class="line"> drv-><a class="code" href="group__nand__interface__gr.html#ac090c205fe3d1b3dcb7288b06468bbe5">ChipEnable</a> (dev_num, <span class="keyword">true</span>);</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Send ONFI Reset command */</span></div>
<div class="line"> drv-><a class="code" href="group__nand__interface__gr.html#a3dbd36d86718980665ce2e3a1ba672ca">SendCommand</a> (dev_num, ONFI_CMD_RESET);</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* NAND device Power OFF */</span></div>
<div class="line"><span class="keywordtype">void</span> PowerOff (<a class="code" href="group__nand__interface__gr.html#structARM__DRIVER__NAND">ARM_DRIVER_NAND</a> *drv, uint32_t dev_num) {</div>
<div class="line"> <a class="code" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a> capabilities;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Query drivers capabilities</span></div>
<div class="line"> capabilities = drv-><a class="code" href="group__nand__interface__gr.html#adab9d081aee3e5d1f83c6911e45ceaa6">GetCapabilities</a>();</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Disable chip manually if needed</span></div>
<div class="line"> <span class="keywordflow">if</span> (capabilities.<a class="code" href="group__nand__interface__gr.html#a2b8044d986995b183b057217643466bf">ce_manual</a>) {</div>
<div class="line"> drv-><a class="code" href="group__nand__interface__gr.html#ac090c205fe3d1b3dcb7288b06468bbe5">ChipEnable</a> (0U, <span class="keyword">false</span>);</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Switch OFF gracefully</span></div>
<div class="line"> uint32_t volt = 0U;</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (capabilities.<a class="code" href="group__nand__interface__gr.html#a35cfa22b2140b109fe24b97c42d5a5ed">vcc</a>) { volt |= <a class="code" href="Driver__NAND_8h.html#a323c320a6195b78c2c79f5c6e85f02e1">ARM_NAND_POWER_VCC_OFF</a>; }</div>
<div class="line"> <span class="keywordflow">if</span> (capabilities.<a class="code" href="group__nand__interface__gr.html#ab1cdfce6eb051bed7b904e0fd1719afa">vccq</a>) { volt |= <a class="code" href="Driver__NAND_8h.html#aca7679e8269ee986559f4218816937c3">ARM_NAND_POWER_VCCQ_OFF</a>; }</div>
<div class="line"> <span class="keywordflow">if</span> (volt) {</div>
<div class="line"> drv-><a class="code" href="group__nand__interface__gr.html#a9ba6f3066cda5c8d781c309a17315a58">DevicePower</a> (volt);</div>
<div class="line"> }</div>
<div class="line"> drv-><a class="code" href="group__nand__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> (<a class="code" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35">ARM_POWER_OFF</a>);</div>
<div class="line"> drv-><a class="code" href="group__nand__interface__gr.html#adcf20681a1402869ecb5c6447fada17b">Uninitialize</a> ();</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Read NAND page. */</span></div>
<div class="line"><span class="keywordtype">void</span> ReadPage (<a class="code" href="group__nand__interface__gr.html#structARM__DRIVER__NAND">ARM_DRIVER_NAND</a> *drv, uint32_t row, uint8_t *data, uint32_t cnt) {</div>
<div class="line"> uint32_t dev_num = 0; <span class="comment">// Device number</span></div>
<div class="line"> uint32_t mode;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Send Read 1st command</span></div>
<div class="line"> drv-><a class="code" href="group__nand__interface__gr.html#a3dbd36d86718980665ce2e3a1ba672ca">SendCommand</a> (dev_num, ONFI_CMD_READ_1ST);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Send address (column: 2 cycles, row: 3 cycles)</span></div>
<div class="line"> drv-><a class="code" href="group__nand__interface__gr.html#a5a43001ef1ca6c6d73f03e366bf41cb5">SendAddress</a> (dev_num, 0x00);</div>
<div class="line"> drv-><a class="code" href="group__nand__interface__gr.html#a5a43001ef1ca6c6d73f03e366bf41cb5">SendAddress</a> (dev_num, 0x00);</div>
<div class="line"> drv-><a class="code" href="group__nand__interface__gr.html#a5a43001ef1ca6c6d73f03e366bf41cb5">SendAddress</a> (dev_num, (uint8_t)(row));</div>
<div class="line"> drv-><a class="code" href="group__nand__interface__gr.html#a5a43001ef1ca6c6d73f03e366bf41cb5">SendAddress</a> (dev_num, (uint8_t)(row >> 8));</div>
<div class="line"> drv-><a class="code" href="group__nand__interface__gr.html#a5a43001ef1ca6c6d73f03e366bf41cb5">SendAddress</a> (dev_num, (uint8_t)(row >> 16));</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Send Read 2nd command</span></div>
<div class="line"> drv-><a class="code" href="group__nand__interface__gr.html#a3dbd36d86718980665ce2e3a1ba672ca">SendCommand</a> (dev_num, ONFI_CMD_READ_2ND);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Wait until device ready</span></div>
<div class="line"> <span class="keywordflow">while</span> (drv-><a class="code" href="group__nand__interface__gr.html#ac9bc93fb1a089c6ac71428122f3a072e">GetDeviceBusy</a>(dev_num) == 1) { ; }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Use ECC algorithm number 2, ECC0 (ECC over main+spare)</span></div>
<div class="line"> mode = <a class="code" href="group__nand__driver__ecc__codes.html#gac2eb4475f12a443209165d29fe200030">ARM_NAND_ECC</a>(2) | <a class="code" href="group__nand__driver__ecc__codes.html#ga15c79a12200c16f953936635f930df1d">ARM_NAND_ECC0</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Transfer data from the NAND chip</span></div>
<div class="line"> <span class="keywordflow">if</span> (drv-><a class="code" href="group__nand__interface__gr.html#aeba263544c0d63ec8c29e919232615cb">ReadData</a> (dev_num, data, cnt, mode | <a class="code" href="group__nand__driver__flag__codes.html#gaf40631ba62411e0ac06c3a945d608581">ARM_NAND_DRIVER_DONE_EVENT</a>) != cnt) {</div>
<div class="line"> <span class="comment">// Wait until driver done event received</span></div>
<div class="line"> <span class="keywordflow">while</span> ((NAND_Events & <a class="code" href="group__nand__driver__flag__codes.html#gaf40631ba62411e0ac06c3a945d608581">ARM_NAND_DRIVER_DONE_EVENT</a>) == 0) { ; }</div>
<div class="line"> <span class="comment">// Read page completed</span></div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> ((NAND_Events & <a class="code" href="group__NAND__events.html#ga7bee0c32528ab991c0c064f895f80664">ARM_NAND_EVENT_ECC_ERROR</a>) != 0) {</div>
<div class="line"> <span class="comment">// ECC correction failed</span></div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Write NAND page (ExecuteSequence interface). */</span></div>
<div class="line"><span class="keywordtype">void</span> WritePage_Seq (<a class="code" href="group__nand__interface__gr.html#structARM__DRIVER__NAND">ARM_DRIVER_NAND</a> *drv, uint32_t row, <span class="keyword">const</span> uint8_t *data, uint32_t cnt) {</div>
<div class="line"> uint32_t dev_num = 0; <span class="comment">// Device number</span></div>
<div class="line"> uint32_t cmd;</div>
<div class="line"> uint32_t code;</div>
<div class="line"> uint32_t seq;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Prepare commands to send</span></div>
<div class="line"> cmd = ONFI_CMD_PROGRAM_1ST | (ONFI_CMD_PROGRAM_2ND << 8);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Construct sequence code:</span></div>
<div class="line"> <span class="comment">// - Send command 1</span></div>
<div class="line"> <span class="comment">// - Send 2 cycles of column address and 3 cycles of row address</span></div>
<div class="line"> <span class="comment">// - Write data from memory to device</span></div>
<div class="line"> <span class="comment">// - Send command 2</span></div>
<div class="line"> code = <a class="code" href="group__nand__driver__seq__exec__codes.html#gaef90c96cd4f2309044d7d438c6b0930a">ARM_NAND_CODE_SEND_CMD1</a> |</div>
<div class="line"> <a class="code" href="group__nand__driver__seq__exec__codes.html#ga891bcba60ebb1195ec80c00c9bec748a">ARM_NAND_CODE_SEND_ADDR_COL1</a> |</div>
<div class="line"> <a class="code" href="group__nand__driver__seq__exec__codes.html#ga62a3f6ddcfb9ee317655bbec9e09bc10">ARM_NAND_CODE_SEND_ADDR_COL2</a> |</div>
<div class="line"> <a class="code" href="group__nand__driver__seq__exec__codes.html#gadc001e69d1e81dc28a542237c6fe11ff">ARM_NAND_CODE_SEND_ADDR_ROW1</a> |</div>
<div class="line"> <a class="code" href="group__nand__driver__seq__exec__codes.html#ga5e55628cb59f5d7d35c529f04ebfcd10">ARM_NAND_CODE_SEND_ADDR_ROW2</a> |</div>
<div class="line"> <a class="code" href="group__nand__driver__seq__exec__codes.html#gaeb5d1be9c13b7ad2ad246d5db10cd419">ARM_NAND_CODE_SEND_ADDR_ROW3</a> |</div>
<div class="line"> <a class="code" href="group__nand__driver__seq__exec__codes.html#ga1b40fc5fbf22dc4fa8130f5836e30d12">ARM_NAND_CODE_WRITE_DATA</a> |</div>
<div class="line"> <a class="code" href="group__nand__driver__seq__exec__codes.html#gacffafbbbca74f7ffa4cd3bb6b067c4ef">ARM_NAND_CODE_SEND_CMD2</a> ;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// - Use ECC algorithm number 2, ECC0 (ECC over main+spare)</span></div>
<div class="line"> code |= <a class="code" href="group__nand__driver__ecc__codes.html#gac2eb4475f12a443209165d29fe200030">ARM_NAND_ECC</a>(2) | <a class="code" href="group__nand__driver__ecc__codes.html#ga15c79a12200c16f953936635f930df1d">ARM_NAND_ECC0</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Number of iterations in a sequence</span></div>
<div class="line"> seq = 1;</div>
<div class="line"> </div>
<div class="line"> drv-><a class="code" href="group__nand__interface__gr.html#af0dd5e96fbcc5c15bb183363f8541af8">ExecuteSequence</a> (dev_num, <span class="comment">// Device number</span></div>
<div class="line"> code, <span class="comment">// Sequence code</span></div>
<div class="line"> cmd, <span class="comment">// Command(s)</span></div>
<div class="line"> 0, <span class="comment">// Column address</span></div>
<div class="line"> row, <span class="comment">// Row address</span></div>
<div class="line"> (<span class="keywordtype">void</span> *)data, <span class="comment">// Data buffer</span></div>
<div class="line"> cnt, <span class="comment">// Number of data items (per iteration)</span></div>
<div class="line"> NULL, <span class="comment">// Device status will not be read</span></div>
<div class="line"> &seq); <span class="comment">// Number of iterations</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Wait until done</span></div>
<div class="line"> <span class="keywordflow">while</span> (drv-><a class="code" href="group__nand__interface__gr.html#aa43ee108ee5bf29e40485ca89b34188b">GetStatus</a>(dev_num).<a class="code" href="group__nand__interface__gr.html#a50c88f3c1d787773e2ac1b59533f034a">busy</a> != 0) { ; }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Page write completed</span></div>
<div class="line">}</div>
</div><!-- fragment --> <hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structARM__NAND__STATUS" id="structARM__NAND__STATUS"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_NAND_STATUS</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>NAND Status. </p>
<p>Structure with information about the status of a NAND. The data fields encode flags for the driver.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__nand__interface__gr.html#ga4578642f37a556b58b0bba0ad5d42641">ARM_NAND_GetStatus</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a50c88f3c1d787773e2ac1b59533f034a"></a>uint32_t</td>
<td class="fieldname">
busy: 1</td>
<td class="fielddoc">
Driver busy flag. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a7707d2200a3bf8f49b148ffc8ded7636"></a>uint32_t</td>
<td class="fieldname">
ecc_error: 1</td>
<td class="fielddoc">
ECC error detected (cleared on next Read/WriteData or ExecuteSequence) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 30</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<a name="structARM__DRIVER__NAND" id="structARM__DRIVER__NAND"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_DRIVER_NAND</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Access structure of the NAND Driver. </p>
<p>The functions of the NAND driver are accessed by function pointers exposed by this structure. Refer to <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a> for overview information.</p>
<p>Each instance of a NAND interface provides such an access structure. The instance is identified by a postfix number in the symbol name of the access structure, for example:</p>
<ul>
<li><b>Driver_NAND0</b> is the name of the access struct of the first instance (no. 0).</li>
<li><b>Driver_NAND1</b> is the name of the access struct of the second instance (no. 1).</li>
</ul>
<p>A middleware configuration setting allows connecting the middleware to a specific driver instance <b>Driver_NAND<em>n</em></b>. The default is <span class="XML-Token">0</span>, which connects a middleware to the first instance of a driver. </p>
</div><table class="memberdecls">
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
<tr class="memitem:a8834b281da48583845c044a81566c1b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#a8834b281da48583845c044a81566c1b3">GetVersion</a> )(void)</td></tr>
<tr class="memdesc:a8834b281da48583845c044a81566c1b3"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__nand__interface__gr.html#ga01255fd4f15e7fa4751c7ea59648ef5a">ARM_NAND_GetVersion</a> : Get driver version. <a href="#a8834b281da48583845c044a81566c1b3">More...</a><br/></td></tr>
<tr class="separator:a8834b281da48583845c044a81566c1b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adab9d081aee3e5d1f83c6911e45ceaa6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#adab9d081aee3e5d1f83c6911e45ceaa6">GetCapabilities</a> )(void)</td></tr>
<tr class="memdesc:adab9d081aee3e5d1f83c6911e45ceaa6"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__nand__interface__gr.html#ga9f2609975c2008d21b9ae28f15daf147">ARM_NAND_GetCapabilities</a> : Get driver capabilities. <a href="#adab9d081aee3e5d1f83c6911e45ceaa6">More...</a><br/></td></tr>
<tr class="separator:adab9d081aee3e5d1f83c6911e45ceaa6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a28b29ab7b6114bb97175bd40d18854ac"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#a28b29ab7b6114bb97175bd40d18854ac">Initialize</a> )(<a class="el" href="group__nand__interface__gr.html#ga09f4cf2f2df0bb690bce38b13d77e50f">ARM_NAND_SignalEvent_t</a> cb_event)</td></tr>
<tr class="memdesc:a28b29ab7b6114bb97175bd40d18854ac"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__nand__interface__gr.html#ga74ad34718a595e7a4375b90f33e72750">ARM_NAND_Initialize</a> : Initialize NAND Interface. <a href="#a28b29ab7b6114bb97175bd40d18854ac">More...</a><br/></td></tr>
<tr class="separator:a28b29ab7b6114bb97175bd40d18854ac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adcf20681a1402869ecb5c6447fada17b"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#adcf20681a1402869ecb5c6447fada17b">Uninitialize</a> )(void)</td></tr>
<tr class="memdesc:adcf20681a1402869ecb5c6447fada17b"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__nand__interface__gr.html#gaa788b638ab696b166fee2f4a4bc8d97a">ARM_NAND_Uninitialize</a> : De-initialize NAND Interface. <a href="#adcf20681a1402869ecb5c6447fada17b">More...</a><br/></td></tr>
<tr class="separator:adcf20681a1402869ecb5c6447fada17b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba8f1c8019af95ffe19c32403e3240ef"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> )(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:aba8f1c8019af95ffe19c32403e3240ef"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__nand__interface__gr.html#ga9c9975637980b5d42db7baba0191fda1">ARM_NAND_PowerControl</a> : Control NAND Interface Power. <a href="#aba8f1c8019af95ffe19c32403e3240ef">More...</a><br/></td></tr>
<tr class="separator:aba8f1c8019af95ffe19c32403e3240ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9ba6f3066cda5c8d781c309a17315a58"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#a9ba6f3066cda5c8d781c309a17315a58">DevicePower</a> )(uint32_t voltage)</td></tr>
<tr class="memdesc:a9ba6f3066cda5c8d781c309a17315a58"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__nand__interface__gr.html#ga11adcbaaace09746581a36befbd563c9">ARM_NAND_DevicePower</a> : Set device power supply voltage. <a href="#a9ba6f3066cda5c8d781c309a17315a58">More...</a><br/></td></tr>
<tr class="separator:a9ba6f3066cda5c8d781c309a17315a58"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add6fa19a729c42303581214bc9dec819"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#add6fa19a729c42303581214bc9dec819">WriteProtect</a> )(uint32_t dev_num, bool enable)</td></tr>
<tr class="memdesc:add6fa19a729c42303581214bc9dec819"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__nand__interface__gr.html#ga1987e65a4e756d748db86332c9fb1cec">ARM_NAND_WriteProtect</a> : Control WPn (Write Protect). <a href="#add6fa19a729c42303581214bc9dec819">More...</a><br/></td></tr>
<tr class="separator:add6fa19a729c42303581214bc9dec819"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac090c205fe3d1b3dcb7288b06468bbe5"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#ac090c205fe3d1b3dcb7288b06468bbe5">ChipEnable</a> )(uint32_t dev_num, bool enable)</td></tr>
<tr class="memdesc:ac090c205fe3d1b3dcb7288b06468bbe5"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__nand__interface__gr.html#ga1c0cba87cb7b706ad5986dc67c831ad1">ARM_NAND_ChipEnable</a> : Control CEn (Chip Enable). <a href="#ac090c205fe3d1b3dcb7288b06468bbe5">More...</a><br/></td></tr>
<tr class="separator:ac090c205fe3d1b3dcb7288b06468bbe5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac9bc93fb1a089c6ac71428122f3a072e"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#ac9bc93fb1a089c6ac71428122f3a072e">GetDeviceBusy</a> )(uint32_t dev_num)</td></tr>
<tr class="memdesc:ac9bc93fb1a089c6ac71428122f3a072e"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__nand__interface__gr.html#ga43011066306bd716b580e6aa9a80cf65">ARM_NAND_GetDeviceBusy</a> : Get Device Busy pin state. <a href="#ac9bc93fb1a089c6ac71428122f3a072e">More...</a><br/></td></tr>
<tr class="separator:ac9bc93fb1a089c6ac71428122f3a072e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3dbd36d86718980665ce2e3a1ba672ca"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#a3dbd36d86718980665ce2e3a1ba672ca">SendCommand</a> )(uint32_t dev_num, uint8_t cmd)</td></tr>
<tr class="memdesc:a3dbd36d86718980665ce2e3a1ba672ca"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__nand__interface__gr.html#ga9f70b89ba478eadfe7f5dee7453a4fb7">ARM_NAND_SendCommand</a> : Send command to NAND device. <a href="#a3dbd36d86718980665ce2e3a1ba672ca">More...</a><br/></td></tr>
<tr class="separator:a3dbd36d86718980665ce2e3a1ba672ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a43001ef1ca6c6d73f03e366bf41cb5"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#a5a43001ef1ca6c6d73f03e366bf41cb5">SendAddress</a> )(uint32_t dev_num, uint8_t addr)</td></tr>
<tr class="memdesc:a5a43001ef1ca6c6d73f03e366bf41cb5"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__nand__interface__gr.html#ga00e195031e03d364db7595858a7e76f3">ARM_NAND_SendAddress</a> : Send address to NAND device. <a href="#a5a43001ef1ca6c6d73f03e366bf41cb5">More...</a><br/></td></tr>
<tr class="separator:a5a43001ef1ca6c6d73f03e366bf41cb5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeba263544c0d63ec8c29e919232615cb"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#aeba263544c0d63ec8c29e919232615cb">ReadData</a> )(uint32_t dev_num, void *data, uint32_t cnt, uint32_t mode)</td></tr>
<tr class="memdesc:aeba263544c0d63ec8c29e919232615cb"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__nand__interface__gr.html#gae1899a20ef107400c8bf84fad477a8ce">ARM_NAND_ReadData</a> : Read data from NAND device. <a href="#aeba263544c0d63ec8c29e919232615cb">More...</a><br/></td></tr>
<tr class="separator:aeba263544c0d63ec8c29e919232615cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a78393d355e539c6f845b33417da60a7e"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#a78393d355e539c6f845b33417da60a7e">WriteData</a> )(uint32_t dev_num, const void *data, uint32_t cnt, uint32_t mode)</td></tr>
<tr class="memdesc:a78393d355e539c6f845b33417da60a7e"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__nand__interface__gr.html#ga1fa497dd51a86fc308e946b4419fd006">ARM_NAND_WriteData</a> : Write data to NAND device. <a href="#a78393d355e539c6f845b33417da60a7e">More...</a><br/></td></tr>
<tr class="separator:a78393d355e539c6f845b33417da60a7e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0dd5e96fbcc5c15bb183363f8541af8"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#af0dd5e96fbcc5c15bb183363f8541af8">ExecuteSequence</a> )(uint32_t dev_num, uint32_t code, uint32_t cmd, uint32_t addr_col, uint32_t addr_row, void *data, uint32_t data_cnt, uint8_t *status, uint32_t *count)</td></tr>
<tr class="memdesc:af0dd5e96fbcc5c15bb183363f8541af8"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__nand__interface__gr.html#ga8a0108dba757a4610475151144b52825">ARM_NAND_ExecuteSequence</a> : Execute sequence of operations. <a href="#af0dd5e96fbcc5c15bb183363f8541af8">More...</a><br/></td></tr>
<tr class="separator:af0dd5e96fbcc5c15bb183363f8541af8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad6e1d53e9028baff856899f795c0d0c8"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#ad6e1d53e9028baff856899f795c0d0c8">AbortSequence</a> )(uint32_t dev_num)</td></tr>
<tr class="memdesc:ad6e1d53e9028baff856899f795c0d0c8"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__nand__interface__gr.html#ga00832861f018db0d8368900b099ecd30">ARM_NAND_AbortSequence</a> : Abort sequence execution. <a href="#ad6e1d53e9028baff856899f795c0d0c8">More...</a><br/></td></tr>
<tr class="separator:ad6e1d53e9028baff856899f795c0d0c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a706fedbc88921808e210d75b7b5da168"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#a706fedbc88921808e210d75b7b5da168">Control</a> )(uint32_t dev_num, uint32_t control, uint32_t arg)</td></tr>
<tr class="memdesc:a706fedbc88921808e210d75b7b5da168"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__nand__interface__gr.html#ga83061d6d53ffb148853efbc87a864607">ARM_NAND_Control</a> : Control NAND Interface. <a href="#a706fedbc88921808e210d75b7b5da168">More...</a><br/></td></tr>
<tr class="separator:a706fedbc88921808e210d75b7b5da168"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa43ee108ee5bf29e40485ca89b34188b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nand__interface__gr.html#structARM__NAND__STATUS">ARM_NAND_STATUS</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#aa43ee108ee5bf29e40485ca89b34188b">GetStatus</a> )(uint32_t dev_num)</td></tr>
<tr class="memdesc:aa43ee108ee5bf29e40485ca89b34188b"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__nand__interface__gr.html#ga4578642f37a556b58b0bba0ad5d42641">ARM_NAND_GetStatus</a> : Get NAND status. <a href="#aa43ee108ee5bf29e40485ca89b34188b">More...</a><br/></td></tr>
<tr class="separator:aa43ee108ee5bf29e40485ca89b34188b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aecd239806e9f08b77ce0d00f61e78cf8"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__interface__gr.html#aecd239806e9f08b77ce0d00f61e78cf8">InquireECC</a> )(int32_t index, <a class="el" href="group__nand__interface__gr.html#structARM__NAND__ECC__INFO">ARM_NAND_ECC_INFO</a> *info)</td></tr>
<tr class="memdesc:aecd239806e9f08b77ce0d00f61e78cf8"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__nand__interface__gr.html#gac21425454d586ef48fdfc35e7bd78947">ARM_NAND_InquireECC</a> : Inquire about available ECC. <a href="#aecd239806e9f08b77ce0d00f61e78cf8">More...</a><br/></td></tr>
<tr class="separator:aecd239806e9f08b77ce0d00f61e78cf8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h4 class="groupheader">Field Documentation</h4>
<a class="anchor" id="a8834b281da48583845c044a81566c1b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* GetVersion)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__nand__interface__gr.html#ga01255fd4f15e7fa4751c7ea59648ef5a">ARM_NAND_GetVersion</a> : Get driver version. </p>
</div>
</div>
<a class="anchor" id="adab9d081aee3e5d1f83c6911e45ceaa6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a>(* GetCapabilities)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__nand__interface__gr.html#ga9f2609975c2008d21b9ae28f15daf147">ARM_NAND_GetCapabilities</a> : Get driver capabilities. </p>
</div>
</div>
<a class="anchor" id="a28b29ab7b6114bb97175bd40d18854ac"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Initialize)(<a class="el" href="group__nand__interface__gr.html#ga09f4cf2f2df0bb690bce38b13d77e50f">ARM_NAND_SignalEvent_t</a> cb_event)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__nand__interface__gr.html#ga74ad34718a595e7a4375b90f33e72750">ARM_NAND_Initialize</a> : Initialize NAND Interface. </p>
</div>
</div>
<a class="anchor" id="adcf20681a1402869ecb5c6447fada17b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Uninitialize)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__nand__interface__gr.html#gaa788b638ab696b166fee2f4a4bc8d97a">ARM_NAND_Uninitialize</a> : De-initialize NAND Interface. </p>
</div>
</div>
<a class="anchor" id="aba8f1c8019af95ffe19c32403e3240ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* PowerControl)(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__nand__interface__gr.html#ga9c9975637980b5d42db7baba0191fda1">ARM_NAND_PowerControl</a> : Control NAND Interface Power. </p>
</div>
</div>
<a class="anchor" id="a9ba6f3066cda5c8d781c309a17315a58"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* DevicePower)(uint32_t voltage)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__nand__interface__gr.html#ga11adcbaaace09746581a36befbd563c9">ARM_NAND_DevicePower</a> : Set device power supply voltage. </p>
</div>
</div>
<a class="anchor" id="add6fa19a729c42303581214bc9dec819"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* WriteProtect)(uint32_t dev_num, bool enable)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__nand__interface__gr.html#ga1987e65a4e756d748db86332c9fb1cec">ARM_NAND_WriteProtect</a> : Control WPn (Write Protect). </p>
</div>
</div>
<a class="anchor" id="ac090c205fe3d1b3dcb7288b06468bbe5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* ChipEnable)(uint32_t dev_num, bool enable)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__nand__interface__gr.html#ga1c0cba87cb7b706ad5986dc67c831ad1">ARM_NAND_ChipEnable</a> : Control CEn (Chip Enable). </p>
</div>
</div>
<a class="anchor" id="ac9bc93fb1a089c6ac71428122f3a072e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* GetDeviceBusy)(uint32_t dev_num)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__nand__interface__gr.html#ga43011066306bd716b580e6aa9a80cf65">ARM_NAND_GetDeviceBusy</a> : Get Device Busy pin state. </p>
</div>
</div>
<a class="anchor" id="a3dbd36d86718980665ce2e3a1ba672ca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SendCommand)(uint32_t dev_num, uint8_t cmd)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__nand__interface__gr.html#ga9f70b89ba478eadfe7f5dee7453a4fb7">ARM_NAND_SendCommand</a> : Send command to NAND device. </p>
</div>
</div>
<a class="anchor" id="a5a43001ef1ca6c6d73f03e366bf41cb5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SendAddress)(uint32_t dev_num, uint8_t addr)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__nand__interface__gr.html#ga00e195031e03d364db7595858a7e76f3">ARM_NAND_SendAddress</a> : Send address to NAND device. </p>
</div>
</div>
<a class="anchor" id="aeba263544c0d63ec8c29e919232615cb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* ReadData)(uint32_t dev_num, void *data, uint32_t cnt, uint32_t mode)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__nand__interface__gr.html#gae1899a20ef107400c8bf84fad477a8ce">ARM_NAND_ReadData</a> : Read data from NAND device. </p>
</div>
</div>
<a class="anchor" id="a78393d355e539c6f845b33417da60a7e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* WriteData)(uint32_t dev_num, const void *data, uint32_t cnt, uint32_t mode)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__nand__interface__gr.html#ga1fa497dd51a86fc308e946b4419fd006">ARM_NAND_WriteData</a> : Write data to NAND device. </p>
</div>
</div>
<a class="anchor" id="af0dd5e96fbcc5c15bb183363f8541af8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* ExecuteSequence)(uint32_t dev_num, uint32_t code, uint32_t cmd, uint32_t addr_col, uint32_t addr_row, void *data, uint32_t data_cnt, uint8_t *status, uint32_t *count)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__nand__interface__gr.html#ga8a0108dba757a4610475151144b52825">ARM_NAND_ExecuteSequence</a> : Execute sequence of operations. </p>
</div>
</div>
<a class="anchor" id="ad6e1d53e9028baff856899f795c0d0c8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* AbortSequence)(uint32_t dev_num)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__nand__interface__gr.html#ga00832861f018db0d8368900b099ecd30">ARM_NAND_AbortSequence</a> : Abort sequence execution. </p>
</div>
</div>
<a class="anchor" id="a706fedbc88921808e210d75b7b5da168"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Control)(uint32_t dev_num, uint32_t control, uint32_t arg)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__nand__interface__gr.html#ga83061d6d53ffb148853efbc87a864607">ARM_NAND_Control</a> : Control NAND Interface. </p>
</div>
</div>
<a class="anchor" id="aa43ee108ee5bf29e40485ca89b34188b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__nand__interface__gr.html#structARM__NAND__STATUS">ARM_NAND_STATUS</a>(* GetStatus)(uint32_t dev_num)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__nand__interface__gr.html#ga4578642f37a556b58b0bba0ad5d42641">ARM_NAND_GetStatus</a> : Get NAND status. </p>
</div>
</div>
<a class="anchor" id="aecd239806e9f08b77ce0d00f61e78cf8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* InquireECC)(int32_t index, <a class="el" href="group__nand__interface__gr.html#structARM__NAND__ECC__INFO">ARM_NAND_ECC_INFO</a> *info)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__nand__interface__gr.html#gac21425454d586ef48fdfc35e7bd78947">ARM_NAND_InquireECC</a> : Inquire about available ECC. </p>
</div>
</div>
</div>
</div>
<a name="structARM__NAND__CAPABILITIES" id="structARM__NAND__CAPABILITIES"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_NAND_CAPABILITIES</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>NAND Driver Capabilities. </p>
<p>A NAND driver can be implemented with different capabilities. The data fields of this struct encode the capabilities implemented by this driver.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__nand__interface__gr.html#ga9f2609975c2008d21b9ae28f15daf147">ARM_NAND_GetCapabilities</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a5f347e9b63764bbb657f52dc20682128"></a>uint32_t</td>
<td class="fieldname">
event_device_ready: 1</td>
<td class="fielddoc">
Signal Device Ready event (R/Bn rising edge) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ae0514834750c7452431717a881471e2b"></a>uint32_t</td>
<td class="fieldname">
reentrant_operation: 1</td>
<td class="fielddoc">
Supports re-entrant operation (SendCommand/Address, Read/WriteData) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="afa4b798731b1154878c26dda3f090acf"></a>uint32_t</td>
<td class="fieldname">
sequence_operation: 1</td>
<td class="fielddoc">
Supports Sequence operation (ExecuteSequence, AbortSequence) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a35cfa22b2140b109fe24b97c42d5a5ed"></a>uint32_t</td>
<td class="fieldname">
vcc: 1</td>
<td class="fielddoc">
Supports VCC Power Supply Control. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a0e7d3b9258d468492b22de55d855a06e"></a>uint32_t</td>
<td class="fieldname">
vcc_1v8: 1</td>
<td class="fielddoc">
Supports 1.8 VCC Power Supply. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ab1cdfce6eb051bed7b904e0fd1719afa"></a>uint32_t</td>
<td class="fieldname">
vccq: 1</td>
<td class="fielddoc">
Supports VCCQ I/O Power Supply Control. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a1896a7548bb6fab285f23cc0d0b23d7d"></a>uint32_t</td>
<td class="fieldname">
vccq_1v8: 1</td>
<td class="fielddoc">
Supports 1.8 VCCQ I/O Power Supply. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a75b97f7c917bba90b2f5c747d6857d23"></a>uint32_t</td>
<td class="fieldname">
vpp: 1</td>
<td class="fielddoc">
Supports VPP High Voltage Power Supply Control. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="afe7f5b149b8d92859398315b1ad31ddc"></a>uint32_t</td>
<td class="fieldname">
wp: 1</td>
<td class="fielddoc">
Supports WPn (Write Protect) Control. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ad5dd0fcdd7f6d5e5cd739f73323a2b11"></a>uint32_t</td>
<td class="fieldname">
ce_lines: 4</td>
<td class="fielddoc">
Number of CEn (Chip Enable) lines: ce_lines + 1. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a2b8044d986995b183b057217643466bf"></a>uint32_t</td>
<td class="fieldname">
ce_manual: 1</td>
<td class="fielddoc">
Supports manual CEn (Chip Enable) Control. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a69f5e734ee4a9bb501718cf78a740c3e"></a>uint32_t</td>
<td class="fieldname">
rb_monitor: 1</td>
<td class="fielddoc">
Supports R/Bn (Ready/Busy) Monitoring. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a0f22baea13daa9101bf6fc1fdfddc747"></a>uint32_t</td>
<td class="fieldname">
data_width_16: 1</td>
<td class="fielddoc">
Supports 16-bit data. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa9acfde38637fe749aa9271c0a8dae1a"></a>uint32_t</td>
<td class="fieldname">
ddr: 1</td>
<td class="fielddoc">
Supports NV-DDR Data Interface (ONFI) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ae086693990cbd5d628014c0fcc7c1f2c"></a>uint32_t</td>
<td class="fieldname">
ddr2: 1</td>
<td class="fielddoc">
Supports NV-DDR2 Data Interface (ONFI) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a21036f2047273d90c0af0e97031df5a9"></a>uint32_t</td>
<td class="fieldname">
sdr_timing_mode: 3</td>
<td class="fielddoc">
Fastest (highest) SDR Timing Mode supported (ONFI) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a00c1f5db7d7c4abe7556733c36da7783"></a>uint32_t</td>
<td class="fieldname">
ddr_timing_mode: 3</td>
<td class="fielddoc">
Fastest (highest) NV_DDR Timing Mode supported (ONFI) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a6d9b66da0e56d04d545e0bb6841891b2"></a>uint32_t</td>
<td class="fieldname">
ddr2_timing_mode: 3</td>
<td class="fielddoc">
Fastest (highest) NV_DDR2 Timing Mode supported (ONFI) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ae672b2a65dd3d0b93812c088491c4552"></a>uint32_t</td>
<td class="fieldname">
driver_strength_18: 1</td>
<td class="fielddoc">
Supports Driver Strength 2.0x = 18 Ohms. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ae87c19872b838dac7d3136a3fd466f6a"></a>uint32_t</td>
<td class="fieldname">
driver_strength_25: 1</td>
<td class="fielddoc">
Supports Driver Strength 1.4x = 25 Ohms. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aef3d6e1522a6cf7fb87fd113dcd43ad5"></a>uint32_t</td>
<td class="fieldname">
driver_strength_50: 1</td>
<td class="fielddoc">
Supports Driver Strength 0.7x = 50 Ohms. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 2</td>
<td class="fielddoc">
Reserved (must be zero) </td></tr>
</table>
</div>
</div>
<a name="structARM__NAND__ECC__INFO" id="structARM__NAND__ECC__INFO"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_NAND_ECC_INFO</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>NAND ECC (Error Correction Code) Information. </p>
<p>Stores the characteristics of a ECC (Error Correction Code) algorithm and provides the information about necessary application data handling in order to protect stored data from NAND bit errors.</p>
<p>ECC algorithms applied on NAND memory typically operate on NAND device page level which is virtually divided to multiple main and spare areas. Data from main and spare area is taken into account when generating ECC data which is also stored into spare area. ECC codeword defines how much data will be protected and how much ECC data will be generated.</p>
<p>To describe how application data must be organized, ECC information structure specifies protection <em>type</em> which defines the protected part of data. As main and spare are of different size, two different algorithms could be provided, we can describe them as ECC0 and ECC1. Type can then have the following values:</p>
<table class="doxtable">
<tr>
<th align="left">Type</th><th align="left">Description </th></tr>
<tr>
<td align="left">0 </td><td align="left">ECC algorithm not used </td></tr>
<tr>
<td align="left">1 </td><td align="left">ECC0 algorithm protects main data </td></tr>
<tr>
<td align="left">2 </td><td align="left">ECC0 algorithm protects main and spare data </td></tr>
<tr>
<td align="left">3 </td><td align="left">ECC0 algorithm protects main and ECC1 algorithm protects spare data </td></tr>
</table>
<p>Virtual page division is described with page layout (<em>page_layout</em>), number of pages (<em>page_count</em>) and virtual page size (<em>page_size</em> or <em>virtual_page_size</em>). Virtual page size used by ECC algorithm can be defined by either <em>page_size</em> or <em>virtual_page_size</em>, depending on the <em>page_size</em> values:</p>
<table class="doxtable">
<tr>
<th align="left">Value</th><th align="left">Main + Spare size </th></tr>
<tr>
<td align="left">0 </td><td align="left">512 + 16 </td></tr>
<tr>
<td align="left">1 </td><td align="left">1024 + 32 </td></tr>
<tr>
<td align="left">2 </td><td align="left">2048 + 64 </td></tr>
<tr>
<td align="left">3 </td><td align="left">4096 + 128 </td></tr>
<tr>
<td align="left">4 </td><td align="left">8192 + 256 </td></tr>
<tr>
<td align="left">8 </td><td align="left">512 + 28 </td></tr>
<tr>
<td align="left">9 </td><td align="left">1024 + 56 </td></tr>
<tr>
<td align="left">10 </td><td align="left">2048 + 112 </td></tr>
<tr>
<td align="left">11 </td><td align="left">4096 + 224 </td></tr>
<tr>
<td align="left">12 </td><td align="left">8192 + 448 </td></tr>
<tr>
<td align="left">15 </td><td align="left">Not used, use virtual_page_size </td></tr>
</table>
<p>Structure member <em>virtual_page_size</em> is an array of two 16-bit values. First field of array (i.e. <em>virtual_page_size</em>[0]) contains main area size while second (i.e. <em>virtual_page_size</em>[1]) contains spare area size. Number of virtual pages N is defined with <em>page_count</em> and must be calculated as N = 2 ^ page_count.</p>
<p>Page layout defines main and spare ordering and two different page layouts are possible. First ordering assumes that spare area follows after every main area, while in second case all main areas build one contiguous region followed by contiguous region of spare areas. This is defined by member <em>page_layout:</em> </p>
<table class="doxtable">
<tr>
<th align="left">Layout</th><th align="left">Description </th></tr>
<tr>
<td align="left">0 </td><td align="left">Single spare follows after single main: Main0,Spare0 ... MainN-1,SpareN-1 </td></tr>
<tr>
<td align="left">1 </td><td align="left">Contiguous spare follows after contiguous main: Main0 ... MainN-1,Spare0 ... SpareN-1 </td></tr>
</table>
<p>ECC codeword size defines the size of data that is protected by ECC algorithm and is different for main and spare area. All structure members that define the codeword are therefore arrays of two 16-bit values. Codeword offset defines where ECC protected data starts in main (<em>codeword_offset</em>[0]) or spare (<em>codeword_offset</em>[1]) area, codeword size (<em>codeword_size</em>) defines the number of data that is protected i.e. data over which ECC is calculated and codeword gap (<em>codeword_gap</em>) defines the space between two consecutive codeword regions.</p>
<p>Generated ECC data is stored into spare area and is described similar as codeword, with offset from start of spare area (<em>ecc_offset</em>), size of generated data (<em>ecc_size</em>) and gap (<em>ecc_gap</em>) between two consecutive ECC data regions.</p>
<p>Number of bits that ECC algorithm can correct per codeword is defined with <em>correctable_bits</em>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__nand__interface__gr.html#gac21425454d586ef48fdfc35e7bd78947">ARM_NAND_InquireECC</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ad44b615021ed3ccb734fcaf583ef4a03"></a>uint32_t</td>
<td class="fieldname">
type: 2</td>
<td class="fielddoc">
Type: 1=ECC0 over Main, 2=ECC0 over Main+Spare, 3=ECC0 over Main and ECC1 over Spare. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a5952ba4313bda7833fefd358f5aff979"></a>uint32_t</td>
<td class="fieldname">
page_layout: 1</td>
<td class="fielddoc">
Page layout: 0=|Main0|Spare0|...|MainN-1|SpareN-1|, 1=|Main0|...|MainN-1|Spare0|...|SpareN-1|. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa993bc236650aa405b01d00b7ca72904"></a>uint32_t</td>
<td class="fieldname">
page_count: 3</td>
<td class="fielddoc">
Number of virtual pages: N = 2 ^ page_count. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a9dd3e47e968a8f6beb5d88c6d1b7ebe9"></a>uint32_t</td>
<td class="fieldname">
page_size: 4</td>
<td class="fielddoc">
Virtual Page size (Main+Spare): 0=512+16, 1=1k+32, 2=2k+64, 3=4k+128, 4=8k+256, 8=512+28, 9=1k+56, 10=2k+112, 11=4k+224, 12=8k+448, 15=Not used (extended description) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 14</td>
<td class="fielddoc">
Reserved (must be zero) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ae65f920c4ad99fd0c6bdf5fd8c4d161a"></a>uint32_t</td>
<td class="fieldname">
correctable_bits: 8</td>
<td class="fielddoc">
Number of correctable bits (based on 512 byte codeword size) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ae8cff208d9efb5067d38ced675916c66"></a>uint16_t</td>
<td class="fieldname">
codeword_size[2]</td>
<td class="fielddoc">
Number of bytes over which ECC is calculated. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a22365f6a2af1171a1c3629c8ae5fe001"></a>uint16_t</td>
<td class="fieldname">
ecc_size[2]</td>
<td class="fielddoc">
ECC size in bytes (rounded up) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a22d6a1813a47a7044f7acb478f8e9eb8"></a>uint16_t</td>
<td class="fieldname">
ecc_offset[2]</td>
<td class="fielddoc">
ECC offset in bytes (where ECC starts in Spare) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa270f95e67fdf1e9137c61f2045b7636"></a>uint16_t</td>
<td class="fieldname">
virtual_page_size[2]</td>
<td class="fielddoc">
Virtual Page size in bytes (Main/Spare) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a31c5b0e899b2d60adb6cdef971633db0"></a>uint16_t</td>
<td class="fieldname">
codeword_offset[2]</td>
<td class="fielddoc">
Codeword offset in bytes (where ECC protected data starts in Main/Spare) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ae0a2b8415bddd99dade9cbcf8c52186a"></a>uint16_t</td>
<td class="fieldname">
codeword_gap[2]</td>
<td class="fielddoc">
Codeword gap in bytes till next protected data. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a94d6b62b24d96ff83c985325d8825dd3"></a>uint16_t</td>
<td class="fieldname">
ecc_gap[2]</td>
<td class="fielddoc">
ECC gap in bytes till next generated ECC. </td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga09f4cf2f2df0bb690bce38b13d77e50f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ARM_NAND_SignalEvent_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__nand__interface__gr.html#gaf4ce80b0fd6717de7ddfb1cfaf7dd754">ARM_NAND_SignalEvent</a> : Signal NAND Event. </p>
<p>Provides the typedef for the callback function <a class="el" href="group__nand__interface__gr.html#gaf4ce80b0fd6717de7ddfb1cfaf7dd754">ARM_NAND_SignalEvent</a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__nand__interface__gr.html#ga74ad34718a595e7a4375b90f33e72750">ARM_NAND_Initialize</a> </li>
</ul>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga01255fd4f15e7fa4751c7ea59648ef5a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> ARM_NAND_GetVersion </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get driver version. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></dd></dl>
<p>The function <b>ARM_NAND_GetVersion</b> returns version information of the driver implementation in <a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></p>
<ul>
<li>API version is the version of the CMSIS-Driver specification used to implement this driver.</li>
<li>Driver version is source code version of the actual driver implementation.</li>
</ul>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__nand__interface__gr.html#structARM__DRIVER__NAND">ARM_DRIVER_NAND</a> Driver_NAND0;</div>
<div class="line"><a class="code" href="group__nand__interface__gr.html#structARM__DRIVER__NAND">ARM_DRIVER_NAND</a> *drv_info;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> setup_nand (<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> version;</div>
<div class="line"> </div>
<div class="line"> drv_info = &Driver_NAND0; </div>
<div class="line"> version = drv_info-><a class="code" href="group__nand__interface__gr.html#a8834b281da48583845c044a81566c1b3">GetVersion</a> ();</div>
<div class="line"> <span class="keywordflow">if</span> (version.<a class="code" href="group__common__drv__gr.html#ad180da20fbde1d3dafc074af87c19540">api</a> < 0x10A) { <span class="comment">// requires at minimum API version 1.10 or higher</span></div>
<div class="line"> <span class="comment">// error handling</span></div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga9f2609975c2008d21b9ae28f15daf147"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a> ARM_NAND_GetCapabilities </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get driver capabilities. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a></dd></dl>
<p>The function <b>ARM_NAND_GetCapabilities</b> retrieves information about capabilities in this driver implementation. The data fields of the structure <a class="el" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a> encode various capabilities, for example if a hardware is able to create signal events using the <a class="el" href="group__nand__interface__gr.html#gaf4ce80b0fd6717de7ddfb1cfaf7dd754">ARM_NAND_SignalEvent</a> callback function.</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__nand__interface__gr.html#structARM__DRIVER__NAND">ARM_DRIVER_NAND</a> Driver_NAND0;</div>
<div class="line"><a class="code" href="group__nand__interface__gr.html#structARM__DRIVER__NAND">ARM_DRIVER_NAND</a> *drv_info;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> read_capabilities (<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a> drv_capabilities;</div>
<div class="line"> </div>
<div class="line"> drv_info = &Driver_NAND0; </div>
<div class="line"> drv_capabilities = drv_info-><a class="code" href="group__nand__interface__gr.html#adab9d081aee3e5d1f83c6911e45ceaa6">GetCapabilities</a> ();</div>
<div class="line"> <span class="comment">// interrogate capabilities</span></div>
<div class="line"> </div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga74ad34718a595e7a4375b90f33e72750"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_NAND_Initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__nand__interface__gr.html#ga09f4cf2f2df0bb690bce38b13d77e50f">ARM_NAND_SignalEvent_t</a> </td>
<td class="paramname"><em>cb_event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the NAND Interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cb_event</td><td>Pointer to <a class="el" href="group__nand__interface__gr.html#gaf4ce80b0fd6717de7ddfb1cfaf7dd754">ARM_NAND_SignalEvent</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_NAND_Initialize</b> initializes the NAND interface. It is called when the middleware component starts operation.</p>
<p>The function performs the following operations:</p>
<ul>
<li>Initializes the resources needed for the NAND interface.</li>
<li>Registers the <a class="el" href="group__nand__interface__gr.html#gaf4ce80b0fd6717de7ddfb1cfaf7dd754">ARM_NAND_SignalEvent</a> callback function.</li>
</ul>
<p>The parameter <em>cb_event</em> is a pointer to the <a class="el" href="group__nand__interface__gr.html#gaf4ce80b0fd6717de7ddfb1cfaf7dd754">ARM_NAND_SignalEvent</a> callback function; use a NULL pointer when no callback signals are required.</p>
<p><b>Example:</b> </p>
<ul>
<li>see <a class="el" href="group__nand__interface__gr.html">NAND Interface</a> - Driver Functions </li>
</ul>
</div>
</div>
<a class="anchor" id="gaa788b638ab696b166fee2f4a4bc8d97a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_NAND_Uninitialize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>De-initialize the NAND Interface. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_NAND_Uninitialize</b> de-initializes the resources of NAND interface.</p>
<p>It is called when the middleware component stops operation and releases the software resources used by the interface. </p>
</div>
</div>
<a class="anchor" id="ga9c9975637980b5d42db7baba0191fda1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_NAND_PowerControl </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> </td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control the NAND interface power. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>Power state </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_NAND_PowerControl</b> controls the power modes of the NAND interface.</p>
<p>The parameter <em>state</em> sets the operation and can have the following values:</p>
<ul>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a> : set-up peripheral for data transfers, enable interrupts (NVIC) and optionally DMA. Can be called multiple times. If the peripheral is already in this mode the function performs no operation and returns with <a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>.</li>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5a9ef9e57cbcc948d0e22314e73dc8c434">ARM_POWER_LOW</a> : may use power saving. Returns <a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> when not implemented.</li>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35">ARM_POWER_OFF</a> : terminates any pending data transfers, disables peripheral, disables related interrupts and DMA.</li>
</ul>
<p>Refer to <a class="el" href="theoryOperation.html#CallSequence">Function Call Sequence</a> for more information. </p>
</div>
</div>
<a class="anchor" id="ga11adcbaaace09746581a36befbd563c9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_NAND_DevicePower </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>voltage</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set device power supply voltage. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">voltage</td><td>NAND Device supply voltage </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_NAND_DevicePower</b> controls the power supply of the NAND device.</p>
<p>The parameter <em>voltage</em> sets the device supply voltage as defined in the table.</p>
<p><b>AMR_NAND_POWER_xxx_xxx</b> specifies power settings.</p>
<table class="doxtable">
<tr>
<th align="left">Device Power Bits </th><th align="left">Description </th></tr>
<tr>
<td align="left"><a class="el" href="Driver__NAND_8h.html#a323c320a6195b78c2c79f5c6e85f02e1">ARM_NAND_POWER_VCC_OFF</a> </td><td align="left">Set VCC Power off </td></tr>
<tr>
<td align="left"><a class="el" href="Driver__NAND_8h.html#ad15355d67bc239ff49cceac69c2024b3">ARM_NAND_POWER_VCC_3V3</a> </td><td align="left">Set VCC = 3.3V </td></tr>
<tr>
<td align="left"><a class="el" href="Driver__NAND_8h.html#aa7b9d5a71125b745caba5c1d7aff6385">ARM_NAND_POWER_VCC_1V8</a> </td><td align="left">Set VCC = 1.8V </td></tr>
<tr>
<td align="left"><a class="el" href="Driver__NAND_8h.html#aca7679e8269ee986559f4218816937c3">ARM_NAND_POWER_VCCQ_OFF</a> </td><td align="left">Set VCCQ I/O Power off </td></tr>
<tr>
<td align="left"><a class="el" href="Driver__NAND_8h.html#a6d5a8a33a0fdaaff2e57e1ac53c984c2">ARM_NAND_POWER_VCCQ_3V3</a> </td><td align="left">Set VCCQ = 3.3V </td></tr>
<tr>
<td align="left"><a class="el" href="Driver__NAND_8h.html#a653d9b4d7bee173beb49d8fec0469476">ARM_NAND_POWER_VCCQ_1V8</a> </td><td align="left">Set VCCQ = 1.8V </td></tr>
<tr>
<td align="left"><a class="el" href="Driver__NAND_8h.html#ae2d278901881ffc73d3e0b48717b22f0">ARM_NAND_POWER_VPP_OFF</a> </td><td align="left">Set VPP off </td></tr>
<tr>
<td align="left"><a class="el" href="Driver__NAND_8h.html#aeb0d50e30bbcd8ab59c3b78db634aad5">ARM_NAND_POWER_VPP_ON</a> </td><td align="left">Set VPP on </td></tr>
</table>
</div>
</div>
<a class="anchor" id="ga1987e65a4e756d748db86332c9fb1cec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_NAND_WriteProtect </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>dev_num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>enable</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control WPn (Write Protect). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev_num</td><td>Device number </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td><ul>
<li><b>false</b> Write Protect off</li>
<li><b>true</b> Write Protect on </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_NAND_WriteProtect</b> controls the Write Protect (WPn) pin of a NAND device.</p>
<p>The parameter <em>dev_num</em> is the device number. <br/>
The parameter <em>enable</em> specifies whether to enable or disable write protection. </p>
</div>
</div>
<a class="anchor" id="ga1c0cba87cb7b706ad5986dc67c831ad1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_NAND_ChipEnable </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>dev_num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>enable</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control CEn (Chip Enable). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev_num</td><td>Device number </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td><ul>
<li><b>false</b> Chip Enable off</li>
<li><b>true</b> Chip Enable on </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_NAND_ChipEnable</b> control the Chip Enable (CEn) pin of a NAND device.</p>
<p>The parameter <em>dev_num</em> is the device number. <br/>
The parameter <em>enable</em> specifies whether to enable or disable the device.</p>
<p>This function is optional and supported only when the data field <em>ce_manual</em> = <span class="XML-Token">1</span> in the structure <a class="el" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a>. Otherwise, the Chip Enable (CEn) signal is controlled automatically by SendCommand/Address, Read/WriteData and ExecuteSequence (for example when the NAND device is connected to a memory bus). </p>
</div>
</div>
<a class="anchor" id="ga43011066306bd716b580e6aa9a80cf65"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_NAND_GetDeviceBusy </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>dev_num</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get Device Busy pin state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev_num</td><td>Device number </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1=busy, 0=not busy, or error</dd></dl>
<p>The function <b>ARM_NAND_GetDeviceBusy</b> returns the status of the Device Busy pin: [<span class="XML-Token">1=busy; 0=not busy or error</span>].</p>
<p>The parameter <em>dev_num</em> is the device number. </p>
</div>
</div>
<a class="anchor" id="ga9f70b89ba478eadfe7f5dee7453a4fb7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_NAND_SendCommand </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>dev_num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>cmd</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send command to NAND device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev_num</td><td>Device number </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>Command </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_NAND_SendCommand</b> sends a command to the NAND device.</p>
<p>The parameter <em>dev_num</em> is the device number. <br/>
The parameter <em>cmd</em> is the command sent to the NAND device. </p>
</div>
</div>
<a class="anchor" id="ga00e195031e03d364db7595858a7e76f3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_NAND_SendAddress </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>dev_num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>addr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send address to NAND device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev_num</td><td>Device number </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>Address </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>Send an address to the NAND device. The parameter <em>dev_num</em> is the device number. The parameter <em>addr</em> is the address. </p>
</div>
</div>
<a class="anchor" id="gae1899a20ef107400c8bf84fad477a8ce"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_NAND_ReadData </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>dev_num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>cnt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>mode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data from NAND device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev_num</td><td>Device number </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Pointer to buffer for data to read from NAND device </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cnt</td><td>Number of data items to read </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>Operation mode </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of data items read or <a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_NAND_ReadData</b> reads data from a NAND device.</p>
<p>The parameter <em>dev_num</em> is the device number. <br/>
The parameter <em>data</em> is a pointer to the buffer that stores the data read from a NAND device. <br/>
The parameter <em>cnt</em> is the number of data items to read. <br/>
The parameter <em>mode</em> defines the operation mode as listed in the table below.</p>
<table class="doxtable">
<tr>
<th align="left">Read Data Mode </th><th align="left">Description </th></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__ecc__codes.html#gac2eb4475f12a443209165d29fe200030">ARM_NAND_ECC(n)</a> </td><td align="left">Select ECC </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__ecc__codes.html#ga15c79a12200c16f953936635f930df1d">ARM_NAND_ECC0</a> </td><td align="left">Use ECC0 of selected ECC </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__ecc__codes.html#gaee653288a88318ee33d1db81baa69bbc">ARM_NAND_ECC1</a> </td><td align="left">Use ECC1 of selected ECC </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__flag__codes.html#gaf40631ba62411e0ac06c3a945d608581">ARM_NAND_DRIVER_DONE_EVENT</a> </td><td align="left">Generate <a class="el" href="group__NAND__events.html#gac774a334871789d24107b843d1ebd00c">ARM_NAND_EVENT_DRIVER_DONE</a> </td></tr>
</table>
<p>The data item size is defined by the data type, which depends on the configured data bus width.</p>
<p>Data type is:</p>
<ul>
<li><em>uint8_t</em> for 8-bit data bus</li>
<li><em>uint16_t</em> for 16-bit data bus</li>
</ul>
<p>The function executes in the following ways:</p>
<ul>
<li>When the operation is blocking (typical for devices connected to memory bus when not using DMA), then the function returns after all data is read and returns the number of data items read.</li>
<li>When the operation is non-blocking (typical for NAND controllers), then the function only starts the operation and returns with zero number of data items read. After the operation is completed, the <a class="el" href="group__NAND__events.html#gac774a334871789d24107b843d1ebd00c">ARM_NAND_EVENT_DRIVER_DONE</a> event is generated (if enabled by <b>ARM_NAND_DRIVER_DONE_EVENT</b>). Progress of the operation can also be monitored by calling the <a class="el" href="group__nand__interface__gr.html#ga4578642f37a556b58b0bba0ad5d42641">ARM_NAND_GetStatus</a> function and checking the <em>busy</em> data field. Operation is automatically aborted if ECC is used and ECC correction fails, which generates the <a class="el" href="group__NAND__events.html#ga7bee0c32528ab991c0c064f895f80664">ARM_NAND_EVENT_ECC_ERROR</a> event (together with <a class="el" href="group__nand__driver__flag__codes.html#gaf40631ba62411e0ac06c3a945d608581">ARM_NAND_DRIVER_DONE_EVENT</a> if enabled). </li>
</ul>
</div>
</div>
<a class="anchor" id="ga1fa497dd51a86fc308e946b4419fd006"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_NAND_WriteData </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>dev_num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>cnt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>mode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write data to NAND device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev_num</td><td>Device number </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Pointer to buffer with data to write to NAND device </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cnt</td><td>Number of data items to write </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>Operation mode </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of data items written or <a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_NAND_WriteData</b> writes data to a NAND device.</p>
<p>The parameter <em>dev_num</em> is the device number. <br/>
The parameter <em>data</em> is a pointer to the buffer with data to write. <br/>
The parameter <em>cnt</em> is the number of data items to write. <br/>
The parameter <em>mode</em> defines the operation mode as listed in the table below.</p>
<table class="doxtable">
<tr>
<th align="left">Write Data Mode </th><th align="left">Description </th></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__ecc__codes.html#gac2eb4475f12a443209165d29fe200030">ARM_NAND_ECC(n)</a> </td><td align="left">Select ECC </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__ecc__codes.html#ga15c79a12200c16f953936635f930df1d">ARM_NAND_ECC0</a> </td><td align="left">Use ECC0 of selected ECC </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__ecc__codes.html#gaee653288a88318ee33d1db81baa69bbc">ARM_NAND_ECC1</a> </td><td align="left">Use ECC1 of selected ECC </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__flag__codes.html#gaf40631ba62411e0ac06c3a945d608581">ARM_NAND_DRIVER_DONE_EVENT</a> </td><td align="left">Generate <a class="el" href="group__NAND__events.html#gac774a334871789d24107b843d1ebd00c">ARM_NAND_EVENT_DRIVER_DONE</a> </td></tr>
</table>
<p>The data item size is defined by the data type, which depends on the configured data bus width.</p>
<p>Data type is:</p>
<ul>
<li><em>uint8_t</em> for 8-bit data bus</li>
<li><em>uint16_t</em> for 16-bit data bus</li>
</ul>
<p>The function executes in the following ways:</p>
<ul>
<li>When the operation is blocking (typical for devices connected to memory bus when not using DMA), then the function returns after all data is written and returns the number of data items written.</li>
<li>When the operation is non-blocking (typical for NAND controllers), then the function only starts the operation and returns with zero number of data items written. After the operation is completed, the <a class="el" href="group__NAND__events.html#gac774a334871789d24107b843d1ebd00c">ARM_NAND_EVENT_DRIVER_DONE</a> event is generated (if enabled by <b>ARM_NAND_DRIVER_DONE_EVENT</b>). Progress of the operation can also be monitored by calling the <a class="el" href="group__nand__interface__gr.html#ga4578642f37a556b58b0bba0ad5d42641">ARM_NAND_GetStatus</a> function and checking the <em>busy</em> data field. Operation is automatically aborted if ECC is used and ECC generation fails, which generates the <a class="el" href="group__NAND__events.html#ga7bee0c32528ab991c0c064f895f80664">ARM_NAND_EVENT_ECC_ERROR</a> event (together with <a class="el" href="group__nand__driver__flag__codes.html#gaf40631ba62411e0ac06c3a945d608581">ARM_NAND_DRIVER_DONE_EVENT</a> if enabled). </li>
</ul>
</div>
</div>
<a class="anchor" id="ga8a0108dba757a4610475151144b52825"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_NAND_ExecuteSequence </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>dev_num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>cmd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>addr_col</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>addr_row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>data_cnt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>status</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t * </td>
<td class="paramname"><em>count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Execute sequence of operations. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev_num</td><td>Device number </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">code</td><td>Sequence code </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>Command(s) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">addr_col</td><td>Column address </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">addr_row</td><td>Row address </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">data</td><td>Pointer to data to be written or read </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data_cnt</td><td>Number of data items in one iteration </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">status</td><td>Pointer to status read </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">count</td><td>Number of iterations </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_NAND_ExecuteSequence</b> executes a sequence of operations for a NAND device.</p>
<p>The parameter <em>dev_num</em> is the device number. <br/>
The parameter <em>code</em> is the sequence encoding as defined in the table <b>Sequence execution Code</b>. <br/>
The parameter <em>cmd</em> is the command or a series of commands. <br/>
The parameter <em>addr_col</em> is the column address. <br/>
The parameter <em>addr_row</em> is the row address. <br/>
The parameter <em>data</em> is a pointer to the buffer that stores the data to or loads the data from. <br/>
The parameter <em>data_cnt</em> is the number of data items to read or write in one iteration. <br/>
The parameter <em>status</em> is a pointer to the buffer that stores the status read. <br/>
The parameter <em>count</em> is a pointer to the number of iterations. <br/>
<b>ARM_NAND_CODE_xxx</b> specifies sequence execution codes.</p>
<table class="doxtable">
<tr>
<th align="left">Sequence Execution Code </th><th align="left">Description </th></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__seq__exec__codes.html#gaef90c96cd4f2309044d7d438c6b0930a">ARM_NAND_CODE_SEND_CMD1</a> </td><td align="left">Send Command 1 (cmd[7..0]) </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga891bcba60ebb1195ec80c00c9bec748a">ARM_NAND_CODE_SEND_ADDR_COL1</a> </td><td align="left">Send Column Address 1 (addr_col[7..0]) </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga62a3f6ddcfb9ee317655bbec9e09bc10">ARM_NAND_CODE_SEND_ADDR_COL2</a> </td><td align="left">Send Column Address 2 (addr_col[15..8]) </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__seq__exec__codes.html#gadc001e69d1e81dc28a542237c6fe11ff">ARM_NAND_CODE_SEND_ADDR_ROW1</a> </td><td align="left">Send Row Address 1 (addr_row[7..0]) </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga5e55628cb59f5d7d35c529f04ebfcd10">ARM_NAND_CODE_SEND_ADDR_ROW2</a> </td><td align="left">Send Row Address 2 (addr_row[15..8]) </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__seq__exec__codes.html#gaeb5d1be9c13b7ad2ad246d5db10cd419">ARM_NAND_CODE_SEND_ADDR_ROW3</a> </td><td align="left">Send Row Address 3 (addr_row[23..16]) </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga959522c98183036da32984dd5e07979b">ARM_NAND_CODE_INC_ADDR_ROW</a> </td><td align="left">Auto-increment Row Address </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga1b40fc5fbf22dc4fa8130f5836e30d12">ARM_NAND_CODE_WRITE_DATA</a> </td><td align="left">Write Data </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__seq__exec__codes.html#gacffafbbbca74f7ffa4cd3bb6b067c4ef">ARM_NAND_CODE_SEND_CMD2</a> </td><td align="left">Send Command 2 (cmd[15..8]) </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga0f4a8b1e97656e09f1c383852f290a37">ARM_NAND_CODE_WAIT_BUSY</a> </td><td align="left">Wait while R/Bn busy </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__seq__exec__codes.html#gab524d840ab57c720ce8560144651dc9d">ARM_NAND_CODE_READ_DATA</a> </td><td align="left">Read Data </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga20f96743ab77bda14ba391dc0c3cdba5">ARM_NAND_CODE_SEND_CMD3</a> </td><td align="left">Send Command 3 (cmd[23..16]) </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga2250f6a532d2c0834bfdc618761ddc86">ARM_NAND_CODE_READ_STATUS</a> </td><td align="left">Read Status byte and check FAIL bit (bit 0) </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__ecc__codes.html#gac2eb4475f12a443209165d29fe200030">ARM_NAND_ECC(n)</a> </td><td align="left">Select ECC </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__ecc__codes.html#ga15c79a12200c16f953936635f930df1d">ARM_NAND_ECC0</a> </td><td align="left">Use ECC0 of selected ECC </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__ecc__codes.html#gaee653288a88318ee33d1db81baa69bbc">ARM_NAND_ECC1</a> </td><td align="left">Use ECC1 of selected ECC </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__driver__flag__codes.html#gaf40631ba62411e0ac06c3a945d608581">ARM_NAND_DRIVER_DONE_EVENT</a> </td><td align="left">Generate <a class="el" href="group__NAND__events.html#gac774a334871789d24107b843d1ebd00c">ARM_NAND_EVENT_DRIVER_DONE</a> </td></tr>
</table>
<p>The data item size is defined by the data type, which depends on the configured data bus width.</p>
<p>Data type is:</p>
<ul>
<li><em>uint8_t</em> for 8-bit data bus</li>
<li><em>uint16_t</em> for 16-bit data bus</li>
</ul>
<p>The function is non-blocking and returns as soon as the driver has started executing the specified sequence. When the operation is completed, the <a class="el" href="group__NAND__events.html#gac774a334871789d24107b843d1ebd00c">ARM_NAND_EVENT_DRIVER_DONE</a> event is generated (if enabled by <b>ARM_NAND_DRIVER_DONE_EVENT</b>). Progress of the operation can also be monitored by calling the <a class="el" href="group__nand__interface__gr.html#ga4578642f37a556b58b0bba0ad5d42641">ARM_NAND_GetStatus</a> function and checking the <em>busy</em> data field.</p>
<p>Driver executes the number of specified iterations where in each iteration items specified by <b>ARM_NAND_CODE_xxx</b> are executed in the order as listed in the table <b>Sequence execution Code</b>. The parameter <em>count</em> is holding the current number of iterations left.</p>
<p>Execution is automatically aborted and <a class="el" href="group__NAND__events.html#gac774a334871789d24107b843d1ebd00c">ARM_NAND_EVENT_DRIVER_DONE</a> event is generated (if enabled by <b>ARM_NAND_DRIVER_DONE_EVENT</b>):</p>
<ul>
<li>if Read Status is enabled and the FAIL bit (bit 0) is set</li>
<li>if ECC is used and ECC fails (also sets <a class="el" href="group__NAND__events.html#ga7bee0c32528ab991c0c064f895f80664">ARM_NAND_EVENT_ECC_ERROR</a> event)</li>
</ul>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="group__nand__driver__seq__exec__codes.html#ga0f4a8b1e97656e09f1c383852f290a37">ARM_NAND_CODE_WAIT_BUSY</a> can only be specified if the Device Ready event can be generated (reported by <em>event_device_ready</em> in <a class="el" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a>). The event <a class="el" href="group__NAND__events.html#gae0be7e1b41188def905de0a1568d442d">ARM_NAND_EVENT_DEVICE_READY</a> is not generated during sequence execution but rather used internally by the driver. </dd></dl>
</div>
</div>
<a class="anchor" id="ga00832861f018db0d8368900b099ecd30"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_NAND_AbortSequence </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>dev_num</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Abort sequence execution. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev_num</td><td>Device number </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_NAND_AbortSequence</b> aborts execution of the current sequence for a NAND device.</p>
<p>The parameter <em>dev_num</em> is the device number. </p>
</div>
</div>
<a class="anchor" id="ga83061d6d53ffb148853efbc87a864607"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_NAND_Control </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>dev_num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>control</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control NAND Interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev_num</td><td>Device number </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">control</td><td>Operation </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">arg</td><td>Argument of operation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_NAND_Control</b> controls the NAND interface and executes operations.</p>
<p>The parameter <em>dev_num</em> is the device number. <br/>
The parameter <em>control</em> specifies the operation. <br/>
The parameter <em>arg</em> provides (depending on the <em>control</em>) additional information or sets values.</p>
<p>The table lists the operations for the parameter <em>control</em>.</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>control</em> </th><th align="left">Operation </th></tr>
<tr>
<td align="left"><a class="el" href="group__nand__control__codes.html#ga9b063c3078e86b50d4aa892518b2e2d8">ARM_NAND_BUS_MODE</a> </td><td align="left">Set the bus mode. The parameter <em>arg</em> sets the <a class="el" href="group__nand__interface__gr.html#bus_mode_tab"><b>Bus</b> Mode</a>. </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__control__codes.html#ga2d3356f5b47871c465ae7136a2c533f4">ARM_NAND_BUS_DATA_WIDTH</a> </td><td align="left">Set the data bus width. The parameter <em>arg</em> sets the <a class="el" href="group__nand__interface__gr.html#bus_data_width_tab"><b>Bus</b> Data Width</a>. </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__control__codes.html#ga5d1d46198404fe115b013bdae7af2a2f">ARM_NAND_DRIVER_STRENGTH</a> </td><td align="left">Set the driver strength. The parameter <em>arg</em> sets the <a class="el" href="group__nand__interface__gr.html#driver_strength_tab"><b>Driver</b> Strength</a>. </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__control__codes.html#gaab6dea1b565aeb53e360876a4e50783c">ARM_NAND_DRIVER_READY_EVENT</a> </td><td align="left">Control generation of callback event <a class="el" href="group__NAND__events.html#ga7b390a906db42c5ea4db38e0e85bb9e9">ARM_NAND_EVENT_DRIVER_READY</a>. Enable: <em>arg</em> = <span class="XML-Token">1</span>. Disable: <em>arg</em> = <span class="XML-Token">0</span>. </td></tr>
<tr>
<td align="left"><a class="el" href="group__nand__control__codes.html#ga1bffc9f341e704ee0e845d86a2989921">ARM_NAND_DEVICE_READY_EVENT</a> </td><td align="left">Control generation of callback event <a class="el" href="group__NAND__events.html#gae0be7e1b41188def905de0a1568d442d">ARM_NAND_EVENT_DEVICE_READY</a>; Enable: <em>arg</em> = <span class="XML-Token">1</span>. Disable: <em>arg</em> = <span class="XML-Token">0</span>. </td></tr>
</table>
<p><b>See Also</b></p>
<ul>
<li><a class="el" href="group__nand__interface__gr.html#ga9f2609975c2008d21b9ae28f15daf147">ARM_NAND_GetCapabilities</a> returns information about supported operations, which are stored in the structure <a class="el" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a>.</li>
<li><a class="el" href="group__nand__interface__gr.html#gaf4ce80b0fd6717de7ddfb1cfaf7dd754">ARM_NAND_SignalEvent</a> provides information about the callback events <a class="el" href="group__NAND__events.html#ga7b390a906db42c5ea4db38e0e85bb9e9">ARM_NAND_EVENT_DRIVER_READY</a> and <a class="el" href="group__NAND__events.html#gae0be7e1b41188def905de0a1568d442d">ARM_NAND_EVENT_DEVICE_READY</a></li>
</ul>
<p>The table lists values for the parameter <em>arg</em> used with the <em>control</em> operation <a class="el" href="group__nand__control__codes.html#ga9b063c3078e86b50d4aa892518b2e2d8">ARM_NAND_BUS_MODE</a>, <a class="el" href="group__nand__control__codes.html#ga2d3356f5b47871c465ae7136a2c533f4">ARM_NAND_BUS_DATA_WIDTH</a>, and <a class="el" href="group__nand__control__codes.html#ga5d1d46198404fe115b013bdae7af2a2f">ARM_NAND_DRIVER_STRENGTH</a>. Values from different categories can be ORed.</p>
<p><a class="anchor" id="bus_mode_tab"></a></p>
<table class="cmtable">
<tr>
<th>Parameter <em>arg</em> <br/>
for <em>control</em> = <a class="el" href="group__nand__control__codes.html#ga9b063c3078e86b50d4aa892518b2e2d8">ARM_NAND_BUS_MODE</a> </th><th>Bit </th><th>Category </th><th>Description </th><th width="30%">Supported when <a class="el" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a> </th></tr>
<tr>
<td><a class="el" href="group__nand__bus__mode__codes.html#ga971e574ac412bbba445055e9afc384ba">ARM_NAND_BUS_TIMING_MODE_0</a> (default) </td><td rowspan="8" style="text-align:right">0..3 </td><td rowspan="8"><a class="anchor" id="bus_timing_tab"></a> Bus Timing Mode </td><td><span class="XML-Token">0</span> </td><td rowspan="8">The maximum timing mode that can be applied to a specific <a class="el" href="group__nand__interface__gr.html#bus_data_interface_tab"><b>Bus</b> Data Interface</a> is stored in the data fields: <br/>
<br/>
<em>sdr_timing_mode</em> - for SDR <br/>
<em>ddr_timing_mode</em> - for NV-DDR <br/>
<em>ddr2_timing_mode</em> - for NV_DDR2 </td></tr>
<tr>
<td><a class="el" href="group__nand__bus__mode__codes.html#ga475a339e929eca46e11bc8a7b330aa45">ARM_NAND_BUS_TIMING_MODE_1</a> </td><td><span class="XML-Token">1</span> </td></tr>
<tr>
<td><a class="el" href="group__nand__bus__mode__codes.html#gaed6154fb03b5516faf0bfd11d7a46309">ARM_NAND_BUS_TIMING_MODE_2</a> </td><td><span class="XML-Token">2</span> </td></tr>
<tr>
<td><a class="el" href="group__nand__bus__mode__codes.html#gacbc4e07e1af6ef0e4c656428e81464a9">ARM_NAND_BUS_TIMING_MODE_3</a> </td><td><span class="XML-Token">3</span> </td></tr>
<tr>
<td><a class="el" href="group__nand__bus__mode__codes.html#ga709d51a5215cd23ce2d85aec57141456">ARM_NAND_BUS_TIMING_MODE_4</a> </td><td><span class="XML-Token">4</span> (SDR EDO capable) </td></tr>
<tr>
<td><a class="el" href="group__nand__bus__mode__codes.html#gaee3cad14ce2b8b9af69149bf74597791">ARM_NAND_BUS_TIMING_MODE_5</a> </td><td><span class="XML-Token">5</span> (SDR EDO capable) </td></tr>
<tr>
<td><a class="el" href="group__nand__bus__mode__codes.html#ga4a3524e0eba994b3a66e06cde877f0f6">ARM_NAND_BUS_TIMING_MODE_6</a> </td><td><span class="XML-Token">6</span> (NV-DDR2 only) </td></tr>
<tr>
<td><a class="el" href="group__nand__bus__mode__codes.html#gaa63d75f5f2b48a7345a066d58de1bd23">ARM_NAND_BUS_TIMING_MODE_7</a> </td><td><span class="XML-Token">7</span> (NV-DDR2 only) </td></tr>
<tr>
<td><a class="el" href="group__nand__bus__mode__codes.html#gac7743aeb6411b97f9fc6a24b556f4963">ARM_NAND_BUS_SDR</a> (default)<a class="anchor" id="bus_data_interface_tab"></a> </td><td rowspan="3" style="text-align:right">4..7 </td><td rowspan="3">Bus Data Interface </td><td>SDR (Single Data Rate) - Traditional interface </td><td><em>always supported</em> </td></tr>
<tr>
<td><a class="el" href="group__nand__bus__mode__codes.html#ga82b8261b3d0d85881535adada318a7df">ARM_NAND_BUS_DDR</a> </td><td>NV-DDR (Double Data Rate) </td><td>data field <em>ddr</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td><a class="el" href="group__nand__bus__mode__codes.html#ga13c102201d6021db184a2f068656c518">ARM_NAND_BUS_DDR2</a> </td><td>NV-DDR2 (Double Data Rate) </td><td>data field <em>ddr2</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td style="white-space: nowrap"><a class="el" href="group__nand__bus__mode__codes.html#ga77348df5f5c2c96bcaeec60b6da02c1b">ARM_NAND_BUS_DDR2_DO_WCYC_0</a> (default) </td><td rowspan="4" style="text-align:right">8..11 </td><td rowspan="4" style="white-space: nowrap">Data Output Warm-up<a class="anchor" id="bus_output_tab"></a> </td><td>Set the DDR2 Data Output Warm-up to <span class="XML-Token">0</span> cycles </td><td rowspan="4"><b>Data Output Warm-up</b> cycles are dummy cycles for interface calibration with no incremental data transfer and apply to NV-DDR2 of the <a class="el" href="group__nand__interface__gr.html#bus_data_interface_tab"><b>Bus</b> Data Interface</a>. </td></tr>
<tr>
<td><a class="el" href="group__nand__bus__mode__codes.html#ga5839be0b4b2eb930ec039a3403b5e89e">ARM_NAND_BUS_DDR2_DO_WCYC_1</a> </td><td>Set the DDR2 Data Output Warm-up to <span class="XML-Token">1</span> cycles </td></tr>
<tr>
<td><a class="el" href="group__nand__bus__mode__codes.html#ga10a1ef3be69bfa7e6cc657bee751a077">ARM_NAND_BUS_DDR2_DO_WCYC_2</a> </td><td>Set the DDR2 Data Output Warm-up to <span class="XML-Token">2</span> cycles </td></tr>
<tr>
<td><a class="el" href="group__nand__bus__mode__codes.html#ga7f9e8416c4a4e20c4a04323e39f2100d">ARM_NAND_BUS_DDR2_DO_WCYC_4</a> </td><td>Set the DDR2 Data Output Warm-up to <span class="XML-Token">4</span> cycles </td></tr>
<tr>
<td style="white-space: nowrap"><a class="el" href="group__nand__bus__mode__codes.html#gaeee1853dea5e96cb19d2596cc0e70169">ARM_NAND_BUS_DDR2_DI_WCYC_0</a> (default)<a class="anchor" id="bus_input_tab"></a> </td><td rowspan="4" style="text-align:right">12..15 </td><td rowspan="4" style="white-space: nowrap">Data Input Warm-up </td><td>Set the DDR2 Data Input Warm-up to <span class="XML-Token">0</span> cycles </td><td rowspan="4"><b>Data Input Warm-up</b> cycles are dummy cycles for interface calibration with no incremental data transfer and apply to NV-DDR2 of the <a class="el" href="group__nand__interface__gr.html#bus_data_interface_tab"><b>Bus</b> Data Interface</a>. </td></tr>
<tr>
<td><a class="el" href="group__nand__bus__mode__codes.html#ga42560a1f046e20cc4956276156c4ce25">ARM_NAND_BUS_DDR2_DI_WCYC_1</a> </td><td>Set the DDR2 Data Input Warm-up to <span class="XML-Token">1</span> cycles </td></tr>
<tr>
<td><a class="el" href="group__nand__bus__mode__codes.html#gaad2e7807292d84a5070143626f5c2756">ARM_NAND_BUS_DDR2_DI_WCYC_2</a> </td><td>Set the DDR2 Data Input Warm-up to <span class="XML-Token">2</span> cycles </td></tr>
<tr>
<td><a class="el" href="group__nand__bus__mode__codes.html#ga3ebb54a1ae971cd34f3c8fc9ff3ab6d5">ARM_NAND_BUS_DDR2_DI_WCYC_4</a> </td><td>Set the DDR2 Data Input Warm-up to <span class="XML-Token">4</span> cycles </td></tr>
<tr>
<td style="white-space: nowrap"><a class="el" href="group__nand__bus__mode__codes.html#ga465ae06a6e097959620346304182e273">ARM_NAND_BUS_DDR2_VEN</a><a class="anchor" id="bus_misc_tab"></a> </td><td style="text-align:right">16 </td><td rowspan="3" style="white-space: nowrap">Miscellaneous </td><td>Set the DDR2 Enable external VREFQ as reference </td><td rowspan="3">  </td></tr>
<tr>
<td><a class="el" href="group__nand__bus__mode__codes.html#gad38354e4a34adbf881afc7f89ff06e89">ARM_NAND_BUS_DDR2_CMPD</a> </td><td style="text-align:right">17 </td><td>Set the DDR2 Enable complementary DQS (DQS_c) signal </td></tr>
<tr>
<td><a class="el" href="group__nand__bus__mode__codes.html#ga8a2d599082b9fe56cee1c6454bb3c6a1">ARM_NAND_BUS_DDR2_CMPR</a> </td><td style="text-align:right">18 </td><td>Set the DDR2 Enable complementary RE_n (RE_c) signal </td></tr>
<tr>
<th>Parameter <em>arg</em> <br/>
for <em>control</em> = <a class="el" href="group__nand__control__codes.html#ga2d3356f5b47871c465ae7136a2c533f4">ARM_NAND_BUS_DATA_WIDTH</a> </th><th>Bit </th><th>Category<a class="anchor" id="bus_data_width_tab"></a> </th><th>Description </th><th width="30%">Supported when <a class="el" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a> </th></tr>
<tr>
<td style="white-space: nowrap"><a class="el" href="group__nand__data__bus__width__codes.html#ga578051cc193ae0b7125aec8007071d21">ARM_NAND_BUS_DATA_WIDTH_8</a> (default) </td><td rowspan="2" style="text-align:right">0..1 </td><td rowspan="2" style="white-space: nowrap">Bus Data Width </td><td>Set to <span class="XML-Token">8 bit</span> </td><td><em>always supported</em> </td></tr>
<tr>
<td><a class="el" href="group__nand__data__bus__width__codes.html#ga49e0e3a946a4d9f26dbd5b32ccc3b2f3">ARM_NAND_BUS_DATA_WIDTH_16</a> </td><td>Set to <span class="XML-Token">16 bit</span> </td><td>data field <em>data_width_16</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<th style="white-space: nowrap">Parameter <em>arg</em> <br/>
for <em>control</em> = <a class="el" href="group__nand__control__codes.html#ga5d1d46198404fe115b013bdae7af2a2f">ARM_NAND_DRIVER_STRENGTH</a> </th><th>Bit </th><th>Category<a class="anchor" id="driver_strength_tab"></a> </th><th>Description </th><th width="30%">Supported when <a class="el" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a> </th></tr>
<tr>
<td style="white-space: nowrap"><a class="el" href="group__nand__driver__strength__codes.html#ga942e20df12022f3bbd0e9a558ec1c7a0">ARM_NAND_DRIVER_STRENGTH_18</a> </td><td rowspan="4" style="text-align:right">0..3 </td><td rowspan="4" style="white-space: nowrap">Driver Strength </td><td>Set the Driver Strength 2.0x = 18 Ohms </td><td>data field <em>driver_strength_18</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td><a class="el" href="group__nand__driver__strength__codes.html#ga17188e039f5f87c581033327399a057d">ARM_NAND_DRIVER_STRENGTH_25</a> </td><td>Set the Driver Strength 1.4x = 25 Ohms </td><td>data field <em>driver_strength_25</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td><a class="el" href="group__nand__driver__strength__codes.html#ga33562a66a5bf328eea82b2f1893a7874">ARM_NAND_DRIVER_STRENGTH_35</a> (default) </td><td>Set the Driver Strength 1.0x = 35 Ohms </td><td><em>always supported</em> </td></tr>
<tr>
<td><a class="el" href="group__nand__driver__strength__codes.html#gaa502e2c995447037d266f939faa43223">ARM_NAND_DRIVER_STRENGTH_50</a> </td><td>Set the Driver Strength 0.7x = 50 Ohms </td><td>data field <em>driver_strength_50</em> = <span class="XML-Token">1</span> </td></tr>
</table>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__nand__interface__gr.html#structARM__DRIVER__NAND">ARM_DRIVER_NAND</a> Driver_NAND0;</div>
<div class="line"> </div>
<div class="line">status = Driver_NAND0.<a class="code" href="group__nand__interface__gr.html#a706fedbc88921808e210d75b7b5da168">Control</a> (0, <a class="code" href="group__nand__control__codes.html#ga9b063c3078e86b50d4aa892518b2e2d8">ARM_NAND_BUS_MODE</a>, <a class="code" href="group__nand__bus__mode__codes.html#gaee3cad14ce2b8b9af69149bf74597791">ARM_NAND_BUS_TIMING_MODE_5</a> | </div>
<div class="line"> <a class="code" href="group__nand__bus__mode__codes.html#ga13c102201d6021db184a2f068656c518">ARM_NAND_BUS_DDR2</a> | </div>
<div class="line"> <a class="code" href="group__nand__bus__mode__codes.html#ga465ae06a6e097959620346304182e273">ARM_NAND_BUS_DDR2_VEN</a>);</div>
<div class="line"> </div>
<div class="line">status = Driver_NAND0.<a class="code" href="group__nand__interface__gr.html#a706fedbc88921808e210d75b7b5da168">Control</a> (0, <a class="code" href="group__nand__control__codes.html#ga2d3356f5b47871c465ae7136a2c533f4">ARM_NAND_BUS_DATA_WIDTH</a>, <a class="code" href="group__nand__data__bus__width__codes.html#ga49e0e3a946a4d9f26dbd5b32ccc3b2f3">ARM_NAND_BUS_DATA_WIDTH_16</a>); </div>
<div class="line"> </div>
<div class="line">status = Driver_NAND0.<a class="code" href="group__nand__interface__gr.html#a706fedbc88921808e210d75b7b5da168">Control</a> (0, <a class="code" href="group__nand__control__codes.html#ga5d1d46198404fe115b013bdae7af2a2f">ARM_NAND_DRIVER_STRENGTH</a>, <a class="code" href="group__nand__driver__strength__codes.html#gaa502e2c995447037d266f939faa43223">ARM_NAND_DRIVER_STRENGTH_50</a>);</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga4578642f37a556b58b0bba0ad5d42641"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__nand__interface__gr.html#structARM__NAND__STATUS">ARM_NAND_STATUS</a> ARM_NAND_GetStatus </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>dev_num</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get NAND status. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev_num</td><td>Device number </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NAND status <a class="el" href="group__nand__interface__gr.html#structARM__NAND__STATUS">ARM_NAND_STATUS</a></dd></dl>
<p>The function <b>ARM_NAND_GetStatus</b> returns the current NAND device status.</p>
<p>The parameter <em>dev_num</em> is the device number. </p>
</div>
</div>
<a class="anchor" id="gac21425454d586ef48fdfc35e7bd78947"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_NAND_InquireECC </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__nand__interface__gr.html#structARM__NAND__ECC__INFO">ARM_NAND_ECC_INFO</a> * </td>
<td class="paramname"><em>info</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Inquire about available ECC. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Inquire ECC index </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">info</td><td>Pointer to ECC information <a class="el" href="group__nand__interface__gr.html#structARM__NAND__ECC__INFO">ARM_NAND_ECC_INFO</a> retrieved </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_NAND_InquireECC</b> reads error correction code information.</p>
<p>The parameter <em>index</em> is the ECC index and is used to retrieve different ECC configurations. <br/>
The parameter <em>info</em> is a pointer of type <a class="el" href="group__nand__interface__gr.html#structARM__NAND__ECC__INFO">ARM_NAND_ECC_INFO</a>. The data fields store the information.</p>
<p>When multiple different ECC configurations exist, <a class="el" href="group__nand__interface__gr.html#structARM__NAND__ECC__INFO" title="NAND ECC (Error Correction Code) Information. ">ARM_NAND_ECC_INFO</a> structure exists for each configuration. Parameter <em>index</em> denotes which configuration will be retrieved. Value of index should start with zero to retrieve first ECC configuration and should be incremented in order to retrieve next ECC configuration. When index is out of range function ARM_NAND_InquireECC returns with error.</p>
<p>Parameter <em>index</em> is used by <a class="el" href="group__nand__driver__ecc__codes.html#gac2eb4475f12a443209165d29fe200030">ARM_NAND_ECC(n)</a> in <a class="el" href="group__nand__interface__gr.html#gae1899a20ef107400c8bf84fad477a8ce">ARM_NAND_ReadData</a>, <a class="el" href="group__nand__interface__gr.html#ga1fa497dd51a86fc308e946b4419fd006">ARM_NAND_WriteData</a> and <a class="el" href="group__nand__interface__gr.html#ga8a0108dba757a4610475151144b52825">ARM_NAND_ExecuteSequence</a> to select suitable ECC configuration.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__nand__interface__gr.html#structARM__DRIVER__NAND">ARM_DRIVER_NAND</a> Driver_NAND0; </div>
<div class="line"></div>
<div class="line"><a class="code" href="group__nand__interface__gr.html#structARM__NAND__ECC__INFO">ARM_NAND_ECC_INFO</a> ecc;</div>
<div class="line">int32_t idx;</div>
<div class="line"> </div>
<div class="line">idx = 0;</div>
<div class="line"><span class="keywordflow">while</span> (Driver_NAND0.<a class="code" href="group__nand__interface__gr.html#aecd239806e9f08b77ce0d00f61e78cf8">InquireECC</a> (idx, &ecc) == <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
<div class="line"> <span class="comment">// Examine retrieved ECC configuration</span></div>
<div class="line"> <span class="keywordflow">if</span> (ecc.<a class="code" href="group__nand__interface__gr.html#ad44b615021ed3ccb734fcaf583ef4a03">type</a> == 2) {</div>
<div class="line"> <span class="comment">// Algorithm ECC0 protects Main+Spare</span></div>
<div class="line"> }</div>
<div class="line"> <span class="comment">// ..</span></div>
<div class="line"> idx++;</div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="gaf4ce80b0fd6717de7ddfb1cfaf7dd754"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARM_NAND_SignalEvent </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>dev_num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>event</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signal NAND event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev_num</td><td>Device number </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td>Event notification mask </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<p>The function <b>ARM_NAND_SignalEvent</b> is a callback function registered by the function <a class="el" href="group__nand__interface__gr.html#ga74ad34718a595e7a4375b90f33e72750">ARM_NAND_Initialize</a>.</p>
<p>The parameter <em>dev_num</em> is the device number. <br/>
The parameter <em>event</em> indicates one or more events that occurred during driver operation. Each event is encoded in a separate bit and therefore it is possible to signal multiple events within the same call.</p>
<p>Not every event is necessarily generated by the driver. This depends on the implemented capabilities stored in the data fields of the structure <a class="el" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a>, which can be retrieved with the function <a class="el" href="group__nand__interface__gr.html#ga9f2609975c2008d21b9ae28f15daf147">ARM_NAND_GetCapabilities</a>.</p>
<p>The following events can be generated:</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>event</em> </th><th>Bit </th><th align="left">Description </th></tr>
<tr>
<td align="left"><a class="el" href="group__NAND__events.html#gae0be7e1b41188def905de0a1568d442d">ARM_NAND_EVENT_DEVICE_READY</a> </td><td>0 </td><td align="left">Occurs when rising edge is detected on R/Bn (Ready/Busy) pin indicating that the device is ready. </td></tr>
<tr>
<td align="left"><a class="el" href="group__NAND__events.html#ga7b390a906db42c5ea4db38e0e85bb9e9">ARM_NAND_EVENT_DRIVER_READY</a> </td><td>1 </td><td align="left">Occurs to indicate that commands can be executed (after previously being busy and not able to start the requested operation). </td></tr>
<tr>
<td align="left"><a class="el" href="group__NAND__events.html#gac774a334871789d24107b843d1ebd00c">ARM_NAND_EVENT_DRIVER_DONE</a> </td><td>2 </td><td align="left">Occurs after an operation completes. An operation was successfully started before with <a class="el" href="group__nand__interface__gr.html#gae1899a20ef107400c8bf84fad477a8ce">ARM_NAND_ReadData</a>, <a class="el" href="group__nand__interface__gr.html#ga1fa497dd51a86fc308e946b4419fd006">ARM_NAND_WriteData</a>, <a class="el" href="group__nand__interface__gr.html#ga8a0108dba757a4610475151144b52825">ARM_NAND_ExecuteSequence</a>. </td></tr>
<tr>
<td align="left"><a class="el" href="group__NAND__events.html#ga7bee0c32528ab991c0c064f895f80664">ARM_NAND_EVENT_ECC_ERROR</a> </td><td>3 </td><td align="left">Occurs when ECC generation failed or ECC correction failed. An operation was successfully started before with <a class="el" href="group__nand__interface__gr.html#gae1899a20ef107400c8bf84fad477a8ce">ARM_NAND_ReadData</a>, <a class="el" href="group__nand__interface__gr.html#ga1fa497dd51a86fc308e946b4419fd006">ARM_NAND_WriteData</a>, <a class="el" href="group__nand__interface__gr.html#ga8a0108dba757a4610475151144b52825">ARM_NAND_ExecuteSequence</a>. </td></tr>
</table>
<p>The event <a class="el" href="group__NAND__events.html#gae0be7e1b41188def905de0a1568d442d">ARM_NAND_EVENT_DEVICE_READY</a> occurs after complete execution of commands (initiated with the functions <a class="el" href="group__nand__interface__gr.html#ga9f70b89ba478eadfe7f5dee7453a4fb7">ARM_NAND_SendCommand</a>, <a class="el" href="group__nand__interface__gr.html#ga00e195031e03d364db7595858a7e76f3">ARM_NAND_SendAddress</a>, <a class="el" href="group__nand__interface__gr.html#gae1899a20ef107400c8bf84fad477a8ce">ARM_NAND_ReadData</a>, <a class="el" href="group__nand__interface__gr.html#ga1fa497dd51a86fc308e946b4419fd006">ARM_NAND_WriteData</a>, <a class="el" href="group__nand__interface__gr.html#ga8a0108dba757a4610475151144b52825">ARM_NAND_ExecuteSequence</a>). It is useful to indicate completion of complex operations (such as erase). The event is only generated when <a class="el" href="group__nand__interface__gr.html#ga9f2609975c2008d21b9ae28f15daf147">ARM_NAND_GetCapabilities</a> returns data field <em>event_device_ready</em> = <span class="XML-Token">1</span> and was enabled by calling <a class="el" href="group__nand__interface__gr.html#ga83061d6d53ffb148853efbc87a864607">ARM_NAND_Control</a> (<a class="el" href="group__nand__control__codes.html#ga1bffc9f341e704ee0e845d86a2989921">ARM_NAND_DEVICE_READY_EVENT</a>, 1). If the event is not available, poll the <em>busy</em> data field using the function <a class="el" href="group__nand__interface__gr.html#ga4578642f37a556b58b0bba0ad5d42641">ARM_NAND_GetStatus</a>.</p>
<p>The event <a class="el" href="group__NAND__events.html#ga7b390a906db42c5ea4db38e0e85bb9e9">ARM_NAND_EVENT_DRIVER_READY</a> occurs when previously a function (<a class="el" href="group__nand__interface__gr.html#ga9f70b89ba478eadfe7f5dee7453a4fb7">ARM_NAND_SendCommand</a>, <a class="el" href="group__nand__interface__gr.html#ga00e195031e03d364db7595858a7e76f3">ARM_NAND_SendAddress</a>, <a class="el" href="group__nand__interface__gr.html#gae1899a20ef107400c8bf84fad477a8ce">ARM_NAND_ReadData</a>, <a class="el" href="group__nand__interface__gr.html#ga1fa497dd51a86fc308e946b4419fd006">ARM_NAND_WriteData</a>, <a class="el" href="group__nand__interface__gr.html#ga8a0108dba757a4610475151144b52825">ARM_NAND_ExecuteSequence</a>) returned with <a class="el" href="group__execution__status.html#ga13c1123319c7b9a4735d63447f35116b">ARM_DRIVER_ERROR_BUSY</a>. It is useful when functions are called simultaneously from independent threads (for example to control multiple devices) and the threads have no knowledge about each other (driver rejects reentrant calls with return of <a class="el" href="group__execution__status.html#ga13c1123319c7b9a4735d63447f35116b">ARM_DRIVER_ERROR_BUSY</a>). <em>dev_num</em> indicates the device that returned previously busy. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__interface__gr.html | HTML | apache-2.0 | 156,130 |
var group__nand__interface__gr =
[
[ "Status Error Codes", "group__nand__execution__status.html", "group__nand__execution__status" ],
[ "NAND Events", "group__NAND__events.html", "group__NAND__events" ],
[ "NAND Flags", "group__nand__driver__flag__codes.html", "group__nand__driver__flag__codes" ],
[ "NAND Control Codes", "group__nand__control__gr.html", "group__nand__control__gr" ],
[ "NAND ECC Codes", "group__nand__driver__ecc__codes.html", "group__nand__driver__ecc__codes" ],
[ "NAND Sequence Execution Codes", "group__nand__driver__seq__exec__codes.html", "group__nand__driver__seq__exec__codes" ],
[ "ARM_NAND_STATUS", "group__nand__interface__gr.html#structARM__NAND__STATUS", [
[ "busy", "group__nand__interface__gr.html#a50c88f3c1d787773e2ac1b59533f034a", null ],
[ "ecc_error", "group__nand__interface__gr.html#a7707d2200a3bf8f49b148ffc8ded7636", null ],
[ "reserved", "group__nand__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_DRIVER_NAND", "group__nand__interface__gr.html#structARM__DRIVER__NAND", [
[ "GetVersion", "group__nand__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__nand__interface__gr.html#adab9d081aee3e5d1f83c6911e45ceaa6", null ],
[ "Initialize", "group__nand__interface__gr.html#a28b29ab7b6114bb97175bd40d18854ac", null ],
[ "Uninitialize", "group__nand__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__nand__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "DevicePower", "group__nand__interface__gr.html#a9ba6f3066cda5c8d781c309a17315a58", null ],
[ "WriteProtect", "group__nand__interface__gr.html#add6fa19a729c42303581214bc9dec819", null ],
[ "ChipEnable", "group__nand__interface__gr.html#ac090c205fe3d1b3dcb7288b06468bbe5", null ],
[ "GetDeviceBusy", "group__nand__interface__gr.html#ac9bc93fb1a089c6ac71428122f3a072e", null ],
[ "SendCommand", "group__nand__interface__gr.html#a3dbd36d86718980665ce2e3a1ba672ca", null ],
[ "SendAddress", "group__nand__interface__gr.html#a5a43001ef1ca6c6d73f03e366bf41cb5", null ],
[ "ReadData", "group__nand__interface__gr.html#aeba263544c0d63ec8c29e919232615cb", null ],
[ "WriteData", "group__nand__interface__gr.html#a78393d355e539c6f845b33417da60a7e", null ],
[ "ExecuteSequence", "group__nand__interface__gr.html#af0dd5e96fbcc5c15bb183363f8541af8", null ],
[ "AbortSequence", "group__nand__interface__gr.html#ad6e1d53e9028baff856899f795c0d0c8", null ],
[ "Control", "group__nand__interface__gr.html#a706fedbc88921808e210d75b7b5da168", null ],
[ "GetStatus", "group__nand__interface__gr.html#aa43ee108ee5bf29e40485ca89b34188b", null ],
[ "InquireECC", "group__nand__interface__gr.html#aecd239806e9f08b77ce0d00f61e78cf8", null ]
] ],
[ "ARM_NAND_CAPABILITIES", "group__nand__interface__gr.html#structARM__NAND__CAPABILITIES", [
[ "event_device_ready", "group__nand__interface__gr.html#a5f347e9b63764bbb657f52dc20682128", null ],
[ "reentrant_operation", "group__nand__interface__gr.html#ae0514834750c7452431717a881471e2b", null ],
[ "sequence_operation", "group__nand__interface__gr.html#afa4b798731b1154878c26dda3f090acf", null ],
[ "vcc", "group__nand__interface__gr.html#a35cfa22b2140b109fe24b97c42d5a5ed", null ],
[ "vcc_1v8", "group__nand__interface__gr.html#a0e7d3b9258d468492b22de55d855a06e", null ],
[ "vccq", "group__nand__interface__gr.html#ab1cdfce6eb051bed7b904e0fd1719afa", null ],
[ "vccq_1v8", "group__nand__interface__gr.html#a1896a7548bb6fab285f23cc0d0b23d7d", null ],
[ "vpp", "group__nand__interface__gr.html#a75b97f7c917bba90b2f5c747d6857d23", null ],
[ "wp", "group__nand__interface__gr.html#afe7f5b149b8d92859398315b1ad31ddc", null ],
[ "ce_lines", "group__nand__interface__gr.html#ad5dd0fcdd7f6d5e5cd739f73323a2b11", null ],
[ "ce_manual", "group__nand__interface__gr.html#a2b8044d986995b183b057217643466bf", null ],
[ "rb_monitor", "group__nand__interface__gr.html#a69f5e734ee4a9bb501718cf78a740c3e", null ],
[ "data_width_16", "group__nand__interface__gr.html#a0f22baea13daa9101bf6fc1fdfddc747", null ],
[ "ddr", "group__nand__interface__gr.html#aa9acfde38637fe749aa9271c0a8dae1a", null ],
[ "ddr2", "group__nand__interface__gr.html#ae086693990cbd5d628014c0fcc7c1f2c", null ],
[ "sdr_timing_mode", "group__nand__interface__gr.html#a21036f2047273d90c0af0e97031df5a9", null ],
[ "ddr_timing_mode", "group__nand__interface__gr.html#a00c1f5db7d7c4abe7556733c36da7783", null ],
[ "ddr2_timing_mode", "group__nand__interface__gr.html#a6d9b66da0e56d04d545e0bb6841891b2", null ],
[ "driver_strength_18", "group__nand__interface__gr.html#ae672b2a65dd3d0b93812c088491c4552", null ],
[ "driver_strength_25", "group__nand__interface__gr.html#ae87c19872b838dac7d3136a3fd466f6a", null ],
[ "driver_strength_50", "group__nand__interface__gr.html#aef3d6e1522a6cf7fb87fd113dcd43ad5", null ],
[ "reserved", "group__nand__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_NAND_ECC_INFO", "group__nand__interface__gr.html#structARM__NAND__ECC__INFO", [
[ "type", "group__nand__interface__gr.html#ad44b615021ed3ccb734fcaf583ef4a03", null ],
[ "page_layout", "group__nand__interface__gr.html#a5952ba4313bda7833fefd358f5aff979", null ],
[ "page_count", "group__nand__interface__gr.html#aa993bc236650aa405b01d00b7ca72904", null ],
[ "page_size", "group__nand__interface__gr.html#a9dd3e47e968a8f6beb5d88c6d1b7ebe9", null ],
[ "reserved", "group__nand__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ],
[ "correctable_bits", "group__nand__interface__gr.html#ae65f920c4ad99fd0c6bdf5fd8c4d161a", null ],
[ "codeword_size", "group__nand__interface__gr.html#ae8cff208d9efb5067d38ced675916c66", null ],
[ "ecc_size", "group__nand__interface__gr.html#a22365f6a2af1171a1c3629c8ae5fe001", null ],
[ "ecc_offset", "group__nand__interface__gr.html#a22d6a1813a47a7044f7acb478f8e9eb8", null ],
[ "virtual_page_size", "group__nand__interface__gr.html#aa270f95e67fdf1e9137c61f2045b7636", null ],
[ "codeword_offset", "group__nand__interface__gr.html#a31c5b0e899b2d60adb6cdef971633db0", null ],
[ "codeword_gap", "group__nand__interface__gr.html#ae0a2b8415bddd99dade9cbcf8c52186a", null ],
[ "ecc_gap", "group__nand__interface__gr.html#a94d6b62b24d96ff83c985325d8825dd3", null ]
] ],
[ "ARM_NAND_SignalEvent_t", "group__nand__interface__gr.html#ga09f4cf2f2df0bb690bce38b13d77e50f", null ],
[ "ARM_NAND_GetVersion", "group__nand__interface__gr.html#ga01255fd4f15e7fa4751c7ea59648ef5a", null ],
[ "ARM_NAND_GetCapabilities", "group__nand__interface__gr.html#ga9f2609975c2008d21b9ae28f15daf147", null ],
[ "ARM_NAND_Initialize", "group__nand__interface__gr.html#ga74ad34718a595e7a4375b90f33e72750", null ],
[ "ARM_NAND_Uninitialize", "group__nand__interface__gr.html#gaa788b638ab696b166fee2f4a4bc8d97a", null ],
[ "ARM_NAND_PowerControl", "group__nand__interface__gr.html#ga9c9975637980b5d42db7baba0191fda1", null ],
[ "ARM_NAND_DevicePower", "group__nand__interface__gr.html#ga11adcbaaace09746581a36befbd563c9", null ],
[ "ARM_NAND_WriteProtect", "group__nand__interface__gr.html#ga1987e65a4e756d748db86332c9fb1cec", null ],
[ "ARM_NAND_ChipEnable", "group__nand__interface__gr.html#ga1c0cba87cb7b706ad5986dc67c831ad1", null ],
[ "ARM_NAND_GetDeviceBusy", "group__nand__interface__gr.html#ga43011066306bd716b580e6aa9a80cf65", null ],
[ "ARM_NAND_SendCommand", "group__nand__interface__gr.html#ga9f70b89ba478eadfe7f5dee7453a4fb7", null ],
[ "ARM_NAND_SendAddress", "group__nand__interface__gr.html#ga00e195031e03d364db7595858a7e76f3", null ],
[ "ARM_NAND_ReadData", "group__nand__interface__gr.html#gae1899a20ef107400c8bf84fad477a8ce", null ],
[ "ARM_NAND_WriteData", "group__nand__interface__gr.html#ga1fa497dd51a86fc308e946b4419fd006", null ],
[ "ARM_NAND_ExecuteSequence", "group__nand__interface__gr.html#ga8a0108dba757a4610475151144b52825", null ],
[ "ARM_NAND_AbortSequence", "group__nand__interface__gr.html#ga00832861f018db0d8368900b099ecd30", null ],
[ "ARM_NAND_Control", "group__nand__interface__gr.html#ga83061d6d53ffb148853efbc87a864607", null ],
[ "ARM_NAND_GetStatus", "group__nand__interface__gr.html#ga4578642f37a556b58b0bba0ad5d42641", null ],
[ "ARM_NAND_InquireECC", "group__nand__interface__gr.html#gac21425454d586ef48fdfc35e7bd78947", null ],
[ "ARM_NAND_SignalEvent", "group__nand__interface__gr.html#gaf4ce80b0fd6717de7ddfb1cfaf7dd754", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__interface__gr.js | JavaScript | apache-2.0 | 8,767 |
var group__nand__interface__gr_structARM__DRIVER__NAND =
[
[ "GetVersion", "group__nand__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__nand__interface__gr.html#adab9d081aee3e5d1f83c6911e45ceaa6", null ],
[ "Initialize", "group__nand__interface__gr.html#a28b29ab7b6114bb97175bd40d18854ac", null ],
[ "Uninitialize", "group__nand__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__nand__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "DevicePower", "group__nand__interface__gr.html#a9ba6f3066cda5c8d781c309a17315a58", null ],
[ "WriteProtect", "group__nand__interface__gr.html#add6fa19a729c42303581214bc9dec819", null ],
[ "ChipEnable", "group__nand__interface__gr.html#ac090c205fe3d1b3dcb7288b06468bbe5", null ],
[ "GetDeviceBusy", "group__nand__interface__gr.html#ac9bc93fb1a089c6ac71428122f3a072e", null ],
[ "SendCommand", "group__nand__interface__gr.html#a3dbd36d86718980665ce2e3a1ba672ca", null ],
[ "SendAddress", "group__nand__interface__gr.html#a5a43001ef1ca6c6d73f03e366bf41cb5", null ],
[ "ReadData", "group__nand__interface__gr.html#aeba263544c0d63ec8c29e919232615cb", null ],
[ "WriteData", "group__nand__interface__gr.html#a78393d355e539c6f845b33417da60a7e", null ],
[ "ExecuteSequence", "group__nand__interface__gr.html#af0dd5e96fbcc5c15bb183363f8541af8", null ],
[ "AbortSequence", "group__nand__interface__gr.html#ad6e1d53e9028baff856899f795c0d0c8", null ],
[ "Control", "group__nand__interface__gr.html#a706fedbc88921808e210d75b7b5da168", null ],
[ "GetStatus", "group__nand__interface__gr.html#aa43ee108ee5bf29e40485ca89b34188b", null ],
[ "InquireECC", "group__nand__interface__gr.html#aecd239806e9f08b77ce0d00f61e78cf8", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__interface__gr_structARM__DRIVER__NAND.js | JavaScript | apache-2.0 | 1,824 |
var group__nand__interface__gr_structARM__NAND__CAPABILITIES =
[
[ "event_device_ready", "group__nand__interface__gr.html#a5f347e9b63764bbb657f52dc20682128", null ],
[ "reentrant_operation", "group__nand__interface__gr.html#ae0514834750c7452431717a881471e2b", null ],
[ "sequence_operation", "group__nand__interface__gr.html#afa4b798731b1154878c26dda3f090acf", null ],
[ "vcc", "group__nand__interface__gr.html#a35cfa22b2140b109fe24b97c42d5a5ed", null ],
[ "vcc_1v8", "group__nand__interface__gr.html#a0e7d3b9258d468492b22de55d855a06e", null ],
[ "vccq", "group__nand__interface__gr.html#ab1cdfce6eb051bed7b904e0fd1719afa", null ],
[ "vccq_1v8", "group__nand__interface__gr.html#a1896a7548bb6fab285f23cc0d0b23d7d", null ],
[ "vpp", "group__nand__interface__gr.html#a75b97f7c917bba90b2f5c747d6857d23", null ],
[ "wp", "group__nand__interface__gr.html#afe7f5b149b8d92859398315b1ad31ddc", null ],
[ "ce_lines", "group__nand__interface__gr.html#ad5dd0fcdd7f6d5e5cd739f73323a2b11", null ],
[ "ce_manual", "group__nand__interface__gr.html#a2b8044d986995b183b057217643466bf", null ],
[ "rb_monitor", "group__nand__interface__gr.html#a69f5e734ee4a9bb501718cf78a740c3e", null ],
[ "data_width_16", "group__nand__interface__gr.html#a0f22baea13daa9101bf6fc1fdfddc747", null ],
[ "ddr", "group__nand__interface__gr.html#aa9acfde38637fe749aa9271c0a8dae1a", null ],
[ "ddr2", "group__nand__interface__gr.html#ae086693990cbd5d628014c0fcc7c1f2c", null ],
[ "sdr_timing_mode", "group__nand__interface__gr.html#a21036f2047273d90c0af0e97031df5a9", null ],
[ "ddr_timing_mode", "group__nand__interface__gr.html#a00c1f5db7d7c4abe7556733c36da7783", null ],
[ "ddr2_timing_mode", "group__nand__interface__gr.html#a6d9b66da0e56d04d545e0bb6841891b2", null ],
[ "driver_strength_18", "group__nand__interface__gr.html#ae672b2a65dd3d0b93812c088491c4552", null ],
[ "driver_strength_25", "group__nand__interface__gr.html#ae87c19872b838dac7d3136a3fd466f6a", null ],
[ "driver_strength_50", "group__nand__interface__gr.html#aef3d6e1522a6cf7fb87fd113dcd43ad5", null ],
[ "reserved", "group__nand__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__interface__gr_structARM__NAND__CAPABILITIES.js | JavaScript | apache-2.0 | 2,217 |
var group__nand__interface__gr_structARM__NAND__ECC__INFO =
[
[ "type", "group__nand__interface__gr.html#ad44b615021ed3ccb734fcaf583ef4a03", null ],
[ "page_layout", "group__nand__interface__gr.html#a5952ba4313bda7833fefd358f5aff979", null ],
[ "page_count", "group__nand__interface__gr.html#aa993bc236650aa405b01d00b7ca72904", null ],
[ "page_size", "group__nand__interface__gr.html#a9dd3e47e968a8f6beb5d88c6d1b7ebe9", null ],
[ "reserved", "group__nand__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ],
[ "correctable_bits", "group__nand__interface__gr.html#ae65f920c4ad99fd0c6bdf5fd8c4d161a", null ],
[ "codeword_size", "group__nand__interface__gr.html#ae8cff208d9efb5067d38ced675916c66", null ],
[ "ecc_size", "group__nand__interface__gr.html#a22365f6a2af1171a1c3629c8ae5fe001", null ],
[ "ecc_offset", "group__nand__interface__gr.html#a22d6a1813a47a7044f7acb478f8e9eb8", null ],
[ "virtual_page_size", "group__nand__interface__gr.html#aa270f95e67fdf1e9137c61f2045b7636", null ],
[ "codeword_offset", "group__nand__interface__gr.html#a31c5b0e899b2d60adb6cdef971633db0", null ],
[ "codeword_gap", "group__nand__interface__gr.html#ae0a2b8415bddd99dade9cbcf8c52186a", null ],
[ "ecc_gap", "group__nand__interface__gr.html#a94d6b62b24d96ff83c985325d8825dd3", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__interface__gr_structARM__NAND__ECC__INFO.js | JavaScript | apache-2.0 | 1,334 |
var group__nand__interface__gr_structARM__NAND__STATUS =
[
[ "busy", "group__nand__interface__gr.html#a50c88f3c1d787773e2ac1b59533f034a", null ],
[ "ecc_error", "group__nand__interface__gr.html#a7707d2200a3bf8f49b148ffc8ded7636", null ],
[ "reserved", "group__nand__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__nand__interface__gr_structARM__NAND__STATUS.js | JavaScript | apache-2.0 | 342 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>SAI Bit Order</title>
<title>CMSIS-Driver: SAI Bit Order</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__sai__bit__order__control.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">SAI Bit Order<div class="ingroups"><a class="el" href="group__sai__configure__control.html">SAI Configuration</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines the bit order.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaf74bfe9c3005bf3b80d69f112ea9e62b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__bit__order__control.html#gaf74bfe9c3005bf3b80d69f112ea9e62b">ARM_SAI_MSB_FIRST</a>   (0U << ARM_SAI_BIT_ORDER_Pos)</td></tr>
<tr class="memdesc:gaf74bfe9c3005bf3b80d69f112ea9e62b"><td class="mdescLeft"> </td><td class="mdescRight">Data is transferred with MSB first (default) <a href="#gaf74bfe9c3005bf3b80d69f112ea9e62b">More...</a><br/></td></tr>
<tr class="separator:gaf74bfe9c3005bf3b80d69f112ea9e62b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga19b51b75537b030b975efcf68f3db78b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__bit__order__control.html#ga19b51b75537b030b975efcf68f3db78b">ARM_SAI_LSB_FIRST</a>   (1U << ARM_SAI_BIT_ORDER_Pos)</td></tr>
<tr class="memdesc:ga19b51b75537b030b975efcf68f3db78b"><td class="mdescLeft"> </td><td class="mdescRight">Data is transferred with LSB first; User Protocol only (ignored otherwise) <a href="#ga19b51b75537b030b975efcf68f3db78b">More...</a><br/></td></tr>
<tr class="separator:ga19b51b75537b030b975efcf68f3db78b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Defines the bit order. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gaf74bfe9c3005bf3b80d69f112ea9e62b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_MSB_FIRST   (0U << ARM_SAI_BIT_ORDER_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Data is transferred with MSB first (default) </p>
</div>
</div>
<a class="anchor" id="ga19b51b75537b030b975efcf68f3db78b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_LSB_FIRST   (1U << ARM_SAI_BIT_ORDER_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Data is transferred with LSB first; User Protocol only (ignored otherwise) </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__bit__order__control.html | HTML | apache-2.0 | 8,967 |
var group__sai__bit__order__control =
[
[ "ARM_SAI_MSB_FIRST", "group__sai__bit__order__control.html#gaf74bfe9c3005bf3b80d69f112ea9e62b", null ],
[ "ARM_SAI_LSB_FIRST", "group__sai__bit__order__control.html#ga19b51b75537b030b975efcf68f3db78b", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__bit__order__control.js | JavaScript | apache-2.0 | 261 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>SAI Clock Polarity</title>
<title>CMSIS-Driver: SAI Clock Polarity</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__sai__clock__pol__control.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">SAI Clock Polarity<div class="ingroups"><a class="el" href="group__sai__configure__control.html">SAI Configuration</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines clock polarity.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga4311b6b6fd937d6ac37aa2d031a5d5ee"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__clock__pol__control.html#ga4311b6b6fd937d6ac37aa2d031a5d5ee">ARM_SAI_CLOCK_POLARITY_0</a>   (0U << ARM_SAI_CLOCK_POLARITY_Pos)</td></tr>
<tr class="memdesc:ga4311b6b6fd937d6ac37aa2d031a5d5ee"><td class="mdescLeft"> </td><td class="mdescRight">Drive on falling edge, Capture on rising edge (default) <a href="#ga4311b6b6fd937d6ac37aa2d031a5d5ee">More...</a><br/></td></tr>
<tr class="separator:ga4311b6b6fd937d6ac37aa2d031a5d5ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae4c9b9abd3b7390810a5494363875a53"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__clock__pol__control.html#gae4c9b9abd3b7390810a5494363875a53">ARM_SAI_CLOCK_POLARITY_1</a>   (1U << ARM_SAI_CLOCK_POLARITY_Pos)</td></tr>
<tr class="memdesc:gae4c9b9abd3b7390810a5494363875a53"><td class="mdescLeft"> </td><td class="mdescRight">Drive on rising edge, Capture on falling edge. <a href="#gae4c9b9abd3b7390810a5494363875a53">More...</a><br/></td></tr>
<tr class="separator:gae4c9b9abd3b7390810a5494363875a53"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Defines clock polarity. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga4311b6b6fd937d6ac37aa2d031a5d5ee"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_CLOCK_POLARITY_0   (0U << ARM_SAI_CLOCK_POLARITY_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Drive on falling edge, Capture on rising edge (default) </p>
</div>
</div>
<a class="anchor" id="gae4c9b9abd3b7390810a5494363875a53"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_CLOCK_POLARITY_1   (1U << ARM_SAI_CLOCK_POLARITY_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Drive on rising edge, Capture on falling edge. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__clock__pol__control.html | HTML | apache-2.0 | 8,998 |
var group__sai__clock__pol__control =
[
[ "ARM_SAI_CLOCK_POLARITY_0", "group__sai__clock__pol__control.html#ga4311b6b6fd937d6ac37aa2d031a5d5ee", null ],
[ "ARM_SAI_CLOCK_POLARITY_1", "group__sai__clock__pol__control.html#gae4c9b9abd3b7390810a5494363875a53", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__clock__pol__control.js | JavaScript | apache-2.0 | 275 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>SAI Companding</title>
<title>CMSIS-Driver: SAI Companding</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__sai__companding__control.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">SAI Companding<div class="ingroups"><a class="el" href="group__sai__configure__control.html">SAI Configuration</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines companding.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga185919d553cf9204e514136eb375ef08"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__companding__control.html#ga185919d553cf9204e514136eb375ef08">ARM_SAI_COMPANDING_NONE</a>   (0U << ARM_SAI_COMPANDING_Pos)</td></tr>
<tr class="memdesc:ga185919d553cf9204e514136eb375ef08"><td class="mdescLeft"> </td><td class="mdescRight">No companding (default) <a href="#ga185919d553cf9204e514136eb375ef08">More...</a><br/></td></tr>
<tr class="separator:ga185919d553cf9204e514136eb375ef08"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacfd6c74148c0ae90aa6eaaf8e69da3a9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__companding__control.html#gacfd6c74148c0ae90aa6eaaf8e69da3a9">ARM_SAI_COMPANDING_A_LAW</a>   (2U << ARM_SAI_COMPANDING_Pos)</td></tr>
<tr class="memdesc:gacfd6c74148c0ae90aa6eaaf8e69da3a9"><td class="mdescLeft"> </td><td class="mdescRight">A-Law companding. <a href="#gacfd6c74148c0ae90aa6eaaf8e69da3a9">More...</a><br/></td></tr>
<tr class="separator:gacfd6c74148c0ae90aa6eaaf8e69da3a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7b571406bcce383140198e53312faee5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__companding__control.html#ga7b571406bcce383140198e53312faee5">ARM_SAI_COMPANDING_U_LAW</a>   (3U << ARM_SAI_COMPANDING_Pos)</td></tr>
<tr class="memdesc:ga7b571406bcce383140198e53312faee5"><td class="mdescLeft"> </td><td class="mdescRight">u-Law companding <a href="#ga7b571406bcce383140198e53312faee5">More...</a><br/></td></tr>
<tr class="separator:ga7b571406bcce383140198e53312faee5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Defines companding. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga185919d553cf9204e514136eb375ef08"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_COMPANDING_NONE   (0U << ARM_SAI_COMPANDING_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>No companding (default) </p>
</div>
</div>
<a class="anchor" id="gacfd6c74148c0ae90aa6eaaf8e69da3a9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_COMPANDING_A_LAW   (2U << ARM_SAI_COMPANDING_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>A-Law companding. </p>
</div>
</div>
<a class="anchor" id="ga7b571406bcce383140198e53312faee5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_COMPANDING_U_LAW   (3U << ARM_SAI_COMPANDING_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>u-Law companding </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__companding__control.html | HTML | apache-2.0 | 9,872 |
var group__sai__companding__control =
[
[ "ARM_SAI_COMPANDING_NONE", "group__sai__companding__control.html#ga185919d553cf9204e514136eb375ef08", null ],
[ "ARM_SAI_COMPANDING_A_LAW", "group__sai__companding__control.html#gacfd6c74148c0ae90aa6eaaf8e69da3a9", null ],
[ "ARM_SAI_COMPANDING_U_LAW", "group__sai__companding__control.html#ga7b571406bcce383140198e53312faee5", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__companding__control.js | JavaScript | apache-2.0 | 391 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>SAI Configuration</title>
<title>CMSIS-Driver: SAI Configuration</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__sai__configure__control.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Content</a> </div>
<div class="headertitle">
<div class="title">SAI Configuration<div class="ingroups"><a class="el" href="group__sai__control.html">SAI Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify Transmitter/Receiver configuration.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Content</h2></td></tr>
<tr class="memitem:group__sai__mode__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__mode__control.html">SAI Mode</a></td></tr>
<tr class="memdesc:group__sai__mode__control"><td class="mdescLeft"> </td><td class="mdescRight">Defines Transmitter/Receiver mode. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__sai__sync__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__sync__control.html">SAI Synchronization</a></td></tr>
<tr class="memdesc:group__sai__sync__control"><td class="mdescLeft"> </td><td class="mdescRight">Defines Transmitter/Receiver synchronization. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__sai__protocol__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__protocol__control.html">SAI Protocol</a></td></tr>
<tr class="memdesc:group__sai__protocol__control"><td class="mdescLeft"> </td><td class="mdescRight">Defines Transmitter/Receiver protocol. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__sai__data__bits__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__data__bits__control.html">SAI Data Size</a></td></tr>
<tr class="memdesc:group__sai__data__bits__control"><td class="mdescLeft"> </td><td class="mdescRight">Defines data size in bits (per channel/slot). <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__sai__bit__order__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__bit__order__control.html">SAI Bit Order</a></td></tr>
<tr class="memdesc:group__sai__bit__order__control"><td class="mdescLeft"> </td><td class="mdescRight">Defines the bit order. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__sai__mono__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__mono__control.html">SAI Mono Mode</a></td></tr>
<tr class="memdesc:group__sai__mono__control"><td class="mdescLeft"> </td><td class="mdescRight">Defines mono mode. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__sai__companding__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__companding__control.html">SAI Companding</a></td></tr>
<tr class="memdesc:group__sai__companding__control"><td class="mdescLeft"> </td><td class="mdescRight">Defines companding. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__sai__clock__pol__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__clock__pol__control.html">SAI Clock Polarity</a></td></tr>
<tr class="memdesc:group__sai__clock__pol__control"><td class="mdescLeft"> </td><td class="mdescRight">Defines clock polarity. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__sai__frame__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__frame__control.html">SAI Frame</a></td></tr>
<tr class="memdesc:group__sai__frame__control"><td class="mdescLeft"> </td><td class="mdescRight">Defines frame. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__sai__slot__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__slot__control.html">SAI Slot</a></td></tr>
<tr class="memdesc:group__sai__slot__control"><td class="mdescLeft"> </td><td class="mdescRight">Defines data slots. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__sai__mclk__pin__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__mclk__pin__control.html">SAI Master Clock Pin</a></td></tr>
<tr class="memdesc:group__sai__mclk__pin__control"><td class="mdescLeft"> </td><td class="mdescRight">Defines MCLK pin. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__sai__mclk__pres__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__mclk__pres__control.html">SAI Master Clock Prescaler</a></td></tr>
<tr class="memdesc:group__sai__mclk__pres__control"><td class="mdescLeft"> </td><td class="mdescRight">Defines MCLK prescaler. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify Transmitter/Receiver configuration. </p>
<p>Configuration is specified by ORing <b>ARM_SAI_CONFIGURE_<em>x</em></b> with the following parameters:</p>
<ul>
<li><a class="el" href="group__sai__mode__control.html">SAI Mode</a></li>
<li><a class="el" href="group__sai__sync__control.html">SAI Synchronization</a></li>
<li><a class="el" href="group__sai__protocol__control.html">SAI Protocol</a></li>
<li><a class="el" href="group__sai__data__bits__control.html">SAI Data Size</a></li>
<li><a class="el" href="group__sai__bit__order__control.html">SAI Bit Order</a></li>
<li><a class="el" href="group__sai__mono__control.html">SAI Mono Mode</a></li>
<li><a class="el" href="group__sai__clock__pol__control.html">SAI Clock Polarity</a></li>
<li><a class="el" href="group__sai__companding__control.html">SAI Companding</a></li>
<li><a class="el" href="group__sai__mclk__pin__control.html">SAI Master Clock Pin</a></li>
</ul>
<p>Additional configuration specified by <em>arg1:</em> </p>
<ul>
<li><a class="el" href="group__sai__frame__control.html">SAI Frame</a></li>
<li><a class="el" href="group__sai__slot__control.html">SAI Slot</a></li>
</ul>
<p>Additional configuration specified by <em>arg2:</em> </p>
<ul>
<li><b>Audio Frequency</b> (Master only)</li>
<li><a class="el" href="group__sai__mclk__pres__control.html">SAI Master Clock Prescaler</a> </li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__configure__control.html | HTML | apache-2.0 | 13,598 |
var group__sai__configure__control =
[
[ "SAI Mode", "group__sai__mode__control.html", "group__sai__mode__control" ],
[ "SAI Synchronization", "group__sai__sync__control.html", "group__sai__sync__control" ],
[ "SAI Protocol", "group__sai__protocol__control.html", "group__sai__protocol__control" ],
[ "SAI Data Size", "group__sai__data__bits__control.html", "group__sai__data__bits__control" ],
[ "SAI Bit Order", "group__sai__bit__order__control.html", "group__sai__bit__order__control" ],
[ "SAI Mono Mode", "group__sai__mono__control.html", "group__sai__mono__control" ],
[ "SAI Companding", "group__sai__companding__control.html", "group__sai__companding__control" ],
[ "SAI Clock Polarity", "group__sai__clock__pol__control.html", "group__sai__clock__pol__control" ],
[ "SAI Frame", "group__sai__frame__control.html", "group__sai__frame__control" ],
[ "SAI Slot", "group__sai__slot__control.html", "group__sai__slot__control" ],
[ "SAI Master Clock Pin", "group__sai__mclk__pin__control.html", "group__sai__mclk__pin__control" ],
[ "SAI Master Clock Prescaler", "group__sai__mclk__pres__control.html", "group__sai__mclk__pres__control" ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__configure__control.js | JavaScript | apache-2.0 | 1,193 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>SAI Control Codes</title>
<title>CMSIS-Driver: SAI Control Codes</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__sai__control.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Content</a> </div>
<div class="headertitle">
<div class="title">SAI Control Codes<div class="ingroups"><a class="el" href="group__sai__interface__gr.html">SAI Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Many parameters of the SAI driver are configured using the <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> function.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Content</h2></td></tr>
<tr class="memitem:group__sai__configure__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__configure__control.html">SAI Configuration</a></td></tr>
<tr class="memdesc:group__sai__configure__control"><td class="mdescLeft"> </td><td class="mdescRight">Specify Transmitter/Receiver configuration. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__sai__controls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html">SAI Controls</a></td></tr>
<tr class="memdesc:group__sai__controls"><td class="mdescLeft"> </td><td class="mdescRight">Specifies controls. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Many parameters of the SAI driver are configured using the <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> function. </p>
<p>The various SAI control codes define:</p>
<ul>
<li><a class="el" href="group__sai__configure__control.html">SAI Configuration</a> specifies SAI configuration</li>
<li><a class="el" href="group__sai__controls.html">SAI Controls</a> specifies SAI controls</li>
</ul>
<p>Refer to the <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> function for further details. </p>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__control.html | HTML | apache-2.0 | 8,323 |
var group__sai__control =
[
[ "SAI Configuration", "group__sai__configure__control.html", "group__sai__configure__control" ],
[ "SAI Controls", "group__sai__controls.html", "group__sai__controls" ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__control.js | JavaScript | apache-2.0 | 208 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>SAI Controls</title>
<title>CMSIS-Driver: SAI Controls</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__sai__controls.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">SAI Controls<div class="ingroups"><a class="el" href="group__sai__control.html">SAI Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specifies controls.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga14ac7775060e731b26bc5b3acd2f317a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#ga14ac7775060e731b26bc5b3acd2f317a">ARM_SAI_CONFIGURE_TX</a>   (0x01U)</td></tr>
<tr class="memdesc:ga14ac7775060e731b26bc5b3acd2f317a"><td class="mdescLeft"> </td><td class="mdescRight">Configure Transmitter; arg1 and arg2 provide additional configuration. <a href="#ga14ac7775060e731b26bc5b3acd2f317a">More...</a><br/></td></tr>
<tr class="separator:ga14ac7775060e731b26bc5b3acd2f317a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaba3e824e022fe2a5736de5dcbbd3d291"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#gaba3e824e022fe2a5736de5dcbbd3d291">ARM_SAI_CONFIGURE_RX</a>   (0x02U)</td></tr>
<tr class="memdesc:gaba3e824e022fe2a5736de5dcbbd3d291"><td class="mdescLeft"> </td><td class="mdescRight">Configure Receiver; arg1 and arg2 provide additional configuration. <a href="#gaba3e824e022fe2a5736de5dcbbd3d291">More...</a><br/></td></tr>
<tr class="separator:gaba3e824e022fe2a5736de5dcbbd3d291"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga74d7850973c095bb8dbffa880b4af1bc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#ga74d7850973c095bb8dbffa880b4af1bc">ARM_SAI_CONTROL_TX</a>   (0x03U)</td></tr>
<tr class="memdesc:ga74d7850973c095bb8dbffa880b4af1bc"><td class="mdescLeft"> </td><td class="mdescRight">Control Transmitter; arg1.0: 0=disable (default), 1=enable; arg1.1: mute. <a href="#ga74d7850973c095bb8dbffa880b4af1bc">More...</a><br/></td></tr>
<tr class="separator:ga74d7850973c095bb8dbffa880b4af1bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa40390b6dd0df3b140fdc45bb7b1439d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#gaa40390b6dd0df3b140fdc45bb7b1439d">ARM_SAI_CONTROL_RX</a>   (0x04U)</td></tr>
<tr class="memdesc:gaa40390b6dd0df3b140fdc45bb7b1439d"><td class="mdescLeft"> </td><td class="mdescRight">Control Receiver; arg1.0: 0=disable (default), 1=enable. <a href="#gaa40390b6dd0df3b140fdc45bb7b1439d">More...</a><br/></td></tr>
<tr class="separator:gaa40390b6dd0df3b140fdc45bb7b1439d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8675b9776189caf4df7d558b3e18fcba"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#ga8675b9776189caf4df7d558b3e18fcba">ARM_SAI_MASK_SLOTS_TX</a>   (0x05U)</td></tr>
<tr class="memdesc:ga8675b9776189caf4df7d558b3e18fcba"><td class="mdescLeft"> </td><td class="mdescRight">Mask Transmitter slots; arg1 = mask (bit: 0=active, 1=inactive); all configured slots are active by default. <a href="#ga8675b9776189caf4df7d558b3e18fcba">More...</a><br/></td></tr>
<tr class="separator:ga8675b9776189caf4df7d558b3e18fcba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga84302d372185665852c9ed941c6545e0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#ga84302d372185665852c9ed941c6545e0">ARM_SAI_MASK_SLOTS_RX</a>   (0x06U)</td></tr>
<tr class="memdesc:ga84302d372185665852c9ed941c6545e0"><td class="mdescLeft"> </td><td class="mdescRight">Mask Receiver slots; arg1 = mask (bit: 0=active, 1=inactive); all configured slots are active by default. <a href="#ga84302d372185665852c9ed941c6545e0">More...</a><br/></td></tr>
<tr class="separator:ga84302d372185665852c9ed941c6545e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab3ec8ef9e5e5a190bd2131ac8c99a240"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#gab3ec8ef9e5e5a190bd2131ac8c99a240">ARM_SAI_ABORT_SEND</a>   (0x07U)</td></tr>
<tr class="memdesc:gab3ec8ef9e5e5a190bd2131ac8c99a240"><td class="mdescLeft"> </td><td class="mdescRight">Abort <a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd">ARM_SAI_Send</a>. <a href="#gab3ec8ef9e5e5a190bd2131ac8c99a240">More...</a><br/></td></tr>
<tr class="separator:gab3ec8ef9e5e5a190bd2131ac8c99a240"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2b8d3d85c1e60f137f8c433f319244cb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#ga2b8d3d85c1e60f137f8c433f319244cb">ARM_SAI_ABORT_RECEIVE</a>   (0x08U)</td></tr>
<tr class="memdesc:ga2b8d3d85c1e60f137f8c433f319244cb"><td class="mdescLeft"> </td><td class="mdescRight">Abort <a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98">ARM_SAI_Receive</a>. <a href="#ga2b8d3d85c1e60f137f8c433f319244cb">More...</a><br/></td></tr>
<tr class="separator:ga2b8d3d85c1e60f137f8c433f319244cb"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specifies controls. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga14ac7775060e731b26bc5b3acd2f317a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_CONFIGURE_TX   (0x01U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure Transmitter; arg1 and arg2 provide additional configuration. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869" title="Control SAI Interface. ">ARM_SAI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaba3e824e022fe2a5736de5dcbbd3d291"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_CONFIGURE_RX   (0x02U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure Receiver; arg1 and arg2 provide additional configuration. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869" title="Control SAI Interface. ">ARM_SAI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga74d7850973c095bb8dbffa880b4af1bc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_CONTROL_TX   (0x03U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Control Transmitter; arg1.0: 0=disable (default), 1=enable; arg1.1: mute. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869" title="Control SAI Interface. ">ARM_SAI_Control</a>; <a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd" title="Start sending data to SAI transmitter. ">ARM_SAI_Send</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaa40390b6dd0df3b140fdc45bb7b1439d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_CONTROL_RX   (0x04U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Control Receiver; arg1.0: 0=disable (default), 1=enable. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869" title="Control SAI Interface. ">ARM_SAI_Control</a>; <a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98" title="Start receiving data from SAI receiver. ">ARM_SAI_Receive</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga8675b9776189caf4df7d558b3e18fcba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_MASK_SLOTS_TX   (0x05U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Mask Transmitter slots; arg1 = mask (bit: 0=active, 1=inactive); all configured slots are active by default. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869" title="Control SAI Interface. ">ARM_SAI_Control</a>; <a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd" title="Start sending data to SAI transmitter. ">ARM_SAI_Send</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga84302d372185665852c9ed941c6545e0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_MASK_SLOTS_RX   (0x06U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Mask Receiver slots; arg1 = mask (bit: 0=active, 1=inactive); all configured slots are active by default. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869" title="Control SAI Interface. ">ARM_SAI_Control</a>; <a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98" title="Start receiving data from SAI receiver. ">ARM_SAI_Receive</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gab3ec8ef9e5e5a190bd2131ac8c99a240"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_ABORT_SEND   (0x07U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Abort <a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd">ARM_SAI_Send</a>. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869" title="Control SAI Interface. ">ARM_SAI_Control</a>; <a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd" title="Start sending data to SAI transmitter. ">ARM_SAI_Send</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga2b8d3d85c1e60f137f8c433f319244cb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_ABORT_RECEIVE   (0x08U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Abort <a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98">ARM_SAI_Receive</a>. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869" title="Control SAI Interface. ">ARM_SAI_Control</a>; <a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98" title="Start receiving data from SAI receiver. ">ARM_SAI_Receive</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__controls.html | HTML | apache-2.0 | 18,016 |
var group__sai__controls =
[
[ "ARM_SAI_CONFIGURE_TX", "group__sai__controls.html#ga14ac7775060e731b26bc5b3acd2f317a", null ],
[ "ARM_SAI_CONFIGURE_RX", "group__sai__controls.html#gaba3e824e022fe2a5736de5dcbbd3d291", null ],
[ "ARM_SAI_CONTROL_TX", "group__sai__controls.html#ga74d7850973c095bb8dbffa880b4af1bc", null ],
[ "ARM_SAI_CONTROL_RX", "group__sai__controls.html#gaa40390b6dd0df3b140fdc45bb7b1439d", null ],
[ "ARM_SAI_MASK_SLOTS_TX", "group__sai__controls.html#ga8675b9776189caf4df7d558b3e18fcba", null ],
[ "ARM_SAI_MASK_SLOTS_RX", "group__sai__controls.html#ga84302d372185665852c9ed941c6545e0", null ],
[ "ARM_SAI_ABORT_SEND", "group__sai__controls.html#gab3ec8ef9e5e5a190bd2131ac8c99a240", null ],
[ "ARM_SAI_ABORT_RECEIVE", "group__sai__controls.html#ga2b8d3d85c1e60f137f8c433f319244cb", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__controls.js | JavaScript | apache-2.0 | 843 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>SAI Data Size</title>
<title>CMSIS-Driver: SAI Data Size</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__sai__data__bits__control.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">SAI Data Size<div class="ingroups"><a class="el" href="group__sai__configure__control.html">SAI Configuration</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines data size in bits (per channel/slot).
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga1a7529e4b46d69dbd57ccef84552a3f4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__data__bits__control.html#ga1a7529e4b46d69dbd57ccef84552a3f4">ARM_SAI_DATA_SIZE</a>(n)   ((((n)-1)&0x1FU) << ARM_SAI_DATA_SIZE_Pos)</td></tr>
<tr class="memdesc:ga1a7529e4b46d69dbd57ccef84552a3f4"><td class="mdescLeft"> </td><td class="mdescRight">Data size in bits (8..32) <a href="#ga1a7529e4b46d69dbd57ccef84552a3f4">More...</a><br/></td></tr>
<tr class="separator:ga1a7529e4b46d69dbd57ccef84552a3f4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Defines data size in bits (per channel/slot). </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga1a7529e4b46d69dbd57ccef84552a3f4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_DATA_SIZE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">n</td><td>)</td>
<td>   ((((n)-1)&0x1FU) << ARM_SAI_DATA_SIZE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Data size in bits (8..32) </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__data__bits__control.html | HTML | apache-2.0 | 8,012 |
var group__sai__data__bits__control =
[
[ "ARM_SAI_DATA_SIZE", "group__sai__data__bits__control.html#ga1a7529e4b46d69dbd57ccef84552a3f4", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__data__bits__control.js | JavaScript | apache-2.0 | 151 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Status Error Codes</title>
<title>CMSIS-Driver: Status Error Codes</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__sai__execution__status.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Status Error Codes<div class="ingroups"><a class="el" href="group__sai__interface__gr.html">SAI Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Negative values indicate errors (SAI has specific codes in addition to common <a class="el" href="group__execution__status.html">Status Error Codes</a>).
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga711cd889b4209df3f8fb01e4f2413c61"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__execution__status.html#ga711cd889b4209df3f8fb01e4f2413c61">ARM_SAI_ERROR_SYNCHRONIZATION</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 1)</td></tr>
<tr class="memdesc:ga711cd889b4209df3f8fb01e4f2413c61"><td class="mdescLeft"> </td><td class="mdescRight">Specified Synchronization not supported. <a href="#ga711cd889b4209df3f8fb01e4f2413c61">More...</a><br/></td></tr>
<tr class="separator:ga711cd889b4209df3f8fb01e4f2413c61"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf4892425930608ad7a41fa5b49603b10"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__execution__status.html#gaf4892425930608ad7a41fa5b49603b10">ARM_SAI_ERROR_PROTOCOL</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 2)</td></tr>
<tr class="memdesc:gaf4892425930608ad7a41fa5b49603b10"><td class="mdescLeft"> </td><td class="mdescRight">Specified Protocol not supported. <a href="#gaf4892425930608ad7a41fa5b49603b10">More...</a><br/></td></tr>
<tr class="separator:gaf4892425930608ad7a41fa5b49603b10"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5c51cbd8c2d2fe4baae110d390cefdc2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__execution__status.html#ga5c51cbd8c2d2fe4baae110d390cefdc2">ARM_SAI_ERROR_DATA_SIZE</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 3)</td></tr>
<tr class="memdesc:ga5c51cbd8c2d2fe4baae110d390cefdc2"><td class="mdescLeft"> </td><td class="mdescRight">Specified Data size not supported. <a href="#ga5c51cbd8c2d2fe4baae110d390cefdc2">More...</a><br/></td></tr>
<tr class="separator:ga5c51cbd8c2d2fe4baae110d390cefdc2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadcd0d44f0f6b691c4e84b30960c096e4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__execution__status.html#gadcd0d44f0f6b691c4e84b30960c096e4">ARM_SAI_ERROR_BIT_ORDER</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 4)</td></tr>
<tr class="memdesc:gadcd0d44f0f6b691c4e84b30960c096e4"><td class="mdescLeft"> </td><td class="mdescRight">Specified Bit order not supported. <a href="#gadcd0d44f0f6b691c4e84b30960c096e4">More...</a><br/></td></tr>
<tr class="separator:gadcd0d44f0f6b691c4e84b30960c096e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga912bf004fce3a37709bbf69734802b4a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__execution__status.html#ga912bf004fce3a37709bbf69734802b4a">ARM_SAI_ERROR_MONO_MODE</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 5)</td></tr>
<tr class="memdesc:ga912bf004fce3a37709bbf69734802b4a"><td class="mdescLeft"> </td><td class="mdescRight">Specified Mono mode not supported. <a href="#ga912bf004fce3a37709bbf69734802b4a">More...</a><br/></td></tr>
<tr class="separator:ga912bf004fce3a37709bbf69734802b4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4683468c258e1a8706afcce1e81356d1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__execution__status.html#ga4683468c258e1a8706afcce1e81356d1">ARM_SAI_ERROR_COMPANDING</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 6)</td></tr>
<tr class="memdesc:ga4683468c258e1a8706afcce1e81356d1"><td class="mdescLeft"> </td><td class="mdescRight">Specified Companding not supported. <a href="#ga4683468c258e1a8706afcce1e81356d1">More...</a><br/></td></tr>
<tr class="separator:ga4683468c258e1a8706afcce1e81356d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7810e77ec599b0f86073a8711c0655df"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__execution__status.html#ga7810e77ec599b0f86073a8711c0655df">ARM_SAI_ERROR_CLOCK_POLARITY</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 7)</td></tr>
<tr class="memdesc:ga7810e77ec599b0f86073a8711c0655df"><td class="mdescLeft"> </td><td class="mdescRight">Specified Clock polarity not supported. <a href="#ga7810e77ec599b0f86073a8711c0655df">More...</a><br/></td></tr>
<tr class="separator:ga7810e77ec599b0f86073a8711c0655df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5021651816da0aa92561eed634ba7578"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__execution__status.html#ga5021651816da0aa92561eed634ba7578">ARM_SAI_ERROR_AUDIO_FREQ</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 8)</td></tr>
<tr class="memdesc:ga5021651816da0aa92561eed634ba7578"><td class="mdescLeft"> </td><td class="mdescRight">Specified Audio frequency not supported. <a href="#ga5021651816da0aa92561eed634ba7578">More...</a><br/></td></tr>
<tr class="separator:ga5021651816da0aa92561eed634ba7578"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0d910d4a638433e3b2326fc776da0f53"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__execution__status.html#ga0d910d4a638433e3b2326fc776da0f53">ARM_SAI_ERROR_MCLK_PIN</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 9)</td></tr>
<tr class="memdesc:ga0d910d4a638433e3b2326fc776da0f53"><td class="mdescLeft"> </td><td class="mdescRight">Specified MCLK Pin setting not supported. <a href="#ga0d910d4a638433e3b2326fc776da0f53">More...</a><br/></td></tr>
<tr class="separator:ga0d910d4a638433e3b2326fc776da0f53"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabab9495d6c57e56604cb1a2ac7e75431"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__execution__status.html#gabab9495d6c57e56604cb1a2ac7e75431">ARM_SAI_ERROR_MCLK_PRESCALER</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 10)</td></tr>
<tr class="memdesc:gabab9495d6c57e56604cb1a2ac7e75431"><td class="mdescLeft"> </td><td class="mdescRight">Specified MCLK Prescaler not supported. <a href="#gabab9495d6c57e56604cb1a2ac7e75431">More...</a><br/></td></tr>
<tr class="separator:gabab9495d6c57e56604cb1a2ac7e75431"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf0448bdd6d1ae33511d170b9ecc1e2d6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__execution__status.html#gaf0448bdd6d1ae33511d170b9ecc1e2d6">ARM_SAI_ERROR_FRAME_LENGHT</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 11)</td></tr>
<tr class="memdesc:gaf0448bdd6d1ae33511d170b9ecc1e2d6"><td class="mdescLeft"> </td><td class="mdescRight">Specified Frame length not supported. <a href="#gaf0448bdd6d1ae33511d170b9ecc1e2d6">More...</a><br/></td></tr>
<tr class="separator:gaf0448bdd6d1ae33511d170b9ecc1e2d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga993da1bc0f6745795b364d84dec24e99"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__execution__status.html#ga993da1bc0f6745795b364d84dec24e99">ARM_SAI_ERROR_FRAME_SYNC_WIDTH</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 12)</td></tr>
<tr class="memdesc:ga993da1bc0f6745795b364d84dec24e99"><td class="mdescLeft"> </td><td class="mdescRight">Specified Frame Sync width not supported. <a href="#ga993da1bc0f6745795b364d84dec24e99">More...</a><br/></td></tr>
<tr class="separator:ga993da1bc0f6745795b364d84dec24e99"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0561b0cc9577d944e0d39b582612e061"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__execution__status.html#ga0561b0cc9577d944e0d39b582612e061">ARM_SAI_ERROR_FRAME_SYNC_POLARITY</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 13)</td></tr>
<tr class="memdesc:ga0561b0cc9577d944e0d39b582612e061"><td class="mdescLeft"> </td><td class="mdescRight">Specified Frame Sync polarity not supported. <a href="#ga0561b0cc9577d944e0d39b582612e061">More...</a><br/></td></tr>
<tr class="separator:ga0561b0cc9577d944e0d39b582612e061"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga09fe9b65d2be54ee1441606523291011"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__execution__status.html#ga09fe9b65d2be54ee1441606523291011">ARM_SAI_ERROR_FRAME_SYNC_EARLY</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 14)</td></tr>
<tr class="memdesc:ga09fe9b65d2be54ee1441606523291011"><td class="mdescLeft"> </td><td class="mdescRight">Specified Frame Sync early not supported. <a href="#ga09fe9b65d2be54ee1441606523291011">More...</a><br/></td></tr>
<tr class="separator:ga09fe9b65d2be54ee1441606523291011"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf52ee0cd13b6cb9c63acfe767ed5dfde"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__execution__status.html#gaf52ee0cd13b6cb9c63acfe767ed5dfde">ARM_SAI_ERROR_SLOT_COUNT</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 15)</td></tr>
<tr class="memdesc:gaf52ee0cd13b6cb9c63acfe767ed5dfde"><td class="mdescLeft"> </td><td class="mdescRight">Specified Slot count not supported. <a href="#gaf52ee0cd13b6cb9c63acfe767ed5dfde">More...</a><br/></td></tr>
<tr class="separator:gaf52ee0cd13b6cb9c63acfe767ed5dfde"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7bf825043ba857950a89817ff9b853d1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__execution__status.html#ga7bf825043ba857950a89817ff9b853d1">ARM_SAI_ERROR_SLOT_SIZE</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 16)</td></tr>
<tr class="memdesc:ga7bf825043ba857950a89817ff9b853d1"><td class="mdescLeft"> </td><td class="mdescRight">Specified Slot size not supported. <a href="#ga7bf825043ba857950a89817ff9b853d1">More...</a><br/></td></tr>
<tr class="separator:ga7bf825043ba857950a89817ff9b853d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4658a3143c891d8972446630b6a978cd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__execution__status.html#ga4658a3143c891d8972446630b6a978cd">ARM_SAI_ERROR_SLOT_OFFESET</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 17)</td></tr>
<tr class="memdesc:ga4658a3143c891d8972446630b6a978cd"><td class="mdescLeft"> </td><td class="mdescRight">Specified Slot offset not supported. <a href="#ga4658a3143c891d8972446630b6a978cd">More...</a><br/></td></tr>
<tr class="separator:ga4658a3143c891d8972446630b6a978cd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Negative values indicate errors (SAI has specific codes in addition to common <a class="el" href="group__execution__status.html">Status Error Codes</a>). </p>
<p>The SAI driver has additional status error codes that are listed below. </p>
<dl class="section note"><dt>Note</dt><dd><ul>
<li>In case multiple errors exist, only the first encountered error will be reported.</li>
<li>errors ARM_SAI_ERROR_BIT_ORDER, ARM_SAI_ERROR_FRAME_SYNC_xxx, ARM_SAI_ERROR_SLOT_xxx will only be reported in <a class="el" href="group__sai__interface__gr.html#Driver_SAI_User">User Defined Protocol</a> mode.</li>
<li>The SAI driver also returns the common <a class="el" href="group__execution__status.html">Status Error Codes</a>. </li>
</ul>
</dd></dl>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga711cd889b4209df3f8fb01e4f2413c61"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_ERROR_SYNCHRONIZATION   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Synchronization not supported. </p>
<p>The <b>synchronization</b> requested with the function <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> is not supported. </p>
</div>
</div>
<a class="anchor" id="gaf4892425930608ad7a41fa5b49603b10"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_ERROR_PROTOCOL   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Protocol not supported. </p>
<p>The <b>protocol</b> requested with the function <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> is not supported. </p>
</div>
</div>
<a class="anchor" id="ga5c51cbd8c2d2fe4baae110d390cefdc2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_ERROR_DATA_SIZE   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 3)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Data size not supported. </p>
<p>The <b>data size</b> requested with the function <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> is not supported. </p>
</div>
</div>
<a class="anchor" id="gadcd0d44f0f6b691c4e84b30960c096e4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_ERROR_BIT_ORDER   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 4)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Bit order not supported. </p>
<p>The <b>bit order</b> requested with the function <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> is not supported. </p>
</div>
</div>
<a class="anchor" id="ga912bf004fce3a37709bbf69734802b4a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_ERROR_MONO_MODE   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 5)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Mono mode not supported. </p>
<p>The <b>mono mode</b> requested with the function <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> is not supported. </p>
</div>
</div>
<a class="anchor" id="ga4683468c258e1a8706afcce1e81356d1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_ERROR_COMPANDING   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 6)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Companding not supported. </p>
<p>The <b>companding</b> requested with the function <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> is not supported. </p>
</div>
</div>
<a class="anchor" id="ga7810e77ec599b0f86073a8711c0655df"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_ERROR_CLOCK_POLARITY   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 7)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Clock polarity not supported. </p>
<p>The <b>clock polarity</b> requested with the function <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> is not supported. </p>
</div>
</div>
<a class="anchor" id="ga5021651816da0aa92561eed634ba7578"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_ERROR_AUDIO_FREQ   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 8)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Audio frequency not supported. </p>
<p>The <b>audio frequency</b> requested with the function <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> is not supported. </p>
</div>
</div>
<a class="anchor" id="ga0d910d4a638433e3b2326fc776da0f53"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_ERROR_MCLK_PIN   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 9)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified MCLK Pin setting not supported. </p>
<p>The <b>MCLK pin</b> setting requested with the function <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> is not supported. </p>
</div>
</div>
<a class="anchor" id="gabab9495d6c57e56604cb1a2ac7e75431"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_ERROR_MCLK_PRESCALER   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 10)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified MCLK Prescaler not supported. </p>
<p>The <b>MCLK prescaler</b> requested with the function <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> is not supported. </p>
</div>
</div>
<a class="anchor" id="gaf0448bdd6d1ae33511d170b9ecc1e2d6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_ERROR_FRAME_LENGHT   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 11)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Frame length not supported. </p>
<p>The <b>frame length</b> requested with the function <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> is not supported. </p>
</div>
</div>
<a class="anchor" id="ga993da1bc0f6745795b364d84dec24e99"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_ERROR_FRAME_SYNC_WIDTH   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 12)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Frame Sync width not supported. </p>
<p>The <b>frame sync width</b> requested with the function <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> is not supported. </p>
</div>
</div>
<a class="anchor" id="ga0561b0cc9577d944e0d39b582612e061"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_ERROR_FRAME_SYNC_POLARITY   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 13)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Frame Sync polarity not supported. </p>
<p>The <b>frame sync polarity</b> requested with the function <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> is not supported. </p>
</div>
</div>
<a class="anchor" id="ga09fe9b65d2be54ee1441606523291011"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_ERROR_FRAME_SYNC_EARLY   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 14)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Frame Sync early not supported. </p>
<p>The <b>frame sync early</b> requested with the function <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> is not supported. </p>
</div>
</div>
<a class="anchor" id="gaf52ee0cd13b6cb9c63acfe767ed5dfde"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_ERROR_SLOT_COUNT   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 15)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Slot count not supported. </p>
<p>The <b>slot count</b> requested with the function <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> is not supported. </p>
</div>
</div>
<a class="anchor" id="ga7bf825043ba857950a89817ff9b853d1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_ERROR_SLOT_SIZE   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 16)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Slot size not supported. </p>
<p>The <b>slot size</b> requested with the function <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> is not supported. </p>
</div>
</div>
<a class="anchor" id="ga4658a3143c891d8972446630b6a978cd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_ERROR_SLOT_OFFESET   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 17)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Slot offset not supported. </p>
<p>The <b>slot offset</b> requested with the function <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> is not supported. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__execution__status.html | HTML | apache-2.0 | 31,996 |
var group__sai__execution__status =
[
[ "ARM_SAI_ERROR_SYNCHRONIZATION", "group__sai__execution__status.html#ga711cd889b4209df3f8fb01e4f2413c61", null ],
[ "ARM_SAI_ERROR_PROTOCOL", "group__sai__execution__status.html#gaf4892425930608ad7a41fa5b49603b10", null ],
[ "ARM_SAI_ERROR_DATA_SIZE", "group__sai__execution__status.html#ga5c51cbd8c2d2fe4baae110d390cefdc2", null ],
[ "ARM_SAI_ERROR_BIT_ORDER", "group__sai__execution__status.html#gadcd0d44f0f6b691c4e84b30960c096e4", null ],
[ "ARM_SAI_ERROR_MONO_MODE", "group__sai__execution__status.html#ga912bf004fce3a37709bbf69734802b4a", null ],
[ "ARM_SAI_ERROR_COMPANDING", "group__sai__execution__status.html#ga4683468c258e1a8706afcce1e81356d1", null ],
[ "ARM_SAI_ERROR_CLOCK_POLARITY", "group__sai__execution__status.html#ga7810e77ec599b0f86073a8711c0655df", null ],
[ "ARM_SAI_ERROR_AUDIO_FREQ", "group__sai__execution__status.html#ga5021651816da0aa92561eed634ba7578", null ],
[ "ARM_SAI_ERROR_MCLK_PIN", "group__sai__execution__status.html#ga0d910d4a638433e3b2326fc776da0f53", null ],
[ "ARM_SAI_ERROR_MCLK_PRESCALER", "group__sai__execution__status.html#gabab9495d6c57e56604cb1a2ac7e75431", null ],
[ "ARM_SAI_ERROR_FRAME_LENGHT", "group__sai__execution__status.html#gaf0448bdd6d1ae33511d170b9ecc1e2d6", null ],
[ "ARM_SAI_ERROR_FRAME_SYNC_WIDTH", "group__sai__execution__status.html#ga993da1bc0f6745795b364d84dec24e99", null ],
[ "ARM_SAI_ERROR_FRAME_SYNC_POLARITY", "group__sai__execution__status.html#ga0561b0cc9577d944e0d39b582612e061", null ],
[ "ARM_SAI_ERROR_FRAME_SYNC_EARLY", "group__sai__execution__status.html#ga09fe9b65d2be54ee1441606523291011", null ],
[ "ARM_SAI_ERROR_SLOT_COUNT", "group__sai__execution__status.html#gaf52ee0cd13b6cb9c63acfe767ed5dfde", null ],
[ "ARM_SAI_ERROR_SLOT_SIZE", "group__sai__execution__status.html#ga7bf825043ba857950a89817ff9b853d1", null ],
[ "ARM_SAI_ERROR_SLOT_OFFESET", "group__sai__execution__status.html#ga4658a3143c891d8972446630b6a978cd", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__execution__status.js | JavaScript | apache-2.0 | 2,024 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>SAI Frame</title>
<title>CMSIS-Driver: SAI Frame</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__sai__frame__control.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">SAI Frame<div class="ingroups"><a class="el" href="group__sai__configure__control.html">SAI Configuration</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines frame.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga4c557aa02c83b8595be23a6c58d284e9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__frame__control.html#ga4c557aa02c83b8595be23a6c58d284e9">ARM_SAI_FRAME_LENGTH</a>(n)   ((((n)-1)&0x3FFU) << ARM_SAI_FRAME_LENGTH_Pos)</td></tr>
<tr class="memdesc:ga4c557aa02c83b8595be23a6c58d284e9"><td class="mdescLeft"> </td><td class="mdescRight">Frame length in bits (8..1024); default depends on protocol and data. <a href="#ga4c557aa02c83b8595be23a6c58d284e9">More...</a><br/></td></tr>
<tr class="separator:ga4c557aa02c83b8595be23a6c58d284e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae165fd96e6a5b06b362954fadeabcb7a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__frame__control.html#gae165fd96e6a5b06b362954fadeabcb7a">ARM_SAI_FRAME_SYNC_WIDTH</a>(n)   ((((n)-1)&0xFFU) << ARM_SAI_FRAME_SYNC_WIDTH_Pos)</td></tr>
<tr class="memdesc:gae165fd96e6a5b06b362954fadeabcb7a"><td class="mdescLeft"> </td><td class="mdescRight">Frame Sync width in bits (1..256); default=1; User Protocol only (ignored otherwise) <a href="#gae165fd96e6a5b06b362954fadeabcb7a">More...</a><br/></td></tr>
<tr class="separator:gae165fd96e6a5b06b362954fadeabcb7a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7be0326e15d61d6c67febb22f5b14d58"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__frame__control.html#ga7be0326e15d61d6c67febb22f5b14d58">ARM_SAI_FRAME_SYNC_POLARITY_HIGH</a>   (0U << ARM_SAI_FRAME_SYNC_POLARITY_Pos)</td></tr>
<tr class="memdesc:ga7be0326e15d61d6c67febb22f5b14d58"><td class="mdescLeft"> </td><td class="mdescRight">Frame Sync is active high (default); User Protocol only (ignored otherwise) <a href="#ga7be0326e15d61d6c67febb22f5b14d58">More...</a><br/></td></tr>
<tr class="separator:ga7be0326e15d61d6c67febb22f5b14d58"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf3d6bdbc05379ac30905cecf1b2d917e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__frame__control.html#gaf3d6bdbc05379ac30905cecf1b2d917e">ARM_SAI_FRAME_SYNC_POLARITY_LOW</a>   (1U << ARM_SAI_FRAME_SYNC_POLARITY_Pos)</td></tr>
<tr class="memdesc:gaf3d6bdbc05379ac30905cecf1b2d917e"><td class="mdescLeft"> </td><td class="mdescRight">Frame Sync is active low; User Protocol only (ignored otherwise) <a href="#gaf3d6bdbc05379ac30905cecf1b2d917e">More...</a><br/></td></tr>
<tr class="separator:gaf3d6bdbc05379ac30905cecf1b2d917e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabec3992447436a2a8ed99108908ae208"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__frame__control.html#gabec3992447436a2a8ed99108908ae208">ARM_SAI_FRAME_SYNC_EARLY</a>   (1U << 19)</td></tr>
<tr class="memdesc:gabec3992447436a2a8ed99108908ae208"><td class="mdescLeft"> </td><td class="mdescRight">Frame Sync one bit before the first bit of the frame; User Protocol only (ignored otherwise) <a href="#gabec3992447436a2a8ed99108908ae208">More...</a><br/></td></tr>
<tr class="separator:gabec3992447436a2a8ed99108908ae208"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Defines frame. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga4c557aa02c83b8595be23a6c58d284e9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_FRAME_LENGTH</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">n</td><td>)</td>
<td>   ((((n)-1)&0x3FFU) << ARM_SAI_FRAME_LENGTH_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Frame length in bits (8..1024); default depends on protocol and data. </p>
</div>
</div>
<a class="anchor" id="gae165fd96e6a5b06b362954fadeabcb7a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_FRAME_SYNC_WIDTH</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">n</td><td>)</td>
<td>   ((((n)-1)&0xFFU) << ARM_SAI_FRAME_SYNC_WIDTH_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Frame Sync width in bits (1..256); default=1; User Protocol only (ignored otherwise) </p>
</div>
</div>
<a class="anchor" id="ga7be0326e15d61d6c67febb22f5b14d58"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_FRAME_SYNC_POLARITY_HIGH   (0U << ARM_SAI_FRAME_SYNC_POLARITY_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Frame Sync is active high (default); User Protocol only (ignored otherwise) </p>
</div>
</div>
<a class="anchor" id="gaf3d6bdbc05379ac30905cecf1b2d917e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_FRAME_SYNC_POLARITY_LOW   (1U << ARM_SAI_FRAME_SYNC_POLARITY_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Frame Sync is active low; User Protocol only (ignored otherwise) </p>
</div>
</div>
<a class="anchor" id="gabec3992447436a2a8ed99108908ae208"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_FRAME_SYNC_EARLY   (1U << 19)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Frame Sync one bit before the first bit of the frame; User Protocol only (ignored otherwise) </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__frame__control.html | HTML | apache-2.0 | 12,857 |
var group__sai__frame__control =
[
[ "ARM_SAI_FRAME_LENGTH", "group__sai__frame__control.html#ga4c557aa02c83b8595be23a6c58d284e9", null ],
[ "ARM_SAI_FRAME_SYNC_WIDTH", "group__sai__frame__control.html#gae165fd96e6a5b06b362954fadeabcb7a", null ],
[ "ARM_SAI_FRAME_SYNC_POLARITY_HIGH", "group__sai__frame__control.html#ga7be0326e15d61d6c67febb22f5b14d58", null ],
[ "ARM_SAI_FRAME_SYNC_POLARITY_LOW", "group__sai__frame__control.html#gaf3d6bdbc05379ac30905cecf1b2d917e", null ],
[ "ARM_SAI_FRAME_SYNC_EARLY", "group__sai__frame__control.html#gabec3992447436a2a8ed99108908ae208", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__frame__control.js | JavaScript | apache-2.0 | 607 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>SAI Interface</title>
<title>CMSIS-Driver: SAI Interface</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__sai__interface__gr.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Content</a> |
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">SAI Interface</div> </div>
</div><!--header-->
<div class="contents">
<p>Driver API for Serial Audio Interface (Driver_SAI.h)
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Content</h2></td></tr>
<tr class="memitem:group__sai__execution__status"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__execution__status.html">Status Error Codes</a></td></tr>
<tr class="memdesc:group__sai__execution__status"><td class="mdescLeft"> </td><td class="mdescRight">Negative values indicate errors (SAI has specific codes in addition to common <a class="el" href="group__execution__status.html">Status Error Codes</a>). <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__SAI__events"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SAI__events.html">SAI Events</a></td></tr>
<tr class="memdesc:group__SAI__events"><td class="mdescLeft"> </td><td class="mdescRight">The SAI driver generates call back events that are notified via the function <a class="el" href="group__sai__interface__gr.html#gaedf3347cb25d6bf2faad1bbb35ad79f4">ARM_SAI_SignalEvent</a>. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__sai__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__control.html">SAI Control Codes</a></td></tr>
<tr class="memdesc:group__sai__control"><td class="mdescLeft"> </td><td class="mdescRight">Many parameters of the SAI driver are configured using the <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> function. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:structARM__DRIVER__SAI"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#structARM__DRIVER__SAI">ARM_DRIVER_SAI</a></td></tr>
<tr class="memdesc:structARM__DRIVER__SAI"><td class="mdescLeft"> </td><td class="mdescRight">Access structure of the SAI Driver. <a href="group__sai__interface__gr.html#structARM__DRIVER__SAI">More...</a><br/></td></tr>
<tr class="separator:structARM__DRIVER__SAI"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__SAI__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#structARM__SAI__CAPABILITIES">ARM_SAI_CAPABILITIES</a></td></tr>
<tr class="memdesc:structARM__SAI__CAPABILITIES"><td class="mdescLeft"> </td><td class="mdescRight">SAI Driver Capabilities. <a href="group__sai__interface__gr.html#structARM__SAI__CAPABILITIES">More...</a><br/></td></tr>
<tr class="separator:structARM__SAI__CAPABILITIES"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__SAI__STATUS"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#structARM__SAI__STATUS">ARM_SAI_STATUS</a></td></tr>
<tr class="memdesc:structARM__SAI__STATUS"><td class="mdescLeft"> </td><td class="mdescRight">SAI Status. <a href="group__sai__interface__gr.html#structARM__SAI__STATUS">More...</a><br/></td></tr>
<tr class="separator:structARM__SAI__STATUS"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gad8ca8e2459e540928f6315b3df6da0ee"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#gad8ca8e2459e540928f6315b3df6da0ee">ARM_SAI_SignalEvent_t</a> )(uint32_t event)</td></tr>
<tr class="memdesc:gad8ca8e2459e540928f6315b3df6da0ee"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__sai__interface__gr.html#gaedf3347cb25d6bf2faad1bbb35ad79f4">ARM_SAI_SignalEvent</a> : Signal SAI Event. <a href="#gad8ca8e2459e540928f6315b3df6da0ee">More...</a><br/></td></tr>
<tr class="separator:gad8ca8e2459e540928f6315b3df6da0ee"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga786b1970a788a4dfc6156b42364e52f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#ga786b1970a788a4dfc6156b42364e52f8">ARM_SAI_GetVersion</a> (void)</td></tr>
<tr class="memdesc:ga786b1970a788a4dfc6156b42364e52f8"><td class="mdescLeft"> </td><td class="mdescRight">Get driver version. <a href="#ga786b1970a788a4dfc6156b42364e52f8">More...</a><br/></td></tr>
<tr class="separator:ga786b1970a788a4dfc6156b42364e52f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac6c636757944eaf25aebf312a67665aa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__sai__interface__gr.html#structARM__SAI__CAPABILITIES">ARM_SAI_CAPABILITIES</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#gac6c636757944eaf25aebf312a67665aa">ARM_SAI_GetCapabilities</a> (void)</td></tr>
<tr class="memdesc:gac6c636757944eaf25aebf312a67665aa"><td class="mdescLeft"> </td><td class="mdescRight">Get driver capabilities. <a href="#gac6c636757944eaf25aebf312a67665aa">More...</a><br/></td></tr>
<tr class="separator:gac6c636757944eaf25aebf312a67665aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga89622a02ca1e7affb1a01eefacb6f54c"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#ga89622a02ca1e7affb1a01eefacb6f54c">ARM_SAI_Initialize</a> (<a class="el" href="group__sai__interface__gr.html#gad8ca8e2459e540928f6315b3df6da0ee">ARM_SAI_SignalEvent_t</a> cb_event)</td></tr>
<tr class="memdesc:ga89622a02ca1e7affb1a01eefacb6f54c"><td class="mdescLeft"> </td><td class="mdescRight">Initialize SAI Interface. <a href="#ga89622a02ca1e7affb1a01eefacb6f54c">More...</a><br/></td></tr>
<tr class="separator:ga89622a02ca1e7affb1a01eefacb6f54c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabdefafaba6f072cfd7ed6f8f132422b6"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#gabdefafaba6f072cfd7ed6f8f132422b6">ARM_SAI_Uninitialize</a> (void)</td></tr>
<tr class="memdesc:gabdefafaba6f072cfd7ed6f8f132422b6"><td class="mdescLeft"> </td><td class="mdescRight">De-initialize SAI Interface. <a href="#gabdefafaba6f072cfd7ed6f8f132422b6">More...</a><br/></td></tr>
<tr class="separator:gabdefafaba6f072cfd7ed6f8f132422b6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacdec50a3dd5902de601caa7397c1dabc"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#gacdec50a3dd5902de601caa7397c1dabc">ARM_SAI_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:gacdec50a3dd5902de601caa7397c1dabc"><td class="mdescLeft"> </td><td class="mdescRight">Control SAI Interface Power. <a href="#gacdec50a3dd5902de601caa7397c1dabc">More...</a><br/></td></tr>
<tr class="separator:gacdec50a3dd5902de601caa7397c1dabc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8bb6866c535adeb930bc4a847d476fcd"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd">ARM_SAI_Send</a> (const void *data, uint32_t num)</td></tr>
<tr class="memdesc:ga8bb6866c535adeb930bc4a847d476fcd"><td class="mdescLeft"> </td><td class="mdescRight">Start sending data to SAI transmitter. <a href="#ga8bb6866c535adeb930bc4a847d476fcd">More...</a><br/></td></tr>
<tr class="separator:ga8bb6866c535adeb930bc4a847d476fcd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2d55f506cef9d2849cbe418146086d98"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98">ARM_SAI_Receive</a> (void *data, uint32_t num)</td></tr>
<tr class="memdesc:ga2d55f506cef9d2849cbe418146086d98"><td class="mdescLeft"> </td><td class="mdescRight">Start receiving data from SAI receiver. <a href="#ga2d55f506cef9d2849cbe418146086d98">More...</a><br/></td></tr>
<tr class="separator:ga2d55f506cef9d2849cbe418146086d98"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa9805f9d32aee205f787e625a58e8898"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#gaa9805f9d32aee205f787e625a58e8898">ARM_SAI_GetTxCount</a> (void)</td></tr>
<tr class="memdesc:gaa9805f9d32aee205f787e625a58e8898"><td class="mdescLeft"> </td><td class="mdescRight">Get transmitted data count. <a href="#gaa9805f9d32aee205f787e625a58e8898">More...</a><br/></td></tr>
<tr class="separator:gaa9805f9d32aee205f787e625a58e8898"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2c571fcc8b9632c25a64043bc2b2baec"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#ga2c571fcc8b9632c25a64043bc2b2baec">ARM_SAI_GetRxCount</a> (void)</td></tr>
<tr class="memdesc:ga2c571fcc8b9632c25a64043bc2b2baec"><td class="mdescLeft"> </td><td class="mdescRight">Get received data count. <a href="#ga2c571fcc8b9632c25a64043bc2b2baec">More...</a><br/></td></tr>
<tr class="separator:ga2c571fcc8b9632c25a64043bc2b2baec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga405a0769c33da6801055db0fb9b6c869"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> (uint32_t control, uint32_t arg1, uint32_t arg2)</td></tr>
<tr class="memdesc:ga405a0769c33da6801055db0fb9b6c869"><td class="mdescLeft"> </td><td class="mdescRight">Control SAI Interface. <a href="#ga405a0769c33da6801055db0fb9b6c869">More...</a><br/></td></tr>
<tr class="separator:ga405a0769c33da6801055db0fb9b6c869"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6a202b57697f0f7a9742e76b33d5eeec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__sai__interface__gr.html#structARM__SAI__STATUS">ARM_SAI_STATUS</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#ga6a202b57697f0f7a9742e76b33d5eeec">ARM_SAI_GetStatus</a> (void)</td></tr>
<tr class="memdesc:ga6a202b57697f0f7a9742e76b33d5eeec"><td class="mdescLeft"> </td><td class="mdescRight">Get SAI status. <a href="#ga6a202b57697f0f7a9742e76b33d5eeec">More...</a><br/></td></tr>
<tr class="separator:ga6a202b57697f0f7a9742e76b33d5eeec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaedf3347cb25d6bf2faad1bbb35ad79f4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#gaedf3347cb25d6bf2faad1bbb35ad79f4">ARM_SAI_SignalEvent</a> (uint32_t event)</td></tr>
<tr class="memdesc:gaedf3347cb25d6bf2faad1bbb35ad79f4"><td class="mdescLeft"> </td><td class="mdescRight">Signal SAI Events. <a href="#gaedf3347cb25d6bf2faad1bbb35ad79f4">More...</a><br/></td></tr>
<tr class="separator:gaedf3347cb25d6bf2faad1bbb35ad79f4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Driver API for Serial Audio Interface (Driver_SAI.h) </p>
<p>The <b>Serial Audio Interface</b> (SAI) implements a synchronous serial bus interface for connecting digital audio devices. It is by far the most common mechanism used to transfer two channels of audio data between devices within a system. <b>SAI</b> can transfer digital audio using various protocols:</p>
<ul>
<li><a class="el" href="group__sai__interface__gr.html#Driver_SAI_I2S">I2S</a></li>
<li><a class="el" href="group__sai__interface__gr.html#Driver_SAI_MSB">MSB Justified</a></li>
<li><a class="el" href="group__sai__interface__gr.html#Driver_SAI_LSB">LSB Justified</a></li>
<li><a class="el" href="group__sai__interface__gr.html#Driver_SAI_PCM">PCM</a></li>
<li><a class="el" href="group__sai__interface__gr.html#Driver_SAI_AC97">AC'97</a></li>
<li><a class="el" href="group__sai__interface__gr.html#Driver_SAI_User">User Defined Protocol</a></li>
</ul>
<p><b>Block Diagram</b></p>
<p> </p>
<div class="image">
<img src="SAI_Schematics.png" alt="SAI_Schematics.png"/>
<div class="caption">
Simplified SAI Schematic</div></div>
<p> </p>
<p><b>SAI API</b></p>
<p>The following header files define the Application Programming Interface (API) for the SAI interface:</p>
<ul>
<li><b>Driver_SAI.h</b> : Driver API for Serial Audio Interface</li>
</ul>
<p>The driver implementation is a typical part of the <a href="../../Pack/html/index.html" class="el" target="_blank">Device Family Pack (DFP)</a> that supports the peripherals of the microcontroller family.</p>
<p><b>Driver Functions</b></p>
<p>The driver functions are published in the access struct as explained in <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a></p>
<ul>
<li><a class="el" href="group__sai__interface__gr.html#structARM__DRIVER__SAI">ARM_DRIVER_SAI</a> : access struct for SAI driver functions</li>
</ul>
<h1><a class="anchor" id="Driver_SAI_I2S"></a>
I2S</h1>
<p><a href="https://en.wikipedia.org/wiki/I%C2%B2S" target="_blank">Integrated Interchip Sound</a> (<b>I2S</b>) is a serial bus interface that connects digital audio devices together. It was introduced by Philips (now <a href="http://www.nxp.com" target="_blank">NXP</a>) in the late 80's and last revised 1996. It uses pulse code modulation to exchange the audio data between the devices. The following timing diagram explains the operation:</p>
<div class="image">
<img src="driver_sai_i2s.png" alt="driver_sai_i2s.png"/>
</div>
<p>I2S separates the clock (<b>SCK</b>) from the serial data (<b>SD</b>), resulting in a lower jitter. A complete audio data frame consists of two slots, one for the left channel and one for the right. The slot size equals the data size. The word select (<b>WS</b>) line lets the device know whether the left channel (WS is low) or the right channel (WS is high) is currently being transmitted. WS has a 50% duty-cycle signal that has the same frequency as the sample frequency. It is an early signal, meaning that the WS line changes one clock cycle before the actual data (SD) is transmitted (left or right). The data on SD is always transmitted MSB first and can have a data size of 8 up to 32 bits.</p>
<p>In terms of the CMSIS-Driver for SAI, the I2S protocol can be described as follows:</p>
<ul>
<li>Data Size: 8..32 (MSB first)</li>
<li>Clock Polarity: Drive on falling edge, Capture on rising edge</li>
<li>Frame Length: 2 * Data Size = 2 * Slot Size</li>
<li>Frame Sync Width: Frame Length / 2</li>
<li>Frame Sync Polarity: Active Low</li>
<li>Frame Sync Early</li>
<li>Slot Count: 2 (L R)</li>
<li>Slot Size: Data Size</li>
<li>Slot Offset: 0</li>
</ul>
<h1><a class="anchor" id="Driver_SAI_MSB"></a>
MSB Justified</h1>
<p><b>MSB</b> <b>Justified</b> is much like <a class="el" href="group__sai__interface__gr.html#Driver_SAI_I2S">I2S</a>, with a few differences:</p>
<div class="image">
<img src="driver_sai_msb.png" alt="driver_sai_msb.png"/>
</div>
<p>Unlike I2S, in MSB Justified the word select (<b>WS</b>) signals the left channel when it is active high and the right channel, when it is active low. The signal changes when the first actual <b>SD</b> data is available. It might happen that a frame (left or right) is not fully filled with data. In this case, all data after the LSB is forced to zero.</p>
<p>In terms of the CMSIS-Driver for SAI, the MSB Justified protocol can be described as follows:</p>
<ul>
<li>Data Size: 8..32 (MSB first)</li>
<li>Clock Polarity: Drive on falling edge, Capture on rising edge</li>
<li>Frame Length: 2 * Slot Size</li>
<li>Frame Sync Width: Frame Length / 2</li>
<li>Frame Sync Polarity: Active High</li>
<li>Slot Count: 2 (L R)</li>
<li>Slot Size: Data Size or higher (16/32)</li>
<li>Slot Offset: 0 (Zero padding after Data: Slot Size - Data Size)</li>
</ul>
<h1><a class="anchor" id="Driver_SAI_LSB"></a>
LSB Justified</h1>
<p><b>LSB</b> <b>Justified</b> is much like <a class="el" href="group__sai__interface__gr.html#Driver_SAI_MSB">MSB Justified</a>, with the single difference that the padding 0's are sent before the first actual data (MSB on <b>SD</b>):</p>
<div class="image">
<img src="driver_sai_lsb.png" alt="driver_sai_lsb.png"/>
</div>
<p>In terms of the CMSIS-Driver for SAI, the LSB Justified protocol can be described as follows:</p>
<ul>
<li>Data Size: 8..32 (MSB first)</li>
<li>Clock Polarity: Drive on falling edge, Capture on rising edge</li>
<li>Frame Length: 2*Slot Size</li>
<li>Frame Sync Width: Frame Length / 2</li>
<li>Frame Sync Polarity: Active High</li>
<li>Slot Count: 2</li>
<li>Slot Size: Data Size or higher (16/32)</li>
<li>Slot Offset: Slot Size - Data Size (Zero padding before Data: Slot Size - Data Size)</li>
</ul>
<h1><a class="anchor" id="Driver_SAI_PCM"></a>
PCM</h1>
<p><a href="https://en.wikipedia.org/wiki/Pulse-code_modulation" target="_blank">Pulse Code Modulation</a> (<b>PCM</b>) differs to the previous protocols in a few ways:</p>
<div class="image">
<img src="driver_sai_pcm.png" alt="driver_sai_pcm.png"/>
</div>
<ul>
<li>Only one channel is transferred.</li>
<li>There are two types of synchronization modes available:<ul>
<li>In <b>short</b> <b>frame</b> sync mode, the falling edge of <b>Frame</b> <b>Sync</b> indicates the start of the serial data <b>SD</b>. <b>Frame</b> <b>Sync</b> is always one clock cycle long.</li>
<li>In <b>long</b> <b>frame</b> sync mode, the rising edge of <b>Frame</b> <b>Sync</b> indicates the start of the serial data <b>SD</b>. <b>Frame</b> <b>Sync</b> stays active high for 13 clock cycles.</li>
</ul>
</li>
</ul>
<p>In terms of the CMSIS-Driver for SAI, the PCM protocol can be described as follows:<br/>
<b>PCM</b> <b>Short</b> <b>Frame</b> </p>
<ul>
<li>Data Size: 8..32 (MSB first)</li>
<li>Clock Polarity: Drive on falling edge, Capture on rising edge</li>
<li>Frame Length: Slot Size</li>
<li>Frame Sync Width: 1</li>
<li>Frame Sync Polarity: Active High</li>
<li>Frame Sync Early</li>
<li>Slot Count: 1</li>
<li>Slot Size: Data Size or higher (16/32)</li>
<li>Slot Offset: 0</li>
</ul>
<p><b>PCM</b> <b>Long</b> <b>Frame</b> </p>
<ul>
<li>Data Size: 16..32 (MSB first)</li>
<li>Clock Polarity: Drive on falling edge, Capture on rising edge</li>
<li>Frame Length: Slot Size</li>
<li>Frame Sync Width: 13</li>
<li>Frame Sync Polarity: Active High</li>
<li>Slot Count: 1</li>
<li>Slot Size: Data Size or higher (32)</li>
<li>Slot Offset: 0</li>
</ul>
<h1><a class="anchor" id="Driver_SAI_AC97"></a>
AC'97</h1>
<p><a href="https://en.wikipedia.org/wiki/AC'97" target="_blank">Audio Codec '97</a> was developed by <a href="http://www.intel.com" target="_blank">Intel</a>. It is composed of five wires: the clock (12.288 MHz), a sync signal, a reset signal, and two data wires: sdata_out (contains the AC97 output) and sdata_in (contains the CODEC output). For more information, consult the <a href="http://www-inst.eecs.berkeley.edu/~cs150/Documents/ac97_r23.pdf" target="_blank">standard documentation</a>.</p>
<h1><a class="anchor" id="Driver_SAI_User"></a>
User Defined Protocol</h1>
<p>Using the control structs of the CMSIS-Driver SAI, it is possible to create support for nearly all serial audio protocols that are available today.</p>
<div class="image">
<img src="driver_sai_user.png" alt="driver_sai_user.png"/>
</div>
<p>The following properties can be configured for a user protocol:</p>
<ul>
<li>Data Size in bits (8..32)</li>
<li>Data Bit Order: MSB first (default) or LSB first</li>
<li>Clock Polarity:<ul>
<li>Driver on falling edge, Capture on rising edge (default)</li>
<li>Driver on rising edge, Capture on falling edge</li>
</ul>
</li>
<li>Frame Length in bits</li>
<li>Frame Sync Width in bits (default=1)</li>
<li>Frame Sync Polarity: active high (default) or low</li>
<li>Frame Sync Early: Sync signal one bit before the first bit of frame</li>
<li>Slot Count: number of slots in frame (default=1)</li>
<li>Slot Size: equal to data size (default) or 16 or 32-bit</li>
<li>Slot Offset: offset of first data bit in slot (default=0)</li>
</ul>
<p>For more information, refer to <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> that explains the different configuration options in more detail. </p>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structARM__DRIVER__SAI" id="structARM__DRIVER__SAI"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_DRIVER_SAI</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Access structure of the SAI Driver. </p>
<p>The functions of the SAI driver are accessed by function pointers exposed by this structure. Refer to <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a> for overview information.</p>
<p>Each instance of an SAI interface provides such an access structure. The instance is identified by a postfix number in the symbol name of the access structure, for example:</p>
<ul>
<li><b>Driver_SAI0</b> is the name of the access struct of the first instance (no. 0).</li>
<li><b>Driver_SAI1</b> is the name of the access struct of the second instance (no. 1).</li>
</ul>
<p>A middleware configuration setting allows connecting the middleware to a specific driver instance <b>Driver_SAI<em>n</em></b>. The default is <span class="XML-Token">0</span>, which connects a middleware to the first instance of a driver. </p>
</div><table class="memberdecls">
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
<tr class="memitem:a8834b281da48583845c044a81566c1b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#a8834b281da48583845c044a81566c1b3">GetVersion</a> )(void)</td></tr>
<tr class="memdesc:a8834b281da48583845c044a81566c1b3"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__sai__interface__gr.html#ga786b1970a788a4dfc6156b42364e52f8">ARM_SAI_GetVersion</a> : Get driver version. <a href="#a8834b281da48583845c044a81566c1b3">More...</a><br/></td></tr>
<tr class="separator:a8834b281da48583845c044a81566c1b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7e230744b9898cabf80ee6f2595569f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__sai__interface__gr.html#structARM__SAI__CAPABILITIES">ARM_SAI_CAPABILITIES</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#a7e230744b9898cabf80ee6f2595569f6">GetCapabilities</a> )(void)</td></tr>
<tr class="memdesc:a7e230744b9898cabf80ee6f2595569f6"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__sai__interface__gr.html#gac6c636757944eaf25aebf312a67665aa">ARM_SAI_GetCapabilities</a> : Get driver capabilities. <a href="#a7e230744b9898cabf80ee6f2595569f6">More...</a><br/></td></tr>
<tr class="separator:a7e230744b9898cabf80ee6f2595569f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54a38e78d5fd7ca0d37174c81ec01731"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#a54a38e78d5fd7ca0d37174c81ec01731">Initialize</a> )(<a class="el" href="group__sai__interface__gr.html#gad8ca8e2459e540928f6315b3df6da0ee">ARM_SAI_SignalEvent_t</a> cb_event)</td></tr>
<tr class="memdesc:a54a38e78d5fd7ca0d37174c81ec01731"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__sai__interface__gr.html#ga89622a02ca1e7affb1a01eefacb6f54c">ARM_SAI_Initialize</a> : Initialize SAI Interface. <a href="#a54a38e78d5fd7ca0d37174c81ec01731">More...</a><br/></td></tr>
<tr class="separator:a54a38e78d5fd7ca0d37174c81ec01731"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adcf20681a1402869ecb5c6447fada17b"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#adcf20681a1402869ecb5c6447fada17b">Uninitialize</a> )(void)</td></tr>
<tr class="memdesc:adcf20681a1402869ecb5c6447fada17b"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__sai__interface__gr.html#gabdefafaba6f072cfd7ed6f8f132422b6">ARM_SAI_Uninitialize</a> : De-initialize SAI Interface. <a href="#adcf20681a1402869ecb5c6447fada17b">More...</a><br/></td></tr>
<tr class="separator:adcf20681a1402869ecb5c6447fada17b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba8f1c8019af95ffe19c32403e3240ef"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> )(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:aba8f1c8019af95ffe19c32403e3240ef"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__sai__interface__gr.html#gacdec50a3dd5902de601caa7397c1dabc">ARM_SAI_PowerControl</a> : Control SAI Interface Power. <a href="#aba8f1c8019af95ffe19c32403e3240ef">More...</a><br/></td></tr>
<tr class="separator:aba8f1c8019af95ffe19c32403e3240ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a44eedddf4428cf4b98883b6c27d31922"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#a44eedddf4428cf4b98883b6c27d31922">Send</a> )(const void *data, uint32_t num)</td></tr>
<tr class="memdesc:a44eedddf4428cf4b98883b6c27d31922"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd">ARM_SAI_Send</a> : Start sending data to SAI Interface. <a href="#a44eedddf4428cf4b98883b6c27d31922">More...</a><br/></td></tr>
<tr class="separator:a44eedddf4428cf4b98883b6c27d31922"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb9224a35fe16c92eb0dd103638e4cf3"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#adb9224a35fe16c92eb0dd103638e4cf3">Receive</a> )(void *data, uint32_t num)</td></tr>
<tr class="memdesc:adb9224a35fe16c92eb0dd103638e4cf3"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98">ARM_SAI_Receive</a> : Start receiving data from SAI Interface. <a href="#adb9224a35fe16c92eb0dd103638e4cf3">More...</a><br/></td></tr>
<tr class="separator:adb9224a35fe16c92eb0dd103638e4cf3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b28b2c21016702f50c28655653099df"><td class="memItemLeft" align="right" valign="top">uint32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#a0b28b2c21016702f50c28655653099df">GetTxCount</a> )(void)</td></tr>
<tr class="memdesc:a0b28b2c21016702f50c28655653099df"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__sai__interface__gr.html#gaa9805f9d32aee205f787e625a58e8898">ARM_SAI_GetTxCount</a> : Get transmitted data count. <a href="#a0b28b2c21016702f50c28655653099df">More...</a><br/></td></tr>
<tr class="separator:a0b28b2c21016702f50c28655653099df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a758c7822edf6ac18f82eb33c9dc09d71"><td class="memItemLeft" align="right" valign="top">uint32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#a758c7822edf6ac18f82eb33c9dc09d71">GetRxCount</a> )(void)</td></tr>
<tr class="memdesc:a758c7822edf6ac18f82eb33c9dc09d71"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__sai__interface__gr.html#ga2c571fcc8b9632c25a64043bc2b2baec">ARM_SAI_GetRxCount</a> : Get received data count. <a href="#a758c7822edf6ac18f82eb33c9dc09d71">More...</a><br/></td></tr>
<tr class="separator:a758c7822edf6ac18f82eb33c9dc09d71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a80455fc2c7355b1850098710fd66a244"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#a80455fc2c7355b1850098710fd66a244">Control</a> )(uint32_t control, uint32_t arg1, uint32_t arg2)</td></tr>
<tr class="memdesc:a80455fc2c7355b1850098710fd66a244"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> : Control SAI Interface. <a href="#a80455fc2c7355b1850098710fd66a244">More...</a><br/></td></tr>
<tr class="separator:a80455fc2c7355b1850098710fd66a244"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a310d55d55bd7c6b0393d43bb994db708"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__sai__interface__gr.html#structARM__SAI__STATUS">ARM_SAI_STATUS</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__interface__gr.html#a310d55d55bd7c6b0393d43bb994db708">GetStatus</a> )(void)</td></tr>
<tr class="memdesc:a310d55d55bd7c6b0393d43bb994db708"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__sai__interface__gr.html#ga6a202b57697f0f7a9742e76b33d5eeec">ARM_SAI_GetStatus</a> : Get SAI status. <a href="#a310d55d55bd7c6b0393d43bb994db708">More...</a><br/></td></tr>
<tr class="separator:a310d55d55bd7c6b0393d43bb994db708"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h4 class="groupheader">Field Documentation</h4>
<a class="anchor" id="a8834b281da48583845c044a81566c1b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* GetVersion)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__sai__interface__gr.html#ga786b1970a788a4dfc6156b42364e52f8">ARM_SAI_GetVersion</a> : Get driver version. </p>
</div>
</div>
<a class="anchor" id="a7e230744b9898cabf80ee6f2595569f6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__sai__interface__gr.html#structARM__SAI__CAPABILITIES">ARM_SAI_CAPABILITIES</a>(* GetCapabilities)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__sai__interface__gr.html#gac6c636757944eaf25aebf312a67665aa">ARM_SAI_GetCapabilities</a> : Get driver capabilities. </p>
</div>
</div>
<a class="anchor" id="a54a38e78d5fd7ca0d37174c81ec01731"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Initialize)(<a class="el" href="group__sai__interface__gr.html#gad8ca8e2459e540928f6315b3df6da0ee">ARM_SAI_SignalEvent_t</a> cb_event)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__sai__interface__gr.html#ga89622a02ca1e7affb1a01eefacb6f54c">ARM_SAI_Initialize</a> : Initialize SAI Interface. </p>
</div>
</div>
<a class="anchor" id="adcf20681a1402869ecb5c6447fada17b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Uninitialize)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__sai__interface__gr.html#gabdefafaba6f072cfd7ed6f8f132422b6">ARM_SAI_Uninitialize</a> : De-initialize SAI Interface. </p>
</div>
</div>
<a class="anchor" id="aba8f1c8019af95ffe19c32403e3240ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* PowerControl)(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__sai__interface__gr.html#gacdec50a3dd5902de601caa7397c1dabc">ARM_SAI_PowerControl</a> : Control SAI Interface Power. </p>
</div>
</div>
<a class="anchor" id="a44eedddf4428cf4b98883b6c27d31922"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Send)(const void *data, uint32_t num)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd">ARM_SAI_Send</a> : Start sending data to SAI Interface. </p>
</div>
</div>
<a class="anchor" id="adb9224a35fe16c92eb0dd103638e4cf3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Receive)(void *data, uint32_t num)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98">ARM_SAI_Receive</a> : Start receiving data from SAI Interface. </p>
</div>
</div>
<a class="anchor" id="a0b28b2c21016702f50c28655653099df"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t(* GetTxCount)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__sai__interface__gr.html#gaa9805f9d32aee205f787e625a58e8898">ARM_SAI_GetTxCount</a> : Get transmitted data count. </p>
</div>
</div>
<a class="anchor" id="a758c7822edf6ac18f82eb33c9dc09d71"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t(* GetRxCount)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__sai__interface__gr.html#ga2c571fcc8b9632c25a64043bc2b2baec">ARM_SAI_GetRxCount</a> : Get received data count. </p>
</div>
</div>
<a class="anchor" id="a80455fc2c7355b1850098710fd66a244"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Control)(uint32_t control, uint32_t arg1, uint32_t arg2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> : Control SAI Interface. </p>
</div>
</div>
<a class="anchor" id="a310d55d55bd7c6b0393d43bb994db708"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__sai__interface__gr.html#structARM__SAI__STATUS">ARM_SAI_STATUS</a>(* GetStatus)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__sai__interface__gr.html#ga6a202b57697f0f7a9742e76b33d5eeec">ARM_SAI_GetStatus</a> : Get SAI status. </p>
</div>
</div>
</div>
</div>
<a name="structARM__SAI__CAPABILITIES" id="structARM__SAI__CAPABILITIES"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_SAI_CAPABILITIES</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>SAI Driver Capabilities. </p>
<p>An SAI driver can be implemented with different capabilities (for example protocol support). The data fields of this structure encode the capabilities implemented by this driver. If a certain hardware peripheral is not able to handle one of the protocols directly (not advertised using <a class="el" href="group__sai__interface__gr.html#structARM__SAI__CAPABILITIES" title="SAI Driver Capabilities. ">ARM_SAI_CAPABILITIES</a>), then it might be possible to implement it using the <a class="el" href="group__sai__interface__gr.html#Driver_SAI_User">User Defined Protocol</a> (if supported).</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__sai__interface__gr.html#gac6c636757944eaf25aebf312a67665aa">ARM_SAI_GetCapabilities</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a75ba2507ea29601a309393e794f4413d"></a>uint32_t</td>
<td class="fieldname">
asynchronous: 1</td>
<td class="fielddoc">
supports asynchronous Transmit/Receive </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a9fa4f850b8ce2be2c7ffa2e3ec70ae20"></a>uint32_t</td>
<td class="fieldname">
synchronous: 1</td>
<td class="fielddoc">
supports synchronous Transmit/Receive </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a808b1f9e0abc3fa67945899cfc9fccc1"></a>uint32_t</td>
<td class="fieldname">
protocol_user: 1</td>
<td class="fielddoc">
supports user defined Protocol </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a6fcb9d68c4999860ce162c0ef44c4c97"></a>uint32_t</td>
<td class="fieldname">
protocol_i2s: 1</td>
<td class="fielddoc">
supports I2S Protocol </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a5363ec1fc0042620cb8aeeee4f98691b"></a>uint32_t</td>
<td class="fieldname">
protocol_justified: 1</td>
<td class="fielddoc">
supports MSB/LSB justified Protocol </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a0b2c79bd96ecb47d801fc5389819314a"></a>uint32_t</td>
<td class="fieldname">
protocol_pcm: 1</td>
<td class="fielddoc">
supports PCM short/long frame Protocol </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a5255f8d78a18ace0a959f604f9c065dd"></a>uint32_t</td>
<td class="fieldname">
protocol_ac97: 1</td>
<td class="fielddoc">
supports AC'97 Protocol </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a8d92817d8662211abda2d747c52ff4a9"></a>uint32_t</td>
<td class="fieldname">
mono_mode: 1</td>
<td class="fielddoc">
supports Mono mode </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a77e4d8466d2bde30e6583b9ad8ba8c82"></a>uint32_t</td>
<td class="fieldname">
companding: 1</td>
<td class="fielddoc">
supports Companding </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a12554e2522a0c611e8a26c9e536554eb"></a>uint32_t</td>
<td class="fieldname">
mclk_pin: 1</td>
<td class="fielddoc">
supports MCLK (Master Clock) pin </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="acc06ba75f18af9862d171426abc3273e"></a>uint32_t</td>
<td class="fieldname">
event_frame_error: 1</td>
<td class="fielddoc">
supports Frame error event: <a class="el" href="group__SAI__events.html#ga6ffcf96fe404b48421a57fbd122b26bc">ARM_SAI_EVENT_FRAME_ERROR</a> </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 21</td>
<td class="fielddoc">
Reserved (must be zero) </td></tr>
</table>
</div>
</div>
<a name="structARM__SAI__STATUS" id="structARM__SAI__STATUS"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_SAI_STATUS</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>SAI Status. </p>
<p>Structure with information about the status of the SAI. The data fields encode busy flags and error flags.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__sai__interface__gr.html#ga6a202b57697f0f7a9742e76b33d5eeec">ARM_SAI_GetStatus</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a2c6d2b67fba3f3e084e96a6bc7fcac6b"></a>uint32_t</td>
<td class="fieldname">
tx_busy: 1</td>
<td class="fielddoc">
Transmitter busy flag. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a9f5baee58ed41b382628a82a0b1cbcb4"></a>uint32_t</td>
<td class="fieldname">
rx_busy: 1</td>
<td class="fielddoc">
Receiver busy flag. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a048f45e9d2257a21821f81d9edd17b72"></a>uint32_t</td>
<td class="fieldname">
tx_underflow: 1</td>
<td class="fielddoc">
Transmit data underflow detected (cleared on start of next send operation) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ac403aefd9bce8b0172e1996c0f3dd8aa"></a>uint32_t</td>
<td class="fieldname">
rx_overflow: 1</td>
<td class="fielddoc">
Receive data overflow detected (cleared on start of next receive operation) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a1b4f69a2caf19ef9fd75cf27ae3932f9"></a>uint32_t</td>
<td class="fieldname">
frame_error: 1</td>
<td class="fielddoc">
Sync Frame error detected (cleared on start of next send/receive operation) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 27</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gad8ca8e2459e540928f6315b3df6da0ee"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ARM_SAI_SignalEvent_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__sai__interface__gr.html#gaedf3347cb25d6bf2faad1bbb35ad79f4">ARM_SAI_SignalEvent</a> : Signal SAI Event. </p>
<p>Provides the typedef for the callback function <a class="el" href="group__sai__interface__gr.html#gaedf3347cb25d6bf2faad1bbb35ad79f4">ARM_SAI_SignalEvent</a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__sai__interface__gr.html#ga89622a02ca1e7affb1a01eefacb6f54c">ARM_SAI_Initialize</a> </li>
</ul>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga786b1970a788a4dfc6156b42364e52f8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> ARM_SAI_GetVersion </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get driver version. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></dd></dl>
<p>The function <b>ARM_SAI_GetVersion</b> returns version information of the driver implementation in <a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></p>
<ul>
<li>API version is the version of the CMSIS-Driver specification used to implement this driver.</li>
<li>Driver version is source code version of the actual driver implementation.</li>
</ul>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__sai__interface__gr.html#structARM__DRIVER__SAI">ARM_DRIVER_SAI</a> Driver_SAI0;</div>
<div class="line"><a class="code" href="group__sai__interface__gr.html#structARM__DRIVER__SAI">ARM_DRIVER_SAI</a> *drv_info;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> setup_sai (<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> version;</div>
<div class="line"> </div>
<div class="line"> drv_info = &Driver_SAI0; </div>
<div class="line"> version = drv_info-><a class="code" href="group__sai__interface__gr.html#a8834b281da48583845c044a81566c1b3">GetVersion</a> ();</div>
<div class="line"> <span class="keywordflow">if</span> (version.<a class="code" href="group__common__drv__gr.html#ad180da20fbde1d3dafc074af87c19540">api</a> < 0x10A) { <span class="comment">// requires at minimum API version 1.10 or higher</span></div>
<div class="line"> <span class="comment">// error handling</span></div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="gac6c636757944eaf25aebf312a67665aa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__sai__interface__gr.html#structARM__SAI__CAPABILITIES">ARM_SAI_CAPABILITIES</a> ARM_SAI_GetCapabilities </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get driver capabilities. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__sai__interface__gr.html#structARM__SAI__CAPABILITIES">ARM_SAI_CAPABILITIES</a></dd></dl>
<p>The function <b>ARM_SAI_GetCapabilities</b> retrieves information about the capabilities in this driver implementation. The data fields of the struct <a class="el" href="group__sai__interface__gr.html#structARM__SAI__CAPABILITIES">ARM_SAI_CAPABILITIES</a> encode various capabilities, for example supported protocols, or if a hardware is capable to create signal events using the <a class="el" href="group__sai__interface__gr.html#gaedf3347cb25d6bf2faad1bbb35ad79f4">ARM_SAI_SignalEvent</a> callback function.</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__sai__interface__gr.html#structARM__DRIVER__SAI">ARM_DRIVER_SAI</a> Driver_SAI0;</div>
<div class="line"><a class="code" href="group__sai__interface__gr.html#structARM__DRIVER__SAI">ARM_DRIVER_SAI</a> *drv_info;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> read_capabilities (<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__sai__interface__gr.html#structARM__SAI__CAPABILITIES">ARM_SAI_CAPABILITIES</a> drv_capabilities;</div>
<div class="line"> </div>
<div class="line"> drv_info = &Driver_SAI0; </div>
<div class="line"> drv_capabilities = drv_info-><a class="code" href="group__sai__interface__gr.html#a7e230744b9898cabf80ee6f2595569f6">GetCapabilities</a> ();</div>
<div class="line"> <span class="comment">// interrogate capabilities</span></div>
<div class="line"> </div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga89622a02ca1e7affb1a01eefacb6f54c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_SAI_Initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__sai__interface__gr.html#gad8ca8e2459e540928f6315b3df6da0ee">ARM_SAI_SignalEvent_t</a> </td>
<td class="paramname"><em>cb_event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize SAI Interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cb_event</td><td>Pointer to <a class="el" href="group__sai__interface__gr.html#gaedf3347cb25d6bf2faad1bbb35ad79f4">ARM_SAI_SignalEvent</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_SAI_Initialize</b> initializes the SAI interface. It is called when the middleware component starts operation.</p>
<p>The function performs the following operations:</p>
<ul>
<li>Initializes the required resources of the SAI interface.</li>
<li>Registers the <a class="el" href="group__sai__interface__gr.html#gaedf3347cb25d6bf2faad1bbb35ad79f4">ARM_SAI_SignalEvent</a> callback function.</li>
</ul>
<p>The parameter <em>cb_event</em> is a pointer to the <a class="el" href="group__sai__interface__gr.html#gaedf3347cb25d6bf2faad1bbb35ad79f4">ARM_SAI_SignalEvent</a> callback function; use a NULL pointer when no callback signals are required. </p>
</div>
</div>
<a class="anchor" id="gabdefafaba6f072cfd7ed6f8f132422b6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_SAI_Uninitialize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>De-initialize SAI Interface. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_SAI_Uninitialize</b> de-initializes the resources of SAI interface.</p>
<p>It is called when the middleware component stops operation and releases the software resources used by the interface. </p>
</div>
</div>
<a class="anchor" id="gacdec50a3dd5902de601caa7397c1dabc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_SAI_PowerControl </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> </td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control SAI Interface Power. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>Power state </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_SAI_PowerControl</b> allows you to control the power modes of the SAI interface.</p>
<p>The parameter <em>state</em> sets the operation and can have the following values:</p>
<ul>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a> : set-up peripheral for data transfers, enable interrupts (NVIC) and optionally DMA. Can be called multiple times. If the peripheral is already in this mode the function performs no operation and returns with <a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>.</li>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5a9ef9e57cbcc948d0e22314e73dc8c434">ARM_POWER_LOW</a> : may use power saving. Returns <a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> when not implemented.</li>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35">ARM_POWER_OFF</a> : terminates any pending data transfers, disables peripheral, disables related interrupts and DMA.</li>
</ul>
<p>Refer to <a class="el" href="theoryOperation.html#CallSequence">Function Call Sequence</a> for more information. </p>
</div>
</div>
<a class="anchor" id="ga8bb6866c535adeb930bc4a847d476fcd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_SAI_Send </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>num</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start sending data to SAI transmitter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to buffer with data to send to SAI transmitter </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Number of data items to send </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_SAI_Send</b> sends data to the SAI transmitter.</p>
<p>The function parameters specify the buffer with <em>data</em> and the number <em>num</em> of items to send. The item size is defined by the data type which depends on the configured number of data bits.</p>
<p>Data type is:</p>
<ul>
<li><em>uint8_t</em> when configured for <span class="XML-Token">8</span> data bits</li>
<li><em>uint16_t</em> when configured for <span class="XML-Token">9..16</span> data bits</li>
<li><em>uint32_t</em> when configured for <span class="XML-Token">17..32</span> data bits</li>
</ul>
<p>Transmitter is enabled by calling <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> with <a class="el" href="group__sai__controls.html#ga74d7850973c095bb8dbffa880b4af1bc">ARM_SAI_CONTROL_TX</a> as the control parameter and <span class="XML-Token">1</span> as an argument. This starts the transmit engine which, generates a clock and frame sync signal in master mode and transmits the data. In slave mode, clock and frame sync are generated by the external master. When mute is active, data is discarded and zero values are transmitted.</p>
<p>Calling the function <b>ARM_SAI_Send</b> only starts the send operation. The function is non-blocking and returns as soon as the driver has started the operation (the driver typically configures DMA or the interrupt system for continuous transfer). During the operation it is not allowed to call this function again. Also, the data buffer must stay allocated and the contents of unsent data must not be modified. When the send operation is completed (requested number of items have been sent), the event <a class="el" href="group__SAI__events.html#ga3dfa64375859f40d157c224187d2885e">ARM_SAI_EVENT_SEND_COMPLETE</a> is generated. Progress of the send operation can be monitored by reading the number of already sent items by calling the function <a class="el" href="group__sai__interface__gr.html#gaa9805f9d32aee205f787e625a58e8898">ARM_SAI_GetTxCount</a>.</p>
<p>The status of the transmitter can also be monitored by calling the function <a class="el" href="group__sai__interface__gr.html#ga6a202b57697f0f7a9742e76b33d5eeec">ARM_SAI_GetStatus</a> and checking the <em>tx_busy</em> flag, which indicates if a transmission is still in progress.</p>
<p>If the transmitter is enabled and data is to be sent but the send operation has not been started yet, then the event <a class="el" href="group__SAI__events.html#ga6a0be7aaf9d700e5259f741641bc37ca">ARM_SAI_EVENT_TX_UNDERFLOW</a> is generated.</p>
<p>If an invalid synchronization frame is detected in slave mode, then the event <a class="el" href="group__SAI__events.html#ga6ffcf96fe404b48421a57fbd122b26bc">ARM_SAI_EVENT_FRAME_ERROR</a> is generated (if supported and reported by <em>event_frame_error</em> in <a class="el" href="group__sai__interface__gr.html#structARM__SAI__CAPABILITIES">ARM_SAI_CAPABILITIES</a>).</p>
<p>The send operation can be aborted by calling the function <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> with the control parameter <a class="el" href="group__sai__controls.html#gab3ec8ef9e5e5a190bd2131ac8c99a240">ARM_SAI_ABORT_SEND</a>. </p>
</div>
</div>
<a class="anchor" id="ga2d55f506cef9d2849cbe418146086d98"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_SAI_Receive </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>num</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start receiving data from SAI receiver. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Pointer to buffer for data to receive from SAI receiver </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Number of data items to receive </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_SAI_Receive</b> is used to receive data from the SAI receiver. The function parameters specify the buffer for <em>data</em> and the number <em>num</em> of items to receive. The item size is defined by the data type, which depends on the configured number of data bits.</p>
<p>Data type is:</p>
<ul>
<li><em>uint8_t</em> when configured for <span class="XML-Token">8</span> data bits</li>
<li><em>uint16_t</em> when configured for <span class="XML-Token">9..16</span> data bits</li>
<li><em>uint32_t</em> when configured for <span class="XML-Token">17..32</span> data bits</li>
</ul>
<p>The receiver is enabled by calling the function <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> with the control parameter <a class="el" href="group__sai__controls.html#gaa40390b6dd0df3b140fdc45bb7b1439d">ARM_SAI_CONTROL_RX</a> and the value <span class="XML-Token">1</span> for the parameter <em>arg1</em>. This starts the receive engine, which generates a clock and frame sync signal in master mode and receives data. In slave mode, clock and frame sync are generated by the external master.</p>
<p>Calling the function <b>ARM_SAI_Receive</b> only starts the receive operation. The function is non-blocking and returns as soon as the driver has started the operation (the driver typically configures DMA or the interrupt system for continuous transfer). During the operation, it is not allowed to call this function again. The data buffer must also stay allocated. When receive operation is completed (the requested number of items have been received), the <a class="el" href="group__SAI__events.html#ga5a9bde0b096aafe53279529a0adbef55">ARM_SAI_EVENT_RECEIVE_COMPLETE</a> event is generated. Progress of the receive operation can also be monitored by reading the number of items already received by calling the function <a class="el" href="group__sai__interface__gr.html#ga2c571fcc8b9632c25a64043bc2b2baec">ARM_SAI_GetRxCount</a>.</p>
<p>The status of the receiver can also be monitored by calling the function <a class="el" href="group__sai__interface__gr.html#ga6a202b57697f0f7a9742e76b33d5eeec">ARM_SAI_GetStatus</a> and checking the <em>rx_busy</em> flag, which indicates whether a reception is still in progress.</p>
<p>When the receiver is enabled and data is received but the receive operation has not been started yet, then the event <a class="el" href="group__SAI__events.html#gac83e9df0238803ef2c88f16605f73bf5">ARM_SAI_EVENT_RX_OVERFLOW</a> is generated.</p>
<p>If an invalid synchronization frame is detected in slave mode, then the event <a class="el" href="group__SAI__events.html#ga6ffcf96fe404b48421a57fbd122b26bc">ARM_SAI_EVENT_FRAME_ERROR</a> is generated (if supported and reported by <em>event_frame_error</em> in <a class="el" href="group__sai__interface__gr.html#structARM__SAI__CAPABILITIES">ARM_SAI_CAPABILITIES</a>).</p>
<p>The receive operation can be aborted by calling the function <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control</a> with the control parameter <a class="el" href="group__sai__controls.html#ga2b8d3d85c1e60f137f8c433f319244cb">ARM_SAI_ABORT_RECEIVE</a>. </p>
</div>
</div>
<a class="anchor" id="gaa9805f9d32aee205f787e625a58e8898"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ARM_SAI_GetTxCount </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get transmitted data count. </p>
<dl class="section return"><dt>Returns</dt><dd>number of data items transmitted</dd></dl>
<p>The function <b>ARM_SAI_GetTxCount</b> returns the number of the currently transmitted data items during an <a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd">ARM_SAI_Send</a> operation. </p>
</div>
</div>
<a class="anchor" id="ga2c571fcc8b9632c25a64043bc2b2baec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ARM_SAI_GetRxCount </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get received data count. </p>
<dl class="section return"><dt>Returns</dt><dd>number of data items received</dd></dl>
<p>The function <b>ARM_SAI_GetRxCount</b> returns the number of the currently received data items during an <a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98">ARM_SAI_Receive</a> operation. </p>
</div>
</div>
<a class="anchor" id="ga405a0769c33da6801055db0fb9b6c869"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_SAI_Control </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>control</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>arg1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>arg2</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control SAI Interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">control</td><td>Operation </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">arg1</td><td>Argument 1 of operation (optional) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">arg2</td><td>Argument 2 of operation (optional) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>common <a class="el" href="group__execution__status.html">Status Error Codes</a> and driver specific <a class="el" href="group__sai__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_SAI_Control</b> controls the SAI interface and executes various operations.</p>
<p>The parameter <em>control</em> specifies the operation. Values are listed in the table <a href="#sai_contrl_tab"><b>Parameter <em>control</em></b></a>.<br/>
The parameter <em>arg1</em> provides, depending on the operation, additional information or sets values. Refer to table <a href="#sai_arg1_tab"><b>Parameter <em>arg1</em></b></a>. <br/>
The parameter <em>arg2</em> provides, depending on the operation and/or <em>arg1</em>, additional information or sets values.</p>
<p>The driver provides a receiver/transmitter pair of signals. In asynchronous operation mode, they operate completely independent from each other. In synchronous operation mode, the synchronous channel uses the Clock (SCK) and Frame Sync (WS) signal from the asynchronous one (control category <a href="#sai_sync"><b>Synchronization</b></a>).</p>
<p>The clock polarity can be set for every protocol, regardless whether it is already predefined for I2S, MSB/LSB Jusitified (control category <a href="#sai_clk_polarity"><b>Clock Polarity</b></a>).</p>
<p>A master clock provides a faster clock from which the frame can be derived (usually 256 x faster than the normal frame clock). You can use a master clock only in master mode. A slave will always have only one clock (control category <a href="#master_clock"><b>Master Clock pin (MCLK)</b></a>).</p>
<p><a class="anchor" id="sai_contrl_tab"></a> The table lists the operation values for <em>control</em>. Values from different categories can be ORed. </p>
<table class="cmtable">
<tr>
<th>Parameter <em>control</em> </th><th>Bit </th><th>Category </th><th>Description </th></tr>
<tr>
<td><a class="el" href="group__sai__controls.html#ga14ac7775060e731b26bc5b3acd2f317a">ARM_SAI_CONFIGURE_TX</a> </td><td rowspan="9" style="text-align:right">0..7 </td><td rowspan="9">Operation </td><td>Configure transmitter. <em>arg1</em> (see <a href="#sai_arg1_tab"><b>Parameter <em>arg1</em></b></a>) and <em>arg2</em> provide additional configuration. </td></tr>
<tr>
<td><a class="el" href="group__sai__controls.html#ga14ac7775060e731b26bc5b3acd2f317a">ARM_SAI_CONFIGURE_TX</a> </td><td>Configure transmitter. <em>arg1</em> (see <a href="#sai_arg1_tab"><b>Parameter <em>arg1</em></b></a>) and <em>arg2</em> provide additional configuration. </td></tr>
<tr>
<td><a class="el" href="group__sai__controls.html#gaba3e824e022fe2a5736de5dcbbd3d291">ARM_SAI_CONFIGURE_RX</a> </td><td>Configure transmitter. <em>arg1</em> and <em>arg2</em> provide additional configuration. </td></tr>
<tr>
<td><a class="el" href="group__sai__controls.html#ga74d7850973c095bb8dbffa880b4af1bc">ARM_SAI_CONTROL_TX</a> </td><td>Enable or disable transmitter and control mute; <em>arg1.0</em> : <span class="XML-Token">0=disable (default); 1=enable;</span> <em>arg1.1</em> : <span class="XML-Token">mute</span> (see <a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd">ARM_SAI_Send</a>) </td></tr>
<tr>
<td><a class="el" href="group__sai__controls.html#gaa40390b6dd0df3b140fdc45bb7b1439d">ARM_SAI_CONTROL_RX</a> </td><td>Enable or disable receiver; <em>arg1.0</em> : <span class="XML-Token">0=disable (default); 1=enable</span> (see <a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98">ARM_SAI_Receive</a>) </td></tr>
<tr>
<td><a class="el" href="group__sai__controls.html#ga8675b9776189caf4df7d558b3e18fcba">ARM_SAI_MASK_SLOTS_TX</a> </td><td>Mask transmitter slots; <em>arg1</em> = <span class="XML-Token">mask</span> (bit: 0=active, 1=inactive); all configured slots are active by default. </td></tr>
<tr>
<td><a class="el" href="group__sai__controls.html#ga84302d372185665852c9ed941c6545e0">ARM_SAI_MASK_SLOTS_RX</a> </td><td>Mask receiver slots; <em>arg1</em> = <span class="XML-Token">mask</span> (bit: 0=active, 1=inactive); all configured slots are active by default. </td></tr>
<tr>
<td><a class="el" href="group__sai__controls.html#gab3ec8ef9e5e5a190bd2131ac8c99a240">ARM_SAI_ABORT_SEND</a> </td><td>Abort send operation (see <a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd">ARM_SAI_Send</a>). </td></tr>
<tr>
<td><a class="el" href="group__sai__controls.html#ga2b8d3d85c1e60f137f8c433f319244cb">ARM_SAI_ABORT_RECEIVE</a> </td><td>Abort receive operation (see <a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98">ARM_SAI_Receive</a>). </td></tr>
<tr>
<td><a class="el" href="group__sai__mode__control.html#ga5bedff714ea0f90139665b72d44daddc">ARM_SAI_MODE_MASTER</a> </td><td rowspan="2" style="text-align:right">8 </td><td rowspan="2">Mode </td><td>Master mode. <em>arg2</em> specifies the audio frequency in [Hz]. You can also set the <a href="#master_clock"><b>Master Clock pin</b></a>. </td></tr>
<tr>
<td><a class="el" href="group__sai__mode__control.html#ga5956c12a24a506754ecc7999f0660bb5">ARM_SAI_MODE_SLAVE</a> (default) </td><td>Slave mode. </td></tr>
<tr>
<td><a class="el" href="group__sai__sync__control.html#gad123537cb6ab9eefd6feab193ed74655">ARM_SAI_ASYNCHRONOUS</a> (default)<a class="anchor" id="sai_sync"></a></td><td rowspan="2" style="text-align:right">9 </td><td rowspan="2">Synchronization </td><td>Asynchronous operation using own clock and sync signal. </td></tr>
<tr>
<td><a class="el" href="group__sai__sync__control.html#gad2ad5406c30c353e80f54b40b3de5db8">ARM_SAI_SYNCHRONOUS</a> </td><td>Synchronous operation using clock and sync signal from other transmitter/receiver. </td></tr>
<tr>
<td><a class="el" href="group__sai__protocol__control.html#gacef87941052c21ebacd3dde6ce9d6925">ARM_SAI_PROTOCOL_USER</a> (default) </td><td rowspan="7" style="text-align:right">10..12 </td><td rowspan="7">Protocol </td><td>User defined </td></tr>
<tr>
<td><a class="el" href="group__sai__protocol__control.html#gaaaf423bbe59920b3c7813e22ce083ddc">ARM_SAI_PROTOCOL_I2S</a> </td><td>I2C </td></tr>
<tr>
<td><a class="el" href="group__sai__protocol__control.html#gad931f9e8aedff4e6040d726d707862f0">ARM_SAI_PROTOCOL_MSB_JUSTIFIED</a> </td><td>MSB (left) justified </td></tr>
<tr>
<td><a class="el" href="group__sai__protocol__control.html#gab88b6f9b61a20927ac8f8d39e46c6349">ARM_SAI_PROTOCOL_LSB_JUSTIFIED</a> </td><td>LSB (right) justified </td></tr>
<tr>
<td><a class="el" href="group__sai__protocol__control.html#ga3762437e0b1402b5d4fd293ae745f103">ARM_SAI_PROTOCOL_PCM_SHORT</a> </td><td>PCM with short frame </td></tr>
<tr>
<td><a class="el" href="group__sai__protocol__control.html#gad43530c5b6ae1e89db587b20d71440b4">ARM_SAI_PROTOCOL_PCM_LONG</a> </td><td>PCM with long frame </td></tr>
<tr>
<td><a class="el" href="group__sai__protocol__control.html#ga8b1669910f4db4bb3584543e7eb04d7a">ARM_SAI_PROTOCOL_AC97</a> </td><td>AC'97 </td></tr>
<tr>
<td><a class="el" href="group__sai__data__bits__control.html#ga1a7529e4b46d69dbd57ccef84552a3f4">ARM_SAI_DATA_SIZE(n)</a> </td><td style="text-align:right">13..17 </td><td>Data Size </td><td>Data size in bits; the range for <em>n</em> is <span class="XML-Token">8..32</span>. See also: <a href="#frame_slot_size"><b>Frame Slot Size</b></a>. </td></tr>
<tr>
<td><a class="el" href="group__sai__bit__order__control.html#gaf74bfe9c3005bf3b80d69f112ea9e62b">ARM_SAI_MSB_FIRST</a> </td><td rowspan="2" style="text-align:right">18 </td><td rowspan="2">Bit Order </td><td>Data is transferred with MSB first. </td></tr>
<tr>
<td><a class="el" href="group__sai__bit__order__control.html#ga19b51b75537b030b975efcf68f3db78b">ARM_SAI_LSB_FIRST</a> </td><td>Data is transferred with LSB first (User protocol only, ignored otherwise). </td></tr>
<tr>
<td><a class="el" href="group__sai__mono__control.html#ga0adcd27875d92add813b9664e9cb0b4b">ARM_SAI_MONO_MODE</a> </td><td style="text-align:right">19 </td><td>Mono Mode </td><td>Only for I2S, MSB/LSB justified. When using <a class="el" href="group__sai__interface__gr.html#Driver_SAI_I2S">I2S</a> in mono mode, only data for a single channel is sent to and received from the driver. Hardware will duplicate the data for the second channel on transmit and ignore the second channel on receive. </td></tr>
<tr>
<td><a class="el" href="group__sai__companding__control.html#ga185919d553cf9204e514136eb375ef08">ARM_SAI_COMPANDING_NONE</a> (default) </td><td rowspan="3" style="text-align:right">20..22 </td><td rowspan="3">Companding </td><td>No companding </td></tr>
<tr>
<td><a class="el" href="group__sai__companding__control.html#gacfd6c74148c0ae90aa6eaaf8e69da3a9">ARM_SAI_COMPANDING_A_LAW</a> </td><td>A-Law companding (8-bit data) </td></tr>
<tr>
<td><a class="el" href="group__sai__companding__control.html#ga7b571406bcce383140198e53312faee5">ARM_SAI_COMPANDING_U_LAW</a> </td><td>u-Law companding (8-bit data) </td></tr>
<tr>
<td><a class="el" href="group__sai__clock__pol__control.html#ga4311b6b6fd937d6ac37aa2d031a5d5ee">ARM_SAI_CLOCK_POLARITY_0</a> (default)<a class="anchor" id="sai_clk_polarity"></a>> </td><td rowspan="2" style="text-align:right">23 </td><td rowspan="2">Clock Polarity </td><td>Drive on falling edge, capture on rising edge. </td></tr>
<tr>
<td><a class="el" href="group__sai__clock__pol__control.html#gae4c9b9abd3b7390810a5494363875a53">ARM_SAI_CLOCK_POLARITY_1</a><a class="anchor" id="master_clock"></a> </td><td>Drive on rising edge, capture on falling edge. </td></tr>
<tr>
<td><a class="el" href="group__sai__mclk__pin__control.html#ga7654bffb42e96d48df57c598323337d6">ARM_SAI_MCLK_PIN_INACTIVE</a> (default) </td><td rowspan="3" style="text-align:right">24..26 </td><td rowspan="3">Master Clock pin (MCLK) </td><td>MCLK not used. </td></tr>
<tr>
<td><a class="el" href="group__sai__mclk__pin__control.html#ga24d99edf05699eff32da02742fb04ced">ARM_SAI_MCLK_PIN_OUTPUT</a> </td><td>MCLK is output (Master mode only). </td></tr>
<tr>
<td><a class="el" href="group__sai__mclk__pin__control.html#ga2cd610be9ba9532b2926376deaacf5ad">ARM_SAI_MCLK_PIN_INPUT</a> </td><td>MCLK is input (Master mode only). </td></tr>
</table>
<p><a class="anchor" id="sai_arg1_tab"></a>The parameter <em>arg1</em> provides frame-specific values depending on the <em>control</em> operation. Values from different categories can be ORed. </p>
<table class="cmtable">
<tr>
<th>Parameter <em>arg1</em> </th><th style="text-align:right">Bit </th><th>Category </th><th>Description </th></tr>
<tr>
<td><a class="el" href="group__sai__frame__control.html#ga4c557aa02c83b8595be23a6c58d284e9">ARM_SAI_FRAME_LENGTH(n)</a> </td><td style="text-align:right">0..9 </td><td>Frame Length </td><td>Frame length in bits; the possible range for <em>n</em> is <span class="XML-Token">8..1024</span>; default depends on protocol and data. </td></tr>
<tr>
<td><a class="el" href="group__sai__frame__control.html#gae165fd96e6a5b06b362954fadeabcb7a">ARM_SAI_FRAME_SYNC_WIDTH(n)</a> </td><td style="text-align:right">10..17 </td><td>Frame Sync Width </td><td>Frame Sync width in bits; the possible range for <em>n</em> is <span class="XML-Token">1..256</span>; <span class="XML-Token">default=1</span>; User protocol only, ignored otherwise. </td></tr>
<tr>
<td><a class="el" href="group__sai__frame__control.html#ga7be0326e15d61d6c67febb22f5b14d58">ARM_SAI_FRAME_SYNC_POLARITY_HIGH</a> </td><td rowspan="2" style="text-align:right">18 </td><td rowspan="2" style="white-spaces:nowrap">Frame Sync Polarity </td><td>Frame Sync is active high (default). </td></tr>
<tr>
<td><a class="el" href="group__sai__frame__control.html#gaf3d6bdbc05379ac30905cecf1b2d917e">ARM_SAI_FRAME_SYNC_POLARITY_LOW</a> </td><td>Frame Sync is active low (User protocol only, ignored otherwise). </td></tr>
<tr>
<td><a class="el" href="group__sai__frame__control.html#gabec3992447436a2a8ed99108908ae208">ARM_SAI_FRAME_SYNC_EARLY</a> </td><td style="text-align:right">19 </td><td>Frame Sync Early </td><td>Frame Sync one bit before the first bit of the frame (User protocol only, ignored otherwise). </td></tr>
<tr>
<td><a class="el" href="group__sai__slot__control.html#ga8f2cf3a212ca7fe389e00b082efb5d0b">ARM_SAI_SLOT_COUNT(n)</a> </td><td style="text-align:right">20..24 </td><td>Frame Sync Count </td><td>Number of slots in frame; the possible range for <em>n</em> is <span class="XML-Token">1..32</span>; default=<span class="XML-Token">1</span>; User protocol only, ignored otherwise. </td></tr>
<tr>
<td><a class="el" href="group__sai__slot__control.html#gad77c6c0de2a4e7223a0c42e1594f0a2c">ARM_SAI_SLOT_SIZE_DEFAULT</a><a class="anchor" id="frame_slot_size"></a> </td><td rowspan="3" style="text-align:right">25..26 </td><td rowspan="3">Frame Slot Size </td><td>Slot size is equal to data size (default). </td></tr>
<tr>
<td><a class="el" href="group__sai__slot__control.html#ga2bb9cf53b07cac81fb0fe71de6c97c83">ARM_SAI_SLOT_SIZE_16</a> </td><td>Slot size is <span class="XML-Token">16 bits</span> (User protocol only, ignored otherwise). </td></tr>
<tr>
<td><a class="el" href="group__sai__slot__control.html#gaaa5c4cc18a0f5668bc9f117874cd83dd">ARM_SAI_SLOT_SIZE_32</a> </td><td>Slot size is <span class="XML-Token">32 bits</span> (User protocol only, ignored otherwise). </td></tr>
<tr>
<td><a class="el" href="group__sai__slot__control.html#ga48d4a142f3a1bb0fa4e88c9e427932a0">ARM_SAI_SLOT_OFFSET(n)</a> </td><td style="text-align:right">27..31 </td><td>Frame Slot Offset </td><td>Offset of first data bit in slot; The range for <em>n</em> is <span class="XML-Token">0..31</span>; default=<span class="XML-Token">0</span>; User protocol only, ignored otherwise. </td></tr>
</table>
<p><a class="anchor" id="mckl_prescaler"></a>Depending on the <em>control</em> operation, the parameter <em>arg2</em> specifies the Master Clock (MCLK) prescaler and calculates the audio frequency automatically.</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>arg2</em> </th><th align="left">MCLK Prescaler </th></tr>
<tr>
<td align="left"><a class="el" href="group__sai__mclk__pres__control.html#ga2afa85cd335e75d8b9b06c9f47f3f4b0">ARM_SAI_MCLK_PRESCALER(n)</a> </td><td align="left">MCLK prescaler; Audio frequency = MCLK/n; the range for <em>n</em> is <span class="XML-Token">1..4096</span>; default=<span class="XML-Token">1</span>. </td></tr>
</table>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__sai__interface__gr.html#structARM__DRIVER__SAI">ARM_DRIVER_SAI</a> Driver_SAI0;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// configure Transmitter to Asynchronous Master: I2S Protocol, 16-bit data, 16kHz Audio frequency</span></div>
<div class="line">status = Driver_SAI0.<a class="code" href="group__sai__interface__gr.html#a80455fc2c7355b1850098710fd66a244">Control</a>(<a class="code" href="group__sai__controls.html#ga14ac7775060e731b26bc5b3acd2f317a">ARM_SAI_CONFIGURE_TX</a> | </div>
<div class="line"> <a class="code" href="group__sai__mode__control.html#ga5bedff714ea0f90139665b72d44daddc">ARM_SAI_MODE_MASTER</a> | </div>
<div class="line"> <a class="code" href="group__sai__sync__control.html#gad123537cb6ab9eefd6feab193ed74655">ARM_SAI_ASYNCHRONOUS</a> | </div>
<div class="line"> <a class="code" href="group__sai__protocol__control.html#gaaaf423bbe59920b3c7813e22ce083ddc">ARM_SAI_PROTOCOL_I2S</a> | </div>
<div class="line"> <a class="code" href="group__sai__data__bits__control.html#ga1a7529e4b46d69dbd57ccef84552a3f4">ARM_SAI_DATA_SIZE</a>(16), 0, 16000);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// configure Receiver to Asynchronous Master: I2S Protocol, 16-bit data, 16kHz Audio frequency</span></div>
<div class="line">status = Driver_SAI0.<a class="code" href="group__sai__interface__gr.html#a80455fc2c7355b1850098710fd66a244">Control</a>(<a class="code" href="group__sai__controls.html#gaba3e824e022fe2a5736de5dcbbd3d291">ARM_SAI_CONFIGURE_RX</a> | </div>
<div class="line"> <a class="code" href="group__sai__mode__control.html#ga5bedff714ea0f90139665b72d44daddc">ARM_SAI_MODE_MASTER</a> | </div>
<div class="line"> <a class="code" href="group__sai__sync__control.html#gad123537cb6ab9eefd6feab193ed74655">ARM_SAI_ASYNCHRONOUS</a> | </div>
<div class="line"> <a class="code" href="group__sai__protocol__control.html#gaaaf423bbe59920b3c7813e22ce083ddc">ARM_SAI_PROTOCOL_I2S</a> | </div>
<div class="line"> <a class="code" href="group__sai__data__bits__control.html#ga1a7529e4b46d69dbd57ccef84552a3f4">ARM_SAI_DATA_SIZE</a>(16), 0, 16000);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// enable Transmitter</span></div>
<div class="line">status = Driver_SAI0.<a class="code" href="group__sai__interface__gr.html#a80455fc2c7355b1850098710fd66a244">Control</a>(<a class="code" href="group__sai__controls.html#ga74d7850973c095bb8dbffa880b4af1bc">ARM_SAI_CONTROL_TX</a>, 1, 0);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// enable Receiver</span></div>
<div class="line">status = Driver_SAI0.<a class="code" href="group__sai__interface__gr.html#a80455fc2c7355b1850098710fd66a244">Control</a>(<a class="code" href="group__sai__controls.html#gaa40390b6dd0df3b140fdc45bb7b1439d">ARM_SAI_CONTROL_RX</a>, 1, 0);</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga6a202b57697f0f7a9742e76b33d5eeec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__sai__interface__gr.html#structARM__SAI__STATUS">ARM_SAI_STATUS</a> ARM_SAI_GetStatus </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get SAI status. </p>
<dl class="section return"><dt>Returns</dt><dd>SAI status <a class="el" href="group__sai__interface__gr.html#structARM__SAI__STATUS">ARM_SAI_STATUS</a></dd></dl>
<p>The function <b>ARM_SAI_GetStatus</b> retrieves the current SAI interface status. </p>
</div>
</div>
<a class="anchor" id="gaedf3347cb25d6bf2faad1bbb35ad79f4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARM_SAI_SignalEvent </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signal SAI Events. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td><a class="el" href="group__SAI__events.html">SAI Events</a> notification mask </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<p>The function <b>ARM_SAI_SignalEvent</b> is a callback function registered by the function <a class="el" href="group__sai__interface__gr.html#ga89622a02ca1e7affb1a01eefacb6f54c">ARM_SAI_Initialize</a>.</p>
<p>The parameter <em>event</em> indicates one or more events that occurred during driver operation. Each event is encoded in a separate bit and therefore it is possible to signal multiple events within the same call.</p>
<p>The following events can be generated:</p>
<table class="doxtable">
<tr>
<th>Parameter <em>event</em> </th><th align="center">Bit </th><th align="left">Description </th></tr>
<tr>
<td><a class="el" href="group__SAI__events.html#ga3dfa64375859f40d157c224187d2885e">ARM_SAI_EVENT_SEND_COMPLETE</a> </td><td align="center">0 </td><td align="left">Occurs after call to <a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd">ARM_SAI_Send</a> to indicate that all the data has been sent (or queued in transmit buffers). The driver is ready for the next call to <a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd">ARM_SAI_Send</a>. </td></tr>
<tr>
<td><a class="el" href="group__SAI__events.html#ga5a9bde0b096aafe53279529a0adbef55">ARM_SAI_EVENT_RECEIVE_COMPLETE</a> </td><td align="center">1 </td><td align="left">Occurs after call to <a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98">ARM_SAI_Receive</a> to indicate that all the data has been received. The driver is ready for the next call to <a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98">ARM_SAI_Receive</a>. </td></tr>
<tr>
<td><a class="el" href="group__SAI__events.html#ga6a0be7aaf9d700e5259f741641bc37ca">ARM_SAI_EVENT_TX_UNDERFLOW</a> </td><td align="center">2 </td><td align="left">Occurs when data is to be sent but send operation has not been started. Data field <em>tx_underflow</em> = <span class="XML-Token">1</span> of <a class="el" href="group__sai__interface__gr.html#structARM__SAI__STATUS">ARM_SAI_STATUS</a>. </td></tr>
<tr>
<td><a class="el" href="group__SAI__events.html#gac83e9df0238803ef2c88f16605f73bf5">ARM_SAI_EVENT_RX_OVERFLOW</a> </td><td align="center">3 </td><td align="left">Occurs when data is received but receive operation has not been started. Data field <em>rx_underflow</em> = <span class="XML-Token">1</span> of <a class="el" href="group__sai__interface__gr.html#structARM__SAI__STATUS">ARM_SAI_STATUS</a>. </td></tr>
<tr>
<td><a class="el" href="group__SAI__events.html#ga6ffcf96fe404b48421a57fbd122b26bc">ARM_SAI_EVENT_FRAME_ERROR</a> </td><td align="center">4 </td><td align="left">Occurs in slave mode when invalid synchronization frame is detected. Data field <em>event_frame_error</em> = <span class="XML-Token">1</span> of <a class="el" href="group__sai__interface__gr.html#structARM__SAI__STATUS">ARM_SAI_STATUS</a>. </td></tr>
</table>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__interface__gr.html | HTML | apache-2.0 | 94,290 |
var group__sai__interface__gr =
[
[ "Status Error Codes", "group__sai__execution__status.html", "group__sai__execution__status" ],
[ "SAI Events", "group__SAI__events.html", "group__SAI__events" ],
[ "SAI Control Codes", "group__sai__control.html", "group__sai__control" ],
[ "ARM_DRIVER_SAI", "group__sai__interface__gr.html#structARM__DRIVER__SAI", [
[ "GetVersion", "group__sai__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__sai__interface__gr.html#a7e230744b9898cabf80ee6f2595569f6", null ],
[ "Initialize", "group__sai__interface__gr.html#a54a38e78d5fd7ca0d37174c81ec01731", null ],
[ "Uninitialize", "group__sai__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__sai__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "Send", "group__sai__interface__gr.html#a44eedddf4428cf4b98883b6c27d31922", null ],
[ "Receive", "group__sai__interface__gr.html#adb9224a35fe16c92eb0dd103638e4cf3", null ],
[ "GetTxCount", "group__sai__interface__gr.html#a0b28b2c21016702f50c28655653099df", null ],
[ "GetRxCount", "group__sai__interface__gr.html#a758c7822edf6ac18f82eb33c9dc09d71", null ],
[ "Control", "group__sai__interface__gr.html#a80455fc2c7355b1850098710fd66a244", null ],
[ "GetStatus", "group__sai__interface__gr.html#a310d55d55bd7c6b0393d43bb994db708", null ]
] ],
[ "ARM_SAI_CAPABILITIES", "group__sai__interface__gr.html#structARM__SAI__CAPABILITIES", [
[ "asynchronous", "group__sai__interface__gr.html#a75ba2507ea29601a309393e794f4413d", null ],
[ "synchronous", "group__sai__interface__gr.html#a9fa4f850b8ce2be2c7ffa2e3ec70ae20", null ],
[ "protocol_user", "group__sai__interface__gr.html#a808b1f9e0abc3fa67945899cfc9fccc1", null ],
[ "protocol_i2s", "group__sai__interface__gr.html#a6fcb9d68c4999860ce162c0ef44c4c97", null ],
[ "protocol_justified", "group__sai__interface__gr.html#a5363ec1fc0042620cb8aeeee4f98691b", null ],
[ "protocol_pcm", "group__sai__interface__gr.html#a0b2c79bd96ecb47d801fc5389819314a", null ],
[ "protocol_ac97", "group__sai__interface__gr.html#a5255f8d78a18ace0a959f604f9c065dd", null ],
[ "mono_mode", "group__sai__interface__gr.html#a8d92817d8662211abda2d747c52ff4a9", null ],
[ "companding", "group__sai__interface__gr.html#a77e4d8466d2bde30e6583b9ad8ba8c82", null ],
[ "mclk_pin", "group__sai__interface__gr.html#a12554e2522a0c611e8a26c9e536554eb", null ],
[ "event_frame_error", "group__sai__interface__gr.html#acc06ba75f18af9862d171426abc3273e", null ],
[ "reserved", "group__sai__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_SAI_STATUS", "group__sai__interface__gr.html#structARM__SAI__STATUS", [
[ "tx_busy", "group__sai__interface__gr.html#a2c6d2b67fba3f3e084e96a6bc7fcac6b", null ],
[ "rx_busy", "group__sai__interface__gr.html#a9f5baee58ed41b382628a82a0b1cbcb4", null ],
[ "tx_underflow", "group__sai__interface__gr.html#a048f45e9d2257a21821f81d9edd17b72", null ],
[ "rx_overflow", "group__sai__interface__gr.html#ac403aefd9bce8b0172e1996c0f3dd8aa", null ],
[ "frame_error", "group__sai__interface__gr.html#a1b4f69a2caf19ef9fd75cf27ae3932f9", null ],
[ "reserved", "group__sai__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_SAI_SignalEvent_t", "group__sai__interface__gr.html#gad8ca8e2459e540928f6315b3df6da0ee", null ],
[ "ARM_SAI_GetVersion", "group__sai__interface__gr.html#ga786b1970a788a4dfc6156b42364e52f8", null ],
[ "ARM_SAI_GetCapabilities", "group__sai__interface__gr.html#gac6c636757944eaf25aebf312a67665aa", null ],
[ "ARM_SAI_Initialize", "group__sai__interface__gr.html#ga89622a02ca1e7affb1a01eefacb6f54c", null ],
[ "ARM_SAI_Uninitialize", "group__sai__interface__gr.html#gabdefafaba6f072cfd7ed6f8f132422b6", null ],
[ "ARM_SAI_PowerControl", "group__sai__interface__gr.html#gacdec50a3dd5902de601caa7397c1dabc", null ],
[ "ARM_SAI_Send", "group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd", null ],
[ "ARM_SAI_Receive", "group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98", null ],
[ "ARM_SAI_GetTxCount", "group__sai__interface__gr.html#gaa9805f9d32aee205f787e625a58e8898", null ],
[ "ARM_SAI_GetRxCount", "group__sai__interface__gr.html#ga2c571fcc8b9632c25a64043bc2b2baec", null ],
[ "ARM_SAI_Control", "group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869", null ],
[ "ARM_SAI_GetStatus", "group__sai__interface__gr.html#ga6a202b57697f0f7a9742e76b33d5eeec", null ],
[ "ARM_SAI_SignalEvent", "group__sai__interface__gr.html#gaedf3347cb25d6bf2faad1bbb35ad79f4", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__interface__gr.js | JavaScript | apache-2.0 | 4,794 |
var group__sai__interface__gr_structARM__DRIVER__SAI =
[
[ "GetVersion", "group__sai__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__sai__interface__gr.html#a7e230744b9898cabf80ee6f2595569f6", null ],
[ "Initialize", "group__sai__interface__gr.html#a54a38e78d5fd7ca0d37174c81ec01731", null ],
[ "Uninitialize", "group__sai__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__sai__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "Send", "group__sai__interface__gr.html#a44eedddf4428cf4b98883b6c27d31922", null ],
[ "Receive", "group__sai__interface__gr.html#adb9224a35fe16c92eb0dd103638e4cf3", null ],
[ "GetTxCount", "group__sai__interface__gr.html#a0b28b2c21016702f50c28655653099df", null ],
[ "GetRxCount", "group__sai__interface__gr.html#a758c7822edf6ac18f82eb33c9dc09d71", null ],
[ "Control", "group__sai__interface__gr.html#a80455fc2c7355b1850098710fd66a244", null ],
[ "GetStatus", "group__sai__interface__gr.html#a310d55d55bd7c6b0393d43bb994db708", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__interface__gr_structARM__DRIVER__SAI.js | JavaScript | apache-2.0 | 1,110 |
var group__sai__interface__gr_structARM__SAI__CAPABILITIES =
[
[ "asynchronous", "group__sai__interface__gr.html#a75ba2507ea29601a309393e794f4413d", null ],
[ "synchronous", "group__sai__interface__gr.html#a9fa4f850b8ce2be2c7ffa2e3ec70ae20", null ],
[ "protocol_user", "group__sai__interface__gr.html#a808b1f9e0abc3fa67945899cfc9fccc1", null ],
[ "protocol_i2s", "group__sai__interface__gr.html#a6fcb9d68c4999860ce162c0ef44c4c97", null ],
[ "protocol_justified", "group__sai__interface__gr.html#a5363ec1fc0042620cb8aeeee4f98691b", null ],
[ "protocol_pcm", "group__sai__interface__gr.html#a0b2c79bd96ecb47d801fc5389819314a", null ],
[ "protocol_ac97", "group__sai__interface__gr.html#a5255f8d78a18ace0a959f604f9c065dd", null ],
[ "mono_mode", "group__sai__interface__gr.html#a8d92817d8662211abda2d747c52ff4a9", null ],
[ "companding", "group__sai__interface__gr.html#a77e4d8466d2bde30e6583b9ad8ba8c82", null ],
[ "mclk_pin", "group__sai__interface__gr.html#a12554e2522a0c611e8a26c9e536554eb", null ],
[ "event_frame_error", "group__sai__interface__gr.html#acc06ba75f18af9862d171426abc3273e", null ],
[ "reserved", "group__sai__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__interface__gr_structARM__SAI__CAPABILITIES.js | JavaScript | apache-2.0 | 1,239 |
var group__sai__interface__gr_structARM__SAI__STATUS =
[
[ "tx_busy", "group__sai__interface__gr.html#a2c6d2b67fba3f3e084e96a6bc7fcac6b", null ],
[ "rx_busy", "group__sai__interface__gr.html#a9f5baee58ed41b382628a82a0b1cbcb4", null ],
[ "tx_underflow", "group__sai__interface__gr.html#a048f45e9d2257a21821f81d9edd17b72", null ],
[ "rx_overflow", "group__sai__interface__gr.html#ac403aefd9bce8b0172e1996c0f3dd8aa", null ],
[ "frame_error", "group__sai__interface__gr.html#a1b4f69a2caf19ef9fd75cf27ae3932f9", null ],
[ "reserved", "group__sai__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__interface__gr_structARM__SAI__STATUS.js | JavaScript | apache-2.0 | 630 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>SAI Master Clock Pin</title>
<title>CMSIS-Driver: SAI Master Clock Pin</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__sai__mclk__pin__control.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">SAI Master Clock Pin<div class="ingroups"><a class="el" href="group__sai__configure__control.html">SAI Configuration</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines MCLK pin.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga7654bffb42e96d48df57c598323337d6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__mclk__pin__control.html#ga7654bffb42e96d48df57c598323337d6">ARM_SAI_MCLK_PIN_INACTIVE</a>   (0U << ARM_SAI_MCLK_PIN_Pos)</td></tr>
<tr class="memdesc:ga7654bffb42e96d48df57c598323337d6"><td class="mdescLeft"> </td><td class="mdescRight">MCLK not used (default) <a href="#ga7654bffb42e96d48df57c598323337d6">More...</a><br/></td></tr>
<tr class="separator:ga7654bffb42e96d48df57c598323337d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga24d99edf05699eff32da02742fb04ced"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__mclk__pin__control.html#ga24d99edf05699eff32da02742fb04ced">ARM_SAI_MCLK_PIN_OUTPUT</a>   (1U << ARM_SAI_MCLK_PIN_Pos)</td></tr>
<tr class="memdesc:ga24d99edf05699eff32da02742fb04ced"><td class="mdescLeft"> </td><td class="mdescRight">MCLK is output (Master only) <a href="#ga24d99edf05699eff32da02742fb04ced">More...</a><br/></td></tr>
<tr class="separator:ga24d99edf05699eff32da02742fb04ced"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2cd610be9ba9532b2926376deaacf5ad"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__mclk__pin__control.html#ga2cd610be9ba9532b2926376deaacf5ad">ARM_SAI_MCLK_PIN_INPUT</a>   (2U << ARM_SAI_MCLK_PIN_Pos)</td></tr>
<tr class="memdesc:ga2cd610be9ba9532b2926376deaacf5ad"><td class="mdescLeft"> </td><td class="mdescRight">MCLK is input (Master only) <a href="#ga2cd610be9ba9532b2926376deaacf5ad">More...</a><br/></td></tr>
<tr class="separator:ga2cd610be9ba9532b2926376deaacf5ad"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Defines MCLK pin. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga7654bffb42e96d48df57c598323337d6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_MCLK_PIN_INACTIVE   (0U << ARM_SAI_MCLK_PIN_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>MCLK not used (default) </p>
</div>
</div>
<a class="anchor" id="ga24d99edf05699eff32da02742fb04ced"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_MCLK_PIN_OUTPUT   (1U << ARM_SAI_MCLK_PIN_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>MCLK is output (Master only) </p>
</div>
</div>
<a class="anchor" id="ga2cd610be9ba9532b2926376deaacf5ad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_MCLK_PIN_INPUT   (2U << ARM_SAI_MCLK_PIN_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>MCLK is input (Master only) </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__mclk__pin__control.html | HTML | apache-2.0 | 9,912 |
var group__sai__mclk__pin__control =
[
[ "ARM_SAI_MCLK_PIN_INACTIVE", "group__sai__mclk__pin__control.html#ga7654bffb42e96d48df57c598323337d6", null ],
[ "ARM_SAI_MCLK_PIN_OUTPUT", "group__sai__mclk__pin__control.html#ga24d99edf05699eff32da02742fb04ced", null ],
[ "ARM_SAI_MCLK_PIN_INPUT", "group__sai__mclk__pin__control.html#ga2cd610be9ba9532b2926376deaacf5ad", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__mclk__pin__control.js | JavaScript | apache-2.0 | 386 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>SAI Master Clock Prescaler</title>
<title>CMSIS-Driver: SAI Master Clock Prescaler</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__sai__mclk__pres__control.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">SAI Master Clock Prescaler<div class="ingroups"><a class="el" href="group__sai__configure__control.html">SAI Configuration</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines MCLK prescaler.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga2afa85cd335e75d8b9b06c9f47f3f4b0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__mclk__pres__control.html#ga2afa85cd335e75d8b9b06c9f47f3f4b0">ARM_SAI_MCLK_PRESCALER</a>(n)   ((((n)-1)&0xFFFU) << ARM_SAI_MCLK_PRESCALER_Pos)</td></tr>
<tr class="memdesc:ga2afa85cd335e75d8b9b06c9f47f3f4b0"><td class="mdescLeft"> </td><td class="mdescRight">MCLK prescaler; Audio_frequency = MCLK/n; n = 1..4096 (default=1) <a href="#ga2afa85cd335e75d8b9b06c9f47f3f4b0">More...</a><br/></td></tr>
<tr class="separator:ga2afa85cd335e75d8b9b06c9f47f3f4b0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Defines MCLK prescaler. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga2afa85cd335e75d8b9b06c9f47f3f4b0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_MCLK_PRESCALER</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">n</td><td>)</td>
<td>   ((((n)-1)&0xFFFU) << ARM_SAI_MCLK_PRESCALER_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>MCLK prescaler; Audio_frequency = MCLK/n; n = 1..4096 (default=1) </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__mclk__pres__control.html | HTML | apache-2.0 | 8,109 |
var group__sai__mclk__pres__control =
[
[ "ARM_SAI_MCLK_PRESCALER", "group__sai__mclk__pres__control.html#ga2afa85cd335e75d8b9b06c9f47f3f4b0", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__mclk__pres__control.js | JavaScript | apache-2.0 | 156 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>SAI Mode</title>
<title>CMSIS-Driver: SAI Mode</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__sai__mode__control.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">SAI Mode<div class="ingroups"><a class="el" href="group__sai__configure__control.html">SAI Configuration</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines Transmitter/Receiver mode.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga5bedff714ea0f90139665b72d44daddc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__mode__control.html#ga5bedff714ea0f90139665b72d44daddc">ARM_SAI_MODE_MASTER</a>   (1U << ARM_SAI_MODE_Pos)</td></tr>
<tr class="memdesc:ga5bedff714ea0f90139665b72d44daddc"><td class="mdescLeft"> </td><td class="mdescRight">Master Mode. <a href="#ga5bedff714ea0f90139665b72d44daddc">More...</a><br/></td></tr>
<tr class="separator:ga5bedff714ea0f90139665b72d44daddc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5956c12a24a506754ecc7999f0660bb5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__mode__control.html#ga5956c12a24a506754ecc7999f0660bb5">ARM_SAI_MODE_SLAVE</a>   (0U << ARM_SAI_MODE_Pos)</td></tr>
<tr class="memdesc:ga5956c12a24a506754ecc7999f0660bb5"><td class="mdescLeft"> </td><td class="mdescRight">Slave Mode (default) <a href="#ga5956c12a24a506754ecc7999f0660bb5">More...</a><br/></td></tr>
<tr class="separator:ga5956c12a24a506754ecc7999f0660bb5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Defines Transmitter/Receiver mode. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga5bedff714ea0f90139665b72d44daddc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_MODE_MASTER   (1U << ARM_SAI_MODE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Master Mode. </p>
</div>
</div>
<a class="anchor" id="ga5956c12a24a506754ecc7999f0660bb5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_MODE_SLAVE   (0U << ARM_SAI_MODE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Slave Mode (default) </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__mode__control.html | HTML | apache-2.0 | 8,772 |
var group__sai__mode__control =
[
[ "ARM_SAI_MODE_MASTER", "group__sai__mode__control.html#ga5bedff714ea0f90139665b72d44daddc", null ],
[ "ARM_SAI_MODE_SLAVE", "group__sai__mode__control.html#ga5956c12a24a506754ecc7999f0660bb5", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__mode__control.js | JavaScript | apache-2.0 | 246 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>SAI Mono Mode</title>
<title>CMSIS-Driver: SAI Mono Mode</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__sai__mono__control.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">SAI Mono Mode<div class="ingroups"><a class="el" href="group__sai__configure__control.html">SAI Configuration</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines mono mode.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga0adcd27875d92add813b9664e9cb0b4b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__mono__control.html#ga0adcd27875d92add813b9664e9cb0b4b">ARM_SAI_MONO_MODE</a>   (1U << 19)</td></tr>
<tr class="memdesc:ga0adcd27875d92add813b9664e9cb0b4b"><td class="mdescLeft"> </td><td class="mdescRight">Mono Mode (only for I2S, MSB/LSB justified) <a href="#ga0adcd27875d92add813b9664e9cb0b4b">More...</a><br/></td></tr>
<tr class="separator:ga0adcd27875d92add813b9664e9cb0b4b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Defines mono mode. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga0adcd27875d92add813b9664e9cb0b4b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_MONO_MODE   (1U << 19)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Mono Mode (only for I2S, MSB/LSB justified) </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__mono__control.html | HTML | apache-2.0 | 7,773 |