1 /*!*****************************************************************************
3 *! Implements an interface for i2c compatible eeproms to run under linux.
4 *! Supports 2k, 8k(?) and 16k. Uses adaptive timing adjustents by
5 *! Johan.Adolfsson@axis.com
8 *! 8k or not is detected (the assumes 2k or 16k)
9 *! 2k or 16k detected using test reads and writes.
11 *!------------------------------------------------------------------------
16 *! Aug 28 1999 Edgar Iglesias Initial Version
17 *! Aug 31 1999 Edgar Iglesias Allow simultaneous users.
18 *! Sep 03 1999 Edgar Iglesias Updated probe.
19 *! Sep 03 1999 Edgar Iglesias Added bail-out stuff if we get interrupted
23 *! Revision 1.12 2005/06/19 17:06:46 starvik
24 *! Merge of Linux 2.6.12.
26 *! Revision 1.11 2005/01/26 07:14:46 starvik
27 *! Applied diff from kernel janitors (Nish Aravamudan).
29 *! Revision 1.10 2003/09/11 07:29:48 starvik
30 *! Merge of Linux 2.6.0-test5
32 *! Revision 1.9 2003/07/04 08:27:37 starvik
33 *! Merge of Linux 2.5.74
35 *! Revision 1.8 2003/04/09 05:20:47 starvik
36 *! Merge of Linux 2.5.67
38 *! Revision 1.6 2003/02/10 07:19:28 starvik
39 *! Removed misplaced ;
41 *! Revision 1.5 2002/12/11 13:13:57 starvik
42 *! Added arch/ to v10 specific includes
43 *! Added fix from Linux 2.4 in serial.c (flush_to_flip_buffer)
45 *! Revision 1.4 2002/11/20 11:56:10 starvik
46 *! Merge of Linux 2.5.48
48 *! Revision 1.3 2002/11/18 13:16:06 starvik
49 *! Linux 2.5 port of latest 2.4 drivers
51 *! Revision 1.8 2001/06/15 13:24:29 jonashg
52 *! * Added verification of pointers from userspace in read and write.
53 *! * Made busy counter volatile.
54 *! * Added define for inital write delay.
55 *! * Removed warnings by using loff_t instead of unsigned long.
57 *! Revision 1.7 2001/06/14 15:26:54 jonashg
58 *! Removed test because condition is always true.
60 *! Revision 1.6 2001/06/14 15:18:20 jonashg
61 *! Kb -> kB (makes quite a difference if you don't know if you have 2k or 16k).
63 *! Revision 1.5 2001/06/14 14:39:51 jonashg
64 *! Forgot to use name when registering the driver.
66 *! Revision 1.4 2001/06/14 14:35:47 jonashg
67 *! * Gave driver a name and used it in printk's.
70 *! Revision 1.3 2001/03/19 16:04:46 markusl
71 *! Fixed init of fops struct
73 *! Revision 1.2 2001/03/19 10:35:07 markusl
74 *! 2.4 port of eeprom driver
76 *! Revision 1.8 2000/05/18 10:42:25 edgar
77 *! Make sure to end write cycle on _every_ write
79 *! Revision 1.7 2000/01/17 17:41:01 johana
80 *! Adjusted probing and return -ENOSPC when writing outside EEPROM
82 *! Revision 1.6 2000/01/17 15:50:36 johana
83 *! Added adaptive timing adjustments and fixed autoprobing for 2k and 16k(?)
86 *! Revision 1.5 1999/09/03 15:07:37 edgar
87 *! Added bail-out check to the spinlock
89 *! Revision 1.4 1999/09/03 12:11:17 bjornw
90 *! Proper atomicity (need to use spinlocks, not if's). users -> busy.
93 *! (c) 1999 Axis Communications AB, Lund, Sweden
94 *!*****************************************************************************/
96 #include <linux/config.h>
97 #include <linux/kernel.h>
98 #include <linux/sched.h>
100 #include <linux/init.h>
101 #include <linux/delay.h>
102 #include <linux/interrupt.h>
103 #include <linux/wait.h>
104 #include <asm/uaccess.h>
109 /* If we should use adaptive timing or not: */
110 //#define EEPROM_ADAPTIVE_TIMING
112 #define EEPROM_MAJOR_NR 122 /* use a LOCAL/EXPERIMENTAL major for now */
113 #define EEPROM_MINOR_NR 0
115 /* Empirical sane initial value of the delay, the value will be adapted to
116 * what the chip needs when using EEPROM_ADAPTIVE_TIMING.
118 #define INITIAL_WRITEDELAY_US 4000
119 #define MAX_WRITEDELAY_US 10000 /* 10 ms according to spec for 2KB EEPROM */
121 /* This one defines how many times to try when eeprom fails. */
122 #define EEPROM_RETRIES 10
124 #define EEPROM_2KB (2 * 1024)
125 /*#define EEPROM_4KB (4 * 1024)*/ /* Exists but not used in Axis products */
126 #define EEPROM_8KB (8 * 1024 - 1 ) /* Last byte has write protection bit */
127 #define EEPROM_16KB (16 * 1024)
129 #define i2c_delay(x) udelay(x)
132 * This structure describes the attached eeprom chip.
133 * The values are probed for.
139 unsigned long sequential_write_pagesize;
140 unsigned char select_cmd;
141 unsigned long usec_delay_writecycles; /* Min time between write cycles
142 (up to 10ms for some models) */
143 unsigned long usec_delay_step; /* For adaptive algorithm */
144 int adapt_state; /* 1 = To high , 0 = Even, -1 = To low */
146 /* this one is to keep the read/write operations atomic */
147 wait_queue_head_t wait_q;
149 int retry_cnt_addr; /* Used to keep track of number of retries for
150 adaptive timing adjustments */
154 static int eeprom_open(struct inode * inode, struct file * file);
155 static loff_t eeprom_lseek(struct file * file, loff_t offset, int orig);
156 static ssize_t eeprom_read(struct file * file, char * buf, size_t count,
158 static ssize_t eeprom_write(struct file * file, const char * buf, size_t count,
160 static int eeprom_close(struct inode * inode, struct file * file);
162 static int eeprom_address(unsigned long addr);
163 static int read_from_eeprom(char * buf, int count);
164 static int eeprom_write_buf(loff_t addr, const char * buf, int count);
165 static int eeprom_read_buf(loff_t addr, char * buf, int count);
167 static void eeprom_disable_write_protect(void);
170 static const char eeprom_name[] = "eeprom";
172 /* chip description */
173 static struct eeprom_type eeprom;
175 /* This is the exported file-operations structure for this device. */
176 struct file_operations eeprom_fops =
178 .llseek = eeprom_lseek,
180 .write = eeprom_write,
182 .release = eeprom_close
185 /* eeprom init call. Probes for different eeprom models. */
187 int __init eeprom_init(void)
189 init_waitqueue_head(&eeprom.wait_q);
192 #ifdef CONFIG_ETRAX_I2C_EEPROM_PROBE
193 #define EETEXT "Found"
195 #define EETEXT "Assuming"
197 if (register_chrdev(EEPROM_MAJOR_NR, eeprom_name, &eeprom_fops))
199 printk(KERN_INFO "%s: unable to get major %d for eeprom device\n",
200 eeprom_name, EEPROM_MAJOR_NR);
204 printk("EEPROM char device v0.3, (c) 2000 Axis Communications AB\n");
207 * Note: Most of this probing method was taken from the printserver (5470e)
208 * codebase. It did not contain a way of finding the 16kB chips
209 * (M24128 or variants). The method used here might not work
210 * for all models. If you encounter problems the easiest way
211 * is probably to define your model within #ifdef's, and hard-
216 eeprom.usec_delay_writecycles = INITIAL_WRITEDELAY_US;
217 eeprom.usec_delay_step = 128;
218 eeprom.adapt_state = 0;
220 #ifdef CONFIG_ETRAX_I2C_EEPROM_PROBE
227 unsigned char buf_2k_start[16];
229 /* Im not sure this will work... :) */
230 /* assume 2kB, if failure go for 16kB */
231 /* Test with 16kB settings.. */
232 /* If it's a 2kB EEPROM and we address it outside it's range
233 * it will mirror the address space:
234 * 1. We read two locations (that are mirrored),
235 * if the content differs * it's a 16kB EEPROM.
236 * 2. if it doesn't differ - write different value to one of the locations,
237 * check the other - if content still is the same it's a 2k EEPROM,
238 * restore original data.
241 #define LOC2 (0x1fb) /*1fb, 3ed, 5df, 7d1 */
245 eeprom.size = EEPROM_2KB;
246 eeprom.select_cmd = 0xA0;
247 eeprom.sequential_write_pagesize = 16;
248 if( eeprom_read_buf( 0, buf_2k_start, 16 ) == 16 )
250 D(printk("2k start: '%16.16s'\n", buf_2k_start));
254 printk(KERN_INFO "%s: Failed to read in 2k mode!\n", eeprom_name);
258 eeprom.size = EEPROM_16KB;
259 eeprom.select_cmd = 0xA0;
260 eeprom.sequential_write_pagesize = 64;
263 unsigned char loc1[4], loc2[4], tmp[4];
264 if( eeprom_read_buf(LOC2, loc2, 4) == 4)
266 if( eeprom_read_buf(LOC1, loc1, 4) == 4)
268 D(printk("0 loc1: (%i) '%4.4s' loc2 (%i) '%4.4s'\n",
269 LOC1, loc1, LOC2, loc2));
271 if (memcmp(loc1, loc2, 4) != 0 )
274 printk(KERN_INFO "%s: 16k detected in step 1\n", eeprom_name);
275 eeprom.size = EEPROM_16KB;
281 /* Do step 2 check */
284 if (eeprom_write_buf(LOC1, loc1, 1) == 1)
286 /* If 2k EEPROM this write will actually write 10 bytes
289 D(printk("1 loc1: (%i) '%4.4s' loc2 (%i) '%4.4s'\n",
290 LOC1, loc1, LOC2, loc2));
291 if( eeprom_read_buf(LOC1, tmp, 4) == 4)
293 D(printk("2 loc1: (%i) '%4.4s' tmp '%4.4s'\n",
295 if (memcmp(loc1, tmp, 4) != 0 )
297 printk(KERN_INFO "%s: read and write differs! Not 16kB\n",
301 if (eeprom_write_buf(LOC1, loc1, 1) == 1)
307 printk(KERN_INFO "%s: Restore 2k failed during probe,"
308 " EEPROM might be corrupt!\n", eeprom_name);
312 /* Go to 2k mode and write original data */
313 eeprom.size = EEPROM_2KB;
314 eeprom.select_cmd = 0xA0;
315 eeprom.sequential_write_pagesize = 16;
316 if( eeprom_write_buf(0, buf_2k_start, 16) == 16)
321 printk(KERN_INFO "%s: Failed to write back 2k start!\n",
325 eeprom.size = EEPROM_2KB;
331 if( eeprom_read_buf(LOC2, loc2, 1) == 1)
333 D(printk("0 loc1: (%i) '%4.4s' loc2 (%i) '%4.4s'\n",
334 LOC1, loc1, LOC2, loc2));
335 if (memcmp(loc1, loc2, 4) == 0 )
337 /* Data the same, must be mirrored -> 2k */
339 printk(KERN_INFO "%s: 2k detected in step 2\n", eeprom_name);
341 if (eeprom_write_buf(LOC1, loc1, 1) == 1)
347 printk(KERN_INFO "%s: Restore 2k failed during probe,"
348 " EEPROM might be corrupt!\n", eeprom_name);
352 eeprom.size = EEPROM_2KB;
356 printk(KERN_INFO "%s: 16k detected in step 2\n",
359 /* Data differs, assume 16k */
361 if (eeprom_write_buf(LOC1, loc1, 1) == 1)
367 printk(KERN_INFO "%s: Restore 16k failed during probe,"
368 " EEPROM might be corrupt!\n", eeprom_name);
371 eeprom.size = EEPROM_16KB;
380 printk(KERN_INFO "%s: Probing failed!, using 2KB!\n", eeprom_name);
381 eeprom.size = EEPROM_2KB;
392 eeprom.size = EEPROM_2KB;
400 eeprom.size = EEPROM_2KB;
406 eeprom.size = EEPROM_8KB;
411 #elif defined(CONFIG_ETRAX_I2C_EEPROM_16KB)
412 eeprom.size = EEPROM_16KB;
413 #elif defined(CONFIG_ETRAX_I2C_EEPROM_8KB)
414 eeprom.size = EEPROM_8KB;
415 #elif defined(CONFIG_ETRAX_I2C_EEPROM_2KB)
416 eeprom.size = EEPROM_2KB;
422 printk("%s: " EETEXT " i2c compatible 2kB eeprom.\n", eeprom_name);
423 eeprom.sequential_write_pagesize = 16;
424 eeprom.select_cmd = 0xA0;
427 printk("%s: " EETEXT " i2c compatible 8kB eeprom.\n", eeprom_name);
428 eeprom.sequential_write_pagesize = 16;
429 eeprom.select_cmd = 0x80;
432 printk("%s: " EETEXT " i2c compatible 16kB eeprom.\n", eeprom_name);
433 eeprom.sequential_write_pagesize = 64;
434 eeprom.select_cmd = 0xA0;
438 printk("%s: Did not find a supported eeprom\n", eeprom_name);
444 eeprom_disable_write_protect();
449 /* Opens the device. */
451 static int eeprom_open(struct inode * inode, struct file * file)
454 if(MINOR(inode->i_rdev) != EEPROM_MINOR_NR)
456 if(MAJOR(inode->i_rdev) != EEPROM_MAJOR_NR)
459 if( eeprom.size > 0 )
465 /* No EEprom found */
469 /* Changes the current file position. */
471 static loff_t eeprom_lseek(struct file * file, loff_t offset, int orig)
474 * orig 0: position from begning of eeprom
475 * orig 1: relative from current position
476 * orig 2: position from last eeprom address
482 file->f_pos = offset;
485 file->f_pos += offset;
488 file->f_pos = eeprom.size - offset;
494 /* truncate position */
501 if (file->f_pos >= eeprom.size)
503 file->f_pos = eeprom.size - 1;
507 return ( file->f_pos );
510 /* Reads data from eeprom. */
512 static int eeprom_read_buf(loff_t addr, char * buf, int count)
517 return eeprom_read(&f, buf, count, &addr);
522 /* Reads data from eeprom. */
524 static ssize_t eeprom_read(struct file * file, char * buf, size_t count, loff_t *off)
527 unsigned long p = file->f_pos;
531 if(p >= eeprom.size) /* Address i 0 - (size-1) */
536 wait_event_interruptible(eeprom.wait_q, !eeprom.busy);
537 if (signal_pending(current))
542 page = (unsigned char) (p >> 8);
544 if(!eeprom_address(p))
546 printk(KERN_INFO "%s: Read failed to address the eeprom: "
547 "0x%08X (%i) page: %i\n", eeprom_name, (int)p, (int)p, page);
550 /* don't forget to wake them up */
552 wake_up_interruptible(&eeprom.wait_q);
556 if( (p + count) > eeprom.size)
559 count = eeprom.size - p;
562 /* stop dummy write op and initiate the read op */
565 /* special case for small eeproms */
566 if(eeprom.size < EEPROM_16KB)
568 i2c_outbyte( eeprom.select_cmd | 1 | (page << 1) );
571 /* go on with the actual read */
572 read = read_from_eeprom( buf, count);
580 wake_up_interruptible(&eeprom.wait_q);
584 /* Writes data to eeprom. */
586 static int eeprom_write_buf(loff_t addr, const char * buf, int count)
592 return eeprom_write(&f, buf, count, &addr);
596 /* Writes data to eeprom. */
598 static ssize_t eeprom_write(struct file * file, const char * buf, size_t count,
601 int i, written, restart=1;
604 if (!access_ok(VERIFY_READ, buf, count))
609 wait_event_interruptible(eeprom.wait_q, !eeprom.busy);
610 /* bail out if we get interrupted */
611 if (signal_pending(current))
614 for(i = 0; (i < EEPROM_RETRIES) && (restart > 0); i++)
621 while( (written < count) && (p < eeprom.size))
623 /* address the eeprom */
624 if(!eeprom_address(p))
626 printk(KERN_INFO "%s: Write failed to address the eeprom: "
627 "0x%08X (%i) \n", eeprom_name, (int)p, (int)p);
630 /* don't forget to wake them up */
632 wake_up_interruptible(&eeprom.wait_q);
635 #ifdef EEPROM_ADAPTIVE_TIMING
636 /* Adaptive algorithm to adjust timing */
637 if (eeprom.retry_cnt_addr > 0)
640 D(printk(">D=%i d=%i\n",
641 eeprom.usec_delay_writecycles, eeprom.usec_delay_step));
643 if (eeprom.usec_delay_step < 4)
645 eeprom.usec_delay_step++;
646 eeprom.usec_delay_writecycles += eeprom.usec_delay_step;
651 if (eeprom.adapt_state > 0)
654 eeprom.usec_delay_step *= 2;
655 if (eeprom.usec_delay_step > 2)
657 eeprom.usec_delay_step--;
659 eeprom.usec_delay_writecycles += eeprom.usec_delay_step;
661 else if (eeprom.adapt_state < 0)
663 /* To High before (toggle dir) */
664 eeprom.usec_delay_writecycles += eeprom.usec_delay_step;
665 if (eeprom.usec_delay_step > 1)
667 eeprom.usec_delay_step /= 2;
668 eeprom.usec_delay_step--;
673 eeprom.adapt_state = 1;
677 /* To High (or good) now */
678 D(printk("<D=%i d=%i\n",
679 eeprom.usec_delay_writecycles, eeprom.usec_delay_step));
681 if (eeprom.adapt_state < 0)
684 if (eeprom.usec_delay_step > 1)
686 eeprom.usec_delay_step *= 2;
687 eeprom.usec_delay_step--;
689 if (eeprom.usec_delay_writecycles > eeprom.usec_delay_step)
691 eeprom.usec_delay_writecycles -= eeprom.usec_delay_step;
695 else if (eeprom.adapt_state > 0)
697 /* To Low before (toggle dir) */
698 if (eeprom.usec_delay_writecycles > eeprom.usec_delay_step)
700 eeprom.usec_delay_writecycles -= eeprom.usec_delay_step;
702 if (eeprom.usec_delay_step > 1)
704 eeprom.usec_delay_step /= 2;
705 eeprom.usec_delay_step--;
708 eeprom.adapt_state = -1;
711 if (eeprom.adapt_state > -100)
713 eeprom.adapt_state--;
717 /* Restart adaption */
718 D(printk("#Restart\n"));
719 eeprom.usec_delay_step++;
722 #endif /* EEPROM_ADAPTIVE_TIMING */
723 /* write until we hit a page boundary or count */
726 i2c_outbyte(buf[written]);
730 printk(KERN_INFO "%s: write error, retrying. %d\n", eeprom_name, i);
736 } while( written < count && ( p % eeprom.sequential_write_pagesize ));
738 /* end write cycle */
740 i2c_delay(eeprom.usec_delay_writecycles);
745 wake_up_interruptible(&eeprom.wait_q);
746 if (written == 0 && file->f_pos >= eeprom.size){
749 file->f_pos += written;
753 /* Closes the device. */
755 static int eeprom_close(struct inode * inode, struct file * file)
757 /* do nothing for now */
761 /* Sets the current address of the eeprom. */
763 static int eeprom_address(unsigned long addr)
766 unsigned char page, offset;
768 page = (unsigned char) (addr >> 8);
769 offset = (unsigned char) addr;
771 for(i = 0; i < EEPROM_RETRIES; i++)
773 /* start a dummy write for addressing */
776 if(eeprom.size == EEPROM_16KB)
778 i2c_outbyte( eeprom.select_cmd );
784 i2c_outbyte( eeprom.select_cmd | (page << 1) );
790 /* Must have a delay here.. 500 works, >50, 100->works 5th time*/
791 i2c_delay(MAX_WRITEDELAY_US / EEPROM_RETRIES * i);
792 /* The chip needs up to 10 ms from write stop to next start */
810 eeprom.retry_cnt_addr = i;
811 D(printk("%i\n", eeprom.retry_cnt_addr));
812 if(eeprom.retry_cnt_addr == EEPROM_RETRIES)
820 /* Reads from current address. */
822 static int read_from_eeprom(char * buf, int count)
826 for(i = 0; i < EEPROM_RETRIES; i++)
828 if(eeprom.size == EEPROM_16KB)
830 i2c_outbyte( eeprom.select_cmd | 1 );
839 if(i == EEPROM_RETRIES)
841 printk(KERN_INFO "%s: failed to read from eeprom\n", eeprom_name);
847 while( (read < count))
849 if (put_user(i2c_inbyte(), &buf[read++]))
857 * make sure we don't ack last byte or you will get very strange
866 /* stop the operation */
872 /* Disables write protection if applicable. */
875 #define ax_printf printk
876 static void eeprom_disable_write_protect(void)
878 /* Disable write protect */
879 if (eeprom.size == EEPROM_8KB)
881 /* Step 1 Set WEL = 1 (write 00000010 to address 1FFFh */
886 DBP_SAVE(ax_printf("Get ack returns false\n"));
891 DBP_SAVE(ax_printf("Get ack returns false 2\n"));
896 DBP_SAVE(ax_printf("Get ack returns false 3\n"));
902 /* Step 2 Set RWEL = 1 (write 00000110 to address 1FFFh */
907 DBP_SAVE(ax_printf("Get ack returns false 55\n"));
912 DBP_SAVE(ax_printf("Get ack returns false 52\n"));
917 DBP_SAVE(ax_printf("Get ack returns false 53\n"));
921 /* Step 3 Set BP1, BP0, and/or WPEN bits (write 00000110 to address 1FFFh */
926 DBP_SAVE(ax_printf("Get ack returns false 56\n"));
931 DBP_SAVE(ax_printf("Get ack returns false 57\n"));
936 DBP_SAVE(ax_printf("Get ack returns false 58\n"));
940 /* Write protect disabled */
944 module_init(eeprom_init);