diff mbox series

[V3,12/14] dts: bindings: Document device tree bindings for Arm TRBE

Message ID 1611737738-1493-13-git-send-email-anshuman.khandual@arm.com
State New
Headers show
Series None | expand

Commit Message

Anshuman Khandual Jan. 27, 2021, 8:55 a.m. UTC 
From: Suzuki K Poulose <suzuki.poulose@arm.com>


Document the device tree bindings for Trace Buffer Extension (TRBE).

Cc: Anshuman Khandual <anshuman.khandual@arm.com>
Cc: Mathieu Poirier <mathieu.poirier@linaro.org>
Cc: Rob Herring <robh@kernel.org>
Cc: devicetree@vger.kernel.org
Signed-off-by: Suzuki K Poulose <suzuki.poulose@arm.com>

Signed-off-by: Anshuman Khandual <anshuman.khandual@arm.com>

---
Changes in V3:

- Added missing description for the TRBE hardware
- Fixed all DT yaml semantics problems

 Documentation/devicetree/bindings/arm/trbe.yaml | 49 +++++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/arm/trbe.yaml

-- 
2.7.4

Comments

Rob Herring Feb. 9, 2021, 7:04 p.m. UTC | #1 
On Wed, 27 Jan 2021 14:25:36 +0530, Anshuman Khandual wrote:
> From: Suzuki K Poulose <suzuki.poulose@arm.com>

> 

> Document the device tree bindings for Trace Buffer Extension (TRBE).

> 

> Cc: Anshuman Khandual <anshuman.khandual@arm.com>

> Cc: Mathieu Poirier <mathieu.poirier@linaro.org>

> Cc: Rob Herring <robh@kernel.org>

> Cc: devicetree@vger.kernel.org

> Signed-off-by: Suzuki K Poulose <suzuki.poulose@arm.com>

> Signed-off-by: Anshuman Khandual <anshuman.khandual@arm.com>

> ---

> Changes in V3:

> 

> - Added missing description for the TRBE hardware

> - Fixed all DT yaml semantics problems

> 

>  Documentation/devicetree/bindings/arm/trbe.yaml | 49 +++++++++++++++++++++++++

>  1 file changed, 49 insertions(+)

>  create mode 100644 Documentation/devicetree/bindings/arm/trbe.yaml

> 


Reviewed-by: Rob Herring <robh@kernel.org>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/arm/trbe.yaml b/Documentation/devicetree/bindings/arm/trbe.yaml
new file mode 100644
index 0000000..4402d7b
--- /dev/null
+++ b/Documentation/devicetree/bindings/arm/trbe.yaml
@@ -0,0 +1,49 @@ 
+# SPDX-License-Identifier: GPL-2.0-only or BSD-2-Clause
+# Copyright 2021, Arm Ltd
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/arm/trbe.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: ARM Trace Buffer Extensions
+
+maintainers:
+  - Anshuman Khandual <anshuman.khandual@arm.com>
+
+description: |
+  Arm Trace Buffer Extension (TRBE) is a per CPU component
+  for storing trace generated on the CPU to memory. It is
+  accessed via CPU system registers. The software can verify
+  if it is permitted to use the component by checking the
+  TRBIDR register.
+
+properties:
+  $nodename:
+    const: "trbe"
+  compatible:
+    items:
+      - const: arm,trace-buffer-extension
+
+  interrupts:
+    description: |
+       Exactly 1 PPI must be listed. For heterogeneous systems where
+       TRBE is only supported on a subset of the CPUs, please consult
+       the arm,gic-v3 binding for details on describing a PPI partition.
+    maxItems: 1
+
+required:
+  - compatible
+  - interrupts
+
+additionalProperties: false
+
+examples:
+
+  - |
+   #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+   trbe {
+     compatible = "arm,trace-buffer-extension";
+     interrupts = <GIC_PPI 15 IRQ_TYPE_LEVEL_HIGH>;
+   };
+...