xref: /freebsd/sys/contrib/device-tree/Bindings/arm/arm,embedded-trace-extension.yaml (revision b97ee269eae3cbaf35c18f51a459aea581c2a7dc) 
1# SPDX-License-Identifier: GPL-2.0-only or BSD-2-Clause
2# Copyright 2021, Arm Ltd
3%YAML 1.2
4---
5$id: "http://devicetree.org/schemas/arm/arm,embedded-trace-extension.yaml#"
6$schema: "http://devicetree.org/meta-schemas/core.yaml#"
7
8title: ARM Embedded Trace Extensions
9
10maintainers:
11  - Suzuki K Poulose <suzuki.poulose@arm.com>
12  - Mathieu Poirier <mathieu.poirier@linaro.org>
13
14description: |
15  Arm Embedded Trace Extension(ETE) is a per CPU trace component that
16  allows tracing the CPU execution. It overlaps with the CoreSight ETMv4
17  architecture and has extended support for future architecture changes.
18  The trace generated by the ETE could be stored via legacy CoreSight
19  components (e.g, TMC-ETR) or other means (e.g, using a per CPU buffer
20  Arm Trace Buffer Extension (TRBE)). Since the ETE can be connected to
21  legacy CoreSight components, a node must be listed per instance, along
22  with any optional connection graph as per the coresight bindings.
23
24properties:
25  $nodename:
26    pattern: "^ete([0-9a-f]+)$"
27  compatible:
28    items:
29      - const: arm,embedded-trace-extension
30
31  cpu:
32    description: |
33      Handle to the cpu this ETE is bound to.
34    $ref: /schemas/types.yaml#/definitions/phandle
35
36  out-ports:
37    description: |
38      Output connections from the ETE to legacy CoreSight trace bus.
39    $ref: /schemas/graph.yaml#/properties/ports
40    properties:
41      port:
42        description: Output connection from the ETE to legacy CoreSight Trace bus.
43        $ref: /schemas/graph.yaml#/properties/port
44
45required:
46  - compatible
47  - cpu
48
49additionalProperties: false
50
51examples:
52
53# An ETE node without legacy CoreSight connections
54  - |
55    ete0 {
56      compatible = "arm,embedded-trace-extension";
57      cpu = <&cpu_0>;
58    };
59# An ETE node with legacy CoreSight connections
60  - |
61   ete1 {
62      compatible = "arm,embedded-trace-extension";
63      cpu = <&cpu_1>;
64
65      out-ports {        /* legacy coresight connection */
66         port {
67             ete1_out_port: endpoint {
68                remote-endpoint = <&funnel_in_port0>;
69             };
70         };
71      };
72   };
73
74...
75