diff mbox series

[v5,1/3] dt-bindings: Add YAML bindings for NVDEC

Message ID 20210910104247.1206716-2-mperttunen@nvidia.com
State Superseded
Headers show
Series NVIDIA Tegra NVDEC support | expand

Commit Message

Mikko Perttunen Sept. 10, 2021, 10:42 a.m. UTC
Add YAML device tree bindings for NVDEC, now in a more appropriate
place compared to the old textual Host1x bindings.

Signed-off-by: Mikko Perttunen <mperttunen@nvidia.com>
---
v5:
* Changed from nvidia,instance to nvidia,host1x-class optional
  property.
* Added dma-coherent
v4:
* Fix incorrect compatibility string in 'if' condition
v3:
* Drop host1x bindings
* Change read2 to read-1 in interconnect names
v2:
* Fix issues pointed out in v1
* Add T194 nvidia,instance property
---
 .../gpu/host1x/nvidia,tegra210-nvdec.yaml     | 104 ++++++++++++++++++
 MAINTAINERS                                   |   1 +
 2 files changed, 105 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/gpu/host1x/nvidia,tegra210-nvdec.yaml

Comments

Rob Herring (Arm) Sept. 10, 2021, 1:08 p.m. UTC | #1
On Fri, 10 Sep 2021 13:42:45 +0300, Mikko Perttunen wrote:
> Add YAML device tree bindings for NVDEC, now in a more appropriate
> place compared to the old textual Host1x bindings.
> 
> Signed-off-by: Mikko Perttunen <mperttunen@nvidia.com>
> ---
> v5:
> * Changed from nvidia,instance to nvidia,host1x-class optional
>   property.
> * Added dma-coherent
> v4:
> * Fix incorrect compatibility string in 'if' condition
> v3:
> * Drop host1x bindings
> * Change read2 to read-1 in interconnect names
> v2:
> * Fix issues pointed out in v1
> * Add T194 nvidia,instance property
> ---
>  .../gpu/host1x/nvidia,tegra210-nvdec.yaml     | 104 ++++++++++++++++++
>  MAINTAINERS                                   |   1 +
>  2 files changed, 105 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/gpu/host1x/nvidia,tegra210-nvdec.yaml
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:
./Documentation/devicetree/bindings/gpu/host1x/nvidia,tegra210-nvdec.yaml:104:1: [warning] too many blank lines (2 > 1) (empty-lines)

dtschema/dtc warnings/errors:

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/patch/1526459

This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit.
Rob Herring (Arm) Sept. 14, 2021, 3:39 p.m. UTC | #2
On Fri, Sep 10, 2021 at 01:42:45PM +0300, Mikko Perttunen wrote:
> Add YAML device tree bindings for NVDEC, now in a more appropriate

> place compared to the old textual Host1x bindings.

> 

> Signed-off-by: Mikko Perttunen <mperttunen@nvidia.com>

> ---

> v5:

> * Changed from nvidia,instance to nvidia,host1x-class optional

>   property.

> * Added dma-coherent

> v4:

> * Fix incorrect compatibility string in 'if' condition

> v3:

> * Drop host1x bindings

> * Change read2 to read-1 in interconnect names

> v2:

> * Fix issues pointed out in v1

> * Add T194 nvidia,instance property

> ---

>  .../gpu/host1x/nvidia,tegra210-nvdec.yaml     | 104 ++++++++++++++++++

>  MAINTAINERS                                   |   1 +

>  2 files changed, 105 insertions(+)

>  create mode 100644 Documentation/devicetree/bindings/gpu/host1x/nvidia,tegra210-nvdec.yaml

> 

> diff --git a/Documentation/devicetree/bindings/gpu/host1x/nvidia,tegra210-nvdec.yaml b/Documentation/devicetree/bindings/gpu/host1x/nvidia,tegra210-nvdec.yaml

> new file mode 100644

> index 000000000000..f1f8d083d736

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/gpu/host1x/nvidia,tegra210-nvdec.yaml

> @@ -0,0 +1,104 @@

> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)

> +%YAML 1.2

> +---

> +$id: "http://devicetree.org/schemas/gpu/host1x/nvidia,tegra210-nvdec.yaml#"

> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"

> +

> +title: Device tree binding for NVIDIA Tegra NVDEC

> +

> +description: |

> +  NVDEC is the hardware video decoder present on NVIDIA Tegra210

> +  and newer chips. It is located on the Host1x bus and typically

> +  programmed through Host1x channels.

> +

> +maintainers:

> +  - Thierry Reding <treding@gmail.com>

