Fedora kernel-2.6.17-1.2142_FC4 patched with stable patch-2.6.17.4-vs2.0.2-rc26.diff
[linux-2.6.git] / arch / cris / arch-v10 / drivers / ds1302.c
1 /*!***************************************************************************
2 *!
3 *! FILE NAME  : ds1302.c
4 *!
5 *! DESCRIPTION: Implements an interface for the DS1302 RTC through Etrax I/O
6 *!
7 *! Functions exported: ds1302_readreg, ds1302_writereg, ds1302_init
8 *!
9 *! $Log: ds1302.c,v $
10 *! Revision 1.18  2005/01/24 09:11:26  mikaelam
11 *! Minor changes to get DS1302 RTC chip driver to work
12 *!
13 *! Revision 1.17  2005/01/05 06:11:22  starvik
14 *! No need to do local_irq_disable after local_irq_save.
15 *!
16 *! Revision 1.16  2004/12/13 12:21:52  starvik
17 *! Added I/O and DMA allocators from Linux 2.4
18 *!
19 *! Revision 1.14  2004/08/24 06:48:43  starvik
20 *! Whitespace cleanup
21 *!
22 *! Revision 1.13  2004/05/28 09:26:59  starvik
23 *! Modified I2C initialization to work in 2.6.
24 *!
25 *! Revision 1.12  2004/05/14 07:58:03  starvik
26 *! Merge of changes from 2.4
27 *!
28 *! Revision 1.10  2004/02/04 09:25:12  starvik
29 *! Merge of Linux 2.6.2
30 *!
31 *! Revision 1.9  2003/07/04 08:27:37  starvik
32 *! Merge of Linux 2.5.74
33 *!
34 *! Revision 1.8  2003/04/09 05:20:47  starvik
35 *! Merge of Linux 2.5.67
36 *!
37 *! Revision 1.6  2003/01/09 14:42:51  starvik
38 *! Merge of Linux 2.5.55
39 *!
40 *! Revision 1.4  2002/12/11 13:13:57  starvik
41 *! Added arch/ to v10 specific includes
42 *! Added fix from Linux 2.4 in serial.c (flush_to_flip_buffer)
43 *!
44 *! Revision 1.3  2002/11/20 11:56:10  starvik
45 *! Merge of Linux 2.5.48
46 *!
47 *! Revision 1.2  2002/11/18 13:16:06  starvik
48 *! Linux 2.5 port of latest 2.4 drivers
49 *!
50 *! Revision 1.15  2002/10/11 16:14:33  johana
51 *! Added CONFIG_ETRAX_DS1302_TRICKLE_CHARGE and initial setting of the
52 *! trcklecharge register.
53 *!
54 *! Revision 1.14  2002/10/10 12:15:38  magnusmn
55 *! Added support for having the RST signal on bit g0
56 *!
57 *! Revision 1.13  2002/05/29 15:16:08  johana
58 *! Removed unused variables.
59 *!
60 *! Revision 1.12  2002/04/10 15:35:25  johana
61 *! Moved probe function closer to init function and marked it __init.
62 *!
63 *! Revision 1.11  2001/06/14 12:35:52  jonashg
64 *! The ATA hack is back. It is unfortunately the only way to set g27 to output.
65 *!
66 *! Revision 1.9  2001/06/14 10:00:14  jonashg
67 *! No need for tempudelay to be inline anymore (had to adjust the usec to
68 *! loops conversion because of this to make it slow enough to be a udelay).
69 *!
70 *! Revision 1.8  2001/06/14 08:06:32  jonashg
71 *! Made tempudelay delay usecs (well, just a tad more).
72 *!
73 *! Revision 1.7  2001/06/13 14:18:11  jonashg
74 *! Only allow processes with SYS_TIME capability to set time and charge.
75 *!
76 *! Revision 1.6  2001/06/12 15:22:07  jonashg
77 *! * Made init function __init.
78 *! * Parameter to out_byte() is unsigned char.
79 *! * The magic number 42 has got a name.
80 *! * Removed comment about /proc (nothing is exported there).
81 *!
82 *! Revision 1.5  2001/06/12 14:35:13  jonashg
83 *! Gave the module a name and added it to printk's.
84 *!
85 *! Revision 1.4  2001/05/31 14:53:40  jonashg
86 *! Made tempudelay() inline so that the watchdog doesn't reset (see
87 *! function comment).
88 *!
89 *! Revision 1.3  2001/03/26 16:03:06  bjornw
90 *! Needs linux/config.h
91 *!
92 *! Revision 1.2  2001/03/20 19:42:00  bjornw
93 *! Use the ETRAX prefix on the DS1302 options
94 *!
95 *! Revision 1.1  2001/03/20 09:13:50  magnusmn
96 *! Linux 2.4 port
97 *!
98 *! Revision 1.10  2000/07/05 15:38:23  bjornw
99 *! Dont update kernel time when a RTC_SET_TIME is done
100 *!
101 *! Revision 1.9  2000/03/02 15:42:59  macce
102 *! * Hack to make RTC work on all 2100/2400
103 *!
104 *! Revision 1.8  2000/02/23 16:59:18  torbjore
105 *! added setup of R_GEN_CONFIG when RTC is connected to the generic port.
106 *!
107 *! Revision 1.7  2000/01/17 15:51:43  johana
108 *! Added RTC_SET_CHARGE ioctl to enable trickle charger.
109 *!
110 *! Revision 1.6  1999/10/27 13:19:47  bjornw
111 *! Added update_xtime_from_cmos which reads back the updated RTC into the kernel.
112 *! /dev/rtc calls it now.
113 *!
114 *! Revision 1.5  1999/10/27 12:39:37  bjornw
115 *! Disabled superuser check. Anyone can now set the time.
116 *!
117 *! Revision 1.4  1999/09/02 13:27:46  pkj
118 *! Added shadow for R_PORT_PB_CONFIG.
119 *! Renamed port_g_shadow to port_g_data_shadow.
120 *!
121 *! Revision 1.3  1999/09/02 08:28:06  pkj
122 *! Made it possible to select either port PB or the generic port for the RST
123 *! signal line to the DS1302 RTC.
124 *! Also make sure the RST bit is configured as output on Port PB (if used).
125 *!
126 *! Revision 1.2  1999/09/01 14:47:20  bjornw
127 *! Added support for /dev/rtc operations with ioctl RD_TIME and SET_TIME to read
128 *! and set the date. Register as major 121.
129 *!
130 *! Revision 1.1  1999/09/01 09:45:29  bjornw
131 *! Implemented a DS1302 RTC driver.
132 *!
133 *!
134 *! ---------------------------------------------------------------------------
135 *!
136 *! (C) Copyright 1999, 2000, 2001, 2002, 2003, 2004  Axis Communications AB, LUND, SWEDEN
137 *!
138 *! $Id: ds1302.c,v 1.18 2005/01/24 09:11:26 mikaelam Exp $
139 *!
140 *!***************************************************************************/
141
142 #include <linux/config.h>
143
144 #include <linux/fs.h>
145 #include <linux/init.h>
146 #include <linux/mm.h>
147 #include <linux/module.h>
148 #include <linux/miscdevice.h>
149 #include <linux/delay.h>
150 #include <linux/bcd.h>
151 #include <linux/capability.h>
152
153 #include <asm/uaccess.h>
154 #include <asm/system.h>
155 #include <asm/arch/svinto.h>
156 #include <asm/io.h>
157 #include <asm/rtc.h>
158 #include <asm/arch/io_interface_mux.h>
159
160 #define RTC_MAJOR_NR 121 /* local major, change later */
161
162 static const char ds1302_name[] = "ds1302";
163
164 /* The DS1302 might be connected to different bits on different products. 
165  * It has three signals - SDA, SCL and RST. RST and SCL are always outputs,
166  * but SDA can have a selected direction.
167  * For now, only PORT_PB is hardcoded.
168  */
169
170 /* The RST bit may be on either the Generic Port or Port PB. */
171 #ifdef CONFIG_ETRAX_DS1302_RST_ON_GENERIC_PORT
172 #define TK_RST_OUT(x) REG_SHADOW_SET(R_PORT_G_DATA,  port_g_data_shadow,  CONFIG_ETRAX_DS1302_RSTBIT, x)
173 #define TK_RST_DIR(x)
174 #else
175 #define TK_RST_OUT(x) REG_SHADOW_SET(R_PORT_PB_DATA, port_pb_data_shadow, CONFIG_ETRAX_DS1302_RSTBIT, x)
176 #define TK_RST_DIR(x) REG_SHADOW_SET(R_PORT_PB_DIR,  port_pb_dir_shadow,  CONFIG_ETRAX_DS1302_RSTBIT, x)
177 #endif
178
179
180 #define TK_SDA_OUT(x) REG_SHADOW_SET(R_PORT_PB_DATA, port_pb_data_shadow, CONFIG_ETRAX_DS1302_SDABIT, x)
181 #define TK_SCL_OUT(x) REG_SHADOW_SET(R_PORT_PB_DATA, port_pb_data_shadow, CONFIG_ETRAX_DS1302_SCLBIT, x)
182
183 #define TK_SDA_IN()   ((*R_PORT_PB_READ >> CONFIG_ETRAX_DS1302_SDABIT) & 1)
184 /* 1 is out, 0 is in */
185 #define TK_SDA_DIR(x) REG_SHADOW_SET(R_PORT_PB_DIR,  port_pb_dir_shadow,  CONFIG_ETRAX_DS1302_SDABIT, x)
186 #define TK_SCL_DIR(x) REG_SHADOW_SET(R_PORT_PB_DIR,  port_pb_dir_shadow,  CONFIG_ETRAX_DS1302_SCLBIT, x)
187
188
189 /*
190  * The reason for tempudelay and not udelay is that loops_per_usec
191  * (used in udelay) is not set when functions here are called from time.c 
192  */
193
194 static void tempudelay(int usecs) 
195 {
196         volatile int loops;
197
198         for(loops = usecs * 12; loops > 0; loops--)
199                 /* nothing */;  
200 }
201
202
203 /* Send 8 bits. */
204 static void
205 out_byte(unsigned char x) 
206 {
207         int i;
208         TK_SDA_DIR(1);
209         for (i = 8; i--;) {
210                 /* The chip latches incoming bits on the rising edge of SCL. */
211                 TK_SCL_OUT(0);
212                 TK_SDA_OUT(x & 1);
213                 tempudelay(1);
214                 TK_SCL_OUT(1);
215                 tempudelay(1);
216                 x >>= 1;
217         }
218         TK_SDA_DIR(0);
219 }
220
221 static unsigned char
222 in_byte(void) 
223 {
224         unsigned char x = 0;
225         int i;
226
227         /* Read byte. Bits come LSB first, on the falling edge of SCL.
228          * Assume SDA is in input direction already.
229          */
230         TK_SDA_DIR(0);
231
232         for (i = 8; i--;) {
233                 TK_SCL_OUT(0);
234                 tempudelay(1);
235                 x >>= 1;
236                 x |= (TK_SDA_IN() << 7);
237                 TK_SCL_OUT(1);
238                 tempudelay(1);
239         }
240
241         return x;
242 }
243
244 /* Prepares for a transaction by de-activating RST (active-low). */
245
246 static void
247 start(void) 
248 {
249         TK_SCL_OUT(0);
250         tempudelay(1);
251         TK_RST_OUT(0);
252         tempudelay(5);
253         TK_RST_OUT(1);  
254 }
255
256 /* Ends a transaction by taking RST active again. */
257
258 static void
259 stop(void) 
260 {
261         tempudelay(2);
262         TK_RST_OUT(0);
263 }
264
265 /* Enable writing. */
266
267 static void
268 ds1302_wenable(void) 
269 {
270         start();        
271         out_byte(0x8e); /* Write control register  */
272         out_byte(0x00); /* Disable write protect bit 7 = 0 */
273         stop();
274 }
275
276 /* Disable writing. */
277
278 static void
279 ds1302_wdisable(void) 
280 {
281         start();
282         out_byte(0x8e); /* Write control register  */
283         out_byte(0x80); /* Disable write protect bit 7 = 0 */
284         stop();
285 }
286
287
288
289 /* Read a byte from the selected register in the DS1302. */
290
291 unsigned char
292 ds1302_readreg(int reg) 
293 {
294         unsigned char x;
295
296         start();
297         out_byte(0x81 | (reg << 1)); /* read register */
298         x = in_byte();
299         stop();
300
301         return x;
302 }
303
304 /* Write a byte to the selected register. */
305
306 void
307 ds1302_writereg(int reg, unsigned char val) 
308 {
309 #ifndef CONFIG_ETRAX_RTC_READONLY
310         int do_writereg = 1;
311 #else
312         int do_writereg = 0;
313
314         if (reg == RTC_TRICKLECHARGER)
315                 do_writereg = 1;
316 #endif
317
318         if (do_writereg) {
319                 ds1302_wenable();
320                 start();
321                 out_byte(0x80 | (reg << 1)); /* write register */
322                 out_byte(val);
323                 stop();
324                 ds1302_wdisable();
325         }
326 }
327
328 void
329 get_rtc_time(struct rtc_time *rtc_tm) 
330 {
331         unsigned long flags;
332
333         local_irq_save(flags);
334
335         rtc_tm->tm_sec = CMOS_READ(RTC_SECONDS);
336         rtc_tm->tm_min = CMOS_READ(RTC_MINUTES);
337         rtc_tm->tm_hour = CMOS_READ(RTC_HOURS);
338         rtc_tm->tm_mday = CMOS_READ(RTC_DAY_OF_MONTH);
339         rtc_tm->tm_mon = CMOS_READ(RTC_MONTH);
340         rtc_tm->tm_year = CMOS_READ(RTC_YEAR);
341
342         local_irq_restore(flags);
343         
344         BCD_TO_BIN(rtc_tm->tm_sec);
345         BCD_TO_BIN(rtc_tm->tm_min);
346         BCD_TO_BIN(rtc_tm->tm_hour);
347         BCD_TO_BIN(rtc_tm->tm_mday);
348         BCD_TO_BIN(rtc_tm->tm_mon);
349         BCD_TO_BIN(rtc_tm->tm_year);
350
351         /*
352          * Account for differences between how the RTC uses the values
353          * and how they are defined in a struct rtc_time;
354          */
355
356         if (rtc_tm->tm_year <= 69)
357                 rtc_tm->tm_year += 100;
358
359         rtc_tm->tm_mon--;
360 }
361
362 static unsigned char days_in_mo[] = 
363     {0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31};
364
365 /* ioctl that supports RTC_RD_TIME and RTC_SET_TIME (read and set time/date). */
366
367 static int
368 rtc_ioctl(struct inode *inode, struct file *file, unsigned int cmd,
369           unsigned long arg) 
370 {
371         unsigned long flags;
372
373         switch(cmd) {
374                 case RTC_RD_TIME:       /* read the time/date from RTC  */
375                 {
376                         struct rtc_time rtc_tm;
377                                                 
378                         memset(&rtc_tm, 0, sizeof (struct rtc_time));
379                         get_rtc_time(&rtc_tm);                                          
380                         if (copy_to_user((struct rtc_time*)arg, &rtc_tm, sizeof(struct rtc_time)))
381                                 return -EFAULT; 
382                         return 0;
383                 }
384
385                 case RTC_SET_TIME:      /* set the RTC */
386                 {
387                         struct rtc_time rtc_tm;
388                         unsigned char mon, day, hrs, min, sec, leap_yr;
389                         unsigned int yrs;
390
391                         if (!capable(CAP_SYS_TIME))
392                                 return -EPERM;
393
394                         if (copy_from_user(&rtc_tm, (struct rtc_time*)arg, sizeof(struct rtc_time)))
395                                 return -EFAULT;
396
397                         yrs = rtc_tm.tm_year + 1900;
398                         mon = rtc_tm.tm_mon + 1;   /* tm_mon starts at zero */
399                         day = rtc_tm.tm_mday;
400                         hrs = rtc_tm.tm_hour;
401                         min = rtc_tm.tm_min;
402                         sec = rtc_tm.tm_sec;
403                         
404                         
405                         if ((yrs < 1970) || (yrs > 2069))
406                                 return -EINVAL;
407
408                         leap_yr = ((!(yrs % 4) && (yrs % 100)) || !(yrs % 400));
409
410                         if ((mon > 12) || (day == 0))
411                                 return -EINVAL;
412
413                         if (day > (days_in_mo[mon] + ((mon == 2) && leap_yr)))
414                                 return -EINVAL;
415                         
416                         if ((hrs >= 24) || (min >= 60) || (sec >= 60))
417                                 return -EINVAL;
418
419                         if (yrs >= 2000)
420                                 yrs -= 2000;    /* RTC (0, 1, ... 69) */
421                         else
422                                 yrs -= 1900;    /* RTC (70, 71, ... 99) */
423
424                         BIN_TO_BCD(sec);
425                         BIN_TO_BCD(min);
426                         BIN_TO_BCD(hrs);
427                         BIN_TO_BCD(day);
428                         BIN_TO_BCD(mon);
429                         BIN_TO_BCD(yrs);
430
431                         local_irq_save(flags);
432                         CMOS_WRITE(yrs, RTC_YEAR);
433                         CMOS_WRITE(mon, RTC_MONTH);
434                         CMOS_WRITE(day, RTC_DAY_OF_MONTH);
435                         CMOS_WRITE(hrs, RTC_HOURS);
436                         CMOS_WRITE(min, RTC_MINUTES);
437                         CMOS_WRITE(sec, RTC_SECONDS);
438                         local_irq_restore(flags);
439
440                         /* Notice that at this point, the RTC is updated but
441                          * the kernel is still running with the old time.
442                          * You need to set that separately with settimeofday
443                          * or adjtimex.
444                          */
445                         return 0;
446                 }
447
448                 case RTC_SET_CHARGE: /* set the RTC TRICKLE CHARGE register */
449                 {
450                         int tcs_val;
451
452                         if (!capable(CAP_SYS_TIME))
453                                 return -EPERM;
454                         
455                         if(copy_from_user(&tcs_val, (int*)arg, sizeof(int)))
456                                 return -EFAULT;
457
458                         tcs_val = RTC_TCR_PATTERN | (tcs_val & 0x0F);
459                         ds1302_writereg(RTC_TRICKLECHARGER, tcs_val);
460                         return 0;
461                 }
462                 case RTC_VLOW_RD:
463                 {
464                         /* TODO:
465                          * Implement voltage low detection support
466                          */
467                         printk(KERN_WARNING "DS1302: RTC Voltage Low detection"
468                                " is not supported\n");
469                         return 0;
470                 }
471                 case RTC_VLOW_SET:
472                 {
473                         /* TODO:
474                          * Nothing to do since Voltage Low detection is not supported
475                          */
476                         return 0;
477                 }
478                 default:
479                         return -ENOIOCTLCMD;
480         }
481 }
482
483 static void
484 print_rtc_status(void)
485 {
486         struct rtc_time tm;
487
488         get_rtc_time(&tm);
489
490         /*
491          * There is no way to tell if the luser has the RTC set for local
492          * time or for Universal Standard Time (GMT). Probably local though.
493          */
494
495         printk(KERN_INFO "rtc_time\t: %02d:%02d:%02d\n",
496                tm.tm_hour, tm.tm_min, tm.tm_sec);
497         printk(KERN_INFO "rtc_date\t: %04d-%02d-%02d\n",
498                tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday);
499 }
500
501 /* The various file operations we support. */
502
503 static struct file_operations rtc_fops = {
504         .owner =        THIS_MODULE,
505         .ioctl =        rtc_ioctl,
506 }; 
507
508 /* Probe for the chip by writing something to its RAM and try reading it back. */
509
510 #define MAGIC_PATTERN 0x42
511
512 static int __init
513 ds1302_probe(void) 
514 {
515         int retval, res; 
516
517         TK_RST_DIR(1);
518         TK_SCL_DIR(1);
519         TK_SDA_DIR(0);
520         
521         /* Try to talk to timekeeper. */
522
523         ds1302_wenable();  
524         start();
525         out_byte(0xc0); /* write RAM byte 0 */  
526         out_byte(MAGIC_PATTERN); /* write something magic */
527         start();
528         out_byte(0xc1); /* read RAM byte 0 */
529
530         if((res = in_byte()) == MAGIC_PATTERN) {
531                 stop();
532                 ds1302_wdisable();
533                 printk(KERN_INFO "%s: RTC found.\n", ds1302_name);
534                 printk(KERN_INFO "%s: SDA, SCL, RST on PB%i, PB%i, %s%i\n",
535                        ds1302_name,
536                        CONFIG_ETRAX_DS1302_SDABIT,
537                        CONFIG_ETRAX_DS1302_SCLBIT,
538 #ifdef CONFIG_ETRAX_DS1302_RST_ON_GENERIC_PORT
539                        "GENIO",
540 #else
541                        "PB",
542 #endif
543                        CONFIG_ETRAX_DS1302_RSTBIT);
544                        print_rtc_status();
545                 retval = 1;
546         } else {
547                 stop();
548                 retval = 0;
549         }
550
551         return retval;
552 }
553
554
555 /* Just probe for the RTC and register the device to handle the ioctl needed. */
556
557 int __init
558 ds1302_init(void) 
559 {
560 #ifdef CONFIG_ETRAX_I2C
561         i2c_init();
562 #endif
563
564         if (!ds1302_probe()) {
565 #ifdef CONFIG_ETRAX_DS1302_RST_ON_GENERIC_PORT
566 #if CONFIG_ETRAX_DS1302_RSTBIT == 27
567                 /*
568                  * The only way to set g27 to output is to enable ATA.
569                  *
570                  * Make sure that R_GEN_CONFIG is setup correct.
571                  */
572                 /* Allocating the ATA interface will grab almost all
573                  * pins in I/O groups a, b, c and d.  A consequence of
574                  * allocating the ATA interface is that the fixed
575                  * interfaces shared RAM, parallel port 0, parallel
576                  * port 1, parallel port W, SCSI-8 port 0, SCSI-8 port
577                  * 1, SCSI-W, serial port 2, serial port 3,
578                  * synchronous serial port 3 and USB port 2 and almost
579                  * all GPIO pins on port g cannot be used.
580                  */
581                 if (cris_request_io_interface(if_ata, "ds1302/ATA")) {
582                         printk(KERN_WARNING "ds1302: Failed to get IO interface\n");
583                         return -1;
584                 }
585
586 #elif CONFIG_ETRAX_DS1302_RSTBIT == 0
587                 if (cris_io_interface_allocate_pins(if_gpio_grp_a,
588                                                     'g',
589                                                     CONFIG_ETRAX_DS1302_RSTBIT,
590                                                     CONFIG_ETRAX_DS1302_RSTBIT)) {
591                         printk(KERN_WARNING "ds1302: Failed to get IO interface\n");
592                         return -1;
593                 }
594
595                 /* Set the direction of this bit to out. */
596                 genconfig_shadow = ((genconfig_shadow &
597                                      ~IO_MASK(R_GEN_CONFIG, g0dir)) |
598                                    (IO_STATE(R_GEN_CONFIG, g0dir, out)));
599                 *R_GEN_CONFIG = genconfig_shadow;
600 #endif
601                 if (!ds1302_probe()) {
602                         printk(KERN_WARNING "%s: RTC not found.\n", ds1302_name);
603                         return -1;
604                 }
605 #else
606                 printk(KERN_WARNING "%s: RTC not found.\n", ds1302_name);
607                 return -1;
608 #endif
609         }
610         /* Initialise trickle charger */
611         ds1302_writereg(RTC_TRICKLECHARGER,
612                         RTC_TCR_PATTERN |(CONFIG_ETRAX_DS1302_TRICKLE_CHARGE & 0x0F));
613         /* Start clock by resetting CLOCK_HALT */
614         ds1302_writereg(RTC_SECONDS, (ds1302_readreg(RTC_SECONDS) & 0x7F));
615         return 0;
616 }
617
618 static int __init ds1302_register(void)
619 {
620         ds1302_init();
621         if (register_chrdev(RTC_MAJOR_NR, ds1302_name, &rtc_fops)) {
622                 printk(KERN_INFO "%s: unable to get major %d for rtc\n", 
623                        ds1302_name, RTC_MAJOR_NR);
624                 return -1;
625         }
626         return 0;
627
628 }
629
630 module_init(ds1302_register);