begriffs open source - cmsis-driver-validation/blob - docs/html/group__spi__tests__evt.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>Event</title>
   7 <title>CMSIS-Driver Validation: Event</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__evt.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">Event<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:ga8ee8300df96447854b4bd435e2cd1bd9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__tests__evt.html#ga8ee8300df96447854b4bd435e2cd1bd9">SPI_DataLost</a> (void)</td></tr>
 121 <tr class="memdesc:ga8ee8300df96447854b4bd435e2cd1bd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: Function SPI_DataLost.  <a href="#ga8ee8300df96447854b4bd435e2cd1bd9">More...</a><br/></td></tr>
 122 <tr class="separator:ga8ee8300df96447854b4bd435e2cd1bd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 123 <tr class="memitem:gae5aa9107a73024bd68d883b638960f8f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__tests__evt.html#gae5aa9107a73024bd68d883b638960f8f">SPI_ModeFault</a> (void)</td></tr>
 124 <tr class="memdesc:gae5aa9107a73024bd68d883b638960f8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: Function SPI_ModeFault.  <a href="#gae5aa9107a73024bd68d883b638960f8f">More...</a><br/></td></tr>
 125 <tr class="separator:gae5aa9107a73024bd68d883b638960f8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 126 </table>
 127 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 128 <p>These tests verify API and operation of the SPI event signaling, except ARM_SPI_EVENT_TRANSFER_COMPLETE signal which is tested in the Data Exchange tests.</p>
 129 <p>The event tests verify the following driver function (<a href="http://www.keil.com/pack/doc/CMSIS/Driver/html/group__spi__interface__gr.html" target="_blank">SPI Driver function documentation</a>):</p>
 130 <ul>
 131 <li><b>SignalEvent</b> <div class="fragment"><div class="line">void (*ARM_SPI_SignalEvent_t) (uint32_t event);</div>
 132 </div><!-- fragment --></li>
 133 </ul>
 134 <dl class="section note"><dt>Note</dt><dd>In Test Mode <b>Loopback</b> these tests are not executed </dd></dl>
 135 <h2 class="groupheader">Function Documentation</h2>
 136 <a class="anchor" id="ga8ee8300df96447854b4bd435e2cd1bd9"></a>
 137 <div class="memitem">
 138 <div class="memproto">
 139       <table class="memname">
 140         <tr>
 141           <td class="memname">void SPI_DataLost </td>
 142           <td>(</td>
 143           <td class="paramtype">void&#160;</td>
 144           <td class="paramname"></td><td>)</td>
 145           <td></td>
 146         </tr>
 147       </table>
 148 </div><div class="memdoc">
 149 <p>The function <b>SPI_DataLost</b> verifies signaling of the <b>ARM_SPI_EVENT_DATA_LOST</b> event:</p>
 150 <ul>
 151 <li>in <b>Slave Mode</b> with <b>Slave Select line Hardware monitored</b></li>
 152 <li>with default clock / frame format</li>
 153 <li>with default data bits</li>
 154 <li>with default bit order</li>
 155 <li>at default bus speed</li>
 156 </ul>
 157 <p>it also checks that status data_lost flag was activated. </p>
 158
 159 </div>
 160 </div>
 161 <a class="anchor" id="gae5aa9107a73024bd68d883b638960f8f"></a>
 162 <div class="memitem">
 163 <div class="memproto">
 164       <table class="memname">
 165         <tr>
 166           <td class="memname">void SPI_ModeFault </td>
 167           <td>(</td>
 168           <td class="paramtype">void&#160;</td>
 169           <td class="paramname"></td><td>)</td>
 170           <td></td>
 171         </tr>
 172       </table>
 173 </div><div class="memdoc">
 174 <p>The function <b>SPI_ModeFault</b> verifies signaling of the <b>ARM_SPI_EVENT_MODE_FAULT</b> event:</p>
 175 <ul>
 176 <li>in <b>Master Mode</b> with <b>Slave Select line Hardware monitored Input</b></li>
 177 <li>with default clock / frame format</li>
 178 <li>with default data bits</li>
 179 <li>with default bit order</li>
 180 <li>at default bus speed</li>
 181 </ul>
 182 <p>it also checks that status mode_fault flag was activated. </p>
 183
 184 </div>
 185 </div>
 186 </div><!-- contents -->
 187 </div><!-- doc-content -->
 188 <!-- start footer part -->
 189 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 190   <ul>
 191     <li class="footer">Generated on Fri Jul 15 2022 08:42:09 for CMSIS-Driver Validation by ARM Ltd. All rights reserved.
 192         <!--
 193     <a href="http://www.doxygen.org/index.html">
 194     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
 195         -->
 196         </li>
 197   </ul>
 198 </div>
 199 </body>
 200 </html>