dt: bindings: mtd: replace references to nand.txt with nand-controller.yaml
nand-controller.yaml replaced nand.txt however the references to it were
not updated. This change updates these references wherever it appears in
bindings documentation.
Fixes: 212e496935 ("dt-bindings: mtd: Add YAML schemas for the generic NAND options")
Signed-off-by: Kamal Dasu <kdasu.kdev@gmail.com>
Signed-off-by: Rob Herring <robh@kernel.org>
This commit is contained in:
Kamal Dasu
Rob Herring
parent
8d665693c2
commit
a5f2246fb9
|
|
@ -24,7 +24,7 @@ Optional children nodes:
|
||||||
Children nodes represent the available nand chips.
|
Children nodes represent the available nand chips.
|
||||||
|
|
||||||
Other properties:
|
Other properties:
|
||||||
see Documentation/devicetree/bindings/mtd/nand.txt for generic bindings.
|
see Documentation/devicetree/bindings/mtd/nand-controller.yaml for generic bindings.
|
||||||
|
|
||||||
Example demonstrate on AXG SoC:
|
Example demonstrate on AXG SoC:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -101,12 +101,12 @@ Required properties:
|
||||||
number (e.g., 0, 1, 2, etc.)
|
number (e.g., 0, 1, 2, etc.)
|
||||||
- #address-cells : see partition.txt
|
- #address-cells : see partition.txt
|
||||||
- #size-cells : see partition.txt
|
- #size-cells : see partition.txt
|
||||||
- nand-ecc-strength : see nand.txt
|
- nand-ecc-strength : see nand-controller.yaml
|
||||||
- nand-ecc-step-size : must be 512 or 1024. See nand.txt
|
- nand-ecc-step-size : must be 512 or 1024. See nand-controller.yaml
|
||||||
|
|
||||||
Optional properties:
|
Optional properties:
|
||||||
- nand-on-flash-bbt : boolean, to enable the on-flash BBT for this
|
- nand-on-flash-bbt : boolean, to enable the on-flash BBT for this
|
||||||
chip-select. See nand.txt
|
chip-select. See nand-controller.yaml
|
||||||
- brcm,nand-oob-sector-size : integer, to denote the spare area sector size
|
- brcm,nand-oob-sector-size : integer, to denote the spare area sector size
|
||||||
expected for the ECC layout in use. This size, in
|
expected for the ECC layout in use. This size, in
|
||||||
addition to the strength and step-size,
|
addition to the strength and step-size,
|
||||||
|
|
|
||||||
|
|
@ -22,16 +22,16 @@ Sub-nodes:
|
||||||
select is connected.
|
select is connected.
|
||||||
|
|
||||||
Optional properties:
|
Optional properties:
|
||||||
- nand-ecc-step-size: see nand.txt for details.
|
- nand-ecc-step-size: see nand-controller.yaml for details.
|
||||||
If present, the value must be
|
If present, the value must be
|
||||||
512 for "altr,socfpga-denali-nand"
|
512 for "altr,socfpga-denali-nand"
|
||||||
1024 for "socionext,uniphier-denali-nand-v5a"
|
1024 for "socionext,uniphier-denali-nand-v5a"
|
||||||
1024 for "socionext,uniphier-denali-nand-v5b"
|
1024 for "socionext,uniphier-denali-nand-v5b"
|
||||||
- nand-ecc-strength: see nand.txt for details. Valid values are:
|
- nand-ecc-strength: see nand-controller.yaml for details. Valid values are:
|
||||||
8, 15 for "altr,socfpga-denali-nand"
|
8, 15 for "altr,socfpga-denali-nand"
|
||||||
8, 16, 24 for "socionext,uniphier-denali-nand-v5a"
|
8, 16, 24 for "socionext,uniphier-denali-nand-v5a"
|
||||||
8, 16 for "socionext,uniphier-denali-nand-v5b"
|
8, 16 for "socionext,uniphier-denali-nand-v5b"
|
||||||
- nand-ecc-maximize: see nand.txt for details
|
- nand-ecc-maximize: see nand-controller.yaml for details
|
||||||
|
|
||||||
The chip nodes may optionally contain sub-nodes describing partitions of the
|
The chip nodes may optionally contain sub-nodes describing partitions of the
|
||||||
address space. See partition.txt for more detail.
|
address space. See partition.txt for more detail.
|
||||||
|
|
|
||||||
|
|
@ -30,9 +30,9 @@ Optional properties:
|
||||||
command is asserted. Zero means one cycle, 255 means 256
|
command is asserted. Zero means one cycle, 255 means 256
|
||||||
cycles.
|
cycles.
|
||||||
- bank: default NAND bank to use (0-3 are valid, 0 is the default).
|
- bank: default NAND bank to use (0-3 are valid, 0 is the default).
|
||||||
- nand-ecc-mode : see nand.txt
|
- nand-ecc-mode : see nand-controller.yaml
|
||||||
- nand-ecc-strength : see nand.txt
|
- nand-ecc-strength : see nand-controller.yaml
|
||||||
- nand-ecc-step-size : see nand.txt
|
- nand-ecc-step-size : see nand-controller.yaml
|
||||||
|
|
||||||
Can support 1-bit HW ECC (default) or if stronger correction is required,
|
Can support 1-bit HW ECC (default) or if stronger correction is required,
|
||||||
software-based BCH.
|
software-based BCH.
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ explained in a separate documents - please refer to
|
||||||
Documentation/devicetree/bindings/memory-controllers/omap-gpmc.txt
|
Documentation/devicetree/bindings/memory-controllers/omap-gpmc.txt
|
||||||
|
|
||||||
For NAND specific properties such as ECC modes or bus width, please refer to
|
For NAND specific properties such as ECC modes or bus width, please refer to
|
||||||
Documentation/devicetree/bindings/mtd/nand.txt
|
Documentation/devicetree/bindings/mtd/nand-controller.yaml
|
||||||
|
|
||||||
|
|
||||||
Required properties:
|
Required properties:
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,7 @@ Required properties:
|
||||||
NAND controller's registers. The second contains base
|
NAND controller's registers. The second contains base
|
||||||
physical address and size of NAND controller's buffer.
|
physical address and size of NAND controller's buffer.
|
||||||
- interrupts: Interrupt number for nfc.
|
- interrupts: Interrupt number for nfc.
|
||||||
- nand-bus-width: See nand.txt.
|
- nand-bus-width: See nand-controller.yaml.
|
||||||
- nand-ecc-mode: Support none and hw ecc mode.
|
- nand-ecc-mode: Support none and hw ecc mode.
|
||||||
- #address-cells: Partition address, should be set 1.
|
- #address-cells: Partition address, should be set 1.
|
||||||
- #size-cells: Partition size, should be set 1.
|
- #size-cells: Partition size, should be set 1.
|
||||||
|
|
|
||||||
|
|
@ -36,29 +36,29 @@ Children nodes represent the available NAND chips.
|
||||||
|
|
||||||
Required properties:
|
Required properties:
|
||||||
- reg: shall contain the native Chip Select ids (0-3).
|
- reg: shall contain the native Chip Select ids (0-3).
|
||||||
- nand-rb: see nand.txt (0-1).
|
- nand-rb: see nand-controller.yaml (0-1).
|
||||||
|
|
||||||
Optional properties:
|
Optional properties:
|
||||||
- marvell,nand-keep-config: orders the driver not to take the timings
|
- marvell,nand-keep-config: orders the driver not to take the timings
|
||||||
from the core and leaving them completely untouched. Bootloader
|
from the core and leaving them completely untouched. Bootloader
|
||||||
timings will then be used.
|
timings will then be used.
|
||||||
- label: MTD name.
|
- label: MTD name.
|
||||||
- nand-on-flash-bbt: see nand.txt.
|
- nand-on-flash-bbt: see nand-controller.yaml.
|
||||||
- nand-ecc-mode: see nand.txt. Will use hardware ECC if not specified.
|
- nand-ecc-mode: see nand-controller.yaml. Will use hardware ECC if not specified.
|
||||||
- nand-ecc-algo: see nand.txt. This property is essentially useful when
|
- nand-ecc-algo: see nand-controller.yaml. This property is essentially useful when
|
||||||
not using hardware ECC. Howerver, it may be added when using hardware
|
not using hardware ECC. Howerver, it may be added when using hardware
|
||||||
ECC for clarification but will be ignored by the driver because ECC
|
ECC for clarification but will be ignored by the driver because ECC
|
||||||
mode is chosen depending on the page size and the strength required by
|
mode is chosen depending on the page size and the strength required by
|
||||||
the NAND chip. This value may be overwritten with nand-ecc-strength
|
the NAND chip. This value may be overwritten with nand-ecc-strength
|
||||||
property.
|
property.
|
||||||
- nand-ecc-strength: see nand.txt.
|
- nand-ecc-strength: see nand-controller.yaml.
|
||||||
- nand-ecc-step-size: see nand.txt. Marvell's NAND flash controller does
|
- nand-ecc-step-size: see nand-controller.yaml. Marvell's NAND flash controller does
|
||||||
use fixed strength (1-bit for Hamming, 16-bit for BCH), so the actual
|
use fixed strength (1-bit for Hamming, 16-bit for BCH), so the actual
|
||||||
step size will shrink or grow in order to fit the required strength.
|
step size will shrink or grow in order to fit the required strength.
|
||||||
Step sizes are not completely random for all and follow certain
|
Step sizes are not completely random for all and follow certain
|
||||||
patterns described in AN-379, "Marvell SoC NFC ECC".
|
patterns described in AN-379, "Marvell SoC NFC ECC".
|
||||||
|
|
||||||
See Documentation/devicetree/bindings/mtd/nand.txt for more details on
|
See Documentation/devicetree/bindings/mtd/nand-controller.yaml for more details on
|
||||||
generic bindings.
|
generic bindings.
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4,9 +4,9 @@ Required properties:
|
||||||
- compatible: "fsl,imxXX-nand"
|
- compatible: "fsl,imxXX-nand"
|
||||||
- reg: address range of the nfc block
|
- reg: address range of the nfc block
|
||||||
- interrupts: irq to be used
|
- interrupts: irq to be used
|
||||||
- nand-bus-width: see nand.txt
|
- nand-bus-width: see nand-controller.yaml
|
||||||
- nand-ecc-mode: see nand.txt
|
- nand-ecc-mode: see nand-controller.yaml
|
||||||
- nand-on-flash-bbt: see nand.txt
|
- nand-on-flash-bbt: see nand-controller.yaml
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -26,14 +26,14 @@ Optional children node properties:
|
||||||
"hw" is supported.
|
"hw" is supported.
|
||||||
- nand-ecc-algo: string, algorithm of NAND ECC.
|
- nand-ecc-algo: string, algorithm of NAND ECC.
|
||||||
Supported values with "hw" ECC mode are: "rs", "bch".
|
Supported values with "hw" ECC mode are: "rs", "bch".
|
||||||
- nand-bus-width : See nand.txt
|
- nand-bus-width : See nand-controller.yaml
|
||||||
- nand-on-flash-bbt: See nand.txt
|
- nand-on-flash-bbt: See nand-controller.yaml
|
||||||
- nand-ecc-strength: integer representing the number of bits to correct
|
- nand-ecc-strength: integer representing the number of bits to correct
|
||||||
per ECC step (always 512). Supported strength using HW ECC
|
per ECC step (always 512). Supported strength using HW ECC
|
||||||
modes are:
|
modes are:
|
||||||
- RS: 4, 6, 8
|
- RS: 4, 6, 8
|
||||||
- BCH: 4, 8, 14, 16
|
- BCH: 4, 8, 14, 16
|
||||||
- nand-ecc-maximize: See nand.txt
|
- nand-ecc-maximize: See nand-controller.yaml
|
||||||
- nand-is-boot-medium: Makes sure only ECC strengths supported by the boot ROM
|
- nand-is-boot-medium: Makes sure only ECC strengths supported by the boot ROM
|
||||||
are chosen.
|
are chosen.
|
||||||
- wp-gpios: GPIO specifier for the write protect pin.
|
- wp-gpios: GPIO specifier for the write protect pin.
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
* Oxford Semiconductor OXNAS NAND Controller
|
* Oxford Semiconductor OXNAS NAND Controller
|
||||||
|
|
||||||
Please refer to nand.txt for generic information regarding MTD NAND bindings.
|
Please refer to nand-controller.yaml for generic information regarding MTD NAND bindings.
|
||||||
|
|
||||||
Required properties:
|
Required properties:
|
||||||
- compatible: "oxsemi,ox820-nand"
|
- compatible: "oxsemi,ox820-nand"
|
||||||
|
|
|
||||||
|
|
@ -47,8 +47,8 @@ Required properties:
|
||||||
- #size-cells: see partition.txt
|
- #size-cells: see partition.txt
|
||||||
|
|
||||||
Optional properties:
|
Optional properties:
|
||||||
- nand-bus-width: see nand.txt
|
- nand-bus-width: see nand-controller.yaml
|
||||||
- nand-ecc-strength: see nand.txt. If not specified, then ECC strength will
|
- nand-ecc-strength: see nand-controller.yaml. If not specified, then ECC strength will
|
||||||
be used according to chip requirement and available
|
be used according to chip requirement and available
|
||||||
OOB size.
|
OOB size.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -6,7 +6,7 @@ Required properties:
|
||||||
"samsung,s3c2412-nand"
|
"samsung,s3c2412-nand"
|
||||||
"samsung,s3c2440-nand"
|
"samsung,s3c2440-nand"
|
||||||
- reg : register's location and length.
|
- reg : register's location and length.
|
||||||
- #address-cells, #size-cells : see nand.txt
|
- #address-cells, #size-cells : see nand-controller.yaml
|
||||||
- clocks : phandle to the nand controller clock
|
- clocks : phandle to the nand controller clock
|
||||||
- clock-names : must contain "nand"
|
- clock-names : must contain "nand"
|
||||||
|
|
||||||
|
|
@ -14,8 +14,8 @@ Optional child nodes:
|
||||||
Child nodes representing the available nand chips.
|
Child nodes representing the available nand chips.
|
||||||
|
|
||||||
Optional child properties:
|
Optional child properties:
|
||||||
- nand-ecc-mode : see nand.txt
|
- nand-ecc-mode : see nand-controller.yaml
|
||||||
- nand-on-flash-bbt : see nand.txt
|
- nand-on-flash-bbt : see nand-controller.yaml
|
||||||
|
|
||||||
Each child device node may optionally contain a 'partitions' sub-node,
|
Each child device node may optionally contain a 'partitions' sub-node,
|
||||||
which further contains sub-nodes describing the flash partition mapping.
|
which further contains sub-nodes describing the flash partition mapping.
|
||||||
|
|
|
||||||
|
|
@ -24,9 +24,9 @@ Required properties:
|
||||||
- reg: describes the CS lines assigned to the NAND device.
|
- reg: describes the CS lines assigned to the NAND device.
|
||||||
|
|
||||||
Optional properties:
|
Optional properties:
|
||||||
- nand-on-flash-bbt: see nand.txt
|
- nand-on-flash-bbt: see nand-controller.yaml
|
||||||
- nand-ecc-strength: see nand.txt
|
- nand-ecc-strength: see nand-controller.yaml
|
||||||
- nand-ecc-step-size: see nand.txt
|
- nand-ecc-step-size: see nand-controller.yaml
|
||||||
|
|
||||||
The following ECC strength and step size are currently supported:
|
The following ECC strength and step size are currently supported:
|
||||||
- nand-ecc-strength = <1>, nand-ecc-step-size = <512> (Hamming)
|
- nand-ecc-strength = <1>, nand-ecc-step-size = <512> (Hamming)
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,7 @@ Required properties:
|
||||||
- #size-cells: <0>
|
- #size-cells: <0>
|
||||||
|
|
||||||
Children nodes represent the available NAND chips.
|
Children nodes represent the available NAND chips.
|
||||||
See Documentation/devicetree/bindings/mtd/nand.txt for generic bindings.
|
See Documentation/devicetree/bindings/mtd/nand-controller.yaml for generic bindings.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -25,14 +25,14 @@ only handle one NAND chip.
|
||||||
|
|
||||||
Required properties:
|
Required properties:
|
||||||
- compatible: Should be set to "fsl,vf610-nfc-cs".
|
- compatible: Should be set to "fsl,vf610-nfc-cs".
|
||||||
- nand-bus-width: see nand.txt
|
- nand-bus-width: see nand-controller.yaml
|
||||||
- nand-ecc-mode: see nand.txt
|
- nand-ecc-mode: see nand-controller.yaml
|
||||||
|
|
||||||
Required properties for hardware ECC:
|
Required properties for hardware ECC:
|
||||||
- nand-ecc-strength: supported strengths are 24 and 32 bit (see nand.txt)
|
- nand-ecc-strength: supported strengths are 24 and 32 bit (see nand-controller.yaml)
|
||||||
- nand-ecc-step-size: step size equals page size, currently only 2k pages are
|
- nand-ecc-step-size: step size equals page size, currently only 2k pages are
|
||||||
supported
|
supported
|
||||||
- nand-on-flash-bbt: see nand.txt
|
- nand-on-flash-bbt: see nand-controller.yaml
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue