diff --git a/dts/bindings/mtd/atmel,at24.yaml b/dts/bindings/mtd/atmel,at24.yaml index da3369ec623..b9dda41cc80 100644 --- a/dts/bindings/mtd/atmel,at24.yaml +++ b/dts/bindings/mtd/atmel,at24.yaml @@ -2,7 +2,36 @@ # Copyright (c) 2018, Nordic Semiconductor # SPDX-License-Identifier: Apache-2.0 -description: Atmel AT24 (or compatible) I2C EEPROM +description: | + I2C EEPROMs compatible with Atmel's AT24 family + + There are multiple vendors manufacturing I2C EEPROMs compatible with the programming model of the + Atmel AT24. + + Examples of compatible EEPROM families: + - Microchip AT24xxx + - ST M24xxx + + Each of these can be represented by a set of common parameters (EEPROM size, page size, address + width, and timeout) available from the datasheet of the specific EEPROM. The compatible string for + these can list the specific EEPROM vendor and model along with the vendor EEPROM family as long as + the least-specific compatible entry is "atmel,at24". + + Example devicetree node describing a ST M24M01 EEPROM on the i2c0 bus: + + &i2c0 { + status = "okay"; + clock-frequency = ; + + eeprom@56 { + compatible = "st,m24m01", "st,m24xxx", "atmel,at24"; + reg = <0x56>; + size = ; + pagesize = <256>; + address-width = <16>; + timeout = <5>; + }; + }; compatible: "atmel,at24" diff --git a/dts/bindings/mtd/atmel,at25.yaml b/dts/bindings/mtd/atmel,at25.yaml index 9b1977e8dc1..7c887dd1768 100644 --- a/dts/bindings/mtd/atmel,at25.yaml +++ b/dts/bindings/mtd/atmel,at25.yaml @@ -1,7 +1,36 @@ # Copyright (c) 2019 Vestas Wind Systems A/S # SPDX-License-Identifier: Apache-2.0 -description: Atmel AT25 (or compatible) SPI EEPROM +description: | + SPI EEPROMs compatible with Atmel's AT25 family + + There are multiple vendors manufacturing SPI EEPROMs compatible with the programming model of the + Atmel AT25. + + Examples of compatible EEPROM families: + - Microchip AT25xxx + - ST M95xxx + + Each of these can be represented by a set of common parameters (EEPROM size, page size, address + width, and timeout) available from the datasheet of the specific EEPROM. The compatible string for + these can list the specific EEPROM vendor and model along with the vendor EEPROM family as long as + the least-specific compatible entry is "atmel,at25". + + Example devicetree node describing a ST M95256 EEPROM on the spi0 bus: + + &spi0 { + status = "okay"; + + eeprom@1 { + compatible = "st,m95256", "st,m95xxx", "atmel,at25"; + reg = <0x1>; + size = ; + pagesize = <64>; + address-width = <16>; + spi-max-frequency = ; + timeout = <5>; + }; + }; compatible: "atmel,at25"