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