Documentation/DAP/html/group__DAP__UART__Transfer.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>DAP_UART_Transfer</title>
 <title>CMSIS-DAP: DAP_UART_Transfer</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>
 <script type="text/javascript" src="cmsis_footer.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.1.1</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__UART__Transfer.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="headertitle">
 <div class="title">DAP_UART_Transfer<div class="ingroups"><a class="el" href="group__DAP__uart__gr.html">UART COM Commands</a></div></div>  </div>
 </div><!--header-->
 <div class="contents">

 <p>Transfer data via UART.
 <a href="#details">More...</a></p>
 <p>Transfer data via UART. </p>
 <h2>DAP_UART_Transfer (0x21): </h2>
 <p>Receive and Transmit data via target UART (only for transport via DAP).</p>
 <p><b>DAP_UART_Transfer Request:</b></p>
 <div class="fragment"><div class="line">| BYTE | SHORT    | SHORT   | BYTE          |</div>
 <div class="line">&gt; 0x21 | Rx Count | Tx Count| Transmit data |</div>
 <div class="line">|******|**********|*********|+++++++++++++++|</div>
 </div><!-- fragment --><ul>
 <li><b>Rx Count</b>: Maximum number of bytes to be read from UART receive buffer.</li>
 <li><b>Tx Count</b>: Number of bytes in <b>Transmit data</b> to be transmitted.</li>
 </ul>
 <dl class="section note"><dt>Note</dt><dd><a class="el" href="group__DAP__UART__Transfer.html">DAP_UART_Transfer</a> command can be used only if transport via DAP is enabled.<br/>
  </dd>
 <dd>
 If only receive is required, Tx Count can be 0.<br/>
  If only transmit is required, Rx Count can be 0.</dd></dl>
 <p><b>DAP_UART_Transfer Response:</b></p>
 <div class="fragment"><div class="line">| BYTE | BYTE   | SHORT    | SHORT    | BYTE          |</div>
 <div class="line">&lt; 0x21 | Status | Tx Count | Rx Count | Receive data  |</div>
 <div class="line">|******|********|**********|**********|+++++++++++++++|</div>
 </div><!-- fragment --><ul>
 <li><b>Status</b>:<ul>
 <li>Bit 0: 1 = Receive enabled, 0 = Receive disabled</li>
 <li>Bit 1: 1 = Data lost detected during receive (automatically cleared)</li>
 <li>Bit 2: 1 = Framing error detected (automatically cleared)</li>
 <li>Bit 3: 1 = Parity error detected (automatically cleared)</li>
 <li>Bit 4: 1 = Transmit enabled, 0 = Transmit disabled</li>
 <li>Bit 7..5: reserved (0)</li>
 </ul>
 </li>
 <li><b>Tx Count</b>: Number of bytes accepted from <b>Transmit data</b> and queued to UART transmit buffer.</li>
 <li><b>Rx Count</b>: Number of bytes in <b>Receive data</b> read from UART receive buffer.</li>
 <li><b>Receive data</b>: Bytes received from the target device via UART. </li>
 </ul>
 </div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="footer">
       <script type="text/javascript">
         <!--
         writeFooter.call(this);
         //-->
       </script>
     </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>DAP_UART_Transfer</title>
	<title>CMSIS-DAP: DAP_UART_Transfer</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>
	<script type="text/javascript" src="cmsis_footer.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.1.1</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__UART__Transfer.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="headertitle">
	<div class="title">DAP_UART_Transfer<div class="ingroups"><a class="el" href="group__DAP__uart__gr.html">UART COM Commands</a></div></div> </div>
	</div><!--header-->
	<div class="contents">

	<p>Transfer data via UART.
	<a href="#details">More...</a></p>
	<p>Transfer data via UART. </p>
	<h2>DAP_UART_Transfer (0x21): </h2>
	<p>Receive and Transmit data via target UART (only for transport via DAP).</p>
	<p><b>DAP_UART_Transfer Request:</b></p>
	<div class="fragment"><div class="line">\| BYTE \| SHORT \| SHORT \| BYTE \|</div>
	<div class="line">> 0x21 \| Rx Count \| Tx Count\| Transmit data \|</div>
	<div class="line">\|****\|******\|*******\|+++++++++++++++\|</div>
	</div><!-- fragment --><ul>
	<li><b>Rx Count</b>: Maximum number of bytes to be read from UART receive buffer.</li>
	<li><b>Tx Count</b>: Number of bytes in <b>Transmit data</b> to be transmitted.</li>
	</ul>
	<dl class="section note"><dt>Note</dt><dd><a class="el" href="group__DAP__UART__Transfer.html">DAP_UART_Transfer</a> command can be used only if transport via DAP is enabled.<br/>
	</dd>
	<dd>
	If only receive is required, Tx Count can be 0.<br/>
	If only transmit is required, Rx Count can be 0.</dd></dl>
	<p><b>DAP_UART_Transfer Response:</b></p>
	<div class="fragment"><div class="line">\| BYTE \| BYTE \| SHORT \| SHORT \| BYTE \|</div>
	<div class="line">< 0x21 \| Status \| Tx Count \| Rx Count \| Receive data \|</div>
	<div class="line">\|****\|****\|******\|********\|+++++++++++++++\|</div>
	</div><!-- fragment --><ul>
	<li><b>Status</b>:<ul>
	<li>Bit 0: 1 = Receive enabled, 0 = Receive disabled</li>
	<li>Bit 1: 1 = Data lost detected during receive (automatically cleared)</li>
	<li>Bit 2: 1 = Framing error detected (automatically cleared)</li>
	<li>Bit 3: 1 = Parity error detected (automatically cleared)</li>
	<li>Bit 4: 1 = Transmit enabled, 0 = Transmit disabled</li>
	<li>Bit 7..5: reserved (0)</li>
	</ul>
	</li>
	<li><b>Tx Count</b>: Number of bytes accepted from <b>Transmit data</b> and queued to UART transmit buffer.</li>
	<li><b>Rx Count</b>: Number of bytes in <b>Receive data</b> read from UART receive buffer.</li>
	<li><b>Receive data</b>: Bytes received from the target device via UART. </li>
	</ul>
	</div><!-- contents -->
	</div><!-- doc-content -->
	<!-- start footer part -->
	<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<ul>
	<li class="footer">
	<script type="text/javascript">
	<!--
	writeFooter.call(this);
	//-->
	</script>
	</li>
	</ul>
	</div>
	</body>
	</html>