blob: b9e376c8e2e36afa6fa7c7f172470b77033627e8 [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 */
Jean Delvare487722c2013-10-21 17:38:49 +020035#include <linux/miscdevice.h> /* For struct miscdevice */
Wim Van Sebroeckd26d9092007-01-08 22:40:33 +010036#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
48/* Module and Version Information */
Wim Van Sebroeck2ef473d2007-01-08 22:45:30 +010049#define DRIVER_VERSION "1.02"
Linus Torvalds1da177e2005-04-16 15:20:36 -070050#define DRIVER_AUTHOR "Wim Van Sebroeck <wim@iguana.be>"
51#define DRIVER_DESC "Berkshire USB-PC Watchdog driver"
52#define DRIVER_LICENSE "GPL"
53#define DRIVER_NAME "pcwd_usb"
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
55MODULE_AUTHOR(DRIVER_AUTHOR);
56MODULE_DESCRIPTION(DRIVER_DESC);
57MODULE_LICENSE(DRIVER_LICENSE);
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +000059#define WATCHDOG_HEARTBEAT 0 /* default heartbeat =
60 delay-time from dip-switches */
Linus Torvalds1da177e2005-04-16 15:20:36 -070061static int heartbeat = WATCHDOG_HEARTBEAT;
62module_param(heartbeat, int, 0);
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +000063MODULE_PARM_DESC(heartbeat, "Watchdog heartbeat in seconds. "
64 "(0<heartbeat<65536 or 0=delay-time from dip-switches, default="
65 __MODULE_STRING(WATCHDOG_HEARTBEAT) ")");
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
Wim Van Sebroeck86a1e182012-03-05 16:51:11 +010067static bool nowayout = WATCHDOG_NOWAYOUT;
68module_param(nowayout, bool, 0);
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +000069MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default="
70 __MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
72/* The vendor and product id's for the USB-PC Watchdog card */
73#define USB_PCWD_VENDOR_ID 0x0c98
74#define USB_PCWD_PRODUCT_ID 0x1140
75
76/* table of devices that work with this driver */
Arvind Yadavcc53e1c2017-08-12 14:09:45 +053077static const struct usb_device_id usb_pcwd_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 { USB_DEVICE(USB_PCWD_VENDOR_ID, USB_PCWD_PRODUCT_ID) },
79 { } /* Terminating entry */
80};
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +000081MODULE_DEVICE_TABLE(usb, usb_pcwd_table);
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
83/* according to documentation max. time to process a command for the USB
84 * watchdog card is 100 or 200 ms, so we give it 250 ms to do it's job */
85#define USB_COMMAND_TIMEOUT 250
86
87/* Watchdog's internal commands */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +000088#define CMD_READ_TEMP 0x02 /* Read Temperature;
89 Re-trigger Watchdog */
Linus Torvalds1da177e2005-04-16 15:20:36 -070090#define CMD_TRIGGER CMD_READ_TEMP
91#define CMD_GET_STATUS 0x04 /* Get Status Information */
92#define CMD_GET_FIRMWARE_VERSION 0x08 /* Get Firmware Version */
93#define CMD_GET_DIP_SWITCH_SETTINGS 0x0c /* Get Dip Switch Settings */
94#define CMD_READ_WATCHDOG_TIMEOUT 0x18 /* Read Current Watchdog Time */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +000095#define CMD_WRITE_WATCHDOG_TIMEOUT 0x19 /* Write Current WatchdogTime */
Linus Torvalds1da177e2005-04-16 15:20:36 -070096#define CMD_ENABLE_WATCHDOG 0x30 /* Enable / Disable Watchdog */
97#define CMD_DISABLE_WATCHDOG CMD_ENABLE_WATCHDOG
98
Wim Van Sebroeck2ef473d2007-01-08 22:45:30 +010099/* Watchdog's Dip Switch heartbeat values */
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000100static const int heartbeat_tbl[] = {
Wim Van Sebroeck2ef473d2007-01-08 22:45:30 +0100101 5, /* OFF-OFF-OFF = 5 Sec */
102 10, /* OFF-OFF-ON = 10 Sec */
103 30, /* OFF-ON-OFF = 30 Sec */
104 60, /* OFF-ON-ON = 1 Min */
105 300, /* ON-OFF-OFF = 5 Min */
106 600, /* ON-OFF-ON = 10 Min */
107 1800, /* ON-ON-OFF = 30 Min */
108 3600, /* ON-ON-ON = 1 hour */
109};
110
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111/* We can only use 1 card due to the /dev/watchdog restriction */
112static int cards_found;
113
114/* some internal variables */
115static unsigned long is_active;
116static char expect_release;
117
118/* Structure to hold all of our device specific stuff */
119struct usb_pcwd_private {
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000120 /* save off the usb device pointer */
121 struct usb_device *udev;
122 /* the interface for this device */
123 struct usb_interface *interface;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000125 /* the interface number used for cmd's */
126 unsigned int interface_number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000128 /* the buffer to intr data */
129 unsigned char *intr_buffer;
130 /* the dma address for the intr buffer */
131 dma_addr_t intr_dma;
132 /* the size of the intr buffer */
133 size_t intr_size;
134 /* the urb used for the intr pipe */
135 struct urb *intr_urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000137 /* The command that is reported back */
138 unsigned char cmd_command;
139 /* The data MSB that is reported back */
140 unsigned char cmd_data_msb;
141 /* The data LSB that is reported back */
142 unsigned char cmd_data_lsb;
143 /* true if we received a report after a command */
144 atomic_t cmd_received;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000146 /* Wether or not the device exists */
147 int exists;
148 /* locks this structure */
149 struct mutex mtx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150};
151static struct usb_pcwd_private *usb_pcwd_device;
152
153/* prevent races between open() and disconnect() */
Ingo Molnar6f87f0d2006-03-23 03:00:27 -0800154static DEFINE_MUTEX(disconnect_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
156/* local function prototypes */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000157static int usb_pcwd_probe(struct usb_interface *interface,
158 const struct usb_device_id *id);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000159static void usb_pcwd_disconnect(struct usb_interface *interface);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
161/* usb specific object needed to register this driver with the usb subsystem */
162static struct usb_driver usb_pcwd_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 .name = DRIVER_NAME,
164 .probe = usb_pcwd_probe,
165 .disconnect = usb_pcwd_disconnect,
166 .id_table = usb_pcwd_table,
167};
168
169
David Howells7d12e782006-10-05 14:55:46 +0100170static void usb_pcwd_intr_done(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171{
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000172 struct usb_pcwd_private *usb_pcwd =
173 (struct usb_pcwd_private *)urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 unsigned char *data = usb_pcwd->intr_buffer;
Greg Kroah-Hartmand7e92f72013-12-19 15:44:10 -0800175 struct device *dev = &usb_pcwd->interface->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 int retval;
177
178 switch (urb->status) {
179 case 0: /* success */
180 break;
181 case -ECONNRESET: /* unlink */
182 case -ENOENT:
183 case -ESHUTDOWN:
184 /* this urb is terminated, clean up */
Greg Kroah-Hartmand7e92f72013-12-19 15:44:10 -0800185 dev_dbg(dev, "%s - urb shutting down with status: %d",
186 __func__, urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 return;
188 /* -EPIPE: should clear the halt */
189 default: /* error */
Greg Kroah-Hartmand7e92f72013-12-19 15:44:10 -0800190 dev_dbg(dev, "%s - nonzero urb status received: %d",
191 __func__, urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 goto resubmit;
193 }
194
Greg Kroah-Hartmand7e92f72013-12-19 15:44:10 -0800195 dev_dbg(dev, "received following data cmd=0x%02x msb=0x%02x lsb=0x%02x",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 data[0], data[1], data[2]);
197
198 usb_pcwd->cmd_command = data[0];
199 usb_pcwd->cmd_data_msb = data[1];
200 usb_pcwd->cmd_data_lsb = data[2];
201
202 /* notify anyone waiting that the cmd has finished */
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000203 atomic_set(&usb_pcwd->cmd_received, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
205resubmit:
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000206 retval = usb_submit_urb(urb, GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 if (retval)
Joe Perches27c766a2012-02-15 15:06:19 -0800208 pr_err("can't resubmit intr, usb_submit_urb failed with result %d\n",
209 retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210}
211
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000212static int usb_pcwd_send_command(struct usb_pcwd_private *usb_pcwd,
213 unsigned char cmd, unsigned char *msb, unsigned char *lsb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214{
215 int got_response, count;
Guenter Roeck5412df02013-10-14 09:29:34 -0700216 unsigned char *buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000218 /* We will not send any commands if the USB PCWD device does
219 * not exist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 if ((!usb_pcwd) || (!usb_pcwd->exists))
221 return -1;
222
Guenter Roeck5412df02013-10-14 09:29:34 -0700223 buf = kmalloc(6, GFP_KERNEL);
224 if (buf == NULL)
225 return 0;
226
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000227 /* The USB PC Watchdog uses a 6 byte report format.
228 * The board currently uses only 3 of the six bytes of the report. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 buf[0] = cmd; /* Byte 0 = CMD */
230 buf[1] = *msb; /* Byte 1 = Data MSB */
231 buf[2] = *lsb; /* Byte 2 = Data LSB */
232 buf[3] = buf[4] = buf[5] = 0; /* All other bytes not used */
233
Greg Kroah-Hartmand7e92f72013-12-19 15:44:10 -0800234 dev_dbg(&usb_pcwd->interface->dev,
235 "sending following data cmd=0x%02x msb=0x%02x lsb=0x%02x",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 buf[0], buf[1], buf[2]);
237
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000238 atomic_set(&usb_pcwd->cmd_received, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239
240 if (usb_control_msg(usb_pcwd->udev, usb_sndctrlpipe(usb_pcwd->udev, 0),
241 HID_REQ_SET_REPORT, HID_DT_REPORT,
Dan Carpenterab5bbdc2013-11-08 01:24:19 -0800242 0x0200, usb_pcwd->interface_number, buf, 6,
243 USB_COMMAND_TIMEOUT) != 6) {
Greg Kroah-Hartmand7e92f72013-12-19 15:44:10 -0800244 dev_dbg(&usb_pcwd->interface->dev,
245 "usb_pcwd_send_command: error in usb_control_msg for cmd 0x%x 0x%x 0x%x\n",
246 cmd, *msb, *lsb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 }
248 /* wait till the usb card processed the command,
249 * with a max. timeout of USB_COMMAND_TIMEOUT */
250 got_response = 0;
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000251 for (count = 0; (count < USB_COMMAND_TIMEOUT) && (!got_response);
252 count++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 mdelay(1);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000254 if (atomic_read(&usb_pcwd->cmd_received))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 got_response = 1;
256 }
257
258 if ((got_response) && (cmd == usb_pcwd->cmd_command)) {
259 /* read back response */
260 *msb = usb_pcwd->cmd_data_msb;
261 *lsb = usb_pcwd->cmd_data_lsb;
262 }
263
Guenter Roeck5412df02013-10-14 09:29:34 -0700264 kfree(buf);
265
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 return got_response;
267}
268
269static int usb_pcwd_start(struct usb_pcwd_private *usb_pcwd)
270{
271 unsigned char msb = 0x00;
272 unsigned char lsb = 0x00;
273 int retval;
274
275 /* Enable Watchdog */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000276 retval = usb_pcwd_send_command(usb_pcwd, CMD_ENABLE_WATCHDOG,
277 &msb, &lsb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
279 if ((retval == 0) || (lsb == 0)) {
Joe Perches27c766a2012-02-15 15:06:19 -0800280 pr_err("Card did not acknowledge enable attempt\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 return -1;
282 }
283
284 return 0;
285}
286
287static int usb_pcwd_stop(struct usb_pcwd_private *usb_pcwd)
288{
289 unsigned char msb = 0xA5;
290 unsigned char lsb = 0xC3;
291 int retval;
292
293 /* Disable Watchdog */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000294 retval = usb_pcwd_send_command(usb_pcwd, CMD_DISABLE_WATCHDOG,
295 &msb, &lsb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
297 if ((retval == 0) || (lsb != 0)) {
Joe Perches27c766a2012-02-15 15:06:19 -0800298 pr_err("Card did not acknowledge disable attempt\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 return -1;
300 }
301
302 return 0;
303}
304
305static int usb_pcwd_keepalive(struct usb_pcwd_private *usb_pcwd)
306{
307 unsigned char dummy;
308
309 /* Re-trigger Watchdog */
310 usb_pcwd_send_command(usb_pcwd, CMD_TRIGGER, &dummy, &dummy);
311
312 return 0;
313}
314
315static int usb_pcwd_set_heartbeat(struct usb_pcwd_private *usb_pcwd, int t)
316{
317 unsigned char msb = t / 256;
318 unsigned char lsb = t % 256;
319
320 if ((t < 0x0001) || (t > 0xFFFF))
321 return -EINVAL;
322
323 /* Write new heartbeat to watchdog */
324 usb_pcwd_send_command(usb_pcwd, CMD_WRITE_WATCHDOG_TIMEOUT, &msb, &lsb);
325
326 heartbeat = t;
327 return 0;
328}
329
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000330static int usb_pcwd_get_temperature(struct usb_pcwd_private *usb_pcwd,
331 int *temperature)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332{
333 unsigned char msb, lsb;
334
335 usb_pcwd_send_command(usb_pcwd, CMD_READ_TEMP, &msb, &lsb);
336
337 /*
338 * Convert celsius to fahrenheit, since this was
339 * the decided 'standard' for this return value.
340 */
341 *temperature = (lsb * 9 / 5) + 32;
342
343 return 0;
344}
345
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000346static int usb_pcwd_get_timeleft(struct usb_pcwd_private *usb_pcwd,
347 int *time_left)
Wim Van Sebroeck58b519f2006-05-21 12:48:44 +0200348{
349 unsigned char msb, lsb;
350
351 /* Read the time that's left before rebooting */
352 /* Note: if the board is not yet armed then we will read 0xFFFF */
353 usb_pcwd_send_command(usb_pcwd, CMD_READ_WATCHDOG_TIMEOUT, &msb, &lsb);
354
355 *time_left = (msb << 8) + lsb;
356
357 return 0;
358}
359
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360/*
361 * /dev/watchdog handling
362 */
363
364static ssize_t usb_pcwd_write(struct file *file, const char __user *data,
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000365 size_t len, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366{
367 /* See if we got the magic character 'V' and reload the timer */
368 if (len) {
369 if (!nowayout) {
370 size_t i;
371
372 /* note: just in case someone wrote the magic character
373 * five months ago... */
374 expect_release = 0;
375
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000376 /* scan to see whether or not we got the
377 * magic character */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 for (i = 0; i != len; i++) {
379 char c;
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000380 if (get_user(c, data + i))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 return -EFAULT;
382 if (c == 'V')
383 expect_release = 42;
384 }
385 }
386
387 /* someone wrote to us, we should reload the timer */
388 usb_pcwd_keepalive(usb_pcwd_device);
389 }
390 return len;
391}
392
Alan Coxc9488522008-07-03 23:51:32 -0700393static long usb_pcwd_ioctl(struct file *file, unsigned int cmd,
394 unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395{
396 void __user *argp = (void __user *)arg;
397 int __user *p = argp;
Wim Van Sebroeck42747d72009-12-26 18:55:22 +0000398 static const struct watchdog_info ident = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 .options = WDIOF_KEEPALIVEPING |
400 WDIOF_SETTIMEOUT |
401 WDIOF_MAGICCLOSE,
402 .firmware_version = 1,
403 .identity = DRIVER_NAME,
404 };
405
406 switch (cmd) {
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000407 case WDIOC_GETSUPPORT:
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000408 return copy_to_user(argp, &ident, sizeof(ident)) ? -EFAULT : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000410 case WDIOC_GETSTATUS:
411 case WDIOC_GETBOOTSTATUS:
412 return put_user(0, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000414 case WDIOC_GETTEMP:
415 {
416 int temperature;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000418 if (usb_pcwd_get_temperature(usb_pcwd_device, &temperature))
419 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000421 return put_user(temperature, p);
422 }
423
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000424 case WDIOC_SETOPTIONS:
425 {
426 int new_options, retval = -EINVAL;
427
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000428 if (get_user(new_options, p))
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000429 return -EFAULT;
430
431 if (new_options & WDIOS_DISABLECARD) {
432 usb_pcwd_stop(usb_pcwd_device);
433 retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 }
435
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000436 if (new_options & WDIOS_ENABLECARD) {
437 usb_pcwd_start(usb_pcwd_device);
438 retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 }
440
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000441 return retval;
442 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443
Wim Van Sebroeck0c06090c2008-07-18 11:41:17 +0000444 case WDIOC_KEEPALIVE:
445 usb_pcwd_keepalive(usb_pcwd_device);
446 return 0;
447
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000448 case WDIOC_SETTIMEOUT:
449 {
450 int new_heartbeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000452 if (get_user(new_heartbeat, p))
453 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000455 if (usb_pcwd_set_heartbeat(usb_pcwd_device, new_heartbeat))
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000456 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000458 usb_pcwd_keepalive(usb_pcwd_device);
459 /* Fall */
460 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000462 case WDIOC_GETTIMEOUT:
463 return put_user(heartbeat, p);
Wim Van Sebroeck58b519f2006-05-21 12:48:44 +0200464
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000465 case WDIOC_GETTIMELEFT:
466 {
467 int time_left;
Wim Van Sebroeck58b519f2006-05-21 12:48:44 +0200468
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000469 if (usb_pcwd_get_timeleft(usb_pcwd_device, &time_left))
470 return -EFAULT;
Wim Van Sebroeck58b519f2006-05-21 12:48:44 +0200471
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000472 return put_user(time_left, p);
473 }
474
475 default:
476 return -ENOTTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 }
478}
479
480static int usb_pcwd_open(struct inode *inode, struct file *file)
481{
482 /* /dev/watchdog can only be opened once */
483 if (test_and_set_bit(0, &is_active))
484 return -EBUSY;
485
486 /* Activate */
487 usb_pcwd_start(usb_pcwd_device);
488 usb_pcwd_keepalive(usb_pcwd_device);
489 return nonseekable_open(inode, file);
490}
491
492static int usb_pcwd_release(struct inode *inode, struct file *file)
493{
494 /*
495 * Shut off the timer.
496 */
497 if (expect_release == 42) {
498 usb_pcwd_stop(usb_pcwd_device);
499 } else {
Joe Perches27c766a2012-02-15 15:06:19 -0800500 pr_crit("Unexpected close, not stopping watchdog!\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 usb_pcwd_keepalive(usb_pcwd_device);
502 }
503 expect_release = 0;
504 clear_bit(0, &is_active);
505 return 0;
506}
507
508/*
509 * /dev/temperature handling
510 */
511
512static ssize_t usb_pcwd_temperature_read(struct file *file, char __user *data,
513 size_t len, loff_t *ppos)
514{
515 int temperature;
516
517 if (usb_pcwd_get_temperature(usb_pcwd_device, &temperature))
518 return -EFAULT;
519
520 if (copy_to_user(data, &temperature, 1))
521 return -EFAULT;
522
523 return 1;
524}
525
526static int usb_pcwd_temperature_open(struct inode *inode, struct file *file)
527{
528 return nonseekable_open(inode, file);
529}
530
531static int usb_pcwd_temperature_release(struct inode *inode, struct file *file)
532{
533 return 0;
534}
535
536/*
537 * Notify system
538 */
539
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000540static int usb_pcwd_notify_sys(struct notifier_block *this, unsigned long code,
541 void *unused)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542{
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000543 if (code == SYS_DOWN || code == SYS_HALT)
544 usb_pcwd_stop(usb_pcwd_device); /* Turn the WDT off */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
546 return NOTIFY_DONE;
547}
548
549/*
550 * Kernel Interfaces
551 */
552
Arjan van de Ven62322d22006-07-03 00:24:21 -0700553static const struct file_operations usb_pcwd_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 .owner = THIS_MODULE,
555 .llseek = no_llseek,
556 .write = usb_pcwd_write,
Alan Coxc9488522008-07-03 23:51:32 -0700557 .unlocked_ioctl = usb_pcwd_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 .open = usb_pcwd_open,
559 .release = usb_pcwd_release,
560};
561
562static struct miscdevice usb_pcwd_miscdev = {
563 .minor = WATCHDOG_MINOR,
564 .name = "watchdog",
565 .fops = &usb_pcwd_fops,
566};
567
Arjan van de Ven62322d22006-07-03 00:24:21 -0700568static const struct file_operations usb_pcwd_temperature_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 .owner = THIS_MODULE,
570 .llseek = no_llseek,
571 .read = usb_pcwd_temperature_read,
572 .open = usb_pcwd_temperature_open,
573 .release = usb_pcwd_temperature_release,
574};
575
576static struct miscdevice usb_pcwd_temperature_miscdev = {
577 .minor = TEMP_MINOR,
578 .name = "temperature",
579 .fops = &usb_pcwd_temperature_fops,
580};
581
582static struct notifier_block usb_pcwd_notifier = {
583 .notifier_call = usb_pcwd_notify_sys,
584};
585
586/**
587 * usb_pcwd_delete
588 */
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000589static inline void usb_pcwd_delete(struct usb_pcwd_private *usb_pcwd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590{
Mariusz Kozlowski6265d622006-11-08 15:34:02 +0100591 usb_free_urb(usb_pcwd->intr_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 if (usb_pcwd->intr_buffer != NULL)
Daniel Mack997ea582010-04-12 13:17:25 +0200593 usb_free_coherent(usb_pcwd->udev, usb_pcwd->intr_size,
594 usb_pcwd->intr_buffer, usb_pcwd->intr_dma);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000595 kfree(usb_pcwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596}
597
598/**
599 * usb_pcwd_probe
600 *
601 * Called by the usb core when a new device is connected that it thinks
602 * this driver might be interested in.
603 */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000604static int usb_pcwd_probe(struct usb_interface *interface,
605 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606{
607 struct usb_device *udev = interface_to_usbdev(interface);
608 struct usb_host_interface *iface_desc;
609 struct usb_endpoint_descriptor *endpoint;
610 struct usb_pcwd_private *usb_pcwd = NULL;
Tomas Winkler99f08ca2016-01-19 15:51:04 +0200611 int pipe;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 int retval = -ENOMEM;
613 int got_fw_rev;
614 unsigned char fw_rev_major, fw_rev_minor;
615 char fw_ver_str[20];
616 unsigned char option_switches, dummy;
617
618 cards_found++;
619 if (cards_found > 1) {
Joe Perches27c766a2012-02-15 15:06:19 -0800620 pr_err("This driver only supports 1 device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 return -ENODEV;
622 }
623
624 /* get the active interface descriptor */
625 iface_desc = interface->cur_altsetting;
626
627 /* check out that we have a HID device */
628 if (!(iface_desc->desc.bInterfaceClass == USB_CLASS_HID)) {
Joe Perches27c766a2012-02-15 15:06:19 -0800629 pr_err("The device isn't a Human Interface Device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 return -ENODEV;
631 }
632
Johan Hovold46c319b2017-03-13 13:49:45 +0100633 if (iface_desc->desc.bNumEndpoints < 1)
634 return -ENODEV;
635
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 /* check out the endpoint: it has to be Interrupt & IN */
637 endpoint = &iface_desc->endpoint[0].desc;
638
Julia Lawall2855d282008-12-29 11:23:47 +0100639 if (!usb_endpoint_is_int_in(endpoint)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 /* we didn't find a Interrupt endpoint with direction IN */
Joe Perches27c766a2012-02-15 15:06:19 -0800641 pr_err("Couldn't find an INTR & IN endpoint\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 return -ENODEV;
643 }
644
645 /* get a handle to the interrupt data pipe */
646 pipe = usb_rcvintpipe(udev, endpoint->bEndpointAddress);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647
648 /* allocate memory for our device and initialize it */
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000649 usb_pcwd = kzalloc(sizeof(struct usb_pcwd_private), GFP_KERNEL);
Jingoo Han8deea832014-02-11 15:46:43 +0900650 if (usb_pcwd == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
653 usb_pcwd_device = usb_pcwd;
654
Matthias Kaehlcke9f7afa62007-05-03 20:15:14 -0700655 mutex_init(&usb_pcwd->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 usb_pcwd->udev = udev;
657 usb_pcwd->interface = interface;
658 usb_pcwd->interface_number = iface_desc->desc.bInterfaceNumber;
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000659 usb_pcwd->intr_size = (le16_to_cpu(endpoint->wMaxPacketSize) > 8 ?
660 le16_to_cpu(endpoint->wMaxPacketSize) : 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661
662 /* set up the memory buffer's */
Daniel Mack997ea582010-04-12 13:17:25 +0200663 usb_pcwd->intr_buffer = usb_alloc_coherent(udev, usb_pcwd->intr_size,
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000664 GFP_ATOMIC, &usb_pcwd->intr_dma);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000665 if (!usb_pcwd->intr_buffer) {
Joe Perches27c766a2012-02-15 15:06:19 -0800666 pr_err("Out of memory\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 goto error;
668 }
669
670 /* allocate the urb's */
671 usb_pcwd->intr_urb = usb_alloc_urb(0, GFP_KERNEL);
Wolfram Sang78a4a0d2016-08-11 23:23:40 +0200672 if (!usb_pcwd->intr_urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674
675 /* initialise the intr urb's */
676 usb_fill_int_urb(usb_pcwd->intr_urb, udev, pipe,
677 usb_pcwd->intr_buffer, usb_pcwd->intr_size,
678 usb_pcwd_intr_done, usb_pcwd, endpoint->bInterval);
679 usb_pcwd->intr_urb->transfer_dma = usb_pcwd->intr_dma;
680 usb_pcwd->intr_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
681
682 /* register our interrupt URB with the USB system */
683 if (usb_submit_urb(usb_pcwd->intr_urb, GFP_KERNEL)) {
Joe Perches27c766a2012-02-15 15:06:19 -0800684 pr_err("Problem registering interrupt URB\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 retval = -EIO; /* failure */
686 goto error;
687 }
688
689 /* The device exists and can be communicated with */
690 usb_pcwd->exists = 1;
691
692 /* disable card */
693 usb_pcwd_stop(usb_pcwd);
694
695 /* Get the Firmware Version */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000696 got_fw_rev = usb_pcwd_send_command(usb_pcwd, CMD_GET_FIRMWARE_VERSION,
697 &fw_rev_major, &fw_rev_minor);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000698 if (got_fw_rev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 sprintf(fw_ver_str, "%u.%02u", fw_rev_major, fw_rev_minor);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000700 else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 sprintf(fw_ver_str, "<card no answer>");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702
Joe Perches27c766a2012-02-15 15:06:19 -0800703 pr_info("Found card (Firmware: %s) with temp option\n", fw_ver_str);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704
705 /* Get switch settings */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000706 usb_pcwd_send_command(usb_pcwd, CMD_GET_DIP_SWITCH_SETTINGS, &dummy,
707 &option_switches);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708
Joe Perches27c766a2012-02-15 15:06:19 -0800709 pr_info("Option switches (0x%02x): Temperature Reset Enable=%s, Power On Delay=%s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 option_switches,
711 ((option_switches & 0x10) ? "ON" : "OFF"),
712 ((option_switches & 0x08) ? "ON" : "OFF"));
713
Wim Van Sebroeck2ef473d2007-01-08 22:45:30 +0100714 /* If heartbeat = 0 then we use the heartbeat from the dip-switches */
715 if (heartbeat == 0)
716 heartbeat = heartbeat_tbl[(option_switches & 0x07)];
717
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000718 /* Check that the heartbeat value is within it's range ;
719 * if not reset to the default */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 if (usb_pcwd_set_heartbeat(usb_pcwd, heartbeat)) {
721 usb_pcwd_set_heartbeat(usb_pcwd, WATCHDOG_HEARTBEAT);
Joe Perches27c766a2012-02-15 15:06:19 -0800722 pr_info("heartbeat value must be 0<heartbeat<65536, using %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 WATCHDOG_HEARTBEAT);
724 }
725
726 retval = register_reboot_notifier(&usb_pcwd_notifier);
727 if (retval != 0) {
Joe Perches27c766a2012-02-15 15:06:19 -0800728 pr_err("cannot register reboot notifier (err=%d)\n", retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 goto error;
730 }
731
732 retval = misc_register(&usb_pcwd_temperature_miscdev);
733 if (retval != 0) {
Joe Perches27c766a2012-02-15 15:06:19 -0800734 pr_err("cannot register miscdev on minor=%d (err=%d)\n",
735 TEMP_MINOR, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 goto err_out_unregister_reboot;
737 }
738
739 retval = misc_register(&usb_pcwd_miscdev);
740 if (retval != 0) {
Joe Perches27c766a2012-02-15 15:06:19 -0800741 pr_err("cannot register miscdev on minor=%d (err=%d)\n",
742 WATCHDOG_MINOR, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 goto err_out_misc_deregister;
744 }
745
746 /* we can register the device now, as it is ready */
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000747 usb_set_intfdata(interface, usb_pcwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
Joe Perches27c766a2012-02-15 15:06:19 -0800749 pr_info("initialized. heartbeat=%d sec (nowayout=%d)\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 heartbeat, nowayout);
751
752 return 0;
753
754err_out_misc_deregister:
755 misc_deregister(&usb_pcwd_temperature_miscdev);
756err_out_unregister_reboot:
757 unregister_reboot_notifier(&usb_pcwd_notifier);
758error:
Adrian Bunkc9d1a0b2006-03-10 19:04:38 +0100759 if (usb_pcwd)
760 usb_pcwd_delete(usb_pcwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 usb_pcwd_device = NULL;
762 return retval;
763}
764
765
766/**
767 * usb_pcwd_disconnect
768 *
769 * Called by the usb core when the device is removed from the system.
770 *
771 * This routine guarantees that the driver will not submit any more urbs
772 * by clearing dev->udev.
773 */
774static void usb_pcwd_disconnect(struct usb_interface *interface)
775{
776 struct usb_pcwd_private *usb_pcwd;
777
778 /* prevent races with open() */
Ingo Molnar6f87f0d2006-03-23 03:00:27 -0800779 mutex_lock(&disconnect_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000781 usb_pcwd = usb_get_intfdata(interface);
782 usb_set_intfdata(interface, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783
Matthias Kaehlcke9f7afa62007-05-03 20:15:14 -0700784 mutex_lock(&usb_pcwd->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785
786 /* Stop the timer before we leave */
787 if (!nowayout)
788 usb_pcwd_stop(usb_pcwd);
789
790 /* We should now stop communicating with the USB PCWD device */
791 usb_pcwd->exists = 0;
792
793 /* Deregister */
794 misc_deregister(&usb_pcwd_miscdev);
795 misc_deregister(&usb_pcwd_temperature_miscdev);
796 unregister_reboot_notifier(&usb_pcwd_notifier);
797
Matthias Kaehlcke9f7afa62007-05-03 20:15:14 -0700798 mutex_unlock(&usb_pcwd->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799
800 /* Delete the USB PCWD device */
801 usb_pcwd_delete(usb_pcwd);
802
803 cards_found--;
804
Ingo Molnar6f87f0d2006-03-23 03:00:27 -0800805 mutex_unlock(&disconnect_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806
Joe Perches27c766a2012-02-15 15:06:19 -0800807 pr_info("USB PC Watchdog disconnected\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808}
809
Greg Kroah-Hartmanfe748482011-11-18 09:52:10 -0800810module_usb_driver(usb_pcwd_driver);