drivers/misc/eeprom/at24.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  * at24.c - handle most I2C EEPROMs
   4  *
   5  * Copyright (C) 2005-2007 David Brownell
   6  * Copyright (C) 2008 Wolfram Sang, Pengutronix
   7  */
   8
   9 #include <linux/acpi.h>
  10 #include <linux/bitops.h>
  11 #include <linux/capability.h>
  12 #include <linux/delay.h>
  13 #include <linux/i2c.h>
  14 #include <linux/init.h>
  15 #include <linux/jiffies.h>
  16 #include <linux/kernel.h>
  17 #include <linux/mod_devicetable.h>
  18 #include <linux/module.h>
  19 #include <linux/mutex.h>
  20 #include <linux/nvmem-provider.h>
  21 #include <linux/of_device.h>
  22 #include <linux/pm_runtime.h>
  23 #include <linux/property.h>
  24 #include <linux/regmap.h>
  25 #include <linux/regulator/consumer.h>
  26 #include <linux/slab.h>
  27
  28 /* Address pointer is 16 bit. */
  29 #define AT24_FLAG_ADDR16        BIT(7)
  30 /* sysfs-entry will be read-only. */
  31 #define AT24_FLAG_READONLY      BIT(6)
  32 /* sysfs-entry will be world-readable. */
  33 #define AT24_FLAG_IRUGO         BIT(5)
  34 /* Take always 8 addresses (24c00). */
  35 #define AT24_FLAG_TAKE8ADDR     BIT(4)
  36 /* Factory-programmed serial number. */
  37 #define AT24_FLAG_SERIAL        BIT(3)
  38 /* Factory-programmed mac address. */
  39 #define AT24_FLAG_MAC           BIT(2)
  40 /* Does not auto-rollover reads to the next slave address. */
  41 #define AT24_FLAG_NO_RDROL      BIT(1)
  42
  43 /*
  44  * I2C EEPROMs from most vendors are inexpensive and mostly interchangeable.
  45  * Differences between different vendor product lines (like Atmel AT24C or
  46  * MicroChip 24LC, etc) won't much matter for typical read/write access.
  47  * There are also I2C RAM chips, likewise interchangeable. One example
  48  * would be the PCF8570, which acts like a 24c02 EEPROM (256 bytes).
  49  *
  50  * However, misconfiguration can lose data. "Set 16-bit memory address"
  51  * to a part with 8-bit addressing will overwrite data. Writing with too
  52  * big a page size also loses data. And it's not safe to assume that the
  53  * conventional addresses 0x50..0x57 only hold eeproms; a PCF8563 RTC
  54  * uses 0x51, for just one example.
  55  *
  56  * Accordingly, explicit board-specific configuration data should be used
  57  * in almost all cases. (One partial exception is an SMBus used to access
  58  * "SPD" data for DRAM sticks. Those only use 24c02 EEPROMs.)
  59  *
  60  * So this driver uses "new style" I2C driver binding, expecting to be
  61  * told what devices exist. That may be in arch/X/mach-Y/board-Z.c or
  62  * similar kernel-resident tables; or, configuration data coming from
  63  * a bootloader.
  64  *
  65  * Other than binding model, current differences from "eeprom" driver are
  66  * that this one handles write access and isn't restricted to 24c02 devices.
  67  * It also handles larger devices (32 kbit and up) with two-byte addresses,
  68  * which won't work on pure SMBus systems.
  69  */
  70
  71 struct at24_data {
  72         /*
  73          * Lock protects against activities from other Linux tasks,
  74          * but not from changes by other I2C masters.
  75          */
  76         struct mutex lock;
  77
  78         unsigned int write_max;
  79         unsigned int num_addresses;
  80         unsigned int offset_adj;
  81
  82         u32 byte_len;
  83         u16 page_size;
  84         u8 flags;
  85
  86         struct nvmem_device *nvmem;
  87         struct regulator *vcc_reg;
  88         void (*read_post)(unsigned int off, char *buf, size_t count);
  89
  90         /*
  91          * Some chips tie up multiple I2C addresses; dummy devices reserve
  92          * them for us.
  93          */
  94         u8 bank_addr_shift;
  95         struct regmap *client_regmaps[] __counted_by(num_addresses);
  96 };
  97
  98 /*
  99  * This parameter is to help this driver avoid blocking other drivers out
 100  * of I2C for potentially troublesome amounts of time. With a 100 kHz I2C
 101  * clock, one 256 byte read takes about 1/43 second which is excessive;
 102  * but the 1/170 second it takes at 400 kHz may be quite reasonable; and
 103  * at 1 MHz (Fm+) a 1/430 second delay could easily be invisible.
 104  *
 105  * This value is forced to be a power of two so that writes align on pages.
 106  */
 107 static unsigned int at24_io_limit = 128;
 108 module_param_named(io_limit, at24_io_limit, uint, 0);
 109 MODULE_PARM_DESC(at24_io_limit, "Maximum bytes per I/O (default 128)");
 110
 111 /*
 112  * Specs often allow 5 msec for a page write, sometimes 20 msec;
 113  * it's important to recover from write timeouts.
 114  */
 115 static unsigned int at24_write_timeout = 25;
 116 module_param_named(write_timeout, at24_write_timeout, uint, 0);
 117 MODULE_PARM_DESC(at24_write_timeout, "Time (in ms) to try writes (default 25)");
 118
 119 struct at24_chip_data {
 120         u32 byte_len;
 121         u8 flags;
 122         u8 bank_addr_shift;
 123         void (*read_post)(unsigned int off, char *buf, size_t count);
 124 };
 125
 126 #define AT24_CHIP_DATA(_name, _len, _flags)                             \
 127         static const struct at24_chip_data _name = {                    \
 128                 .byte_len = _len, .flags = _flags,                      \
 129         }
 130
 131 #define AT24_CHIP_DATA_CB(_name, _len, _flags, _read_post)              \
 132         static const struct at24_chip_data _name = {                    \
 133                 .byte_len = _len, .flags = _flags,                      \
 134                 .read_post = _read_post,                                \
 135         }
 136
 137 #define AT24_CHIP_DATA_BS(_name, _len, _flags, _bank_addr_shift)        \
 138         static const struct at24_chip_data _name = {                    \
 139                 .byte_len = _len, .flags = _flags,                      \
 140                 .bank_addr_shift = _bank_addr_shift                     \
 141         }
 142
 143 static void at24_read_post_vaio(unsigned int off, char *buf, size_t count)
 144 {
 145         int i;
 146
 147         if (capable(CAP_SYS_ADMIN))
 148                 return;
 149
 150         /*
 151          * Hide VAIO private settings to regular users:
 152          * - BIOS passwords: bytes 0x00 to 0x0f
 153          * - UUID: bytes 0x10 to 0x1f
 154          * - Serial number: 0xc0 to 0xdf
 155          */
 156         for (i = 0; i < count; i++) {
 157                 if ((off + i <= 0x1f) ||
 158                     (off + i >= 0xc0 && off + i <= 0xdf))
 159                         buf[i] = 0;
 160         }
 161 }
 162
 163 /* needs 8 addresses as A0-A2 are ignored */
 164 AT24_CHIP_DATA(at24_data_24c00, 128 / 8, AT24_FLAG_TAKE8ADDR);
 165 /* old variants can't be handled with this generic entry! */
 166 AT24_CHIP_DATA(at24_data_24c01, 1024 / 8, 0);
 167 AT24_CHIP_DATA(at24_data_24cs01, 16,
 168         AT24_FLAG_SERIAL | AT24_FLAG_READONLY);
 169 AT24_CHIP_DATA(at24_data_24c02, 2048 / 8, 0);
 170 AT24_CHIP_DATA(at24_data_24cs02, 16,
 171         AT24_FLAG_SERIAL | AT24_FLAG_READONLY);
 172 AT24_CHIP_DATA(at24_data_24mac402, 48 / 8,
 173         AT24_FLAG_MAC | AT24_FLAG_READONLY);
 174 AT24_CHIP_DATA(at24_data_24mac602, 64 / 8,
 175         AT24_FLAG_MAC | AT24_FLAG_READONLY);
 176 /* spd is a 24c02 in memory DIMMs */
 177 AT24_CHIP_DATA(at24_data_spd, 2048 / 8,
 178         AT24_FLAG_READONLY | AT24_FLAG_IRUGO);
 179 /* 24c02_vaio is a 24c02 on some Sony laptops */
 180 AT24_CHIP_DATA_CB(at24_data_24c02_vaio, 2048 / 8,
 181         AT24_FLAG_READONLY | AT24_FLAG_IRUGO,
 182         at24_read_post_vaio);
 183 AT24_CHIP_DATA(at24_data_24c04, 4096 / 8, 0);
 184 AT24_CHIP_DATA(at24_data_24cs04, 16,
 185         AT24_FLAG_SERIAL | AT24_FLAG_READONLY);
 186 /* 24rf08 quirk is handled at i2c-core */
 187 AT24_CHIP_DATA(at24_data_24c08, 8192 / 8, 0);
 188 AT24_CHIP_DATA(at24_data_24cs08, 16,
 189         AT24_FLAG_SERIAL | AT24_FLAG_READONLY);
 190 AT24_CHIP_DATA(at24_data_24c16, 16384 / 8, 0);
 191 AT24_CHIP_DATA(at24_data_24cs16, 16,
 192         AT24_FLAG_SERIAL | AT24_FLAG_READONLY);
 193 AT24_CHIP_DATA(at24_data_24c32, 32768 / 8, AT24_FLAG_ADDR16);
 194 /* M24C32-D Additional Write lockable page (M24C32-D order codes) */
 195 AT24_CHIP_DATA(at24_data_24c32d_wlp, 32, AT24_FLAG_ADDR16);
 196 AT24_CHIP_DATA(at24_data_24cs32, 16,
 197         AT24_FLAG_ADDR16 | AT24_FLAG_SERIAL | AT24_FLAG_READONLY);
 198 AT24_CHIP_DATA(at24_data_24c64, 65536 / 8, AT24_FLAG_ADDR16);
 199 /* M24C64-D Additional Write lockable page (M24C64-D order codes) */
 200 AT24_CHIP_DATA(at24_data_24c64d_wlp, 32, AT24_FLAG_ADDR16);
 201 AT24_CHIP_DATA(at24_data_24cs64, 16,
 202         AT24_FLAG_ADDR16 | AT24_FLAG_SERIAL | AT24_FLAG_READONLY);
 203 AT24_CHIP_DATA(at24_data_24c128, 131072 / 8, AT24_FLAG_ADDR16);
 204 AT24_CHIP_DATA(at24_data_24c256, 262144 / 8, AT24_FLAG_ADDR16);
 205 AT24_CHIP_DATA(at24_data_24c512, 524288 / 8, AT24_FLAG_ADDR16);
 206 AT24_CHIP_DATA(at24_data_24c1024, 1048576 / 8, AT24_FLAG_ADDR16);
 207 AT24_CHIP_DATA_BS(at24_data_24c1025, 1048576 / 8, AT24_FLAG_ADDR16, 2);
 208 AT24_CHIP_DATA(at24_data_24c2048, 2097152 / 8, AT24_FLAG_ADDR16);
 209 /* identical to 24c08 ? */
 210 AT24_CHIP_DATA(at24_data_INT3499, 8192 / 8, 0);
 211
 212 static const struct i2c_device_id at24_ids[] = {
 213         { "24c00",      (kernel_ulong_t)&at24_data_24c00 },
 214         { "24c01",      (kernel_ulong_t)&at24_data_24c01 },
 215         { "24cs01",     (kernel_ulong_t)&at24_data_24cs01 },
 216         { "24c02",      (kernel_ulong_t)&at24_data_24c02 },
 217         { "24cs02",     (kernel_ulong_t)&at24_data_24cs02 },
 218         { "24mac402",   (kernel_ulong_t)&at24_data_24mac402 },
 219         { "24mac602",   (kernel_ulong_t)&at24_data_24mac602 },
 220         { "spd",        (kernel_ulong_t)&at24_data_spd },
 221         { "24c02-vaio", (kernel_ulong_t)&at24_data_24c02_vaio },
 222         { "24c04",      (kernel_ulong_t)&at24_data_24c04 },
 223         { "24cs04",     (kernel_ulong_t)&at24_data_24cs04 },
 224         { "24c08",      (kernel_ulong_t)&at24_data_24c08 },
 225         { "24cs08",     (kernel_ulong_t)&at24_data_24cs08 },
 226         { "24c16",      (kernel_ulong_t)&at24_data_24c16 },
 227         { "24cs16",     (kernel_ulong_t)&at24_data_24cs16 },
 228         { "24c32",      (kernel_ulong_t)&at24_data_24c32 },
 229         { "24c32d-wl",  (kernel_ulong_t)&at24_data_24c32d_wlp },
 230         { "24cs32",     (kernel_ulong_t)&at24_data_24cs32 },
 231         { "24c64",      (kernel_ulong_t)&at24_data_24c64 },
 232         { "24c64-wl",   (kernel_ulong_t)&at24_data_24c64d_wlp },
 233         { "24cs64",     (kernel_ulong_t)&at24_data_24cs64 },
 234         { "24c128",     (kernel_ulong_t)&at24_data_24c128 },
 235         { "24c256",     (kernel_ulong_t)&at24_data_24c256 },
 236         { "24c512",     (kernel_ulong_t)&at24_data_24c512 },
 237         { "24c1024",    (kernel_ulong_t)&at24_data_24c1024 },
 238         { "24c1025",    (kernel_ulong_t)&at24_data_24c1025 },
 239         { "24c2048",    (kernel_ulong_t)&at24_data_24c2048 },
 240         { "at24",       0 },
 241         { /* END OF LIST */ }
 242 };
 243 MODULE_DEVICE_TABLE(i2c, at24_ids);
 244
 245 static const struct of_device_id at24_of_match[] = {
 246         { .compatible = "atmel,24c00",          .data = &at24_data_24c00 },
 247         { .compatible = "atmel,24c01",          .data = &at24_data_24c01 },
 248         { .compatible = "atmel,24cs01",         .data = &at24_data_24cs01 },
 249         { .compatible = "atmel,24c02",          .data = &at24_data_24c02 },
 250         { .compatible = "atmel,24cs02",         .data = &at24_data_24cs02 },
 251         { .compatible = "atmel,24mac402",       .data = &at24_data_24mac402 },
 252         { .compatible = "atmel,24mac602",       .data = &at24_data_24mac602 },
 253         { .compatible = "atmel,spd",            .data = &at24_data_spd },
 254         { .compatible = "atmel,24c04",          .data = &at24_data_24c04 },
 255         { .compatible = "atmel,24cs04",         .data = &at24_data_24cs04 },
 256         { .compatible = "atmel,24c08",          .data = &at24_data_24c08 },
 257         { .compatible = "atmel,24cs08",         .data = &at24_data_24cs08 },
 258         { .compatible = "atmel,24c16",          .data = &at24_data_24c16 },
 259         { .compatible = "atmel,24cs16",         .data = &at24_data_24cs16 },
 260         { .compatible = "atmel,24c32",          .data = &at24_data_24c32 },
 261         { .compatible = "atmel,24c32d-wl",      .data = &at24_data_24c32d_wlp },
 262         { .compatible = "atmel,24cs32",         .data = &at24_data_24cs32 },
 263         { .compatible = "atmel,24c64",          .data = &at24_data_24c64 },
 264         { .compatible = "atmel,24c64d-wl",      .data = &at24_data_24c64d_wlp },
 265         { .compatible = "atmel,24cs64",         .data = &at24_data_24cs64 },
 266         { .compatible = "atmel,24c128",         .data = &at24_data_24c128 },
 267         { .compatible = "atmel,24c256",         .data = &at24_data_24c256 },
 268         { .compatible = "atmel,24c512",         .data = &at24_data_24c512 },
 269         { .compatible = "atmel,24c1024",        .data = &at24_data_24c1024 },
 270         { .compatible = "atmel,24c1025",        .data = &at24_data_24c1025 },
 271         { .compatible = "atmel,24c2048",        .data = &at24_data_24c2048 },
 272         { /* END OF LIST */ },
 273 };
 274 MODULE_DEVICE_TABLE(of, at24_of_match);
 275
 276 static const struct acpi_device_id __maybe_unused at24_acpi_ids[] = {
 277         { "INT3499",    (kernel_ulong_t)&at24_data_INT3499 },
 278         { "TPF0001",    (kernel_ulong_t)&at24_data_24c1024 },
 279         { /* END OF LIST */ }
 280 };
 281 MODULE_DEVICE_TABLE(acpi, at24_acpi_ids);
 282
 283 /*
 284  * This routine supports chips which consume multiple I2C addresses. It
 285  * computes the addressing information to be used for a given r/w request.
 286  * Assumes that sanity checks for offset happened at sysfs-layer.
 287  *
 288  * Slave address and byte offset derive from the offset. Always
 289  * set the byte address; on a multi-master board, another master
 290  * may have changed the chip's "current" address pointer.
 291  */
 292 static struct regmap *at24_translate_offset(struct at24_data *at24,
 293                                             unsigned int *offset)
 294 {
 295         unsigned int i;
 296
 297         if (at24->flags & AT24_FLAG_ADDR16) {
 298                 i = *offset >> 16;
 299                 *offset &= 0xffff;
 300         } else {
 301                 i = *offset >> 8;
 302                 *offset &= 0xff;
 303         }
 304
 305         return at24->client_regmaps[i];
 306 }
 307
 308 static struct device *at24_base_client_dev(struct at24_data *at24)
 309 {
 310         return regmap_get_device(at24->client_regmaps[0]);
 311 }
 312
 313 static size_t at24_adjust_read_count(struct at24_data *at24,
 314                                       unsigned int offset, size_t count)
 315 {
 316         unsigned int bits;
 317         size_t remainder;
 318
 319         /*
 320          * In case of multi-address chips that don't rollover reads to
 321          * the next slave address: truncate the count to the slave boundary,
 322          * so that the read never straddles slaves.
 323          */
 324         if (at24->flags & AT24_FLAG_NO_RDROL) {
 325                 bits = (at24->flags & AT24_FLAG_ADDR16) ? 16 : 8;
 326                 remainder = BIT(bits) - offset;
 327                 if (count > remainder)
 328                         count = remainder;
 329         }
 330
 331         if (count > at24_io_limit)
 332                 count = at24_io_limit;
 333
 334         return count;
 335 }
 336
 337 static ssize_t at24_regmap_read(struct at24_data *at24, char *buf,
 338                                 unsigned int offset, size_t count)
 339 {
 340         unsigned long timeout, read_time;
 341         struct regmap *regmap;
 342         int ret;
 343
 344         regmap = at24_translate_offset(at24, &offset);
 345         count = at24_adjust_read_count(at24, offset, count);
 346
 347         /* adjust offset for mac and serial read ops */
 348         offset += at24->offset_adj;
 349
 350         timeout = jiffies + msecs_to_jiffies(at24_write_timeout);
 351         do {
 352                 /*
 353                  * The timestamp shall be taken before the actual operation
 354                  * to avoid a premature timeout in case of high CPU load.
 355                  */
 356                 read_time = jiffies;
 357
 358                 ret = regmap_bulk_read(regmap, offset, buf, count);
 359                 dev_dbg(regmap_get_device(regmap), "read %zu@%d --> %d (%ld)\n",
 360                         count, offset, ret, jiffies);
 361                 if (!ret)
 362                         return count;
 363
 364                 usleep_range(1000, 1500);
 365         } while (time_before(read_time, timeout));
 366
 367         return -ETIMEDOUT;
 368 }
 369
 370 /*
 371  * Note that if the hardware write-protect pin is pulled high, the whole
 372  * chip is normally write protected. But there are plenty of product
 373  * variants here, including OTP fuses and partial chip protect.
 374  *
 375  * We only use page mode writes; the alternative is sloooow. These routines
 376  * write at most one page.
 377  */
 378
 379 static size_t at24_adjust_write_count(struct at24_data *at24,
 380                                       unsigned int offset, size_t count)
 381 {
 382         unsigned int next_page;
 383
 384         /* write_max is at most a page */
 385         if (count > at24->write_max)
 386                 count = at24->write_max;
 387
 388         /* Never roll over backwards, to the start of this page */
 389         next_page = roundup(offset + 1, at24->page_size);
 390         if (offset + count > next_page)
 391                 count = next_page - offset;
 392
 393         return count;
 394 }
 395
 396 static ssize_t at24_regmap_write(struct at24_data *at24, const char *buf,
 397                                  unsigned int offset, size_t count)
 398 {
 399         unsigned long timeout, write_time;
 400         struct regmap *regmap;
 401         int ret;
 402
 403         regmap = at24_translate_offset(at24, &offset);
 404         count = at24_adjust_write_count(at24, offset, count);
 405         timeout = jiffies + msecs_to_jiffies(at24_write_timeout);
 406
 407         do {
 408                 /*
 409                  * The timestamp shall be taken before the actual operation
 410                  * to avoid a premature timeout in case of high CPU load.
 411                  */
 412                 write_time = jiffies;
 413
 414                 ret = regmap_bulk_write(regmap, offset, buf, count);
 415                 dev_dbg(regmap_get_device(regmap), "write %zu@%d --> %d (%ld)\n",
 416                         count, offset, ret, jiffies);
 417                 if (!ret)
 418                         return count;
 419
 420                 usleep_range(1000, 1500);
 421         } while (time_before(write_time, timeout));
 422
 423         return -ETIMEDOUT;
 424 }
 425
 426 static int at24_read(void *priv, unsigned int off, void *val, size_t count)
 427 {
 428         struct at24_data *at24;
 429         struct device *dev;
 430         char *buf = val;
 431         int i, ret;
 432
 433         at24 = priv;
 434         dev = at24_base_client_dev(at24);
 435
 436         if (unlikely(!count))
 437                 return count;
 438
 439         if (off + count > at24->byte_len)
 440                 return -EINVAL;
 441
 442         ret = pm_runtime_get_sync(dev);
 443         if (ret < 0) {
 444                 pm_runtime_put_noidle(dev);
 445                 return ret;
 446         }
 447
 448         /*
 449          * Read data from chip, protecting against concurrent updates
 450          * from this host, but not from other I2C masters.
 451          */
 452         mutex_lock(&at24->lock);
 453
 454         for (i = 0; count; i += ret, count -= ret) {
 455                 ret = at24_regmap_read(at24, buf + i, off + i, count);
 456                 if (ret < 0) {
 457                         mutex_unlock(&at24->lock);
 458                         pm_runtime_put(dev);
 459                         return ret;
 460                 }
 461         }
 462
 463         mutex_unlock(&at24->lock);
 464
 465         pm_runtime_put(dev);
 466
 467         if (unlikely(at24->read_post))
 468                 at24->read_post(off, buf, i);
 469
 470         return 0;
 471 }
 472
 473 static int at24_write(void *priv, unsigned int off, void *val, size_t count)
 474 {
 475         struct at24_data *at24;
 476         struct device *dev;
 477         char *buf = val;
 478         int ret;
 479
 480         at24 = priv;
 481         dev = at24_base_client_dev(at24);
 482
 483         if (unlikely(!count))
 484                 return -EINVAL;
 485
 486         if (off + count > at24->byte_len)
 487                 return -EINVAL;
 488
 489         ret = pm_runtime_get_sync(dev);
 490         if (ret < 0) {
 491                 pm_runtime_put_noidle(dev);
 492                 return ret;
 493         }
 494
 495         /*
 496          * Write data to chip, protecting against concurrent updates
 497          * from this host, but not from other I2C masters.
 498          */
 499         mutex_lock(&at24->lock);
 500
 501         while (count) {
 502                 ret = at24_regmap_write(at24, buf, off, count);
 503                 if (ret < 0) {
 504                         mutex_unlock(&at24->lock);
 505                         pm_runtime_put(dev);
 506                         return ret;
 507                 }
 508                 buf += ret;
 509                 off += ret;
 510                 count -= ret;
 511         }
 512
 513         mutex_unlock(&at24->lock);
 514
 515         pm_runtime_put(dev);
 516
 517         return 0;
 518 }
 519
 520 static int at24_make_dummy_client(struct at24_data *at24, unsigned int index,
 521                                   struct i2c_client *base_client,
 522                                   struct regmap_config *regmap_config)
 523 {
 524         struct i2c_client *dummy_client;
 525         struct regmap *regmap;
 526
 527         dummy_client = devm_i2c_new_dummy_device(&base_client->dev,
 528                                                  base_client->adapter,
 529                                                  base_client->addr +
 530                                                  (index << at24->bank_addr_shift));
 531         if (IS_ERR(dummy_client))
 532                 return PTR_ERR(dummy_client);
 533
 534         regmap = devm_regmap_init_i2c(dummy_client, regmap_config);
 535         if (IS_ERR(regmap))
 536                 return PTR_ERR(regmap);
 537
 538         at24->client_regmaps[index] = regmap;
 539
 540         return 0;
 541 }
 542
 543 static unsigned int at24_get_offset_adj(u8 flags, unsigned int byte_len)
 544 {
 545         if (flags & AT24_FLAG_MAC) {
 546                 /* EUI-48 starts from 0x9a, EUI-64 from 0x98 */
 547                 return 0xa0 - byte_len;
 548         } else if (flags & AT24_FLAG_SERIAL && flags & AT24_FLAG_ADDR16) {
 549                 /*
 550                  * For 16 bit address pointers, the word address must contain
 551                  * a '10' sequence in bits 11 and 10 regardless of the
 552                  * intended position of the address pointer.
 553                  */
 554                 return 0x0800;
 555         } else if (flags & AT24_FLAG_SERIAL) {
 556                 /*
 557                  * Otherwise the word address must begin with a '10' sequence,
 558                  * regardless of the intended address.
 559                  */
 560                 return 0x0080;
 561         } else {
 562                 return 0;
 563         }
 564 }
 565
 566 static int at24_probe(struct i2c_client *client)
 567 {
 568         struct regmap_config regmap_config = { };
 569         struct nvmem_config nvmem_config = { };
 570         u32 byte_len, page_size, flags, addrw;
 571         const struct at24_chip_data *cdata;
 572         struct device *dev = &client->dev;
 573         bool i2c_fn_i2c, i2c_fn_block;
 574         unsigned int i, num_addresses;
 575         struct at24_data *at24;
 576         bool full_power;
 577         struct regmap *regmap;
 578         bool writable;
 579         u8 test_byte;
 580         int err;
 581
 582         i2c_fn_i2c = i2c_check_functionality(client->adapter, I2C_FUNC_I2C);
 583         i2c_fn_block = i2c_check_functionality(client->adapter,
 584                                                I2C_FUNC_SMBUS_WRITE_I2C_BLOCK);
 585
 586         cdata = i2c_get_match_data(client);
 587         if (!cdata)
 588                 return -ENODEV;
 589
 590         err = device_property_read_u32(dev, "pagesize", &page_size);
 591         if (err)
 592                 /*
 593                  * This is slow, but we can't know all eeproms, so we better
 594                  * play safe. Specifying custom eeprom-types via device tree
 595                  * or properties is recommended anyhow.
 596                  */
 597                 page_size = 1;
 598
 599         flags = cdata->flags;
 600         if (device_property_present(dev, "read-only"))
 601                 flags |= AT24_FLAG_READONLY;
 602         if (device_property_present(dev, "no-read-rollover"))
 603                 flags |= AT24_FLAG_NO_RDROL;
 604
 605         err = device_property_read_u32(dev, "address-width", &addrw);
 606         if (!err) {
 607                 switch (addrw) {
 608                 case 8:
 609                         if (flags & AT24_FLAG_ADDR16)
 610                                 dev_warn(dev,
 611                                          "Override address width to be 8, while default is 16\n");
 612                         flags &= ~AT24_FLAG_ADDR16;
 613                         break;
 614                 case 16:
 615                         flags |= AT24_FLAG_ADDR16;
 616                         break;
 617                 default:
 618                         dev_warn(dev, "Bad \"address-width\" property: %u\n",
 619                                  addrw);
 620                 }
 621         }
 622
 623         err = device_property_read_u32(dev, "size", &byte_len);
 624         if (err)
 625                 byte_len = cdata->byte_len;
 626
 627         if (!i2c_fn_i2c && !i2c_fn_block)
 628                 page_size = 1;
 629
 630         if (!page_size) {
 631                 dev_err(dev, "page_size must not be 0!\n");
 632                 return -EINVAL;
 633         }
 634
 635         if (!is_power_of_2(page_size))
 636                 dev_warn(dev, "page_size looks suspicious (no power of 2)!\n");
 637
 638         err = device_property_read_u32(dev, "num-addresses", &num_addresses);
 639         if (err) {
 640                 if (flags & AT24_FLAG_TAKE8ADDR)
 641                         num_addresses = 8;
 642                 else
 643                         num_addresses = DIV_ROUND_UP(byte_len,
 644                                 (flags & AT24_FLAG_ADDR16) ? 65536 : 256);
 645         }
 646
 647         if ((flags & AT24_FLAG_SERIAL) && (flags & AT24_FLAG_MAC)) {
 648                 dev_err(dev,
 649                         "invalid device data - cannot have both AT24_FLAG_SERIAL & AT24_FLAG_MAC.");
 650                 return -EINVAL;
 651         }
 652
 653         regmap_config.val_bits = 8;
 654         regmap_config.reg_bits = (flags & AT24_FLAG_ADDR16) ? 16 : 8;
 655         regmap_config.disable_locking = true;
 656
 657         regmap = devm_regmap_init_i2c(client, &regmap_config);
 658         if (IS_ERR(regmap))
 659                 return PTR_ERR(regmap);
 660
 661         at24 = devm_kzalloc(dev, struct_size(at24, client_regmaps, num_addresses),
 662                             GFP_KERNEL);
 663         if (!at24)
 664                 return -ENOMEM;
 665
 666         mutex_init(&at24->lock);
 667         at24->byte_len = byte_len;
 668         at24->page_size = page_size;
 669         at24->flags = flags;
 670         at24->read_post = cdata->read_post;
 671         at24->bank_addr_shift = cdata->bank_addr_shift;
 672         at24->num_addresses = num_addresses;
 673         at24->offset_adj = at24_get_offset_adj(flags, byte_len);
 674         at24->client_regmaps[0] = regmap;
 675
 676         at24->vcc_reg = devm_regulator_get(dev, "vcc");
 677         if (IS_ERR(at24->vcc_reg))
 678                 return PTR_ERR(at24->vcc_reg);
 679
 680         writable = !(flags & AT24_FLAG_READONLY);
 681         if (writable) {
 682                 at24->write_max = min_t(unsigned int,
 683                                         page_size, at24_io_limit);
 684                 if (!i2c_fn_i2c && at24->write_max > I2C_SMBUS_BLOCK_MAX)
 685                         at24->write_max = I2C_SMBUS_BLOCK_MAX;
 686         }
 687
 688         /* use dummy devices for multiple-address chips */
 689         for (i = 1; i < num_addresses; i++) {
 690                 err = at24_make_dummy_client(at24, i, client, &regmap_config);
 691                 if (err)
 692                         return err;
 693         }
 694
 695         /*
 696          * We initialize nvmem_config.id to NVMEM_DEVID_AUTO even if the
 697          * label property is set as some platform can have multiple eeproms
 698          * with same label and we can not register each of those with same
 699          * label. Failing to register those eeproms trigger cascade failure
 700          * on such platform.
 701          */
 702         nvmem_config.id = NVMEM_DEVID_AUTO;
 703
 704         if (device_property_present(dev, "label")) {
 705                 err = device_property_read_string(dev, "label",
 706                                                   &nvmem_config.name);
 707                 if (err)
 708                         return err;
 709         } else {
 710                 nvmem_config.name = dev_name(dev);
 711         }
 712
 713         nvmem_config.type = NVMEM_TYPE_EEPROM;
 714         nvmem_config.dev = dev;
 715         nvmem_config.read_only = !writable;
 716         nvmem_config.root_only = !(flags & AT24_FLAG_IRUGO);
 717         nvmem_config.owner = THIS_MODULE;
 718         nvmem_config.compat = true;
 719         nvmem_config.base_dev = dev;
 720         nvmem_config.reg_read = at24_read;
 721         nvmem_config.reg_write = at24_write;
 722         nvmem_config.priv = at24;
 723         nvmem_config.stride = 1;
 724         nvmem_config.word_size = 1;
 725         nvmem_config.size = byte_len;
 726
 727         i2c_set_clientdata(client, at24);
 728
 729         full_power = acpi_dev_state_d0(&client->dev);
 730         if (full_power) {
 731                 err = regulator_enable(at24->vcc_reg);
 732                 if (err) {
 733                         dev_err(dev, "Failed to enable vcc regulator\n");
 734                         return err;
 735                 }
 736
 737                 pm_runtime_set_active(dev);
 738         }
 739         pm_runtime_enable(dev);
 740
 741         at24->nvmem = devm_nvmem_register(dev, &nvmem_config);
 742         if (IS_ERR(at24->nvmem)) {
 743                 pm_runtime_disable(dev);
 744                 if (!pm_runtime_status_suspended(dev))
 745                         regulator_disable(at24->vcc_reg);
 746                 return dev_err_probe(dev, PTR_ERR(at24->nvmem),
 747                                      "failed to register nvmem\n");
 748         }
 749
 750         /*
 751          * Perform a one-byte test read to verify that the chip is functional,
 752          * unless powering on the device is to be avoided during probe (i.e.
 753          * it's powered off right now).
 754          */
 755         if (full_power) {
 756                 err = at24_read(at24, 0, &test_byte, 1);
 757                 if (err) {
 758                         pm_runtime_disable(dev);
 759                         if (!pm_runtime_status_suspended(dev))
 760                                 regulator_disable(at24->vcc_reg);
 761                         return -ENODEV;
 762                 }
 763         }
 764
 765         pm_runtime_idle(dev);
 766
 767         if (writable)
 768                 dev_info(dev, "%u byte %s EEPROM, writable, %u bytes/write\n",
 769                          byte_len, client->name, at24->write_max);
 770         else
 771                 dev_info(dev, "%u byte %s EEPROM, read-only\n",
 772                          byte_len, client->name);
 773
 774         return 0;
 775 }
 776
 777 static void at24_remove(struct i2c_client *client)
 778 {
 779         struct at24_data *at24 = i2c_get_clientdata(client);
 780
 781         pm_runtime_disable(&client->dev);
 782         if (acpi_dev_state_d0(&client->dev)) {
 783                 if (!pm_runtime_status_suspended(&client->dev))
 784                         regulator_disable(at24->vcc_reg);
 785                 pm_runtime_set_suspended(&client->dev);
 786         }
 787 }
 788
 789 static int __maybe_unused at24_suspend(struct device *dev)
 790 {
 791         struct i2c_client *client = to_i2c_client(dev);
 792         struct at24_data *at24 = i2c_get_clientdata(client);
 793
 794         return regulator_disable(at24->vcc_reg);
 795 }
 796
 797 static int __maybe_unused at24_resume(struct device *dev)
 798 {
 799         struct i2c_client *client = to_i2c_client(dev);
 800         struct at24_data *at24 = i2c_get_clientdata(client);
 801
 802         return regulator_enable(at24->vcc_reg);
 803 }
 804
 805 static const struct dev_pm_ops at24_pm_ops = {
 806         SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
 807                                 pm_runtime_force_resume)
 808         SET_RUNTIME_PM_OPS(at24_suspend, at24_resume, NULL)
 809 };
 810
 811 static struct i2c_driver at24_driver = {
 812         .driver = {
 813                 .name = "at24",
 814                 .pm = &at24_pm_ops,
 815                 .of_match_table = at24_of_match,
 816                 .acpi_match_table = ACPI_PTR(at24_acpi_ids),
 817         },
 818         .probe = at24_probe,
 819         .remove = at24_remove,
 820         .id_table = at24_ids,
 821         .flags = I2C_DRV_ACPI_WAIVE_D0_PROBE,
 822 };
 823
 824 static int __init at24_init(void)
 825 {
 826         if (!at24_io_limit) {
 827                 pr_err("at24: at24_io_limit must not be 0!\n");
 828                 return -EINVAL;
 829         }
 830
 831         at24_io_limit = rounddown_pow_of_two(at24_io_limit);
 832         return i2c_add_driver(&at24_driver);
 833 }
 834 module_init(at24_init);
 835
 836 static void __exit at24_exit(void)
 837 {
 838         i2c_del_driver(&at24_driver);
 839 }
 840 module_exit(at24_exit);
 841
 842 MODULE_DESCRIPTION("Driver for most I2C EEPROMs");
 843 MODULE_AUTHOR("David Brownell and Wolfram Sang");
 844 MODULE_LICENSE("GPL");