begriffs open source - cmsis-driver-validation/blob - docs/html/group__spi__tests__drv__mgmt.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <title>Driver Management</title>
   7 <title>CMSIS-Driver Validation: Driver Management</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <link href="drv.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="printComponentTabs.js"></script>
  13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18   $(window).load(resizeHeight);
  19 </script>
  20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23   $(document).ready(function() { searchBox.OnSelectItem(0); });
  24 </script>
  25 <link href="stylsheetf" rel="stylesheet" type="text/css" />
  26 </head>
  27 <body>
  28 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  29 <div id="titlearea">
  30 <table cellspacing="0" cellpadding="0">
  31  <tbody>
  32  <tr style="height: 46px;">
  33   <td id="projectlogo"><img alt="Logo" src="keilarm.png"/></td>
  34   <td style="padding-left: 0.5em;">
  35    <div id="projectname">CMSIS-Driver Validation
  36    &#160;<span id="projectnumber">Version 3.0.0</span>
  37    </div>
  38    <div id="projectbrief">Driver Validation</div>
  39   </td>
  40  </tr>
  41  </tbody>
  42 </table>
  43 </div>
  44 <!-- end header part -->
  45 <div id="DRVnav" class="tabs1">
  46     <ul class="tablist">
  47       <script type="text/javascript">
  48                 <!--
  49                 writeComponentTabs.call(this);
  50                 //-->
  51       </script>
  52           </ul>
  53 </div>
  54 <!-- Generated by Doxygen 1.8.6 -->
  55 <script type="text/javascript">
  56 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  57 </script>
  58   <div id="navrow1" class="tabs">
  59     <ul class="tablist">
  60       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  61       <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  62       <li><a href="modules.html"><span>Reference</span></a></li>
  63       <li>
  64         <div id="MSearchBox" class="MSearchBoxInactive">
  65         <span class="left">
  66           <img id="MSearchSelect" src="search/mag_sel.png"
  67                onmouseover="return searchBox.OnSearchSelectShow()"
  68                onmouseout="return searchBox.OnSearchSelectHide()"
  69                alt=""/>
  70           <input type="text" id="MSearchField" value="Search" accesskey="S"
  71                onfocus="searchBox.OnSearchFieldFocus(true)"
  72                onblur="searchBox.OnSearchFieldFocus(false)"
  73                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  74           </span><span class="right">
  75             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  76           </span>
  77         </div>
  78       </li>
  79     </ul>
  80   </div>
  81 </div><!-- top -->
  82 <div id="side-nav" class="ui-resizable side-nav-resizable">
  83   <div id="nav-tree">
  84     <div id="nav-tree-contents">
  85       <div id="nav-sync" class="sync"></div>
  86     </div>
  87   </div>
  88   <div id="splitbar" style="-moz-user-select:none;"
  89        class="ui-resizable-handle">
  90   </div>
  91 </div>
  92 <script type="text/javascript">
  93 $(document).ready(function(){initNavTree('group__spi__tests__drv__mgmt.html','');});
  94 </script>
  95 <div id="doc-content">
  96 <!-- window showing the filter options -->
  97 <div id="MSearchSelectWindow"
  98      onmouseover="return searchBox.OnSearchSelectShow()"
  99      onmouseout="return searchBox.OnSearchSelectHide()"
 100      onkeydown="return searchBox.OnSearchSelectKey(event)">
 101 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Pages</a></div>
 102
 103 <!-- iframe showing the search results (closed by default) -->
 104 <div id="MSearchResultsWindow">
 105 <iframe src="javascript:void(0)" frameborder="0"
 106         name="MSearchResults" id="MSearchResults">
 107 </iframe>
 108 </div>
 109
 110 <div class="header">
 111   <div class="summary">
 112 <a href="#func-members">Functions</a>  </div>
 113   <div class="headertitle">
 114 <div class="title">Driver Management<div class="ingroups"><a class="el" href="group__spi__tests.html">Tests</a></div></div>  </div>
 115 </div><!--header-->
 116 <div class="contents">
 117 <table class="memberdecls">
 118 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 119 Functions</h2></td></tr>
 120 <tr class="memitem:ga4a67b9fbf625ac278c06011ea4dc225a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__tests__drv__mgmt.html#ga4a67b9fbf625ac278c06011ea4dc225a">SPI_GetVersion</a> (void)</td></tr>
 121 <tr class="memdesc:ga4a67b9fbf625ac278c06011ea4dc225a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: Function SPI_GetVersion.  <a href="#ga4a67b9fbf625ac278c06011ea4dc225a">More...</a><br/></td></tr>
 122 <tr class="separator:ga4a67b9fbf625ac278c06011ea4dc225a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 123 <tr class="memitem:ga73d306b64a92cb27421a5142042c823c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__tests__drv__mgmt.html#ga73d306b64a92cb27421a5142042c823c">SPI_GetCapabilities</a> (void)</td></tr>
 124 <tr class="memdesc:ga73d306b64a92cb27421a5142042c823c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: Function SPI_GetCapabilities.  <a href="#ga73d306b64a92cb27421a5142042c823c">More...</a><br/></td></tr>
 125 <tr class="separator:ga73d306b64a92cb27421a5142042c823c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 126 <tr class="memitem:ga1f84a363466cd780fcbc4cc0747cefec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__tests__drv__mgmt.html#ga1f84a363466cd780fcbc4cc0747cefec">SPI_Initialize_Uninitialize</a> (void)</td></tr>
 127 <tr class="memdesc:ga1f84a363466cd780fcbc4cc0747cefec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: Function SPI_Initialize_Uninitialize.  <a href="#ga1f84a363466cd780fcbc4cc0747cefec">More...</a><br/></td></tr>
 128 <tr class="separator:ga1f84a363466cd780fcbc4cc0747cefec"><td class="memSeparator" colspan="2">&#160;</td></tr>
 129 <tr class="memitem:gaf9277686b4b32b538df354e2b2c5a6b6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__tests__drv__mgmt.html#gaf9277686b4b32b538df354e2b2c5a6b6">SPI_PowerControl</a> (void)</td></tr>
 130 <tr class="memdesc:gaf9277686b4b32b538df354e2b2c5a6b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: Function SPI_PowerControl.  <a href="#gaf9277686b4b32b538df354e2b2c5a6b6">More...</a><br/></td></tr>
 131 <tr class="separator:gaf9277686b4b32b538df354e2b2c5a6b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 132 </table>
 133 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 134 <p>These tests verify API and operation of the SPI driver management functions.</p>
 135 <p>The driver management tests verify the following driver functions (<a href="http://www.keil.com/pack/doc/CMSIS/Driver/html/group__spi__interface__gr.html" target="_blank">SPI Driver function documentation</a>):</p>
 136 <ul>
 137 <li><b>GetVersion</b> <div class="fragment"><div class="line">ARM_DRIVER_VERSION   GetVersion      (<span class="keywordtype">void</span>);</div>
 138 </div><!-- fragment --></li>
 139 <li><b>GetCapabilities</b> <div class="fragment"><div class="line">ARM_SPI_CAPABILITIES GetCapabilities (<span class="keywordtype">void</span>);</div>
 140 </div><!-- fragment --></li>
 141 <li><b>Initialize</b> <div class="fragment"><div class="line">int32_t              Initialize      (ARM_SPI_SignalEvent_t cb_event);</div>
 142 </div><!-- fragment --></li>
 143 <li><b>Uninitialize</b> <div class="fragment"><div class="line">int32_t              Uninitialize    (<span class="keywordtype">void</span>);</div>
 144 </div><!-- fragment --></li>
 145 <li><b>PowerControl</b> <div class="fragment"><div class="line">int32_t              PowerControl    (ARM_POWER_STATE state);</div>
 146 </div><!-- fragment --> </li>
 147 </ul>
 148 <h2 class="groupheader">Function Documentation</h2>
 149 <a class="anchor" id="ga4a67b9fbf625ac278c06011ea4dc225a"></a>
 150 <div class="memitem">
 151 <div class="memproto">
 152       <table class="memname">
 153         <tr>
 154           <td class="memname">void SPI_GetVersion </td>
 155           <td>(</td>
 156           <td class="paramtype">void&#160;</td>
 157           <td class="paramname"></td><td>)</td>
 158           <td></td>
 159         </tr>
 160       </table>
 161 </div><div class="memdoc">
 162 <p>The function <b>SPI_GetVersion</b> verifies the <b>GetVersion</b> function. </p>
 163 <div class="fragment"><div class="line">ARM_DRIVER_VERSION GetVersion (<span class="keywordtype">void</span>);</div>
 164 </div><!-- fragment --><p>Testing sequence:</p>
 165 <ul>
 166 <li>Driver is uninitialized and peripheral is powered-off:<ul>
 167 <li>Call GetVersion function</li>
 168 <li>Assert that GetVersion function returned version structure with API and implementation versions higher or equal to 1.0 </li>
 169 </ul>
 170 </li>
 171 </ul>
 172
 173 </div>
 174 </div>
 175 <a class="anchor" id="ga73d306b64a92cb27421a5142042c823c"></a>
 176 <div class="memitem">
 177 <div class="memproto">
 178       <table class="memname">
 179         <tr>
 180           <td class="memname">void SPI_GetCapabilities </td>
 181           <td>(</td>
 182           <td class="paramtype">void&#160;</td>
 183           <td class="paramname"></td><td>)</td>
 184           <td></td>
 185         </tr>
 186       </table>
 187 </div><div class="memdoc">
 188 <p>The function <b>SPI_GetCapabilities</b> verifies the <b>GetCapabilities</b> function. </p>
 189 <div class="fragment"><div class="line">ARM_SPI_CAPABILITIES GetCapabilities (<span class="keywordtype">void</span>);</div>
 190 </div><!-- fragment --><p>Testing sequence:</p>
 191 <ul>
 192 <li>Driver is uninitialized and peripheral is powered-off:<ul>
 193 <li>Call GetCapabilities function</li>
 194 <li>Assert that GetCapabilities function returned capabilities structure with reserved field 0 </li>
 195 </ul>
 196 </li>
 197 </ul>
 198
 199 </div>
 200 </div>
 201 <a class="anchor" id="ga1f84a363466cd780fcbc4cc0747cefec"></a>
 202 <div class="memitem">
 203 <div class="memproto">
 204       <table class="memname">
 205         <tr>
 206           <td class="memname">void SPI_Initialize_Uninitialize </td>
 207           <td>(</td>
 208           <td class="paramtype">void&#160;</td>
 209           <td class="paramname"></td><td>)</td>
 210           <td></td>
 211         </tr>
 212       </table>
 213 </div><div class="memdoc">
 214 <p>The function <b>SPI_Initialize_Uninitialize</b> verifies the <b>Initialize</b> and <b>Uninitialize</b> functions. </p>
 215 <div class="fragment"><div class="line">int32_t Initialize (ARM_SPI_SignalEvent_t cb_event);</div>
 216 </div><!-- fragment --> <div class="fragment"><div class="line">int32_t Uninitialize (<span class="keywordtype">void</span>);</div>
 217 </div><!-- fragment --><p>Testing sequence:</p>
 218 <ul>
 219 <li>Driver is uninitialized and peripheral is powered-off:<ul>
 220 <li>Call PowerControl(ARM_POWER_FULL) function and assert that it returned ARM_DRIVER_ERROR status</li>
 221 <li>Call PowerControl(ARM_POWER_LOW) function and assert that it returned ARM_DRIVER_ERROR status</li>
 222 <li>Call PowerControl(ARM_POWER_OFF) function and assert that it returned ARM_DRIVER_ERROR status</li>
 223 <li>Call Send function and assert that it returned ARM_DRIVER_ERROR status</li>
 224 <li>Call Receive function and assert that it returned ARM_DRIVER_ERROR status</li>
 225 <li>Call Transfer function and assert that it returned ARM_DRIVER_ERROR status</li>
 226 <li>Call GetDataCount function and assert that it returned 0</li>
 227 <li>Call Control function and assert that it returned ARM_DRIVER_ERROR status</li>
 228 <li>Call GetStatus function</li>
 229 <li>Assert that GetStatus function returned status structure with busy flag 0</li>
 230 <li>Assert that GetStatus function returned status structure with data_lost flag 0</li>
 231 <li>Assert that GetStatus function returned status structure with mode_fault flag 0</li>
 232 <li>Assert that GetStatus function returned status structure with reserved field 0</li>
 233 <li>Call Initialize function (without callback specified) and assert that it returned ARM_DRIVER_OK status</li>
 234 </ul>
 235 </li>
 236 <li>Driver is initialized and peripheral is powered-off:<ul>
 237 <li>Call Initialize function (without callback specified) again and assert that it returned ARM_DRIVER_OK status</li>
 238 <li>Call Uninitialize function and assert that it returned ARM_DRIVER_OK status</li>
 239 </ul>
 240 </li>
 241 <li>Driver is uninitialized and peripheral is powered-off:<ul>
 242 <li>Call Initialize function (with callback specified) and assert that it returned ARM_DRIVER_OK status</li>
 243 </ul>
 244 </li>
 245 <li>Driver is initialized and peripheral is powered-off:<ul>
 246 <li>Call Initialize function (with callback specified) again and assert that it returned ARM_DRIVER_OK status</li>
 247 <li>Call Uninitialize function and assert that it returned ARM_DRIVER_OK status</li>
 248 </ul>
 249 </li>
 250 <li>Driver is uninitialized and peripheral is powered-off:<ul>
 251 <li>Call Uninitialize function again and assert that it returned ARM_DRIVER_OK status</li>
 252 <li>Call Initialize function (without callback specified) and assert that it returned ARM_DRIVER_OK status</li>
 253 </ul>
 254 </li>
 255 <li>Driver is initialized and peripheral is powered-off:<ul>
 256 <li>Call PowerControl(ARM_POWER_FULL) function and assert that it returned ARM_DRIVER_OK status</li>
 257 </ul>
 258 </li>
 259 <li>Driver is initialized and peripheral is powered-on:<ul>
 260 <li>Call Control function and assert that it returned ARM_DRIVER_OK status</li>
 261 <li>Call Transfer function and assert that it returned ARM_DRIVER_OK status</li>
 262 <li>Call GetStatus function</li>
 263 <li>Assert that GetStatus function returned status structure with busy flag 1</li>
 264 <li>Call Uninitialize function with transfer active and assert that it returned ARM_DRIVER_OK status<br/>
 265  (this must unconditionally terminate active transfer, power-off the peripheral and uninitialize the driver)</li>
 266 </ul>
 267 </li>
 268 <li>Driver is uninitialized and peripheral is powered-off:<ul>
 269 <li>Call GetStatus function</li>
 270 <li>Assert that GetStatus function returned status structure with busy flag 0 </li>
 271 </ul>
 272 </li>
 273 </ul>
 274
 275 </div>
 276 </div>
 277 <a class="anchor" id="gaf9277686b4b32b538df354e2b2c5a6b6"></a>
 278 <div class="memitem">
 279 <div class="memproto">
 280       <table class="memname">
 281         <tr>
 282           <td class="memname">void SPI_PowerControl </td>
 283           <td>(</td>
 284           <td class="paramtype">void&#160;</td>
 285           <td class="paramname"></td><td>)</td>
 286           <td></td>
 287         </tr>
 288       </table>
 289 </div><div class="memdoc">
 290 <p>The function <b>SPI_PowerControl</b> verifies the <b>PowerControl</b> function. </p>
 291 <div class="fragment"><div class="line">int32_t PowerControl (ARM_POWER_STATE state);</div>
 292 </div><!-- fragment --><p>Testing sequence:</p>
 293 <ul>
 294 <li>Driver is initialized and peripheral is powered-off:<ul>
 295 <li>Call Send function and assert that it returned ARM_DRIVER_ERROR status</li>
 296 <li>Call Receive function and assert that it returned ARM_DRIVER_ERROR status</li>
 297 <li>Call Transfer function and assert that it returned ARM_DRIVER_ERROR status</li>
 298 <li>Call GetDataCount function and assert that it returned 0</li>
 299 <li>Call Control function and assert that it returned ARM_DRIVER_ERROR status</li>
 300 <li>Call GetStatus function</li>
 301 <li>Assert that GetStatus function returned status structure with busy flag 0</li>
 302 <li>Assert that GetStatus function returned status structure with data_lost flag 0</li>
 303 <li>Assert that GetStatus function returned status structure with mode_fault flag 0</li>
 304 <li>Assert that GetStatus function returned status structure with reserved field 0</li>
 305 <li>Call PowerControl(ARM_POWER_OFF) and assert that it returned ARM_DRIVER_OK status</li>
 306 <li>Call PowerControl(ARM_POWER_OFF) again and assert that it returned ARM_DRIVER_OK status</li>
 307 <li>Call PowerControl(ARM_POWER_FULL) function and assert that it returned ARM_DRIVER_OK status</li>
 308 </ul>
 309 </li>
 310 <li>Driver is initialized and peripheral is powered-on:<ul>
 311 <li>Call PowerControl(ARM_POWER_FULL) function again and assert that it returned ARM_DRIVER_OK status</li>
 312 <li>Call PowerControl(ARM_POWER_OFF) and assert that it returned ARM_DRIVER_OK status</li>
 313 </ul>
 314 </li>
 315 <li>Driver is initialized and peripheral is powered-off:<ul>
 316 <li>Call PowerControl(ARM_POWER_OFF) again and assert that it returned ARM_DRIVER_OK status</li>
 317 <li>Call PowerControl(ARM_POWER_LOW) function</li>
 318 </ul>
 319 </li>
 320 <li>Driver is initialized and peripheral is powered-on or in low-power mode:<ul>
 321 <li>Assert that PowerControl(ARM_POWER_LOW) function returned ARM_DRIVER_OK or ARM_DRIVER_ERROR_UNSUPPORTED status</li>
 322 <li>Call PowerControl(ARM_POWER_FULL) function and assert that it returned ARM_DRIVER_OK status</li>
 323 </ul>
 324 </li>
 325 <li>Driver is initialized and peripheral is powered-on:<ul>
 326 <li>Call Control function and assert that it returned ARM_DRIVER_OK status</li>
 327 <li>Call Transfer function and assert that it returned ARM_DRIVER_OK status</li>
 328 <li>Call GetStatus function</li>
 329 <li>Assert that GetStatus function returned status structure with busy flag 1</li>
 330 <li>Call PowerControl(ARM_POWER_OFF) function with transfer active and assert that it returned ARM_DRIVER_OK status<br/>
 331  (this must unconditionally terminate active transfer and power-off the peripheral)</li>
 332 </ul>
 333 </li>
 334 <li>Driver is initialized and peripheral is powered-off:<ul>
 335 <li>Call GetStatus function</li>
 336 <li>Assert that GetStatus function returned status structure with busy flag 0 </li>
 337 </ul>
 338 </li>
 339 </ul>
 340
 341 </div>
 342 </div>
 343 </div><!-- contents -->
 344 </div><!-- doc-content -->
 345 <!-- start footer part -->
 346 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 347   <ul>
 348     <li class="footer">Generated on Fri Jul 15 2022 08:42:09 for CMSIS-Driver Validation by ARM Ltd. All rights reserved.
 349         <!--
 350     <a href="http://www.doxygen.org/index.html">
 351     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
 352         -->
 353         </li>
 354   </ul>
 355 </div>
 356 </body>
 357 </html>