begriffs open source - cmsis/blob - main/Driver/html/group__execution__status.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: Status Error Codes</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__execution__status.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="#define-members">Macros</a>  </div>
 132   <div class="headertitle"><div class="title">Status Error Codes<div class="ingroups"><a class="el" href="group__common__drv__gr.html">Common Driver Definitions</a></div></div></div>
 133 </div><!--header-->
 134 <div class="contents">
 135
 136 <p>Negative return values of functions indicate errors occurred during execution.
 137 <a href="#details">More...</a></p>
 138 <table class="memberdecls">
 139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 140 Macros</h2></td></tr>
 141 <tr class="memitem:ga85752c5de59e8adeb001e35ff5be6be7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>&#160;&#160;&#160;0</td></tr>
 142 <tr class="memdesc:ga85752c5de59e8adeb001e35ff5be6be7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operation succeeded.  <br /></td></tr>
 143 <tr class="separator:ga85752c5de59e8adeb001e35ff5be6be7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:ga2f627075447749bb368d3b768be107cb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__execution__status.html#ga2f627075447749bb368d3b768be107cb">ARM_DRIVER_ERROR</a>&#160;&#160;&#160;-1</td></tr>
 145 <tr class="memdesc:ga2f627075447749bb368d3b768be107cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unspecified error.  <br /></td></tr>
 146 <tr class="separator:ga2f627075447749bb368d3b768be107cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:ga13c1123319c7b9a4735d63447f35116b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__execution__status.html#ga13c1123319c7b9a4735d63447f35116b">ARM_DRIVER_ERROR_BUSY</a>&#160;&#160;&#160;-2</td></tr>
 148 <tr class="memdesc:ga13c1123319c7b9a4735d63447f35116b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Driver is busy.  <br /></td></tr>
 149 <tr class="separator:ga13c1123319c7b9a4735d63447f35116b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:ga0bac892205bb2d586b822e8b178ab310"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__execution__status.html#ga0bac892205bb2d586b822e8b178ab310">ARM_DRIVER_ERROR_TIMEOUT</a>&#160;&#160;&#160;-3</td></tr>
 151 <tr class="memdesc:ga0bac892205bb2d586b822e8b178ab310"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timeout occurred.  <br /></td></tr>
 152 <tr class="separator:ga0bac892205bb2d586b822e8b178ab310"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:ga2efa59e480d82697795439220e6884e4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a>&#160;&#160;&#160;-4</td></tr>
 154 <tr class="memdesc:ga2efa59e480d82697795439220e6884e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operation not supported.  <br /></td></tr>
 155 <tr class="separator:ga2efa59e480d82697795439220e6884e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:gac781d4b70ce17c4c2efe2db045be751c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__execution__status.html#gac781d4b70ce17c4c2efe2db045be751c">ARM_DRIVER_ERROR_PARAMETER</a>&#160;&#160;&#160;-5</td></tr>
 157 <tr class="memdesc:gac781d4b70ce17c4c2efe2db045be751c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parameter error.  <br /></td></tr>
 158 <tr class="separator:gac781d4b70ce17c4c2efe2db045be751c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 <tr class="memitem:ga5a2b5d68f6649598d099b88c0eaee3e5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a>&#160;&#160;&#160;-6</td></tr>
 160 <tr class="memdesc:ga5a2b5d68f6649598d099b88c0eaee3e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start of driver specific errors.  <br /></td></tr>
 161 <tr class="separator:ga5a2b5d68f6649598d099b88c0eaee3e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 </table>
 163 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 164 <p>Negative return values of functions indicate errors occurred during execution. </p>
 165 <p>Most functions return a status information using negative return values. The following list provides the status error codes that are common in all drivers. The drivers may return also status error codes that are specific to the peripheral. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__spi__execution__status.html">SPI Status Error Codes</a> for SPI driver; <a class="el" href="group__usart__execution__status.html">USART Status Error Codes</a> for USART driver; <a class="el" href="group__nand__execution__status.html">NAND Status Error Codes</a> for NAND driver; </dd></dl>
 166 <h2 class="groupheader">Macro Definition Documentation</h2>
 167 <a id="ga85752c5de59e8adeb001e35ff5be6be7" name="ga85752c5de59e8adeb001e35ff5be6be7"></a>
 168 <h2 class="memtitle"><span class="permalink"><a href="#ga85752c5de59e8adeb001e35ff5be6be7">&#9670;&#160;</a></span>ARM_DRIVER_OK</h2>
 169
 170 <div class="memitem">
 171 <div class="memproto">
 172       <table class="memname">
 173         <tr>
 174           <td class="memname">#define ARM_DRIVER_OK&#160;&#160;&#160;0</td>
 175         </tr>
 176       </table>
 177 </div><div class="memdoc">
 178
 179 <p>Operation succeeded. </p>
 180 <p>The value 0 or positive values indicate that the function execution is completed without any errors. Note that positive values are used to provide for example the number of data items. </p>
 181
 182 </div>
 183 </div>
 184 <a id="ga2f627075447749bb368d3b768be107cb" name="ga2f627075447749bb368d3b768be107cb"></a>
 185 <h2 class="memtitle"><span class="permalink"><a href="#ga2f627075447749bb368d3b768be107cb">&#9670;&#160;</a></span>ARM_DRIVER_ERROR</h2>
 186
 187 <div class="memitem">
 188 <div class="memproto">
 189       <table class="memname">
 190         <tr>
 191           <td class="memname">#define ARM_DRIVER_ERROR&#160;&#160;&#160;-1</td>
 192         </tr>
 193       </table>
 194 </div><div class="memdoc">
 195
 196 <p>Unspecified error. </p>
 197 <p>The function did not execute correct and an unspecified error occurred during execution. </p>
 198
 199 </div>
 200 </div>
 201 <a id="ga13c1123319c7b9a4735d63447f35116b" name="ga13c1123319c7b9a4735d63447f35116b"></a>
 202 <h2 class="memtitle"><span class="permalink"><a href="#ga13c1123319c7b9a4735d63447f35116b">&#9670;&#160;</a></span>ARM_DRIVER_ERROR_BUSY</h2>
 203
 204 <div class="memitem">
 205 <div class="memproto">
 206       <table class="memname">
 207         <tr>
 208           <td class="memname">#define ARM_DRIVER_ERROR_BUSY&#160;&#160;&#160;-2</td>
 209         </tr>
 210       </table>
 211 </div><div class="memdoc">
 212
 213 <p>Driver is busy. </p>
 214 <p>The function cannot be executed because the driver is busy with the execution of a conflicting operation. </p>
 215
 216 </div>
 217 </div>
 218 <a id="ga0bac892205bb2d586b822e8b178ab310" name="ga0bac892205bb2d586b822e8b178ab310"></a>
 219 <h2 class="memtitle"><span class="permalink"><a href="#ga0bac892205bb2d586b822e8b178ab310">&#9670;&#160;</a></span>ARM_DRIVER_ERROR_TIMEOUT</h2>
 220
 221 <div class="memitem">
 222 <div class="memproto">
 223       <table class="memname">
 224         <tr>
 225           <td class="memname">#define ARM_DRIVER_ERROR_TIMEOUT&#160;&#160;&#160;-3</td>
 226         </tr>
 227       </table>
 228 </div><div class="memdoc">
 229
 230 <p>Timeout occurred. </p>
 231 <p>The function execution is terminated because a peripheral did not react within a specific timeout limit. </p>
 232
 233 </div>
 234 </div>
 235 <a id="ga2efa59e480d82697795439220e6884e4" name="ga2efa59e480d82697795439220e6884e4"></a>
 236 <h2 class="memtitle"><span class="permalink"><a href="#ga2efa59e480d82697795439220e6884e4">&#9670;&#160;</a></span>ARM_DRIVER_ERROR_UNSUPPORTED</h2>
 237
 238 <div class="memitem">
 239 <div class="memproto">
 240       <table class="memname">
 241         <tr>
 242           <td class="memname">#define ARM_DRIVER_ERROR_UNSUPPORTED&#160;&#160;&#160;-4</td>
 243         </tr>
 244       </table>
 245 </div><div class="memdoc">
 246
 247 <p>Operation not supported. </p>
 248 <p>The function requested an operation (for example by using an illegal control code) that is not supported. </p>
 249
 250 </div>
 251 </div>
 252 <a id="gac781d4b70ce17c4c2efe2db045be751c" name="gac781d4b70ce17c4c2efe2db045be751c"></a>
 253 <h2 class="memtitle"><span class="permalink"><a href="#gac781d4b70ce17c4c2efe2db045be751c">&#9670;&#160;</a></span>ARM_DRIVER_ERROR_PARAMETER</h2>
 254
 255 <div class="memitem">
 256 <div class="memproto">
 257       <table class="memname">
 258         <tr>
 259           <td class="memname">#define ARM_DRIVER_ERROR_PARAMETER&#160;&#160;&#160;-5</td>
 260         </tr>
 261       </table>
 262 </div><div class="memdoc">
 263
 264 <p>Parameter error. </p>
 265 <p>A function parameter is incorrect. </p>
 266
 267 </div>
 268 </div>
 269 <a id="ga5a2b5d68f6649598d099b88c0eaee3e5" name="ga5a2b5d68f6649598d099b88c0eaee3e5"></a>
 270 <h2 class="memtitle"><span class="permalink"><a href="#ga5a2b5d68f6649598d099b88c0eaee3e5">&#9670;&#160;</a></span>ARM_DRIVER_ERROR_SPECIFIC</h2>
 271
 272 <div class="memitem">
 273 <div class="memproto">
 274       <table class="memname">
 275         <tr>
 276           <td class="memname">#define ARM_DRIVER_ERROR_SPECIFIC&#160;&#160;&#160;-6</td>
 277         </tr>
 278       </table>
 279 </div><div class="memdoc">
 280
 281 <p>Start of driver specific errors. </p>
 282 <p>This value indicates the start of status error codes that are specific to the peripheral driver. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__spi__execution__status.html">SPI Status Error Codes</a> for SPI driver; <a class="el" href="group__usart__execution__status.html">USART Status Error Codes</a> for USART driver; </dd></dl>
 283
 284 </div>
 285 </div>
 286 </div><!-- contents -->
 287 </div><!-- doc-content -->
 288 <!-- start footer part -->
 289 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 290   <ul>
 291     <li class="footer">
 292       <script type="text/javascript">
 293         <!--
 294         writeFooter.call(this);
 295         //-->
 296       </script>
 297     </li>
 298   </ul>
 299 </div>
 300 </body>
 301 </html>