hc
2023-11-22 9ca5fbcb63a8dcaee0527f96afb91dc4b4bd8fa9
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
* CoreSight Components:
 
CoreSight components are compliant with the ARM CoreSight architecture
specification and can be connected in various topologies to suit a particular
SoCs tracing needs. These trace components can generally be classified as
sinks, links and sources. Trace data produced by one or more sources flows
through the intermediate links connecting the source to the currently selected
sink. Each CoreSight component device should use these properties to describe
its hardware characteristcs.
 
* Required properties for all components *except* non-configurable replicators:
 
   * compatible: These have to be supplemented with "arm,primecell" as
     drivers are using the AMBA bus interface.  Possible values include:
       - Embedded Trace Buffer (version 1.0):
           "arm,coresight-etb10", "arm,primecell";
 
       - Trace Port Interface Unit:
           "arm,coresight-tpiu", "arm,primecell";
 
       - Trace Memory Controller, used for Embedded Trace Buffer(ETB),
         Embedded Trace FIFO(ETF) and Embedded Trace Router(ETR)
         configuration.  The configuration mode (ETB, ETF, ETR) is
         discovered at boot time when the device is probed.
           "arm,coresight-tmc", "arm,primecell";
 
       - Trace Funnel:
           "arm,coresight-funnel", "arm,primecell";
 
       - Embedded Trace Macrocell (version 3.x) and
                   Program Flow Trace Macrocell:
           "arm,coresight-etm3x", "arm,primecell";
 
       - Embedded Trace Macrocell (version 4.x):
           "arm,coresight-etm4x", "arm,primecell";
 
       - Coresight programmable Replicator :
           "arm,coresight-dynamic-replicator", "arm,primecell";
 
       - System Trace Macrocell:
           "arm,coresight-stm", "arm,primecell"; [1]
       - Coresight Address Translation Unit (CATU)
           "arm,coresight-catu", "arm,primecell";
 
   * reg: physical base address and length of the register
     set(s) of the component.
 
   * clocks: the clocks associated to this component.
 
   * clock-names: the name of the clocks referenced by the code.
     Since we are using the AMBA framework, the name of the clock
     providing the interconnect should be "apb_pclk", and some
     coresight blocks also have an additional clock "atclk", which
     clocks the core of that coresight component. The latter clock
     is optional.
 
   * port or ports: The representation of the component's port
     layout using the generic DT graph presentation found in
     "bindings/graph.txt".
 
* Additional required properties for System Trace Macrocells (STM):
   * reg: along with the physical base address and length of the register
     set as described above, another entry is required to describe the
     mapping of the extended stimulus port area.
 
   * reg-names: the only acceptable values are "stm-base" and
     "stm-stimulus-base", each corresponding to the areas defined in "reg".
 
* Required properties for devices that don't show up on the AMBA bus, such as
  non-configurable replicators:
 
   * compatible: Currently supported value is (note the absence of the
     AMBA markee):
       - "arm,coresight-replicator"
 
   * port or ports: same as above.
 
* Optional properties for all components:
 
   * arm,coresight-loses-context-with-cpu : boolean. Indicates that the
     hardware will lose register context on CPU power down (e.g. CPUIdle).
     An example of where this may be needed are systems which contain a
     coresight component and CPU in the same power domain. When the CPU
     powers down the coresight component also powers down and loses its
     context. This property is currently only used for the ETM 4.x driver.
 
* Optional properties for ETM/PTMs:
 
   * arm,cp14: must be present if the system accesses ETM/PTM management
     registers via co-processor 14.
 
   * cpu: the cpu phandle this ETM/PTM is affined to. When omitted the
     source is considered to belong to CPU0.
 
* Optional property for TMC:
 
   * arm,buffer-size: size of contiguous buffer space for TMC ETR
     (embedded trace router). This property is obsolete. The buffer size
     can be configured dynamically via buffer_size property in sysfs.
 
   * arm,scatter-gather: boolean. Indicates that the TMC-ETR can safely
     use the SG mode on this system.
 
* Optional property for CATU :
   * interrupts : Exactly one SPI may be listed for reporting the address
     error
 
Example:
 
