blob: 1121a4a62056c455285356a8dc26c2416ca2ad40 [file] [log] [blame]
<!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_QueueCommands</title>
<title>CMSIS-DAP: DAP_QueueCommands</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__QueueCommands__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="headertitle">
<div class="title">DAP_QueueCommands<div class="ingroups"><a class="el" href="group__DAP__atomic__gr.html">Atomic Commands</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Queue multiple DAP commands provided in a multiple packets.
<a href="#details">More...</a></p>
<p>Queue multiple DAP commands provided in a multiple packets. </p>
<p>Queues multiple DAP commands provided in multiple packets. Queuing starts with the first packet that includes <b>DAP_QueueCommands</b> command and continues with all subsequent packets that also include this command. Queued commands execute when a packet without <b>DAP_QueueCommands</b> command is received. Packet size and count limitation for requests and responses needs to respected.</p>
<p>The command is similar to <a class="el" href="group__DAP__ExecuteCommands__gr.html">DAP_ExecuteCommands</a> on a packet level but queues multiple packets before processing them.</p>
<p><b>DAP_QueueCommands Request:</b> </p>
<div class="fragment"><div class="line">| BYTE | BYTE **|+++++++++++++++++++|</div>
<div class="line">&gt; 0x7E | NumCmd | Command Requests | First queued packet</div>
<div class="line">|******|********|+++++++++++++++++++|</div>
<div class="line"> .</div>
<div class="line"> .</div>
<div class="line"> .</div>
<div class="line">| BYTE | BYTE **|+++++++++++++++++++|</div>
<div class="line">&gt; 0x7E | NumCmd | Command Requests | Last queued packet</div>
<div class="line">|******|********|+++++++++++++++++++|</div>
</div><!-- fragment --><ul>
<li><b>&gt;</b> Command Request (any command except <b>DAP_QueueCommands</b>) <br/>
Queued commands are executed before this command</li>
<li><b>NumCmd:</b> Number of commands to queue (single packet)</li>
<li><b>Commands Requests</b>: Concatenated command requests (single packet)</li>
</ul>
<p><b>DAP_QueueCommands Response:</b> </p>
<div class="fragment"><div class="line">| BYTE | BYTE **|+++++++++++++++++++|</div>
<div class="line">&lt; 0x7F | NumCmd | Command Responses |</div>
<div class="line">|******|********|+++++++++++++++++++|</div>
<div class="line"> .</div>
<div class="line"> .</div>
<div class="line"> .</div>
<div class="line">| BYTE | BYTE **|+++++++++++++++++++|</div>
<div class="line">&lt; 0x7F | NumCmd | Command Responses |</div>
<div class="line">|******|********|+++++++++++++++++++|</div>
</div><!-- fragment --><ul>
<li><b>&lt;</b> Command Response (first non <b>DAP_QueueCommands</b> command)</li>
<li><b>NumCmd:</b> Number of commands executed (single packet)</li>
<li><b>Commands Responses</b>: Concatenated command responses (single packet)</li>
</ul>
<p><b>Example:</b> </p>
<p>Queue <a class="el" href="group__DAP__SWJ__Pins.html">DAP_SWJ_Pins</a> and <a class="el" href="group__DAP__Delay.html">DAP_Delay</a> in first packet. <br/>
Queue <a class="el" href="group__DAP__SWJ__Pins.html">DAP_SWJ_Pins</a> in second packet. <br/>
Queue <a class="el" href="group__DAP__Delay.html">DAP_Delay</a> in third packet. <br/>
Send <a class="el" href="group__DAP__SWJ__Pins.html">DAP_SWJ_Pins</a> in fourth packet which executes queued commands and command in the last packet.</p>
<p><b>Request:</b> </p>
<div class="fragment"><div class="line">| BYTE | BYTE | BYTE | BYTE ******| BYTE ******| WORD ****| BYTE | SHORT |</div>
<div class="line">&gt; 0x7E | 0x02 | 0x10 | Pin Output | Pin Select | Pin Wait | 0x09 | Delay |</div>
<div class="line">|******|******|******|************|************|**********|******|*******|</div>
<div class="line"> Queue|NumCmd| DAP_SWJ_Pins | DAP_Delay |</div>
<div class="line"> </div>
<div class="line">| BYTE | BYTE | BYTE | BYTE ******| BYTE ******| WORD ****|</div>
<div class="line">&gt; 0x7E | 0x01 | 0x10 | Pin Output | Pin Select | Pin Wait |</div>
<div class="line">|******|******|******|************|************|**********|</div>
<div class="line"> Queue|NumCmd| DAP_SWJ_Pins |</div>
<div class="line"> </div>
<div class="line">| BYTE | BYTE | BYTE | SHORT |</div>
<div class="line">&gt; 0x7E | 0x01 | 0x09 | Delay |</div>
<div class="line">|******|******|******|*******|</div>
<div class="line"> Queue|NumCmd| DAP_Delay |</div>
<div class="line"> </div>
<div class="line">| BYTE | BYTE ******| BYTE ******| WORD ****|</div>
<div class="line">&gt; 0x10 | Pin Output | Pin Select | Pin Wait |</div>
<div class="line">|******|************|************|**********|</div>
<div class="line"> DAP_SWJ_Pins |</div>
</div><!-- fragment --><p><b>Response:</b> </p>
<div class="fragment"><div class="line">| BYTE | BYTE | BYTE | BYTE *****| BYTE | BYTE **|</div>
<div class="line">&lt; 0x7F | 0x02 | 0x10 | Pin Input | 0x09 | Status |</div>
<div class="line">|******|******|******|***********|******|********|</div>
<div class="line"> |NumCmd| DAP_SWJ_Pins | DAP_Delay |</div>
<div class="line"> </div>
<div class="line">| BYTE | BYTE | BYTE | BYTE *****|</div>
<div class="line">&lt; 0x7F | 0x01 | 0x10 | Pin Input |</div>
<div class="line">|******|******|******|***********|</div>
<div class="line"> |NumCmd| DAP_SWJ_Pins |</div>
<div class="line"> </div>
<div class="line">| BYTE | BYTE | BYTE | BYTE **|</div>
<div class="line">&lt; 0x7F | 0x01 | 0x09 | Status |</div>
<div class="line">|******|******|******|********|</div>
<div class="line"> |NumCmd| DAP_Delay |</div>
<div class="line"> </div>
<div class="line">| BYTE | BYTE *****|</div>
<div class="line">&lt; 0x10 | Pin Input |</div>
<div class="line">|******|***********|</div>
<div class="line"> DAP_SWJ_Pins |</div>
</div><!-- fragment --> </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>