diff mbox series

[v2,4/4] dt-bindings: bus: add documentation for Aspeed AHBC

Message ID 20221004032841.3714928-5-neal_liu@aspeedtech.com (mailing list archive)
State New, archived
Headers show
Series Add Aspeed ACRY driver for hardware acceleration | expand

Commit Message

Neal Liu Oct. 4, 2022, 3:28 a.m. UTC
Add device tree binding documentation for the Aspeed
Advanced High-Performance Bus (AHB) Controller.

Signed-off-by: Neal Liu <neal_liu@aspeedtech.com>
---
 .../bindings/bus/aspeed,ast2600-ahbc.yaml     | 46 +++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/bus/aspeed,ast2600-ahbc.yaml

Comments

Rob Herring (Arm) Oct. 5, 2022, 1:18 p.m. UTC | #1
On Tue, Oct 04, 2022 at 11:28:41AM +0800, Neal Liu wrote:
> Add device tree binding documentation for the Aspeed
> Advanced High-Performance Bus (AHB) Controller.
> 
> Signed-off-by: Neal Liu <neal_liu@aspeedtech.com>
> ---
>  .../bindings/bus/aspeed,ast2600-ahbc.yaml     | 46 +++++++++++++++++++
>  1 file changed, 46 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/bus/aspeed,ast2600-ahbc.yaml
> 
> diff --git a/Documentation/devicetree/bindings/bus/aspeed,ast2600-ahbc.yaml b/Documentation/devicetree/bindings/bus/aspeed,ast2600-ahbc.yaml
> new file mode 100644
> index 000000000000..c42a350d30a1
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/bus/aspeed,ast2600-ahbc.yaml
> @@ -0,0 +1,46 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/bus/aspeed,ast2600-ahbc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: ASPEED Advanced High-Performance Bus Controller (AHBC) Device Tree Bindings
> +
> +maintainers:
> +  - Neal Liu <neal_liu@aspeedtech.com>
> +  - Chia-Wei Wang <chiawei_wang@aspeedtech.com>
> +
> +description: |
> +  Advanced High-performance Bus Controller (AHBC) supports plenty of mechanisms
> +  including a priority arbiter, an address decoder and a data multiplexer
> +  to control the overall operations of Advanced High-performance
> +  Bus (AHB). AHB is the main system bus for ARM CPU to communicate with the
> +  related peripherals.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - aspeed,ast2600-ahbc
> +
> +  reg:
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    bus {
> +        compatible = "simple-bus";
> +        #address-cells = <1>;
> +        #size-cells = <1>;
> +        ranges;
> +
> +        ahbc: bus@1e600000 {
> +            compatible = "aspeed,ast2600-ahbc";
> +            reg = <0x1e600000 0x100>;

Devices on the AHB bus should be child nodes here. Unless this is just 
for device master interface to memory, but that's not what the 
description says.

Rob
Neal Liu Oct. 6, 2022, 5:45 a.m. UTC | #2
> > Add device tree binding documentation for the Aspeed Advanced
> > High-Performance Bus (AHB) Controller.
> >
> > Signed-off-by: Neal Liu <neal_liu@aspeedtech.com>
> > ---
> >  .../bindings/bus/aspeed,ast2600-ahbc.yaml     | 46
> +++++++++++++++++++
> >  1 file changed, 46 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/bus/aspeed,ast2600-ahbc.yaml
> >
> > diff --git
> > a/Documentation/devicetree/bindings/bus/aspeed,ast2600-ahbc.yaml
> > b/Documentation/devicetree/bindings/bus/aspeed,ast2600-ahbc.yaml
> > new file mode 100644
> > index 000000000000..c42a350d30a1
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/bus/aspeed,ast2600-ahbc.yaml
> > @@ -0,0 +1,46 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/bus/aspeed,ast2600-ahbc.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: ASPEED Advanced High-Performance Bus Controller (AHBC) Device
> > +Tree Bindings
> > +
> > +maintainers:
> > +  - Neal Liu <neal_liu@aspeedtech.com>
> > +  - Chia-Wei Wang <chiawei_wang@aspeedtech.com>
> > +
> > +description: |
> > +  Advanced High-performance Bus Controller (AHBC) supports plenty of
> > +mechanisms
> > +  including a priority arbiter, an address decoder and a data
> > +multiplexer
> > +  to control the overall operations of Advanced High-performance
> > +  Bus (AHB). AHB is the main system bus for ARM CPU to communicate
> > +with the
> > +  related peripherals.
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - aspeed,ast2600-ahbc
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    bus {
> > +        compatible = "simple-bus";
> > +        #address-cells = <1>;
> > +        #size-cells = <1>;
> > +        ranges;
> > +
> > +        ahbc: bus@1e600000 {
> > +            compatible = "aspeed,ast2600-ahbc";
> > +            reg = <0x1e600000 0x100>;
> 
> Devices on the AHB bus should be child nodes here. Unless this is just for
> device master interface to memory, but that's not what the description says.

Sorry, I don't understand. "ahbc" device is already a child node here under AHB bus.
"ahbc" is a controller to control the overall operations of AHB, which is described in the description.
Could you explain more details?
Thanks.
Neal Liu Oct. 28, 2022, 7:30 a.m. UTC | #3
> > > Add device tree binding documentation for the Aspeed Advanced
> > > High-Performance Bus (AHB) Controller.
> > >
> > > Signed-off-by: Neal Liu <neal_liu@aspeedtech.com>
> > > ---
> > >  .../bindings/bus/aspeed,ast2600-ahbc.yaml     | 46
> > +++++++++++++++++++
> > >  1 file changed, 46 insertions(+)
> > >  create mode 100644
> > > Documentation/devicetree/bindings/bus/aspeed,ast2600-ahbc.yaml
> > >
> > > diff --git
> > > a/Documentation/devicetree/bindings/bus/aspeed,ast2600-ahbc.yaml
> > > b/Documentation/devicetree/bindings/bus/aspeed,ast2600-ahbc.yaml
> > > new file mode 100644
> > > index 000000000000..c42a350d30a1
> > > --- /dev/null
> > > +++
> b/Documentation/devicetree/bindings/bus/aspeed,ast2600-ahbc.yaml
> > > @@ -0,0 +1,46 @@
> > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
> > > +---
> > > +$id: http://devicetree.org/schemas/bus/aspeed,ast2600-ahbc.yaml#
> > > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > > +
> > > +title: ASPEED Advanced High-Performance Bus Controller (AHBC)
> > > +Device Tree Bindings
> > > +
> > > +maintainers:
> > > +  - Neal Liu <neal_liu@aspeedtech.com>
> > > +  - Chia-Wei Wang <chiawei_wang@aspeedtech.com>
> > > +
> > > +description: |
> > > +  Advanced High-performance Bus Controller (AHBC) supports plenty
> > > +of mechanisms
> > > +  including a priority arbiter, an address decoder and a data
> > > +multiplexer
> > > +  to control the overall operations of Advanced High-performance
> > > +  Bus (AHB). AHB is the main system bus for ARM CPU to communicate
> > > +with the
> > > +  related peripherals.
> > > +
> > > +properties:
> > > +  compatible:
> > > +    enum:
> > > +      - aspeed,ast2600-ahbc
> > > +
> > > +  reg:
> > > +    maxItems: 1
> > > +
> > > +required:
> > > +  - compatible
> > > +  - reg
> > > +
> > > +additionalProperties: false
> > > +
> > > +examples:
> > > +  - |
> > > +    bus {
> > > +        compatible = "simple-bus";
> > > +        #address-cells = <1>;
> > > +        #size-cells = <1>;
> > > +        ranges;
> > > +
> > > +        ahbc: bus@1e600000 {
> > > +            compatible = "aspeed,ast2600-ahbc";
> > > +            reg = <0x1e600000 0x100>;
> >
> > Devices on the AHB bus should be child nodes here. Unless this is just
> > for device master interface to memory, but that's not what the description
> says.
> 
> Sorry, I don't understand. "ahbc" device is already a child node here under
> AHB bus.
> "ahbc" is a controller to control the overall operations of AHB, which is
> described in the description.
> Could you explain more details?
> Thanks.

Hi Rob,

This controller is a device master interface to memory, not the bus itself. Maybe the description confuse it, I'll try to revise it.
Thanks.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/bus/aspeed,ast2600-ahbc.yaml b/Documentation/devicetree/bindings/bus/aspeed,ast2600-ahbc.yaml
new file mode 100644
index 000000000000..c42a350d30a1
--- /dev/null
+++ b/Documentation/devicetree/bindings/bus/aspeed,ast2600-ahbc.yaml
@@ -0,0 +1,46 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/bus/aspeed,ast2600-ahbc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ASPEED Advanced High-Performance Bus Controller (AHBC) Device Tree Bindings
+
+maintainers:
+  - Neal Liu <neal_liu@aspeedtech.com>
+  - Chia-Wei Wang <chiawei_wang@aspeedtech.com>
+
+description: |
+  Advanced High-performance Bus Controller (AHBC) supports plenty of mechanisms
+  including a priority arbiter, an address decoder and a data multiplexer
+  to control the overall operations of Advanced High-performance
+  Bus (AHB). AHB is the main system bus for ARM CPU to communicate with the
+  related peripherals.
+
+properties:
+  compatible:
+    enum:
+      - aspeed,ast2600-ahbc
+
+  reg:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    bus {
+        compatible = "simple-bus";
+        #address-cells = <1>;
+        #size-cells = <1>;
+        ranges;
+
+        ahbc: bus@1e600000 {
+            compatible = "aspeed,ast2600-ahbc";
+            reg = <0x1e600000 0x100>;
+        };
+    };