[1/2] dt-bindings: ufs: ti,j721e-ufs.yaml: Add binding for TI UFS wrapper
diff mbox series

Message ID 20190918133921.25844-2-vigneshr@ti.com
State Changes Requested
Headers show
Series
  • scsi: ufs: Add driver for TI wrapper for Cadence UFS IP
Related show

Checks

Context Check Description
robh/dt-meta-schema fail build log
robh/checkpatch success

Commit Message

Vignesh Raghavendra Sept. 18, 2019, 1:39 p.m. UTC
Add binding documentation of TI wrapper for Cadence UFS Controller.

Signed-off-by: Vignesh Raghavendra <vigneshr@ti.com>
---
 .../devicetree/bindings/ufs/ti,j721e-ufs.yaml | 45 +++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/ufs/ti,j721e-ufs.yaml

Comments

Rob Herring Oct. 1, 2019, 12:08 p.m. UTC | #1
On Wed, Sep 18, 2019 at 07:09:20PM +0530, Vignesh Raghavendra wrote:
> Add binding documentation of TI wrapper for Cadence UFS Controller.
> 
> Signed-off-by: Vignesh Raghavendra <vigneshr@ti.com>
> ---
>  .../devicetree/bindings/ufs/ti,j721e-ufs.yaml | 45 +++++++++++++++++++
>  1 file changed, 45 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/ufs/ti,j721e-ufs.yaml
> 
> diff --git a/Documentation/devicetree/bindings/ufs/ti,j721e-ufs.yaml b/Documentation/devicetree/bindings/ufs/ti,j721e-ufs.yaml
> new file mode 100644
> index 000000000000..dabd7c795fbe
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/ufs/ti,j721e-ufs.yaml
> @@ -0,0 +1,45 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/ufs/ti,j721e-ufs.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: TI J721e UFS Host Controller Glue Driver
> +
> +maintainers:
> +  - Vignesh Raghavendra <vigneshr@ti.com>
> +
> +properties:
> +  compatible:
> +    items:
> +      - const: ti,j721e-ufs
> +
> +  reg:
> +    maxItems: 1
> +    description: address of TI UFS glue registers
> +
> +  clocks:
> +    maxItems: 1
> +    description: phandle to the M-PHY clock
> +
> +  power-domains:
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - clocks
> +  - power-domains
> +
> +examples:
> +  - |
> +    ufs_wrapper: ufs-wrapper@4e80000 {
> +       compatible = "ti,j721e-ufs";
> +       reg = <0x0 0x4e80000 0x0 0x100>;
> +       power-domains = <&k3_pds 277>;
> +       clocks = <&k3_clks 277 1>;
> +       assigned-clocks = <&k3_clks 277 1>;
> +       assigned-clock-parents = <&k3_clks 277 4>;
> +       #address-cells = <2>;
> +       #size-cells = <2>;

Based on the driver you expect to have a child node here with the UFS 
controller? You need to show that and have a schema for it.

> +    };
> -- 
> 2.23.0
>
Vignesh Raghavendra Oct. 1, 2019, 12:18 p.m. UTC | #2
On 01/10/19 5:38 PM, Rob Herring wrote:
> On Wed, Sep 18, 2019 at 07:09:20PM +0530, Vignesh Raghavendra wrote:
>> Add binding documentation of TI wrapper for Cadence UFS Controller.
>>
>> Signed-off-by: Vignesh Raghavendra <vigneshr@ti.com>
>> ---
>>  .../devicetree/bindings/ufs/ti,j721e-ufs.yaml | 45 +++++++++++++++++++
>>  1 file changed, 45 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/ufs/ti,j721e-ufs.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/ufs/ti,j721e-ufs.yaml b/Documentation/devicetree/bindings/ufs/ti,j721e-ufs.yaml
>> new file mode 100644
>> index 000000000000..dabd7c795fbe
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/ufs/ti,j721e-ufs.yaml
>> @@ -0,0 +1,45 @@
>> +# SPDX-License-Identifier: GPL-2.0
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/ufs/ti,j721e-ufs.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: TI J721e UFS Host Controller Glue Driver
>> +
>> +maintainers:
>> +  - Vignesh Raghavendra <vigneshr@ti.com>
>> +
>> +properties:
>> +  compatible:
>> +    items:
>> +      - const: ti,j721e-ufs
>> +
>> +  reg:
>> +    maxItems: 1
>> +    description: address of TI UFS glue registers
>> +
>> +  clocks:
>> +    maxItems: 1
>> +    description: phandle to the M-PHY clock
>> +
>> +  power-domains:
>> +    maxItems: 1
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - clocks
>> +  - power-domains
>> +
>> +examples:
>> +  - |
>> +    ufs_wrapper: ufs-wrapper@4e80000 {
>> +       compatible = "ti,j721e-ufs";
>> +       reg = <0x0 0x4e80000 0x0 0x100>;
>> +       power-domains = <&k3_pds 277>;
>> +       clocks = <&k3_clks 277 1>;
>> +       assigned-clocks = <&k3_clks 277 1>;
>> +       assigned-clock-parents = <&k3_clks 277 4>;
>> +       #address-cells = <2>;
>> +       #size-cells = <2>;
> 
> Based on the driver you expect to have a child node here with the UFS 
> controller? You need to show that and have a schema for it.
> 

Yes, Cadence UFS controller node will be the child node. Its bindings
are documented at: Documentation/devicetree/bindings/ufs/cdns,ufshc.txt
(which in turn refers to
Documentation/devicetree/bindings/ufs/ufshcd-pltfrm.txt)

But they are not in .yaml yet. How would you suggest to reference that?
Or should I just write plain text DT binding doc given that subsystem is
not converted to yaml?

>> +    };
>> -- 
>> 2.23.0
>>
Rob Herring Oct. 3, 2019, 9:56 p.m. UTC | #3
On Tue, Oct 1, 2019 at 7:18 AM Vignesh Raghavendra <vigneshr@ti.com> wrote:
>
>
>
> On 01/10/19 5:38 PM, Rob Herring wrote:
> > On Wed, Sep 18, 2019 at 07:09:20PM +0530, Vignesh Raghavendra wrote:
> >> Add binding documentation of TI wrapper for Cadence UFS Controller.
> >>
> >> Signed-off-by: Vignesh Raghavendra <vigneshr@ti.com>
> >> ---
> >>  .../devicetree/bindings/ufs/ti,j721e-ufs.yaml | 45 +++++++++++++++++++
> >>  1 file changed, 45 insertions(+)
> >>  create mode 100644 Documentation/devicetree/bindings/ufs/ti,j721e-ufs.yaml
> >>
> >> diff --git a/Documentation/devicetree/bindings/ufs/ti,j721e-ufs.yaml b/Documentation/devicetree/bindings/ufs/ti,j721e-ufs.yaml
> >> new file mode 100644
> >> index 000000000000..dabd7c795fbe
> >> --- /dev/null
> >> +++ b/Documentation/devicetree/bindings/ufs/ti,j721e-ufs.yaml
> >> @@ -0,0 +1,45 @@
> >> +# SPDX-License-Identifier: GPL-2.0
> >> +%YAML 1.2
> >> +---
> >> +$id: http://devicetree.org/schemas/ufs/ti,j721e-ufs.yaml#
> >> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> >> +
> >> +title: TI J721e UFS Host Controller Glue Driver
> >> +
> >> +maintainers:
> >> +  - Vignesh Raghavendra <vigneshr@ti.com>
> >> +
> >> +properties:
> >> +  compatible:
> >> +    items:
> >> +      - const: ti,j721e-ufs
> >> +
> >> +  reg:
> >> +    maxItems: 1
> >> +    description: address of TI UFS glue registers
> >> +
> >> +  clocks:
> >> +    maxItems: 1
> >> +    description: phandle to the M-PHY clock
> >> +
> >> +  power-domains:
> >> +    maxItems: 1
> >> +
> >> +required:
> >> +  - compatible
> >> +  - reg
> >> +  - clocks
> >> +  - power-domains
> >> +
> >> +examples:
> >> +  - |
> >> +    ufs_wrapper: ufs-wrapper@4e80000 {
> >> +       compatible = "ti,j721e-ufs";
> >> +       reg = <0x0 0x4e80000 0x0 0x100>;
> >> +       power-domains = <&k3_pds 277>;
> >> +       clocks = <&k3_clks 277 1>;
> >> +       assigned-clocks = <&k3_clks 277 1>;
> >> +       assigned-clock-parents = <&k3_clks 277 4>;
> >> +       #address-cells = <2>;
> >> +       #size-cells = <2>;
> >
> > Based on the driver you expect to have a child node here with the UFS
> > controller? You need to show that and have a schema for it.
> >
>
> Yes, Cadence UFS controller node will be the child node. Its bindings
> are documented at: Documentation/devicetree/bindings/ufs/cdns,ufshc.txt
> (which in turn refers to
> Documentation/devicetree/bindings/ufs/ufshcd-pltfrm.txt)
>
> But they are not in .yaml yet. How would you suggest to reference that?
> Or should I just write plain text DT binding doc given that subsystem is
> not converted to yaml?

I guess for now just define the child node and refer to the text
document. Or feel free to convert the above 2 docs to schema. :)

