^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) # SPDX-License-Identifier: GPL-2.0-only
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) # Copyright 2019 BayLibre SAS
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) %YAML 1.2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) ---
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) $id: "http://devicetree.org/schemas/eeprom/at24.yaml#"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) $schema: "http://devicetree.org/meta-schemas/core.yaml#"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) title: I2C EEPROMs compatible with Atmel's AT24
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) maintainers:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) - Bartosz Golaszewski <bgolaszewski@baylibre.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) select:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) properties:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) compatible:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) contains:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) pattern: "^atmel,(24(c|cs|mac)[0-9]+|spd)$"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) required:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) - compatible
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) properties:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) $nodename:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) pattern: "^eeprom@[0-9a-f]{1,2}$"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) # There are multiple known vendors who manufacture EEPROM chips compatible
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) # with Atmel's AT24. The compatible string requires either a single item
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) # if the memory comes from Atmel (in which case the vendor part must be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) # 'atmel') or two items with the same 'model' part where the vendor part of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) # the first one is the actual manufacturer and the second item is the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) # corresponding 'atmel,<model>' from Atmel.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) compatible:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) oneOf:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) - allOf:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) - minItems: 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) maxItems: 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) - pattern: "^(atmel|catalyst|microchip|nxp|ramtron|renesas|rohm|st),(24(c|cs|lc|mac)[0-9]+|spd)$"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) - pattern: "^atmel,(24(c|cs|mac)[0-9]+|spd)$"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) - oneOf:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) pattern: c00$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) pattern: c01$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) pattern: cs01$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) pattern: c02$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) pattern: cs02$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) pattern: mac402$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) pattern: mac602$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) pattern: c04$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) pattern: cs04$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) pattern: c08$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) pattern: cs08$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) pattern: c16$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) pattern: cs16$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) pattern: c32$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) pattern: cs32$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) pattern: c64$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) pattern: cs64$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) pattern: c128$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) pattern: cs128$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) pattern: c256$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) pattern: cs256$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) pattern: c512$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) pattern: cs512$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) pattern: c1024$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) pattern: cs1024$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) pattern: c2048$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) pattern: cs2048$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) pattern: spd$
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) # These are special cases that don't conform to the above pattern.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) # Each requires a standard at24 model as fallback.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) - const: rohm,br24t01
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) - const: atmel,24c01
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) - const: nxp,se97b
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) - const: atmel,24c02
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) - const: renesas,r1ex24002
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) - const: atmel,24c02
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) - const: renesas,r1ex24016
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) - const: atmel,24c16
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) - const: giantec,gt24c32a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) - const: atmel,24c32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) - items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) - const: renesas,r1ex24128
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) - const: atmel,24c128
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) label:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) description: Descriptive name of the EEPROM.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) reg:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) maxItems: 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) pagesize:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) The length of the pagesize for writing. Please consult the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) manual of your device, that value varies a lot. A wrong value
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) may result in data loss! If not specified, a safety value of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) '1' is used which will be very slow.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) $ref: /schemas/types.yaml#/definitions/uint32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) enum: [1, 8, 16, 32, 64, 128, 256]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) default: 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) read-only:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) $ref: /schemas/types.yaml#definitions/flag
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) Disables writes to the eeprom.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) size:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) $ref: /schemas/types.yaml#/definitions/uint32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) Total eeprom size in bytes.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) no-read-rollover:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) $ref: /schemas/types.yaml#definitions/flag
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) Indicates that the multi-address eeprom does not automatically roll
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) over reads to the next slave address. Please consult the manual of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) your device.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) wp-gpios: true
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) address-width:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) Number of address bits.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) $ref: /schemas/types.yaml#/definitions/uint32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) default: 8
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) enum: [ 8, 16 ]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) num-addresses:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) Total number of i2c slave addresses this device takes.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) $ref: /schemas/types.yaml#/definitions/uint32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) default: 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) minimum: 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) maximum: 8
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) vcc-supply:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) phandle of the regulator that provides the supply voltage.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) required:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) - compatible
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) - reg
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) additionalProperties: false
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) examples:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) - |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) i2c {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) #address-cells = <1>;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) #size-cells = <0>;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) eeprom@52 {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) compatible = "microchip,24c32", "atmel,24c32";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) reg = <0x52>;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) pagesize = <32>;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) wp-gpios = <&gpio1 3 0>;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) num-addresses = <8>;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) ...