Documentation/devicetree/bindings/mtd/gpmi-nand.txt

   1 * Freescale General-Purpose Media Interface (GPMI)
   2
   3 The GPMI nand controller provides an interface to control the
   4 NAND flash chips.
   5
   6 Required properties:
   7   - compatible : should be "fsl,<chip>-gpmi-nand", chip can be:
   8     * imx23
   9     * imx28
  10     * imx6q
  11     * imx6sx
  12     * imx7d
  13   - reg : should contain registers location and length for gpmi and bch.
  14   - reg-names: Should contain the reg names "gpmi-nand" and "bch"
  15   - interrupts : BCH interrupt number.
  16   - interrupt-names : Should be "bch".
  17   - dmas: DMA specifier, consisting of a phandle to DMA controller node
  18     and GPMI DMA channel ID.
  19     Refer to dma.txt and fsl-mxs-dma.txt for details.
  20   - dma-names: Must be "rx-tx".
  21   - clocks : clocks phandle and clock specifier corresponding to each clock
  22     specified in clock-names.
  23   - clock-names : The "gpmi_io" clock is always required. Which clocks are
  24     exactly required depends on chip:
  25     * imx23/imx28 : "gpmi_io"
  26     * imx6q/sx : "gpmi_io", "gpmi_apb", "gpmi_bch", "gpmi_bch_apb", "per1_bch"
  27     * imx7d : "gpmi_io", "gpmi_bch_apb"
  28
  29 Optional properties:
  30   - nand-on-flash-bbt: boolean to enable on flash bbt option if not
  31                        present false
  32   - fsl,use-minimum-ecc: Protect this NAND flash with the minimum ECC
  33                        strength required. The required ECC strength is
  34                        automatically discoverable for some flash
  35                        (e.g., according to the ONFI standard).
  36                        However, note that if this strength is not
  37                        discoverable or this property is not enabled,
  38                        the software may chooses an implementation-defined
  39                        ECC scheme.
  40   - fsl,no-blockmark-swap: Don't swap the bad block marker from the OOB
  41                        area with the byte in the data area but rely on the
  42                        flash based BBT for identifying bad blocks.
  43                        NOTE: this is only valid in conjunction with
  44                              'nand-on-flash-bbt'.
  45                        WARNING: on i.MX28 blockmark swapping cannot be
  46                        disabled for the BootROM in the FCB. Thus,
  47                        partitions written from Linux with this feature
  48                        turned on may not be accessible by the BootROM
  49                        code.
  50
  51 The device tree may optionally contain sub-nodes describing partitions of the
  52 address space. See partition.txt for more detail.
  53
  54 Examples:
  55
  56 gpmi-nand@8000c000 {
  57         compatible = "fsl,imx28-gpmi-nand";
  58         #address-cells = <1>;
  59         #size-cells = <1>;
  60         reg = <0x8000c000 2000>, <0x8000a000 2000>;
  61         reg-names = "gpmi-nand", "bch";
  62         interrupts = <41>;
  63         interrupt-names = "bch";
  64         dmas = <&dma_apbh 4>;
  65         dma-names = "rx-tx";
  66
  67         partition@0 {
  68         ...
  69         };
  70 };