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