Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 8c6e7fd9 authored by Christophe Kerello's avatar Christophe Kerello Committed by Miquel Raynal
Browse files

dt-bindings: mtd: stm32_fmc2: add STM32 FMC2 NAND controller documentation 



This patch adds the documentation of the device tree bindings for the STM32
FMC2 NAND controller.

Signed-off-by: default avatarChristophe Kerello <christophe.kerello@st.com>
Reviewed-by: default avatarBoris Brezillon <boris.brezillon@bootlin.com>
Signed-off-by: default avatarMiquel Raynal <miquel.raynal@bootlin.com>
parent bfeffd15

Documentation/devicetree/bindings/mtd/stm32-fmc2-nand.txt

0 → 100644
+61 −0
Original line number Diff line number Diff line 
STMicroelectronics Flexible Memory Controller 2 (FMC2)

NAND Interface



Required properties:

- compatible: Should be one of:

              * st,stm32mp15-fmc2

- reg: NAND flash controller memory areas.

       First region contains the register location.

       Regions 2 to 4 respectively contain the data, command,

       and address space for CS0.

       Regions 5 to 7 contain the same areas for CS1.

- interrupts: The interrupt number

- pinctrl-0: Standard Pinctrl phandle (see: pinctrl/pinctrl-bindings.txt)

- clocks: The clock needed by the NAND flash controller



Optional properties:

- resets: Reference to a reset controller asserting the FMC controller

- dmas: DMA specifiers (see: dma/stm32-mdma.txt)

- dma-names: Must be "tx", "rx" and "ecc"



* NAND device bindings:



Required properties:

- reg: describes the CS lines assigned to the NAND device.



Optional properties:

- nand-on-flash-bbt: see nand.txt

- nand-ecc-strength: see nand.txt

- nand-ecc-step-size: see nand.txt



The following ECC strength and step size are currently supported:

 - nand-ecc-strength = <1>, nand-ecc-step-size = <512> (Hamming)

 - nand-ecc-strength = <4>, nand-ecc-step-size = <512> (BCH4)

 - nand-ecc-strength = <8>, nand-ecc-step-size = <512> (BCH8) (default)



Example:



	fmc: nand-controller@58002000 {

		compatible = "st,stm32mp15-fmc2";

		reg = <0x58002000 0x1000>,

		      <0x80000000 0x1000>,

		      <0x88010000 0x1000>,

		      <0x88020000 0x1000>,

		      <0x81000000 0x1000>,

		      <0x89010000 0x1000>,

		      <0x89020000 0x1000>;

		interrupts = <GIC_SPI 48 IRQ_TYPE_LEVEL_HIGH>;

		clocks = <&rcc FMC_K>;

		resets = <&rcc FMC_R>;

		pinctrl-names = "default";

		pinctrl-0 = <&fmc_pins_a>;

		#address-cells = <1>;

		#size-cells = <0>;



		nand@0 {

			reg = <0>;

			nand-on-flash-bbt;

			#address-cells = <1>;

			#size-cells = <1>;

		};

	};