diff mbox series

[2/3] iommu: bindings: Add binding documentation for Toshiba Visconti5 IOMMU device

Message ID 20220525013147.2215355-3-nobuhiro1.iwamatsu@toshiba.co.jp
State Changes Requested, archived
Headers show
Series Add Visconti5 IOMMU driver | expand

Checks

Context Check Description
robh/checkpatch warning total: 0 errors, 1 warnings, 62 lines checked
robh/patch-applied success
robh/dtbs-check warning build log
robh/dt-meta-schema success

Commit Message

Nobuhiro Iwamatsu May 25, 2022, 1:31 a.m. UTC
Add documentation for the binding of Toshiba Visconti5 SoC's IOMMU.

Signed-off-by: Nobuhiro Iwamatsu <nobuhiro1.iwamatsu@toshiba.co.jp>
---
 .../bindings/iommu/toshiba,visconti-atu.yaml  | 62 +++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iommu/toshiba,visconti-atu.yaml

Comments

Rob Herring June 2, 2022, 1:43 p.m. UTC | #1
On Wed, May 25, 2022 at 10:31:46AM +0900, Nobuhiro Iwamatsu wrote:
> Add documentation for the binding of Toshiba Visconti5 SoC's IOMMU.
> 
> Signed-off-by: Nobuhiro Iwamatsu <nobuhiro1.iwamatsu@toshiba.co.jp>
> ---
>  .../bindings/iommu/toshiba,visconti-atu.yaml  | 62 +++++++++++++++++++
>  1 file changed, 62 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iommu/toshiba,visconti-atu.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iommu/toshiba,visconti-atu.yaml b/Documentation/devicetree/bindings/iommu/toshiba,visconti-atu.yaml
> new file mode 100644
> index 000000000000..af8d6688fa70
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iommu/toshiba,visconti-atu.yaml
> @@ -0,0 +1,62 @@
> +# SPDX-License-Identifier: GPL-2.0-only

Dual license: GPL-2.0-only OR BSD-2-Clause

> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iommu/toshiba,visconti-atu.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Toshiba ARM SoC Visconti5 IOMMU (ATU)
> +
> +maintainers:
> +  - Nobuhiro Iwamatsu <nobuhiro1.iwamatsu@toshiba.co.jp>
> +
> +description: |+
> +  IOMMU (ATU) driver can bse used for Visconti5's multimedia IPs, such as

Bindings are for hardware, not drivers.

> +  DCNN (Deep Convolutional Neural Network), VIIF(Video Input), VOIF(Video
> +  output), and others.
> +
> +properties:
> +  compatible:
> +    const: toshiba,visconti-atu
> +
> +  reg:
> +    maxItems: 1
> +
> +  "#iommu-cells":
> +    const: 0
> +
> +  toshiba,max-entry:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    description: The size of entry for address
> +    enum:
> +      - 16
> +      - 32
> +
> +  toshiba,reserved-entry:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    description: The reserve number of entry address.
> +    default: 0
> +    minimum: 0
> +    maximum: 32

These 2 need a better description of what they are for.

> +
> +required:
> +  - compatible
> +  - reg
> +  - "#iommu-cells"
> +  - toshiba,max-entry
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    soc {
> +        #address-cells = <2>;
> +        #size-cells = <2>;
> +
> +        atu_affine0: iommu@1400f000 {

Drop unused labels.

> +            compatible = "toshiba,visconti-atu";
> +            reg = <0 0x1400F000 0 0x1000>;
> +            toshiba,max-entry = <16>;
> +            toshiba,reserved-entry = <1>;
> +            #iommu-cells = <0>;
> +        };
> +    };
> -- 
> 2.36.0
> 
> 
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iommu/toshiba,visconti-atu.yaml b/Documentation/devicetree/bindings/iommu/toshiba,visconti-atu.yaml
new file mode 100644
index 000000000000..af8d6688fa70
--- /dev/null
+++ b/Documentation/devicetree/bindings/iommu/toshiba,visconti-atu.yaml
@@ -0,0 +1,62 @@ 
+# SPDX-License-Identifier: GPL-2.0-only
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iommu/toshiba,visconti-atu.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Toshiba ARM SoC Visconti5 IOMMU (ATU)
+
+maintainers:
+  - Nobuhiro Iwamatsu <nobuhiro1.iwamatsu@toshiba.co.jp>
+
+description: |+
+  IOMMU (ATU) driver can bse used for Visconti5's multimedia IPs, such as
+  DCNN (Deep Convolutional Neural Network), VIIF(Video Input), VOIF(Video
+  output), and others.
+
+properties:
+  compatible:
+    const: toshiba,visconti-atu
+
+  reg:
+    maxItems: 1
+
+  "#iommu-cells":
+    const: 0
+
+  toshiba,max-entry:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: The size of entry for address
+    enum:
+      - 16
+      - 32
+
+  toshiba,reserved-entry:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: The reserve number of entry address.
+    default: 0
+    minimum: 0
+    maximum: 32
+
+required:
+  - compatible
+  - reg
+  - "#iommu-cells"
+  - toshiba,max-entry
+
+additionalProperties: false
+
+examples:
+  - |
+    soc {
+        #address-cells = <2>;
+        #size-cells = <2>;
+
+        atu_affine0: iommu@1400f000 {
+            compatible = "toshiba,visconti-atu";
+            reg = <0 0x1400F000 0 0x1000>;
+            toshiba,max-entry = <16>;
+            toshiba,reserved-entry = <1>;
+            #iommu-cells = <0>;
+        };
+    };