begriffs open source - cmsis-driver-validation/blob - docs/html/index.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>Introduction</title>
   7 <title>CMSIS-Driver Validation: Introduction</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 1.2.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 class="current"><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('index.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>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><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">Introduction </div>  </div>
 113 </div><!--header-->
 114 <div class="contents">
 115 <div class="textblock"><p>This manual explains the scope and the usage of the Software Pack for <b>CMSIS-Driver</b> <b>Validation</b>. <a href="http://www.keil.com/pack/doc/CMSIS/Driver/html/index.html" target="_blank">CMSIS-Driver</a> are standard peripheral API interfaces that connect microcontroller peripherals with middleware or the user application.</p>
 116 <p>The Software Pack for CMSIS-Driver validation provides:</p>
 117 <ul>
 118 <li>Configurable validation tests for several CMSIS-Driver interfaces</li>
 119 <li>Example projects that show the usage of the CMSIS-Driver validation</li>
 120 </ul>
 121 <p>The CMSIS-Driver validation tests and verifies:</p>
 122 <ul>
 123 <li><b>API</b> <b>interface</b> <b>interaction</b> using the driver capabilities as well as valid and invalid parameters.</li>
 124 <li><b>Data</b> <b>communication</b> with various transfer sizes and communication parameters (i.e. baudrate).</li>
 125 <li><b>Loopback</b> <b>communication</b> (for some interfaces) for testing the underlying hardware.</li>
 126 <li><b>Transfer</b> <b>speed</b> of the data communication with time measurement of data transfers (for interfaces with loopback functionality).</li>
 127 </ul>
 128 <p>The CMSIS-Driver Validation requires <a href="http://www.keil.com/pack/doc/CMSIS/RTOS/html/index.html" target="_blank">CMSIS-RTOS</a> functionality and can be used to verify the setup and configuration of the CMSIS-Driver interfaces in a user system. It is also used to validate implementation of a CMSIS-Driver interface.</p>
 129 <p>The diagram below is an overview of the configuration for CMSIS-Driver validation.</p>
 130 <div class="image">
 131 <img src="DVSuite.png" alt="DVSuite.png"/>
 132 </div>
 133 <p>This manual contains the following chapters:</p>
 134 <ul>
 135 <li><a class="el" href="test_setup.html">Test Setup</a> - Describes the general setup of the CMSIS-Driver validation test and how to generate test output.</li>
 136 <li><a class="el" href="test_results.html">Reading Test Results</a> - Explains how to interpret the test results from loopback tests.</li>
 137 <li><a class="el" href="examples.html">Examples</a> - Contains information of several example projects including the required hardware setup.</li>
 138 <li><a class="el" href="resource_requirements.html">Resource Requirements</a> - Lists memory and CMSIS-RTOS requirements.</li>
 139 <li><a href="./modules.html" class="el">Reference</a> - explains the individual tests for the various CMSIS-Driver interfaces.</li>
 140 </ul>
 141 <p>The Software Pack for CMSIS-Driver validation current tests the following interfaces:</p>
 142 <ul>
 143 <li><a class="el" href="group__eth__funcs.html">Ethernet Validation</a> - Interface to Ethernet MAC and PHY peripheral.</li>
 144 <li><a class="el" href="group__i2c__funcs.html">I2C Validation</a> - Inter-Integrated Circuit (I2C) multi-master serial single-ended bus interface driver.</li>
 145 <li><a class="el" href="group__mci__funcs.html">MCI Validation</a> - Memory card interface for SD/MMC memory.</li>
 146 <li><a class="el" href="group__spi__funcs.html">SPI Validation</a> - Serial Peripheral Interface (SPI) driver.</li>
 147 <li><a class="el" href="group__usart__funcs.html">USART Validation</a> - Universal Synchronous and Asynchronous Receiver/Transmitter (USART) interface driver.</li>
 148 <li><a class="el" href="group__usbd__funcs.html">USB Device Validation</a> - Universal Serial Bus (USB) interface driver (USB Device communication only).</li>
 149 </ul>
 150 <p>This manual assumes that you are familiar with MDK. Refer to <a href="http://www2.keil.com/mdk5/install" target="_blank">MDK Version 5 - Getting Started</a> for additional information.</p>
 151 <hr/>
 152 <h2>Revision History </h2>
 153 <table class="doxtable">
 154 <tr>
 155 <th align="left">Version </th><th align="left">Description  </th></tr>
 156 <tr>
 157 <td align="left">V1.1 </td><td align="left">Added USB Host, CAN and Ethernet Precision Time Protocol tests </td></tr>
 158 <tr>
 159 <td align="left">V1.0 </td><td align="left">Initial release for CMSIS-Driver API V2.0 </td></tr>
 160 </table>
 161 </div></div><!-- contents -->
 162 </div><!-- doc-content -->
 163 <!-- start footer part -->
 164 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 165   <ul>
 166     <li class="footer">Generated on Thu Feb 21 2019 15:24:48 for CMSIS-Driver Validation by ARM Ltd. All rights reserved.
 167         <!--
 168     <a href="http://www.doxygen.org/index.html">
 169     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
 170         -->
 171         </li>
 172   </ul>
 173 </div>
 174 </body>
 175 </html>