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
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Target Communication Framework Services - Registers</title>
</head>
<body lang='EN-US'>
<h1>Target Communication Framework Services - Registers</h1>
<ul>
<li><a href='#VersionHistory'>Version History</a>
<li><a href='#Overview'>Overview</a>
<li><a href='#Cmds'>Commands</a>
<ul>
<li><a href='#CmdGetContext'>Get Context</a>
<li><a href='#CmdGetChildren'>Get Children</a>
<li><a href='#CmdSetRegister'>Set Register</a>
<li><a href='#CmdGetRegister'>Get Register</a>
<li><a href='#CmdSetMultiple'>Set Multiple Registers</a>
<li><a href='#CmdGetMultiple'>Get Multiple Registers</a>
<li><a href='#CmdSearch'>Search for Registers</a>
</ul>
<li><a href='#Events'>Events</a>
<li><a href='#API'>API</a>
</ul>
<h1>Registers Service</h1>
<h2><a name='VersionHistory'>Version History</a></h2>
<table border=1 cellpadding=8>
<tr>
<th>Version
<th>Date
<th>Change
<tr>
<td>0.1
<td>2008-01-10
<td>Initial contribution
<tr>
<td>0.2
<td>2008-04-23
<td>Added get/set multiple
<tr>
<td>1.0
<td>2008-05-06
<td>Approved
<tr>
<td>1.1
<td>2009-03-16
<td>Added search command and several context properties
</table>
<h2><a name='Overview'>Overview</a></h2>
<p>The service provides basic operations to read/write CPU and hardware registers. Command
and event parameters are encoded as zero terminated <a href='TCF Specification.html#JSON'>JSON</a> strings.</p>
<p>The service uses standard format for error reports,
see <a href='TCF Services.html#ErrorFormat'>Error Report Format</a>.</p>
In addition to commands that can set/get individual register context values, the service defines commands to set/get values at
multiple locations. This allows:
<ol>
<li> to get/set multiple register contexts in one command
<li> to specify offset and size for get/set on large register groups
<li> to get/set truncated register values, e.g. only the low 32 bits of a 64-bit register
</ol>
<h2><a name='Cmds'>Commands</a></h2>
<h3><a name='CmdGetContext'>Get Context</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
C • <i><token></i> • Registers • getContext • <i><string: context ID></i> •
</font></b></pre>
<p>The command retrieves context info for given context ID. A context corresponds to an
register, register group, register bit field, etc. Exact meaning of a context depends on the target.
Target agent should define contexts hierarchy that is:</p>
<ul type='disc'>
<li>Adequately reflects target hardware registers layout;
<li>Consistent with the lingo/terminology of the processor manuals;
<li>Intuitive to a user.
</ul>
<p>Reply:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
R • <i><token></i> • <i><error report></i> • <i><context data></i> •
<i><context data></i>
⇒ null
⇒ <i><object></i>
</font></b></pre>
<p>Context data object should, at least, contain member
<b><font face="Courier New" size=2 color=#333399>"ID" : <i><string>.</i></font></b>
Context data is expected to be cached by clients.
Service sends contextChanged event to notify changes in context data.</p>
<p>Predefined register context properties are:</p>
<ul>
<li><code><b><font face="Courier New" size=2 color=#333399>"ID" : <i><string></i></font></b></code>
- ID of the context, same as getContext command argument.
<li><code><b><font face="Courier New" size=2 color=#333399>"ParentID" : <i><string></i></font></b></code>
- ID of a parent context.
<li><code><b><font face="Courier New" size=2 color=#333399>"ProcessID" : <i><string></i></font></b></code>
- process ID.
<li><code><b><font face="Courier New" size=2 color=#333399>"Name" : <i><string></i></font></b></code>
- context name.
<li><code><b><font face="Courier New" size=2 color=#333399>"Description" : <i><string></i></font></b></code>
- context description.
<li><code><b><font face="Courier New" size=2 color=#333399>"Size" : <i><int></i></font></b></code>
- context size in bytes. Byte arrays in get/set commands should be same size.
Hardware register can be smaller then this size, for example in case
when register size is not an even number of bytes. In such case implementation
should add/remove padding that consists of necessary number of zero bits.
<li><code><b><font face="Courier New" size=2 color=#333399>"Readable" : <i><boolean></i></font></b></code>
- true if context value can be read.
<li><code><b><font face="Courier New" size=2 color=#333399>"ReadOnce" : <i><boolean></i></font></b></code>
- true if reading the context (register) destroys its current value - it can be read only once.
<li><code><b><font face="Courier New" size=2 color=#333399>"Writeable" : <i><boolean></i></font></b></code>
- true if context value can be written.
<li><code><b><font face="Courier New" size=2 color=#333399>"WriteOnce" : <i><boolean></i></font></b></code>
- true if register value can not be overwritten - every write counts.
<li><code><b><font face="Courier New" size=2 color=#333399>"SideEffects" : <i><boolean></i></font></b></code>
- true if writing the context can change values of other registers.
<li><code><b><font face="Courier New" size=2 color=#333399>"Volatile" : <i><boolean></i></font></b></code>
- true if the register value can change even when target is stopped.
<li><code><b><font face="Courier New" size=2 color=#333399>"Float" : <i><boolean></i></font></b></code>
- true if the register value is a floating-point value.
<li><code><b><font face="Courier New" size=2 color=#333399>"BigEndian" : <i><boolean></i></font></b></code>
- true if big endian, which means decreasing numeric significance with increasing bit number.
If absent default if false, which implies little endianess. The endianess is used to encode and decode values of get, getm, set and setm commands.
<li><code><b><font face="Courier New" size=2 color=#333399>"LeftToRight" : <i><boolean></i></font></b></code>
- true if the lowest numbered bit (i.e. bit #0 or bit #1, depending on "FirstBit" value) should be shown to user as the left-most bit.
<li><code><b><font face="Courier New" size=2 color=#333399>"FirstBit" : <i><int></i></font></b></code>
- 0 or 1. If the context has bit field children, bit positions of the fields can be zero-based or 1-based.
<li><code><b><font face="Courier New" size=2 color=#333399>"Bits" : <i><array of int></i></font></b></code>
- if context is a bit field, contains the field bit numbers in the parent context.
<li><code><b><font face="Courier New" size=2 color=#333399>"Values" : <i><array of named values></i></font></b></code>
- predefined names (mnemonics) for some of context values.
<pre><b><font face="Courier New" size=2 color=#333399>
<i><array of named values></i>
⇒ null
⇒ [ ]
⇒ [ <i><named values list></i> ]
<i><named values list></i>
⇒ <i><object: named value properties></i>
⇒ <i><named values list></i> , <i><object: named value properties></i>
</font></b></pre>
Named value properties are:
<ul>
<li><code><b><font face="Courier New" size="2" color="#333399">"Name"</font></b></code>
- Name (menemonic) of the value.
<li><code><b><font face="Courier New" size="2" color="#333399">"Value"</font></b></code>
- BASE64 encoded binary bits of the value.
<li><code><b><font face="Courier New" size="2" color="#333399">"Description"</font></b></code>
- Short, human readable description of the value.
</ul>
<p>
<li><code><b><font face="Courier New" size="2" color="#333399">"MemoryAddress" : <i><int></i></font></b></code>
- The address of a memory mapped register. If MemoryContext is provided, the address is referring into that context.
<li><code><b><font face="Courier New" size="2" color="#333399">"MemoryContext" : <i><string></i></font></b></code>
- The context ID of a memory context in which a memory mapped register is located. Used together with MemoryAddress to inform where in memory memory mapped registers are located.
If absent and MemoryAddress is defined, the context ID of this context is used as default.
<li><code><b><font face="Courier New" size="2" color="#333399">"CanSearch" : <i><array of strings></i></font></b></code>
- A list of attribute names which can be searched for starting on this context.
If absent the context does not support search.
<li><code><b><font face="Courier New" size="2" color="#333399">"Role" : <i><string></i></font></b></code>
- The role the register plays in a program execution.
<p>Predefined register role strings are:</p>
<ul>
<li><code><b><font face="Courier New" size="2" color="#333399">"PC"</font></b></code>
- Program counter. Defines instruction to execute next.
<li><code><b><font face="Courier New" size="2" color="#333399">"SP"</font></b></code>
- Register defining the current stack pointer location.
<li><code><b><font face="Courier New" size="2" color="#333399">"FP"</font></b></code>
- Register defining the current frame pointer location.
<li><code><b><font face="Courier New" size="2" color="#333399">"RET"</font></b></code>
- Register used to store the return address for calls.
<li><code><b><font face="Courier New" size="2" color="#333399">"CORE"</font></b></code>
- Indicates register or register groups which belong to the core state.
Commonly set for general purpose registers,
condition code and other registers which are of special
interest for determining the state.
</ul>
</ul>
<h3><a name='CmdGetChildren'>Get Children</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
C • <i><token></i> • Registers • getChildren • <i><string: parent context ID></i> •
</font></b></pre>
<p>The command requests a list of contexts available for registers access commands.</p>
<p>Parent context ID is usually a thread ID retrieved through Run Control Service or one
of context IDs retrieved by previous getChildren commands.
Contexts hierarchy can be simple plain list of registers, or it can form a tree of register groups, registers and bit fields.
It is up to target agent developers to choose layout that is most descriptive for a given target.</p>
<p>Reply:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
R • <i><token></i> • <i><error report></i> • <i><array of context IDs></i> •<i></i>
<i><array of context IDs></i>
⇒ null
⇒ [ ]
⇒ [ <i><context ID list></i> ]
<i><context ID list></i>
⇒ <i><string: context ID></i>
⇒ <i><context ID list></i> , <i><string: context ID></i>
</font></b></pre>
<h3><a name='CmdSetRegister'>Set Register</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
C • <token> • Registers • set • <i><string: context ID></i> • <i><string: value></i> •
</font></b></pre>
<p>Writes value into given register context. Context ID must be one returned by getContexts.
Value is BASE64 encoded byte array of binary data. Array size should match the size of the register.</p>
<p>Result message:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
R • <i><token></i> • <i><error report></i> •
</font></b></pre>
<p>Error report provides integer error code and a short, human readable explanation
of error.</p>
<h3><a name='CmdGetRegister'>Get Register</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
C • <token> • Registers • get • <i><string: context ID></i> •
</font></b></pre>
<p>Reads register value from given register context. Context ID must be one returned by getContexts.
</p>
<p>Result message:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
R • <i><token></i> • <i><error report></i> • <i><string: value></i> •
</font></b></pre>
<p>Error report provides integer error code and a short, human readable explanation
of error. Value is BASE64 encoded byte array of binary data. Array size should match the size of the register.</p>
<h3><a name='CmdSetMultiple'>Set Multiple Registers</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
C • <token> • Registers • setm • <i><array of locations></i> • <i><string: value></i> •
<i><array of locations></i>
⇒ [ <i><location list></i> ]
<i><location list></i>
⇒ <i><location></i>
⇒ <i><location list></i> , <i><location></i>
<i><location></i>
⇒ [ <i><string: register context ID></i> , <i><int: offset in bytes></i> , <i><int: size in bytes></i> ]
</font></b></pre>
<p>Writes value into given list of locations in registers. Each location is represented by 3-element array that consists of
context ID, offset in the context in bytes and value size in bytes.
Value is BASE64 encoded byte array of binary data. Byte array size should match the sum of location sizes.</p>
<p>Result message:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
R • <i><token></i> • <i><error report></i> •
</font></b></pre>
<p>Error report provides integer error code and a short, human readable explanation
of error.</p>
<h3><a name='CmdGetMultiple'>Get Multiple Registers</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
C • <token> • Registers • getm • <i><array of locations></i> •
<i><array of locations></i>
⇒ [ <i><location list></i> ]
<i><location list></i>
⇒ <i><location></i>
⇒ <i><location list></i> , <i><location></i>
<i><location></i>
⇒ [ <i><string: register context ID></i> , <i><int: offset in bytes></i> , <i><int: size in bytes></i> ]
</font></b></pre>
<p>Reads register values from given list of locations in registers. Each location is represented by 3-element array that consists of
context ID, offset in the context in bytes and value size in bytes.
</p>
<p>Result message:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
R • <i><token></i> • <i><error report></i> • <i><string: value></i> •
</font></b></pre>
<p>Error report provides integer error code and a short, human readable explanation
of error. Value is BASE64 encoded byte array of binary data. Byte array size should match the sum of location sizes.</p>
<h3><a name='CmdSearch'>Search for Registers</a></h3>
<pre><b><font face="Courier New" size="2" color="#333399">
C • <token> • Registers • search • <i><string: start context ID> • <object:filter properties></i> •
</font></b></pre>
<p>Search returns a path to each context with properties matching the filter. A path consists of a list of
context ids starting with a direct child of the start context up to the found context.
Search is only supported for properties listed in the CanSearch property.
<p>Predefined filter object properties are:</p>
<ul>
<li><code><b><font face="Courier New" size="2" color="#333399">"Name" : <i><string></i></font></b></code>
- The name of the property this filter applies to. Must be one of the names listed in the CanSearch property.
</li>
<li><code><b><font face="Courier New" size="2" color="#333399">"EqualValue" : <i><string></i></font></b></code>
- The value which is searched for.
</li>
</ul>
</p>
<p>Result message:</p>
<pre><b><font face="Courier New" size="2" color="#333399">
R • <i><token></i> • <i><error report></i> • <i><array of context Paths></i> •
<i><array of context Paths></i>
⇒ null
⇒ [ ]
⇒ [ <i><context Path list></i> ]
<i><context Path list></i>
⇒ <i><array of context IDs></i>
⇒ <i><context Path list></i> , <i><array of context IDs></i>
</font></b></pre>
<p>Error report provides integer error code and a short, human readable explanation of error.
In the result, each matching context is provided with the path of parents starting with the direct
children of the starting node up to the matching node.
Multiple found entries are returned as an array of those paths.
</p>
Example Assume the following context hierarchy:
<pre><b><font face="Courier New" size="2">
{"Name" : "Core", "ID":"ID_C"}
{"Name" : "Group0", "ID":"ID_G0", "Role":"CORE"}
{"Name" : "PC", "ID":"ID_PC", "Role":"PC"}
{"Name" : "SP", "ID":"ID_SP", "Role":"SP"}
{"Name" : "Group1", "ID":"ID_G1"}
{"Name" : "R0", "ID":"ID_R0"}
</font></b></pre>
With this setup, the following commands and responses could take place:
<pre><b><font face="Courier New" size="2">
C • "1234" • Registers • search • "ID_C" • {"Name":"Name", "EqualValue":"PC"} •
R • "1234" • [["ID_G0", "ID_PC"]] •
C • "1235" • Registers • search • "ID_C" • {"Name":"Role", "EqualValue":"CORE"} •
R • "1235" • [["ID_G0"]] •
</font></b></pre>
<h2><a name='Events'>Events</a></h2>
<p>Registers service broadcasts notification events when registers contexts are changed, and when
a register content is altered by "set" commands.</p>
<pre><b><font face="Courier New" size="2" color="#333399">
E • Registers • contextChanged •
E • Registers • registerChanged • <i><string: context ID></i> •
</font></b></pre>
<h2><a name='API'>API</a></h2>
<pre>
<font color=#3F5FBF>/**
* IRegisters service provides access to target CPU register values and properties.
*/</font>
<font color=#7F0055>public interface</font> IRegisters <font color=#7F0055>extends</font> IService {
<font color=#7F0055>static final</font> String NAME = "Registers";
<font color=#3F5FBF>/**
* Context property names.
*/</font>
<font color=#7F0055>static final</font> String
PROP_ID = "ID", <font color=#3F5FBF>/** String, ID of the context */</font>
PROP_PARENT_ID = "ParentID", <font color=#3F5FBF>/** String, ID of a parent context */</font>
PROP_PROCESS_ID = "ProcessID", <font color=#3F5FBF>/** String, process ID */</font>
PROP_NAME = "Name", <font color=#3F5FBF>/** String, context name */</font>
PROP_DESCRIPTION = "Description", <font color=#3F5FBF>/** String, context description */</font>
PROP_SIZE = "Size", <font color=#3F5FBF>/** Number, context size in bytes. Byte arrays in get/set commands should be same size */</font>
PROP_READBLE = "Readable", <font color=#3F5FBF>/** Boolean, true if context value can be read */</font>
PROP_READ_ONCE = "ReadOnce", <font color=#3F5FBF>/** Boolean, true if reading the context (register) destroys its current value */</font>
PROP_WRITEABLE = "Writeable", <font color=#3F5FBF>/** Boolean, true if context value can be written */</font>
PROP_WRITE_ONCE = "WriteOnce", <font color=#3F5FBF>/** Boolean, true if register value can not be overwritten - every write counts */</font>
PROP_SIDE_EFFECTS = "SideEffects", <font color=#3F5FBF>/** Boolean, true if writing the context can change values of other registers */</font>
PROP_VOLATILE = "Volatile", <font color=#3F5FBF>/** Boolean, true if the register value can change even when target is stopped */</font>
PROP_FLOAT = "Float", <font color=#3F5FBF>/** Boolean, true if the register value is a floating-point value */</font>
PROP_BIG_ENDIAN = "BigEndian", <font color=#3F5FBF>/** Boolean, true if big endian */</font>
PROP_LEFT_TO_RIGHT = "LeftToRight", <font color=#3F5FBF>/** Boolean, true if the lowest numbered bit should be shown to user as the left-most bit */</font>
PROP_FIST_BIT = "FirstBit", <font color=#3F5FBF>/** Number, bit numbering base (0 or 1) to use when showing bits to user */</font>
PROP_BITS = "Bits", <font color=#3F5FBF>/** Number, if context is a bit field, contains the field bit numbers in the parent context */</font>
PROP_VALUES = "Values", <font color=#3F5FBF>/** Array of Map, predefined names (mnemonics) for some of context values */</font>
PROP_MEMORY_ADDRESS = "MemoryAddress", <font color=#3F5FBF>/** Number, the address of a memory mapped register */</font>
PROP_MEMORY_CONTEXT = "MemoryContext", <font color=#3F5FBF>/** String, the context ID of a memory context in which a memory mapped register is located */</font>
PROP_CAN_SEARCH = "CanSearch", <font color=#3F5FBF>/** Array of String, a list of attribute names which can be searched for starting on this context */</font>
PROP_ROLE = "Role"; <font color=#3F5FBF>/** String, the role the register plays in a program execution */</font>
<font color=#3F5FBF>/**
* Role property names.
*/</font>
<font color=#7F0055>static final</font> String
ROLE_PC = "PC", <font color=#3F5FBF>/** Program counter. Defines instruction to execute next */</font>
ROLE_SP = "SP", <font color=#3F5FBF>/** Register defining the current stack pointer location */</font>
ROLE_FP = "FP", <font color=#3F5FBF>/** Register defining the current frame pointer location */</font>
ROLE_RET = "RET", <font color=#3F5FBF>/** Register used to store the return address for calls */</font>
ROLE_CORE = "CORE"; <font color=#3F5FBF>/** Indicates register or register groups which belong to the core state */</font>
<font color=#3F5FBF>/**
* Filter property names.
*/</font>
<font color=#7F0055>static final</font> String
SEARCH_NAME = "Name", <font color=#3F5FBF>/** The name of the property this filter applies too */</font>
SEARCH_EQUAL_VALUE = "EqualValue"; <font color=#3F5FBF>/** The value which is searched for */</font>
<font color=#3F5FBF>/**
* Retrieve context info for given context ID.
*
* <font color=#7F9FBF>@param</font> id – context ID.
* <font color=#7F9FBF>@param</font> done - call back interface called when operation is completed.
*/</font>
IToken getContext(String id, DoneGetContext done);
<font color=#3F5FBF>/**
* Client call back interface for getContext().
*/</font>
<font color=#7F0055>interface</font> DoneGetContext {
<font color=#3F5FBF>/**
* Called when contexts data retrieval is done.
* <font color=#7F9FBF>@param</font> error – error description if operation failed, null if succeeded.
* <font color=#7F9FBF>@param</font> context – context data.
*/</font>
<font color=#7F0055>void</font> doneGetContext(IToken token, Exception error, RegistersContext context);
}
<font color=#3F5FBF>/**
* Retrieve contexts available for registers commands.
* A context corresponds to an execution thread, stack frame, registers group, etc.
* A context can belong to a parent context. Contexts hierarchy can be simple
* plain list or it can form a tree. It is up to target agent developers to choose
* layout that is most descriptive for a given target. Context IDs are valid across
* all services. In other words, all services access same hierarchy of contexts,
* with same IDs, however, each service accesses its own subset of context's
* attributes and functionality, which is relevant to that service.
*
* <font color=#7F9FBF>@param</font> parent_context_id – parent context ID. Can be null –
* to retrieve top level of the hierarchy, or one of context IDs retrieved
* by previous getChildren commands.
* <font color=#7F9FBF>@param</font> done - call back interface called when operation is completed.
*/</font>
IToken getChildren(String parent_context_id, DoneGetChildren done);
<font color=#3F5FBF>/**
* Client call back interface for getChildren().
*/</font>
<font color=#7F0055>interface</font> DoneGetChildren {
<font color=#3F5FBF>/**
* Called when contexts data retrieval is done.
* <font color=#7F9FBF>@param</font> error – error description if operation failed, null if succeeded.
* <font color=#7F9FBF>@param</font> context_ids – array of available context IDs.
*/</font>
<font color=#7F0055>void</font> doneGetChildren(IToken token, Exception error, String[] context_ids);
}
<font color=#3F5FBF>/**
* RegistersContext objects represent register groups, registers and bit fields.
*/</font>
<font color=#7F0055>interface</font> RegistersContext {
<font color=#3F5FBF>/**
* Get Context ID.
* <font color=#7F9FBF>@return</font> context ID.
*/</font>
String getID();
<font color=#3F5FBF>/**
* Get parent context ID.
* <font color=#7F9FBF>@return</font> parent context ID.
*/</font>
String getParentID();
<font color=#3F5FBF>/**
* Get context (register, register group, bit field) name.
* <font color=#7F9FBF>@return</font> context name.
*/</font>
String getName();
<font color=#3F5FBF>/**
* Get context description.
* <font color=#7F9FBF>@return</font> context description.
*/</font>
String getDescription();
<font color=#3F5FBF>/**
* Get context size in bytes.
* Byte arrays in get()/set() methods should be same size.
* Hardware register can be smaller then this size, for example in case
* when register size is not an even number of bytes. In such case implementation
* should add/remove padding that consists of necessary number of zero bits.
* @return context size in bytes.
*/</font>
<font color=#7F0055>int</font> getSize();
<font color=#3F5FBF>/**
* Check if context value can be read.
* <font color=#7F9FBF>@return</font> true if can read value of the context.
*/</font>
<font color=#7F0055>boolean</font> isReadable();
<font color=#3F5FBF>/**
* Check if reading the context (register) destroys its current value -
* it can be read only once.
* <font color=#7F9FBF>@return</font> true if read-once register.
*/</font>
<font color=#7F0055>boolean</font> isReadOnce();
<font color=#3F5FBF>/**
* Check if context value can be written.
* <font color=#7F9FBF>@return</font> true if can write value of the context.
*/</font>
<font color=#7F0055>boolean</font> isWriteable();
<font color=#3F5FBF>/**
* Check if register value can not be overwritten - every write counts.
* <font color=#7F9FBF>@return</font> true if write-once register.
*/</font>
<font color=#7F0055>boolean</font> isWriteOnce();
<font color=#3F5FBF>/**
* Check if writing the context can change values of other registers.
* <font color=#7F9FBF>@return</font> true if has side effects.
*/</font>
<font color=#7F0055>boolean</font> hasSideEffects();
<font color=#3F5FBF>/**
* Check if the register value can change even when target is stopped.
* <font color=#7F9FBF>@return</font> true if the register value can change at any time.
*/</font>
<font color=#7F0055>boolean</font> isVolatile();
<font color=#3F5FBF>/**
* Check if the register value is a floating-point value.
* <font color=#7F9FBF>@return</font> true if a floating-point register.
*/</font>
<font color=#7F0055>boolean</font> isFloat();
<font color=#3F5FBF>/**
* Check endianess of the context.
* Big endian means decreasing numeric significance with increasing bit number.
* <font color=#7F9FBF>@return</font> true if big endian.
*/</font>
<font color=#7F0055>boolean</font> isBigEndian();
<font color=#3F5FBF>/**
* Check if the lowest numbered bit (i.e. bit #0 or bit #1 depending on
* getFirstBitNumber() value) should be shown to user as the left-most bit or
* the right-most bit.
* <font color=#7F9FBF>@return</font> true if the first bit is left-most bit.
*/</font>
<font color=#7F0055>boolean</font> isLeftToRight();
<font color=#3F5FBF>/**
* If the context has bit field children, bit positions of the fields
* can be zero-based or 1-based.
* <font color=#7F9FBF>@return</font> first bit position - 0 or 1.
*/</font>
<font color=#7F0055>int</font> getFirstBitNumber();
<font color=#3F5FBF>/**
* If context is a bit field, get the field bit numbers in parent context.
* <font color=#7F9FBF>@return</font> array of bit numbers.
*/</font>
<font color=#7F0055>int</font>[] getBitNumbers();
<font color=#3F5FBF>/**
* A context can have predefined names (mnemonics) for some its values.
* This method returns a list of such named values.
* <font color=#7F9FBF>@return</font> array of named values or null.
*/</font>
NamedValue[] getNamedValues();
<font color=#3F5FBF>/**
* Get the address of a memory mapped register.
* <font color=#7F9FBF>@return</font> address.
*/</font>
Number getMemoryAddress();
<font color=#3F5FBF>/**
* Get the context ID of a memory context in which a memory mapped register is located.
* <font color=#7F9FBF>@return</font> memory context ID.
*/</font>
String getMemoryContext();
<font color=#3F5FBF>/**
* Get a list of property names which can be searched for starting on this context
* <font color=#7F9FBF>@return</font> collection of property names.
*/</font>
Collection<String> canSearch();
<font color=#3F5FBF>/**
* Get the role the register plays in a program execution.
* <font color=#7F9FBF>@return</font> role name.
*/</font>
String getRole();
<font color=#3F5FBF>/**
* Get complete map of context properties.
* <font color=#7F9FBF>@return</font> map of all available context properties.
*/</font>
Map<String,Object> getProperties();
<font color=#3F5FBF>/**
* Read value of the context.
* <font color=#7F9FBF>@param</font> done - call back object.
* <font color=#7F9FBF>@return</font> - pending command handle.
*/</font>
IToken get(DoneGet done);
<font color=#3F5FBF>/**
* Set value of the context.
* <font color=#7F9FBF>@param</font> value - value to write into the context.
* <font color=#7F9FBF>@param</font> done - call back object.
* <font color=#7F9FBF>@return</font> - pending command handle.
*/</font>
IToken set(byte[] value, DoneSet done);
<font color=#3F5FBF>/**
* Search register contexts that passes given search filter.
* Search is only supported for properties listed in the "CanSearch" property.
* <font color=#7F9FBF>@param</font> filter - properties bag that defines search filter.
* <font color=#7F9FBF>@param</font> done - call back object.
* <font color=#7F9FBF>@return</font> - pending command handle.
*/</font>
IToken search(Map<String,Object> filter, DoneSearch done);
}
<font color=#3F5FBF>/**
* A register context can have predefined names (mnemonics) for some its values.
* NamedValue objects represent such values.
*/</font>
<font color=#7F0055>interface</font> NamedValue {
<font color=#3F5FBF>/**
* Get value associated with the name.
* <font color=#7F9FBF>@return</font> the value as an array of bytes.
*/</font>
byte[] getValue();
<font color=#3F5FBF>/**
* Get name (mnemonic) of the value.
* <font color=#7F9FBF>@return</font> value name.
*/</font>
String getName();
<font color=#3F5FBF>/**
* Get human readable description of the value.
* <font color=#7F9FBF>@return</font> value description.
*/</font>
String getDescription();
}
<font color=#3F5FBF>/**
* Read values of multiple locations in registers.
* <font color=#7F9FBF>@param</font> locs - array of data locations.
* <font color=#7F9FBF>@param</font> done - call back object.
* <font color=#7F9FBF>@return</font> - pending command handle.
*/</font>
IToken getm(Location[] locs, DoneGet done);
<font color=#3F5FBF>/**
* Set values of multiple locations in registers.
* <font color=#7F9FBF>@param</font> locs - array of data locations.
* <font color=#7F9FBF>@param</font> value - value to write into the context.
* <font color=#7F9FBF>@param</font> done - call back object.
* <font color=#7F9FBF>@return</font> - pending command handle.
*/</font>
IToken setm(Location[] locs, byte[] value, DoneSet done);
<font color=#3F5FBF>/**
* Class Location represents value location in register context
*/</font>
<font color=#7F0055>final class</font> Location {
<font color=#3F5FBF>/** Register context ID */</font>
<font color=#7F0055>public final</font> String id;
<font color=#3F5FBF>/** offset in the context, in bytes */</font>
<font color=#7F0055>public final int</font> offs;
<font color=#3F5FBF>/** value size in bytes */</font>
<font color=#7F0055>public final int</font> size;
<font color=#7F0055>public</font> Location(String id, <font color=#7F0055>int</font> offs, <font color=#7F0055>int</font> size) {
<font color=#7F0055>this</font>.id = id;
<font color=#7F0055>this</font>.offs = offs;
<font color=#7F0055>this</font>.size = size;
}
}
<font color=#3F5FBF>/**
* 'get' command call back interface.
*/</font>
<font color=#7F0055>interface</font> DoneGet {
<font color=#3F5FBF>/**
* Called when value retrieval is done.
* <font color=#7F9FBF>@param</font> token - command handle
* <font color=#7F9FBF>@param</font> error - error description if operation failed, null if succeeded.
* <font color=#7F9FBF>@param</font> value - context value as array of bytes.
*/</font>
<font color=#7F0055>void</font> doneGet(IToken token, Exception error, byte[] value);
}
<font color=#3F5FBF>/**
* 'set' command call back interface.
*/</font>
<font color=#7F0055>interface</font> DoneSet {
<font color=#3F5FBF>/**
* Called when value setting is done.
* <font color=#7F9FBF>@param</font> token - command handle.
* <font color=#7F9FBF>@param</font> error - error description if operation failed, null if succeeded.
*/</font>
<font color=#7F0055>void</font> doneSet(IToken token, Exception error);
}
<font color=#3F5FBF>/**
* 'search' command call back interface.
*/</font>
<font color=#7F0055>interface</font> DoneSearch {
<font color=#3F5FBF>/**
* Called when context search is done.
* <font color=#7F9FBF>@param</font> token - command handle.
* <font color=#7F9FBF>@param</font> error - error description if operation failed, null if succeeded.
* <font color=#7F9FBF>@param</font> paths - array of paths to each context with properties matching the filter
*/</font>
<font color=#7F0055>void</font> doneSearch(IToken token, String[][] paths);
}
<font color=#3F5FBF>/**
* Add registers service event listener.
* <font color=#7F9FBF>@param</font> listener - event listener implementation.
*/</font>
<font color=#7F0055>void</font> addListener(RegistersListener listener);
<font color=#3F5FBF>/**
* Remove registers service event listener.
* <font color=#7F9FBF>@param</font> listener - event listener implementation.
*/</font>
<font color=#7F0055>void</font> removeListener(RegistersListener listener);
<font color=#3F5FBF>/**
* Registers event listener is notified when registers context hierarchy
* changes, and when a register is modified by the service commands.
*/</font>
<font color=#7F0055>interface</font> RegistersListener {
<font color=#3F5FBF>/**
* Called when register context properties changed.
* Most targets have static set of registers and register properties.
* Such targets never generate this event. However, some targets,
* for example, JTAG probes, allow user to modify register definitions.
* Clients should flush all cached register context data.
*/</font>
<font color=#7F0055>void</font> contextChanged();
<font color=#3F5FBF>/**
* Called when register content was changed and clients
* need to update themselves. Clients, at least, should invalidate
* corresponding cached registers data.
* Not every change is notified - it is not possible,
* only those, which are not caused by normal execution of the debuggee.
* At least, changes caused by "set" command should be notified.
* <font color=#7F9FBF>@param</font> id - register context ID.
*/</font>
<font color=#7F0055>void</font> registerChanged(String context_id);
}
}
</pre>
</body>
</html>
|
