gpio: palmas: fix compilation failures
[linux-2.6.git] / drivers / watchdog / sch311x_wdt.c
1 /*
2  *      sch311x_wdt.c - Driver for the SCH311x Super-I/O chips
3  *                      integrated watchdog.
4  *
5  *      (c) Copyright 2008 Wim Van Sebroeck <wim@iguana.be>.
6  *
7  *      This program is free software; you can redistribute it and/or
8  *      modify it under the terms of the GNU General Public License
9  *      as published by the Free Software Foundation; either version
10  *      2 of the License, or (at your option) any later version.
11  *
12  *      Neither Wim Van Sebroeck nor Iguana vzw. admit liability nor
13  *      provide warranty for any of this software. This material is
14  *      provided "AS-IS" and at no charge.
15  */
16
17 /*
18  *      Includes, defines, variables, module parameters, ...
19  */
20
21 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
22
23 /* Includes */
24 #include <linux/module.h>               /* For module specific items */
25 #include <linux/moduleparam.h>          /* For new moduleparam's */
26 #include <linux/types.h>                /* For standard types (like size_t) */
27 #include <linux/errno.h>                /* For the -ENODEV/... values */
28 #include <linux/kernel.h>               /* For printk/... */
29 #include <linux/miscdevice.h>           /* For MODULE_ALIAS_MISCDEV
30                                                         (WATCHDOG_MINOR) */
31 #include <linux/watchdog.h>             /* For the watchdog specific items */
32 #include <linux/init.h>                 /* For __init/__exit/... */
33 #include <linux/fs.h>                   /* For file operations */
34 #include <linux/platform_device.h>      /* For platform_driver framework */
35 #include <linux/ioport.h>               /* For io-port access */
36 #include <linux/spinlock.h>             /* For spin_lock/spin_unlock/... */
37 #include <linux/uaccess.h>              /* For copy_to_user/put_user/... */
38 #include <linux/io.h>                   /* For inb/outb/... */
39
40 /* Module and version information */
41 #define DRV_NAME        "sch311x_wdt"
42
43 /* Runtime registers */
44 #define RESGEN                  0x1d
45 #define GP60                    0x47
46 #define WDT_TIME_OUT            0x65
47 #define WDT_VAL                 0x66
48 #define WDT_CFG                 0x67
49 #define WDT_CTRL                0x68
50
51 /* internal variables */
52 static unsigned long sch311x_wdt_is_open;
53 static char sch311x_wdt_expect_close;
54 static struct platform_device *sch311x_wdt_pdev;
55
56 static int sch311x_ioports[] = { 0x2e, 0x4e, 0x162e, 0x164e, 0x00 };
57
58 static struct { /* The devices private data */
59         /* the Runtime Register base address */
60         unsigned short runtime_reg;
61         /* The card's boot status */
62         int boot_status;
63         /* the lock for io operations */
64         spinlock_t io_lock;
65 } sch311x_wdt_data;
66
67 /* Module load parameters */
68 static unsigned short force_id;
69 module_param(force_id, ushort, 0);
70 MODULE_PARM_DESC(force_id, "Override the detected device ID");
71
72 static unsigned short therm_trip;
73 module_param(therm_trip, ushort, 0);
74 MODULE_PARM_DESC(therm_trip, "Should a ThermTrip trigger the reset generator");
75
76 #define WATCHDOG_TIMEOUT 60             /* 60 sec default timeout */
77 static int timeout = WATCHDOG_TIMEOUT;  /* in seconds */
78 module_param(timeout, int, 0);
79 MODULE_PARM_DESC(timeout,
80         "Watchdog timeout in seconds. 1<= timeout <=15300, default="
81                 __MODULE_STRING(WATCHDOG_TIMEOUT) ".");
82
83 static bool nowayout = WATCHDOG_NOWAYOUT;
84 module_param(nowayout, bool, 0);
85 MODULE_PARM_DESC(nowayout,
86         "Watchdog cannot be stopped once started (default="
87                 __MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
88
89 /*
90  *      Super-IO functions
91  */
92
93 static inline void sch311x_sio_enter(int sio_config_port)
94 {
95         outb(0x55, sio_config_port);
96 }
97
98 static inline void sch311x_sio_exit(int sio_config_port)
99 {
100         outb(0xaa, sio_config_port);
101 }
102
103 static inline int sch311x_sio_inb(int sio_config_port, int reg)
104 {
105         outb(reg, sio_config_port);
106         return inb(sio_config_port + 1);
107 }
108
109 static inline void sch311x_sio_outb(int sio_config_port, int reg, int val)
110 {
111         outb(reg, sio_config_port);
112         outb(val, sio_config_port + 1);
113 }
114
115 /*
116  *      Watchdog Operations
117  */
118
119 static void sch311x_wdt_set_timeout(int t)
120 {
121         unsigned char timeout_unit = 0x80;
122
123         /* When new timeout is bigger then 255 seconds, we will use minutes */
124         if (t > 255) {
125                 timeout_unit = 0;
126                 t /= 60;
127         }
128
129         /* -- Watchdog Timeout --
130          * Bit 0-6 (Reserved)
131          * Bit 7   WDT Time-out Value Units Select
132          *         (0 = Minutes, 1 = Seconds)
133          */
134         outb(timeout_unit, sch311x_wdt_data.runtime_reg + WDT_TIME_OUT);
135
136         /* -- Watchdog Timer Time-out Value --
137          * Bit 0-7 Binary coded units (0=Disabled, 1..255)
138          */
139         outb(t, sch311x_wdt_data.runtime_reg + WDT_VAL);
140 }
141
142 static void sch311x_wdt_start(void)
143 {
144         spin_lock(&sch311x_wdt_data.io_lock);
145
146         /* set watchdog's timeout */
147         sch311x_wdt_set_timeout(timeout);
148         /* enable the watchdog */
149         /* -- General Purpose I/O Bit 6.0 --
150          * Bit 0,   In/Out: 0 = Output, 1 = Input
151          * Bit 1,   Polarity: 0 = No Invert, 1 = Invert
152          * Bit 2-3, Function select: 00 = GPI/O, 01 = LED1, 11 = WDT,
153          *                           10 = Either Edge Triggered Intr.4
154          * Bit 4-6  (Reserved)
155          * Bit 7,   Output Type: 0 = Push Pull Bit, 1 = Open Drain
156          */
157         outb(0x0e, sch311x_wdt_data.runtime_reg + GP60);
158
159         spin_unlock(&sch311x_wdt_data.io_lock);
160
161 }
162
163 static void sch311x_wdt_stop(void)
164 {
165         spin_lock(&sch311x_wdt_data.io_lock);
166
167         /* stop the watchdog */
168         outb(0x01, sch311x_wdt_data.runtime_reg + GP60);
169         /* disable timeout by setting it to 0 */
170         sch311x_wdt_set_timeout(0);
171
172         spin_unlock(&sch311x_wdt_data.io_lock);
173 }
174
175 static void sch311x_wdt_keepalive(void)
176 {
177         spin_lock(&sch311x_wdt_data.io_lock);
178         sch311x_wdt_set_timeout(timeout);
179         spin_unlock(&sch311x_wdt_data.io_lock);
180 }
181
182 static int sch311x_wdt_set_heartbeat(int t)
183 {
184         if (t < 1 || t > (255*60))
185                 return -EINVAL;
186
187         /* When new timeout is bigger then 255 seconds,
188          * we will round up to minutes (with a max of 255) */
189         if (t > 255)
190                 t = (((t - 1) / 60) + 1) * 60;
191
192         timeout = t;
193         return 0;
194 }
195
196 static void sch311x_wdt_get_status(int *status)
197 {
198         unsigned char new_status;
199
200         *status = 0;
201
202         spin_lock(&sch311x_wdt_data.io_lock);
203
204         /* -- Watchdog timer control --
205          * Bit 0   Status Bit: 0 = Timer counting, 1 = Timeout occurred
206          * Bit 1   Reserved
207          * Bit 2   Force Timeout: 1 = Forces WD timeout event (self-cleaning)
208          * Bit 3   P20 Force Timeout enabled:
209          *          0 = P20 activity does not generate the WD timeout event
210          *          1 = P20 Allows rising edge of P20, from the keyboard
211          *              controller, to force the WD timeout event.
212          * Bit 4-7 Reserved
213          */
214         new_status = inb(sch311x_wdt_data.runtime_reg + WDT_CTRL);
215         if (new_status & 0x01)
216                 *status |= WDIOF_CARDRESET;
217
218         spin_unlock(&sch311x_wdt_data.io_lock);
219 }
220
221 /*
222  *      /dev/watchdog handling
223  */
224
225 static ssize_t sch311x_wdt_write(struct file *file, const char __user *buf,
226                                                 size_t count, loff_t *ppos)
227 {
228         if (count) {
229                 if (!nowayout) {
230                         size_t i;
231
232                         sch311x_wdt_expect_close = 0;
233
234                         for (i = 0; i != count; i++) {
235                                 char c;
236                                 if (get_user(c, buf + i))
237                                         return -EFAULT;
238                                 if (c == 'V')
239                                         sch311x_wdt_expect_close = 42;
240                         }
241                 }
242                 sch311x_wdt_keepalive();
243         }
244         return count;
245 }
246
247 static long sch311x_wdt_ioctl(struct file *file, unsigned int cmd,
248                                                         unsigned long arg)
249 {
250         int status;
251         int new_timeout;
252         void __user *argp = (void __user *)arg;
253         int __user *p = argp;
254         static const struct watchdog_info ident = {
255                 .options                = WDIOF_KEEPALIVEPING |
256                                           WDIOF_SETTIMEOUT |
257                                           WDIOF_MAGICCLOSE,
258                 .firmware_version       = 1,
259                 .identity               = DRV_NAME,
260         };
261
262         switch (cmd) {
263         case WDIOC_GETSUPPORT:
264                 if (copy_to_user(argp, &ident, sizeof(ident)))
265                         return -EFAULT;
266                 break;
267
268         case WDIOC_GETSTATUS:
269         {
270                 sch311x_wdt_get_status(&status);
271                 return put_user(status, p);
272         }
273         case WDIOC_GETBOOTSTATUS:
274                 return put_user(sch311x_wdt_data.boot_status, p);
275
276         case WDIOC_SETOPTIONS:
277         {
278                 int options, retval = -EINVAL;
279
280                 if (get_user(options, p))
281                         return -EFAULT;
282                 if (options & WDIOS_DISABLECARD) {
283                         sch311x_wdt_stop();
284                         retval = 0;
285                 }
286                 if (options & WDIOS_ENABLECARD) {
287                         sch311x_wdt_start();
288                         retval = 0;
289                 }
290                 return retval;
291         }
292         case WDIOC_KEEPALIVE:
293                 sch311x_wdt_keepalive();
294                 break;
295
296         case WDIOC_SETTIMEOUT:
297                 if (get_user(new_timeout, p))
298                         return -EFAULT;
299                 if (sch311x_wdt_set_heartbeat(new_timeout))
300                         return -EINVAL;
301                 sch311x_wdt_keepalive();
302                 /* Fall */
303         case WDIOC_GETTIMEOUT:
304                 return put_user(timeout, p);
305         default:
306                 return -ENOTTY;
307         }
308         return 0;
309 }
310
311 static int sch311x_wdt_open(struct inode *inode, struct file *file)
312 {
313         if (test_and_set_bit(0, &sch311x_wdt_is_open))
314                 return -EBUSY;
315         /*
316          *      Activate
317          */
318         sch311x_wdt_start();
319         return nonseekable_open(inode, file);
320 }
321
322 static int sch311x_wdt_close(struct inode *inode, struct file *file)
323 {
324         if (sch311x_wdt_expect_close == 42) {
325                 sch311x_wdt_stop();
326         } else {
327                 pr_crit("Unexpected close, not stopping watchdog!\n");
328                 sch311x_wdt_keepalive();
329         }
330         clear_bit(0, &sch311x_wdt_is_open);
331         sch311x_wdt_expect_close = 0;
332         return 0;
333 }
334
335 /*
336  *      Kernel Interfaces
337  */
338
339 static const struct file_operations sch311x_wdt_fops = {
340         .owner          = THIS_MODULE,
341         .llseek         = no_llseek,
342         .write          = sch311x_wdt_write,
343         .unlocked_ioctl = sch311x_wdt_ioctl,
344         .open           = sch311x_wdt_open,
345         .release        = sch311x_wdt_close,
346 };
347
348 static struct miscdevice sch311x_wdt_miscdev = {
349         .minor  = WATCHDOG_MINOR,
350         .name   = "watchdog",
351         .fops   = &sch311x_wdt_fops,
352 };
353
354 /*
355  *      Init & exit routines
356  */
357
358 static int __devinit sch311x_wdt_probe(struct platform_device *pdev)
359 {
360         struct device *dev = &pdev->dev;
361         unsigned char val;
362         int err;
363
364         spin_lock_init(&sch311x_wdt_data.io_lock);
365
366         if (!request_region(sch311x_wdt_data.runtime_reg + RESGEN, 1,
367                                                                 DRV_NAME)) {
368                 dev_err(dev, "Failed to request region 0x%04x-0x%04x.\n",
369                         sch311x_wdt_data.runtime_reg + RESGEN,
370                         sch311x_wdt_data.runtime_reg + RESGEN);
371                 err = -EBUSY;
372                 goto exit;
373         }
374
375         if (!request_region(sch311x_wdt_data.runtime_reg + GP60, 1, DRV_NAME)) {
376                 dev_err(dev, "Failed to request region 0x%04x-0x%04x.\n",
377                         sch311x_wdt_data.runtime_reg + GP60,
378                         sch311x_wdt_data.runtime_reg + GP60);
379                 err = -EBUSY;
380                 goto exit_release_region;
381         }
382
383         if (!request_region(sch311x_wdt_data.runtime_reg + WDT_TIME_OUT, 4,
384                                                                 DRV_NAME)) {
385                 dev_err(dev, "Failed to request region 0x%04x-0x%04x.\n",
386                         sch311x_wdt_data.runtime_reg + WDT_TIME_OUT,
387                         sch311x_wdt_data.runtime_reg + WDT_CTRL);
388                 err = -EBUSY;
389                 goto exit_release_region2;
390         }
391
392         /* Make sure that the watchdog is not running */
393         sch311x_wdt_stop();
394
395         /* Disable keyboard and mouse interaction and interrupt */
396         /* -- Watchdog timer configuration --
397          * Bit 0   Reserved
398          * Bit 1   Keyboard enable: 0* = No Reset, 1 = Reset WDT upon KBD Intr.
399          * Bit 2   Mouse enable: 0* = No Reset, 1 = Reset WDT upon Mouse Intr
400          * Bit 3   Reserved
401          * Bit 4-7 WDT Interrupt Mapping: (0000* = Disabled,
402          *            0001=IRQ1, 0010=(Invalid), 0011=IRQ3 to 1111=IRQ15)
403          */
404         outb(0, sch311x_wdt_data.runtime_reg + WDT_CFG);
405
406         /* Check that the heartbeat value is within it's range ;
407          * if not reset to the default */
408         if (sch311x_wdt_set_heartbeat(timeout)) {
409                 sch311x_wdt_set_heartbeat(WATCHDOG_TIMEOUT);
410                 dev_info(dev, "timeout value must be 1<=x<=15300, using %d\n",
411                         timeout);
412         }
413
414         /* Get status at boot */
415         sch311x_wdt_get_status(&sch311x_wdt_data.boot_status);
416
417         /* enable watchdog */
418         /* -- Reset Generator --
419          * Bit 0   Enable Watchdog Timer Generation: 0* = Enabled, 1 = Disabled
420          * Bit 1   Thermtrip Source Select: O* = No Source, 1 = Source
421          * Bit 2   WDT2_CTL: WDT input bit
422          * Bit 3-7 Reserved
423          */
424         outb(0, sch311x_wdt_data.runtime_reg + RESGEN);
425         val = therm_trip ? 0x06 : 0x04;
426         outb(val, sch311x_wdt_data.runtime_reg + RESGEN);
427
428         sch311x_wdt_miscdev.parent = dev;
429
430         err = misc_register(&sch311x_wdt_miscdev);
431         if (err != 0) {
432                 dev_err(dev, "cannot register miscdev on minor=%d (err=%d)\n",
433                                                         WATCHDOG_MINOR, err);
434                 goto exit_release_region3;
435         }
436
437         dev_info(dev,
438                 "SMSC SCH311x WDT initialized. timeout=%d sec (nowayout=%d)\n",
439                 timeout, nowayout);
440
441         return 0;
442
443 exit_release_region3:
444         release_region(sch311x_wdt_data.runtime_reg + WDT_TIME_OUT, 4);
445 exit_release_region2:
446         release_region(sch311x_wdt_data.runtime_reg + GP60, 1);
447 exit_release_region:
448         release_region(sch311x_wdt_data.runtime_reg + RESGEN, 1);
449         sch311x_wdt_data.runtime_reg = 0;
450 exit:
451         return err;
452 }
453
454 static int __devexit sch311x_wdt_remove(struct platform_device *pdev)
455 {
456         /* Stop the timer before we leave */
457         if (!nowayout)
458                 sch311x_wdt_stop();
459
460         /* Deregister */
461         misc_deregister(&sch311x_wdt_miscdev);
462         release_region(sch311x_wdt_data.runtime_reg + WDT_TIME_OUT, 4);
463         release_region(sch311x_wdt_data.runtime_reg + GP60, 1);
464         release_region(sch311x_wdt_data.runtime_reg + RESGEN, 1);
465         sch311x_wdt_data.runtime_reg = 0;
466         return 0;
467 }
468
469 static void sch311x_wdt_shutdown(struct platform_device *dev)
470 {
471         /* Turn the WDT off if we have a soft shutdown */
472         sch311x_wdt_stop();
473 }
474
475 static struct platform_driver sch311x_wdt_driver = {
476         .probe          = sch311x_wdt_probe,
477         .remove         = __devexit_p(sch311x_wdt_remove),
478         .shutdown       = sch311x_wdt_shutdown,
479         .driver         = {
480                 .owner = THIS_MODULE,
481                 .name = DRV_NAME,
482         },
483 };
484
485 static int __init sch311x_detect(int sio_config_port, unsigned short *addr)
486 {
487         int err = 0, reg;
488         unsigned short base_addr;
489         unsigned char dev_id;
490
491         sch311x_sio_enter(sio_config_port);
492
493         /* Check device ID. We currently know about:
494          * SCH3112 (0x7c), SCH3114 (0x7d), and SCH3116 (0x7f). */
495         reg = force_id ? force_id : sch311x_sio_inb(sio_config_port, 0x20);
496         if (!(reg == 0x7c || reg == 0x7d || reg == 0x7f)) {
497                 err = -ENODEV;
498                 goto exit;
499         }
500         dev_id = reg == 0x7c ? 2 : reg == 0x7d ? 4 : 6;
501
502         /* Select logical device A (runtime registers) */
503         sch311x_sio_outb(sio_config_port, 0x07, 0x0a);
504
505         /* Check if Logical Device Register is currently active */
506         if ((sch311x_sio_inb(sio_config_port, 0x30) & 0x01) == 0)
507                 pr_info("Seems that LDN 0x0a is not active...\n");
508
509         /* Get the base address of the runtime registers */
510         base_addr = (sch311x_sio_inb(sio_config_port, 0x60) << 8) |
511                            sch311x_sio_inb(sio_config_port, 0x61);
512         if (!base_addr) {
513                 pr_err("Base address not set\n");
514                 err = -ENODEV;
515                 goto exit;
516         }
517         *addr = base_addr;
518
519         pr_info("Found an SMSC SCH311%d chip at 0x%04x\n", dev_id, base_addr);
520
521 exit:
522         sch311x_sio_exit(sio_config_port);
523         return err;
524 }
525
526 static int __init sch311x_wdt_init(void)
527 {
528         int err, i, found = 0;
529         unsigned short addr = 0;
530
531         for (i = 0; !found && sch311x_ioports[i]; i++)
532                 if (sch311x_detect(sch311x_ioports[i], &addr) == 0)
533                         found++;
534
535         if (!found)
536                 return -ENODEV;
537
538         sch311x_wdt_data.runtime_reg = addr;
539
540         err = platform_driver_register(&sch311x_wdt_driver);
541         if (err)
542                 return err;
543
544         sch311x_wdt_pdev = platform_device_register_simple(DRV_NAME, addr,
545                                                                 NULL, 0);
546
547         if (IS_ERR(sch311x_wdt_pdev)) {
548                 err = PTR_ERR(sch311x_wdt_pdev);
549                 goto unreg_platform_driver;
550         }
551
552         return 0;
553
554 unreg_platform_driver:
555         platform_driver_unregister(&sch311x_wdt_driver);
556         return err;
557 }
558
559 static void __exit sch311x_wdt_exit(void)
560 {
561         platform_device_unregister(sch311x_wdt_pdev);
562         platform_driver_unregister(&sch311x_wdt_driver);
563 }
564
565 module_init(sch311x_wdt_init);
566 module_exit(sch311x_wdt_exit);
567
568 MODULE_AUTHOR("Wim Van Sebroeck <wim@iguana.be>");
569 MODULE_DESCRIPTION("SMSC SCH311x WatchDog Timer Driver");
570 MODULE_LICENSE("GPL");
571 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);
572