Commit | Line | Data |
---|---|---|
b587b13a DB |
1 | /* |
2 | * at25.c -- support most SPI EEPROMs, such as Atmel AT25 models | |
3 | * | |
4 | * Copyright (C) 2006 David Brownell | |
5 | * | |
6 | * This program is free software; you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License as published by | |
8 | * the Free Software Foundation; either version 2 of the License, or | |
9 | * (at your option) any later version. | |
10 | */ | |
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/device.h> | |
18 | #include <linux/sched.h> | |
19 | ||
20 | #include <linux/spi/spi.h> | |
21 | #include <linux/spi/eeprom.h> | |
22 | ||
23 | ||
3f86f14c DB |
24 | /* |
25 | * NOTE: this is an *EEPROM* driver. The vagaries of product naming | |
26 | * mean that some AT25 products are EEPROMs, and others are FLASH. | |
27 | * Handle FLASH chips with the drivers/mtd/devices/m25p80.c driver, | |
28 | * not this one! | |
29 | */ | |
30 | ||
b587b13a DB |
31 | struct at25_data { |
32 | struct spi_device *spi; | |
14dd1ff0 | 33 | struct memory_accessor mem; |
b587b13a DB |
34 | struct mutex lock; |
35 | struct spi_eeprom chip; | |
36 | struct bin_attribute bin; | |
37 | unsigned addrlen; | |
38 | }; | |
39 | ||
40 | #define AT25_WREN 0x06 /* latch the write enable */ | |
41 | #define AT25_WRDI 0x04 /* reset the write enable */ | |
42 | #define AT25_RDSR 0x05 /* read status register */ | |
43 | #define AT25_WRSR 0x01 /* write status register */ | |
44 | #define AT25_READ 0x03 /* read byte(s) */ | |
45 | #define AT25_WRITE 0x02 /* write byte(s)/sector */ | |
46 | ||
47 | #define AT25_SR_nRDY 0x01 /* nRDY = write-in-progress */ | |
48 | #define AT25_SR_WEN 0x02 /* write enable (latched) */ | |
49 | #define AT25_SR_BP0 0x04 /* BP for software writeprotect */ | |
50 | #define AT25_SR_BP1 0x08 | |
51 | #define AT25_SR_WPEN 0x80 /* writeprotect enable */ | |
52 | ||
53 | ||
54 | #define EE_MAXADDRLEN 3 /* 24 bit addresses, up to 2 MBytes */ | |
55 | ||
56 | /* Specs often allow 5 msec for a page write, sometimes 20 msec; | |
57 | * it's important to recover from write timeouts. | |
58 | */ | |
59 | #define EE_TIMEOUT 25 | |
60 | ||
61 | /*-------------------------------------------------------------------------*/ | |
62 | ||
63 | #define io_limit PAGE_SIZE /* bytes */ | |
64 | ||
65 | static ssize_t | |
66 | at25_ee_read( | |
67 | struct at25_data *at25, | |
68 | char *buf, | |
69 | unsigned offset, | |
70 | size_t count | |
71 | ) | |
72 | { | |
73 | u8 command[EE_MAXADDRLEN + 1]; | |
74 | u8 *cp; | |
75 | ssize_t status; | |
76 | struct spi_transfer t[2]; | |
77 | struct spi_message m; | |
78 | ||
14dd1ff0 DB |
79 | if (unlikely(offset >= at25->bin.size)) |
80 | return 0; | |
81 | if ((offset + count) > at25->bin.size) | |
82 | count = at25->bin.size - offset; | |
83 | if (unlikely(!count)) | |
84 | return count; | |
85 | ||
b587b13a DB |
86 | cp = command; |
87 | *cp++ = AT25_READ; | |
88 | ||
89 | /* 8/16/24-bit address is written MSB first */ | |
90 | switch (at25->addrlen) { | |
91 | default: /* case 3 */ | |
92 | *cp++ = offset >> 16; | |
93 | case 2: | |
94 | *cp++ = offset >> 8; | |
95 | case 1: | |
96 | case 0: /* can't happen: for better codegen */ | |
97 | *cp++ = offset >> 0; | |
98 | } | |
99 | ||
100 | spi_message_init(&m); | |
101 | memset(t, 0, sizeof t); | |
102 | ||
103 | t[0].tx_buf = command; | |
104 | t[0].len = at25->addrlen + 1; | |
105 | spi_message_add_tail(&t[0], &m); | |
106 | ||
107 | t[1].rx_buf = buf; | |
108 | t[1].len = count; | |
109 | spi_message_add_tail(&t[1], &m); | |
110 | ||
111 | mutex_lock(&at25->lock); | |
112 | ||
113 | /* Read it all at once. | |
114 | * | |
115 | * REVISIT that's potentially a problem with large chips, if | |
116 | * other devices on the bus need to be accessed regularly or | |
117 | * this chip is clocked very slowly | |
118 | */ | |
119 | status = spi_sync(at25->spi, &m); | |
120 | dev_dbg(&at25->spi->dev, | |
121 | "read %Zd bytes at %d --> %d\n", | |
122 | count, offset, (int) status); | |
123 | ||
124 | mutex_unlock(&at25->lock); | |
125 | return status ? status : count; | |
126 | } | |
127 | ||
128 | static ssize_t | |
91a69029 ZR |
129 | at25_bin_read(struct kobject *kobj, struct bin_attribute *bin_attr, |
130 | char *buf, loff_t off, size_t count) | |
b587b13a DB |
131 | { |
132 | struct device *dev; | |
133 | struct at25_data *at25; | |
134 | ||
135 | dev = container_of(kobj, struct device, kobj); | |
136 | at25 = dev_get_drvdata(dev); | |
137 | ||
b587b13a DB |
138 | return at25_ee_read(at25, buf, off, count); |
139 | } | |
140 | ||
141 | ||
142 | static ssize_t | |
143 | at25_ee_write(struct at25_data *at25, char *buf, loff_t off, size_t count) | |
144 | { | |
145 | ssize_t status = 0; | |
146 | unsigned written = 0; | |
147 | unsigned buf_size; | |
148 | u8 *bounce; | |
149 | ||
14dd1ff0 DB |
150 | if (unlikely(off >= at25->bin.size)) |
151 | return -EFBIG; | |
152 | if ((off + count) > at25->bin.size) | |
153 | count = at25->bin.size - off; | |
154 | if (unlikely(!count)) | |
155 | return count; | |
156 | ||
b587b13a DB |
157 | /* Temp buffer starts with command and address */ |
158 | buf_size = at25->chip.page_size; | |
159 | if (buf_size > io_limit) | |
160 | buf_size = io_limit; | |
161 | bounce = kmalloc(buf_size + at25->addrlen + 1, GFP_KERNEL); | |
162 | if (!bounce) | |
163 | return -ENOMEM; | |
164 | ||
165 | /* For write, rollover is within the page ... so we write at | |
166 | * most one page, then manually roll over to the next page. | |
167 | */ | |
168 | bounce[0] = AT25_WRITE; | |
169 | mutex_lock(&at25->lock); | |
170 | do { | |
171 | unsigned long timeout, retries; | |
172 | unsigned segment; | |
173 | unsigned offset = (unsigned) off; | |
174 | u8 *cp = bounce + 1; | |
175 | ||
176 | *cp = AT25_WREN; | |
177 | status = spi_write(at25->spi, cp, 1); | |
178 | if (status < 0) { | |
179 | dev_dbg(&at25->spi->dev, "WREN --> %d\n", | |
180 | (int) status); | |
181 | break; | |
182 | } | |
183 | ||
184 | /* 8/16/24-bit address is written MSB first */ | |
185 | switch (at25->addrlen) { | |
186 | default: /* case 3 */ | |
187 | *cp++ = offset >> 16; | |
188 | case 2: | |
189 | *cp++ = offset >> 8; | |
190 | case 1: | |
191 | case 0: /* can't happen: for better codegen */ | |
192 | *cp++ = offset >> 0; | |
193 | } | |
194 | ||
195 | /* Write as much of a page as we can */ | |
196 | segment = buf_size - (offset % buf_size); | |
197 | if (segment > count) | |
198 | segment = count; | |
199 | memcpy(cp, buf, segment); | |
200 | status = spi_write(at25->spi, bounce, | |
201 | segment + at25->addrlen + 1); | |
202 | dev_dbg(&at25->spi->dev, | |
203 | "write %u bytes at %u --> %d\n", | |
204 | segment, offset, (int) status); | |
205 | if (status < 0) | |
206 | break; | |
207 | ||
208 | /* REVISIT this should detect (or prevent) failed writes | |
209 | * to readonly sections of the EEPROM... | |
210 | */ | |
211 | ||
212 | /* Wait for non-busy status */ | |
213 | timeout = jiffies + msecs_to_jiffies(EE_TIMEOUT); | |
214 | retries = 0; | |
215 | do { | |
216 | int sr; | |
217 | ||
218 | sr = spi_w8r8(at25->spi, AT25_RDSR); | |
219 | if (sr < 0 || (sr & AT25_SR_nRDY)) { | |
220 | dev_dbg(&at25->spi->dev, | |
221 | "rdsr --> %d (%02x)\n", sr, sr); | |
222 | /* at HZ=100, this is sloooow */ | |
223 | msleep(1); | |
224 | continue; | |
225 | } | |
226 | if (!(sr & AT25_SR_nRDY)) | |
227 | break; | |
228 | } while (retries++ < 3 || time_before_eq(jiffies, timeout)); | |
229 | ||
230 | if (time_after(jiffies, timeout)) { | |
231 | dev_err(&at25->spi->dev, | |
232 | "write %d bytes offset %d, " | |
233 | "timeout after %u msecs\n", | |
234 | segment, offset, | |
235 | jiffies_to_msecs(jiffies - | |
236 | (timeout - EE_TIMEOUT))); | |
237 | status = -ETIMEDOUT; | |
238 | break; | |
239 | } | |
240 | ||
241 | off += segment; | |
242 | buf += segment; | |
243 | count -= segment; | |
244 | written += segment; | |
245 | ||
246 | } while (count > 0); | |
247 | ||
248 | mutex_unlock(&at25->lock); | |
249 | ||
250 | kfree(bounce); | |
251 | return written ? written : status; | |
252 | } | |
253 | ||
254 | static ssize_t | |
91a69029 ZR |
255 | at25_bin_write(struct kobject *kobj, struct bin_attribute *bin_attr, |
256 | char *buf, loff_t off, size_t count) | |
b587b13a DB |
257 | { |
258 | struct device *dev; | |
259 | struct at25_data *at25; | |
260 | ||
261 | dev = container_of(kobj, struct device, kobj); | |
262 | at25 = dev_get_drvdata(dev); | |
263 | ||
b587b13a DB |
264 | return at25_ee_write(at25, buf, off, count); |
265 | } | |
266 | ||
267 | /*-------------------------------------------------------------------------*/ | |
268 | ||
14dd1ff0 DB |
269 | /* Let in-kernel code access the eeprom data. */ |
270 | ||
271 | static ssize_t at25_mem_read(struct memory_accessor *mem, char *buf, | |
272 | off_t offset, size_t count) | |
273 | { | |
274 | struct at25_data *at25 = container_of(mem, struct at25_data, mem); | |
275 | ||
276 | return at25_ee_read(at25, buf, offset, count); | |
277 | } | |
278 | ||
279 | static ssize_t at25_mem_write(struct memory_accessor *mem, char *buf, | |
280 | off_t offset, size_t count) | |
281 | { | |
282 | struct at25_data *at25 = container_of(mem, struct at25_data, mem); | |
283 | ||
284 | return at25_ee_write(at25, buf, offset, count); | |
285 | } | |
286 | ||
287 | /*-------------------------------------------------------------------------*/ | |
288 | ||
b587b13a DB |
289 | static int at25_probe(struct spi_device *spi) |
290 | { | |
291 | struct at25_data *at25 = NULL; | |
292 | const struct spi_eeprom *chip; | |
293 | int err; | |
294 | int sr; | |
295 | int addrlen; | |
296 | ||
297 | /* Chip description */ | |
298 | chip = spi->dev.platform_data; | |
299 | if (!chip) { | |
300 | dev_dbg(&spi->dev, "no chip description\n"); | |
301 | err = -ENODEV; | |
302 | goto fail; | |
303 | } | |
304 | ||
305 | /* For now we only support 8/16/24 bit addressing */ | |
306 | if (chip->flags & EE_ADDR1) | |
307 | addrlen = 1; | |
308 | else if (chip->flags & EE_ADDR2) | |
309 | addrlen = 2; | |
310 | else if (chip->flags & EE_ADDR3) | |
311 | addrlen = 3; | |
312 | else { | |
313 | dev_dbg(&spi->dev, "unsupported address type\n"); | |
314 | err = -EINVAL; | |
315 | goto fail; | |
316 | } | |
317 | ||
318 | /* Ping the chip ... the status register is pretty portable, | |
319 | * unlike probing manufacturer IDs. We do expect that system | |
320 | * firmware didn't write it in the past few milliseconds! | |
321 | */ | |
322 | sr = spi_w8r8(spi, AT25_RDSR); | |
323 | if (sr < 0 || sr & AT25_SR_nRDY) { | |
c6ca97d2 | 324 | dev_dbg(&spi->dev, "rdsr --> %d (%02x)\n", sr, sr); |
b587b13a DB |
325 | err = -ENXIO; |
326 | goto fail; | |
327 | } | |
328 | ||
329 | if (!(at25 = kzalloc(sizeof *at25, GFP_KERNEL))) { | |
330 | err = -ENOMEM; | |
331 | goto fail; | |
332 | } | |
333 | ||
334 | mutex_init(&at25->lock); | |
335 | at25->chip = *chip; | |
336 | at25->spi = spi_dev_get(spi); | |
337 | dev_set_drvdata(&spi->dev, at25); | |
338 | at25->addrlen = addrlen; | |
339 | ||
340 | /* Export the EEPROM bytes through sysfs, since that's convenient. | |
14dd1ff0 DB |
341 | * And maybe to other kernel code; it might hold a board's Ethernet |
342 | * address, or board-specific calibration data generated on the | |
343 | * manufacturing floor. | |
344 | * | |
b587b13a DB |
345 | * Default to root-only access to the data; EEPROMs often hold data |
346 | * that's sensitive for read and/or write, like ethernet addresses, | |
347 | * security codes, board-specific manufacturing calibrations, etc. | |
348 | */ | |
349 | at25->bin.attr.name = "eeprom"; | |
350 | at25->bin.attr.mode = S_IRUSR; | |
b587b13a | 351 | at25->bin.read = at25_bin_read; |
14dd1ff0 | 352 | at25->mem.read = at25_mem_read; |
b587b13a DB |
353 | |
354 | at25->bin.size = at25->chip.byte_len; | |
355 | if (!(chip->flags & EE_READONLY)) { | |
356 | at25->bin.write = at25_bin_write; | |
357 | at25->bin.attr.mode |= S_IWUSR; | |
14dd1ff0 | 358 | at25->mem.write = at25_mem_write; |
b587b13a DB |
359 | } |
360 | ||
361 | err = sysfs_create_bin_file(&spi->dev.kobj, &at25->bin); | |
362 | if (err) | |
363 | goto fail; | |
364 | ||
14dd1ff0 DB |
365 | if (chip->setup) |
366 | chip->setup(&at25->mem, chip->context); | |
367 | ||
b587b13a DB |
368 | dev_info(&spi->dev, "%Zd %s %s eeprom%s, pagesize %u\n", |
369 | (at25->bin.size < 1024) | |
370 | ? at25->bin.size | |
371 | : (at25->bin.size / 1024), | |
372 | (at25->bin.size < 1024) ? "Byte" : "KByte", | |
373 | at25->chip.name, | |
374 | (chip->flags & EE_READONLY) ? " (readonly)" : "", | |
375 | at25->chip.page_size); | |
376 | return 0; | |
377 | fail: | |
378 | dev_dbg(&spi->dev, "probe err %d\n", err); | |
379 | kfree(at25); | |
380 | return err; | |
381 | } | |
382 | ||
383 | static int __devexit at25_remove(struct spi_device *spi) | |
384 | { | |
385 | struct at25_data *at25; | |
386 | ||
387 | at25 = dev_get_drvdata(&spi->dev); | |
388 | sysfs_remove_bin_file(&spi->dev.kobj, &at25->bin); | |
389 | kfree(at25); | |
390 | return 0; | |
391 | } | |
392 | ||
393 | /*-------------------------------------------------------------------------*/ | |
394 | ||
395 | static struct spi_driver at25_driver = { | |
396 | .driver = { | |
397 | .name = "at25", | |
398 | .owner = THIS_MODULE, | |
399 | }, | |
400 | .probe = at25_probe, | |
401 | .remove = __devexit_p(at25_remove), | |
402 | }; | |
403 | ||
404 | static int __init at25_init(void) | |
405 | { | |
406 | return spi_register_driver(&at25_driver); | |
407 | } | |
408 | module_init(at25_init); | |
409 | ||
410 | static void __exit at25_exit(void) | |
411 | { | |
412 | spi_unregister_driver(&at25_driver); | |
413 | } | |
414 | module_exit(at25_exit); | |
415 | ||
416 | MODULE_DESCRIPTION("Driver for most SPI EEPROMs"); | |
417 | MODULE_AUTHOR("David Brownell"); | |
418 | MODULE_LICENSE("GPL"); | |
419 |