1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
|
<!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 Debug Unit Information</title>
<title>CMSIS-DAP: CMSIS-DAP Debug Unit Information</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__Debug__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="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">CMSIS-DAP Debug Unit Information<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>Provides definitions about the hardware and configuration of the Debug Unit.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga512016e5f1966a8fd45b3f1a81ba5b8f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__Debug__gr.html#ga512016e5f1966a8fd45b3f1a81ba5b8f">CPU_CLOCK</a>   100000000U</td></tr>
<tr class="memdesc:ga512016e5f1966a8fd45b3f1a81ba5b8f"><td class="mdescLeft"> </td><td class="mdescRight">Processor Clock of the Cortex-M MCU used in the Debug Unit. This value is used to calculate the SWD/JTAG clock speed. <a href="#ga512016e5f1966a8fd45b3f1a81ba5b8f">More...</a><br/></td></tr>
<tr class="separator:ga512016e5f1966a8fd45b3f1a81ba5b8f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga119c70409a24e3a8bb35df07dffeb8c8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__Debug__gr.html#ga119c70409a24e3a8bb35df07dffeb8c8">IO_PORT_WRITE_CYCLES</a>   2U</td></tr>
<tr class="memdesc:ga119c70409a24e3a8bb35df07dffeb8c8"><td class="mdescLeft"> </td><td class="mdescRight">Number of processor cycles for I/O Port write operations. This value is used to calculate the SWD/JTAG clock speed that is generated with I/O Port write operations in the Debug Unit by a Cortex-M MCU. Most Cortex-M processors require 2 processor cycles for a I/O Port Write operation. If the Debug Unit uses a Cortex-M0+ processor with high-speed peripheral I/O only 1 processor cycle might be required. <a href="#ga119c70409a24e3a8bb35df07dffeb8c8">More...</a><br/></td></tr>
<tr class="separator:ga119c70409a24e3a8bb35df07dffeb8c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf886ab35e52d1ff2935351817786c8af"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__Debug__gr.html#gaf886ab35e52d1ff2935351817786c8af">DAP_SWD</a>   1</td></tr>
<tr class="memdesc:gaf886ab35e52d1ff2935351817786c8af"><td class="mdescLeft"> </td><td class="mdescRight">Indicate that Serial Wire Debug (SWD) communication mode is available at the Debug Access Port. This information is returned by the command <a class="el" href="group__DAP__Info.html">DAP_Info</a> as part of <b>Capabilities</b>. <a href="#gaf886ab35e52d1ff2935351817786c8af">More...</a><br/></td></tr>
<tr class="separator:gaf886ab35e52d1ff2935351817786c8af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3bbd310146b348db48a842ee804a0adf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__Debug__gr.html#ga3bbd310146b348db48a842ee804a0adf">DAP_JTAG</a>   1</td></tr>
<tr class="memdesc:ga3bbd310146b348db48a842ee804a0adf"><td class="mdescLeft"> </td><td class="mdescRight">Indicate that JTAG communication mode is available at the Debug Port. This information is returned by the command <a class="el" href="group__DAP__Info.html">DAP_Info</a> as part of <b>Capabilities</b>. <a href="#ga3bbd310146b348db48a842ee804a0adf">More...</a><br/></td></tr>
<tr class="separator:ga3bbd310146b348db48a842ee804a0adf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab29200a0988c7d1454f63661a8450dbf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__Debug__gr.html#gab29200a0988c7d1454f63661a8450dbf">DAP_JTAG_DEV_CNT</a>   8U</td></tr>
<tr class="memdesc:gab29200a0988c7d1454f63661a8450dbf"><td class="mdescLeft"> </td><td class="mdescRight">Configure maximum number of JTAG devices on the scan chain connected to the Debug Access Port. This setting impacts the RAM requirements of the Debug Unit. Valid range is 1 .. 255. <a href="#gab29200a0988c7d1454f63661a8450dbf">More...</a><br/></td></tr>
<tr class="separator:gab29200a0988c7d1454f63661a8450dbf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga89462514881c12c1508395050ce160eb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__Debug__gr.html#ga89462514881c12c1508395050ce160eb">DAP_DEFAULT_PORT</a>   1U</td></tr>
<tr class="memdesc:ga89462514881c12c1508395050ce160eb"><td class="mdescLeft"> </td><td class="mdescRight">Default communication mode on the Debug Access Port. Used for the command <a class="el" href="group__DAP__Connect.html">DAP_Connect</a> when Port Default mode is selected. <a href="#ga89462514881c12c1508395050ce160eb">More...</a><br/></td></tr>
<tr class="separator:ga89462514881c12c1508395050ce160eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab52710df89c3e3c19de577c638f954ea"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__Debug__gr.html#gab52710df89c3e3c19de577c638f954ea">DAP_DEFAULT_SWJ_CLOCK</a>   1000000U</td></tr>
<tr class="memdesc:gab52710df89c3e3c19de577c638f954ea"><td class="mdescLeft"> </td><td class="mdescRight">Default communication speed on the Debug Access Port for SWD and JTAG mode. Used to initialize the default SWD/JTAG clock frequency. The command <a class="el" href="group__DAP__SWJ__Clock.html">DAP_SWJ_Clock</a> can be used to overwrite this default setting. <a href="#gab52710df89c3e3c19de577c638f954ea">More...</a><br/></td></tr>
<tr class="separator:gab52710df89c3e3c19de577c638f954ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa28bb1da2661291634c4a8fb3e227404"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__Debug__gr.html#gaa28bb1da2661291634c4a8fb3e227404">DAP_PACKET_SIZE</a>   512U</td></tr>
<tr class="memdesc:gaa28bb1da2661291634c4a8fb3e227404"><td class="mdescLeft"> </td><td class="mdescRight">Maximum Package Size for Command and Response data. This configuration settings is used to optimize the communication performance with the debugger and depends on the USB peripheral. Typical vales are 64 for Full-speed USB HID or WinUSB, 1024 for High-speed USB HID and 512 for High-speed USB WinUSB. <a href="#gaa28bb1da2661291634c4a8fb3e227404">More...</a><br/></td></tr>
<tr class="separator:gaa28bb1da2661291634c4a8fb3e227404"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga03ed6a5aae34f4379ea97435122f83dd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__Debug__gr.html#ga03ed6a5aae34f4379ea97435122f83dd">DAP_PACKET_COUNT</a>   8U</td></tr>
<tr class="memdesc:ga03ed6a5aae34f4379ea97435122f83dd"><td class="mdescLeft"> </td><td class="mdescRight">Maximum Package Buffers for Command and Response data. This configuration settings is used to optimize the communication performance with the debugger and depends on the USB peripheral. For devices with limited RAM or USB buffer the setting can be reduced (valid range is 1 .. 255). <a href="#ga03ed6a5aae34f4379ea97435122f83dd">More...</a><br/></td></tr>
<tr class="separator:ga03ed6a5aae34f4379ea97435122f83dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf0d60b30fb0eef2d249bc89a6e454ab6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__Debug__gr.html#gaf0d60b30fb0eef2d249bc89a6e454ab6">SWO_UART</a>   1</td></tr>
<tr class="memdesc:gaf0d60b30fb0eef2d249bc89a6e454ab6"><td class="mdescLeft"> </td><td class="mdescRight">Indicate that UART Serial Wire Output (SWO) trace is available. This information is returned by the command <a class="el" href="group__DAP__Info.html">DAP_Info</a> as part of <b>Capabilities</b>. <a href="#gaf0d60b30fb0eef2d249bc89a6e454ab6">More...</a><br/></td></tr>
<tr class="separator:gaf0d60b30fb0eef2d249bc89a6e454ab6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad19240f209f055db7d70cb5eb2431d31"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__Debug__gr.html#gad19240f209f055db7d70cb5eb2431d31">SWO_UART_MAX_BAUDRATE</a>   10000000U</td></tr>
<tr class="memdesc:gad19240f209f055db7d70cb5eb2431d31"><td class="mdescLeft"> </td><td class="mdescRight">Maximum SWO UART Baudrate. <a href="#gad19240f209f055db7d70cb5eb2431d31">More...</a><br/></td></tr>
<tr class="separator:gad19240f209f055db7d70cb5eb2431d31"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga213ee3d1501adeca4c9c660072922c7e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__Debug__gr.html#ga213ee3d1501adeca4c9c660072922c7e">SWO_MANCHESTER</a>   0</td></tr>
<tr class="memdesc:ga213ee3d1501adeca4c9c660072922c7e"><td class="mdescLeft"> </td><td class="mdescRight">Indicate that Manchester Serial Wire Output (SWO) trace is available. This information is returned by the command <a class="el" href="group__DAP__Info.html">DAP_Info</a> as part of <b>Capabilities</b>. <a href="#ga213ee3d1501adeca4c9c660072922c7e">More...</a><br/></td></tr>
<tr class="separator:ga213ee3d1501adeca4c9c660072922c7e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5d89633a43ee3296e1754c7392ad856e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__Debug__gr.html#ga5d89633a43ee3296e1754c7392ad856e">SWO_BUFFER_SIZE</a>   4096U</td></tr>
<tr class="memdesc:ga5d89633a43ee3296e1754c7392ad856e"><td class="mdescLeft"> </td><td class="mdescRight">SWO Trace Buffer Size. <a href="#ga5d89633a43ee3296e1754c7392ad856e">More...</a><br/></td></tr>
<tr class="separator:ga5d89633a43ee3296e1754c7392ad856e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafd6f450a10f4e03757388e00ea56906f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__Debug__gr.html#gafd6f450a10f4e03757388e00ea56906f">SWO_STREAM</a>   0</td></tr>
<tr class="memdesc:gafd6f450a10f4e03757388e00ea56906f"><td class="mdescLeft"> </td><td class="mdescRight">SWO Streaming Trace. <a href="#gafd6f450a10f4e03757388e00ea56906f">More...</a><br/></td></tr>
<tr class="separator:gafd6f450a10f4e03757388e00ea56906f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga698a5a4ebd84335134a35e74848d2734"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__Debug__gr.html#ga698a5a4ebd84335134a35e74848d2734">TIMESTAMP_CLOCK</a>   100000000U</td></tr>
<tr class="memdesc:ga698a5a4ebd84335134a35e74848d2734"><td class="mdescLeft"> </td><td class="mdescRight">Clock frequency of the Test Domain Timer. Timer value is returned with <a class="el" href="group__DAP__Config__Timestamp__gr.html#gaf9bdc40d3a256fc2cc4d26b295993d9c">TIMESTAMP_GET</a>. <a href="#ga698a5a4ebd84335134a35e74848d2734">More...</a><br/></td></tr>
<tr class="separator:ga698a5a4ebd84335134a35e74848d2734"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga792651aa4035a7ad712c6bb201db8a6a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__Debug__gr.html#ga792651aa4035a7ad712c6bb201db8a6a">TARGET_DEVICE_FIXED</a>   0</td></tr>
<tr class="memdesc:ga792651aa4035a7ad712c6bb201db8a6a"><td class="mdescLeft"> </td><td class="mdescRight">Debug Unit is connected to fixed Target Device. The Debug Unit may be part of an evaluation board and always connected to a fixed known device. In this case a Device Vendor and Device Name string is stored which may be used by the debugger or IDE to configure device parameters. <a href="#ga792651aa4035a7ad712c6bb201db8a6a">More...</a><br/></td></tr>
<tr class="separator:ga792651aa4035a7ad712c6bb201db8a6a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gad52ec88278b7b3ccbdcc10359dd8d0a8"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__Debug__gr.html#gad52ec88278b7b3ccbdcc10359dd8d0a8">DAP_GetVendorString</a> (char *str)</td></tr>
<tr class="memdesc:gad52ec88278b7b3ccbdcc10359dd8d0a8"><td class="mdescLeft"> </td><td class="mdescRight">Get Vendor ID string. <a href="#gad52ec88278b7b3ccbdcc10359dd8d0a8">More...</a><br/></td></tr>
<tr class="separator:gad52ec88278b7b3ccbdcc10359dd8d0a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga947f60d7e5382cefe3087ad1fb46b13b"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__Debug__gr.html#ga947f60d7e5382cefe3087ad1fb46b13b">DAP_GetProductString</a> (char *str)</td></tr>
<tr class="memdesc:ga947f60d7e5382cefe3087ad1fb46b13b"><td class="mdescLeft"> </td><td class="mdescRight">Get Product ID string. <a href="#ga947f60d7e5382cefe3087ad1fb46b13b">More...</a><br/></td></tr>
<tr class="separator:ga947f60d7e5382cefe3087ad1fb46b13b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7b875652fd4e380af4d419bc2878ab33"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DAP__Config__Debug__gr.html#ga7b875652fd4e380af4d419bc2878ab33">DAP_GetSerNumString</a> (char *str)</td></tr>
<tr class="memdesc:ga7b875652fd4e380af4d419bc2878ab33"><td class="mdescLeft"> </td><td class="mdescRight">Get Serial Number string. <a href="#ga7b875652fd4e380af4d419bc2878ab33">More...</a><br/></td></tr>
<tr class="separator:ga7b875652fd4e380af4d419bc2878ab33"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Provides definitions about the hardware and configuration of the Debug Unit. </p>
<p>This information includes:</p>
<ul>
<li>Definition of Cortex-M processor parameters used in CMSIS-DAP Debug Unit.</li>
<li>Debug Unit Identification strings (Vendor, Product, Serial Number).</li>
<li>Debug Unit communication packet size.</li>
<li>Debug Access Port supported modes and settings (JTAG/SWD and SWO).</li>
<li>Optional information about a connected Target Device (for Evaluation Boards). </li>
</ul>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga512016e5f1966a8fd45b3f1a81ba5b8f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CPU_CLOCK   100000000U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Processor Clock of the Cortex-M MCU used in the Debug Unit. This value is used to calculate the SWD/JTAG clock speed. </p>
<p>Specifies the CPU Clock in Hz. </p>
</div>
</div>
<a class="anchor" id="ga89462514881c12c1508395050ce160eb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DAP_DEFAULT_PORT   1U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Default communication mode on the Debug Access Port. Used for the command <a class="el" href="group__DAP__Connect.html">DAP_Connect</a> when Port Default mode is selected. </p>
<p>Default JTAG/SWJ Port Mode: 1 = SWD, 2 = JTAG. </p>
</div>
</div>
<a class="anchor" id="gab52710df89c3e3c19de577c638f954ea"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DAP_DEFAULT_SWJ_CLOCK   1000000U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Default communication speed on the Debug Access Port for SWD and JTAG mode. Used to initialize the default SWD/JTAG clock frequency. The command <a class="el" href="group__DAP__SWJ__Clock.html">DAP_SWJ_Clock</a> can be used to overwrite this default setting. </p>
<p>Default SWD/JTAG clock frequency in Hz. </p>
</div>
</div>
<a class="anchor" id="ga3bbd310146b348db48a842ee804a0adf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DAP_JTAG   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicate that JTAG communication mode is available at the Debug Port. This information is returned by the command <a class="el" href="group__DAP__Info.html">DAP_Info</a> as part of <b>Capabilities</b>. </p>
<p>JTAG Mode: 1 = available, 0 = not available. </p>
</div>
</div>
<a class="anchor" id="gab29200a0988c7d1454f63661a8450dbf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DAP_JTAG_DEV_CNT   8U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure maximum number of JTAG devices on the scan chain connected to the Debug Access Port. This setting impacts the RAM requirements of the Debug Unit. Valid range is 1 .. 255. </p>
<p>Maximum number of JTAG devices on scan chain. </p>
</div>
</div>
<a class="anchor" id="ga03ed6a5aae34f4379ea97435122f83dd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DAP_PACKET_COUNT   8U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum Package Buffers for Command and Response data. This configuration settings is used to optimize the communication performance with the debugger and depends on the USB peripheral. For devices with limited RAM or USB buffer the setting can be reduced (valid range is 1 .. 255). </p>
<p>Specifies number of packets buffered. </p>
</div>
</div>
<a class="anchor" id="gaa28bb1da2661291634c4a8fb3e227404"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DAP_PACKET_SIZE   512U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum Package Size for Command and Response data. This configuration settings is used to optimize the communication performance with the debugger and depends on the USB peripheral. Typical vales are 64 for Full-speed USB HID or WinUSB, 1024 for High-speed USB HID and 512 for High-speed USB WinUSB. </p>
<p>Specifies Packet Size in bytes. </p>
</div>
</div>
<a class="anchor" id="gaf886ab35e52d1ff2935351817786c8af"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DAP_SWD   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicate that Serial Wire Debug (SWD) communication mode is available at the Debug Access Port. This information is returned by the command <a class="el" href="group__DAP__Info.html">DAP_Info</a> as part of <b>Capabilities</b>. </p>
<p>SWD Mode: 1 = available, 0 = not available. </p>
</div>
</div>
<a class="anchor" id="ga119c70409a24e3a8bb35df07dffeb8c8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define IO_PORT_WRITE_CYCLES   2U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of processor cycles for I/O Port write operations. This value is used to calculate the SWD/JTAG clock speed that is generated with I/O Port write operations in the Debug Unit by a Cortex-M MCU. Most Cortex-M processors require 2 processor cycles for a I/O Port Write operation. If the Debug Unit uses a Cortex-M0+ processor with high-speed peripheral I/O only 1 processor cycle might be required. </p>
<p>I/O Cycles: 2=default, 1=Cortex-M0+ fast I/0. </p>
</div>
</div>
<a class="anchor" id="ga5d89633a43ee3296e1754c7392ad856e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SWO_BUFFER_SIZE   4096U</td>
</tr>
</table>
</div><div class="memdoc">
<p>SWO Trace Buffer Size. </p>
<p>SWO Trace Buffer Size in bytes (must be 2^n). </p>
</div>
</div>
<a class="anchor" id="ga213ee3d1501adeca4c9c660072922c7e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SWO_MANCHESTER   0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicate that Manchester Serial Wire Output (SWO) trace is available. This information is returned by the command <a class="el" href="group__DAP__Info.html">DAP_Info</a> as part of <b>Capabilities</b>. </p>
<p>SWO Manchester: 1 = available, 0 = not available. </p>
</div>
</div>
<a class="anchor" id="gafd6f450a10f4e03757388e00ea56906f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SWO_STREAM   0</td>
</tr>
</table>
</div><div class="memdoc">
<p>SWO Streaming Trace. </p>
<p>SWO Streaming Trace: 1 = available, 0 = not available. </p>
</div>
</div>
<a class="anchor" id="gaf0d60b30fb0eef2d249bc89a6e454ab6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SWO_UART   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicate that UART Serial Wire Output (SWO) trace is available. This information is returned by the command <a class="el" href="group__DAP__Info.html">DAP_Info</a> as part of <b>Capabilities</b>. </p>
<p>SWO UART: 1 = available, 0 = not available. </p>
</div>
</div>
<a class="anchor" id="gad19240f209f055db7d70cb5eb2431d31"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SWO_UART_MAX_BAUDRATE   10000000U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum SWO UART Baudrate. </p>
<p>SWO UART Maximum Baudrate in Hz. </p>
</div>
</div>
<a class="anchor" id="ga792651aa4035a7ad712c6bb201db8a6a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TARGET_DEVICE_FIXED   0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Debug Unit is connected to fixed Target Device. The Debug Unit may be part of an evaluation board and always connected to a fixed known device. In this case a Device Vendor and Device Name string is stored which may be used by the debugger or IDE to configure device parameters. </p>
<p>Target Device: 1 = known, 0 = unknown; </p>
</div>
</div>
<a class="anchor" id="ga698a5a4ebd84335134a35e74848d2734"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TIMESTAMP_CLOCK   100000000U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Clock frequency of the Test Domain Timer. Timer value is returned with <a class="el" href="group__DAP__Config__Timestamp__gr.html#gaf9bdc40d3a256fc2cc4d26b295993d9c">TIMESTAMP_GET</a>. </p>
<p>Timestamp clock in Hz (0 = timestamps not supported). </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga947f60d7e5382cefe3087ad1fb46b13b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__STATIC_INLINE uint8_t DAP_GetProductString </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get Product ID string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>Pointer to buffer to store the string. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>String length. </dd></dl>
</div>
</div>
<a class="anchor" id="ga7b875652fd4e380af4d419bc2878ab33"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__STATIC_INLINE uint8_t DAP_GetSerNumString </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get Serial Number string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>Pointer to buffer to store the string. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>String length. </dd></dl>
</div>
</div>
<a class="anchor" id="gad52ec88278b7b3ccbdcc10359dd8d0a8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__STATIC_INLINE uint8_t DAP_GetVendorString </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get Vendor ID string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>Pointer to buffer to store the string. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>String length. </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>
|
