blob: 115a0ebebf4acdbded5cd73012c9b32701ff3789 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Berkshire USB-PC Watchdog Card Driver
3 *
Wim Van Sebroeck2ef473d2007-01-08 22:45:30 +01004 * (c) Copyright 2004-2007 Wim Van Sebroeck <wim@iguana.be>.
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
6 * Based on source code of the following authors:
7 * Ken Hollis <kenji@bitgate.com>,
Alan Cox29fa0582008-10-27 15:17:56 +00008 * Alan Cox <alan@lxorguk.ukuu.org.uk>,
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * Matt Domsch <Matt_Domsch@dell.com>,
10 * Rob Radez <rob@osinvestor.com>,
11 * Greg Kroah-Hartman <greg@kroah.com>
12 *
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License
15 * as published by the Free Software Foundation; either version
16 * 2 of the License, or (at your option) any later version.
17 *
18 * Neither Wim Van Sebroeck nor Iguana vzw. admit liability nor
19 * provide warranty for any of this software. This material is
20 * provided "AS-IS" and at no charge.
21 *
22 * Thanks also to Simon Machell at Berkshire Products Inc. for
23 * providing the test hardware. More info is available at
24 * http://www.berkprod.com/ or http://www.pcwatchdog.com/
25 */
26
Joe Perches27c766a2012-02-15 15:06:19 -080027#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
28
Wim Van Sebroeckd26d9092007-01-08 22:40:33 +010029#include <linux/module.h> /* For module specific items */
30#include <linux/moduleparam.h> /* For new moduleparam's */
31#include <linux/types.h> /* For standard types (like size_t) */
32#include <linux/errno.h> /* For the -ENODEV/... values */
33#include <linux/kernel.h> /* For printk/panic/... */
34#include <linux/delay.h> /* For mdelay function */
35#include <linux/miscdevice.h> /* For MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR) */
36#include <linux/watchdog.h> /* For the watchdog specific items */
37#include <linux/notifier.h> /* For notifier support */
38#include <linux/reboot.h> /* For reboot_notifier stuff */
39#include <linux/init.h> /* For __init/__exit/... */
40#include <linux/fs.h> /* For file operations */
41#include <linux/usb.h> /* For USB functions */
42#include <linux/slab.h> /* For kmalloc, ... */
43#include <linux/mutex.h> /* For mutex locking */
Wim Van Sebroeckd4b87592006-12-12 23:46:47 +010044#include <linux/hid.h> /* For HID_REQ_SET_REPORT & HID_DT_REPORT */
Wim Van Sebroeck089ab072008-07-15 11:46:11 +000045#include <linux/uaccess.h> /* For copy_to_user/put_user/... */
Wim Van Sebroeckd26d9092007-01-08 22:40:33 +010046
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#ifdef CONFIG_USB_DEBUG
Joe Perches27c766a2012-02-15 15:06:19 -080048static int debug = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049#else
Joe Perches27c766a2012-02-15 15:06:19 -080050static int debug;
Linus Torvalds1da177e2005-04-16 15:20:36 -070051#endif
52
53/* Use our own dbg macro */
Joe Perches27c766a2012-02-15 15:06:19 -080054
Linus Torvalds1da177e2005-04-16 15:20:36 -070055#undef dbg
Joe Perches27c766a2012-02-15 15:06:19 -080056#ifndef DEBUG
57#define DEBUG
58#endif
59#define dbg(format, ...) \
60do { \
61 if (debug) \
62 pr_debug(format "\n", ##__VA_ARGS__); \
63} while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
65/* Module and Version Information */
Wim Van Sebroeck2ef473d2007-01-08 22:45:30 +010066#define DRIVER_VERSION "1.02"
Linus Torvalds1da177e2005-04-16 15:20:36 -070067#define DRIVER_AUTHOR "Wim Van Sebroeck <wim@iguana.be>"
68#define DRIVER_DESC "Berkshire USB-PC Watchdog driver"
69#define DRIVER_LICENSE "GPL"
70#define DRIVER_NAME "pcwd_usb"
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
72MODULE_AUTHOR(DRIVER_AUTHOR);
73MODULE_DESCRIPTION(DRIVER_DESC);
74MODULE_LICENSE(DRIVER_LICENSE);
75MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);
76MODULE_ALIAS_MISCDEV(TEMP_MINOR);
77
78/* Module Parameters */
79module_param(debug, int, 0);
80MODULE_PARM_DESC(debug, "Debug enabled or not");
81
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +000082#define WATCHDOG_HEARTBEAT 0 /* default heartbeat =
83 delay-time from dip-switches */
Linus Torvalds1da177e2005-04-16 15:20:36 -070084static int heartbeat = WATCHDOG_HEARTBEAT;
85module_param(heartbeat, int, 0);
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +000086MODULE_PARM_DESC(heartbeat, "Watchdog heartbeat in seconds. "
87 "(0<heartbeat<65536 or 0=delay-time from dip-switches, default="
88 __MODULE_STRING(WATCHDOG_HEARTBEAT) ")");
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
Wim Van Sebroeck86a1e182012-03-05 16:51:11 +010090static bool nowayout = WATCHDOG_NOWAYOUT;
91module_param(nowayout, bool, 0);
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +000092MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default="
93 __MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
95/* The vendor and product id's for the USB-PC Watchdog card */
96#define USB_PCWD_VENDOR_ID 0x0c98
97#define USB_PCWD_PRODUCT_ID 0x1140
98
99/* table of devices that work with this driver */
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000100static struct usb_device_id usb_pcwd_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 { USB_DEVICE(USB_PCWD_VENDOR_ID, USB_PCWD_PRODUCT_ID) },
102 { } /* Terminating entry */
103};
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000104MODULE_DEVICE_TABLE(usb, usb_pcwd_table);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
106/* according to documentation max. time to process a command for the USB
107 * watchdog card is 100 or 200 ms, so we give it 250 ms to do it's job */
108#define USB_COMMAND_TIMEOUT 250
109
110/* Watchdog's internal commands */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000111#define CMD_READ_TEMP 0x02 /* Read Temperature;
112 Re-trigger Watchdog */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113#define CMD_TRIGGER CMD_READ_TEMP
114#define CMD_GET_STATUS 0x04 /* Get Status Information */
115#define CMD_GET_FIRMWARE_VERSION 0x08 /* Get Firmware Version */
116#define CMD_GET_DIP_SWITCH_SETTINGS 0x0c /* Get Dip Switch Settings */
117#define CMD_READ_WATCHDOG_TIMEOUT 0x18 /* Read Current Watchdog Time */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000118#define CMD_WRITE_WATCHDOG_TIMEOUT 0x19 /* Write Current WatchdogTime */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119#define CMD_ENABLE_WATCHDOG 0x30 /* Enable / Disable Watchdog */
120#define CMD_DISABLE_WATCHDOG CMD_ENABLE_WATCHDOG
121
Wim Van Sebroeck2ef473d2007-01-08 22:45:30 +0100122/* Watchdog's Dip Switch heartbeat values */
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000123static const int heartbeat_tbl[] = {
Wim Van Sebroeck2ef473d2007-01-08 22:45:30 +0100124 5, /* OFF-OFF-OFF = 5 Sec */
125 10, /* OFF-OFF-ON = 10 Sec */
126 30, /* OFF-ON-OFF = 30 Sec */
127 60, /* OFF-ON-ON = 1 Min */
128 300, /* ON-OFF-OFF = 5 Min */
129 600, /* ON-OFF-ON = 10 Min */
130 1800, /* ON-ON-OFF = 30 Min */
131 3600, /* ON-ON-ON = 1 hour */
132};
133
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134/* We can only use 1 card due to the /dev/watchdog restriction */
135static int cards_found;
136
137/* some internal variables */
138static unsigned long is_active;
139static char expect_release;
140
141/* Structure to hold all of our device specific stuff */
142struct usb_pcwd_private {
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000143 /* save off the usb device pointer */
144 struct usb_device *udev;
145 /* the interface for this device */
146 struct usb_interface *interface;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000148 /* the interface number used for cmd's */
149 unsigned int interface_number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000151 /* the buffer to intr data */
152 unsigned char *intr_buffer;
153 /* the dma address for the intr buffer */
154 dma_addr_t intr_dma;
155 /* the size of the intr buffer */
156 size_t intr_size;
157 /* the urb used for the intr pipe */
158 struct urb *intr_urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000160 /* The command that is reported back */
161 unsigned char cmd_command;
162 /* The data MSB that is reported back */
163 unsigned char cmd_data_msb;
164 /* The data LSB that is reported back */
165 unsigned char cmd_data_lsb;
166 /* true if we received a report after a command */
167 atomic_t cmd_received;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000169 /* Wether or not the device exists */
170 int exists;
171 /* locks this structure */
172 struct mutex mtx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173};
174static struct usb_pcwd_private *usb_pcwd_device;
175
176/* prevent races between open() and disconnect() */
Ingo Molnar6f87f0d2006-03-23 03:00:27 -0800177static DEFINE_MUTEX(disconnect_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
179/* local function prototypes */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000180static int usb_pcwd_probe(struct usb_interface *interface,
181 const struct usb_device_id *id);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000182static void usb_pcwd_disconnect(struct usb_interface *interface);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
184/* usb specific object needed to register this driver with the usb subsystem */
185static struct usb_driver usb_pcwd_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 .name = DRIVER_NAME,
187 .probe = usb_pcwd_probe,
188 .disconnect = usb_pcwd_disconnect,
189 .id_table = usb_pcwd_table,
190};
191
192
David Howells7d12e782006-10-05 14:55:46 +0100193static void usb_pcwd_intr_done(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194{
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000195 struct usb_pcwd_private *usb_pcwd =
196 (struct usb_pcwd_private *)urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 unsigned char *data = usb_pcwd->intr_buffer;
198 int retval;
199
200 switch (urb->status) {
201 case 0: /* success */
202 break;
203 case -ECONNRESET: /* unlink */
204 case -ENOENT:
205 case -ESHUTDOWN:
206 /* this urb is terminated, clean up */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000207 dbg("%s - urb shutting down with status: %d", __func__,
208 urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 return;
210 /* -EPIPE: should clear the halt */
211 default: /* error */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000212 dbg("%s - nonzero urb status received: %d", __func__,
213 urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 goto resubmit;
215 }
216
217 dbg("received following data cmd=0x%02x msb=0x%02x lsb=0x%02x",
218 data[0], data[1], data[2]);
219
220 usb_pcwd->cmd_command = data[0];
221 usb_pcwd->cmd_data_msb = data[1];
222 usb_pcwd->cmd_data_lsb = data[2];
223
224 /* notify anyone waiting that the cmd has finished */
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000225 atomic_set(&usb_pcwd->cmd_received, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
227resubmit:
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000228 retval = usb_submit_urb(urb, GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 if (retval)
Joe Perches27c766a2012-02-15 15:06:19 -0800230 pr_err("can't resubmit intr, usb_submit_urb failed with result %d\n",
231 retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232}
233
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000234static int usb_pcwd_send_command(struct usb_pcwd_private *usb_pcwd,
235 unsigned char cmd, unsigned char *msb, unsigned char *lsb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236{
237 int got_response, count;
Guenter Roeck5412df02013-10-14 09:29:34 -0700238 unsigned char *buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000240 /* We will not send any commands if the USB PCWD device does
241 * not exist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 if ((!usb_pcwd) || (!usb_pcwd->exists))
243 return -1;
244
Guenter Roeck5412df02013-10-14 09:29:34 -0700245 buf = kmalloc(6, GFP_KERNEL);
246 if (buf == NULL)
247 return 0;
248
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000249 /* The USB PC Watchdog uses a 6 byte report format.
250 * The board currently uses only 3 of the six bytes of the report. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 buf[0] = cmd; /* Byte 0 = CMD */
252 buf[1] = *msb; /* Byte 1 = Data MSB */
253 buf[2] = *lsb; /* Byte 2 = Data LSB */
254 buf[3] = buf[4] = buf[5] = 0; /* All other bytes not used */
255
256 dbg("sending following data cmd=0x%02x msb=0x%02x lsb=0x%02x",
257 buf[0], buf[1], buf[2]);
258
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000259 atomic_set(&usb_pcwd->cmd_received, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
261 if (usb_control_msg(usb_pcwd->udev, usb_sndctrlpipe(usb_pcwd->udev, 0),
262 HID_REQ_SET_REPORT, HID_DT_REPORT,
263 0x0200, usb_pcwd->interface_number, buf, sizeof(buf),
264 USB_COMMAND_TIMEOUT) != sizeof(buf)) {
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000265 dbg("usb_pcwd_send_command: error in usb_control_msg for "
266 "cmd 0x%x 0x%x 0x%x\n", cmd, *msb, *lsb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 }
268 /* wait till the usb card processed the command,
269 * with a max. timeout of USB_COMMAND_TIMEOUT */
270 got_response = 0;
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000271 for (count = 0; (count < USB_COMMAND_TIMEOUT) && (!got_response);
272 count++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 mdelay(1);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000274 if (atomic_read(&usb_pcwd->cmd_received))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 got_response = 1;
276 }
277
278 if ((got_response) && (cmd == usb_pcwd->cmd_command)) {
279 /* read back response */
280 *msb = usb_pcwd->cmd_data_msb;
281 *lsb = usb_pcwd->cmd_data_lsb;
282 }
283
Guenter Roeck5412df02013-10-14 09:29:34 -0700284 kfree(buf);
285
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 return got_response;
287}
288
289static int usb_pcwd_start(struct usb_pcwd_private *usb_pcwd)
290{
291 unsigned char msb = 0x00;
292 unsigned char lsb = 0x00;
293 int retval;
294
295 /* Enable Watchdog */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000296 retval = usb_pcwd_send_command(usb_pcwd, CMD_ENABLE_WATCHDOG,
297 &msb, &lsb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298
299 if ((retval == 0) || (lsb == 0)) {
Joe Perches27c766a2012-02-15 15:06:19 -0800300 pr_err("Card did not acknowledge enable attempt\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 return -1;
302 }
303
304 return 0;
305}
306
307static int usb_pcwd_stop(struct usb_pcwd_private *usb_pcwd)
308{
309 unsigned char msb = 0xA5;
310 unsigned char lsb = 0xC3;
311 int retval;
312
313 /* Disable Watchdog */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000314 retval = usb_pcwd_send_command(usb_pcwd, CMD_DISABLE_WATCHDOG,
315 &msb, &lsb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
317 if ((retval == 0) || (lsb != 0)) {
Joe Perches27c766a2012-02-15 15:06:19 -0800318 pr_err("Card did not acknowledge disable attempt\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 return -1;
320 }
321
322 return 0;
323}
324
325static int usb_pcwd_keepalive(struct usb_pcwd_private *usb_pcwd)
326{
327 unsigned char dummy;
328
329 /* Re-trigger Watchdog */
330 usb_pcwd_send_command(usb_pcwd, CMD_TRIGGER, &dummy, &dummy);
331
332 return 0;
333}
334
335static int usb_pcwd_set_heartbeat(struct usb_pcwd_private *usb_pcwd, int t)
336{
337 unsigned char msb = t / 256;
338 unsigned char lsb = t % 256;
339
340 if ((t < 0x0001) || (t > 0xFFFF))
341 return -EINVAL;
342
343 /* Write new heartbeat to watchdog */
344 usb_pcwd_send_command(usb_pcwd, CMD_WRITE_WATCHDOG_TIMEOUT, &msb, &lsb);
345
346 heartbeat = t;
347 return 0;
348}
349
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000350static int usb_pcwd_get_temperature(struct usb_pcwd_private *usb_pcwd,
351 int *temperature)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352{
353 unsigned char msb, lsb;
354
355 usb_pcwd_send_command(usb_pcwd, CMD_READ_TEMP, &msb, &lsb);
356
357 /*
358 * Convert celsius to fahrenheit, since this was
359 * the decided 'standard' for this return value.
360 */
361 *temperature = (lsb * 9 / 5) + 32;
362
363 return 0;
364}
365
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000366static int usb_pcwd_get_timeleft(struct usb_pcwd_private *usb_pcwd,
367 int *time_left)
Wim Van Sebroeck58b519f2006-05-21 12:48:44 +0200368{
369 unsigned char msb, lsb;
370
371 /* Read the time that's left before rebooting */
372 /* Note: if the board is not yet armed then we will read 0xFFFF */
373 usb_pcwd_send_command(usb_pcwd, CMD_READ_WATCHDOG_TIMEOUT, &msb, &lsb);
374
375 *time_left = (msb << 8) + lsb;
376
377 return 0;
378}
379
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380/*
381 * /dev/watchdog handling
382 */
383
384static ssize_t usb_pcwd_write(struct file *file, const char __user *data,
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000385 size_t len, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386{
387 /* See if we got the magic character 'V' and reload the timer */
388 if (len) {
389 if (!nowayout) {
390 size_t i;
391
392 /* note: just in case someone wrote the magic character
393 * five months ago... */
394 expect_release = 0;
395
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000396 /* scan to see whether or not we got the
397 * magic character */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 for (i = 0; i != len; i++) {
399 char c;
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000400 if (get_user(c, data + i))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 return -EFAULT;
402 if (c == 'V')
403 expect_release = 42;
404 }
405 }
406
407 /* someone wrote to us, we should reload the timer */
408 usb_pcwd_keepalive(usb_pcwd_device);
409 }
410 return len;
411}
412
Alan Coxc9488522008-07-03 23:51:32 -0700413static long usb_pcwd_ioctl(struct file *file, unsigned int cmd,
414 unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415{
416 void __user *argp = (void __user *)arg;
417 int __user *p = argp;
Wim Van Sebroeck42747d72009-12-26 18:55:22 +0000418 static const struct watchdog_info ident = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 .options = WDIOF_KEEPALIVEPING |
420 WDIOF_SETTIMEOUT |
421 WDIOF_MAGICCLOSE,
422 .firmware_version = 1,
423 .identity = DRIVER_NAME,
424 };
425
426 switch (cmd) {
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000427 case WDIOC_GETSUPPORT:
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000428 return copy_to_user(argp, &ident, sizeof(ident)) ? -EFAULT : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000430 case WDIOC_GETSTATUS:
431 case WDIOC_GETBOOTSTATUS:
432 return put_user(0, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000434 case WDIOC_GETTEMP:
435 {
436 int temperature;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000438 if (usb_pcwd_get_temperature(usb_pcwd_device, &temperature))
439 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000441 return put_user(temperature, p);
442 }
443
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000444 case WDIOC_SETOPTIONS:
445 {
446 int new_options, retval = -EINVAL;
447
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000448 if (get_user(new_options, p))
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000449 return -EFAULT;
450
451 if (new_options & WDIOS_DISABLECARD) {
452 usb_pcwd_stop(usb_pcwd_device);
453 retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 }
455
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000456 if (new_options & WDIOS_ENABLECARD) {
457 usb_pcwd_start(usb_pcwd_device);
458 retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 }
460
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000461 return retval;
462 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463
Wim Van Sebroeck0c06090c2008-07-18 11:41:17 +0000464 case WDIOC_KEEPALIVE:
465 usb_pcwd_keepalive(usb_pcwd_device);
466 return 0;
467
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000468 case WDIOC_SETTIMEOUT:
469 {
470 int new_heartbeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000472 if (get_user(new_heartbeat, p))
473 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000475 if (usb_pcwd_set_heartbeat(usb_pcwd_device, new_heartbeat))
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000476 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000478 usb_pcwd_keepalive(usb_pcwd_device);
479 /* Fall */
480 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000482 case WDIOC_GETTIMEOUT:
483 return put_user(heartbeat, p);
Wim Van Sebroeck58b519f2006-05-21 12:48:44 +0200484
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000485 case WDIOC_GETTIMELEFT:
486 {
487 int time_left;
Wim Van Sebroeck58b519f2006-05-21 12:48:44 +0200488
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000489 if (usb_pcwd_get_timeleft(usb_pcwd_device, &time_left))
490 return -EFAULT;
Wim Van Sebroeck58b519f2006-05-21 12:48:44 +0200491
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000492 return put_user(time_left, p);
493 }
494
495 default:
496 return -ENOTTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 }
498}
499
500static int usb_pcwd_open(struct inode *inode, struct file *file)
501{
502 /* /dev/watchdog can only be opened once */
503 if (test_and_set_bit(0, &is_active))
504 return -EBUSY;
505
506 /* Activate */
507 usb_pcwd_start(usb_pcwd_device);
508 usb_pcwd_keepalive(usb_pcwd_device);
509 return nonseekable_open(inode, file);
510}
511
512static int usb_pcwd_release(struct inode *inode, struct file *file)
513{
514 /*
515 * Shut off the timer.
516 */
517 if (expect_release == 42) {
518 usb_pcwd_stop(usb_pcwd_device);
519 } else {
Joe Perches27c766a2012-02-15 15:06:19 -0800520 pr_crit("Unexpected close, not stopping watchdog!\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 usb_pcwd_keepalive(usb_pcwd_device);
522 }
523 expect_release = 0;
524 clear_bit(0, &is_active);
525 return 0;
526}
527
528/*
529 * /dev/temperature handling
530 */
531
532static ssize_t usb_pcwd_temperature_read(struct file *file, char __user *data,
533 size_t len, loff_t *ppos)
534{
535 int temperature;
536
537 if (usb_pcwd_get_temperature(usb_pcwd_device, &temperature))
538 return -EFAULT;
539
540 if (copy_to_user(data, &temperature, 1))
541 return -EFAULT;
542
543 return 1;
544}
545
546static int usb_pcwd_temperature_open(struct inode *inode, struct file *file)
547{
548 return nonseekable_open(inode, file);
549}
550
551static int usb_pcwd_temperature_release(struct inode *inode, struct file *file)
552{
553 return 0;
554}
555
556/*
557 * Notify system
558 */
559
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000560static int usb_pcwd_notify_sys(struct notifier_block *this, unsigned long code,
561 void *unused)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562{
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000563 if (code == SYS_DOWN || code == SYS_HALT)
564 usb_pcwd_stop(usb_pcwd_device); /* Turn the WDT off */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565
566 return NOTIFY_DONE;
567}
568
569/*
570 * Kernel Interfaces
571 */
572
Arjan van de Ven62322d22006-07-03 00:24:21 -0700573static const struct file_operations usb_pcwd_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 .owner = THIS_MODULE,
575 .llseek = no_llseek,
576 .write = usb_pcwd_write,
Alan Coxc9488522008-07-03 23:51:32 -0700577 .unlocked_ioctl = usb_pcwd_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 .open = usb_pcwd_open,
579 .release = usb_pcwd_release,
580};
581
582static struct miscdevice usb_pcwd_miscdev = {
583 .minor = WATCHDOG_MINOR,
584 .name = "watchdog",
585 .fops = &usb_pcwd_fops,
586};
587
Arjan van de Ven62322d22006-07-03 00:24:21 -0700588static const struct file_operations usb_pcwd_temperature_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 .owner = THIS_MODULE,
590 .llseek = no_llseek,
591 .read = usb_pcwd_temperature_read,
592 .open = usb_pcwd_temperature_open,
593 .release = usb_pcwd_temperature_release,
594};
595
596static struct miscdevice usb_pcwd_temperature_miscdev = {
597 .minor = TEMP_MINOR,
598 .name = "temperature",
599 .fops = &usb_pcwd_temperature_fops,
600};
601
602static struct notifier_block usb_pcwd_notifier = {
603 .notifier_call = usb_pcwd_notify_sys,
604};
605
606/**
607 * usb_pcwd_delete
608 */
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000609static inline void usb_pcwd_delete(struct usb_pcwd_private *usb_pcwd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610{
Mariusz Kozlowski6265d622006-11-08 15:34:02 +0100611 usb_free_urb(usb_pcwd->intr_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 if (usb_pcwd->intr_buffer != NULL)
Daniel Mack997ea582010-04-12 13:17:25 +0200613 usb_free_coherent(usb_pcwd->udev, usb_pcwd->intr_size,
614 usb_pcwd->intr_buffer, usb_pcwd->intr_dma);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000615 kfree(usb_pcwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616}
617
618/**
619 * usb_pcwd_probe
620 *
621 * Called by the usb core when a new device is connected that it thinks
622 * this driver might be interested in.
623 */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000624static int usb_pcwd_probe(struct usb_interface *interface,
625 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626{
627 struct usb_device *udev = interface_to_usbdev(interface);
628 struct usb_host_interface *iface_desc;
629 struct usb_endpoint_descriptor *endpoint;
630 struct usb_pcwd_private *usb_pcwd = NULL;
631 int pipe, maxp;
632 int retval = -ENOMEM;
633 int got_fw_rev;
634 unsigned char fw_rev_major, fw_rev_minor;
635 char fw_ver_str[20];
636 unsigned char option_switches, dummy;
637
638 cards_found++;
639 if (cards_found > 1) {
Joe Perches27c766a2012-02-15 15:06:19 -0800640 pr_err("This driver only supports 1 device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 return -ENODEV;
642 }
643
644 /* get the active interface descriptor */
645 iface_desc = interface->cur_altsetting;
646
647 /* check out that we have a HID device */
648 if (!(iface_desc->desc.bInterfaceClass == USB_CLASS_HID)) {
Joe Perches27c766a2012-02-15 15:06:19 -0800649 pr_err("The device isn't a Human Interface Device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 return -ENODEV;
651 }
652
653 /* check out the endpoint: it has to be Interrupt & IN */
654 endpoint = &iface_desc->endpoint[0].desc;
655
Julia Lawall2855d282008-12-29 11:23:47 +0100656 if (!usb_endpoint_is_int_in(endpoint)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 /* we didn't find a Interrupt endpoint with direction IN */
Joe Perches27c766a2012-02-15 15:06:19 -0800658 pr_err("Couldn't find an INTR & IN endpoint\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 return -ENODEV;
660 }
661
662 /* get a handle to the interrupt data pipe */
663 pipe = usb_rcvintpipe(udev, endpoint->bEndpointAddress);
664 maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
665
666 /* allocate memory for our device and initialize it */
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000667 usb_pcwd = kzalloc(sizeof(struct usb_pcwd_private), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 if (usb_pcwd == NULL) {
Joe Perches27c766a2012-02-15 15:06:19 -0800669 pr_err("Out of memory\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 goto error;
671 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672
673 usb_pcwd_device = usb_pcwd;
674
Matthias Kaehlcke9f7afa62007-05-03 20:15:14 -0700675 mutex_init(&usb_pcwd->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 usb_pcwd->udev = udev;
677 usb_pcwd->interface = interface;
678 usb_pcwd->interface_number = iface_desc->desc.bInterfaceNumber;
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000679 usb_pcwd->intr_size = (le16_to_cpu(endpoint->wMaxPacketSize) > 8 ?
680 le16_to_cpu(endpoint->wMaxPacketSize) : 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681
682 /* set up the memory buffer's */
Daniel Mack997ea582010-04-12 13:17:25 +0200683 usb_pcwd->intr_buffer = usb_alloc_coherent(udev, usb_pcwd->intr_size,
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000684 GFP_ATOMIC, &usb_pcwd->intr_dma);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000685 if (!usb_pcwd->intr_buffer) {
Joe Perches27c766a2012-02-15 15:06:19 -0800686 pr_err("Out of memory\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 goto error;
688 }
689
690 /* allocate the urb's */
691 usb_pcwd->intr_urb = usb_alloc_urb(0, GFP_KERNEL);
692 if (!usb_pcwd->intr_urb) {
Joe Perches27c766a2012-02-15 15:06:19 -0800693 pr_err("Out of memory\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 goto error;
695 }
696
697 /* initialise the intr urb's */
698 usb_fill_int_urb(usb_pcwd->intr_urb, udev, pipe,
699 usb_pcwd->intr_buffer, usb_pcwd->intr_size,
700 usb_pcwd_intr_done, usb_pcwd, endpoint->bInterval);
701 usb_pcwd->intr_urb->transfer_dma = usb_pcwd->intr_dma;
702 usb_pcwd->intr_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
703
704 /* register our interrupt URB with the USB system */
705 if (usb_submit_urb(usb_pcwd->intr_urb, GFP_KERNEL)) {
Joe Perches27c766a2012-02-15 15:06:19 -0800706 pr_err("Problem registering interrupt URB\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 retval = -EIO; /* failure */
708 goto error;
709 }
710
711 /* The device exists and can be communicated with */
712 usb_pcwd->exists = 1;
713
714 /* disable card */
715 usb_pcwd_stop(usb_pcwd);
716
717 /* Get the Firmware Version */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000718 got_fw_rev = usb_pcwd_send_command(usb_pcwd, CMD_GET_FIRMWARE_VERSION,
719 &fw_rev_major, &fw_rev_minor);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000720 if (got_fw_rev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 sprintf(fw_ver_str, "%u.%02u", fw_rev_major, fw_rev_minor);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000722 else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 sprintf(fw_ver_str, "<card no answer>");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724
Joe Perches27c766a2012-02-15 15:06:19 -0800725 pr_info("Found card (Firmware: %s) with temp option\n", fw_ver_str);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
727 /* Get switch settings */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000728 usb_pcwd_send_command(usb_pcwd, CMD_GET_DIP_SWITCH_SETTINGS, &dummy,
729 &option_switches);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730
Joe Perches27c766a2012-02-15 15:06:19 -0800731 pr_info("Option switches (0x%02x): Temperature Reset Enable=%s, Power On Delay=%s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 option_switches,
733 ((option_switches & 0x10) ? "ON" : "OFF"),
734 ((option_switches & 0x08) ? "ON" : "OFF"));
735
Wim Van Sebroeck2ef473d2007-01-08 22:45:30 +0100736 /* If heartbeat = 0 then we use the heartbeat from the dip-switches */
737 if (heartbeat == 0)
738 heartbeat = heartbeat_tbl[(option_switches & 0x07)];
739
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000740 /* Check that the heartbeat value is within it's range ;
741 * if not reset to the default */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 if (usb_pcwd_set_heartbeat(usb_pcwd, heartbeat)) {
743 usb_pcwd_set_heartbeat(usb_pcwd, WATCHDOG_HEARTBEAT);
Joe Perches27c766a2012-02-15 15:06:19 -0800744 pr_info("heartbeat value must be 0<heartbeat<65536, using %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 WATCHDOG_HEARTBEAT);
746 }
747
748 retval = register_reboot_notifier(&usb_pcwd_notifier);
749 if (retval != 0) {
Joe Perches27c766a2012-02-15 15:06:19 -0800750 pr_err("cannot register reboot notifier (err=%d)\n", retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 goto error;
752 }
753
754 retval = misc_register(&usb_pcwd_temperature_miscdev);
755 if (retval != 0) {
Joe Perches27c766a2012-02-15 15:06:19 -0800756 pr_err("cannot register miscdev on minor=%d (err=%d)\n",
757 TEMP_MINOR, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 goto err_out_unregister_reboot;
759 }
760
761 retval = misc_register(&usb_pcwd_miscdev);
762 if (retval != 0) {
Joe Perches27c766a2012-02-15 15:06:19 -0800763 pr_err("cannot register miscdev on minor=%d (err=%d)\n",
764 WATCHDOG_MINOR, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 goto err_out_misc_deregister;
766 }
767
768 /* we can register the device now, as it is ready */
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000769 usb_set_intfdata(interface, usb_pcwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770
Joe Perches27c766a2012-02-15 15:06:19 -0800771 pr_info("initialized. heartbeat=%d sec (nowayout=%d)\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 heartbeat, nowayout);
773
774 return 0;
775
776err_out_misc_deregister:
777 misc_deregister(&usb_pcwd_temperature_miscdev);
778err_out_unregister_reboot:
779 unregister_reboot_notifier(&usb_pcwd_notifier);
780error:
Adrian Bunkc9d1a0b2006-03-10 19:04:38 +0100781 if (usb_pcwd)
782 usb_pcwd_delete(usb_pcwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 usb_pcwd_device = NULL;
784 return retval;
785}
786
787
788/**
789 * usb_pcwd_disconnect
790 *
791 * Called by the usb core when the device is removed from the system.
792 *
793 * This routine guarantees that the driver will not submit any more urbs
794 * by clearing dev->udev.
795 */
796static void usb_pcwd_disconnect(struct usb_interface *interface)
797{
798 struct usb_pcwd_private *usb_pcwd;
799
800 /* prevent races with open() */
Ingo Molnar6f87f0d2006-03-23 03:00:27 -0800801 mutex_lock(&disconnect_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000803 usb_pcwd = usb_get_intfdata(interface);
804 usb_set_intfdata(interface, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805
Matthias Kaehlcke9f7afa62007-05-03 20:15:14 -0700806 mutex_lock(&usb_pcwd->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807
808 /* Stop the timer before we leave */
809 if (!nowayout)
810 usb_pcwd_stop(usb_pcwd);
811
812 /* We should now stop communicating with the USB PCWD device */
813 usb_pcwd->exists = 0;
814
815 /* Deregister */
816 misc_deregister(&usb_pcwd_miscdev);
817 misc_deregister(&usb_pcwd_temperature_miscdev);
818 unregister_reboot_notifier(&usb_pcwd_notifier);
819
Matthias Kaehlcke9f7afa62007-05-03 20:15:14 -0700820 mutex_unlock(&usb_pcwd->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821
822 /* Delete the USB PCWD device */
823 usb_pcwd_delete(usb_pcwd);
824
825 cards_found--;
826
Ingo Molnar6f87f0d2006-03-23 03:00:27 -0800827 mutex_unlock(&disconnect_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828
Joe Perches27c766a2012-02-15 15:06:19 -0800829 pr_info("USB PC Watchdog disconnected\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830}
831
Greg Kroah-Hartmanfe748482011-11-18 09:52:10 -0800832module_usb_driver(usb_pcwd_driver);