[RFC PATCH 1/6] dt-bindings: riscv: Add YAML documentation for PMU

From: Zong Li
Date: Sun Jun 28 2020 - 23:19:35 EST


Add device tree bindings for performance monitor unit. And it passes the
dt_binding_check verification.

Signed-off-by: Zong Li <zong.li@xxxxxxxxxx>
---
.../devicetree/bindings/riscv/pmu.yaml | 59 +++++++++++++++++++
1 file changed, 59 insertions(+)
create mode 100644 Documentation/devicetree/bindings/riscv/pmu.yaml

diff --git a/Documentation/devicetree/bindings/riscv/pmu.yaml b/Documentation/devicetree/bindings/riscv/pmu.yaml
new file mode 100644
index 000000000000..f55ccbc6c685
--- /dev/null
+++ b/Documentation/devicetree/bindings/riscv/pmu.yaml
@@ -0,0 +1,59 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/riscv/pmu.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: RISC-V Performance Monitor Units
+
+maintainers:
+ - Zong Li <zong.li@xxxxxxxxxx>
+ - Paul Walmsley <paul.walmsley@xxxxxxxxxx>
+ - Palmer Dabbelt <palmer@xxxxxxxxxxx>
+
+properties:
+ compatible:
+ items:
+ - const: riscv,pmu
+
+ riscv,width-base-cntr:
+ description: The width of cycle and instret CSRs.
+ $ref: /schemas/types.yaml#/definitions/uint32
+
+ riscv,width-event-cntr:
+ description: The width of hpmcounter CSRs.
+ $ref: /schemas/types.yaml#/definitions/uint32
+
+ riscv,n-event-cntr:
+ description: The number of hpmcounter CSRs.
+ $ref: /schemas/types.yaml#/definitions/uint32
+
+ riscv,hw-event-map:
+ description: The mapping of generic hardware events. Default is no mapping.
+ $ref: /schemas/types.yaml#/definitions/uint32-array
+
+ riscv,hw-cache-event-map:
+ description: The mapping of generic hardware cache events.
+ Default is no mapping.
+ $ref: /schemas/types.yaml#/definitions/uint32-array
+
+required:
+ - compatible
+ - riscv,width-base-cntr
+ - riscv,width-event-cntr
+ - riscv,n-event-cntr
+
+additionalProperties: false
+
+examples:
+ - |
+ pmu {
+ compatible = "riscv,pmu";
+ riscv,width-base-cntr = <64>;
+ riscv,width-event-cntr = <40>;
+ riscv,n-event-cntr = <2>;
+ riscv,hw-event-map = <0x0 0x0 0x1 0x1 0x3 0x0202 0x4 0x4000>;
+ riscv,hw-cache-event-map = <0x010201 0x0102 0x010204 0x0802>;
+ };
+
+...
--
2.27.0