Add binding doc for fsl,spba-bus.
Signed-off-by: Adam Ford <[email protected]>
---
V6: Rebase on 5.16-rc and rename spba@xxxx to spba-bus@xxxx since
most dsti files use that naming convention.
V5: Rebase on 5.10-rc2 to be able to check yaml
Add Reg entry
V4: Remove an accidental makefile change
Move type:object under additional properties
V3: Rebase sample from aips-bus example
Split off from series adding i.MX8M Nano functions to reduce noise
V2: Attempted to update yaml from feedback
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..d42dbb0bbc2e
--- /dev/null
+++ b/Documentation/devicetree/bindings/bus/fsl,spba-bus.yaml
@@ -0,0 +1,68 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/bus/fsl,spba-bus.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Shared Peripherals Bus Interface
+
+maintainers:
+ - Shawn Guo <[email protected]>
+
+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.
+
+select:
+ properties:
+ compatible:
+ contains:
+ const: fsl,spba-bus
+ required:
+ - compatible
+
+properties:
+ $nodename:
+ pattern: "^spba-bus(@[0-9a-f]+)?$"
+
+ compatible:
+ items:
+ - const: fsl,spba-bus
+ - const: simple-bus
+
+ '#address-cells':
+ enum: [ 1, 2 ]
+
+ '#size-cells':
+ enum: [ 1, 2 ]
+
+ reg:
+ maxItems: 1
+
+ ranges: true
+
+required:
+ - compatible
+ - '#address-cells'
+ - '#size-cells'
+ - reg
+ - ranges
+
+additionalProperties:
+ type: object
+
+examples:
+ - |
+ spba-bus@30000000 {
+ compatible = "fsl,spba-bus", "simple-bus";
+ #address-cells = <1>;
+ #size-cells = <1>;
+ reg = <0x30000000 0x100000>;
+ ranges;
+ };
--
2.32.0
With the updated dt-bindings for the spba-bus, rename spba@xxxx
to spba-bus@xxxx. There are no functional changes.
Signed-off-by: Adam Ford <[email protected]>
---
V6: New to series to address warnings generated by dtb checks.
diff --git a/arch/arm/boot/dts/imx25.dtsi b/arch/arm/boot/dts/imx25.dtsi
index fdcca82c9986..83278b390c70 100644
--- a/arch/arm/boot/dts/imx25.dtsi
+++ b/arch/arm/boot/dts/imx25.dtsi
@@ -200,7 +200,7 @@ audmux: audmux@43fb0000 {
};
};
- spba@50000000 {
+ spba-bus@50000000 {
compatible = "fsl,spba-bus", "simple-bus";
#address-cells = <1>;
#size-cells = <1>;
diff --git a/arch/arm/boot/dts/imx31.dtsi b/arch/arm/boot/dts/imx31.dtsi
index 948d2a543f8d..2adb923c0b27 100644
--- a/arch/arm/boot/dts/imx31.dtsi
+++ b/arch/arm/boot/dts/imx31.dtsi
@@ -166,7 +166,7 @@ uart5: serial@43fb4000 {
};
};
- spba@50000000 {
+ spba-bus@50000000 {
compatible = "fsl,spba-bus", "simple-bus";
#address-cells = <1>;
#size-cells = <1>;
diff --git a/arch/arm/boot/dts/imx50.dtsi b/arch/arm/boot/dts/imx50.dtsi
index a969f335b240..a31e3694fa2b 100644
--- a/arch/arm/boot/dts/imx50.dtsi
+++ b/arch/arm/boot/dts/imx50.dtsi
@@ -108,7 +108,7 @@ bus@50000000 { /* AIPS1 */
reg = <0x50000000 0x10000000>;
ranges;
- spba@50000000 {
+ spba-bus@50000000 {
compatible = "fsl,spba-bus", "simple-bus";
#address-cells = <1>;
#size-cells = <1>;
diff --git a/arch/arm/boot/dts/imx51.dtsi b/arch/arm/boot/dts/imx51.dtsi
index 01cfcbe5928e..ba496fdfe8cb 100644
--- a/arch/arm/boot/dts/imx51.dtsi
+++ b/arch/arm/boot/dts/imx51.dtsi
@@ -178,7 +178,7 @@ bus@70000000 { /* AIPS1 */
reg = <0x70000000 0x10000000>;
ranges;
- spba@70000000 {
+ spba-bus@70000000 {
compatible = "fsl,spba-bus", "simple-bus";
#address-cells = <1>;
#size-cells = <1>;
diff --git a/arch/arm/boot/dts/imx53.dtsi b/arch/arm/boot/dts/imx53.dtsi
index 2cf3909cca2f..6082cd347124 100644
--- a/arch/arm/boot/dts/imx53.dtsi
+++ b/arch/arm/boot/dts/imx53.dtsi
@@ -229,7 +229,7 @@ bus@50000000 { /* AIPS1 */
reg = <0x50000000 0x10000000>;
ranges;
- spba@50000000 {
+ spba-bus@50000000 {
compatible = "fsl,spba-bus", "simple-bus";
#address-cells = <1>;
#size-cells = <1>;
diff --git a/arch/arm/boot/dts/imx6qdl.dtsi b/arch/arm/boot/dts/imx6qdl.dtsi
index f5de5def876d..6dc1b970bcad 100644
--- a/arch/arm/boot/dts/imx6qdl.dtsi
+++ b/arch/arm/boot/dts/imx6qdl.dtsi
@@ -481,7 +481,7 @@ asrc: asrc@2034000 {
status = "okay";
};
- spba@203c000 {
+ spba-bus@203c000 {
reg = <0x0203c000 0x4000>;
};
};
--
2.32.0
On Thu, Dec 2, 2021 at 8:38 AM Adam Ford <[email protected]> wrote:
>
> Add binding doc for fsl,spba-bus.
>
Rob / Shawn,
Any feedback on this series? I am not very good with YAML, but my
intent was to name the bus 'spba-bus' and the second patch in the
series was designed to go through all the SoC device trees and update
them to reflect this name to remove a bunch of the splat generated
when building various imx boards.
thanks
adam
> Signed-off-by: Adam Ford <[email protected]>
> ---
> V6: Rebase on 5.16-rc and rename spba@xxxx to spba-bus@xxxx since
> most dsti files use that naming convention.
>
> V5: Rebase on 5.10-rc2 to be able to check yaml
> Add Reg entry
>
> V4: Remove an accidental makefile change
> Move type:object under additional properties
>
> V3: Rebase sample from aips-bus example
> Split off from series adding i.MX8M Nano functions to reduce noise
>
> V2: Attempted to update yaml from feedback
>
> 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..d42dbb0bbc2e
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/bus/fsl,spba-bus.yaml
> @@ -0,0 +1,68 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/bus/fsl,spba-bus.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Shared Peripherals Bus Interface
> +
> +maintainers:
> + - Shawn Guo <[email protected]>
> +
> +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.
> +
> +select:
> + properties:
> + compatible:
> + contains:
> + const: fsl,spba-bus
> + required:
> + - compatible
> +
> +properties:
> + $nodename:
> + pattern: "^spba-bus(@[0-9a-f]+)?$"
> +
> + compatible:
> + items:
> + - const: fsl,spba-bus
> + - const: simple-bus
> +
> + '#address-cells':
> + enum: [ 1, 2 ]
> +
> + '#size-cells':
> + enum: [ 1, 2 ]
> +
> + reg:
> + maxItems: 1
> +
> + ranges: true
> +
> +required:
> + - compatible
> + - '#address-cells'
> + - '#size-cells'
> + - reg
> + - ranges
> +
> +additionalProperties:
> + type: object
> +
> +examples:
> + - |
> + spba-bus@30000000 {
> + compatible = "fsl,spba-bus", "simple-bus";
> + #address-cells = <1>;
> + #size-cells = <1>;
> + reg = <0x30000000 0x100000>;
> + ranges;
> + };
> --
> 2.32.0
>
On Thu, 02 Dec 2021 08:38:26 -0600, Adam Ford wrote:
> Add binding doc for fsl,spba-bus.
>
> Signed-off-by: Adam Ford <[email protected]>
> ---
> V6: Rebase on 5.16-rc and rename spba@xxxx to spba-bus@xxxx since
> most dsti files use that naming convention.
>
> V5: Rebase on 5.10-rc2 to be able to check yaml
> Add Reg entry
>
> V4: Remove an accidental makefile change
> Move type:object under additional properties
>
> V3: Rebase sample from aips-bus example
> Split off from series adding i.MX8M Nano functions to reduce noise
>
> V2: Attempted to update yaml from feedback
>
Reviewed-by: Rob Herring <[email protected]>
On Thu, Dec 02, 2021 at 08:38:27AM -0600, Adam Ford wrote:
> With the updated dt-bindings for the spba-bus, rename spba@xxxx
> to spba-bus@xxxx. There are no functional changes.
>
> Signed-off-by: Adam Ford <[email protected]>
I updated the subject prefix like below.
ARM: dts: imx: ...
Applied both, thanks!
Shawn