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