begriffs open source - cmsis/blob - main/Driver/driverValidation.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: Driver Validation</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('driverValidation.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><div class="header">
 127   <div class="headertitle"><div class="title">Driver Validation </div></div>
 128 </div><!--header-->
 129 <div class="contents">
 130 <div class="textblock"><p><a class="anchor" id="md_src_validation"></a> Developers can use <b>CMSIS-Driver Validation</b> framework to verify that an implementation of a peripheral driver is compliant with the corresponding CMSIS-Driver Specification. Verified drivers can then be reliably used with middleware components and user applications that rely on CMSIS-Driver APIs.</p>
 131 <p>The CMSIS-Driver Validation is maintained in a separate public <a href="https://github.com/ARM-software/CMSIS-Driver_Validation">GitHub repository</a>, and is also released as a <a href="https://www.keil.arm.com/packs/">CMSIS Software Pack</a> named <b>ARM::CMSIS-Driver_Validation</b>.</p>
 132 <p>This page gives an overview about driver validation. Refer to <a href="https://arm-software.github.io/CMSIS-Driver_Validation/latest/index.html">CMSIS-Driver Validation Guide</a>) for full documentation.</p>
 133 <p>The CMSIS-Driver Validation Suite performs the following tests:</p>
 134 <ul>
 135 <li>Generic Validation of API function calls</li>
 136 <li>Validation of Configuration Parameters</li>
 137 <li>Validation of Communication with loopback tests</li>
 138 <li>Validation of Communication Parameters such as baudrate</li>
 139 <li>Validation of Event functions</li>
 140 </ul>
 141 <p>The following CMSIS-Drivers can be tested with the current release:</p>
 142 <ul>
 143 <li><a class="el" href="group__can__interface__gr.html">CAN Interface</a> : with loop back test of communication.</li>
 144 <li><a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> : MAC and PHY with loop back test of communication.</li>
 145 <li><a class="el" href="group__i2c__interface__gr.html">I2C Interface</a> : only API and setup; does not test data transfer.</li>
 146 <li><a class="el" href="group__mci__interface__gr.html">MCI Interface</a> : only API and setup; does not test data transfer.</li>
 147 <li><a class="el" href="group__spi__interface__gr.html">SPI Interface</a> : with loop back test of communication.</li>
 148 <li><a class="el" href="group__usart__interface__gr.html">USART Interface</a> : with loop back test of communication.</li>
 149 <li><a class="el" href="group__usbd__interface__gr.html">USB Device Interface</a> : only API and setup; does not test data transfer.</li>
 150 <li><a class="el" href="group__usbh__interface__gr.html">USB Host Interface</a> : only API and setup; does not test data transfer.</li>
 151 <li><a class="el" href="group__wifi__interface__gr.html">WiFi Interface</a> : extensive tests for WiFi Driver.</li>
 152 </ul>
 153 <h1><a class="anchor" id="test_output"></a>
 154 Sample Test Output</h1>
 155 <p>The Driver Validation output can be printed to a console or saved in an XML file, via standard output (usually ITM).</p>
 156 <div class="fragment"><div class="line">CMSIS-Driver USART Test Report   Dec  6 2019   11:44:30</div>
 157 <div class="line"> </div>
 158 <div class="line">TEST 01: USART_GetCapabilities            PASSED</div>
 159 <div class="line">TEST 02: USART_Initialization             PASSED</div>
 160 <div class="line">TEST 03: USART_PowerControl</div>
 161 <div class="line">  DV_USART.c (301): [WARNING] Low power is not supported</div>
 162 <div class="line">                                          PASSED</div>
 163 <div class="line">TEST 04: USART_Config_PolarityPhase       PASSED</div>
 164 <div class="line">TEST 05: USART_Config_DataBits</div>
 165 <div class="line">  DV_USART.c (387): [WARNING] Data Bits = 9 are not supported</div>
 166 <div class="line">                                          PASSED</div>
 167 <div class="line">TEST 06: USART_Config_StopBits</div>
 168 <div class="line">  DV_USART.c (425): [WARNING] Stop Bits = 1.5 are not supported</div>
 169 <div class="line">  DV_USART.c (429): [WARNING] Stop Bits = 0.5 are not supported</div>
 170 <div class="line">                                          PASSED</div>
 171 <div class="line">TEST 07: USART_Config_Parity              PASSED</div>
 172 <div class="line">TEST 08: USART_Config_Baudrate            PASSED</div>
 173 <div class="line">TEST 09: USART_Config_CommonParams        PASSED</div>
 174 <div class="line">TEST 10: USART_Send                       PASSED</div>
 175 <div class="line">TEST 11: USART_AsynchronousReceive        PASSED</div>
 176 <div class="line">TEST 12: USART_Loopback_CheckBaudrate     PASSED</div>
 177 <div class="line">TEST 13: USART_Loopback_Transfer          PASSED</div>
 178 <div class="line">TEST 14: USART_CheckInvalidInit           PASSED</div>
 179 <div class="line"> </div>
 180 <div class="line">Test Summary: 14 Tests, 14 Passed, 0 Failed.</div>
 181 <div class="line">Test Result: PASSED</div>
 182 </div><!-- fragment --><h1><a class="anchor" id="loop_back_setup"></a>
 183 Setup for Loop Back Communication</h1>
 184 <p>To perform loop back communication tests it is required to connect the input and the output of the peripherals as shown in this table:</p>
 185 <table class="markdownTable">
 186 <tr class="markdownTableHead">
 187 <th class="markdownTableHeadLeft">Peripheral   </th><th class="markdownTableHeadLeft">Loop Back Configuration    </th></tr>
 188 <tr class="markdownTableRowOdd">
 189 <td class="markdownTableBodyLeft">Ethernet   </td><td class="markdownTableBodyLeft">Connect TX+ (Pin 1) with RX+ (Pin 3), TX- (Pin 2) with RX- (Pin 6)    </td></tr>
 190 <tr class="markdownTableRowEven">
 191 <td class="markdownTableBodyLeft">SPI   </td><td class="markdownTableBodyLeft">Connect MISO to MOSI    </td></tr>
 192 <tr class="markdownTableRowOdd">
 193 <td class="markdownTableBodyLeft">USART   </td><td class="markdownTableBodyLeft">Connect TX with RX   </td></tr>
 194 </table>
 195 <p>The following picture shows the necessary external loop back connections for the Keil MCBSTM32F400 evaluation board:</p>
 196 <ul>
 197 <li>SPI: PB14 (SPI2_MISO) and PB15 (SPI2_MOSI)</li>
 198 <li>USART: PB6 (USART1_TX) and PB7 (USART1_RX)</li>
 199 <li>Ethernet: Pin 1 (TX+) and Pin 3 (RX+), Pin 2 (TX-) and Pin 6 (RX-)</li>
 200 </ul>
 201 <div class="image">
 202 <img src="image006.png" alt=""/>
 203 <div class="caption">
 204 Connections for Loop Back Communication Tests on Keil MCBSTM32F400</div></div>
 205      </div></div><!-- contents -->
 206 </div><!-- PageDoc -->
 207 </div><!-- doc-content -->
 208 <!-- start footer part -->
 209 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 210   <ul>
 211     <li class="footer">
 212       <script type="text/javascript">
 213         <!--
 214         writeFooter.call(this);
 215         //-->
 216       </script>
 217     </li>
 218   </ul>
 219 </div>
 220 </body>
 221 </html>