On Fri, Jun 12, 2020 at 04:18:29PM +0200, Thierry Reding wrote: > From: Thierry Reding <treding@xxxxxxxxxx> > > Convert the Tegra186 BPMP bindings from the free-form text format to a > json-schema and fix things up so that existing device trees properly > validate. > > Signed-off-by: Thierry Reding <treding@xxxxxxxxxx> > --- > .../firmware/nvidia,tegra186-bpmp.txt | 107 ----------- > .../firmware/nvidia,tegra186-bpmp.yaml | 180 ++++++++++++++++++ > 2 files changed, 180 insertions(+), 107 deletions(-) > delete mode 100644 Documentation/devicetree/bindings/firmware/nvidia,tegra186-bpmp.txt > create mode 100644 Documentation/devicetree/bindings/firmware/nvidia,tegra186-bpmp.yaml [...] > diff --git a/Documentation/devicetree/bindings/firmware/nvidia,tegra186-bpmp.yaml b/Documentation/devicetree/bindings/firmware/nvidia,tegra186-bpmp.yaml > new file mode 100644 > index 000000000000..0e4d51ba7aa1 > --- /dev/null > +++ b/Documentation/devicetree/bindings/firmware/nvidia,tegra186-bpmp.yaml > @@ -0,0 +1,180 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/firmware/nvidia,tegra186-bpmp.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: NVIDIA Tegra186 (and later) Boot and Power Management Processor (BPMP) > + > +maintainers: > + - Thierry Reding <thierry.reding@xxxxxxxxx> > + - Jon Hunter <jonathanh@xxxxxxxxxx> > + > +description: | > + The BPMP is a specific processor in Tegra chip, which is designed for > + booting process handling and offloading the power management, clock > + management, and reset control tasks from the CPU. The binding document > + defines the resources that would be used by the BPMP firmware driver, > + which can create the interprocessor communication (IPC) between the > + CPU and BPMP. > + > + The BPMP implements some services which must be represented by separate > + nodes. For example, it can provide access to certain I2C controllers, and > + the I2C bindings represent each I2C controller as a device tree node. Such > + nodes should be nested directly inside the main BPMP node. > + > + Software can determine whether a child node of the BPMP node represents a > + device by checking for a compatible property. Any node with a compatible > + property represents a device that can be instantiated. Nodes without a > + compatible property may be used to provide configuration information > + regarding the BPMP itself, although no such configuration nodes are > + currently defined by this binding. > + > + The BPMP firmware defines no single global name-/numbering-space for such > + services. Put another way, the numbering scheme for I2C buses is distinct > + from the numbering scheme for any other service the BPMP may provide (e.g. > + a future hypothetical SPI bus service). As such, child device nodes will > + have no "reg" property, and the BPMP node will have no "#address-cells" or > + "#size-cells" property. > + > +properties: > + compatible: > + items: > + - enum: > + - nvidia,tegra186-bpmp > + > + iommus: > + description: | > + The phandle of the IOMMU and the IOMMU specifier. See ../iommu/iommu.txt > + for details. > + $ref: "/schemas/types.yaml#/definitions/phandle-array" Standard property, don't need a type. Just 'maxItems: 1' if 1 entry or an 'items' list if more than 1. > + > + mboxes: > + description: | > + The phandle of the mailbox controller and the mailbox specifier. See > + ../mailbox/mailbox.txt and ../mailbox/nvidia,tegra186-hsp.txt for > + details. > + $ref: "/schemas/types.yaml#/definitions/phandle-array" Same here. > + > + shmem: > + description: | > + List of phandles for the TX and RX shared memory areas used for > + interprocess communication between the CPU and the BPMP. > + > + The shared memory area for the IPC TX and RX between CPU and BPMP are > + predefined and work on top of sysram, which is an SRAM inside the chip. > + > + See ../sram/sram.yaml for the bindings. > + $ref: "/schemas/types.yaml#/definitions/phandle-array" > + > + "#clock-cells": > + const: 1 > + > + "#power-domain-cells": > + const: 1 > + > + "#reset-cells": > + const: 1 > + > + i2c: > + type: object > + description: | > + The BPMP can provide serialized access to I2C controllers that have > + been assigned to it. Should have a $ref to i2c-controller.yaml > + > + properties: > + compatible: > + items: > + - enum: > + - nvidia,tegra186-bpmp-i2c > + > + "#address-cells": > + const: 1 > + > + "#size-cells": > + const: 0 > + > + nvidia,bpmp-bus-id: > + description: The bus ID of the I2C controller. > + $ref: "/schemas/types.yaml#/definitions/uint32" > + > + required: > + - compatible > + - "#address-cells" > + - "#size-cells" > + - nvidia,bpmp-bus-id > + > + patternProperties: > + "^.*@[0-9a-f]+$": > + type: object > + description: I2C slave > + properties: > + reg: > + maxItems: 1 > + description: I2C address of the slave > + > + required: > + - reg And child node schema can be dropped. > + > + additionalProperties: false > + > + thermal: > + type: object > + description: > + The BPMP provides functionality that exposes system temperature sensors > + and which can be used to trigger a system shutdown if the temperature > + for a given zone exceeds the specified thresholds. > + > + properties: > + compatible: > + items: > + - enum: > + - nvidia,tegra186-bpmp-thermal > + > + "#thermal-sensor-cells": > + description: The ID of the thermal zone. > + const: 1 > + > + required: > + - compatible > + - "#thermal-sensor-cells" > + > + additionalProperties: false > + > +required: > + - compatible > + - mboxes > + - shmem > + - "#clock-cells" > + - "#power-domain-cells" > + - "#reset-cells" > + > +additionalProperties: false > + > +examples: > + - | > + #include <dt-bindings/mailbox/tegra186-hsp.h> > + #include <dt-bindings/memory/tegra186-mc.h> > + > + bpmp { > + compatible = "nvidia,tegra186-bpmp"; > + iommus = <&smmu TEGRA186_SID_BPMP>; > + mboxes = <&hsp_top0 TEGRA_HSP_MBOX_TYPE_DB TEGRA_HSP_DB_MASTER_BPMP>; > + shmem = <&cpu_bpmp_tx &cpu_bpmp_rx>; > + #clock-cells = <1>; > + #power-domain-cells = <1>; > + #reset-cells = <1>; > + > + i2c { > + compatible = "nvidia,tegra186-bpmp-i2c"; > + nvidia,bpmp-bus-id = <5>; > + #address-cells = <1>; > + #size-cells = <0>; > + status = "disabled"; Don't show status in examples. > + }; > + > + thermal { > + compatible = "nvidia,tegra186-bpmp-thermal"; > + #thermal-sensor-cells = <1>; > + }; > + }; > -- > 2.24.1 >
