^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) # SPDX-License-Identifier: GPL-2.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) %YAML 1.2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) ---
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) $id: http://devicetree.org/schemas/bus/simple-pm-bus.yaml#
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) $schema: http://devicetree.org/meta-schemas/core.yaml#
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) title: Simple Power-Managed Bus
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) maintainers:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) - Geert Uytterhoeven <geert+renesas@glider.be>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) description: |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) A Simple Power-Managed Bus is a transparent bus that doesn't need a real
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) driver, as it's typically initialized by the boot loader.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) However, its bus controller is part of a PM domain, or under the control
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) of a functional clock. Hence, the bus controller's PM domain and/or
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) clock must be enabled for child devices connected to the bus (either
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) on-SoC or externally) to function.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) While "simple-pm-bus" follows the "simple-bus" set of properties, as
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) specified in the Devicetree Specification, it is not an extension of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) "simple-bus".
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) properties:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) $nodename:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) pattern: "^bus(@[0-9a-f]+)?$"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) compatible:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) contains:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) const: simple-pm-bus
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) Shall contain "simple-pm-bus" in addition to a optional bus-specific
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) compatible strings defined in individual pm-bus bindings.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) '#address-cells':
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) enum: [ 1, 2 ]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) '#size-cells':
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) enum: [ 1, 2 ]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) ranges: true
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) clocks: true
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) # Functional clocks
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) # Required if power-domains is absent, optional otherwise
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) power-domains:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) # Required if clocks is absent, optional otherwise
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) minItems: 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) required:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) - compatible
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) - '#address-cells'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) - '#size-cells'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) - ranges
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) anyOf:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) - required:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) - clocks
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) - required:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) - power-domains
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) additionalProperties: true
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) examples:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) - |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) #include <dt-bindings/clock/qcom,gcc-msm8996.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) #include <dt-bindings/interrupt-controller/irq.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) bus {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) power-domains = <&gcc AGGRE0_NOC_GDSC>;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) compatible = "simple-pm-bus";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) #address-cells = <1>;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) #size-cells = <1>;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) ranges;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) };