docs/DAP/html/group__DAP__Config__LEDs__gr.html - third_party/github/STMicroelectronics/cmsis_core - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
 <title>CMSIS-DAP Hardware Status LEDs</title>
 <title>CMSIS-DAP: CMSIS-DAP Hardware Status LEDs</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <link href="cmsis.css" rel="stylesheet" type="text/css" />
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
 <script type="text/javascript" src="printComponentTabs.js"></script>
 <link href="navtree.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="resize.js"></script>
 <script type="text/javascript" src="navtree.js"></script>
 <script type="text/javascript">
   $(document).ready(initResizable);
   $(window).load(resizeHeight);
 </script>
 <link href="search/search.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="search/search.js"></script>
 <script type="text/javascript">
   $(document).ready(function() { searchBox.OnSelectItem(0); });
 </script>
 </head>
 <body>
 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
 <div id="titlearea">
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr style="height: 46px;">
   <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
   <td style="padding-left: 0.5em;">
    <div id="projectname">CMSIS-DAP
    &#160;<span id="projectnumber">Version 2.0.0</span>
    </div>
    <div id="projectbrief">Interface Firmware for CoreSight Debug Access Port</div>
   </td>
  </tr>
  </tbody>
 </table>
 </div>
 <!-- end header part -->
 <div id="CMSISnav" class="tabs1">
     <ul class="tablist">
       <script type="text/javascript">
 		<!--
 		writeComponentTabs.call(this);
 		//-->
       </script>
 	  </ul>
 </div>
 <!-- Generated by Doxygen 1.8.6 -->
 <script type="text/javascript">
 var searchBox = new SearchBox("searchBox", "search",false,'Search');
 </script>
   <div id="navrow1" class="tabs">
     <ul class="tablist">
       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
       <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
       <li><a href="modules.html"><span>Reference</span></a></li>
       <li>
         <div id="MSearchBox" class="MSearchBoxInactive">
         <span class="left">
           <img id="MSearchSelect" src="search/mag_sel.png"
                onmouseover="return searchBox.OnSearchSelectShow()"
                onmouseout="return searchBox.OnSearchSelectHide()"
                alt=""/>
           <input type="text" id="MSearchField" value="Search" accesskey="S"
                onfocus="searchBox.OnSearchFieldFocus(true)"
                onblur="searchBox.OnSearchFieldFocus(false)"
                onkeyup="searchBox.OnSearchFieldChange(event)"/>
           </span><span class="right">
             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
           </span>
         </div>
       </li>
     </ul>
   </div>
 </div><!-- top -->
 <div id="side-nav" class="ui-resizable side-nav-resizable">
   <div id="nav-tree">
     <div id="nav-tree-contents">
       <div id="nav-sync" class="sync"></div>
     </div>
   </div>
   <div id="splitbar" style="-moz-user-select:none;"
        class="ui-resizable-handle">
   </div>
 </div>
 <script type="text/javascript">
 $(document).ready(function(){initNavTree('group__DAP__Config__LEDs__gr.html','');});
 </script>
 <div id="doc-content">
 <!-- window showing the filter options -->
 <div id="MSearchSelectWindow"
      onmouseover="return searchBox.OnSearchSelectShow()"
      onmouseout="return searchBox.OnSearchSelectHide()"
      onkeydown="return searchBox.OnSearchSelectKey(event)">
 <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>

 <!-- iframe showing the search results (closed by default) -->
 <div id="MSearchResultsWindow">
 <iframe src="javascript:void(0)" frameborder="0"
         name="MSearchResults" id="MSearchResults">
 </iframe>
 </div>

 <div class="header">
   <div class="summary">
 <a href="#func-members">Functions</a>  </div>
   <div class="headertitle">
 <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>
 </div><!--header-->
 <div class="contents">

 <p>CMSIS-DAP Hardware may provide LEDs that indicate the status of the CMSIS-DAP Debug Unit.
 <a href="#details">More...</a></p>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 Functions</h2></td></tr>
 <tr class="memitem:ga27408c1c7010aa394abdcf0c85d7b798"><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#ga27408c1c7010aa394abdcf0c85d7b798">LED_CONNECTED_OUT</a> (uint32_t bit)</td></tr>
 <tr class="memdesc:ga27408c1c7010aa394abdcf0c85d7b798"><td class="mdescLeft">&#160;</td><td class="mdescRight">Debug Unit: Set status of Connected LED.  <a href="#ga27408c1c7010aa394abdcf0c85d7b798">More...</a><br/></td></tr>
 <tr class="separator:ga27408c1c7010aa394abdcf0c85d7b798"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:gaa27ef99d16e3e68759adf1e6cb016e50"><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#gaa27ef99d16e3e68759adf1e6cb016e50">LED_RUNNING_OUT</a> (uint32_t bit)</td></tr>
 <tr class="memdesc:gaa27ef99d16e3e68759adf1e6cb016e50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Debug Unit: Set status Target Running LED.  <a href="#gaa27ef99d16e3e68759adf1e6cb016e50">More...</a><br/></td></tr>
 <tr class="separator:gaa27ef99d16e3e68759adf1e6cb016e50"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 <p>CMSIS-DAP Hardware may provide LEDs that indicate the status of the CMSIS-DAP Debug Unit. </p>
 <p>It is recommended to provide the following LEDs for status indication:</p>
 <ul>
 <li>Connect LED: is active when the DAP hardware is connected to a debugger.</li>
 <li>Running LED: is active when the debugger has put the target device into running state. </li>
 </ul>
 <h2 class="groupheader">Function Documentation</h2>
 <a class="anchor" id="ga27408c1c7010aa394abdcf0c85d7b798"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">__STATIC_INLINE void LED_CONNECTED_OUT </td>
           <td>(</td>
           <td class="paramtype">uint32_t&#160;</td>
           <td class="paramname"><em>bit</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Debug Unit: Set status of Connected LED. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">bit</td><td>status of the Connect LED.<ul>
 <li>1: Connect LED ON: debugger is connected to CMSIS-DAP Debug Unit.</li>
 <li>0: Connect LED OFF: debugger is not connected to CMSIS-DAP Debug Unit. </li>
 </ul>
 </td></tr>
   </table>
   </dd>
 </dl>

 </div>
 </div>
 <a class="anchor" id="gaa27ef99d16e3e68759adf1e6cb016e50"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">__STATIC_INLINE void LED_RUNNING_OUT </td>
           <td>(</td>
           <td class="paramtype">uint32_t&#160;</td>
           <td class="paramname"><em>bit</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Debug Unit: Set status Target Running LED. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">bit</td><td>status of the Target Running LED.<ul>
 <li>1: Target Running LED ON: program execution in target started.</li>
 <li>0: Target Running LED OFF: program execution in target stopped. </li>
 </ul>
 </td></tr>
   </table>
   </dd>
 </dl>

 </div>
 </div>
 </div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="footer">Generated on Wed Jul 10 2019 15:20:28 for CMSIS-DAP Version 2.0.0 by Arm Ltd. All rights reserved.
 	<!--
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
 	-->
 	</li>
   </ul>
 </div>
 </body>
 </html>
	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
	<html xmlns="http://www.w3.org/1999/xhtml">
	<head>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<meta http-equiv="X-UA-Compatible" content="IE=9"/>
	<title>CMSIS-DAP Hardware Status LEDs</title>
	<title>CMSIS-DAP: CMSIS-DAP Hardware Status LEDs</title>
	<link href="tabs.css" rel="stylesheet" type="text/css"/>
	<link href="cmsis.css" rel="stylesheet" type="text/css" />
	<script type="text/javascript" src="jquery.js"></script>
	<script type="text/javascript" src="dynsections.js"></script>
	<script type="text/javascript" src="printComponentTabs.js"></script>
	<link href="navtree.css" rel="stylesheet" type="text/css"/>
	<script type="text/javascript" src="resize.js"></script>
	<script type="text/javascript" src="navtree.js"></script>
	<script type="text/javascript">
	$(document).ready(initResizable);
	$(window).load(resizeHeight);
	</script>
	<link href="search/search.css" rel="stylesheet" type="text/css"/>
	<script type="text/javascript" src="search/search.js"></script>
	<script type="text/javascript">
	$(document).ready(function() { searchBox.OnSelectItem(0); });
	</script>
	</head>
	<body>
	<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
	<div id="titlearea">
	<table cellspacing="0" cellpadding="0">
	<tbody>
	<tr style="height: 46px;">
	<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
	<td style="padding-left: 0.5em;">
	<div id="projectname">CMSIS-DAP
	<span id="projectnumber">Version 2.0.0</span>
	</div>
	<div id="projectbrief">Interface Firmware for CoreSight Debug Access Port</div>
	</td>
	</tr>
	</tbody>
	</table>
	</div>
	<!-- end header part -->
	<div id="CMSISnav" class="tabs1">
	<ul class="tablist">
	<script type="text/javascript">
	<!--
	writeComponentTabs.call(this);
	//-->
	</script>
	</ul>
	</div>
	<!-- Generated by Doxygen 1.8.6 -->
	<script type="text/javascript">
	var searchBox = new SearchBox("searchBox", "search",false,'Search');
	</script>
	<div id="navrow1" class="tabs">
	<ul class="tablist">
	<li><a href="index.html"><span>Main Page</span></a></li>
	<li><a href="pages.html"><span>Usage and Description</span></a></li>
	<li><a href="modules.html"><span>Reference</span></a></li>
	<li>
	<div id="MSearchBox" class="MSearchBoxInactive">
	<span class="left">
	<img id="MSearchSelect" src="search/mag_sel.png"
	onmouseover="return searchBox.OnSearchSelectShow()"
	onmouseout="return searchBox.OnSearchSelectHide()"
	alt=""/>
	<input type="text" id="MSearchField" value="Search" accesskey="S"
	onfocus="searchBox.OnSearchFieldFocus(true)"
	onblur="searchBox.OnSearchFieldFocus(false)"
	onkeyup="searchBox.OnSearchFieldChange(event)"/>
	</span><span class="right">
	<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
	</span>
	</div>
	</li>
	</ul>
	</div>
	</div><!-- top -->
	<div id="side-nav" class="ui-resizable side-nav-resizable">
	<div id="nav-tree">
	<div id="nav-tree-contents">
	<div id="nav-sync" class="sync"></div>
	</div>
	</div>
	<div id="splitbar" style="-moz-user-select:none;"
	class="ui-resizable-handle">
	</div>
	</div>
	<script type="text/javascript">
	$(document).ready(function(){initNavTree('group__DAP__Config__LEDs__gr.html','');});
	</script>
	<div id="doc-content">
	<!-- window showing the filter options -->
	<div id="MSearchSelectWindow"
	onmouseover="return searchBox.OnSearchSelectShow()"
	onmouseout="return searchBox.OnSearchSelectHide()"
	onkeydown="return searchBox.OnSearchSelectKey(event)">
	<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Pages</a></div>

	<!-- iframe showing the search results (closed by default) -->
	<div id="MSearchResultsWindow">
	<iframe src="javascript:void(0)" frameborder="0"
	name="MSearchResults" id="MSearchResults">
	</iframe>
	</div>

	<div class="header">
	<div class="summary">
	<a href="#func-members">Functions</a> </div>
	<div class="headertitle">
	<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>
	</div><!--header-->
	<div class="contents">

	<p>CMSIS-DAP Hardware may provide LEDs that indicate the status of the CMSIS-DAP Debug Unit.
	<a href="#details">More...</a></p>
	<table class="memberdecls">
	<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
	Functions</h2></td></tr>
	<tr class="memitem:ga27408c1c7010aa394abdcf0c85d7b798"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__LEDs__gr.html#ga27408c1c7010aa394abdcf0c85d7b798">LED_CONNECTED_OUT</a> (uint32_t bit)</td></tr>
	<tr class="memdesc:ga27408c1c7010aa394abdcf0c85d7b798"><td class="mdescLeft"> </td><td class="mdescRight">Debug Unit: Set status of Connected LED. <a href="#ga27408c1c7010aa394abdcf0c85d7b798">More...</a><br/></td></tr>
	<tr class="separator:ga27408c1c7010aa394abdcf0c85d7b798"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:gaa27ef99d16e3e68759adf1e6cb016e50"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__LEDs__gr.html#gaa27ef99d16e3e68759adf1e6cb016e50">LED_RUNNING_OUT</a> (uint32_t bit)</td></tr>
	<tr class="memdesc:gaa27ef99d16e3e68759adf1e6cb016e50"><td class="mdescLeft"> </td><td class="mdescRight">Debug Unit: Set status Target Running LED. <a href="#gaa27ef99d16e3e68759adf1e6cb016e50">More...</a><br/></td></tr>
	<tr class="separator:gaa27ef99d16e3e68759adf1e6cb016e50"><td class="memSeparator" colspan="2"> </td></tr>
	</table>
	<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
	<p>CMSIS-DAP Hardware may provide LEDs that indicate the status of the CMSIS-DAP Debug Unit. </p>
	<p>It is recommended to provide the following LEDs for status indication:</p>
	<ul>
	<li>Connect LED: is active when the DAP hardware is connected to a debugger.</li>
	<li>Running LED: is active when the debugger has put the target device into running state. </li>
	</ul>
	<h2 class="groupheader">Function Documentation</h2>
	<a class="anchor" id="ga27408c1c7010aa394abdcf0c85d7b798"></a>
	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">__STATIC_INLINE void LED_CONNECTED_OUT </td>
	<td>(</td>
	<td class="paramtype">uint32_t </td>
	<td class="paramname"><em>bit</em></td><td>)</td>
	<td></td>
	</tr>
	</table>
	</div><div class="memdoc">

	<p>Debug Unit: Set status of Connected LED. </p>
	<dl class="params"><dt>Parameters</dt><dd>
	<table class="params">
	<tr><td class="paramname">bit</td><td>status of the Connect LED.<ul>
	<li>1: Connect LED ON: debugger is connected to CMSIS-DAP Debug Unit.</li>
	<li>0: Connect LED OFF: debugger is not connected to CMSIS-DAP Debug Unit. </li>
	</ul>
	</td></tr>
	</table>
	</dd>
	</dl>

	</div>
	</div>
	<a class="anchor" id="gaa27ef99d16e3e68759adf1e6cb016e50"></a>
	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">__STATIC_INLINE void LED_RUNNING_OUT </td>
	<td>(</td>
	<td class="paramtype">uint32_t </td>
	<td class="paramname"><em>bit</em></td><td>)</td>
	<td></td>
	</tr>
	</table>
	</div><div class="memdoc">

	<p>Debug Unit: Set status Target Running LED. </p>
	<dl class="params"><dt>Parameters</dt><dd>
	<table class="params">
	<tr><td class="paramname">bit</td><td>status of the Target Running LED.<ul>
	<li>1: Target Running LED ON: program execution in target started.</li>
	<li>0: Target Running LED OFF: program execution in target stopped. </li>
	</ul>
	</td></tr>
	</table>
	</dd>
	</dl>

	</div>
	</div>
	</div><!-- contents -->
	</div><!-- doc-content -->
	<!-- start footer part -->
	<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<ul>
	<li class="footer">Generated on Wed Jul 10 2019 15:20:28 for CMSIS-DAP Version 2.0.0 by Arm Ltd. All rights reserved.
	<!--
	<a href="http://www.doxygen.org/index.html">
	<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
	-->
	</li>
	</ul>
	</div>
	</body>
	</html>