drivers/misc/eeprom/at24.c

   1 /*
   2  * at24.c - handle most I2C EEPROMs
   3  *
   4  * Copyright (C) 2005-2007 David Brownell
   5  * Copyright (C) 2008 Wolfram Sang, Pengutronix
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  */
  12 #include <linux/kernel.h>
  13 #include <linux/init.h>
  14 #include <linux/module.h>
  15 #include <linux/slab.h>
  16 #include <linux/delay.h>
  17 #include <linux/mutex.h>
  18 #include <linux/sysfs.h>
  19 #include <linux/mod_devicetable.h>
  20 #include <linux/log2.h>
  21 #include <linux/bitops.h>
  22 #include <linux/jiffies.h>
  23 #include <linux/i2c.h>
  24 #include <linux/i2c/at24.h>
  25
  26 /*
  27  * I2C EEPROMs from most vendors are inexpensive and mostly interchangeable.
  28  * Differences between different vendor product lines (like Atmel AT24C or
  29  * MicroChip 24LC, etc) won't much matter for typical read/write access.
  30  * There are also I2C RAM chips, likewise interchangeable. One example
  31  * would be the PCF8570, which acts like a 24c02 EEPROM (256 bytes).
  32  *
  33  * However, misconfiguration can lose data. "Set 16-bit memory address"
  34  * to a part with 8-bit addressing will overwrite data. Writing with too
  35  * big a page size also loses data. And it's not safe to assume that the
  36  * conventional addresses 0x50..0x57 only hold eeproms; a PCF8563 RTC
  37  * uses 0x51, for just one example.
  38  *
  39  * Accordingly, explicit board-specific configuration data should be used
  40  * in almost all cases. (One partial exception is an SMBus used to access
  41  * "SPD" data for DRAM sticks. Those only use 24c02 EEPROMs.)
  42  *
  43  * So this driver uses "new style" I2C driver binding, expecting to be
  44  * told what devices exist. That may be in arch/X/mach-Y/board-Z.c or
  45  * similar kernel-resident tables; or, configuration data coming from
  46  * a bootloader.
  47  *
  48  * Other than binding model, current differences from "eeprom" driver are
  49  * that this one handles write access and isn't restricted to 24c02 devices.
  50  * It also handles larger devices (32 kbit and up) with two-byte addresses,
  51  * which won't work on pure SMBus systems.
  52  */
  53
  54 struct at24_data {
  55         struct at24_platform_data chip;
  56         struct memory_accessor macc;
  57         bool use_smbus;
  58
  59         /*
  60          * Lock protects against activities from other Linux tasks,
  61          * but not from changes by other I2C masters.
  62          */
  63         struct mutex lock;
  64         struct bin_attribute bin;
  65
  66         u8 *writebuf;
  67         unsigned write_max;
  68         unsigned num_addresses;
  69
  70         /*
  71          * Some chips tie up multiple I2C addresses; dummy devices reserve
  72          * them for us, and we'll use them with SMBus calls.
  73          */
  74         struct i2c_client *client[];
  75 };
  76
  77 /*
  78  * This parameter is to help this driver avoid blocking other drivers out
  79  * of I2C for potentially troublesome amounts of time. With a 100 kHz I2C
  80  * clock, one 256 byte read takes about 1/43 second which is excessive;
  81  * but the 1/170 second it takes at 400 kHz may be quite reasonable; and
  82  * at 1 MHz (Fm+) a 1/430 second delay could easily be invisible.
  83  *
  84  * This value is forced to be a power of two so that writes align on pages.
  85  */
  86 static unsigned io_limit = 128;
  87 module_param(io_limit, uint, 0);
  88 MODULE_PARM_DESC(io_limit, "Maximum bytes per I/O (default 128)");
  89
  90 /*
  91  * Specs often allow 5 msec for a page write, sometimes 20 msec;
  92  * it's important to recover from write timeouts.
  93  */
  94 static unsigned write_timeout = 25;
  95 module_param(write_timeout, uint, 0);
  96 MODULE_PARM_DESC(write_timeout, "Time (in ms) to try writes (default 25)");
  97
  98 #define AT24_SIZE_BYTELEN 5
  99 #define AT24_SIZE_FLAGS 8
 100
 101 #define AT24_BITMASK(x) (BIT(x) - 1)
 102
 103 /* create non-zero magic value for given eeprom parameters */
 104 #define AT24_DEVICE_MAGIC(_len, _flags)                 \
 105         ((1 << AT24_SIZE_FLAGS | (_flags))              \
 106             << AT24_SIZE_BYTELEN | ilog2(_len))
 107
 108 static const struct i2c_device_id at24_ids[] = {
 109         /* needs 8 addresses as A0-A2 are ignored */
 110         { "24c00", AT24_DEVICE_MAGIC(128 / 8, AT24_FLAG_TAKE8ADDR) },
 111         /* old variants can't be handled with this generic entry! */
 112         { "24c01", AT24_DEVICE_MAGIC(1024 / 8, 0) },
 113         { "24c02", AT24_DEVICE_MAGIC(2048 / 8, 0) },
 114         /* spd is a 24c02 in memory DIMMs */
 115         { "spd", AT24_DEVICE_MAGIC(2048 / 8,
 116                 AT24_FLAG_READONLY | AT24_FLAG_IRUGO) },
 117         { "24c04", AT24_DEVICE_MAGIC(4096 / 8, 0) },
 118         /* 24rf08 quirk is handled at i2c-core */
 119         { "24c08", AT24_DEVICE_MAGIC(8192 / 8, 0) },
 120         { "24c16", AT24_DEVICE_MAGIC(16384 / 8, 0) },
 121         { "24c32", AT24_DEVICE_MAGIC(32768 / 8, AT24_FLAG_ADDR16) },
 122         { "24c64", AT24_DEVICE_MAGIC(65536 / 8, AT24_FLAG_ADDR16) },
 123         { "24c128", AT24_DEVICE_MAGIC(131072 / 8, AT24_FLAG_ADDR16) },
 124         { "24c256", AT24_DEVICE_MAGIC(262144 / 8, AT24_FLAG_ADDR16) },
 125         { "24c512", AT24_DEVICE_MAGIC(524288 / 8, AT24_FLAG_ADDR16) },
 126         { "24c1024", AT24_DEVICE_MAGIC(1048576 / 8, AT24_FLAG_ADDR16) },
 127         { "at24", 0 },
 128         { /* END OF LIST */ }
 129 };
 130 MODULE_DEVICE_TABLE(i2c, at24_ids);
 131
 132 /*-------------------------------------------------------------------------*/
 133
 134 /*
 135  * This routine supports chips which consume multiple I2C addresses. It
 136  * computes the addressing information to be used for a given r/w request.
 137  * Assumes that sanity checks for offset happened at sysfs-layer.
 138  */
 139 static struct i2c_client *at24_translate_offset(struct at24_data *at24,
 140                 unsigned *offset)
 141 {
 142         unsigned i;
 143
 144         if (at24->chip.flags & AT24_FLAG_ADDR16) {
 145                 i = *offset >> 16;
 146                 *offset &= 0xffff;
 147         } else {
 148                 i = *offset >> 8;
 149                 *offset &= 0xff;
 150         }
 151
 152         return at24->client[i];
 153 }
 154
 155 static ssize_t at24_eeprom_read(struct at24_data *at24, char *buf,
 156                 unsigned offset, size_t count)
 157 {
 158         struct i2c_msg msg[2];
 159         u8 msgbuf[2];
 160         struct i2c_client *client;
 161         unsigned long timeout, read_time;
 162         int status, i;
 163
 164         memset(msg, 0, sizeof(msg));
 165
 166         /*
 167          * REVISIT some multi-address chips don't rollover page reads to
 168          * the next slave address, so we may need to truncate the count.
 169          * Those chips might need another quirk flag.
 170          *
 171          * If the real hardware used four adjacent 24c02 chips and that
 172          * were misconfigured as one 24c08, that would be a similar effect:
 173          * one "eeprom" file not four, but larger reads would fail when
 174          * they crossed certain pages.
 175          */
 176
 177         /*
 178          * Slave address and byte offset derive from the offset. Always
 179          * set the byte address; on a multi-master board, another master
 180          * may have changed the chip's "current" address pointer.
 181          */
 182         client = at24_translate_offset(at24, &offset);
 183
 184         if (count > io_limit)
 185                 count = io_limit;
 186
 187         if (at24->use_smbus) {
 188                 /* Smaller eeproms can work given some SMBus extension calls */
 189                 if (count > I2C_SMBUS_BLOCK_MAX)
 190                         count = I2C_SMBUS_BLOCK_MAX;
 191         } else {
 192                 /*
 193                  * When we have a better choice than SMBus calls, use a
 194                  * combined I2C message. Write address; then read up to
 195                  * io_limit data bytes. Note that read page rollover helps us
 196                  * here (unlike writes). msgbuf is u8 and will cast to our
 197                  * needs.
 198                  */
 199                 i = 0;
 200                 if (at24->chip.flags & AT24_FLAG_ADDR16)
 201                         msgbuf[i++] = offset >> 8;
 202                 msgbuf[i++] = offset;
 203
 204                 msg[0].addr = client->addr;
 205                 msg[0].buf = msgbuf;
 206                 msg[0].len = i;
 207
 208                 msg[1].addr = client->addr;
 209                 msg[1].flags = I2C_M_RD;
 210                 msg[1].buf = buf;
 211                 msg[1].len = count;
 212         }
 213
 214         /*
 215          * Reads fail if the previous write didn't complete yet. We may
 216          * loop a few times until this one succeeds, waiting at least
 217          * long enough for one entire page write to work.
 218          */
 219         timeout = jiffies + msecs_to_jiffies(write_timeout);
 220         do {
 221                 read_time = jiffies;
 222                 if (at24->use_smbus) {
 223                         status = i2c_smbus_read_i2c_block_data(client, offset,
 224                                         count, buf);
 225                 } else {
 226                         status = i2c_transfer(client->adapter, msg, 2);
 227                         if (status == 2)
 228                                 status = count;
 229                 }
 230                 dev_dbg(&client->dev, "read %zu@%d --> %d (%ld)\n",
 231                                 count, offset, status, jiffies);
 232
 233                 if (status == count)
 234                         return count;
 235
 236                 /* REVISIT: at HZ=100, this is sloooow */
 237                 msleep(1);
 238         } while (time_before(read_time, timeout));
 239
 240         return -ETIMEDOUT;
 241 }
 242
 243 static ssize_t at24_read(struct at24_data *at24,
 244                 char *buf, loff_t off, size_t count)
 245 {
 246         ssize_t retval = 0;
 247
 248         if (unlikely(!count))
 249                 return count;
 250
 251         /*
 252          * Read data from chip, protecting against concurrent updates
 253          * from this host, but not from other I2C masters.
 254          */
 255         mutex_lock(&at24->lock);
 256
 257         while (count) {
 258                 ssize_t status;
 259
 260                 status = at24_eeprom_read(at24, buf, off, count);
 261                 if (status <= 0) {
 262                         if (retval == 0)
 263                                 retval = status;
 264                         break;
 265                 }
 266                 buf += status;
 267                 off += status;
 268                 count -= status;
 269                 retval += status;
 270         }
 271
 272         mutex_unlock(&at24->lock);
 273
 274         return retval;
 275 }
 276
 277 static ssize_t at24_bin_read(struct file *filp, struct kobject *kobj,
 278                 struct bin_attribute *attr,
 279                 char *buf, loff_t off, size_t count)
 280 {
 281         struct at24_data *at24;
 282
 283         at24 = dev_get_drvdata(container_of(kobj, struct device, kobj));
 284         return at24_read(at24, buf, off, count);
 285 }
 286
 287
 288 /*
 289  * Note that if the hardware write-protect pin is pulled high, the whole
 290  * chip is normally write protected. But there are plenty of product
 291  * variants here, including OTP fuses and partial chip protect.
 292  *
 293  * We only use page mode writes; the alternative is sloooow. This routine
 294  * writes at most one page.
 295  */
 296 static ssize_t at24_eeprom_write(struct at24_data *at24, const char *buf,
 297                 unsigned offset, size_t count)
 298 {
 299         struct i2c_client *client;
 300         struct i2c_msg msg;
 301         ssize_t status;
 302         unsigned long timeout, write_time;
 303         unsigned next_page;
 304
 305         /* Get corresponding I2C address and adjust offset */
 306         client = at24_translate_offset(at24, &offset);
 307
 308         /* write_max is at most a page */
 309         if (count > at24->write_max)
 310                 count = at24->write_max;
 311
 312         /* Never roll over backwards, to the start of this page */
 313         next_page = roundup(offset + 1, at24->chip.page_size);
 314         if (offset + count > next_page)
 315                 count = next_page - offset;
 316
 317         /* If we'll use I2C calls for I/O, set up the message */
 318         if (!at24->use_smbus) {
 319                 int i = 0;
 320
 321                 msg.addr = client->addr;
 322                 msg.flags = 0;
 323
 324                 /* msg.buf is u8 and casts will mask the values */
 325                 msg.buf = at24->writebuf;
 326                 if (at24->chip.flags & AT24_FLAG_ADDR16)
 327                         msg.buf[i++] = offset >> 8;
 328
 329                 msg.buf[i++] = offset;
 330                 memcpy(&msg.buf[i], buf, count);
 331                 msg.len = i + count;
 332         }
 333
 334         /*
 335          * Writes fail if the previous one didn't complete yet. We may
 336          * loop a few times until this one succeeds, waiting at least
 337          * long enough for one entire page write to work.
 338          */
 339         timeout = jiffies + msecs_to_jiffies(write_timeout);
 340         do {
 341                 write_time = jiffies;
 342                 if (at24->use_smbus) {
 343                         status = i2c_smbus_write_i2c_block_data(client,
 344                                         offset, count, buf);
 345                         if (status == 0)
 346                                 status = count;
 347                 } else {
 348                         status = i2c_transfer(client->adapter, &msg, 1);
 349                         if (status == 1)
 350                                 status = count;
 351                 }
 352                 dev_dbg(&client->dev, "write %zu@%d --> %zd (%ld)\n",
 353                                 count, offset, status, jiffies);
 354
 355                 if (status == count)
 356                         return count;
 357
 358                 /* REVISIT: at HZ=100, this is sloooow */
 359                 msleep(1);
 360         } while (time_before(write_time, timeout));
 361
 362         return -ETIMEDOUT;
 363 }
 364
 365 static ssize_t at24_write(struct at24_data *at24, const char *buf, loff_t off,
 366                           size_t count)
 367 {
 368         ssize_t retval = 0;
 369
 370         if (unlikely(!count))
 371                 return count;
 372
 373         /*
 374          * Write data to chip, protecting against concurrent updates
 375          * from this host, but not from other I2C masters.
 376          */
 377         mutex_lock(&at24->lock);
 378
 379         while (count) {
 380                 ssize_t status;
 381
 382                 status = at24_eeprom_write(at24, buf, off, count);
 383                 if (status <= 0) {
 384                         if (retval == 0)
 385                                 retval = status;
 386                         break;
 387                 }
 388                 buf += status;
 389                 off += status;
 390                 count -= status;
 391                 retval += status;
 392         }
 393
 394         mutex_unlock(&at24->lock);
 395
 396         return retval;
 397 }
 398
 399 static ssize_t at24_bin_write(struct file *filp, struct kobject *kobj,
 400                 struct bin_attribute *attr,
 401                 char *buf, loff_t off, size_t count)
 402 {
 403         struct at24_data *at24;
 404
 405         at24 = dev_get_drvdata(container_of(kobj, struct device, kobj));
 406         return at24_write(at24, buf, off, count);
 407 }
 408
 409 /*-------------------------------------------------------------------------*/
 410
 411 /*
 412  * This lets other kernel code access the eeprom data. For example, it
 413  * might hold a board's Ethernet address, or board-specific calibration
 414  * data generated on the manufacturing floor.
 415  */
 416
 417 static ssize_t at24_macc_read(struct memory_accessor *macc, char *buf,
 418                          off_t offset, size_t count)
 419 {
 420         struct at24_data *at24 = container_of(macc, struct at24_data, macc);
 421
 422         return at24_read(at24, buf, offset, count);
 423 }
 424
 425 static ssize_t at24_macc_write(struct memory_accessor *macc, const char *buf,
 426                           off_t offset, size_t count)
 427 {
 428         struct at24_data *at24 = container_of(macc, struct at24_data, macc);
 429
 430         return at24_write(at24, buf, offset, count);
 431 }
 432
 433 /*-------------------------------------------------------------------------*/
 434
 435 static int at24_probe(struct i2c_client *client, const struct i2c_device_id *id)
 436 {
 437         struct at24_platform_data chip;
 438         bool writable;
 439         bool use_smbus = false;
 440         struct at24_data *at24;
 441         int err;
 442         unsigned i, num_addresses;
 443         kernel_ulong_t magic;
 444
 445         if (client->dev.platform_data) {
 446                 chip = *(struct at24_platform_data *)client->dev.platform_data;
 447         } else {
 448                 if (!id->driver_data) {
 449                         err = -ENODEV;
 450                         goto err_out;
 451                 }
 452                 magic = id->driver_data;
 453                 chip.byte_len = BIT(magic & AT24_BITMASK(AT24_SIZE_BYTELEN));
 454                 magic >>= AT24_SIZE_BYTELEN;
 455                 chip.flags = magic & AT24_BITMASK(AT24_SIZE_FLAGS);
 456                 /*
 457                  * This is slow, but we can't know all eeproms, so we better
 458                  * play safe. Specifying custom eeprom-types via platform_data
 459                  * is recommended anyhow.
 460                  */
 461                 chip.page_size = 1;
 462
 463                 chip.setup = NULL;
 464                 chip.context = NULL;
 465         }
 466
 467         if (!is_power_of_2(chip.byte_len))
 468                 dev_warn(&client->dev,
 469                         "byte_len looks suspicious (no power of 2)!\n");
 470         if (!is_power_of_2(chip.page_size))
 471                 dev_warn(&client->dev,
 472                         "page_size looks suspicious (no power of 2)!\n");
 473
 474         /* Use I2C operations unless we're stuck with SMBus extensions. */
 475         if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
 476                 if (chip.flags & AT24_FLAG_ADDR16) {
 477                         err = -EPFNOSUPPORT;
 478                         goto err_out;
 479                 }
 480                 if (!i2c_check_functionality(client->adapter,
 481                                 I2C_FUNC_SMBUS_READ_I2C_BLOCK)) {
 482                         err = -EPFNOSUPPORT;
 483                         goto err_out;
 484                 }
 485                 use_smbus = true;
 486         }
 487
 488         if (chip.flags & AT24_FLAG_TAKE8ADDR)
 489                 num_addresses = 8;
 490         else
 491                 num_addresses = DIV_ROUND_UP(chip.byte_len,
 492                         (chip.flags & AT24_FLAG_ADDR16) ? 65536 : 256);
 493
 494         at24 = kzalloc(sizeof(struct at24_data) +
 495                 num_addresses * sizeof(struct i2c_client *), GFP_KERNEL);
 496         if (!at24) {
 497                 err = -ENOMEM;
 498                 goto err_out;
 499         }
 500
 501         mutex_init(&at24->lock);
 502         at24->use_smbus = use_smbus;
 503         at24->chip = chip;
 504         at24->num_addresses = num_addresses;
 505
 506         /*
 507          * Export the EEPROM bytes through sysfs, since that's convenient.
 508          * By default, only root should see the data (maybe passwords etc)
 509          */
 510         sysfs_bin_attr_init(&at24->bin);
 511         at24->bin.attr.name = "eeprom";
 512         at24->bin.attr.mode = chip.flags & AT24_FLAG_IRUGO ? S_IRUGO : S_IRUSR;
 513         at24->bin.read = at24_bin_read;
 514         at24->bin.size = chip.byte_len;
 515
 516         at24->macc.read = at24_macc_read;
 517
 518         writable = !(chip.flags & AT24_FLAG_READONLY);
 519         if (writable) {
 520                 if (!use_smbus || i2c_check_functionality(client->adapter,
 521                                 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)) {
 522
 523                         unsigned write_max = chip.page_size;
 524
 525                         at24->macc.write = at24_macc_write;
 526
 527                         at24->bin.write = at24_bin_write;
 528                         at24->bin.attr.mode |= S_IWUSR;
 529
 530                         if (write_max > io_limit)
 531                                 write_max = io_limit;
 532                         if (use_smbus && write_max > I2C_SMBUS_BLOCK_MAX)
 533                                 write_max = I2C_SMBUS_BLOCK_MAX;
 534                         at24->write_max = write_max;
 535
 536                         /* buffer (data + address at the beginning) */
 537                         at24->writebuf = kmalloc(write_max + 2, GFP_KERNEL);
 538                         if (!at24->writebuf) {
 539                                 err = -ENOMEM;
 540                                 goto err_struct;
 541                         }
 542                 } else {
 543                         dev_warn(&client->dev,
 544                                 "cannot write due to controller restrictions.");
 545                 }
 546         }
 547
 548         at24->client[0] = client;
 549
 550         /* use dummy devices for multiple-address chips */
 551         for (i = 1; i < num_addresses; i++) {
 552                 at24->client[i] = i2c_new_dummy(client->adapter,
 553                                         client->addr + i);
 554                 if (!at24->client[i]) {
 555                         dev_err(&client->dev, "address 0x%02x unavailable\n",
 556                                         client->addr + i);
 557                         err = -EADDRINUSE;
 558                         goto err_clients;
 559                 }
 560         }
 561
 562         err = sysfs_create_bin_file(&client->dev.kobj, &at24->bin);
 563         if (err)
 564                 goto err_clients;
 565
 566         i2c_set_clientdata(client, at24);
 567
 568         dev_info(&client->dev, "%zu byte %s EEPROM %s\n",
 569                 at24->bin.size, client->name,
 570                 writable ? "(writable)" : "(read-only)");
 571         dev_dbg(&client->dev,
 572                 "page_size %d, num_addresses %d, write_max %d%s\n",
 573                 chip.page_size, num_addresses,
 574                 at24->write_max,
 575                 use_smbus ? ", use_smbus" : "");
 576
 577         /* export data to kernel code */
 578         if (chip.setup)
 579                 chip.setup(&at24->macc, chip.context);
 580
 581         return 0;
 582
 583 err_clients:
 584         for (i = 1; i < num_addresses; i++)
 585                 if (at24->client[i])
 586                         i2c_unregister_device(at24->client[i]);
 587
 588         kfree(at24->writebuf);
 589 err_struct:
 590         kfree(at24);
 591 err_out:
 592         dev_dbg(&client->dev, "probe error %d\n", err);
 593         return err;
 594 }
 595
 596 static int __devexit at24_remove(struct i2c_client *client)
 597 {
 598         struct at24_data *at24;
 599         int i;
 600
 601         at24 = i2c_get_clientdata(client);
 602         sysfs_remove_bin_file(&client->dev.kobj, &at24->bin);
 603
 604         for (i = 1; i < at24->num_addresses; i++)
 605                 i2c_unregister_device(at24->client[i]);
 606
 607         kfree(at24->writebuf);
 608         kfree(at24);
 609         i2c_set_clientdata(client, NULL);
 610         return 0;
 611 }
 612
 613 /*-------------------------------------------------------------------------*/
 614
 615 static struct i2c_driver at24_driver = {
 616         .driver = {
 617                 .name = "at24",
 618                 .owner = THIS_MODULE,
 619         },
 620         .probe = at24_probe,
 621         .remove = __devexit_p(at24_remove),
 622         .id_table = at24_ids,
 623 };
 624
 625 static int __init at24_init(void)
 626 {
 627         io_limit = rounddown_pow_of_two(io_limit);
 628         return i2c_add_driver(&at24_driver);
 629 }
 630 module_init(at24_init);
 631
 632 static void __exit at24_exit(void)
 633 {
 634         i2c_del_driver(&at24_driver);
 635 }
 636 module_exit(at24_exit);
 637
 638 MODULE_DESCRIPTION("Driver for most I2C EEPROMs");
 639 MODULE_AUTHOR("David Brownell and Wolfram Sang");
 640 MODULE_LICENSE("GPL");