blob: 7b14d184792705d3b60ea6fba20041be351a186d [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;
238 unsigned char buf[6];
239
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
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000245 /* The USB PC Watchdog uses a 6 byte report format.
246 * The board currently uses only 3 of the six bytes of the report. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 buf[0] = cmd; /* Byte 0 = CMD */
248 buf[1] = *msb; /* Byte 1 = Data MSB */
249 buf[2] = *lsb; /* Byte 2 = Data LSB */
250 buf[3] = buf[4] = buf[5] = 0; /* All other bytes not used */
251
252 dbg("sending following data cmd=0x%02x msb=0x%02x lsb=0x%02x",
253 buf[0], buf[1], buf[2]);
254
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000255 atomic_set(&usb_pcwd->cmd_received, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
257 if (usb_control_msg(usb_pcwd->udev, usb_sndctrlpipe(usb_pcwd->udev, 0),
258 HID_REQ_SET_REPORT, HID_DT_REPORT,
259 0x0200, usb_pcwd->interface_number, buf, sizeof(buf),
260 USB_COMMAND_TIMEOUT) != sizeof(buf)) {
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000261 dbg("usb_pcwd_send_command: error in usb_control_msg for "
262 "cmd 0x%x 0x%x 0x%x\n", cmd, *msb, *lsb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 }
264 /* wait till the usb card processed the command,
265 * with a max. timeout of USB_COMMAND_TIMEOUT */
266 got_response = 0;
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000267 for (count = 0; (count < USB_COMMAND_TIMEOUT) && (!got_response);
268 count++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 mdelay(1);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000270 if (atomic_read(&usb_pcwd->cmd_received))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 got_response = 1;
272 }
273
274 if ((got_response) && (cmd == usb_pcwd->cmd_command)) {
275 /* read back response */
276 *msb = usb_pcwd->cmd_data_msb;
277 *lsb = usb_pcwd->cmd_data_lsb;
278 }
279
280 return got_response;
281}
282
283static int usb_pcwd_start(struct usb_pcwd_private *usb_pcwd)
284{
285 unsigned char msb = 0x00;
286 unsigned char lsb = 0x00;
287 int retval;
288
289 /* Enable Watchdog */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000290 retval = usb_pcwd_send_command(usb_pcwd, CMD_ENABLE_WATCHDOG,
291 &msb, &lsb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
293 if ((retval == 0) || (lsb == 0)) {
Joe Perches27c766a2012-02-15 15:06:19 -0800294 pr_err("Card did not acknowledge enable attempt\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 return -1;
296 }
297
298 return 0;
299}
300
301static int usb_pcwd_stop(struct usb_pcwd_private *usb_pcwd)
302{
303 unsigned char msb = 0xA5;
304 unsigned char lsb = 0xC3;
305 int retval;
306
307 /* Disable Watchdog */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000308 retval = usb_pcwd_send_command(usb_pcwd, CMD_DISABLE_WATCHDOG,
309 &msb, &lsb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
311 if ((retval == 0) || (lsb != 0)) {
Joe Perches27c766a2012-02-15 15:06:19 -0800312 pr_err("Card did not acknowledge disable attempt\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 return -1;
314 }
315
316 return 0;
317}
318
319static int usb_pcwd_keepalive(struct usb_pcwd_private *usb_pcwd)
320{
321 unsigned char dummy;
322
323 /* Re-trigger Watchdog */
324 usb_pcwd_send_command(usb_pcwd, CMD_TRIGGER, &dummy, &dummy);
325
326 return 0;
327}
328
329static int usb_pcwd_set_heartbeat(struct usb_pcwd_private *usb_pcwd, int t)
330{
331 unsigned char msb = t / 256;
332 unsigned char lsb = t % 256;
333
334 if ((t < 0x0001) || (t > 0xFFFF))
335 return -EINVAL;
336
337 /* Write new heartbeat to watchdog */
338 usb_pcwd_send_command(usb_pcwd, CMD_WRITE_WATCHDOG_TIMEOUT, &msb, &lsb);
339
340 heartbeat = t;
341 return 0;
342}
343
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000344static int usb_pcwd_get_temperature(struct usb_pcwd_private *usb_pcwd,
345 int *temperature)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346{
347 unsigned char msb, lsb;
348
349 usb_pcwd_send_command(usb_pcwd, CMD_READ_TEMP, &msb, &lsb);
350
351 /*
352 * Convert celsius to fahrenheit, since this was
353 * the decided 'standard' for this return value.
354 */
355 *temperature = (lsb * 9 / 5) + 32;
356
357 return 0;
358}
359
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000360static int usb_pcwd_get_timeleft(struct usb_pcwd_private *usb_pcwd,
361 int *time_left)
Wim Van Sebroeck58b519f2006-05-21 12:48:44 +0200362{
363 unsigned char msb, lsb;
364
365 /* Read the time that's left before rebooting */
366 /* Note: if the board is not yet armed then we will read 0xFFFF */
367 usb_pcwd_send_command(usb_pcwd, CMD_READ_WATCHDOG_TIMEOUT, &msb, &lsb);
368
369 *time_left = (msb << 8) + lsb;
370
371 return 0;
372}
373
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374/*
375 * /dev/watchdog handling
376 */
377
378static ssize_t usb_pcwd_write(struct file *file, const char __user *data,
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000379 size_t len, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380{
381 /* See if we got the magic character 'V' and reload the timer */
382 if (len) {
383 if (!nowayout) {
384 size_t i;
385
386 /* note: just in case someone wrote the magic character
387 * five months ago... */
388 expect_release = 0;
389
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000390 /* scan to see whether or not we got the
391 * magic character */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 for (i = 0; i != len; i++) {
393 char c;
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000394 if (get_user(c, data + i))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 return -EFAULT;
396 if (c == 'V')
397 expect_release = 42;
398 }
399 }
400
401 /* someone wrote to us, we should reload the timer */
402 usb_pcwd_keepalive(usb_pcwd_device);
403 }
404 return len;
405}
406
Alan Coxc9488522008-07-03 23:51:32 -0700407static long usb_pcwd_ioctl(struct file *file, unsigned int cmd,
408 unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409{
410 void __user *argp = (void __user *)arg;
411 int __user *p = argp;
Wim Van Sebroeck42747d72009-12-26 18:55:22 +0000412 static const struct watchdog_info ident = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 .options = WDIOF_KEEPALIVEPING |
414 WDIOF_SETTIMEOUT |
415 WDIOF_MAGICCLOSE,
416 .firmware_version = 1,
417 .identity = DRIVER_NAME,
418 };
419
420 switch (cmd) {
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000421 case WDIOC_GETSUPPORT:
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000422 return copy_to_user(argp, &ident, sizeof(ident)) ? -EFAULT : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000424 case WDIOC_GETSTATUS:
425 case WDIOC_GETBOOTSTATUS:
426 return put_user(0, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000428 case WDIOC_GETTEMP:
429 {
430 int temperature;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000432 if (usb_pcwd_get_temperature(usb_pcwd_device, &temperature))
433 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000435 return put_user(temperature, p);
436 }
437
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000438 case WDIOC_SETOPTIONS:
439 {
440 int new_options, retval = -EINVAL;
441
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000442 if (get_user(new_options, p))
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000443 return -EFAULT;
444
445 if (new_options & WDIOS_DISABLECARD) {
446 usb_pcwd_stop(usb_pcwd_device);
447 retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 }
449
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000450 if (new_options & WDIOS_ENABLECARD) {
451 usb_pcwd_start(usb_pcwd_device);
452 retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 }
454
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000455 return retval;
456 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457
Wim Van Sebroeck0c06090c2008-07-18 11:41:17 +0000458 case WDIOC_KEEPALIVE:
459 usb_pcwd_keepalive(usb_pcwd_device);
460 return 0;
461
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000462 case WDIOC_SETTIMEOUT:
463 {
464 int new_heartbeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000466 if (get_user(new_heartbeat, p))
467 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000469 if (usb_pcwd_set_heartbeat(usb_pcwd_device, new_heartbeat))
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000470 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000472 usb_pcwd_keepalive(usb_pcwd_device);
473 /* Fall */
474 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000476 case WDIOC_GETTIMEOUT:
477 return put_user(heartbeat, p);
Wim Van Sebroeck58b519f2006-05-21 12:48:44 +0200478
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000479 case WDIOC_GETTIMELEFT:
480 {
481 int time_left;
Wim Van Sebroeck58b519f2006-05-21 12:48:44 +0200482
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000483 if (usb_pcwd_get_timeleft(usb_pcwd_device, &time_left))
484 return -EFAULT;
Wim Van Sebroeck58b519f2006-05-21 12:48:44 +0200485
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000486 return put_user(time_left, p);
487 }
488
489 default:
490 return -ENOTTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 }
492}
493
494static int usb_pcwd_open(struct inode *inode, struct file *file)
495{
496 /* /dev/watchdog can only be opened once */
497 if (test_and_set_bit(0, &is_active))
498 return -EBUSY;
499
500 /* Activate */
501 usb_pcwd_start(usb_pcwd_device);
502 usb_pcwd_keepalive(usb_pcwd_device);
503 return nonseekable_open(inode, file);
504}
505
506static int usb_pcwd_release(struct inode *inode, struct file *file)
507{
508 /*
509 * Shut off the timer.
510 */
511 if (expect_release == 42) {
512 usb_pcwd_stop(usb_pcwd_device);
513 } else {
Joe Perches27c766a2012-02-15 15:06:19 -0800514 pr_crit("Unexpected close, not stopping watchdog!\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 usb_pcwd_keepalive(usb_pcwd_device);
516 }
517 expect_release = 0;
518 clear_bit(0, &is_active);
519 return 0;
520}
521
522/*
523 * /dev/temperature handling
524 */
525
526static ssize_t usb_pcwd_temperature_read(struct file *file, char __user *data,
527 size_t len, loff_t *ppos)
528{
529 int temperature;
530
531 if (usb_pcwd_get_temperature(usb_pcwd_device, &temperature))
532 return -EFAULT;
533
534 if (copy_to_user(data, &temperature, 1))
535 return -EFAULT;
536
537 return 1;
538}
539
540static int usb_pcwd_temperature_open(struct inode *inode, struct file *file)
541{
542 return nonseekable_open(inode, file);
543}
544
545static int usb_pcwd_temperature_release(struct inode *inode, struct file *file)
546{
547 return 0;
548}
549
550/*
551 * Notify system
552 */
553
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000554static int usb_pcwd_notify_sys(struct notifier_block *this, unsigned long code,
555 void *unused)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556{
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000557 if (code == SYS_DOWN || code == SYS_HALT)
558 usb_pcwd_stop(usb_pcwd_device); /* Turn the WDT off */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559
560 return NOTIFY_DONE;
561}
562
563/*
564 * Kernel Interfaces
565 */
566
Arjan van de Ven62322d22006-07-03 00:24:21 -0700567static const struct file_operations usb_pcwd_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 .owner = THIS_MODULE,
569 .llseek = no_llseek,
570 .write = usb_pcwd_write,
Alan Coxc9488522008-07-03 23:51:32 -0700571 .unlocked_ioctl = usb_pcwd_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 .open = usb_pcwd_open,
573 .release = usb_pcwd_release,
574};
575
576static struct miscdevice usb_pcwd_miscdev = {
577 .minor = WATCHDOG_MINOR,
578 .name = "watchdog",
579 .fops = &usb_pcwd_fops,
580};
581
Arjan van de Ven62322d22006-07-03 00:24:21 -0700582static const struct file_operations usb_pcwd_temperature_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 .owner = THIS_MODULE,
584 .llseek = no_llseek,
585 .read = usb_pcwd_temperature_read,
586 .open = usb_pcwd_temperature_open,
587 .release = usb_pcwd_temperature_release,
588};
589
590static struct miscdevice usb_pcwd_temperature_miscdev = {
591 .minor = TEMP_MINOR,
592 .name = "temperature",
593 .fops = &usb_pcwd_temperature_fops,
594};
595
596static struct notifier_block usb_pcwd_notifier = {
597 .notifier_call = usb_pcwd_notify_sys,
598};
599
600/**
601 * usb_pcwd_delete
602 */
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000603static inline void usb_pcwd_delete(struct usb_pcwd_private *usb_pcwd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604{
Mariusz Kozlowski6265d622006-11-08 15:34:02 +0100605 usb_free_urb(usb_pcwd->intr_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 if (usb_pcwd->intr_buffer != NULL)
Daniel Mack997ea582010-04-12 13:17:25 +0200607 usb_free_coherent(usb_pcwd->udev, usb_pcwd->intr_size,
608 usb_pcwd->intr_buffer, usb_pcwd->intr_dma);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000609 kfree(usb_pcwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610}
611
612/**
613 * usb_pcwd_probe
614 *
615 * Called by the usb core when a new device is connected that it thinks
616 * this driver might be interested in.
617 */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000618static int usb_pcwd_probe(struct usb_interface *interface,
619 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620{
621 struct usb_device *udev = interface_to_usbdev(interface);
622 struct usb_host_interface *iface_desc;
623 struct usb_endpoint_descriptor *endpoint;
624 struct usb_pcwd_private *usb_pcwd = NULL;
625 int pipe, maxp;
626 int retval = -ENOMEM;
627 int got_fw_rev;
628 unsigned char fw_rev_major, fw_rev_minor;
629 char fw_ver_str[20];
630 unsigned char option_switches, dummy;
631
632 cards_found++;
633 if (cards_found > 1) {
Joe Perches27c766a2012-02-15 15:06:19 -0800634 pr_err("This driver only supports 1 device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 return -ENODEV;
636 }
637
638 /* get the active interface descriptor */
639 iface_desc = interface->cur_altsetting;
640
641 /* check out that we have a HID device */
642 if (!(iface_desc->desc.bInterfaceClass == USB_CLASS_HID)) {
Joe Perches27c766a2012-02-15 15:06:19 -0800643 pr_err("The device isn't a Human Interface Device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 return -ENODEV;
645 }
646
647 /* check out the endpoint: it has to be Interrupt & IN */
648 endpoint = &iface_desc->endpoint[0].desc;
649
Julia Lawall2855d282008-12-29 11:23:47 +0100650 if (!usb_endpoint_is_int_in(endpoint)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 /* we didn't find a Interrupt endpoint with direction IN */
Joe Perches27c766a2012-02-15 15:06:19 -0800652 pr_err("Couldn't find an INTR & IN endpoint\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 return -ENODEV;
654 }
655
656 /* get a handle to the interrupt data pipe */
657 pipe = usb_rcvintpipe(udev, endpoint->bEndpointAddress);
658 maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
659
660 /* allocate memory for our device and initialize it */
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000661 usb_pcwd = kzalloc(sizeof(struct usb_pcwd_private), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 if (usb_pcwd == NULL) {
Joe Perches27c766a2012-02-15 15:06:19 -0800663 pr_err("Out of memory\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 goto error;
665 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666
667 usb_pcwd_device = usb_pcwd;
668
Matthias Kaehlcke9f7afa62007-05-03 20:15:14 -0700669 mutex_init(&usb_pcwd->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 usb_pcwd->udev = udev;
671 usb_pcwd->interface = interface;
672 usb_pcwd->interface_number = iface_desc->desc.bInterfaceNumber;
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000673 usb_pcwd->intr_size = (le16_to_cpu(endpoint->wMaxPacketSize) > 8 ?
674 le16_to_cpu(endpoint->wMaxPacketSize) : 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675
676 /* set up the memory buffer's */
Daniel Mack997ea582010-04-12 13:17:25 +0200677 usb_pcwd->intr_buffer = usb_alloc_coherent(udev, usb_pcwd->intr_size,
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000678 GFP_ATOMIC, &usb_pcwd->intr_dma);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000679 if (!usb_pcwd->intr_buffer) {
Joe Perches27c766a2012-02-15 15:06:19 -0800680 pr_err("Out of memory\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 goto error;
682 }
683
684 /* allocate the urb's */
685 usb_pcwd->intr_urb = usb_alloc_urb(0, GFP_KERNEL);
686 if (!usb_pcwd->intr_urb) {
Joe Perches27c766a2012-02-15 15:06:19 -0800687 pr_err("Out of memory\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 goto error;
689 }
690
691 /* initialise the intr urb's */
692 usb_fill_int_urb(usb_pcwd->intr_urb, udev, pipe,
693 usb_pcwd->intr_buffer, usb_pcwd->intr_size,
694 usb_pcwd_intr_done, usb_pcwd, endpoint->bInterval);
695 usb_pcwd->intr_urb->transfer_dma = usb_pcwd->intr_dma;
696 usb_pcwd->intr_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
697
698 /* register our interrupt URB with the USB system */
699 if (usb_submit_urb(usb_pcwd->intr_urb, GFP_KERNEL)) {
Joe Perches27c766a2012-02-15 15:06:19 -0800700 pr_err("Problem registering interrupt URB\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 retval = -EIO; /* failure */
702 goto error;
703 }
704
705 /* The device exists and can be communicated with */
706 usb_pcwd->exists = 1;
707
708 /* disable card */
709 usb_pcwd_stop(usb_pcwd);
710
711 /* Get the Firmware Version */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000712 got_fw_rev = usb_pcwd_send_command(usb_pcwd, CMD_GET_FIRMWARE_VERSION,
713 &fw_rev_major, &fw_rev_minor);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000714 if (got_fw_rev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 sprintf(fw_ver_str, "%u.%02u", fw_rev_major, fw_rev_minor);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000716 else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 sprintf(fw_ver_str, "<card no answer>");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718
Joe Perches27c766a2012-02-15 15:06:19 -0800719 pr_info("Found card (Firmware: %s) with temp option\n", fw_ver_str);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720
721 /* Get switch settings */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000722 usb_pcwd_send_command(usb_pcwd, CMD_GET_DIP_SWITCH_SETTINGS, &dummy,
723 &option_switches);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724
Joe Perches27c766a2012-02-15 15:06:19 -0800725 pr_info("Option switches (0x%02x): Temperature Reset Enable=%s, Power On Delay=%s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 option_switches,
727 ((option_switches & 0x10) ? "ON" : "OFF"),
728 ((option_switches & 0x08) ? "ON" : "OFF"));
729
Wim Van Sebroeck2ef473d2007-01-08 22:45:30 +0100730 /* If heartbeat = 0 then we use the heartbeat from the dip-switches */
731 if (heartbeat == 0)
732 heartbeat = heartbeat_tbl[(option_switches & 0x07)];
733
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000734 /* Check that the heartbeat value is within it's range ;
735 * if not reset to the default */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 if (usb_pcwd_set_heartbeat(usb_pcwd, heartbeat)) {
737 usb_pcwd_set_heartbeat(usb_pcwd, WATCHDOG_HEARTBEAT);
Joe Perches27c766a2012-02-15 15:06:19 -0800738 pr_info("heartbeat value must be 0<heartbeat<65536, using %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 WATCHDOG_HEARTBEAT);
740 }
741
742 retval = register_reboot_notifier(&usb_pcwd_notifier);
743 if (retval != 0) {
Joe Perches27c766a2012-02-15 15:06:19 -0800744 pr_err("cannot register reboot notifier (err=%d)\n", retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 goto error;
746 }
747
748 retval = misc_register(&usb_pcwd_temperature_miscdev);
749 if (retval != 0) {
Joe Perches27c766a2012-02-15 15:06:19 -0800750 pr_err("cannot register miscdev on minor=%d (err=%d)\n",
751 TEMP_MINOR, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 goto err_out_unregister_reboot;
753 }
754
755 retval = misc_register(&usb_pcwd_miscdev);
756 if (retval != 0) {
Joe Perches27c766a2012-02-15 15:06:19 -0800757 pr_err("cannot register miscdev on minor=%d (err=%d)\n",
758 WATCHDOG_MINOR, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 goto err_out_misc_deregister;
760 }
761
762 /* we can register the device now, as it is ready */
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000763 usb_set_intfdata(interface, usb_pcwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764
Joe Perches27c766a2012-02-15 15:06:19 -0800765 pr_info("initialized. heartbeat=%d sec (nowayout=%d)\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766 heartbeat, nowayout);
767
768 return 0;
769
770err_out_misc_deregister:
771 misc_deregister(&usb_pcwd_temperature_miscdev);
772err_out_unregister_reboot:
773 unregister_reboot_notifier(&usb_pcwd_notifier);
774error:
Adrian Bunkc9d1a0b2006-03-10 19:04:38 +0100775 if (usb_pcwd)
776 usb_pcwd_delete(usb_pcwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 usb_pcwd_device = NULL;
778 return retval;
779}
780
781
782/**
783 * usb_pcwd_disconnect
784 *
785 * Called by the usb core when the device is removed from the system.
786 *
787 * This routine guarantees that the driver will not submit any more urbs
788 * by clearing dev->udev.
789 */
790static void usb_pcwd_disconnect(struct usb_interface *interface)
791{
792 struct usb_pcwd_private *usb_pcwd;
793
794 /* prevent races with open() */
Ingo Molnar6f87f0d2006-03-23 03:00:27 -0800795 mutex_lock(&disconnect_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000797 usb_pcwd = usb_get_intfdata(interface);
798 usb_set_intfdata(interface, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799
Matthias Kaehlcke9f7afa62007-05-03 20:15:14 -0700800 mutex_lock(&usb_pcwd->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801
802 /* Stop the timer before we leave */
803 if (!nowayout)
804 usb_pcwd_stop(usb_pcwd);
805
806 /* We should now stop communicating with the USB PCWD device */
807 usb_pcwd->exists = 0;
808
809 /* Deregister */
810 misc_deregister(&usb_pcwd_miscdev);
811 misc_deregister(&usb_pcwd_temperature_miscdev);
812 unregister_reboot_notifier(&usb_pcwd_notifier);
813
Matthias Kaehlcke9f7afa62007-05-03 20:15:14 -0700814 mutex_unlock(&usb_pcwd->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815
816 /* Delete the USB PCWD device */
817 usb_pcwd_delete(usb_pcwd);
818
819 cards_found--;
820
Ingo Molnar6f87f0d2006-03-23 03:00:27 -0800821 mutex_unlock(&disconnect_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822
Joe Perches27c766a2012-02-15 15:06:19 -0800823 pr_info("USB PC Watchdog disconnected\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824}
825
Greg Kroah-Hartmanfe748482011-11-18 09:52:10 -0800826module_usb_driver(usb_pcwd_driver);