begriffs open source - cmsis-driver-validation/blob - docs/html/group__dv__usart.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>USART Validation</title>
   7 <title>CMSIS-Driver Validation: USART 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__usart.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">USART Validation</div>  </div>
 115 </div><!--header-->
 116 <div class="contents">
 117
 118 <p>USART 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__usart__config"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__config.html">Configuration</a></td></tr>
 124 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 125 <tr class="memitem:group__usart__server"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__server.html">USART Server</a></td></tr>
 126 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 127 <tr class="memitem:group__usart__tests"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__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 USART 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>Modem lines operation</li>
 136 <li>Event signaling</li>
 137 </ul>
 138 <p>Two Test Modes are available: <b>Loopback</b> and <b>USART Server</b>.</p>
 139 <h2>Test Mode : <b>Loopback</b> </h2>
 140 <p>This test mode allows only limited validation of the USART Driver.<br/>
 141  It is recommended that this test mode is used only as a proof that driver is good enough to be tested with the <b>USART Server</b>.</p>
 142 <p>For this purpose following <b>Default settings</b> should be used:</p>
 143 <ul>
 144 <li>Mode: Asynchronous</li>
 145 <li>Data Bits: 8</li>
 146 <li>Parity: None</li>
 147 <li>Stop Bits: 1</li>
 148 <li>Flow control: No</li>
 149 <li>Clock Polarity: Clock Polarity 0</li>
 150 <li>Clock Phase: Clock Phase 0</li>
 151 <li>Baudrate: 115200</li>
 152 <li>Number of Items: 32</li>
 153 </ul>
 154 <p>To enable this mode of testing in the <b>DV_USART_Config.h</b> configuration file select the <b>Configuration: Test Mode: Loopback</b> setting.</p>
 155 <p>Required pin connection for the <b>Loopback</b> test mode:</p>
 156 <div class="image">
 157 <img src="usart_loopback_pin_connections.png" alt="usart_loopback_pin_connections.png"/>
 158 </div>
 159 <dl class="section note"><dt>Note</dt><dd>In this mode following operations / settings cannot be tested:<ul>
 160 <li>synchronous slave or single-wire modes</li>
 161 <li>operation of the Receive function</li>
 162 <li>data content sent by the Send function</li>
 163 <li>parity, stop bits, flow control, clock polarity / phase settings</li>
 164 <li>data bit settings other then 8</li>
 165 <li>modem lines operation</li>
 166 <li>event signaling</li>
 167 </ul>
 168 </dd></dl>
 169 <p><a class="anchor" id="usart_server_con"></a> </p>
 170 <h2>Test Mode : <b>USART Server</b> </h2>
 171 <p>This test mode allows extensive validation of the USART Driver.<br/>
 172  Results of the Driver Validation in this test mode are relevant as a proof of driver compliance to the CMSIS-Driver specification.</p>
 173 <p>To perform extensive communication tests, it is required to use an <a class="el" href="group__usart__server.html">USART Server</a> running on a dedicated hardware.</p>
 174 <p>To enable this mode of testing in the <b>DV_USART_Config.h</b> configuration file select the <b>Configuration: Test Mode: USART Server</b> setting.</p>
 175 <p>Required pin connections for the <b>USART Server</b> test mode with <b>USART Server Mode</b>: <b>Asynchronous</b> or <b>IrDa</b></p>
 176 <dl class="section note"><dt>Note</dt><dd>Only necessary pin connections are Tx, Rx and GND. Flow control (RTS, CTS), modem lines (DSR, DTR, DCD, RI) and synchronous clock (CLK) line are optional and depend on pin availability and driver support for flow control, modem lines and synchronous mode. </dd>
 177 <dd>
 178 For stable idle level on Rx lines, external pull-ups can be added.</dd></dl>
 179 <div class="image">
 180 <img src="usart_server_pin_connections_async.png" alt="usart_server_pin_connections_async.png"/>
 181 </div>
 182 <p>Required pin connections for the <b>USART Server</b> test mode with <b>USART Server Mode</b>: <b>Single-wire</b></p>
 183 <div class="image">
 184 <img src="usart_server_pin_connections_single_wire.png" alt="usart_server_pin_connections_single_wire.png"/>
 185 </div>
 186 <dl class="section note"><dt>Note</dt><dd>Asynchronous and IrDa modes use same connection type and Single-wire uses a different connection. </dd>
 187 <dd>
 188 Please ensure that correct connection is used as required by tests otherwise damage to hardware may occur (For example using Asynchronous mode selected with hardware connected for Single-wire tests can result in damaged pins). </dd>
 189 <dd>
 190 In this mode Tx and Rx pins are internally connected together. </dd>
 191 <dd>
 192 Tx pin should use open-drain setting in this mode to prevent damage in case of simultaneous driving from both USART Server and USART Client.</dd>
 193 <dd>
 194 To ensure proper signal quality:<ul>
 195 <li>keep the connecting wires as short as possible</li>
 196 <li>if possible keep Tx and Rx wires wires separate from each other</li>
 197 <li>ensure a good Ground (GND) connection between USART Server and DUT </li>
 198 </ul>
 199 </dd></dl>
 200 </div><!-- contents -->
 201 </div><!-- doc-content -->
 202 <!-- start footer part -->
 203 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 204   <ul>
 205     <li class="footer">Generated on Fri Jul 15 2022 08:42:09 for CMSIS-Driver Validation by ARM Ltd. All rights reserved.
 206         <!--
 207     <a href="http://www.doxygen.org/index.html">
 208     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
 209         -->
 210         </li>
 211   </ul>
 212 </div>
 213 </body>
 214 </html>