> +  - Mikko Perttunen <mperttunen@nvidia.com>

> +

> +properties:

> +  $nodename:

> +    pattern: "^nvdec@[0-9a-f]*$"

> +

> +  compatible:

> +    enum:

> +      - nvidia,tegra210-nvdec

> +      - nvidia,tegra186-nvdec

> +      - nvidia,tegra194-nvdec

> +

> +  reg:

> +    maxItems: 1

> +

> +  clocks:

> +    maxItems: 1

> +

> +  clock-names:

> +    items:

> +      - const: nvdec

> +

> +  resets:

> +    maxItems: 1

> +

> +  reset-names:

> +    items:

> +      - const: nvdec

> +

> +  power-domains:

> +    maxItems: 1

> +

> +  iommus:

> +    maxItems: 1

> +

> +  dma-coherent: true

> +

> +  interconnects:

> +    items:

> +      - description: DMA read memory client

> +      - description: DMA read 2 memory client

> +      - description: DMA write memory client

> +

> +  interconnect-names:

> +    items:

> +      - const: dma-mem

> +      - const: read-1

> +      - const: write

> +

> +  nvidia,host1x-class:

> +    description: Host1x class of the engine. If not specified, defaults to 0xf0.


Define what this is with more than just repeating what is in the 
property name.

> +    $ref: /schemas/types.yaml#/definitions/uint32


default: 0xf0

Is there a range or set of valid values you specify as schema?

Rob
Mikko Perttunen Sept. 16, 2021, 2:44 p.m. UTC | #3
On 9/14/21 6:39 PM, Rob Herring wrote:
> On Fri, Sep 10, 2021 at 01:42:45PM +0300, Mikko Perttunen wrote:

>> Add YAML device tree bindings for NVDEC, now in a more appropriate

>> place compared to the old textual Host1x bindings.

>>

>> Signed-off-by: Mikko Perttunen <mperttunen@nvidia.com>

>> ---

>> v5:

>> * Changed from nvidia,instance to nvidia,host1x-class optional

>>    property.

>> * Added dma-coherent

>> v4:

>> * Fix incorrect compatibility string in 'if' condition

>> v3:

>> * Drop host1x bindings

>> * Change read2 to read-1 in interconnect names

>> v2:

>> * Fix issues pointed out in v1

>> * Add T194 nvidia,instance property

>> ---

>>   .../gpu/host1x/nvidia,tegra210-nvdec.yaml     | 104 ++++++++++++++++++

>>   MAINTAINERS                                   |   1 +

>>   2 files changed, 105 insertions(+)

>>   create mode 100644 Documentation/devicetree/bindings/gpu/host1x/nvidia,tegra210-nvdec.yaml

>>

>> diff --git a/Documentation/devicetree/bindings/gpu/host1x/nvidia,tegra210-nvdec.yaml b/Documentation/devicetree/bindings/gpu/host1x/nvidia,tegra210-nvdec.yaml

>> new file mode 100644

>> index 000000000000..f1f8d083d736

>> --- /dev/null

>> +++ b/Documentation/devicetree/bindings/gpu/host1x/nvidia,tegra210-nvdec.yaml

>> @@ -0,0 +1,104 @@

>> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)

>> +%YAML 1.2

>> +---

>> +$id: "http://devicetree.org/schemas/gpu/host1x/nvidia,tegra210-nvdec.yaml#"

>> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"

>> +

>> +title: Device tree binding for NVIDIA Tegra NVDEC

>> +

>> +description: |

>> +  NVDEC is the hardware video decoder present on NVIDIA Tegra210

>> +  and newer chips. It is located on the Host1x bus and typically

>> +  programmed through Host1x channels.

>> +

>> +maintainers:

>> +  - Thierry Reding <treding@gmail.com>

>> +  - Mikko Perttunen <mperttunen@nvidia.com>

>> +

>> +properties:

>> +  $nodename:

>> +    pattern: "^nvdec@[0-9a-f]*$"

>> +

>> +  compatible:

>> +    enum:

>> +      - nvidia,tegra210-nvdec

>> +      - nvidia,tegra186-nvdec

>> +      - nvidia,tegra194-nvdec

>> +

>> +  reg:

>> +    maxItems: 1

>> +

>> +  clocks:

>> +    maxItems: 1

>> +

>> +  clock-names:

>> +    items:

>> +      - const: nvdec

>> +

>> +  resets:

>> +    maxItems: 1

>> +

>> +  reset-names:

>> +    items:

>> +      - const: nvdec

>> +

>> +  power-domains:

>> +    maxItems: 1

>> +

