| Message ID | 20231005051548.55122-1-niravkumar.l.rabara@intel.com |
|---|---|
| State | New |
| Headers | show |
| Series | [v2] dt-bindings: mtd: cadence: convert cadence-nand-controller.txt to yaml | expand |
On Thu, Oct 05, 2023 at 01:15:48PM +0800, niravkumar.l.rabara@intel.com wrote: > From: Niravkumar L Rabara <niravkumar.l.rabara@intel.com> > > Convert cadence-nand-controller.txt to yaml format. > Update cadence-nand-controller.txt to cadence,nand.yaml in MAINTAINER file. > > Signed-off-by: Niravkumar L Rabara <niravkumar.l.rabara@intel.com> > --- > .../devicetree/bindings/mtd/cadence,nand.yaml | 73 +++++++++++++++++++ Filename matching compatible. > .../bindings/mtd/cadence-nand-controller.txt | 53 -------------- > MAINTAINERS | 2 +- > 3 files changed, 74 insertions(+), 54 deletions(-) > create mode 100644 Documentation/devicetree/bindings/mtd/cadence,nand.yaml > delete mode 100644 Documentation/devicetree/bindings/mtd/cadence-nand-controller.txt > > diff --git a/Documentation/devicetree/bindings/mtd/cadence,nand.yaml b/Documentation/devicetree/bindings/mtd/cadence,nand.yaml > new file mode 100644 > index 000000000000..781812ac702f > --- /dev/null > +++ b/Documentation/devicetree/bindings/mtd/cadence,nand.yaml > @@ -0,0 +1,73 @@ > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/mtd/cadence,nand.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Cadence NAND controller > + > +maintainers: > + - Niravkumar L Rabara <niravkumar.l.rabara@intel.com> > + > +allOf: > + - $ref: nand-controller.yaml > + > +properties: > + compatible: > + items: > + - const: cdns,hp-nfc > + > + reg: > + items: > + - description: Address and length of the controller register set > + - description: Address and length of the Slave DMA data port > + > + reg-names: > + items: > + - const: reg > + - const: sdma > + > + interrupts: > + maxItems: 1 > + > + clocks: > + maxItems: 1 > + > + dmas: > + maxItems: 1 > + > + cdns,board-delay-ps: > + description: | > + Estimated Board delay. The value includes the total round trip > + delay for the signals and is used for deciding on values associated > + with data read capture. The example formula for SDR mode is the > + following. > + board delay = RE#PAD delay + PCB trace to device + PCB trace from device > + + DQ PAD delay > + > +required: > + - compatible > + - reg > + - reg-names > + - interrupts > + - clocks > + > +unevaluatedProperties: false > + > +examples: > + - | > + nand-controller@10b80000 { > + compatible = "cdns,hp-nfc"; > + reg = <0x10b80000 0x10000>, > + <0x10840000 0x10000>; > + reg-names = "reg", "sdma"; > + #address-cells = <1>; > + #size-cells = <0>; > + interrupts = <0 97 4>; > + clocks = <&nf_clk>; > + cdns,board-delay-ps = <4830>; > + > + nand@0 { > + reg = <0>; > + }; > + }; > diff --git a/Documentation/devicetree/bindings/mtd/cadence-nand-controller.txt b/Documentation/devicetree/bindings/mtd/cadence-nand-controller.txt > deleted file mode 100644 > index d2eada5044b2..000000000000 > --- a/Documentation/devicetree/bindings/mtd/cadence-nand-controller.txt > +++ /dev/null > @@ -1,53 +0,0 @@ > -* Cadence NAND controller > - > -Required properties: > - - compatible : "cdns,hp-nfc" > - - reg : Contains two entries, each of which is a tuple consisting of a > - physical address and length. The first entry is the address and > - length of the controller register set. The second entry is the > - address and length of the Slave DMA data port. > - - reg-names: should contain "reg" and "sdma" > - - #address-cells: should be 1. The cell encodes the chip select connection. > - - #size-cells : should be 0. > - - interrupts : The interrupt number. > - - clocks: phandle of the controller core clock (nf_clk). > - > -Optional properties: > - - dmas: shall reference DMA channel associated to the NAND controller > - - cdns,board-delay-ps : Estimated Board delay. The value includes the total > - round trip delay for the signals and is used for deciding on values > - associated with data read capture. The example formula for SDR mode is > - the following: > - board delay = RE#PAD delay + PCB trace to device + PCB trace from device > - + DQ PAD delay > - > -Child nodes represent the available NAND chips. > - > -Required properties of NAND chips: > - - reg: shall contain the native Chip Select ids from 0 to max supported by > - the cadence nand flash controller > - > -See Documentation/devicetree/bindings/mtd/nand-controller.yaml for more details on > -generic bindings. > - > -Example: > - > -nand_controller: nand-controller@60000000 { > - compatible = "cdns,hp-nfc"; > - #address-cells = <1>; > - #size-cells = <0>; > - reg = <0x60000000 0x10000>, <0x80000000 0x10000>; > - reg-names = "reg", "sdma"; > - clocks = <&nf_clk>; > - cdns,board-delay-ps = <4830>; > - interrupts = <2 0>; > - nand@0 { > - reg = <0>; > - label = "nand-1"; > - }; > - nand@1 { > - reg = <1>; > - label = "nand-2"; > - }; > - > -}; > diff --git a/MAINTAINERS b/MAINTAINERS > index 90f13281d297..502963390646 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -4474,7 +4474,7 @@ F: drivers/media/platform/cadence/cdns-csi2* > CADENCE NAND DRIVER > L: linux-mtd@lists.infradead.org > S: Orphan > -F: Documentation/devicetree/bindings/mtd/cadence-nand-controller.txt > +F: Documentation/devicetree/bindings/mtd/cadence,nand.yaml > F: drivers/mtd/nand/raw/cadence-nand-controller.c > > CADENCE USB3 DRD IP DRIVER > -- > 2.25.1 >
On 05/10/2023 07:15, niravkumar.l.rabara@intel.com wrote: > From: Niravkumar L Rabara <niravkumar.l.rabara@intel.com> > > Convert cadence-nand-controller.txt to yaml format. > Update cadence-nand-controller.txt to cadence,nand.yaml in MAINTAINER file. > > +allOf: > + - $ref: nand-controller.yaml > + > +properties: > + compatible: > + items: > + - const: cdns,hp-nfc > + > + reg: > + items: > + - description: Address and length of the controller register set Just "Controller register set" > + - description: Address and length of the Slave DMA data port "Slave DMA data port" or "Slave DMA data port register set" > + > + reg-names: > + items: > + - const: reg > + - const: sdma > + > + interrupts: > + maxItems: 1 > + > + clocks: > + maxItems: 1 > + > + dmas: > + maxItems: 1 > + > + cdns,board-delay-ps: > + description: | > + Estimated Board delay. The value includes the total round trip > + delay for the signals and is used for deciding on values associated > + with data read capture. The example formula for SDR mode is the > + following. > + board delay = RE#PAD delay + PCB trace to device + PCB trace from device > + + DQ PAD delay > + > +required: > + - compatible > + - reg > + - reg-names > + - interrupts > + - clocks > + > +unevaluatedProperties: false > + > +examples: > + - | > + nand-controller@10b80000 { This does not look properly indented. Should start at | before. IOW: Use 4 spaces for example indentation. > + compatible = "cdns,hp-nfc"; > + reg = <0x10b80000 0x10000>, > + <0x10840000 0x10000>; Please align it properly with opening < > + reg-names = "reg", "sdma"; > + #address-cells = <1>; > + #size-cells = <0>; > + interrupts = <0 97 4>; Use defines for interrupt flags. > + clocks = <&nf_clk>; > + cdns,board-delay-ps = <4830>; > + > + nand@0 { > + reg = <0>; > + }; > + }; Best regards, Krzysztof
diff --git a/Documentation/devicetree/bindings/mtd/cadence,nand.yaml b/Documentation/devicetree/bindings/mtd/cadence,nand.yaml new file mode 100644 index 000000000000..781812ac702f --- /dev/null +++ b/Documentation/devicetree/bindings/mtd/cadence,nand.yaml @@ -0,0 +1,73 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mtd/cadence,nand.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Cadence NAND controller + +maintainers: + - Niravkumar L Rabara <niravkumar.l.rabara@intel.com> + +allOf: + - $ref: nand-controller.yaml + +properties: + compatible: + items: + - const: cdns,hp-nfc + + reg: + items: + - description: Address and length of the controller register set + - description: Address and length of the Slave DMA data port + + reg-names: + items: + - const: reg + - const: sdma + + interrupts: + maxItems: 1 + + clocks: + maxItems: 1 + + dmas: + maxItems: 1 + + cdns,board-delay-ps: + description: | + Estimated Board delay. The value includes the total round trip + delay for the signals and is used for deciding on values associated + with data read capture. The example formula for SDR mode is the + following. + board delay = RE#PAD delay + PCB trace to device + PCB trace from device + + DQ PAD delay + +required: + - compatible + - reg + - reg-names + - interrupts + - clocks + +unevaluatedProperties: false + +examples: + - | + nand-controller@10b80000 { + compatible = "cdns,hp-nfc"; + reg = <0x10b80000 0x10000>, + <0x10840000 0x10000>; + reg-names = "reg", "sdma"; + #address-cells = <1>; + #size-cells = <0>; + interrupts = <0 97 4>; + clocks = <&nf_clk>; + cdns,board-delay-ps = <4830>; + + nand@0 { + reg = <0>; + }; + }; diff --git a/Documentation/devicetree/bindings/mtd/cadence-nand-controller.txt b/Documentation/devicetree/bindings/mtd/cadence-nand-controller.txt deleted file mode 100644 index d2eada5044b2..000000000000 --- a/Documentation/devicetree/bindings/mtd/cadence-nand-controller.txt +++ /dev/null @@ -1,53 +0,0 @@ -* Cadence NAND controller - -Required properties: - - compatible : "cdns,hp-nfc" - - reg : Contains two entries, each of which is a tuple consisting of a - physical address and length. The first entry is the address and - length of the controller register set. The second entry is the - address and length of the Slave DMA data port. - - reg-names: should contain "reg" and "sdma" - - #address-cells: should be 1. The cell encodes the chip select connection. - - #size-cells : should be 0. - - interrupts : The interrupt number. - - clocks: phandle of the controller core clock (nf_clk). - -Optional properties: - - dmas: shall reference DMA channel associated to the NAND controller - - cdns,board-delay-ps : Estimated Board delay. The value includes the total - round trip delay for the signals and is used for deciding on values - associated with data read capture. The example formula for SDR mode is - the following: - board delay = RE#PAD delay + PCB trace to device + PCB trace from device - + DQ PAD delay - -Child nodes represent the available NAND chips. - -Required properties of NAND chips: - - reg: shall contain the native Chip Select ids from 0 to max supported by - the cadence nand flash controller - -See Documentation/devicetree/bindings/mtd/nand-controller.yaml for more details on -generic bindings. - -Example: - -nand_controller: nand-controller@60000000 { - compatible = "cdns,hp-nfc"; - #address-cells = <1>; - #size-cells = <0>; - reg = <0x60000000 0x10000>, <0x80000000 0x10000>; - reg-names = "reg", "sdma"; - clocks = <&nf_clk>; - cdns,board-delay-ps = <4830>; - interrupts = <2 0>; - nand@0 { - reg = <0>; - label = "nand-1"; - }; - nand@1 { - reg = <1>; - label = "nand-2"; - }; - -}; diff --git a/MAINTAINERS b/MAINTAINERS index 90f13281d297..502963390646 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -4474,7 +4474,7 @@ F: drivers/media/platform/cadence/cdns-csi2* CADENCE NAND DRIVER L: linux-mtd@lists.infradead.org S: Orphan -F: Documentation/devicetree/bindings/mtd/cadence-nand-controller.txt +F: Documentation/devicetree/bindings/mtd/cadence,nand.yaml F: drivers/mtd/nand/raw/cadence-nand-controller.c CADENCE USB3 DRD IP DRIVER