| Message ID | 20211202143828.3335-1-aford173@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [V6,1/2] dt-bindings: soc: imx: Add binding doc for spba bus | expand |
On Thu, Dec 2, 2021 at 8:38 AM Adam Ford <aford173@gmail.com> 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 <aford173@gmail.com> > --- > 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 <shawnguo@kernel.org> > + > +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 <aford173@gmail.com> > --- > 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 <robh@kernel.org>
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 <shawnguo@kernel.org> + +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; + };
Add binding doc for fsl,spba-bus. Signed-off-by: Adam Ford <aford173@gmail.com> --- 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