]> begriffs open source - cmsis/blob - main/Driver/html/driverValidation.html
Update documentation for branch main
[cmsis] / main / Driver / html / 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 <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);
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 <script type="text/javascript">
83   writeSubComponentTabs.call(this);
84 </script>
85 <!-- Generated by Doxygen 1.9.6 -->
86 <script type="text/javascript">
87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
88 var searchBox = new SearchBox("searchBox", "search/",'.html');
89 /* @license-end */
90 </script>
91 </div><!-- top -->
92 <div id="side-nav" class="ui-resizable side-nav-resizable">
93   <div id="nav-tree">
94     <div id="nav-tree-contents">
95       <div id="nav-sync" class="sync"></div>
96     </div>
97   </div>
98   <div id="splitbar" style="-moz-user-select:none;" 
99        class="ui-resizable-handle">
100   </div>
101 </div>
102 <script type="text/javascript">
103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
104 $(document).ready(function(){initNavTree('driverValidation.html',''); initResizable(); });
105 /* @license-end */
106 </script>
107 <div id="doc-content">
108 <!-- window showing the filter options -->
109 <div id="MSearchSelectWindow"
110      onmouseover="return searchBox.OnSearchSelectShow()"
111      onmouseout="return searchBox.OnSearchSelectHide()"
112      onkeydown="return searchBox.OnSearchSelectKey(event)">
113 </div>
114
115 <!-- iframe showing the search results (closed by default) -->
116 <div id="MSearchResultsWindow">
117 <div id="MSearchResults">
118 <div class="SRPage">
119 <div id="SRIndex">
120 <div id="SRResults"></div>
121 <div class="SRStatus" id="Loading">Loading...</div>
122 <div class="SRStatus" id="Searching">Searching...</div>
123 <div class="SRStatus" id="NoMatches">No Matches</div>
124 </div>
125 </div>
126 </div>
127 </div>
128
129 <div><div class="header">
130   <div class="headertitle"><div class="title">Driver Validation </div></div>
131 </div><!--header-->
132 <div class="contents">
133 <div class="textblock"><p>The <a href="https://www.keil.com/pack/" target="_blank">Software Pack</a> named <b>ARM::CMSIS-Driver_Validation</b> contains the following:</p>
134 <ul>
135 <li>Source code of a CMSIS-Driver Validation Suite along with configuration file.</li>
136 <li>Documentation of the CMSIS-Driver Validation Suite.</li>
137 <li>Examples that shows the usage of the CMSIS-Driver Validation Suite on various target platforms.</li>
138 </ul>
139 <p>The CMSIS-Driver Validation Suite performs the following tests:</p><ul>
140 <li>Generic Validation of API function calls</li>
141 <li>Validation of Configuration Parameters</li>
142 <li>Validation of Communication with loopback tests</li>
143 <li>Validation of Communication Parameters such as baudrate</li>
144 <li>Validation of Event functions</li>
145 </ul>
146 <p>The following CMSIS-Drivers can be tested with the current release:</p><ul>
147 <li><a class="el" href="group__can__interface__gr.html">CAN Interface</a> : with loop back test of communication.</li>
148 <li><a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> : MAC and PHY with loop back test of communication.</li>
149 <li><a class="el" href="group__i2c__interface__gr.html">I2C Interface</a> : only API and setup; does not test data transfer.</li>
150 <li><a class="el" href="group__mci__interface__gr.html">MCI Interface</a> : only API and setup; does not test data transfer.</li>
151 <li><a class="el" href="group__spi__interface__gr.html">SPI Interface</a> : with loop back test of communication.</li>
152 <li><a class="el" href="group__usart__interface__gr.html">USART Interface</a> : with loop back test of communication.</li>
153 <li><a class="el" href="group__usbd__interface__gr.html">USB Device Interface</a> : only API and setup; does not test data transfer.</li>
154 <li><a class="el" href="group__usbh__interface__gr.html">USB Host Interface</a> : only API and setup; does not test data transfer.</li>
155 <li><a class="el" href="group__wifi__interface__gr.html">WiFi Interface</a> : extensive tests for WiFi Driver.</li>
156 </ul>
157 <p>The Driver Validation output can be printed to a console or saved in an XML file, via standard output (usually ITM).</p>
158 <h1><a class="anchor" id="test_output"></a>
159 Sample Test Output</h1>
160 <pre class="fragment">CMSIS-Driver USART Test Report   Dec  6 2019   11:44:30 
161
162 TEST 01: USART_GetCapabilities            PASSED
163 TEST 02: USART_Initialization             PASSED
164 TEST 03: USART_PowerControl               
165   DV_USART.c (301): [WARNING] Low power is not supported
166                                           PASSED
167 TEST 04: USART_Config_PolarityPhase       PASSED
168 TEST 05: USART_Config_DataBits            
169   DV_USART.c (387): [WARNING] Data Bits = 9 are not supported
170                                           PASSED
171 TEST 06: USART_Config_StopBits            
172   DV_USART.c (425): [WARNING] Stop Bits = 1.5 are not supported
173   DV_USART.c (429): [WARNING] Stop Bits = 0.5 are not supported
174                                           PASSED
175 TEST 07: USART_Config_Parity              PASSED
176 TEST 08: USART_Config_Baudrate            PASSED
177 TEST 09: USART_Config_CommonParams        PASSED
178 TEST 10: USART_Send                       PASSED
179 TEST 11: USART_AsynchronousReceive        PASSED
180 TEST 12: USART_Loopback_CheckBaudrate     PASSED
181 TEST 13: USART_Loopback_Transfer          PASSED
182 TEST 14: USART_CheckInvalidInit           PASSED
183
184 Test Summary: 14 Tests, 14 Passed, 0 Failed.
185 Test Result: PASSED
186 </pre><h1><a class="anchor" id="loop_back_setup"></a>
187 Setup for Loop Back Communication</h1>
188 <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>
189 <table class="markdownTable">
190 <tr class="markdownTableHead">
191 <th class="markdownTableHeadLeft">Peripheral   </th><th class="markdownTableHeadLeft">Loop Back Configuration    </th></tr>
192 <tr class="markdownTableRowOdd">
193 <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>
194 <tr class="markdownTableRowEven">
195 <td class="markdownTableBodyLeft">SPI   </td><td class="markdownTableBodyLeft">Connect MISO to MOSI    </td></tr>
196 <tr class="markdownTableRowOdd">
197 <td class="markdownTableBodyLeft">USART   </td><td class="markdownTableBodyLeft">Connect TX with RX   </td></tr>
198 </table>
199 <p>The following picture shows the necessary external loop back connections for the Keil MCBSTM32F400 evaluation board:</p><ul>
200 <li>SPI: PB14 (SPI2_MISO) and PB15 (SPI2_MOSI)</li>
201 <li>USART: PB6 (USART1_TX) and PB7 (USART1_RX)</li>
202 <li>Ethernet: Pin 1 (TX+) and Pin 3 (RX+), Pin 2 (TX-) and Pin 6 (RX-)</li>
203 </ul>
204 <div class="image">
205 <img src="image006.png" alt=""/>
206 <div class="caption">
207 Connections for Loop Back Communication Tests on Keil MCBSTM32F400</div></div>
208  </div></div><!-- contents -->
209 </div><!-- PageDoc -->
210 </div><!-- doc-content -->
211 <!-- start footer part -->
212 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
213   <ul>
214     <li class="footer">
215       <script type="text/javascript">
216         <!--
217         writeFooter.call(this);
218         //-->
219       </script> 
220     </li>
221   </ul>
222 </div>
223 </body>
224 </html>