1 # SPDX-License-Identifier: (GPL-2.0-only OR BS 1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 %YAML 1.2 2 %YAML 1.2
3 --- 3 ---
4 $id: http://devicetree.org/schemas/mtd/nand-ch 4 $id: http://devicetree.org/schemas/mtd/nand-chip.yaml#
5 $schema: http://devicetree.org/meta-schemas/co 5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6 6
7 title: NAND Chip Common Properties !! 7 title: NAND Chip and NAND Controller Generic Binding
8 8
9 maintainers: 9 maintainers:
10 - Miquel Raynal <miquel.raynal@bootlin.com> 10 - Miquel Raynal <miquel.raynal@bootlin.com>
11 11
12 allOf: <<
13 - $ref: mtd.yaml# <<
14 <<
15 description: | 12 description: |
16 This file covers the generic description of 13 This file covers the generic description of a NAND chip. It implies that the
17 bus interface should not be taken into accou 14 bus interface should not be taken into account: both raw NAND devices and
18 SPI-NAND devices are concerned by this descr 15 SPI-NAND devices are concerned by this description.
19 16
20 properties: 17 properties:
21 reg: 18 reg:
22 description: 19 description:
23 Contains the chip-select IDs. 20 Contains the chip-select IDs.
24 21
25 nand-ecc-engine: 22 nand-ecc-engine:
26 description: | 23 description: |
27 A phandle on the hardware ECC engine if 24 A phandle on the hardware ECC engine if any. There are
28 basically three possibilities: 25 basically three possibilities:
29 1/ The ECC engine is part of the NAND co 26 1/ The ECC engine is part of the NAND controller, in this
30 case the phandle should reference the pa 27 case the phandle should reference the parent node.
31 2/ The ECC engine is part of the NAND pa 28 2/ The ECC engine is part of the NAND part (on-die), in this
32 case the phandle should reference the no 29 case the phandle should reference the node itself.
33 3/ The ECC engine is external, in this c 30 3/ The ECC engine is external, in this case the phandle should
34 reference the specific ECC engine node. 31 reference the specific ECC engine node.
35 $ref: /schemas/types.yaml#/definitions/pha 32 $ref: /schemas/types.yaml#/definitions/phandle
36 33
37 nand-use-soft-ecc-engine: 34 nand-use-soft-ecc-engine:
38 description: Use a software ECC engine. 35 description: Use a software ECC engine.
39 type: boolean 36 type: boolean
40 37
41 nand-no-ecc-engine: 38 nand-no-ecc-engine:
42 description: Do not use any ECC correction 39 description: Do not use any ECC correction.
43 type: boolean 40 type: boolean
44 41
45 nand-ecc-algo: 42 nand-ecc-algo:
46 description: 43 description:
47 Desired ECC algorithm. 44 Desired ECC algorithm.
48 $ref: /schemas/types.yaml#/definitions/str 45 $ref: /schemas/types.yaml#/definitions/string
49 enum: [hamming, bch, rs] 46 enum: [hamming, bch, rs]
50 47
51 nand-ecc-strength: 48 nand-ecc-strength:
52 description: 49 description:
53 Maximum number of bits that can be corre 50 Maximum number of bits that can be corrected per ECC step.
54 $ref: /schemas/types.yaml#/definitions/uin 51 $ref: /schemas/types.yaml#/definitions/uint32
55 minimum: 1 52 minimum: 1
56 53
57 nand-ecc-step-size: 54 nand-ecc-step-size:
58 description: 55 description:
59 Number of data bytes covered by a single 56 Number of data bytes covered by a single ECC step.
60 $ref: /schemas/types.yaml#/definitions/uin 57 $ref: /schemas/types.yaml#/definitions/uint32
61 minimum: 1 58 minimum: 1
62 59
63 secure-regions: 60 secure-regions:
64 description: 61 description:
65 Regions in the NAND chip which are prote 62 Regions in the NAND chip which are protected using a secure element
66 like Trustzone. This property contains t 63 like Trustzone. This property contains the start address and size of
67 the secure regions present. 64 the secure regions present.
68 $ref: /schemas/types.yaml#/definitions/uin 65 $ref: /schemas/types.yaml#/definitions/uint64-matrix
69 66
70 required: 67 required:
71 - reg 68 - reg
72 69
73 # This file can be referenced by more specific <<
74 additionalProperties: true 70 additionalProperties: true
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.