• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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/platform_data/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 
55 struct 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  */
87 static unsigned io_limit = 128;
88 module_param(io_limit, uint, 0);
89 MODULE_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  */
95 static unsigned write_timeout = 25;
96 module_param(write_timeout, uint, 0);
97 MODULE_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 
109 static 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 };
131 MODULE_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  */
at24_translate_offset(struct at24_data * at24,unsigned * offset)140 static 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 
at24_eeprom_read(struct at24_data * at24,char * buf,unsigned offset,size_t count)156 static 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 
at24_read(struct at24_data * at24,char * buf,loff_t off,size_t count)269 static 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 	if (off + count > at24->chip.byte_len)
278 		return -EINVAL;
279 
280 	/*
281 	 * Read data from chip, protecting against concurrent updates
282 	 * from this host, but not from other I2C masters.
283 	 */
284 	mutex_lock(&at24->lock);
285 
286 	while (count) {
287 		ssize_t	status;
288 
289 		status = at24_eeprom_read(at24, buf, off, count);
290 		if (status <= 0) {
291 			if (retval == 0)
292 				retval = status;
293 			break;
294 		}
295 		buf += status;
296 		off += status;
297 		count -= status;
298 		retval += status;
299 	}
300 
301 	mutex_unlock(&at24->lock);
302 
303 	return retval;
304 }
305 
at24_bin_read(struct file * filp,struct kobject * kobj,struct bin_attribute * attr,char * buf,loff_t off,size_t count)306 static ssize_t at24_bin_read(struct file *filp, struct kobject *kobj,
307 		struct bin_attribute *attr,
308 		char *buf, loff_t off, size_t count)
309 {
310 	struct at24_data *at24;
311 
312 	at24 = dev_get_drvdata(container_of(kobj, struct device, kobj));
313 	return at24_read(at24, buf, off, count);
314 }
315 
316 
317 /*
318  * Note that if the hardware write-protect pin is pulled high, the whole
319  * chip is normally write protected. But there are plenty of product
320  * variants here, including OTP fuses and partial chip protect.
321  *
322  * We only use page mode writes; the alternative is sloooow. This routine
323  * writes at most one page.
324  */
at24_eeprom_write(struct at24_data * at24,const char * buf,unsigned offset,size_t count)325 static ssize_t at24_eeprom_write(struct at24_data *at24, const char *buf,
326 		unsigned offset, size_t count)
327 {
328 	struct i2c_client *client;
329 	struct i2c_msg msg;
330 	ssize_t status;
331 	unsigned long timeout, write_time;
332 	unsigned next_page;
333 
334 	if (offset + count > at24->chip.byte_len)
335 		return -EINVAL;
336 
337 	/* Get corresponding I2C address and adjust offset */
338 	client = at24_translate_offset(at24, &offset);
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->chip.page_size);
346 	if (offset + count > next_page)
347 		count = next_page - offset;
348 
349 	/* If we'll use I2C calls for I/O, set up the message */
350 	if (!at24->use_smbus) {
351 		int i = 0;
352 
353 		msg.addr = client->addr;
354 		msg.flags = 0;
355 
356 		/* msg.buf is u8 and casts will mask the values */
357 		msg.buf = at24->writebuf;
358 		if (at24->chip.flags & AT24_FLAG_ADDR16)
359 			msg.buf[i++] = offset >> 8;
360 
361 		msg.buf[i++] = offset;
362 		memcpy(&msg.buf[i], buf, count);
363 		msg.len = i + count;
364 	}
365 
366 	/*
367 	 * Writes fail if the previous one didn't complete yet. We may
368 	 * loop a few times until this one succeeds, waiting at least
369 	 * long enough for one entire page write to work.
370 	 */
371 	timeout = jiffies + msecs_to_jiffies(write_timeout);
372 	do {
373 		write_time = jiffies;
374 		if (at24->use_smbus) {
375 			status = i2c_smbus_write_i2c_block_data(client,
376 					offset, count, buf);
377 			if (status == 0)
378 				status = count;
379 		} else {
380 			status = i2c_transfer(client->adapter, &msg, 1);
381 			if (status == 1)
382 				status = count;
383 		}
384 		dev_dbg(&client->dev, "write %zu@%d --> %zd (%ld)\n",
385 				count, offset, status, jiffies);
386 
387 		if (status == count)
388 			return count;
389 
390 		/* REVISIT: at HZ=100, this is sloooow */
391 		msleep(1);
392 	} while (time_before(write_time, timeout));
393 
394 	return -ETIMEDOUT;
395 }
396 
at24_write(struct at24_data * at24,const char * buf,loff_t off,size_t count)397 static ssize_t at24_write(struct at24_data *at24, const char *buf, loff_t off,
398 			  size_t count)
399 {
400 	ssize_t retval = 0;
401 
402 	if (unlikely(!count))
403 		return count;
404 
405 	/*
406 	 * Write data to chip, protecting against concurrent updates
407 	 * from this host, but not from other I2C masters.
408 	 */
409 	mutex_lock(&at24->lock);
410 
411 	while (count) {
412 		ssize_t	status;
413 
414 		status = at24_eeprom_write(at24, buf, off, count);
415 		if (status <= 0) {
416 			if (retval == 0)
417 				retval = status;
418 			break;
419 		}
420 		buf += status;
421 		off += status;
422 		count -= status;
423 		retval += status;
424 	}
425 
426 	mutex_unlock(&at24->lock);
427 
428 	return retval;
429 }
430 
at24_bin_write(struct file * filp,struct kobject * kobj,struct bin_attribute * attr,char * buf,loff_t off,size_t count)431 static ssize_t at24_bin_write(struct file *filp, struct kobject *kobj,
432 		struct bin_attribute *attr,
433 		char *buf, loff_t off, size_t count)
434 {
435 	struct at24_data *at24;
436 
437 	if (unlikely(off >= attr->size))
438 		return -EFBIG;
439 
440 	at24 = dev_get_drvdata(container_of(kobj, struct device, kobj));
441 	return at24_write(at24, buf, off, count);
442 }
443 
444 /*-------------------------------------------------------------------------*/
445 
446 /*
447  * This lets other kernel code access the eeprom data. For example, it
448  * might hold a board's Ethernet address, or board-specific calibration
449  * data generated on the manufacturing floor.
450  */
451 
at24_macc_read(struct memory_accessor * macc,char * buf,off_t offset,size_t count)452 static ssize_t at24_macc_read(struct memory_accessor *macc, char *buf,
453 			 off_t offset, size_t count)
454 {
455 	struct at24_data *at24 = container_of(macc, struct at24_data, macc);
456 
457 	return at24_read(at24, buf, offset, count);
458 }
459 
at24_macc_write(struct memory_accessor * macc,const char * buf,off_t offset,size_t count)460 static ssize_t at24_macc_write(struct memory_accessor *macc, const char *buf,
461 			  off_t offset, size_t count)
462 {
463 	struct at24_data *at24 = container_of(macc, struct at24_data, macc);
464 
465 	return at24_write(at24, buf, offset, count);
466 }
467 
468 /*-------------------------------------------------------------------------*/
469 
470 #ifdef CONFIG_OF
at24_get_ofdata(struct i2c_client * client,struct at24_platform_data * chip)471 static void at24_get_ofdata(struct i2c_client *client,
472 		struct at24_platform_data *chip)
473 {
474 	const __be32 *val;
475 	struct device_node *node = client->dev.of_node;
476 
477 	if (node) {
478 		if (of_get_property(node, "read-only", NULL))
479 			chip->flags |= AT24_FLAG_READONLY;
480 		val = of_get_property(node, "pagesize", NULL);
481 		if (val)
482 			chip->page_size = be32_to_cpup(val);
483 	}
484 }
485 #else
at24_get_ofdata(struct i2c_client * client,struct at24_platform_data * chip)486 static void at24_get_ofdata(struct i2c_client *client,
487 		struct at24_platform_data *chip)
488 { }
489 #endif /* CONFIG_OF */
490 
at24_probe(struct i2c_client * client,const struct i2c_device_id * id)491 static int at24_probe(struct i2c_client *client, const struct i2c_device_id *id)
492 {
493 	struct at24_platform_data chip;
494 	bool writable;
495 	int use_smbus = 0;
496 	struct at24_data *at24;
497 	int err;
498 	unsigned i, num_addresses;
499 	kernel_ulong_t magic;
500 
501 	if (client->dev.platform_data) {
502 		chip = *(struct at24_platform_data *)client->dev.platform_data;
503 	} else {
504 		if (!id->driver_data)
505 			return -ENODEV;
506 
507 		magic = id->driver_data;
508 		chip.byte_len = BIT(magic & AT24_BITMASK(AT24_SIZE_BYTELEN));
509 		magic >>= AT24_SIZE_BYTELEN;
510 		chip.flags = magic & AT24_BITMASK(AT24_SIZE_FLAGS);
511 		/*
512 		 * This is slow, but we can't know all eeproms, so we better
513 		 * play safe. Specifying custom eeprom-types via platform_data
514 		 * is recommended anyhow.
515 		 */
516 		chip.page_size = 1;
517 
518 		/* update chipdata if OF is present */
519 		at24_get_ofdata(client, &chip);
520 
521 		chip.setup = NULL;
522 		chip.context = NULL;
523 	}
524 
525 	if (!is_power_of_2(chip.byte_len))
526 		dev_warn(&client->dev,
527 			"byte_len looks suspicious (no power of 2)!\n");
528 	if (!chip.page_size) {
529 		dev_err(&client->dev, "page_size must not be 0!\n");
530 		return -EINVAL;
531 	}
532 	if (!is_power_of_2(chip.page_size))
533 		dev_warn(&client->dev,
534 			"page_size looks suspicious (no power of 2)!\n");
535 
536 	/* Use I2C operations unless we're stuck with SMBus extensions. */
537 	if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
538 		if (chip.flags & AT24_FLAG_ADDR16)
539 			return -EPFNOSUPPORT;
540 
541 		if (i2c_check_functionality(client->adapter,
542 				I2C_FUNC_SMBUS_READ_I2C_BLOCK)) {
543 			use_smbus = I2C_SMBUS_I2C_BLOCK_DATA;
544 		} else if (i2c_check_functionality(client->adapter,
545 				I2C_FUNC_SMBUS_READ_WORD_DATA)) {
546 			use_smbus = I2C_SMBUS_WORD_DATA;
547 		} else if (i2c_check_functionality(client->adapter,
548 				I2C_FUNC_SMBUS_READ_BYTE_DATA)) {
549 			use_smbus = I2C_SMBUS_BYTE_DATA;
550 		} else {
551 			return -EPFNOSUPPORT;
552 		}
553 	}
554 
555 	if (chip.flags & AT24_FLAG_TAKE8ADDR)
556 		num_addresses = 8;
557 	else
558 		num_addresses =	DIV_ROUND_UP(chip.byte_len,
559 			(chip.flags & AT24_FLAG_ADDR16) ? 65536 : 256);
560 
561 	at24 = devm_kzalloc(&client->dev, sizeof(struct at24_data) +
562 		num_addresses * sizeof(struct i2c_client *), GFP_KERNEL);
563 	if (!at24)
564 		return -ENOMEM;
565 
566 	mutex_init(&at24->lock);
567 	at24->use_smbus = use_smbus;
568 	at24->chip = chip;
569 	at24->num_addresses = num_addresses;
570 
571 	/*
572 	 * Export the EEPROM bytes through sysfs, since that's convenient.
573 	 * By default, only root should see the data (maybe passwords etc)
574 	 */
575 	sysfs_bin_attr_init(&at24->bin);
576 	at24->bin.attr.name = "eeprom";
577 	at24->bin.attr.mode = chip.flags & AT24_FLAG_IRUGO ? S_IRUGO : S_IRUSR;
578 	at24->bin.read = at24_bin_read;
579 	at24->bin.size = chip.byte_len;
580 
581 	at24->macc.read = at24_macc_read;
582 
583 	writable = !(chip.flags & AT24_FLAG_READONLY);
584 	if (writable) {
585 		if (!use_smbus || i2c_check_functionality(client->adapter,
586 				I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)) {
587 
588 			unsigned write_max = chip.page_size;
589 
590 			at24->macc.write = at24_macc_write;
591 
592 			at24->bin.write = at24_bin_write;
593 			at24->bin.attr.mode |= S_IWUSR;
594 
595 			if (write_max > io_limit)
596 				write_max = io_limit;
597 			if (use_smbus && write_max > I2C_SMBUS_BLOCK_MAX)
598 				write_max = I2C_SMBUS_BLOCK_MAX;
599 			at24->write_max = write_max;
600 
601 			/* buffer (data + address at the beginning) */
602 			at24->writebuf = devm_kzalloc(&client->dev,
603 				write_max + 2, GFP_KERNEL);
604 			if (!at24->writebuf)
605 				return -ENOMEM;
606 		} else {
607 			dev_warn(&client->dev,
608 				"cannot write due to controller restrictions.");
609 		}
610 	}
611 
612 	at24->client[0] = client;
613 
614 	/* use dummy devices for multiple-address chips */
615 	for (i = 1; i < num_addresses; i++) {
616 		at24->client[i] = i2c_new_dummy(client->adapter,
617 					client->addr + i);
618 		if (!at24->client[i]) {
619 			dev_err(&client->dev, "address 0x%02x unavailable\n",
620 					client->addr + i);
621 			err = -EADDRINUSE;
622 			goto err_clients;
623 		}
624 	}
625 
626 	err = sysfs_create_bin_file(&client->dev.kobj, &at24->bin);
627 	if (err)
628 		goto err_clients;
629 
630 	i2c_set_clientdata(client, at24);
631 
632 	dev_info(&client->dev, "%zu byte %s EEPROM, %s, %u bytes/write\n",
633 		at24->bin.size, client->name,
634 		writable ? "writable" : "read-only", at24->write_max);
635 	if (use_smbus == I2C_SMBUS_WORD_DATA ||
636 	    use_smbus == I2C_SMBUS_BYTE_DATA) {
637 		dev_notice(&client->dev, "Falling back to %s reads, "
638 			   "performance will suffer\n", use_smbus ==
639 			   I2C_SMBUS_WORD_DATA ? "word" : "byte");
640 	}
641 
642 	/* export data to kernel code */
643 	if (chip.setup)
644 		chip.setup(&at24->macc, chip.context);
645 
646 	return 0;
647 
648 err_clients:
649 	for (i = 1; i < num_addresses; i++)
650 		if (at24->client[i])
651 			i2c_unregister_device(at24->client[i]);
652 
653 	return err;
654 }
655 
at24_remove(struct i2c_client * client)656 static int at24_remove(struct i2c_client *client)
657 {
658 	struct at24_data *at24;
659 	int i;
660 
661 	at24 = i2c_get_clientdata(client);
662 	sysfs_remove_bin_file(&client->dev.kobj, &at24->bin);
663 
664 	for (i = 1; i < at24->num_addresses; i++)
665 		i2c_unregister_device(at24->client[i]);
666 
667 	return 0;
668 }
669 
670 /*-------------------------------------------------------------------------*/
671 
672 static struct i2c_driver at24_driver = {
673 	.driver = {
674 		.name = "at24",
675 		.owner = THIS_MODULE,
676 	},
677 	.probe = at24_probe,
678 	.remove = at24_remove,
679 	.id_table = at24_ids,
680 };
681 
at24_init(void)682 static int __init at24_init(void)
683 {
684 	if (!io_limit) {
685 		pr_err("at24: io_limit must not be 0!\n");
686 		return -EINVAL;
687 	}
688 
689 	io_limit = rounddown_pow_of_two(io_limit);
690 	return i2c_add_driver(&at24_driver);
691 }
692 module_init(at24_init);
693 
at24_exit(void)694 static void __exit at24_exit(void)
695 {
696 	i2c_del_driver(&at24_driver);
697 }
698 module_exit(at24_exit);
699 
700 MODULE_DESCRIPTION("Driver for most I2C EEPROMs");
701 MODULE_AUTHOR("David Brownell and Wolfram Sang");
702 MODULE_LICENSE("GPL");
703