| Message ID | 1389190924-26226-7-git-send-email-b.brezillon@overkiz.com |
|---|---|
| State | Superseded |
| Headers | show |
On Wednesday 08 January 2014, Boris BREZILLON wrote: > --- /dev/null > +++ b/Documentation/devicetree/bindings/mtd/sunxi-nand.txt > @@ -0,0 +1,71 @@ > +Allwinner NAND Flash Controller (NFC) > + > +Required properties: > +- compatible : "allwinner,sun4i-nfc". > +- reg : shall contain registers location and length for data and reg. > +- interrupts : shall define the NFC interrupt. > +- #address-cells: shall be set to 1. Encode the nand CS. > +- #size-cells : shall be set to 0. > +- clocks : shall reference NFC clocks. > +- clock-names : NFC internal clock names. Shall contain : > + * "ahb_clk" : AHB gating clock > + * "sclk" : NFC clock > + One small request: Can we try to avoid the "NFC" name here? I think it's too overloaded and people may confuse it with near-field communication, which I'm sure will be supported in sunxi based devices at some point. It doesn't hurt to also mention that the function block is called nfc, but I think references to it are better named "nand", which is less confusing. Arnd
On 08/01/2014 22:28, Arnd Bergmann wrote: > On Wednesday 08 January 2014, Boris BREZILLON wrote: >> --- /dev/null >> +++ b/Documentation/devicetree/bindings/mtd/sunxi-nand.txt >> @@ -0,0 +1,71 @@ >> +Allwinner NAND Flash Controller (NFC) >> + >> +Required properties: >> +- compatible : "allwinner,sun4i-nfc". >> +- reg : shall contain registers location and length for data and reg. >> +- interrupts : shall define the NFC interrupt. >> +- #address-cells: shall be set to 1. Encode the nand CS. >> +- #size-cells : shall be set to 0. >> +- clocks : shall reference NFC clocks. >> +- clock-names : NFC internal clock names. Shall contain : >> + * "ahb_clk" : AHB gating clock >> + * "sclk" : NFC clock >> + > One small request: Can we try to avoid the "NFC" name here? I think it's > too overloaded and people may confuse it with near-field communication, > which I'm sure will be supported in sunxi based devices at some point. > > It doesn't hurt to also mention that the function block is called > nfc, but I think references to it are better named "nand", which is > less confusing. Sure, I'll remove references to the NFC acronym: - change compatible string to "allwinner,sun4i-nand" - avoid NFC references in the doc - rename the driver into sunxi-nand.c (formerly sunxi_nfc.c) Do you see any other references to this acronym ? Best Regards, Boris > Arnd
On Thursday 09 January 2014, boris brezillon wrote: > Sure, I'll remove references to the NFC acronym: > - change compatible string to "allwinner,sun4i-nand" > - avoid NFC references in the doc > - rename the driver into sunxi-nand.c (formerly sunxi_nfc.c) > > Do you see any other references to this acronym ? > Those are the important ones, thanks! Regarding the binding, I would mention nfc once there to help people that happen to look for that. Arnd
diff --git a/Documentation/devicetree/bindings/mtd/sunxi-nand.txt b/Documentation/devicetree/bindings/mtd/sunxi-nand.txt new file mode 100644 index 0000000..c3206fc --- /dev/null +++ b/Documentation/devicetree/bindings/mtd/sunxi-nand.txt @@ -0,0 +1,71 @@ +Allwinner NAND Flash Controller (NFC) + +Required properties: +- compatible : "allwinner,sun4i-nfc". +- reg : shall contain registers location and length for data and reg. +- interrupts : shall define the NFC interrupt. +- #address-cells: shall be set to 1. Encode the nand CS. +- #size-cells : shall be set to 0. +- clocks : shall reference NFC clocks. +- clock-names : NFC internal clock names. Shall contain : + * "ahb_clk" : AHB gating clock + * "sclk" : NFC clock + +Optional children nodes: +Children nodes represent the available nand chips. + +Required properties: +- reg : shall contain the CS ids (a given chip might use several CS) +- tCLS-min : see Documentation/devicetree/mtd/nand.txt +- tCLH-min : Documentation/devicetree/mtd/nand.txt +- tCS-min : see Documentation/devicetree/mtd/nand.txt +- tCH-min : see Documentation/devicetree/mtd/nand.txt +- tWP-min : see Documentation/devicetree/mtd/nand.txt +- tWH-min : see Documentation/devicetree/mtd/nand.txt +- tALS-min : see Documentation/devicetree/mtd/nand.txt +- tDS-min : see Documentation/devicetree/mtd/nand.txt +- tDH-min : see Documentation/devicetree/mtd/nand.txt +- tRR-min : see Documentation/devicetree/mtd/nand.txt +- tALH-min : see Documentation/devicetree/mtd/nand.txt +- tRP-min : see Documentation/devicetree/mtd/nand.txt +- tREH-min : see Documentation/devicetree/mtd/nand.txt +- tRC-min : see Documentation/devicetree/mtd/nand.txt +- tWC-min : see Documentation/devicetree/mtd/nand.txt + +Optional properties: +- allwinner,rb : shall contain the native Ready/Busy ids. + or +- rb-gpios : shall contain the gpios used as R/B pins. + +see Documentation/devicetree/mtd/nand.txt for generic bindings. + + +Examples: +nfc: nand@01c03000 { + pinctrl-names = "default"; + pinctrl-0 = <&nand_pins_a &nand_cs0_pins_a &nand_rb0_pins_a>; + status = "okay"; + + nand@0 { + reg = <0>; + allwinner,rb = <0>; + nand-ecc-mode = "soft_bch"; + + /* nand timings */ + tCLS-min = <6>; + tCLH-min = <3>; + tCS-min = <20>; + tCH-min = <5>; + tWP-min = <8>; + tWH-min = <6>; + tALS-min = <6>; + tDS-min = <6>; + tDH-min = <2>; + tRR-min = <20>; + tALH-min = <3>; + tRP-min = <8>; + tREH-min = <6>; + tRC-min = <16>; + tWC-min = <16>; + }; +};
Add the sunxi NAND Flash Controller dt bindings documentation. Signed-off-by: Boris BREZILLON <b.brezillon@overkiz.com> --- .../devicetree/bindings/mtd/sunxi-nand.txt | 71 ++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 Documentation/devicetree/bindings/mtd/sunxi-nand.txt