Rob

Patch
diff mbox series

diff --git a/Documentation/devicetree/bindings/ufs/ti,j721e-ufs.yaml b/Documentation/devicetree/bindings/ufs/ti,j721e-ufs.yaml
new file mode 100644
index 000000000000..dabd7c795fbe
--- /dev/null
+++ b/Documentation/devicetree/bindings/ufs/ti,j721e-ufs.yaml
@@ -0,0 +1,45 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/ufs/ti,j721e-ufs.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: TI J721e UFS Host Controller Glue Driver
+
+maintainers:
+  - Vignesh Raghavendra <vigneshr@ti.com>
+
+properties:
+  compatible:
+    items:
+      - const: ti,j721e-ufs
+
+  reg:
+    maxItems: 1
+    description: address of TI UFS glue registers
+
+  clocks:
+    maxItems: 1
+    description: phandle to the M-PHY clock
+
+  power-domains:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - power-domains
+
+examples:
+  - |
+    ufs_wrapper: ufs-wrapper@4e80000 {
+       compatible = "ti,j721e-ufs";
+       reg = <0x0 0x4e80000 0x0 0x100>;
+       power-domains = <&k3_pds 277>;
+       clocks = <&k3_clks 277 1>;
+       assigned-clocks = <&k3_clks 277 1>;
+       assigned-clock-parents = <&k3_clks 277 4>;
+       #address-cells = <2>;
+       #size-cells = <2>;
+    };