index.html 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186
  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>Firmware for CoreSight Debug Access Port</title>
  7. <title>CMSIS-DAP: Firmware for CoreSight Debug Access Port</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <link href="cmsis.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. </head>
  26. <body>
  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28. <div id="titlearea">
  29. <table cellspacing="0" cellpadding="0">
  30. <tbody>
  31. <tr style="height: 46px;">
  32. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33. <td style="padding-left: 0.5em;">
  34. <div id="projectname">CMSIS-DAP
  35. &#160;<span id="projectnumber">Version 2.0.0</span>
  36. </div>
  37. <div id="projectbrief">Interface Firmware for CoreSight Debug Access Port</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li class="current"><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li><a href="modules.html"><span>Reference</span></a></li>
  62. <li>
  63. <div id="MSearchBox" class="MSearchBoxInactive">
  64. <span class="left">
  65. <img id="MSearchSelect" src="search/mag_sel.png"
  66. onmouseover="return searchBox.OnSearchSelectShow()"
  67. onmouseout="return searchBox.OnSearchSelectHide()"
  68. alt=""/>
  69. <input type="text" id="MSearchField" value="Search" accesskey="S"
  70. onfocus="searchBox.OnSearchFieldFocus(true)"
  71. onblur="searchBox.OnSearchFieldFocus(false)"
  72. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73. </span><span class="right">
  74. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75. </span>
  76. </div>
  77. </li>
  78. </ul>
  79. </div>
  80. </div><!-- top -->
  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
  82. <div id="nav-tree">
  83. <div id="nav-tree-contents">
  84. <div id="nav-sync" class="sync"></div>
  85. </div>
  86. </div>
  87. <div id="splitbar" style="-moz-user-select:none;"
  88. class="ui-resizable-handle">
  89. </div>
  90. </div>
  91. <script type="text/javascript">
  92. $(document).ready(function(){initNavTree('index.html','');});
  93. </script>
  94. <div id="doc-content">
  95. <!-- window showing the filter options -->
  96. <div id="MSearchSelectWindow"
  97. onmouseover="return searchBox.OnSearchSelectShow()"
  98. onmouseout="return searchBox.OnSearchSelectHide()"
  99. onkeydown="return searchBox.OnSearchSelectKey(event)">
  100. <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>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  101. <!-- iframe showing the search results (closed by default) -->
  102. <div id="MSearchResultsWindow">
  103. <iframe src="javascript:void(0)" frameborder="0"
  104. name="MSearchResults" id="MSearchResults">
  105. </iframe>
  106. </div>
  107. <div class="header">
  108. <div class="headertitle">
  109. <div class="title">Firmware for CoreSight Debug Access Port </div> </div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <div class="textblock"><p><b>CMSIS-DAP</b> is a specification and a implementation of a <b>Firmware</b> that supports access to the CoreSight <b>Debug Access Port</b> (DAP).<br/>
  113. <br/>
  114. The various Arm Cortex processors provide <a href="http://www.arm.com/products/system-ip/coresight/index.php" target="_blank"><b>CoreSight Debug and Trace</b></a>. CMSIS-DAP supports target Devices that contain one or more Cortex processors. A Device provides a Debug Access Port (DAP) typically either with a 5-pin JTAG or with a 2-pin Serial Wired Debug (SWD) interface that connects to a Debug Unit. CMSIS-DAP is the interface firmware for a Debug Unit that connects the Debug Port to USB. Debuggers that execute on a host computer connect via USB and the Debug Unit to the Device which runs the application software.</p>
  115. <div class="image">
  116. <img src="CMSIS_DAP_INTERFACE.png" alt="CMSIS_DAP_INTERFACE.png"/>
  117. <div class="caption">
  118. CMSIS-DAP Overview</div></div>
  119. <h2>Configuration of CMSIS-DAP Firmware </h2>
  120. <p>The CMSIS-DAP Firmware version 2 can be configured in two different USB interface modes:</p>
  121. <ul>
  122. <li>Version 1 configuration uses USB HID as interface to the host PC.</li>
  123. <li>Version 2 configuration uses WinUSB as interface to the host PC and provides high-speed SWO trace streaming.</li>
  124. </ul>
  125. <h2>Benefits of CMSIS-DAP </h2>
  126. <ul>
  127. <li>Provides a standardized interface for debuggers. Interfaces to many standard debuggers is available.</li>
  128. <li>Access to CoreSight registers of all Cortex processor architectures (Cortex-A/R/M).</li>
  129. <li>Connects via 5-pin JTAG or 2-pin Serial Wire Debug (SWD).</li>
  130. <li>Supports multi-core debugging.</li>
  131. <li>Supports Serial Wire Output of Cortex-M devices (new in CMSIS-DAP Version 1.1.0).</li>
  132. <li>Easy to deploy to Debug Units based on Cortex-M microcontrollers.</li>
  133. <li>Debug Unit may be integrated on an evaluation board.</li>
  134. <li>USB using HID (Human Interface Device) driver class that avoids driver installation on host PC.</li>
  135. <li>Supports time-critical JTAG or SWD command execution (new in CMSIS-DAP Version 1.10).</li>
  136. <li>Supports Test Domain Timer for time measurement using the debug unit (new in CMSIS-DAP Version 1.2.0)</li>
  137. </ul>
  138. <h1>CMSIS-DAP Firmware </h1>
  139. <p>The CMSIS-DAP Firmware is provided as source code and is fully configurable to a new Debug Unit. A source code template and several reference implementations for popular Debug Units are provided. Refer to <a class="el" href="group__DAP__Config__gr.html">Firmware Configuration</a> for more information.</p>
  140. <p>The CMSIS-DAP Software Stack is composed of the following components:</p>
  141. <ul>
  142. <li>CMSIS-DAP Firmware that interfaces to JTAG or SWD Debug pins using standard I/O pins of the Cortex-M device.</li>
  143. <li>CMSIS-Driver USART that connects the UART of the Cortex-M device to the SWO output from the target.</li>
  144. <li>USB Communication Stack that interfaces to the USB Port of the Host Computer using the HID or custom class.</li>
  145. <li>The USB Device middleware may require CMSIS-RTOS and a CMSIS-Driver USB.</li>
  146. </ul>
  147. <div class="image">
  148. <img src="CMSIS_DAP_SWStack.png" alt="CMSIS_DAP_SWStack.png"/>
  149. <div class="caption">
  150. CMSIS-DAP Software Stack</div></div>
  151. <p> In the examples provided the MDK Version 5 USB Communication Stack has been used. However it is possible to use alternative USB stacks instead.</p>
  152. <p>The CMSIS-DAP Firmware is provided in the following directory structure.</p>
  153. <table class="doxtable">
  154. <tr>
  155. <th align="left">Directory </th><th align="left">Description </th></tr>
  156. <tr>
  157. <td align="left">.\CMSIS\DAP\Firmware\Config </td><td align="left">CMSIS-DAP Firmware configuration </td></tr>
  158. <tr>
  159. <td align="left">.\CMSIS\DAP\Firmware\Examples </td><td align="left">CMSIS-DAP Firmware adapted to various Debug Units </td></tr>
  160. <tr>
  161. <td align="left">.\CMSIS\DAP\Firmware\Include </td><td align="left">CMSIS-DAP Firmware header file </td></tr>
  162. <tr>
  163. <td align="left">.\CMSIS\DAP\Firmware\Source </td><td align="left">CMSIS-DAP Firmware source code </td></tr>
  164. <tr>
  165. <td align="left">.\CMSIS\DAP\Firmware\Template </td><td align="left">Interface Templates for MDK Version 5 middleware </td></tr>
  166. </table>
  167. <h2>Validation </h2>
  168. <p>CMSIS-DAP compliant Debug Units must be validated using the scripts provided in <a class="el" href="group__DAP__Validate__gr.html">Validate Debug Unit</a>.</p>
  169. <hr/>
  170. </div></div><!-- contents -->
  171. </div><!-- doc-content -->
  172. <!-- start footer part -->
  173. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  174. <ul>
  175. <li class="footer">Generated on Thu Apr 9 2020 15:49:12 for CMSIS-DAP Version 2.0.0 by Arm Ltd. All rights reserved.
  176. <!--
  177. <a href="http://www.doxygen.org/index.html">
  178. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  179. -->
  180. </li>
  181. </ul>
  182. </div>
  183. </body>
  184. </html>