GNU Linux-libre 6.8.9-gnu
[releases.git] / Documentation / devicetree / bindings / arm / arm,coresight-dynamic-replicator.yaml
1 # SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/arm/arm,coresight-dynamic-replicator.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: Arm Coresight Programmable Trace Bus Replicator
8
9 maintainers:
10   - Mathieu Poirier <mathieu.poirier@linaro.org>
11   - Mike Leach <mike.leach@linaro.org>
12   - Leo Yan <leo.yan@linaro.org>
13   - Suzuki K Poulose <suzuki.poulose@arm.com>
14
15 description: |
16   CoreSight components are compliant with the ARM CoreSight architecture
17   specification and can be connected in various topologies to suit a particular
18   SoCs tracing needs. These trace components can generally be classified as
19   sinks, links and sources. Trace data produced by one or more sources flows
20   through the intermediate links connecting the source to the currently selected
21   sink.
22
23   The Coresight replicator splits a single trace stream into two trace streams
24   for systems that have more than one trace sink component.
25
26 # Need a custom select here or 'arm,primecell' will match on lots of nodes
27 select:
28   properties:
29     compatible:
30       contains:
31         const: arm,coresight-dynamic-replicator
32   required:
33     - compatible
34
35 allOf:
36   - $ref: /schemas/arm/primecell.yaml#
37
38 properties:
39   compatible:
40     items:
41       - const: arm,coresight-dynamic-replicator
42       - const: arm,primecell
43
44   reg:
45     maxItems: 1
46
47   clocks:
48     minItems: 1
49     maxItems: 2
50
51   clock-names:
52     minItems: 1
53     items:
54       - const: apb_pclk
55       - const: atclk
56
57   power-domains:
58     maxItems: 1
59
60   qcom,replicator-loses-context:
61     type: boolean
62     description:
63       Indicates that the replicator will lose register context when AMBA clock
64       is removed which is observed in some replicator designs.
65
66   in-ports:
67     $ref: /schemas/graph.yaml#/properties/ports
68     additionalProperties: false
69
70     properties:
71       port:
72         description: Input connection from CoreSight Trace bus
73         $ref: /schemas/graph.yaml#/properties/port
74
75   out-ports:
76     $ref: /schemas/graph.yaml#/properties/ports
77
78     patternProperties:
79       '^port(@[01])?$':
80         description: Output connections to CoreSight Trace bus
81         $ref: /schemas/graph.yaml#/properties/port
82
83 required:
84   - compatible
85   - reg
86   - clocks
87   - clock-names
88   - in-ports
89   - out-ports
90
91 unevaluatedProperties: false
92
93 examples:
94   - |
95     replicator@20120000 {
96         compatible = "arm,coresight-dynamic-replicator", "arm,primecell";
97         reg = <0x20120000 0x1000>;
98
99         clocks = <&soc_smc50mhz>;
100         clock-names = "apb_pclk";
101
102         out-ports {
103             #address-cells = <1>;
104             #size-cells = <0>;
105
106             /* replicator output ports */
107             port@0 {
108                 reg = <0>;
109                 replicator_out_port0: endpoint {
110                     remote-endpoint = <&tpiu_in_port>;
111                 };
112             };
113
114             port@1 {
115                 reg = <1>;
116                 replicator_out_port1: endpoint {
117                     remote-endpoint = <&etr_in_port>;
118                 };
119             };
120         };
121         in-ports {
122             port {
123                 replicator_in_port0: endpoint {
124                     remote-endpoint = <&csys2_funnel_out_port>;
125                 };
126             };
127         };
128     };
129 ...