Re: [PATCH V3 1/5] dt-bindings: soc: imx: Add binding doc for spba bus

From: Rob Herring
Date: Fri Nov 06 2020 - 11:19:52 EST


On Fri, Nov 06, 2020 at 05:15:39AM -0600, Adam Ford wrote:
> Add binding doc for fsl,spba-bus.
>
> Signed-off-by: Adam Ford <aford173@xxxxxxxxx>
> ---
> V3: New to series

Please implement my review comments from the last version you sent.

>
> diff --git a/Documentation/devicetree/bindings/bus/fsl,spba-bus.yaml b/Documentation/devicetree/bindings/bus/fsl,spba-bus.yaml
> new file mode 100644
> index 000000000000..0a2add841145
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/bus/fsl,spba-bus.yaml
> @@ -0,0 +1,56 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/bus/simple-pm-bus.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Shared Peripherals Bus Interface
> +
> +maintainers:
> + - Shawn Guo <shawnguo@xxxxxxxxxx>
> +
> +description: |
> + A simple bus enabling access to shared peripherals.
> +
> + The "spba-bus" follows the "simple-bus" set of properties, as
> + specified in the Devicetree Specification. It is an extension of
> + "simple-bus" because the SDMA controller uses this compatible flag to
> + determine which peripherals are available to it and the range over which
> + the SDMA can access. There are no special clocks for the bus, because
> + the SDMA controller itself has its interrupt, and clock assignments.
> +
> +properties:
> + $nodename:
> + pattern: "^bus(@[0-9a-f]+)?$"
> +
> + compatible:
> + contains:
> + const: fsl,spba-bus
> + description:
> + Shall contain "fsl,spba-bus" in addition to "simple-bus"
> + compatible strings.
> +
> + '#address-cells':
> + enum: [ 1, 2 ]
> +
> + '#size-cells':
> + enum: [ 1, 2 ]
> +
> + ranges: true
> +
> +required:
> + - compatible
> + - '#address-cells'
> + - '#size-cells'
> + - ranges
> +
> +additionalProperties: true
> +
> +examples:
> + - |
> + bus {
> + compatible = "fsl,spba-bus", "simple-bus";
> + #address-cells = <1>;
> + #size-cells = <1>;
> + ranges;
> + };
> --
> 2.25.1
>