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