Re: [PATCH v3 1/2] dt-bindings: spi: Add schema for Cadence QSPI Controller driver

[Ramuthevar, Vadivel MuruganX]

Hi Vignesh,

ÂÂ Thank you for the review comments.

On 16/12/2019 8:50 PM, Vignesh Raghavendra wrote:
> Hi,
>
> On 09/12/19 2:10 pm, Ramuthevar,Vadivel MuruganX wrote:
> > From: Ramuthevar Vadivel Murugan <vadivel.muruganx.ramuthevar@xxxxxxxxxxxxxxx>
> >
> > Add dt-bindings documentation for Cadence-QSPI controller to support
> > spi based flash memories.
> >
> > Signed-off-by: Ramuthevar Vadivel Murugan <vadivel.muruganx.ramuthevar@xxxxxxxxxxxxxxx>
> > ---
> >   .../devicetree/bindings/spi/cadence,qspi.yaml      | 162 +++++++++++++++++++++
> >   1 file changed, 162 insertions(+)
> >   create mode 100644 Documentation/devicetree/bindings/spi/cadence,qspi.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/spi/cadence,qspi.yaml b/Documentation/devicetree/bindings/spi/cadence,qspi.yaml
> > new file mode 100644
> > index 000000000000..7756c34bb453
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/spi/cadence,qspi.yaml
> > @@ -0,0 +1,162 @@
> > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: "http://devicetree.org/schemas/spi/cadence,qspi.yaml#";
> > +$schema: "http://devicetree.org/meta-schemas/core.yaml#";
> > +
> > +title: Cadence QSPI Flash Controller support
> > +
> > +maintainers:
> > +  - Ramuthevar Vadivel Murugan <vadivel.muruganx.ramuthevar@xxxxxxxxxxxxxxx>
> > +
> > +allOf:
> > +  - $ref: "spi-controller.yaml#"
> > +
> > +description: |
> > +  Add support for the Cadence QSPI controller,This controller is
> > +  present in the Intel LGM, Altera SoCFPGA and TI SoCs and this driver
> > +  has been tested On Intel's LGM SoC.
> > +
> This looks like a commit message. Description should probably says
> something like "Binding Documentation for Cadence QSPI controller..."
Agreed!, will change it in next patch.
> > +  - compatible : should be one of the following:
> > +        Generic default - "cdns,qspi-nor".
> > +        For TI 66AK2G SoC - "ti,k2g-qspi", "cdns,qspi-nor".
> > +        For TI AM654 SoC  - "ti,am654-ospi", "cdns,qspi-nor".
> > +        For Intel LGM SoC - "intel,lgm-qspi", "cdns,qspi-nor".
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> This should be:
>
>    compatible:
>      oneOf:
>        - items:
>          - enum:
>             - ti,k2g-qspi
>          - const: cdns,qspi-nor
>
>        - items:
>          - enum:
>             - ti,am654-ospi
>          - const: cdns,qspi-nor
>
>        - items:
>          - enum:
>             - intel,lgm-qspi
>          - const: cdns,qspi-nor
>
>        - items:
>          - const: cdns,qspi-nor
will follow the same code.
> > +      - cadence,qspi
> This wrong and does not match what you is there in description above.
> "cadence" is not a valid vendor prefix... It should be "cdns" as per
> Documentation/devicetree/bindings/vendor-prefixes.yaml
>
> Have you verified this yaml schema? I see bunch of errors for my platform
schema is built not verified on the platform, when I was built there is 
no errors
> > +      - cdns,qspi-nor
> > +      - ti,k2g-qspi
> > +      - ti,am654-ospi
> > +      - intel,lgm-qspi
> > +
> > +  reg:
> > +    description: |
> > +      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 QSPI Controller data area.
> Don't you need to put a constraint here, like:
>
> maxItems: 2
Noted , will fixt it.
> > +
> > +  interrupts:
> > +    description:
> > +      Unit interrupt specifier for the controller interrupt.
> > +
> maxItems: 1??
>
> > +  clocks:
> > +    description:
> > +      phandle to the Quad SPI clock.
> > +
> maxItems: 1??
noted, will drop it.
> > +  cdns,fifo-depth:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description:
> > +      Size of the data FIFO in words.
> > +
> > +  cdns,fifo-width:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description:
> > +      Bus width of the data FIFO in bytes.
> > +
> > +  cdns,trigger-address:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description:
> > +      32-bit indirect AHB trigger address.
> > +
> > +  cdns,is-decoded-cs:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description:
> > +      Flag to indicate whether decoder is used or not.
> > +
> > +  cdns,rclk-en:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description: |
> > +      Flag to indicate that QSPI return clock is used to latch the read data
> > +      rather than the QSPI clock. Make sure that QSPI return clock is populated
> > +      on the board before using this property.
> > +
> > +  resets:
> > +    minItems: 1
> > +    maxItems: 2
> > +
> > +  reset-names:
> > +    minItems: 1
> > +    maxItems: 2
> > +    items:
> > +      - const: qspi
> > +      - const: qspi-ocp
> > +
> > +# subnode's properties
> > +patternProperties:
> > +  "^.*@[0-9a-fA-F]+$":
> > +    type: object
> > +    description:
> > +      flash device uses the subnodes below defined properties.
> > +
> > +  cdns,read-delay:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description:
> > +      Delay for read capture logic, in clock cycles.
> > +
> > +  cdns,tshsl-ns:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description: |
> > +      Delay in nanoseconds for the length that the master mode chip select
> > +      outputs are de-asserted between transactions.
> > +
> > +  cdns,tsd2d-ns:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description: |
> > +      Delay in nanoseconds between one chip select being de-activated
> > +      and the activation of another.
> > +
> > +  cdns,tchsh-ns:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description: |
> > +      Delay in nanoseconds between last bit of current transaction and
> > +      deasserting the device chip select (qspi_n_ss_out).
> > +
> > +  cdns,tslch-ns:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description: |
> > +      Delay in nanoseconds between setting qspi_n_ss_out low and
> > +      first bit transfer.
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - interrupts
> > +  - clocks
> > +  - cdns,is-decoded-cs
> Not a required property as per existing DT bindings
noted, will drop it.
> > +  - cdns,fifo-depth
> > +  - cdns,fifo-width
> > +  - cdns,trigger-address
>
> > +  - resets
> > +  - reset-names
> Again optional properties
Noted
> > +
> > +examples:
> > +  - |
> > +    qspi: spi@ff705000 {
> > +          compatible = "cadence,qspi", "cdns,qspi-nor";
> > +          #address-cells = <1>;
> > +          #size-cells = <0>;
> > +          reg = <0xff705000 0x1000>,
> > +                <0xffa00000 0x1000>;
> > +          interrupts = <0 151 4>;
> > +          clocks = <&qspi_clk>;
> > +          cdns,is-decoded-cs;
> > +          cdns,fifo-depth = <128>;
> > +          cdns,fifo-width = <4>;
> > +          cdns,trigger-address = <0x00000000>;
> > +          resets = <&rst QSPI_RESET>, <&rst QSPI_OCP_RESET>;
> > +          reset-names = "qspi", "qspi-ocp";
> > +
> > +          flash0: n25q00@0 {
> > +              ...
> > +              cdns,read-delay = <4>;
> > +              cdns,tshsl-ns = <50>;
> > +              cdns,tsd2d-ns = <50>;
> > +              cdns,tchsh-ns = <4>;
> > +              cdns,tslch-ns = <4>;
> > +          };
> > +    };
> > +
> No blank line before EOF, please

Noted, will fix it next patch.

---
with Best Regards
Vadivel