1. Sinks
   etb@20010000 {
       compatible = "arm,coresight-etb10", "arm,primecell";
       reg = <0 0x20010000 0 0x1000>;
 
       clocks = <&oscclk6a>;
       clock-names = "apb_pclk";
       port {
           etb_in_port: endpoint@0 {
               slave-mode;
               remote-endpoint = <&replicator_out_port0>;
           };
       };
   };
 
   tpiu@20030000 {
       compatible = "arm,coresight-tpiu", "arm,primecell";
       reg = <0 0x20030000 0 0x1000>;
 
       clocks = <&oscclk6a>;
       clock-names = "apb_pclk";
       port {
           tpiu_in_port: endpoint@0 {
               slave-mode;
               remote-endpoint = <&replicator_out_port1>;
           };
       };
   };
 
   etr@20070000 {
       compatible = "arm,coresight-tmc", "arm,primecell";
       reg = <0 0x20070000 0 0x1000>;
 
       clocks = <&oscclk6a>;
       clock-names = "apb_pclk";
       ports {
           #address-cells = <1>;
           #size-cells = <0>;
 
           /* input port */
           port@0 {
               reg =  <0>;
               etr_in_port: endpoint {
                   slave-mode;
                   remote-endpoint = <&replicator2_out_port0>;
               };
           };
 
           /* CATU link represented by output port */
           port@1 {
               reg = <1>;
               etr_out_port: endpoint {
                   remote-endpoint = <&catu_in_port>;
               };
           };
       };
   };
 
2. Links
   replicator {
       /* non-configurable replicators don't show up on the
        * AMBA bus.  As such no need to add "arm,primecell".
        */
       compatible = "arm,coresight-replicator";
 
       ports {
           #address-cells = <1>;
           #size-cells = <0>;
 
           /* replicator output ports */
           port@0 {
               reg = <0>;
               replicator_out_port0: endpoint {
                   remote-endpoint = <&etb_in_port>;
               };
           };
 
           port@1 {
               reg = <1>;
               replicator_out_port1: endpoint {
                   remote-endpoint = <&tpiu_in_port>;
               };
           };
 
           /* replicator input port */
           port@2 {
               reg = <0>;
               replicator_in_port0: endpoint {
                   slave-mode;
                   remote-endpoint = <&funnel_out_port0>;
               };
           };
       };
   };
 
   funnel@20040000 {
       compatible = "arm,coresight-funnel", "arm,primecell";
       reg = <0 0x20040000 0 0x1000>;
 
       clocks = <&oscclk6a>;
       clock-names = "apb_pclk";
       ports {
           #address-cells = <1>;
           #size-cells = <0>;
 
           /* funnel output port */
           port@0 {
               reg = <0>;
               funnel_out_port0: endpoint {
                   remote-endpoint =
                           <&replicator_in_port0>;
               };
           };
 
           /* funnel input ports */
           port@1 {
               reg = <0>;
               funnel_in_port0: endpoint {
                   slave-mode;
                   remote-endpoint = <&ptm0_out_port>;
               };
           };
 
           port@2 {
               reg = <1>;
               funnel_in_port1: endpoint {
                   slave-mode;
                   remote-endpoint = <&ptm1_out_port>;
               };
           };
 
           port@3 {
               reg = <2>;
               funnel_in_port2: endpoint {
                   slave-mode;
                   remote-endpoint = <&etm0_out_port>;
               };
           };
 
       };
   };
 
3. Sources
   ptm@2201c000 {
       compatible = "arm,coresight-etm3x", "arm,primecell";
       reg = <0 0x2201c000 0 0x1000>;
 
       cpu = <&cpu0>;
       clocks = <&oscclk6a>;
       clock-names = "apb_pclk";
       port {
           ptm0_out_port: endpoint {
               remote-endpoint = <&funnel_in_port0>;
           };
       };
   };
 
   ptm@2201d000 {
       compatible = "arm,coresight-etm3x", "arm,primecell";
       reg = <0 0x2201d000 0 0x1000>;
 
       cpu = <&cpu1>;
       clocks = <&oscclk6a>;
       clock-names = "apb_pclk";
       port {
           ptm1_out_port: endpoint {
               remote-endpoint = <&funnel_in_port1>;
           };
       };
   };
 
4. STM
   stm@20100000 {
       compatible = "arm,coresight-stm", "arm,primecell";
       reg = <0 0x20100000 0 0x1000>,
             <0 0x28000000 0 0x180000>;
       reg-names = "stm-base", "stm-stimulus-base";
 
       clocks = <&soc_smc50mhz>;
       clock-names = "apb_pclk";
       port {
           stm_out_port: endpoint {
               remote-endpoint = <&main_funnel_in_port2>;
           };
       };
   };
 
5. CATU
 
   catu@207e0000 {
       compatible = "arm,coresight-catu", "arm,primecell";
       reg = <0 0x207e0000 0 0x1000>;
 
       clocks = <&oscclk6a>;
       clock-names = "apb_pclk";
 
       interrupts = <GIC_SPI 4 IRQ_TYPE_LEVEL_HIGH>;
       port {
           catu_in_port: endpoint {
               slave-mode;
               remote-endpoint = <&etr_out_port>;
           };
       };
   };
 
[1]. There is currently two version of STM: STM32 and STM500.  Both
have the same HW interface and as such don't need an explicit binding name.