Document the bindings used by the Macronix raw NAND controller.
Signed-off-by: Mason Yang <[email protected]>
---
Documentation/devicetree/bindings/mtd/mxic-nand.txt | 19 +++++++++++++++++++
1 file changed, 19 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..de37d60
--- /dev/null
+++ b/Documentation/devicetree/bindings/mtd/mxic-nand.txt
@@ -0,0 +1,19 @@
+Macronix Raw NAND Controller Device Tree Bindings
+-------------------------------------------------
+
+Required properties:
+- compatible: should be "mxicy,multi-itfc-v009-nand-morph"
+- reg: should contain 1 entry for the registers
+- interrupts: interrupt line connected to this raw NAND controller
+- clock-names: should contain "ps", "send" and "send_dly"
+- clocks: should contain 3 phandles for the "ps", "send" and
+ "send_dly" clocks
+
+Example:
+
+ nand: nand-controller@43c30000 {
+ compatible = "mxicy,multi-itfc-v009-nand-morph";
+ reg = <0x43c30000 0x10000>;
+ clocks = <&clkwizard 0>, <&clkwizard 1>, <&clkc 15>;
+ clock-names = "send", "send_dly", "ps";
+ };
--
1.9.1
On Thu, 1 Aug 2019 11:55:10 +0800
Mason Yang <[email protected]> wrote:
> Document the bindings used by the Macronix raw NAND controller.
>
> Signed-off-by: Mason Yang <[email protected]>
> ---
> Documentation/devicetree/bindings/mtd/mxic-nand.txt | 19 +++++++++++++++++++
> 1 file changed, 19 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..de37d60
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mtd/mxic-nand.txt
> @@ -0,0 +1,19 @@
> +Macronix Raw NAND Controller Device Tree Bindings
> +-------------------------------------------------
> +
> +Required properties:
> +- compatible: should be "mxicy,multi-itfc-v009-nand-morph"
> +- reg: should contain 1 entry for the registers
> +- interrupts: interrupt line connected to this raw NAND controller
> +- clock-names: should contain "ps", "send" and "send_dly"
> +- clocks: should contain 3 phandles for the "ps", "send" and
> + "send_dly" clocks
> +
> +Example:
> +
> + nand: nand-controller@43c30000 {
> + compatible = "mxicy,multi-itfc-v009-nand-morph";
> + reg = <0x43c30000 0x10000>;
> + clocks = <&clkwizard 0>, <&clkwizard 1>, <&clkc 15>;
> + clock-names = "send", "send_dly", "ps";
You should have subnodes describing the NAND connected to the
controller (see [1]).
[1]https://elixir.bootlin.com/linux/v5.3-rc2/source/Documentation/devicetree/bindings/mtd/nand-controller.yaml#L131
> + };
Hi Mason,
Mason Yang <[email protected]> wrote on Thu, 1 Aug 2019 11:55:10
+0800:
> Document the bindings used by the Macronix raw NAND controller.
>
> Signed-off-by: Mason Yang <[email protected]>
> ---
> Documentation/devicetree/bindings/mtd/mxic-nand.txt | 19 +++++++++++++++++++
> 1 file changed, 19 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..de37d60
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mtd/mxic-nand.txt
> @@ -0,0 +1,19 @@
> +Macronix Raw NAND Controller Device Tree Bindings
> +-------------------------------------------------
> +
> +Required properties:
> +- compatible: should be "mxicy,multi-itfc-v009-nand-morph"
> +- reg: should contain 1 entry for the registers
> +- interrupts: interrupt line connected to this raw NAND controller
> +- clock-names: should contain "ps", "send" and "send_dly"
> +- clocks: should contain 3 phandles for the "ps", "send" and
> + "send_dly" clocks
> +
> +Example:
> +
> + nand: nand-controller@43c30000 {
> + compatible = "mxicy,multi-itfc-v009-nand-morph";
"mxicy" looks strange to me, I know it has been used in the past and
cannot be removed, but I don't think it is wise to continue using it
while your use "mxic" in all your other contributions. I would update
the prefix to mxic here and fill-in the relevant doc.
Also, what is nand-morph? I thought we were okay for
the "-nand-controller" suffix.
Thanks,
Miquèl
Hi Boris,
> On Thu, 1 Aug 2019 11:55:10 +0800
> Mason Yang <[email protected]> wrote:
>
> > Document the bindings used by the Macronix raw NAND controller.
> >
> > Signed-off-by: Mason Yang <[email protected]>
> > ---
> > Documentation/devicetree/bindings/mtd/mxic-nand.txt | 19
+++++++++++++++++++
> > 1 file changed, 19 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..de37d60
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/mtd/mxic-nand.txt
> > @@ -0,0 +1,19 @@
> > +Macronix Raw NAND Controller Device Tree Bindings
> > +-------------------------------------------------
> > +
> > +Required properties:
> > +- compatible: should be "mxicy,multi-itfc-v009-nand-morph"
> > +- reg: should contain 1 entry for the registers
> > +- interrupts: interrupt line connected to this raw NAND controller
> > +- clock-names: should contain "ps", "send" and "send_dly"
> > +- clocks: should contain 3 phandles for the "ps", "send" and
> > + "send_dly" clocks
> > +
> > +Example:
> > +
> > + nand: nand-controller@43c30000 {
> > + compatible = "mxicy,multi-itfc-v009-nand-morph";
> > + reg = <0x43c30000 0x10000>;
> > + clocks = <&clkwizard 0>, <&clkwizard 1>, <&clkc 15>;
> > + clock-names = "send", "send_dly", "ps";
>
> You should have subnodes describing the NAND connected to the
> controller (see [1]).
>
> [1]
https://elixir.bootlin.com/linux/v5.3-rc2/source/Documentation/devicetree/
> bindings/mtd/nand-controller.yaml#L131
>
> > + };
>
Do you mean to add patternProperties ?
nand: nand-controller@43c30000 {
compatible =
"mxicy,multi-itfc-v009-nand-morph";
reg = <0x43c30000 0x10000>;
clocks = <&clkwizard 0>, <&clkwizard 1>,
<&clkc 15>;
clock-names = "send", "send_dly", "ps";
+ nand@0 {
+
+ };
};
something like that.
thanks & best regards,
Mason
CONFIDENTIALITY NOTE:
This e-mail and any attachments may contain confidential information
and/or personal data, which is protected by applicable laws. Please be
reminded that duplication, disclosure, distribution, or use of this e-mail
(and/or its attachments) or any part thereof is prohibited. If you receive
this e-mail in error, please notify us immediately and delete this mail as
well as its attachment(s) from your system. In addition, please be
informed that collection, processing, and/or use of personal data is
prohibited unless expressly permitted by personal data protection laws.
Thank you for your attention and cooperation.
Macronix International Co., Ltd.
=====================================================================
============================================================================
CONFIDENTIALITY NOTE:
This e-mail and any attachments may contain confidential information and/or personal data, which is protected by applicable laws. Please be reminded that duplication, disclosure, distribution, or use of this e-mail (and/or its attachments) or any part thereof is prohibited. If you receive this e-mail in error, please notify us immediately and delete this mail as well as its attachment(s) from your system. In addition, please be informed that collection, processing, and/or use of personal data is prohibited unless expressly permitted by personal data protection laws. Thank you for your attention and cooperation.
Macronix International Co., Ltd.
=====================================================================
Hi Miquel,
> > Document the bindings used by the Macronix raw NAND controller.
> >
> > Signed-off-by: Mason Yang <[email protected]>
> > ---
> > Documentation/devicetree/bindings/mtd/mxic-nand.txt | 19
+++++++++++++++++++
> > 1 file changed, 19 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..de37d60
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/mtd/mxic-nand.txt
> > @@ -0,0 +1,19 @@
> > +Macronix Raw NAND Controller Device Tree Bindings
> > +-------------------------------------------------
> > +
> > +Required properties:
> > +- compatible: should be "mxicy,multi-itfc-v009-nand-morph"
> > +- reg: should contain 1 entry for the registers
> > +- interrupts: interrupt line connected to this raw NAND controller
> > +- clock-names: should contain "ps", "send" and "send_dly"
> > +- clocks: should contain 3 phandles for the "ps", "send" and
> > + "send_dly" clocks
> > +
> > +Example:
> > +
> > + nand: nand-controller@43c30000 {
> > + compatible = "mxicy,multi-itfc-v009-nand-morph";
>
> "mxicy" looks strange to me, I know it has been used in the past and
> cannot be removed, but I don't think it is wise to continue using it
> while your use "mxic" in all your other contributions. I would update
> the prefix to mxic here and fill-in the relevant doc.
>
> Also, what is nand-morph? I thought we were okay for
> the "-nand-controller" suffix.
>
I thought there is a node name "nand-controller@43c30000" and the
"-nand-controller" suffix in compatible property seems repeated.
In addition, I would like to indicate it's a multi function controller.
nand-morph means this multi interface controller (multi-itfc) works in
raw NAND controller.
thanks & best regards,
Mason
CONFIDENTIALITY NOTE:
This e-mail and any attachments may contain confidential information
and/or personal data, which is protected by applicable laws. Please be
reminded that duplication, disclosure, distribution, or use of this e-mail
(and/or its attachments) or any part thereof is prohibited. If you receive
this e-mail in error, please notify us immediately and delete this mail as
well as its attachment(s) from your system. In addition, please be
informed that collection, processing, and/or use of personal data is
prohibited unless expressly permitted by personal data protection laws.
Thank you for your attention and cooperation.
Macronix International Co., Ltd.
=====================================================================
============================================================================
CONFIDENTIALITY NOTE:
This e-mail and any attachments may contain confidential information and/or personal data, which is protected by applicable laws. Please be reminded that duplication, disclosure, distribution, or use of this e-mail (and/or its attachments) or any part thereof is prohibited. If you receive this e-mail in error, please notify us immediately and delete this mail as well as its attachment(s) from your system. In addition, please be informed that collection, processing, and/or use of personal data is prohibited unless expressly permitted by personal data protection laws. Thank you for your attention and cooperation.
Macronix International Co., Ltd.
=====================================================================
Hi Mason,
[email protected] wrote on Thu, 1 Aug 2019 17:32:04 +0800:
> Hi Miquel,
>
> > > Document the bindings used by the Macronix raw NAND controller.
> > >
> > > Signed-off-by: Mason Yang <[email protected]>
> > > ---
> > > Documentation/devicetree/bindings/mtd/mxic-nand.txt | 19
> +++++++++++++++++++
> > > 1 file changed, 19 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..de37d60
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/mtd/mxic-nand.txt
> > > @@ -0,0 +1,19 @@
> > > +Macronix Raw NAND Controller Device Tree Bindings
> > > +-------------------------------------------------
> > > +
> > > +Required properties:
> > > +- compatible: should be "mxicy,multi-itfc-v009-nand-morph"
> > > +- reg: should contain 1 entry for the registers
> > > +- interrupts: interrupt line connected to this raw NAND controller
> > > +- clock-names: should contain "ps", "send" and "send_dly"
> > > +- clocks: should contain 3 phandles for the "ps", "send" and
> > > + "send_dly" clocks
> > > +
> > > +Example:
> > > +
> > > + nand: nand-controller@43c30000 {
> > > + compatible = "mxicy,multi-itfc-v009-nand-morph";
> >
> > "mxicy" looks strange to me, I know it has been used in the past and
> > cannot be removed, but I don't think it is wise to continue using it
> > while your use "mxic" in all your other contributions. I would update
> > the prefix to mxic here and fill-in the relevant doc.
> >
> > Also, what is nand-morph? I thought we were okay for
> > the "-nand-controller" suffix.
> >
>
> I thought there is a node name "nand-controller@43c30000" and the
> "-nand-controller" suffix in compatible property seems repeated.
It is repeated because it won't be used the same way. The node name
will only be relevant in the DT itself (to reference a node for
instance). I will also appear in the sysfs.
The compatibles are listed in drivers and "given" to the kernel core so
that the device-driver association can take place.
>
> In addition, I would like to indicate it's a multi function controller.
>
> nand-morph means this multi interface controller (multi-itfc) works in
> raw NAND controller.
I think this is clear as you already put "multi-itfc" in the name. If
you want you can switch to "morph" in the prefix, but I want the suffix
to be "-nand-controller".
Thanks,
Miquèl
On Thu, 1 Aug 2019 17:17:29 +0800
[email protected] wrote:
> Hi Boris,
>
> > On Thu, 1 Aug 2019 11:55:10 +0800
> > Mason Yang <[email protected]> wrote:
> >
> > > Document the bindings used by the Macronix raw NAND controller.
> > >
> > > Signed-off-by: Mason Yang <[email protected]>
> > > ---
> > > Documentation/devicetree/bindings/mtd/mxic-nand.txt | 19
> +++++++++++++++++++
> > > 1 file changed, 19 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..de37d60
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/mtd/mxic-nand.txt
> > > @@ -0,0 +1,19 @@
> > > +Macronix Raw NAND Controller Device Tree Bindings
> > > +-------------------------------------------------
> > > +
> > > +Required properties:
> > > +- compatible: should be "mxicy,multi-itfc-v009-nand-morph"
> > > +- reg: should contain 1 entry for the registers
> > > +- interrupts: interrupt line connected to this raw NAND controller
> > > +- clock-names: should contain "ps", "send" and "send_dly"
> > > +- clocks: should contain 3 phandles for the "ps", "send" and
> > > + "send_dly" clocks
> > > +
> > > +Example:
> > > +
> > > + nand: nand-controller@43c30000 {
> > > + compatible = "mxicy,multi-itfc-v009-nand-morph";
> > > + reg = <0x43c30000 0x10000>;
> > > + clocks = <&clkwizard 0>, <&clkwizard 1>, <&clkc 15>;
> > > + clock-names = "send", "send_dly", "ps";
> >
> > You should have subnodes describing the NAND connected to the
> > controller (see [1]).
> >
> > [1]
> https://elixir.bootlin.com/linux/v5.3-rc2/source/Documentation/devicetree/
> > bindings/mtd/nand-controller.yaml#L131
> >
> > > + };
> >
>
> Do you mean to add patternProperties ?
>
> nand: nand-controller@43c30000 {
> compatible =
> "mxicy,multi-itfc-v009-nand-morph";
> reg = <0x43c30000 0x10000>;
> clocks = <&clkwizard 0>, <&clkwizard 1>,
> <&clkc 15>;
> clock-names = "send", "send_dly", "ps";
>
#address-cells = <1>;
#size-cells = <0>;
> + nand@0 {
> +
reg = <0>;
/* nand props here */
> + };
> };
>
> something like that.
Yes, something like that.