>> +  iommus:

>> +    maxItems: 1

>> +

>> +  dma-coherent: true

>> +

>> +  interconnects:

>> +    items:

>> +      - description: DMA read memory client

>> +      - description: DMA read 2 memory client

>> +      - description: DMA write memory client

>> +

>> +  interconnect-names:

>> +    items:

>> +      - const: dma-mem

>> +      - const: read-1

>> +      - const: write

>> +

>> +  nvidia,host1x-class:

>> +    description: Host1x class of the engine. If not specified, defaults to 0xf0.

> 

> Define what this is with more than just repeating what is in the

> property name.


Sure, I'll add a description.

> 

>> +    $ref: /schemas/types.yaml#/definitions/uint32

> 

> default: 0xf0

> 

> Is there a range or set of valid values you specify as schema?


Only to the same extent that there is a set of valid MMIO addresses in 
the 'reg' field.

Mikko

> 

> Rob

>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/gpu/host1x/nvidia,tegra210-nvdec.yaml b/Documentation/devicetree/bindings/gpu/host1x/nvidia,tegra210-nvdec.yaml
new file mode 100644
index 000000000000..f1f8d083d736
--- /dev/null
+++ b/Documentation/devicetree/bindings/gpu/host1x/nvidia,tegra210-nvdec.yaml
@@ -0,0 +1,104 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/gpu/host1x/nvidia,tegra210-nvdec.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Device tree binding for NVIDIA Tegra NVDEC
+
+description: |
+  NVDEC is the hardware video decoder present on NVIDIA Tegra210
+  and newer chips. It is located on the Host1x bus and typically
+  programmed through Host1x channels.
+
+maintainers:
+  - Thierry Reding <treding@gmail.com>
+  - Mikko Perttunen <mperttunen@nvidia.com>
+
+properties:
+  $nodename:
+    pattern: "^nvdec@[0-9a-f]*$"
+
+  compatible:
+    enum:
+      - nvidia,tegra210-nvdec
+      - nvidia,tegra186-nvdec
+      - nvidia,tegra194-nvdec
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  clock-names:
+    items:
+      - const: nvdec
+
+  resets:
+    maxItems: 1
+
+  reset-names:
+    items:
+      - const: nvdec
+
+  power-domains:
+    maxItems: 1
+
+  iommus:
+    maxItems: 1
+
+  dma-coherent: true
+
+  interconnects:
+    items:
+      - description: DMA read memory client
+      - description: DMA read 2 memory client
+      - description: DMA write memory client
+
+  interconnect-names:
+    items:
+      - const: dma-mem
+      - const: read-1
+      - const: write
+
+  nvidia,host1x-class:
+    description: Host1x class of the engine. If not specified, defaults to 0xf0.
+    $ref: /schemas/types.yaml#/definitions/uint32
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - clock-names
+  - resets
+  - reset-names
+  - power-domains
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/tegra186-clock.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/memory/tegra186-mc.h>
+    #include <dt-bindings/power/tegra186-powergate.h>
+    #include <dt-bindings/reset/tegra186-reset.h>
+
+    nvdec@15480000 {
+            compatible = "nvidia,tegra186-nvdec";
+            reg = <0x15480000 0x40000>;
+            clocks = <&bpmp TEGRA186_CLK_NVDEC>;
+            clock-names = "nvdec";
+            resets = <&bpmp TEGRA186_RESET_NVDEC>;
+            reset-names = "nvdec";
+
+            power-domains = <&bpmp TEGRA186_POWER_DOMAIN_NVDEC>;
+            interconnects = <&mc TEGRA186_MEMORY_CLIENT_NVDECSRD &emc>,
+                            <&mc TEGRA186_MEMORY_CLIENT_NVDECSRD1 &emc>,
+                            <&mc TEGRA186_MEMORY_CLIENT_NVDECSWR &emc>;
+            interconnect-names = "dma-mem", "read-1", "write";
+            iommus = <&smmu TEGRA186_SID_NVDEC>;
+    };
+
+
diff --git a/MAINTAINERS b/MAINTAINERS
index 69932194e1ba..ce9e360639d5 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -6230,6 +6230,7 @@  L:	linux-tegra@vger.kernel.org
 S:	Supported
 T:	git git://anongit.freedesktop.org/tegra/linux.git
 F:	Documentation/devicetree/bindings/display/tegra/nvidia,tegra20-host1x.txt
+F:	Documentation/devicetree/bindings/gpu/host1x/
 F:	drivers/gpu/drm/tegra/
 F:	drivers/gpu/host1x/
 F:	include/linux/host1x.h