dt-bindings: mtd: Convert mtd-physmap to DT schema
Convert the mtd-physmap binding to DT schema format. The arm-versatile, cypress,hyperflash and intel,ixp4xx-flash are all just an additional compatible string, so they are all merged into the main schema. There doesn't appear to be any users nor support for 'vendor-id' and 'device-id', so these have been dropped. Cc: Linus Walleij <linus.walleij@linaro.org> Cc: Miquel Raynal <miquel.raynal@bootlin.com> Cc: Richard Weinberger <richard@nod.at> Cc: Vignesh Raghavendra <vigneshr@ti.com> Cc: linux-mtd@lists.infradead.org Signed-off-by: Rob Herring <robh@kernel.org> Reviewed-by: Linus Walleij <linus.walleij@linaro.org> Reviewed-by: Miquel Raynal <miquel.raynal@bootlin.com> Link: https://lore.kernel.org/r/20210607193500.3085920-1-robh@kernel.org
This commit is contained in:
Rob Herring
parent
13542a69b9
commit
63f8e9e0ac
@ -1,26 +0,0 @@
|
|||||||
Flash device on ARM Versatile board
|
|
||||||
|
|
||||||
These flash chips are found in the ARM reference designs like Integrator,
|
|
||||||
Versatile, RealView, Versatile Express etc.
|
|
||||||
|
|
||||||
They are regular CFI compatible (Intel or AMD extended) flash chips with
|
|
||||||
some special write protect/VPP bits that can be controlled by the machine's
|
|
||||||
system controller.
|
|
||||||
|
|
||||||
Required properties:
|
|
||||||
- compatible : must be "arm,versatile-flash", "cfi-flash";
|
|
||||||
- reg : memory address for the flash chip
|
|
||||||
- bank-width : width in bytes of flash interface.
|
|
||||||
|
|
||||||
For the rest of the properties, see mtd-physmap.txt.
|
|
||||||
|
|
||||||
The device tree may optionally contain sub-nodes describing partitions of the
|
|
||||||
address space. See partition.txt for more detail.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
flash@34000000 {
|
|
||||||
compatible = "arm,versatile-flash", "cfi-flash";
|
|
||||||
reg = <0x34000000 0x4000000>;
|
|
||||||
bank-width = <4>;
|
|
||||||
};
|
|
||||||
@ -9,7 +9,7 @@ Required properties:
|
|||||||
- syscon : must be a phandle to the system controller
|
- syscon : must be a phandle to the system controller
|
||||||
- bank-width : width in bytes of flash interface, should be <2>
|
- bank-width : width in bytes of flash interface, should be <2>
|
||||||
|
|
||||||
For the rest of the properties, see mtd-physmap.txt.
|
For the rest of the properties, see mtd-physmap.yaml.
|
||||||
|
|
||||||
The device tree may optionally contain sub-nodes describing partitions of the
|
The device tree 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.
|
||||||
|
|||||||
@ -1,13 +0,0 @@
|
|||||||
Bindings for HyperFlash NOR flash chips compliant with Cypress HyperBus
|
|
||||||
specification and supports Cypress CFI specification 1.5 command set.
|
|
||||||
|
|
||||||
Required properties:
|
|
||||||
- compatible : "cypress,hyperflash", "cfi-flash" for HyperFlash NOR chips
|
|
||||||
- reg : Address of flash's memory map
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
flash@0 {
|
|
||||||
compatible = "cypress,hyperflash", "cfi-flash";
|
|
||||||
reg = <0x0 0x4000000>;
|
|
||||||
};
|
|
||||||
@ -1,22 +0,0 @@
|
|||||||
Flash device on Intel IXP4xx SoC
|
|
||||||
|
|
||||||
This flash is regular CFI compatible (Intel or AMD extended) flash chips with
|
|
||||||
specific big-endian or mixed-endian memory access pattern.
|
|
||||||
|
|
||||||
Required properties:
|
|
||||||
- compatible : must be "intel,ixp4xx-flash", "cfi-flash";
|
|
||||||
- reg : memory address for the flash chip
|
|
||||||
- bank-width : width in bytes of flash interface, should be <2>
|
|
||||||
|
|
||||||
For the rest of the properties, see mtd-physmap.txt.
|
|
||||||
|
|
||||||
The device tree may optionally contain sub-nodes describing partitions of the
|
|
||||||
address space. See partition.txt for more detail.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
flash@50000000 {
|
|
||||||
compatible = "intel,ixp4xx-flash", "cfi-flash";
|
|
||||||
reg = <0x50000000 0x01000000>;
|
|
||||||
bank-width = <2>;
|
|
||||||
};
|
|
||||||
@ -1,114 +0,0 @@
|
|||||||
CFI or JEDEC memory-mapped NOR flash, MTD-RAM (NVRAM...)
|
|
||||||
|
|
||||||
Flash chips (Memory Technology Devices) are often used for solid state
|
|
||||||
file systems on embedded devices.
|
|
||||||
|
|
||||||
- compatible : should contain the specific model of mtd chip(s)
|
|
||||||
used, if known, followed by either "cfi-flash", "jedec-flash",
|
|
||||||
"mtd-ram" or "mtd-rom".
|
|
||||||
- reg : Address range(s) of the mtd chip(s)
|
|
||||||
It's possible to (optionally) define multiple "reg" tuples so that
|
|
||||||
non-identical chips can be described in one node.
|
|
||||||
- bank-width : Width (in bytes) of the bank. Equal to the
|
|
||||||
device width times the number of interleaved chips.
|
|
||||||
- device-width : (optional) Width of a single mtd chip. If
|
|
||||||
omitted, assumed to be equal to 'bank-width'.
|
|
||||||
- #address-cells, #size-cells : Must be present if the device has
|
|
||||||
sub-nodes representing partitions (see below). In this case
|
|
||||||
both #address-cells and #size-cells must be equal to 1.
|
|
||||||
- no-unaligned-direct-access: boolean to disable the default direct
|
|
||||||
mapping of the flash.
|
|
||||||
On some platforms (e.g. MPC5200) a direct 1:1 mapping may cause
|
|
||||||
problems with JFFS2 usage, as the local bus (LPB) doesn't support
|
|
||||||
unaligned accesses as implemented in the JFFS2 code via memcpy().
|
|
||||||
By defining "no-unaligned-direct-access", the flash will not be
|
|
||||||
exposed directly to the MTD users (e.g. JFFS2) any more.
|
|
||||||
- linux,mtd-name: allow to specify the mtd name for retro capability with
|
|
||||||
physmap-flash drivers as boot loader pass the mtd partition via the old
|
|
||||||
device name physmap-flash.
|
|
||||||
- use-advanced-sector-protection: boolean to enable support for the
|
|
||||||
advanced sector protection (Spansion: PPB - Persistent Protection
|
|
||||||
Bits) locking.
|
|
||||||
- addr-gpios : (optional) List of GPIO descriptors that will be used to
|
|
||||||
address the MSBs address lines. The order goes from LSB to MSB.
|
|
||||||
|
|
||||||
For JEDEC compatible devices, the following additional properties
|
|
||||||
are defined:
|
|
||||||
|
|
||||||
- vendor-id : Contains the flash chip's vendor id (1 byte).
|
|
||||||
- device-id : Contains the flash chip's device id (1 byte).
|
|
||||||
|
|
||||||
For ROM compatible devices (and ROM fallback from cfi-flash), the following
|
|
||||||
additional (optional) property is defined:
|
|
||||||
|
|
||||||
- erase-size : The chip's physical erase block size in bytes.
|
|
||||||
|
|
||||||
The device tree may optionally contain endianness property.
|
|
||||||
little-endian or big-endian : It Represents the endianness that should be used
|
|
||||||
by the controller to properly read/write data
|
|
||||||
from/to the flash. If this property is missing,
|
|
||||||
the endianness is chosen by the system
|
|
||||||
(potentially based on extra configuration options).
|
|
||||||
|
|
||||||
The device tree may optionally contain sub-nodes describing partitions of the
|
|
||||||
address space. See partition.txt for more detail.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
flash@ff000000 {
|
|
||||||
compatible = "amd,am29lv128ml", "cfi-flash";
|
|
||||||
reg = <ff000000 01000000>;
|
|
||||||
bank-width = <4>;
|
|
||||||
device-width = <1>;
|
|
||||||
#address-cells = <1>;
|
|
||||||
#size-cells = <1>;
|
|
||||||
fs@0 {
|
|
||||||
label = "fs";
|
|
||||||
reg = <0 f80000>;
|
|
||||||
};
|
|
||||||
firmware@f80000 {
|
|
||||||
label ="firmware";
|
|
||||||
reg = <f80000 80000>;
|
|
||||||
read-only;
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
Here an example with multiple "reg" tuples:
|
|
||||||
|
|
||||||
flash@f0000000,0 {
|
|
||||||
#address-cells = <1>;
|
|
||||||
#size-cells = <1>;
|
|
||||||
compatible = "intel,PC48F4400P0VB", "cfi-flash";
|
|
||||||
reg = <0 0x00000000 0x02000000
|
|
||||||
0 0x02000000 0x02000000>;
|
|
||||||
bank-width = <2>;
|
|
||||||
partition@0 {
|
|
||||||
label = "test-part1";
|
|
||||||
reg = <0 0x04000000>;
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
An example using SRAM:
|
|
||||||
|
|
||||||
sram@2,0 {
|
|
||||||
compatible = "samsung,k6f1616u6a", "mtd-ram";
|
|
||||||
reg = <2 0 0x00200000>;
|
|
||||||
bank-width = <2>;
|
|
||||||
};
|
|
||||||
|
|
||||||
An example using gpio-addrs
|
|
||||||
|
|
||||||
flash@20000000 {
|
|
||||||
#address-cells = <1>;
|
|
||||||
#size-cells = <1>;
|
|
||||||
compatible = "cfi-flash", "jedec-flash";
|
|
||||||
reg = <0x20000000 0x02000000>;
|
|
||||||
ranges = <0 0x00000000 0x02000000
|
|
||||||
1 0x02000000 0x02000000>;
|
|
||||||
bank-width = <2>;
|
|
||||||
addr-gpios = <&gpio1 2 GPIO_ACTIVE_HIGH>;
|
|
||||||
partition@0 {
|
|
||||||
label = "test-part1";
|
|
||||||
reg = <0 0x04000000>;
|
|
||||||
};
|
|
||||||
};
|
|
||||||
208
Documentation/devicetree/bindings/mtd/mtd-physmap.yaml
Normal file
208
Documentation/devicetree/bindings/mtd/mtd-physmap.yaml
Normal file
@ -0,0 +1,208 @@
|
|||||||
|
# SPDX-License-Identifier: GPL-2.0
|
||||||
|
%YAML 1.2
|
||||||
|
---
|
||||||
|
$id: http://devicetree.org/schemas/mtd/mtd-physmap.yaml#
|
||||||
|
$schema: http://devicetree.org/meta-schemas/core.yaml#
|
||||||
|
|
||||||
|
title: CFI or JEDEC memory-mapped NOR flash, MTD-RAM (NVRAM...)
|
||||||
|
|
||||||
|
maintainers:
|
||||||
|
- Rob Herring <robh@kernel.org>
|
||||||
|
|
||||||
|
description: |
|
||||||
|
Flash chips (Memory Technology Devices) are often used for solid state
|
||||||
|
file systems on embedded devices.
|
||||||
|
|
||||||
|
properties:
|
||||||
|
compatible:
|
||||||
|
oneOf:
|
||||||
|
- items:
|
||||||
|
- enum:
|
||||||
|
- amd,s29gl01gp
|
||||||
|
- amd,s29gl032a
|
||||||
|
- amd,s29gl256n
|
||||||
|
- amd,s29gl512n
|
||||||
|
- arm,versatile-flash
|
||||||
|
- cortina,gemini-flash
|
||||||
|
- cypress,hyperflash
|
||||||
|
- ge,imp3a-firmware-mirror
|
||||||
|
- ge,imp3a-paged-flash
|
||||||
|
- gef,ppc9a-firmware-mirror
|
||||||
|
- gef,ppc9a-paged-flash
|
||||||
|
- gef,sbc310-firmware-mirror
|
||||||
|
- gef,sbc310-paged-flash
|
||||||
|
- gef,sbc610-firmware-mirror
|
||||||
|
- gef,sbc610-paged-flash
|
||||||
|
- intel,28f128j3
|
||||||
|
- intel,dt28f160
|
||||||
|
- intel,ixp4xx-flash
|
||||||
|
- intel,JS28F128
|
||||||
|
- intel,JS28F640
|
||||||
|
- intel,PC28F640P30T85
|
||||||
|
- numonyx,js28f00a
|
||||||
|
- numonyx,js28f128
|
||||||
|
- sst,sst39vf320
|
||||||
|
- xlnx,xps-mch-emc-2.00.a
|
||||||
|
- const: cfi-flash
|
||||||
|
- items:
|
||||||
|
- enum:
|
||||||
|
- cypress,cy7c1019dv33-10zsxi
|
||||||
|
- arm,vexpress-psram
|
||||||
|
- const: mtd-ram
|
||||||
|
- enum:
|
||||||
|
- cfi-flash
|
||||||
|
- jedec-flash
|
||||||
|
- mtd-ram
|
||||||
|
- mtd-rom
|
||||||
|
|
||||||
|
reg:
|
||||||
|
description: |
|
||||||
|
It's possible to (optionally) define multiple "reg" tuples so that
|
||||||
|
non-identical chips can be described in one node.
|
||||||
|
minItems: 1
|
||||||
|
maxItems: 8
|
||||||
|
|
||||||
|
bank-width:
|
||||||
|
description: Width (in bytes) of the bank. Equal to the device width times
|
||||||
|
the number of interleaved chips.
|
||||||
|
$ref: /schemas/types.yaml#/definitions/uint32
|
||||||
|
enum: [ 1, 2, 4 ]
|
||||||
|
|
||||||
|
device-width:
|
||||||
|
description:
|
||||||
|
Width of a single mtd chip. If omitted, assumed to be equal to 'bank-width'.
|
||||||
|
$ref: /schemas/types.yaml#/definitions/uint32
|
||||||
|
enum: [ 1, 2 ]
|
||||||
|
|
||||||
|
no-unaligned-direct-access:
|
||||||
|
type: boolean
|
||||||
|
description: |
|
||||||
|
Disables the default direct mapping of the flash.
|
||||||
|
|
||||||
|
On some platforms (e.g. MPC5200) a direct 1:1 mapping may cause problems
|
||||||
|
with JFFS2 usage, as the local bus (LPB) doesn't support unaligned
|
||||||
|
accesses as implemented in the JFFS2 code via memcpy(). By defining
|
||||||
|
"no-unaligned-direct-access", the flash will not be exposed directly to
|
||||||
|
the MTD users (e.g. JFFS2) any more.
|
||||||
|
|
||||||
|
linux,mtd-name:
|
||||||
|
description:
|
||||||
|
Allows specifying the mtd name for retro capability with physmap-flash
|
||||||
|
drivers as boot loader pass the mtd partition via the old device name
|
||||||
|
physmap-flash.
|
||||||
|
$ref: /schemas/types.yaml#/definitions/string
|
||||||
|
|
||||||
|
use-advanced-sector-protection:
|
||||||
|
type: boolean
|
||||||
|
description: |
|
||||||
|
Enables support for the advanced sector protection (Spansion: PPB -
|
||||||
|
Persistent Protection Bits) locking.
|
||||||
|
|
||||||
|
erase-size:
|
||||||
|
description: The chip's physical erase block size in bytes.
|
||||||
|
$ref: /schemas/types.yaml#/definitions/uint32
|
||||||
|
|
||||||
|
addr-gpios:
|
||||||
|
description:
|
||||||
|
List of GPIO descriptors that will be used to address the MSBs address
|
||||||
|
lines. The order goes from LSB to MSB.
|
||||||
|
minItems: 1
|
||||||
|
maxItems: 8
|
||||||
|
|
||||||
|
'#address-cells':
|
||||||
|
const: 1
|
||||||
|
|
||||||
|
'#size-cells':
|
||||||
|
const: 1
|
||||||
|
|
||||||
|
big-endian: true
|
||||||
|
little-endian: true
|
||||||
|
|
||||||
|
patternProperties:
|
||||||
|
'@[0-9a-f]+$':
|
||||||
|
$ref: partitions/partition.yaml
|
||||||
|
|
||||||
|
required:
|
||||||
|
- compatible
|
||||||
|
- reg
|
||||||
|
|
||||||
|
# FIXME: A parent bus may define timing properties
|
||||||
|
additionalProperties: true
|
||||||
|
|
||||||
|
examples:
|
||||||
|
- |
|
||||||
|
|
||||||
|
flash@ff000000 {
|
||||||
|
compatible = "cfi-flash";
|
||||||
|
reg = <0xff000000 0x01000000>;
|
||||||
|
bank-width = <4>;
|
||||||
|
device-width = <1>;
|
||||||
|
|
||||||
|
#address-cells = <1>;
|
||||||
|
#size-cells = <1>;
|
||||||
|
ranges = <0 0xff000000 0x01000000>;
|
||||||
|
|
||||||
|
fs@0 {
|
||||||
|
label = "fs";
|
||||||
|
reg = <0 0xf80000>;
|
||||||
|
};
|
||||||
|
firmware@f80000 {
|
||||||
|
label ="firmware";
|
||||||
|
reg = <0xf80000 0x80000>;
|
||||||
|
read-only;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
- |
|
||||||
|
/* An example with multiple "reg" tuples */
|
||||||
|
|
||||||
|
flash@0 {
|
||||||
|
compatible = "intel,PC28F640P30T85", "cfi-flash";
|
||||||
|
reg = <0x00000000 0x02000000>,
|
||||||
|
<0x02000000 0x02000000>;
|
||||||
|
bank-width = <2>;
|
||||||
|
|
||||||
|
#address-cells = <1>;
|
||||||
|
#size-cells = <1>;
|
||||||
|
ranges = <0 0 0x04000000>;
|
||||||
|
|
||||||
|
partition@0 {
|
||||||
|
label = "test-part1";
|
||||||
|
reg = <0 0x04000000>;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
- |
|
||||||
|
/* An example using SRAM */
|
||||||
|
bus {
|
||||||
|
#address-cells = <2>;
|
||||||
|
#size-cells = <1>;
|
||||||
|
|
||||||
|
sram@2,0 {
|
||||||
|
compatible = "mtd-ram";
|
||||||
|
reg = <2 0 0x00200000>;
|
||||||
|
bank-width = <2>;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
- |
|
||||||
|
/* An example using addr-gpios */
|
||||||
|
#include <dt-bindings/gpio/gpio.h>
|
||||||
|
|
||||||
|
flash@20000000 {
|
||||||
|
compatible = "cfi-flash";
|
||||||
|
reg = <0x20000000 0x02000000>;
|
||||||
|
bank-width = <2>;
|
||||||
|
addr-gpios = <&gpio1 2 GPIO_ACTIVE_HIGH>;
|
||||||
|
|
||||||
|
#address-cells = <1>;
|
||||||
|
#size-cells = <1>;
|
||||||
|
ranges = <0 0x00000000 0x02000000>,
|
||||||
|
<1 0x02000000 0x02000000>;
|
||||||
|
|
||||||
|
partition@0 {
|
||||||
|
label = "test-part1";
|
||||||
|
reg = <0 0x04000000>;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
...
|
||||||
Loading…
x
Reference in New Issue
Block a user