begriffs open source - cmsis/blob - main/Driver/html/group__spi__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, "CMSIS-Driver");
  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 <!-- 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__spi__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__spi__interface__gr.html">SPI Interface</a> &#124; <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 values indicate errors (SPI has specific codes in addition to common <a class="el" href="group__execution__status.html">Status Error Codes</a>).
 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:ga273a55c5d19491c565e5f05d03d66f3f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__execution__status.html#ga273a55c5d19491c565e5f05d03d66f3f">ARM_SPI_ERROR_MODE</a>&#160;&#160;&#160;(<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 1)</td></tr>
 139 <tr class="memdesc:ga273a55c5d19491c565e5f05d03d66f3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specified Mode not supported.  <br /></td></tr>
 140 <tr class="separator:ga273a55c5d19491c565e5f05d03d66f3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:gac47584fe5691889c056611bc589b25aa"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__execution__status.html#gac47584fe5691889c056611bc589b25aa">ARM_SPI_ERROR_FRAME_FORMAT</a>&#160;&#160;&#160;(<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 2)</td></tr>
 142 <tr class="memdesc:gac47584fe5691889c056611bc589b25aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specified Frame Format not supported.  <br /></td></tr>
 143 <tr class="separator:gac47584fe5691889c056611bc589b25aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:ga76f895d3380ca474124f83acbebc5651"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__execution__status.html#ga76f895d3380ca474124f83acbebc5651">ARM_SPI_ERROR_DATA_BITS</a>&#160;&#160;&#160;(<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 3)</td></tr>
 145 <tr class="memdesc:ga76f895d3380ca474124f83acbebc5651"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specified number of Data bits not supported.  <br /></td></tr>
 146 <tr class="separator:ga76f895d3380ca474124f83acbebc5651"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:ga6b8ac31930ea6ca3a9635f2ac935466d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__execution__status.html#ga6b8ac31930ea6ca3a9635f2ac935466d">ARM_SPI_ERROR_BIT_ORDER</a>&#160;&#160;&#160;(<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 4)</td></tr>
 148 <tr class="memdesc:ga6b8ac31930ea6ca3a9635f2ac935466d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specified Bit order not supported.  <br /></td></tr>
 149 <tr class="separator:ga6b8ac31930ea6ca3a9635f2ac935466d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:gaae7b1a1feb46faa1830c92b73bd775ad"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__execution__status.html#gaae7b1a1feb46faa1830c92b73bd775ad">ARM_SPI_ERROR_SS_MODE</a>&#160;&#160;&#160;(<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 5)</td></tr>
 151 <tr class="memdesc:gaae7b1a1feb46faa1830c92b73bd775ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specified Slave Select Mode not supported.  <br /></td></tr>
 152 <tr class="separator:gaae7b1a1feb46faa1830c92b73bd775ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 </table>
 154 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 155 <p>Negative values indicate errors (SPI has specific codes in addition to common <a class="el" href="group__execution__status.html">Status Error Codes</a>). </p>
 156 <p>The SPI driver has additional status error codes that are listed below. Note that the SPI driver also returns the common <a class="el" href="group__execution__status.html">Status Error Codes</a>. </p>
 157 <h2 class="groupheader">Macro Definition Documentation</h2>
 158 <a id="ga273a55c5d19491c565e5f05d03d66f3f" name="ga273a55c5d19491c565e5f05d03d66f3f"></a>
 159 <h2 class="memtitle"><span class="permalink"><a href="#ga273a55c5d19491c565e5f05d03d66f3f">&#9670;&#160;</a></span>ARM_SPI_ERROR_MODE</h2>
 160
 161 <div class="memitem">
 162 <div class="memproto">
 163       <table class="memname">
 164         <tr>
 165           <td class="memname">#define ARM_SPI_ERROR_MODE&#160;&#160;&#160;(<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 1)</td>
 166         </tr>
 167       </table>
 168 </div><div class="memdoc">
 169
 170 <p>Specified Mode not supported. </p>
 171 <p>The <b>mode</b> requested with the function <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> is not supported by this driver. </p>
 172
 173 </div>
 174 </div>
 175 <a id="gac47584fe5691889c056611bc589b25aa" name="gac47584fe5691889c056611bc589b25aa"></a>
 176 <h2 class="memtitle"><span class="permalink"><a href="#gac47584fe5691889c056611bc589b25aa">&#9670;&#160;</a></span>ARM_SPI_ERROR_FRAME_FORMAT</h2>
 177
 178 <div class="memitem">
 179 <div class="memproto">
 180       <table class="memname">
 181         <tr>
 182           <td class="memname">#define ARM_SPI_ERROR_FRAME_FORMAT&#160;&#160;&#160;(<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 2)</td>
 183         </tr>
 184       </table>
 185 </div><div class="memdoc">
 186
 187 <p>Specified Frame Format not supported. </p>
 188 <p>The <b>frame format</b> requested with the function <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> is not supported by this driver. </p>
 189
 190 </div>
 191 </div>
 192 <a id="ga76f895d3380ca474124f83acbebc5651" name="ga76f895d3380ca474124f83acbebc5651"></a>
 193 <h2 class="memtitle"><span class="permalink"><a href="#ga76f895d3380ca474124f83acbebc5651">&#9670;&#160;</a></span>ARM_SPI_ERROR_DATA_BITS</h2>
 194
 195 <div class="memitem">
 196 <div class="memproto">
 197       <table class="memname">
 198         <tr>
 199           <td class="memname">#define ARM_SPI_ERROR_DATA_BITS&#160;&#160;&#160;(<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 3)</td>
 200         </tr>
 201       </table>
 202 </div><div class="memdoc">
 203
 204 <p>Specified number of Data bits not supported. </p>
 205 <p>The number of <b>data bits</b> requested with the function <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> is not supported by this driver. </p>
 206
 207 </div>
 208 </div>
 209 <a id="ga6b8ac31930ea6ca3a9635f2ac935466d" name="ga6b8ac31930ea6ca3a9635f2ac935466d"></a>
 210 <h2 class="memtitle"><span class="permalink"><a href="#ga6b8ac31930ea6ca3a9635f2ac935466d">&#9670;&#160;</a></span>ARM_SPI_ERROR_BIT_ORDER</h2>
 211
 212 <div class="memitem">
 213 <div class="memproto">
 214       <table class="memname">
 215         <tr>
 216           <td class="memname">#define ARM_SPI_ERROR_BIT_ORDER&#160;&#160;&#160;(<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 4)</td>
 217         </tr>
 218       </table>
 219 </div><div class="memdoc">
 220
 221 <p>Specified Bit order not supported. </p>
 222 <p>The <b>bit order</b> requested with the function <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> is not supported by this driver. </p>
 223
 224 </div>
 225 </div>
 226 <a id="gaae7b1a1feb46faa1830c92b73bd775ad" name="gaae7b1a1feb46faa1830c92b73bd775ad"></a>
 227 <h2 class="memtitle"><span class="permalink"><a href="#gaae7b1a1feb46faa1830c92b73bd775ad">&#9670;&#160;</a></span>ARM_SPI_ERROR_SS_MODE</h2>
 228
 229 <div class="memitem">
 230 <div class="memproto">
 231       <table class="memname">
 232         <tr>
 233           <td class="memname">#define ARM_SPI_ERROR_SS_MODE&#160;&#160;&#160;(<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 5)</td>
 234         </tr>
 235       </table>
 236 </div><div class="memdoc">
 237
 238 <p>Specified Slave Select Mode not supported. </p>
 239 <p>The <b>slave select mode</b> requested with the function <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> is not supported by this driver. </p>
 240
 241 </div>
 242 </div>
 243 </div><!-- contents -->
 244 </div><!-- doc-content -->
 245 <!-- start footer part -->
 246 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 247   <ul>
 248     <li class="footer">
 249       <script type="text/javascript">
 250         <!--
 251         writeFooter.call(this);
 252         //-->
 253       </script>
 254     </li>
 255   </ul>
 256 </div>
 257 </body>
 258 </html>