group__DAP__Config__LEDs__gr.html 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223
  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>CMSIS-DAP Hardware Status LEDs</title>
  7. <title>CMSIS-DAP: CMSIS-DAP Hardware Status LEDs</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 1.1.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><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('group__DAP__Config__LEDs__gr.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="summary">
  109. <a href="#func-members">Functions</a> </div>
  110. <div class="headertitle">
  111. <div class="title">CMSIS-DAP Hardware Status LEDs<div class="ingroups"><a class="el" href="group__DAP__ConfigIO__gr.html">Configure I/O Ports and Debug Unit</a></div></div> </div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <p>CMSIS-DAP Hardware may provide LEDs that indicate the status of the CMSIS-DAP Debug Unit.
  115. <a href="#details">More...</a></p>
  116. <table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  118. Functions</h2></td></tr>
  119. <tr class="memitem:ga519ba0a5ae485365e01fc2a9df77ce90"><td class="memItemLeft" align="right" valign="top">static __inline void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__LEDs__gr.html#ga519ba0a5ae485365e01fc2a9df77ce90">LED_CONNECTED_OUT</a> (uint32_t bit)</td></tr>
  120. <tr class="memdesc:ga519ba0a5ae485365e01fc2a9df77ce90"><td class="mdescLeft">&#160;</td><td class="mdescRight">Debug Unit: Set status of Connected LED. <a href="#ga519ba0a5ae485365e01fc2a9df77ce90">More...</a><br/></td></tr>
  121. <tr class="separator:ga519ba0a5ae485365e01fc2a9df77ce90"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:ga6231ce4a4d4b83fe5a3b290997b8d550"><td class="memItemLeft" align="right" valign="top">static __inline void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__LEDs__gr.html#ga6231ce4a4d4b83fe5a3b290997b8d550">LED_RUNNING_OUT</a> (uint32_t bit)</td></tr>
  123. <tr class="memdesc:ga6231ce4a4d4b83fe5a3b290997b8d550"><td class="mdescLeft">&#160;</td><td class="mdescRight">Debug Unit: Set status Target Running LED. <a href="#ga6231ce4a4d4b83fe5a3b290997b8d550">More...</a><br/></td></tr>
  124. <tr class="separator:ga6231ce4a4d4b83fe5a3b290997b8d550"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. </table>
  126. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  127. <p>CMSIS-DAP Hardware may provide LEDs that indicate the status of the CMSIS-DAP Debug Unit. </p>
  128. <p>It is recommended to provide the following LEDs for status indication:</p>
  129. <ul>
  130. <li>Connect LED: is active when the DAP hardware is connected to a debugger.</li>
  131. <li>Running LED: is active when the debugger has put the target device into running state. </li>
  132. </ul>
  133. <h2 class="groupheader">Function Documentation</h2>
  134. <a class="anchor" id="ga519ba0a5ae485365e01fc2a9df77ce90"></a>
  135. <div class="memitem">
  136. <div class="memproto">
  137. <table class="mlabels">
  138. <tr>
  139. <td class="mlabels-left">
  140. <table class="memname">
  141. <tr>
  142. <td class="memname">static __inline void LED_CONNECTED_OUT </td>
  143. <td>(</td>
  144. <td class="paramtype">uint32_t&#160;</td>
  145. <td class="paramname"><em>bit</em></td><td>)</td>
  146. <td></td>
  147. </tr>
  148. </table>
  149. </td>
  150. <td class="mlabels-right">
  151. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  152. </tr>
  153. </table>
  154. </div><div class="memdoc">
  155. <p>Debug Unit: Set status of Connected LED. </p>
  156. <dl class="params"><dt>Parameters</dt><dd>
  157. <table class="params">
  158. <tr><td class="paramname">bit</td><td>status of the Connect LED.<ul>
  159. <li>1: Connect LED ON: debugger is connected to CMSIS-DAP Debug Unit.</li>
  160. <li>0: Connect LED OFF: debugger is not connected to CMSIS-DAP Debug Unit. </li>
  161. </ul>
  162. </td></tr>
  163. </table>
  164. </dd>
  165. </dl>
  166. </div>
  167. </div>
  168. <a class="anchor" id="ga6231ce4a4d4b83fe5a3b290997b8d550"></a>
  169. <div class="memitem">
  170. <div class="memproto">
  171. <table class="mlabels">
  172. <tr>
  173. <td class="mlabels-left">
  174. <table class="memname">
  175. <tr>
  176. <td class="memname">static __inline void LED_RUNNING_OUT </td>
  177. <td>(</td>
  178. <td class="paramtype">uint32_t&#160;</td>
  179. <td class="paramname"><em>bit</em></td><td>)</td>
  180. <td></td>
  181. </tr>
  182. </table>
  183. </td>
  184. <td class="mlabels-right">
  185. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  186. </tr>
  187. </table>
  188. </div><div class="memdoc">
  189. <p>Debug Unit: Set status Target Running LED. </p>
  190. <dl class="params"><dt>Parameters</dt><dd>
  191. <table class="params">
  192. <tr><td class="paramname">bit</td><td>status of the Target Running LED.<ul>
  193. <li>1: Target Running LED ON: program execution in target started.</li>
  194. <li>0: Target Running LED OFF: program execution in target stopped. </li>
  195. </ul>
  196. </td></tr>
  197. </table>
  198. </dd>
  199. </dl>
  200. </div>
  201. </div>
  202. </div><!-- contents -->
  203. </div><!-- doc-content -->
  204. <!-- start footer part -->
  205. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  206. <ul>
  207. <li class="footer">Generated on Wed Feb 8 2017 10:20:42 for CMSIS-DAP by ARM Ltd. All rights reserved.
  208. <!--
  209. <a href="http://www.doxygen.org/index.html">
  210. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  211. -->
  212. </li>
  213. </ul>
  214. </div>
  215. </body>
  216. </html>