Skip to content

Commit 8ff16cf

Browse files
Documentation: devicetree: m25p80: add "nor-jedec" binding
Almost all flash that are "compatible" with m25p80 support the JEDEC READ ID opcode (0x9F), and in fact, that is often the only thing that is used to differentiate them. Let's add a compatible string that represents this lowest common denominator of compatibility. Device trees can still specify manufacturer/device names in addition, but (until some reason is found to differentiate between them through device tree) software will likely want to bind just against the generic name, and avoid unnecessarily growing its device ID binding tables. This is related to the work of commit a5b7616 ("mtd: m25p80,spi-nor: Fix module aliases for m25p80"), which showed that maintaining these device tables as stable device-tree/modalias binding tables is not a worthwhile burden for mostly-comptatible flash. At the same time, let's update the binding doc to point to the m25p_ids[] ID list instead of spi_nor_ids[]. The former can be used for device tree bindings, but the latter cannot. In the future, we should pare down the m25p_ids[] list to only those IDs which are actually used in device trees. Signed-off-by: Brian Norris <[email protected]> Cc: Rafał Miłecki <[email protected]> Reviewed-by: Marek Vasut <[email protected]>
1 parent 2a6a28e commit 8ff16cf

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

Documentation/devicetree/bindings/mtd/m25p80.txt

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,13 @@
33
Required properties:
44
- #address-cells, #size-cells : Must be present if the device has sub-nodes
55
representing partitions.
6-
- compatible : Should be the manufacturer and the name of the chip. Bear in mind
7-
the DT binding is not Linux-only, but in case of Linux, see the
8-
"spi_nor_ids" table in drivers/mtd/spi-nor/spi-nor.c for the list
9-
of supported chips.
6+
- compatible : May include a device-specific string consisting of the
7+
manufacturer and name of the chip. Bear in mind the DT binding
8+
is not Linux-only, but in case of Linux, see the "m25p_ids"
9+
table in drivers/mtd/devices/m25p80.c for the list of supported
10+
chips.
11+
Must also include "nor-jedec" for any SPI NOR flash that can be
12+
identified by the JEDEC READ ID opcode (0x9F).
1013
- reg : Chip-Select number
1114
- spi-max-frequency : Maximum frequency of the SPI bus the chip can operate at
1215

@@ -22,7 +25,7 @@ Example:
2225
flash: m25p80@0 {
2326
#address-cells = <1>;
2427
#size-cells = <1>;
25-
compatible = "spansion,m25p80";
28+
compatible = "spansion,m25p80", "nor-jedec";
2629
reg = <0>;
2730
spi-max-frequency = <40000000>;
2831
m25p,fast-read;

0 commit comments

Comments
 (0)