linux-kernel - Re: [PATCH v5 2/2] dt-bindings: mtd: Document Macronix raw NAND controller bindings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Mon, 22 Jul 2019 17:46:14 -0600
From:   Rob Herring <robh@...nel.org>
To:     Mason Yang <masonccyang@...c.com.tw>
Cc:     miquel.raynal@...tlin.com, marek.vasut@...il.com,
        bbrezillon@...nel.org, dwmw2@...radead.org,
        computersforpeace@...il.com, vigneshr@...com, richard@....at,
        stefan@...er.ch, mark.rutland@....com,
        linux-kernel@...r.kernel.org, linux-mtd@...ts.infradead.org,
        juliensu@...c.com.tw, paul.burton@...s.com, liang.yang@...ogic.com,
        lee.jones@...aro.org, anders.roxell@...aro.org,
        christophe.kerello@...com, paul@...pouillou.net,
        devicetree@...r.kernel.org
Subject: Re: [PATCH v5 2/2] dt-bindings: mtd: Document Macronix raw NAND
 controller bindings

On Wed, Jul 03, 2019 at 03:15:44PM +0800, Mason Yang wrote:
> Document the bindings used by the Macronix raw NAND controller.
> 
> Signed-off-by: Mason Yang <masonccyang@...c.com.tw>
> ---
>  Documentation/devicetree/bindings/mtd/mxic-nand.txt | 20 ++++++++++++++++++++
>  1 file changed, 20 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/mtd/mxic-nand.txt
> 
> diff --git a/Documentation/devicetree/bindings/mtd/mxic-nand.txt b/Documentation/devicetree/bindings/mtd/mxic-nand.txt
> new file mode 100644
> index 0000000..ddd7660
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mtd/mxic-nand.txt
> @@ -0,0 +1,20 @@
> +Macronix Raw NAND Controller Device Tree Bindings
> +-------------------------------------------------
> +
> +Required properties:
> +- compatible: should be "macronix,nand-controller"

That's not very specific. There's only 1 version of this h/w?

> +- reg: should contain 1 entrie for the registers

s/entrie/entry/

> +- interrupts: interrupt line connected to this raw NAND controller
> +- clock-names: should contain "ps_clk", "send_clk" and "send_dly_clk"
> +- clocks: should contain 3 phandles for the "ps_clk", "send_clk" and
> +	 "send_dly_clk" clocks

You can drop '_clk' as that is redundant.

> +
> +Example:
> +
> +	nand: mxic-nfc@...30000 {
> +		compatible = "macronix,nand-controller";
> +		reg = <0x43c30000 0x10000>;
> +		reg-names = "regs";

Not documented. You can drop as *-names is not generally useful when 
there is only 1 entry.

> +		clocks = <&clkwizard 0>, <&clkwizard 1>, <&clkc 15>;
> +		clock-names = "send_clk", "send_dly_clk", "ps_clk";
> +	};
> -- 
> 1.9.1
>