begriffs open source - cmsis/blob - v6.1.0/Driver/group__common__drv__gr.html

   1 <!-- HTML header for doxygen 1.9.6-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>CMSIS-Driver: Common Driver Definitions</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <script type="text/javascript" src="tabs.js"></script>
  13 <script type="text/javascript" src="footer.js"></script>
  14 <script type="text/javascript" src="navtree.js"></script>
  15 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  16 <script type="text/javascript" src="resize.js"></script>
  17 <script type="text/javascript" src="navtreedata.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="search/searchdata.js"></script>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  24   $(document).ready(function() { init_search(); });
  25 /* @license-end */
  26 </script>
  27 <script type="text/javascript" src="darkmode_toggle.js"></script>
  28 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  29 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  30 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  31 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
  32 <link href="version.css" rel="stylesheet" type="text/css"/>
  33 <script type="text/javascript" src="../../version.js"></script>
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 55px;">
  41   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  42   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  43    <div id="projectname">CMSIS-Driver
  44    &#160;<span id="projectnumber"><script type="text/javascript">
  45      <!--
  46      writeHeader.call(this);
  47      writeVersionDropdown.call(this, "CMSIS-Driver");
  48      //-->
  49     </script>
  50    </span>
  51    </div>
  52    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  53   </td>
  54    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  55         <span class="left">
  56           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  57           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  58                onfocus="searchBox.OnSearchFieldFocus(true)"
  59                onblur="searchBox.OnSearchFieldFocus(false)"
  60                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  61           </span><span class="right">
  62             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  63           </span>
  64         </div>
  65 </td>
  66   <!--END !PROJECT_NAME-->
  67  </tr>
  68  </tbody>
  69 </table>
  70 </div>
  71 <!-- end header part -->
  72 <div id="CMSISnav" class="tabs1">
  73   <ul class="tablist">
  74     <script type="text/javascript">
  75       writeComponentTabs.call(this);
  76     </script>
  77   </ul>
  78 </div>
  79 <script type="text/javascript">
  80   writeSubComponentTabs.call(this);
  81 </script>
  82 <!-- Generated by Doxygen 1.9.6 -->
  83 <script type="text/javascript">
  84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  85 var searchBox = new SearchBox("searchBox", "search/",'.html');
  86 /* @license-end */
  87 </script>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 101 $(document).ready(function(){initNavTree('group__common__drv__gr.html',''); initResizable(); });
 102 /* @license-end */
 103 </script>
 104 <div id="doc-content">
 105 <!-- window showing the filter options -->
 106 <div id="MSearchSelectWindow"
 107      onmouseover="return searchBox.OnSearchSelectShow()"
 108      onmouseout="return searchBox.OnSearchSelectHide()"
 109      onkeydown="return searchBox.OnSearchSelectKey(event)">
 110 </div>
 111
 112 <!-- iframe showing the search results (closed by default) -->
 113 <div id="MSearchResultsWindow">
 114 <div id="MSearchResults">
 115 <div class="SRPage">
 116 <div id="SRIndex">
 117 <div id="SRResults"></div>
 118 <div class="SRStatus" id="Loading">Loading...</div>
 119 <div class="SRStatus" id="Searching">Searching...</div>
 120 <div class="SRStatus" id="NoMatches">No Matches</div>
 121 </div>
 122 </div>
 123 </div>
 124 </div>
 125
 126 <div class="header">
 127   <div class="summary">
 128 <a href="#groups">Content</a> &#124;
 129 <a href="#nested-classes">Data Structures</a> &#124;
 130 <a href="#enum-members">Enumerations</a>  </div>
 131   <div class="headertitle"><div class="title">Common Driver Definitions</div></div>
 132 </div><!--header-->
 133 <div class="contents">
 134
 135 <p>Definitions common in all driver interfaces (Driver_Common.h)
 136 <a href="#details">More...</a></p>
 137 <table class="memberdecls">
 138 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
 139 Content</h2></td></tr>
 140 <tr class="memitem:group__execution__status"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__execution__status.html">Status Error Codes</a></td></tr>
 141 <tr class="memdesc:group__execution__status"><td class="mdescLeft">&#160;</td><td class="mdescRight">Negative return values of functions indicate errors occurred during execution. <br /></td></tr>
 142 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 </table><table class="memberdecls">
 144 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
 145 Data Structures</h2></td></tr>
 146 <tr class="memitem:structARM__DRIVER__VERSION"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></td></tr>
 147 <tr class="memdesc:structARM__DRIVER__VERSION"><td class="mdescLeft">&#160;</td><td class="mdescRight">Driver Version.  <a href="group__common__drv__gr.html#structARM__DRIVER__VERSION">More...</a><br /></td></tr>
 148 <tr class="separator:structARM__DRIVER__VERSION"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 </table><table class="memberdecls">
 150 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
 151 Enumerations</h2></td></tr>
 152 <tr class="memitem:ga47d6d7c31f88f3b8ae4aaf9d8444afa5"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> { <br />
 153 &#160;&#160;<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35">ARM_POWER_OFF</a>
 154 , <br />
 155 &#160;&#160;<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5a9ef9e57cbcc948d0e22314e73dc8c434">ARM_POWER_LOW</a>
 156 , <br />
 157 &#160;&#160;<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a>
 158 <br />
 159  }</td></tr>
 160 <tr class="memdesc:ga47d6d7c31f88f3b8ae4aaf9d8444afa5"><td class="mdescLeft">&#160;</td><td class="mdescRight">General power states.  <a href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">More...</a><br /></td></tr>
 161 <tr class="separator:ga47d6d7c31f88f3b8ae4aaf9d8444afa5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 </table>
 163 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 164 <p>Definitions common in all driver interfaces (Driver_Common.h) </p>
 165 <p>The following definitions are common in all CMSIS-Driver interfaces. Refer to <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a> for a general overview. </p>
 166 <hr/><h2 class="groupheader">Data Structure Documentation</h2>
 167 <a name="structARM__DRIVER__VERSION" id="structARM__DRIVER__VERSION"></a>
 168 <h2 class="memtitle"><span class="permalink"><a href="#structARM__DRIVER__VERSION">&#9670;&#160;</a></span>ARM_DRIVER_VERSION</h2>
 169
 170 <div class="memitem">
 171 <div class="memproto">
 172       <table class="memname">
 173         <tr>
 174           <td class="memname">struct ARM_DRIVER_VERSION</td>
 175         </tr>
 176       </table>
 177 </div><div class="memdoc">
 178 <div class="textblock"><p>Driver Version. </p>
 179 <p>The access structure of each CMSIS-Driver provides the function <b>GetVersion</b>, which returns in the struct <a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION" title="Driver Version.">ARM_DRIVER_VERSION</a>:</p><ul>
 180 <li>API version, which is the version of the CMSIS-Driver specification used to implement this driver.</li>
 181 <li>Driver version, which is the source code version of the actual driver implementation.</li>
 182 </ul>
 183 <p>The version is encoded as 16-bit unsigned value (uint16_t) with:</p><ul>
 184 <li>high-byte: major version.</li>
 185 <li>low-byte: minor version.</li>
 186 </ul>
 187 <p>For example, version 1.12 is encoded as 0x10C. </p>
 188 </div><table class="fieldtable">
 189 <tr><th colspan="3">Data Fields</th></tr>
 190 <tr><td class="fieldtype">
 191 <a id="ad180da20fbde1d3dafc074af87c19540" name="ad180da20fbde1d3dafc074af87c19540"></a>uint16_t</td>
 192 <td class="fieldname">
 193 api</td>
 194 <td class="fielddoc">
 195 API version. </td></tr>
 196 <tr><td class="fieldtype">
 197 <a id="adcd153bc4507926c792e86ebe74e6455" name="adcd153bc4507926c792e86ebe74e6455"></a>uint16_t</td>
 198 <td class="fieldname">
 199 drv</td>
 200 <td class="fielddoc">
 201 Driver version. </td></tr>
 202 </table>
 203
 204 </div>
 205 </div>
 206 <h2 class="groupheader">Enumeration Type Documentation</h2>
 207 <a id="ga47d6d7c31f88f3b8ae4aaf9d8444afa5" name="ga47d6d7c31f88f3b8ae4aaf9d8444afa5"></a>
 208 <h2 class="memtitle"><span class="permalink"><a href="#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">&#9670;&#160;</a></span>ARM_POWER_STATE</h2>
 209
 210 <div class="memitem">
 211 <div class="memproto">
 212       <table class="memname">
 213         <tr>
 214           <td class="memname">enum <a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a></td>
 215         </tr>
 216       </table>
 217 </div><div class="memdoc">
 218
 219 <p>General power states. </p>
 220 <p>The access structure of each CMSIS-Driver provides the function <b>PowerControl</b>, which handles the power profile for a peripheral using the parameter <a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a>. Depending on this parameter, the peripheral will operate at full speed, detect just events, or is completely un-powered.</p>
 221 <p>Refer to <a class="el" href="theoryOperation.html#CallSequence">Function Call Sequence</a> for more information. </p>
 222 <table class="fieldtable">
 223 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35" name="ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35"></a>ARM_POWER_OFF&#160;</td><td class="fielddoc"><p>Power off: no operation possible. </p>
 224 </td></tr>
 225 <tr><td class="fieldname"><a id="ga47d6d7c31f88f3b8ae4aaf9d8444afa5a9ef9e57cbcc948d0e22314e73dc8c434" name="ga47d6d7c31f88f3b8ae4aaf9d8444afa5a9ef9e57cbcc948d0e22314e73dc8c434"></a>ARM_POWER_LOW&#160;</td><td class="fielddoc"><p>Low Power mode: retain state, detect and signal wake-up events. </p>
 226 </td></tr>
 227 <tr><td class="fieldname"><a id="ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e" name="ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e"></a>ARM_POWER_FULL&#160;</td><td class="fielddoc"><p>Power on: full operation at maximum performance. </p>
 228 </td></tr>
 229 </table>
 230
 231 </div>
 232 </div>
 233 </div><!-- contents -->
 234 </div><!-- doc-content -->
 235 <!-- start footer part -->
 236 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 237   <ul>
 238     <li class="footer">
 239       <script type="text/javascript">
 240         <!--
 241         writeFooter.call(this);
 242         //-->
 243       </script>
 244     </li>
 245   </ul>
 246 </div>
 247 </body>
 248 </html>