begriffs open source - cmsis-driver-validation/blob - docs/html/group__usart__config.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>Configuration</title>
   7 <title>CMSIS-Driver Validation: Configuration</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__usart__config.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="headertitle">
 112 <div class="title">Configuration<div class="ingroups"><a class="el" href="group__dv__usart.html">USART Validation</a></div></div>  </div>
 113 </div><!--header-->
 114 <div class="contents">
 115 <p>The USART driver validation settings are available in the <b>DV_USART_Config.h</b> configuration file.</p>
 116 <div class="image">
 117 <img src="dv_usart_config_h.png" alt="dv_usart_config_h.png"/>
 118 <div class="caption">
 119 DV_USART_Config.h configuration file in Configuration Wizard view mode</div></div>
 120 <p> Some settings depend on the test environment and need to be changed for proper operation of the USART driver validation.<br/>
 121 </p>
 122 <h1><a class="anchor" id="usart_config_detail"></a>
 123 Configuration settings</h1>
 124 <p><b>Driver_USART#</b> selects the driver instance that will be tested.<br/>
 125  For example if we want to test <code>Driver_USART2</code> then this setting would be set to <code>2</code>.</p>
 126 <p><b>Configuration</b> section contains configuration of: Test Mode, USART Server and Tests settings:</p>
 127 <ul>
 128 <li><b>Test Mode</b> can be set to <b>Loopback</b> or <b>USART Server</b>.<br/>
 129  Loopback mode should be used for initial validation.<br/>
 130  Loopback mode requires that Tx and Rx pins are connected together thus driver validation can test basic functionality.<br/>
 131  <b>For full compliance of the USART driver with the CMSIS-Driver USART specification the USART Server Test Mode has to be used.</b></li>
 132 <li><b>USART Server</b> settings are relevant if <b>Test Mode: USART Server</b> is selected.<br/>
 133  These settings specify communication settings at which Driver Validation communicates with the USART Server<br/>
 134  and <b>must be same as configured on the USART Server.</b><ul>
 135 <li>Some settings are fixed and cannot be changed, these are the following ones:<ul>
 136 <li><b>Baudrate: 115200</b></li>
 137 <li><b>Data Bits: 8</b></li>
 138 <li><b>Parity: None</b></li>
 139 <li><b>Stop Bits: 1</b></li>
 140 <li><b>Flow Control: None</b></li>
 141 </ul>
 142 </li>
 143 <li>Only configurable setting for the USART Server is:<ul>
 144 <li><b>Mode</b> setting specifies the mode for communication with USART Server.<br/>
 145  Different modes require different physical connection and also USART Server must use same setting.<br/>
 146  For details on modes please check <a class="el" href="group__dv__usart.html#usart_server_con">USART Server connection</a>.</li>
 147 </ul>
 148 </li>
 149 </ul>
 150 </li>
 151 <li><b>Tests</b> settings specify tests configuration:<ul>
 152 <li><b>Default settings</b> specifies the default settings used in the data exchange tests.<br/>
 153  Usually, one feature is tested by executing the data exchange while all other parameters are used as default.<br/>
 154  For details on which parameters are used as default in each test function please refer to <a class="el" href="group__usart__tests__data__xchg.html">Data Exchange</a> functions documentation.</li>
 155 <li><b>Baudrate</b> settings specifies minimum and maximum bus speeds at which data transfer will be executed.<br/>
 156  These settings are used by the <a class="el" href="group__usart__tests__data__xchg.html#gaccd6bc4a56a3ab6fbf9c6d6b530c7202">USART_Baudrate_Min</a> and <a class="el" href="group__usart__tests__data__xchg.html#ga2f49cdc91fc6531f35c2cde38a557a17">USART_Baudrate_Max</a> test functions.</li>
 157 <li><b>Number of Items</b> settings specifies a few different number of items to be tested.<br/>
 158  These settings are used by the <a class="el" href="group__usart__tests__data__xchg.html#ga89c83e2ced0a9e285c24f0bab4388f79">USART_Number_Of_Items</a> test function which tests that odd and unusual number of items are transferred correctly according to the CMSIS-Driver specification.</li>
 159 </ul>
 160 </li>
 161 </ul>
 162 <p><b>Tests</b> section contains selection of tests to be executed:</p>
 163 <ul>
 164 <li><b>Driver Management</b> allows enabling or disabling of the whole driver management group of test functions.<br/>
 165  Each test function in this group can be enabled or disabled individually, for details on tests performed by each test function please refer to <a class="el" href="group__usart__tests__drv__mgmt.html">Driver Management</a> documentation.</li>
 166 <li><b>Data Exchange</b> allows enabling or disabling of the whole data exchange group of test functions.<br/>
 167  Each test function in this group can be enabled or disabled individually, for details on tests performed by each test function please refer to <a class="el" href="group__usart__tests__data__xchg.html">Data Exchange</a> documentation.</li>
 168 <li><b>Modem</b> allows enabling or disabling of the whole modem lines group of test functions.<br/>
 169  Each test function in this group can be enabled or disabled individually, for details on tests performed by each test function please refer to <a class="el" href="group__usart__tests__modem.html">Modem Lines</a> documentation.</li>
 170 <li><b>Event</b> allows enabling or disabling of the whole event group of test functions.<br/>
 171  Each test function in this group can be enabled or disabled individually, for details on tests performed by each test function please refer to <a class="el" href="group__usart__tests__evt.html">Event</a> documentation. </li>
 172 </ul>
 173 </div><!-- contents -->
 174 </div><!-- doc-content -->
 175 <!-- start footer part -->
 176 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 177   <ul>
 178     <li class="footer">Generated on Fri Jul 15 2022 08:42:08 for CMSIS-Driver Validation by ARM Ltd. All rights reserved.
 179         <!--
 180     <a href="http://www.doxygen.org/index.html">
 181     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
 182         -->
 183         </li>
 184   </ul>
 185 </div>
 186 </body>
 187 </html>