begriffs open source - cmsis-driver-validation/blob - docs/html/group__dv__spi.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>SPI Validation</title>
   7 <title>CMSIS-Driver Validation: SPI Validation</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__dv__spi.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="#groups">Content</a>  </div>
 113   <div class="headertitle">
 114 <div class="title">SPI Validation</div>  </div>
 115 </div><!--header-->
 116 <div class="contents">
 117
 118 <p>SPI driver validation.
 119 <a href="#details">More...</a></p>
 120 <table class="memberdecls">
 121 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
 122 Content</h2></td></tr>
 123 <tr class="memitem:group__spi__config"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__config.html">Configuration</a></td></tr>
 124 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 125 <tr class="memitem:group__spi__server"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__server.html">SPI Server</a></td></tr>
 126 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 127 <tr class="memitem:group__spi__tests"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__tests.html">Tests</a></td></tr>
 128 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 129 </table>
 130 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 131 <p>The SPI validation performs the following tests:</p>
 132 <ul>
 133 <li>API interface compliance</li>
 134 <li>Data exchange with various speeds, transfer sizes and communication settings</li>
 135 <li>Event signaling</li>
 136 </ul>
 137 <p>Two Test Modes are available: <b>Loopback</b> and <b>SPI Server</b>.</p>
 138 <h2>Test Mode : <b>Loopback</b> </h2>
 139 <p>This test mode allows only limited validation of the SPI Driver.<br/>
 140  It is recommended that this test mode is used only as a proof that driver is good enough to be tested with the <b>SPI Server</b>.</p>
 141 <p>For this purpose following <b>Default settings</b> should be used:</p>
 142 <ul>
 143 <li>Slave Select: Not used</li>
 144 <li>Clock / Frame Format: Clock Polarity 0, Clock Phase 0</li>
 145 <li>Data Bits: 8</li>
 146 <li>Bit Order: MSB to LSB</li>
 147 <li>Bus Speed: same as setting for the SPI Server</li>
 148 <li>Number of Items: 32</li>
 149 </ul>
 150 <p>To enable this mode of testing in the <b>DV_SPI_Config.h</b> configuration file select the <b>Configuration: Test Mode: Loopback</b> setting.</p>
 151 <p>Required pin connection for the <b>Loopback</b> test mode:</p>
 152 <div class="image">
 153 <img src="spi_loopback_pin_connections.png" alt="spi_loopback_pin_connections.png"/>
 154 </div>
 155 <dl class="section note"><dt>Note</dt><dd>In this mode following operations / settings cannot be tested:<ul>
 156 <li>SPI slave mode</li>
 157 <li>Slave Select line functionality</li>
 158 <li>operation of the Receive function</li>
 159 <li>data content sent by the Send function</li>
 160 <li>clock / frame format and bit order settings</li>
 161 <li>data bit settings other then: 8, 16, 24 and 32</li>
 162 <li>event signaling</li>
 163 </ul>
 164 </dd></dl>
 165 <h2>Test Mode : <b>SPI Server</b> </h2>
 166 <p>This test mode allows extensive validation of the SPI Driver.<br/>
 167  Results of the Driver Validation in this test mode are relevant as a proof of driver compliance to the CMSIS-Driver specification.</p>
 168 <p>To perform extensive communication tests, it is required to use an <a class="el" href="group__spi__server.html">SPI Server</a> running on a dedicated hardware.</p>
 169 <p>To enable this mode of testing in the <b>DV_SPI_Config.h</b> configuration file select the <b>Configuration: Test Mode: SPI Server</b> setting.</p>
 170 <p>Required pin connections for the <b>SPI Server</b> test mode:</p>
 171 <div class="image">
 172 <img src="spi_server_pin_connections.png" alt="spi_server_pin_connections.png"/>
 173 </div>
 174 <dl class="section note"><dt>Note</dt><dd>Slave Select line has to be pulled to Vcc by an external pull-up (for example 10 kOhm). </dd>
 175 <dd>
 176 To ensure proper signal quality:<ul>
 177 <li>keep the connecting wires as short as possible</li>
 178 <li>if possible have SCK and GND wires as a twisted pair and MISO, MOSI and Slave Select wires separate from each other</li>
 179 <li>ensure a good Ground (GND) connection between SPI Server and DUT </li>
 180 </ul>
 181 </dd>
 182 <dd>
 183 If you experience issues with corrupt data content try reducing bus speed. </dd></dl>
 184 </div><!-- contents -->
 185 </div><!-- doc-content -->
 186 <!-- start footer part -->
 187 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 188   <ul>
 189     <li class="footer">Generated on Fri Jul 15 2022 08:42:09 for CMSIS-Driver Validation by ARM Ltd. All rights reserved.
 190         <!--
 191     <a href="http://www.doxygen.org/index.html">
 192     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
 193         -->
 194         </li>
 195   </ul>
 196 </div>
 197 </body>
 198 </html>