blob: 4d02f26156f9ce10f03993d8dd88b79b4715f848 [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"
Linus Torvalds1da177e2005-04-16 15:20:36 -070052#define DRIVER_NAME "pcwd_usb"
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
54MODULE_AUTHOR(DRIVER_AUTHOR);
55MODULE_DESCRIPTION(DRIVER_DESC);
Greg Kroah-Hartmanbf020972017-11-17 15:22:03 +010056MODULE_LICENSE("GPL");
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +000058#define WATCHDOG_HEARTBEAT 0 /* default heartbeat =
59 delay-time from dip-switches */
Linus Torvalds1da177e2005-04-16 15:20:36 -070060static int heartbeat = WATCHDOG_HEARTBEAT;
61module_param(heartbeat, int, 0);
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +000062MODULE_PARM_DESC(heartbeat, "Watchdog heartbeat in seconds. "
63 "(0<heartbeat<65536 or 0=delay-time from dip-switches, default="
64 __MODULE_STRING(WATCHDOG_HEARTBEAT) ")");
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
Wim Van Sebroeck86a1e182012-03-05 16:51:11 +010066static bool nowayout = WATCHDOG_NOWAYOUT;
67module_param(nowayout, bool, 0);
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +000068MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default="
69 __MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
Linus Torvalds1da177e2005-04-16 15:20:36 -070070
71/* The vendor and product id's for the USB-PC Watchdog card */
72#define USB_PCWD_VENDOR_ID 0x0c98
73#define USB_PCWD_PRODUCT_ID 0x1140
74
75/* table of devices that work with this driver */
Arvind Yadavcc53e1c2017-08-12 14:09:45 +053076static const struct usb_device_id usb_pcwd_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 { USB_DEVICE(USB_PCWD_VENDOR_ID, USB_PCWD_PRODUCT_ID) },
78 { } /* Terminating entry */
79};
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +000080MODULE_DEVICE_TABLE(usb, usb_pcwd_table);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
82/* according to documentation max. time to process a command for the USB
83 * watchdog card is 100 or 200 ms, so we give it 250 ms to do it's job */
84#define USB_COMMAND_TIMEOUT 250
85
86/* Watchdog's internal commands */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +000087#define CMD_READ_TEMP 0x02 /* Read Temperature;
88 Re-trigger Watchdog */
Linus Torvalds1da177e2005-04-16 15:20:36 -070089#define CMD_TRIGGER CMD_READ_TEMP
90#define CMD_GET_STATUS 0x04 /* Get Status Information */
91#define CMD_GET_FIRMWARE_VERSION 0x08 /* Get Firmware Version */
92#define CMD_GET_DIP_SWITCH_SETTINGS 0x0c /* Get Dip Switch Settings */
93#define CMD_READ_WATCHDOG_TIMEOUT 0x18 /* Read Current Watchdog Time */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +000094#define CMD_WRITE_WATCHDOG_TIMEOUT 0x19 /* Write Current WatchdogTime */
Linus Torvalds1da177e2005-04-16 15:20:36 -070095#define CMD_ENABLE_WATCHDOG 0x30 /* Enable / Disable Watchdog */
96#define CMD_DISABLE_WATCHDOG CMD_ENABLE_WATCHDOG
97
Wim Van Sebroeck2ef473d2007-01-08 22:45:30 +010098/* Watchdog's Dip Switch heartbeat values */
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +000099static const int heartbeat_tbl[] = {
Wim Van Sebroeck2ef473d2007-01-08 22:45:30 +0100100 5, /* OFF-OFF-OFF = 5 Sec */
101 10, /* OFF-OFF-ON = 10 Sec */
102 30, /* OFF-ON-OFF = 30 Sec */
103 60, /* OFF-ON-ON = 1 Min */
104 300, /* ON-OFF-OFF = 5 Min */
105 600, /* ON-OFF-ON = 10 Min */
106 1800, /* ON-ON-OFF = 30 Min */
107 3600, /* ON-ON-ON = 1 hour */
108};
109
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110/* We can only use 1 card due to the /dev/watchdog restriction */
111static int cards_found;
112
113/* some internal variables */
114static unsigned long is_active;
115static char expect_release;
116
117/* Structure to hold all of our device specific stuff */
118struct usb_pcwd_private {
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000119 /* save off the usb device pointer */
120 struct usb_device *udev;
121 /* the interface for this device */
122 struct usb_interface *interface;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000124 /* the interface number used for cmd's */
125 unsigned int interface_number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000127 /* the buffer to intr data */
128 unsigned char *intr_buffer;
129 /* the dma address for the intr buffer */
130 dma_addr_t intr_dma;
131 /* the size of the intr buffer */
132 size_t intr_size;
133 /* the urb used for the intr pipe */
134 struct urb *intr_urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000136 /* The command that is reported back */
137 unsigned char cmd_command;
138 /* The data MSB that is reported back */
139 unsigned char cmd_data_msb;
140 /* The data LSB that is reported back */
141 unsigned char cmd_data_lsb;
142 /* true if we received a report after a command */
143 atomic_t cmd_received;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000145 /* Wether or not the device exists */
146 int exists;
147 /* locks this structure */
148 struct mutex mtx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149};
150static struct usb_pcwd_private *usb_pcwd_device;
151
152/* prevent races between open() and disconnect() */
Ingo Molnar6f87f0d2006-03-23 03:00:27 -0800153static DEFINE_MUTEX(disconnect_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
155/* local function prototypes */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000156static int usb_pcwd_probe(struct usb_interface *interface,
157 const struct usb_device_id *id);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000158static void usb_pcwd_disconnect(struct usb_interface *interface);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
160/* usb specific object needed to register this driver with the usb subsystem */
161static struct usb_driver usb_pcwd_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 .name = DRIVER_NAME,
163 .probe = usb_pcwd_probe,
164 .disconnect = usb_pcwd_disconnect,
165 .id_table = usb_pcwd_table,
166};
167
168
David Howells7d12e782006-10-05 14:55:46 +0100169static void usb_pcwd_intr_done(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170{
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000171 struct usb_pcwd_private *usb_pcwd =
172 (struct usb_pcwd_private *)urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 unsigned char *data = usb_pcwd->intr_buffer;
Greg Kroah-Hartmand7e92f72013-12-19 15:44:10 -0800174 struct device *dev = &usb_pcwd->interface->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 int retval;
176
177 switch (urb->status) {
178 case 0: /* success */
179 break;
180 case -ECONNRESET: /* unlink */
181 case -ENOENT:
182 case -ESHUTDOWN:
183 /* this urb is terminated, clean up */
Greg Kroah-Hartmand7e92f72013-12-19 15:44:10 -0800184 dev_dbg(dev, "%s - urb shutting down with status: %d",
185 __func__, urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 return;
187 /* -EPIPE: should clear the halt */
188 default: /* error */
Greg Kroah-Hartmand7e92f72013-12-19 15:44:10 -0800189 dev_dbg(dev, "%s - nonzero urb status received: %d",
190 __func__, urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 goto resubmit;
192 }
193
Greg Kroah-Hartmand7e92f72013-12-19 15:44:10 -0800194 dev_dbg(dev, "received following data cmd=0x%02x msb=0x%02x lsb=0x%02x",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 data[0], data[1], data[2]);
196
197 usb_pcwd->cmd_command = data[0];
198 usb_pcwd->cmd_data_msb = data[1];
199 usb_pcwd->cmd_data_lsb = data[2];
200
201 /* notify anyone waiting that the cmd has finished */
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000202 atomic_set(&usb_pcwd->cmd_received, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
204resubmit:
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000205 retval = usb_submit_urb(urb, GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 if (retval)
Joe Perches27c766a2012-02-15 15:06:19 -0800207 pr_err("can't resubmit intr, usb_submit_urb failed with result %d\n",
208 retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209}
210
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000211static int usb_pcwd_send_command(struct usb_pcwd_private *usb_pcwd,
212 unsigned char cmd, unsigned char *msb, unsigned char *lsb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213{
214 int got_response, count;
Guenter Roeck5412df02013-10-14 09:29:34 -0700215 unsigned char *buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000217 /* We will not send any commands if the USB PCWD device does
218 * not exist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 if ((!usb_pcwd) || (!usb_pcwd->exists))
220 return -1;
221
Guenter Roeck5412df02013-10-14 09:29:34 -0700222 buf = kmalloc(6, GFP_KERNEL);
223 if (buf == NULL)
224 return 0;
225
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000226 /* The USB PC Watchdog uses a 6 byte report format.
227 * The board currently uses only 3 of the six bytes of the report. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 buf[0] = cmd; /* Byte 0 = CMD */
229 buf[1] = *msb; /* Byte 1 = Data MSB */
230 buf[2] = *lsb; /* Byte 2 = Data LSB */
231 buf[3] = buf[4] = buf[5] = 0; /* All other bytes not used */
232
Greg Kroah-Hartmand7e92f72013-12-19 15:44:10 -0800233 dev_dbg(&usb_pcwd->interface->dev,
234 "sending following data cmd=0x%02x msb=0x%02x lsb=0x%02x",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 buf[0], buf[1], buf[2]);
236
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000237 atomic_set(&usb_pcwd->cmd_received, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238
239 if (usb_control_msg(usb_pcwd->udev, usb_sndctrlpipe(usb_pcwd->udev, 0),
240 HID_REQ_SET_REPORT, HID_DT_REPORT,
Dan Carpenterab5bbdc2013-11-08 01:24:19 -0800241 0x0200, usb_pcwd->interface_number, buf, 6,
242 USB_COMMAND_TIMEOUT) != 6) {
Greg Kroah-Hartmand7e92f72013-12-19 15:44:10 -0800243 dev_dbg(&usb_pcwd->interface->dev,
244 "usb_pcwd_send_command: error in usb_control_msg for cmd 0x%x 0x%x 0x%x\n",
245 cmd, *msb, *lsb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 }
247 /* wait till the usb card processed the command,
248 * with a max. timeout of USB_COMMAND_TIMEOUT */
249 got_response = 0;
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000250 for (count = 0; (count < USB_COMMAND_TIMEOUT) && (!got_response);
251 count++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 mdelay(1);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000253 if (atomic_read(&usb_pcwd->cmd_received))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 got_response = 1;
255 }
256
257 if ((got_response) && (cmd == usb_pcwd->cmd_command)) {
258 /* read back response */
259 *msb = usb_pcwd->cmd_data_msb;
260 *lsb = usb_pcwd->cmd_data_lsb;
261 }
262
Guenter Roeck5412df02013-10-14 09:29:34 -0700263 kfree(buf);
264
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 return got_response;
266}
267
268static int usb_pcwd_start(struct usb_pcwd_private *usb_pcwd)
269{
270 unsigned char msb = 0x00;
271 unsigned char lsb = 0x00;
272 int retval;
273
274 /* Enable Watchdog */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000275 retval = usb_pcwd_send_command(usb_pcwd, CMD_ENABLE_WATCHDOG,
276 &msb, &lsb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
278 if ((retval == 0) || (lsb == 0)) {
Joe Perches27c766a2012-02-15 15:06:19 -0800279 pr_err("Card did not acknowledge enable attempt\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 return -1;
281 }
282
283 return 0;
284}
285
286static int usb_pcwd_stop(struct usb_pcwd_private *usb_pcwd)
287{
288 unsigned char msb = 0xA5;
289 unsigned char lsb = 0xC3;
290 int retval;
291
292 /* Disable Watchdog */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000293 retval = usb_pcwd_send_command(usb_pcwd, CMD_DISABLE_WATCHDOG,
294 &msb, &lsb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
296 if ((retval == 0) || (lsb != 0)) {
Joe Perches27c766a2012-02-15 15:06:19 -0800297 pr_err("Card did not acknowledge disable attempt\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 return -1;
299 }
300
301 return 0;
302}
303
304static int usb_pcwd_keepalive(struct usb_pcwd_private *usb_pcwd)
305{
306 unsigned char dummy;
307
308 /* Re-trigger Watchdog */
309 usb_pcwd_send_command(usb_pcwd, CMD_TRIGGER, &dummy, &dummy);
310
311 return 0;
312}
313
314static int usb_pcwd_set_heartbeat(struct usb_pcwd_private *usb_pcwd, int t)
315{
316 unsigned char msb = t / 256;
317 unsigned char lsb = t % 256;
318
319 if ((t < 0x0001) || (t > 0xFFFF))
320 return -EINVAL;
321
322 /* Write new heartbeat to watchdog */
323 usb_pcwd_send_command(usb_pcwd, CMD_WRITE_WATCHDOG_TIMEOUT, &msb, &lsb);
324
325 heartbeat = t;
326 return 0;
327}
328
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000329static int usb_pcwd_get_temperature(struct usb_pcwd_private *usb_pcwd,
330 int *temperature)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331{
332 unsigned char msb, lsb;
333
334 usb_pcwd_send_command(usb_pcwd, CMD_READ_TEMP, &msb, &lsb);
335
336 /*
337 * Convert celsius to fahrenheit, since this was
338 * the decided 'standard' for this return value.
339 */
340 *temperature = (lsb * 9 / 5) + 32;
341
342 return 0;
343}
344
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000345static int usb_pcwd_get_timeleft(struct usb_pcwd_private *usb_pcwd,
346 int *time_left)
Wim Van Sebroeck58b519f2006-05-21 12:48:44 +0200347{
348 unsigned char msb, lsb;
349
350 /* Read the time that's left before rebooting */
351 /* Note: if the board is not yet armed then we will read 0xFFFF */
352 usb_pcwd_send_command(usb_pcwd, CMD_READ_WATCHDOG_TIMEOUT, &msb, &lsb);
353
354 *time_left = (msb << 8) + lsb;
355
356 return 0;
357}
358
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359/*
360 * /dev/watchdog handling
361 */
362
363static ssize_t usb_pcwd_write(struct file *file, const char __user *data,
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000364 size_t len, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365{
366 /* See if we got the magic character 'V' and reload the timer */
367 if (len) {
368 if (!nowayout) {
369 size_t i;
370
371 /* note: just in case someone wrote the magic character
372 * five months ago... */
373 expect_release = 0;
374
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000375 /* scan to see whether or not we got the
376 * magic character */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 for (i = 0; i != len; i++) {
378 char c;
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000379 if (get_user(c, data + i))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 return -EFAULT;
381 if (c == 'V')
382 expect_release = 42;
383 }
384 }
385
386 /* someone wrote to us, we should reload the timer */
387 usb_pcwd_keepalive(usb_pcwd_device);
388 }
389 return len;
390}
391
Alan Coxc9488522008-07-03 23:51:32 -0700392static long usb_pcwd_ioctl(struct file *file, unsigned int cmd,
393 unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394{
395 void __user *argp = (void __user *)arg;
396 int __user *p = argp;
Wim Van Sebroeck42747d72009-12-26 18:55:22 +0000397 static const struct watchdog_info ident = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 .options = WDIOF_KEEPALIVEPING |
399 WDIOF_SETTIMEOUT |
400 WDIOF_MAGICCLOSE,
401 .firmware_version = 1,
402 .identity = DRIVER_NAME,
403 };
404
405 switch (cmd) {
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000406 case WDIOC_GETSUPPORT:
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000407 return copy_to_user(argp, &ident, sizeof(ident)) ? -EFAULT : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000409 case WDIOC_GETSTATUS:
410 case WDIOC_GETBOOTSTATUS:
411 return put_user(0, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000413 case WDIOC_GETTEMP:
414 {
415 int temperature;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000417 if (usb_pcwd_get_temperature(usb_pcwd_device, &temperature))
418 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000420 return put_user(temperature, p);
421 }
422
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000423 case WDIOC_SETOPTIONS:
424 {
425 int new_options, retval = -EINVAL;
426
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000427 if (get_user(new_options, p))
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000428 return -EFAULT;
429
430 if (new_options & WDIOS_DISABLECARD) {
431 usb_pcwd_stop(usb_pcwd_device);
432 retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 }
434
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000435 if (new_options & WDIOS_ENABLECARD) {
436 usb_pcwd_start(usb_pcwd_device);
437 retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 }
439
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000440 return retval;
441 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442
Wim Van Sebroeck0c060902008-07-18 11:41:17 +0000443 case WDIOC_KEEPALIVE:
444 usb_pcwd_keepalive(usb_pcwd_device);
445 return 0;
446
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000447 case WDIOC_SETTIMEOUT:
448 {
449 int new_heartbeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000451 if (get_user(new_heartbeat, p))
452 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000454 if (usb_pcwd_set_heartbeat(usb_pcwd_device, new_heartbeat))
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000455 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000457 usb_pcwd_keepalive(usb_pcwd_device);
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000458 }
Gustavo A. R. Silva3d002ea2017-11-03 09:53:41 -0500459 /* fall through */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000461 case WDIOC_GETTIMEOUT:
462 return put_user(heartbeat, p);
Wim Van Sebroeck58b519f2006-05-21 12:48:44 +0200463
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000464 case WDIOC_GETTIMELEFT:
465 {
466 int time_left;
Wim Van Sebroeck58b519f2006-05-21 12:48:44 +0200467
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000468 if (usb_pcwd_get_timeleft(usb_pcwd_device, &time_left))
469 return -EFAULT;
Wim Van Sebroeck58b519f2006-05-21 12:48:44 +0200470
Wim Van Sebroeck5eb82492008-07-17 18:08:47 +0000471 return put_user(time_left, p);
472 }
473
474 default:
475 return -ENOTTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 }
477}
478
479static int usb_pcwd_open(struct inode *inode, struct file *file)
480{
481 /* /dev/watchdog can only be opened once */
482 if (test_and_set_bit(0, &is_active))
483 return -EBUSY;
484
485 /* Activate */
486 usb_pcwd_start(usb_pcwd_device);
487 usb_pcwd_keepalive(usb_pcwd_device);
488 return nonseekable_open(inode, file);
489}
490
491static int usb_pcwd_release(struct inode *inode, struct file *file)
492{
493 /*
494 * Shut off the timer.
495 */
496 if (expect_release == 42) {
497 usb_pcwd_stop(usb_pcwd_device);
498 } else {
Joe Perches27c766a2012-02-15 15:06:19 -0800499 pr_crit("Unexpected close, not stopping watchdog!\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 usb_pcwd_keepalive(usb_pcwd_device);
501 }
502 expect_release = 0;
503 clear_bit(0, &is_active);
504 return 0;
505}
506
507/*
508 * /dev/temperature handling
509 */
510
511static ssize_t usb_pcwd_temperature_read(struct file *file, char __user *data,
512 size_t len, loff_t *ppos)
513{
514 int temperature;
515
516 if (usb_pcwd_get_temperature(usb_pcwd_device, &temperature))
517 return -EFAULT;
518
519 if (copy_to_user(data, &temperature, 1))
520 return -EFAULT;
521
522 return 1;
523}
524
525static int usb_pcwd_temperature_open(struct inode *inode, struct file *file)
526{
527 return nonseekable_open(inode, file);
528}
529
530static int usb_pcwd_temperature_release(struct inode *inode, struct file *file)
531{
532 return 0;
533}
534
535/*
536 * Notify system
537 */
538
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000539static int usb_pcwd_notify_sys(struct notifier_block *this, unsigned long code,
540 void *unused)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541{
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000542 if (code == SYS_DOWN || code == SYS_HALT)
543 usb_pcwd_stop(usb_pcwd_device); /* Turn the WDT off */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544
545 return NOTIFY_DONE;
546}
547
548/*
549 * Kernel Interfaces
550 */
551
Arjan van de Ven62322d22006-07-03 00:24:21 -0700552static const struct file_operations usb_pcwd_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 .owner = THIS_MODULE,
554 .llseek = no_llseek,
555 .write = usb_pcwd_write,
Alan Coxc9488522008-07-03 23:51:32 -0700556 .unlocked_ioctl = usb_pcwd_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 .open = usb_pcwd_open,
558 .release = usb_pcwd_release,
559};
560
561static struct miscdevice usb_pcwd_miscdev = {
562 .minor = WATCHDOG_MINOR,
563 .name = "watchdog",
564 .fops = &usb_pcwd_fops,
565};
566
Arjan van de Ven62322d22006-07-03 00:24:21 -0700567static const struct file_operations usb_pcwd_temperature_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 .owner = THIS_MODULE,
569 .llseek = no_llseek,
570 .read = usb_pcwd_temperature_read,
571 .open = usb_pcwd_temperature_open,
572 .release = usb_pcwd_temperature_release,
573};
574
575static struct miscdevice usb_pcwd_temperature_miscdev = {
576 .minor = TEMP_MINOR,
577 .name = "temperature",
578 .fops = &usb_pcwd_temperature_fops,
579};
580
581static struct notifier_block usb_pcwd_notifier = {
582 .notifier_call = usb_pcwd_notify_sys,
583};
584
585/**
586 * usb_pcwd_delete
587 */
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000588static inline void usb_pcwd_delete(struct usb_pcwd_private *usb_pcwd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589{
Mariusz Kozlowski6265d622006-11-08 15:34:02 +0100590 usb_free_urb(usb_pcwd->intr_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 if (usb_pcwd->intr_buffer != NULL)
Daniel Mack997ea582010-04-12 13:17:25 +0200592 usb_free_coherent(usb_pcwd->udev, usb_pcwd->intr_size,
593 usb_pcwd->intr_buffer, usb_pcwd->intr_dma);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000594 kfree(usb_pcwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595}
596
597/**
598 * usb_pcwd_probe
599 *
600 * Called by the usb core when a new device is connected that it thinks
601 * this driver might be interested in.
602 */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000603static int usb_pcwd_probe(struct usb_interface *interface,
604 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605{
606 struct usb_device *udev = interface_to_usbdev(interface);
607 struct usb_host_interface *iface_desc;
608 struct usb_endpoint_descriptor *endpoint;
609 struct usb_pcwd_private *usb_pcwd = NULL;
Tomas Winkler99f08ca2016-01-19 15:51:04 +0200610 int pipe;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 int retval = -ENOMEM;
612 int got_fw_rev;
613 unsigned char fw_rev_major, fw_rev_minor;
614 char fw_ver_str[20];
615 unsigned char option_switches, dummy;
616
617 cards_found++;
618 if (cards_found > 1) {
Joe Perches27c766a2012-02-15 15:06:19 -0800619 pr_err("This driver only supports 1 device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 return -ENODEV;
621 }
622
623 /* get the active interface descriptor */
624 iface_desc = interface->cur_altsetting;
625
626 /* check out that we have a HID device */
627 if (!(iface_desc->desc.bInterfaceClass == USB_CLASS_HID)) {
Joe Perches27c766a2012-02-15 15:06:19 -0800628 pr_err("The device isn't a Human Interface Device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 return -ENODEV;
630 }
631
Johan Hovold46c319b2017-03-13 13:49:45 +0100632 if (iface_desc->desc.bNumEndpoints < 1)
633 return -ENODEV;
634
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 /* check out the endpoint: it has to be Interrupt & IN */
636 endpoint = &iface_desc->endpoint[0].desc;
637
Julia Lawall2855d282008-12-29 11:23:47 +0100638 if (!usb_endpoint_is_int_in(endpoint)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 /* we didn't find a Interrupt endpoint with direction IN */
Joe Perches27c766a2012-02-15 15:06:19 -0800640 pr_err("Couldn't find an INTR & IN endpoint\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 return -ENODEV;
642 }
643
644 /* get a handle to the interrupt data pipe */
645 pipe = usb_rcvintpipe(udev, endpoint->bEndpointAddress);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646
647 /* allocate memory for our device and initialize it */
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000648 usb_pcwd = kzalloc(sizeof(struct usb_pcwd_private), GFP_KERNEL);
Jingoo Han8deea832014-02-11 15:46:43 +0900649 if (usb_pcwd == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651
652 usb_pcwd_device = usb_pcwd;
653
Matthias Kaehlcke9f7afa62007-05-03 20:15:14 -0700654 mutex_init(&usb_pcwd->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 usb_pcwd->udev = udev;
656 usb_pcwd->interface = interface;
657 usb_pcwd->interface_number = iface_desc->desc.bInterfaceNumber;
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000658 usb_pcwd->intr_size = (le16_to_cpu(endpoint->wMaxPacketSize) > 8 ?
659 le16_to_cpu(endpoint->wMaxPacketSize) : 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
661 /* set up the memory buffer's */
Daniel Mack997ea582010-04-12 13:17:25 +0200662 usb_pcwd->intr_buffer = usb_alloc_coherent(udev, usb_pcwd->intr_size,
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000663 GFP_ATOMIC, &usb_pcwd->intr_dma);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000664 if (!usb_pcwd->intr_buffer) {
Joe Perches27c766a2012-02-15 15:06:19 -0800665 pr_err("Out of memory\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 goto error;
667 }
668
669 /* allocate the urb's */
670 usb_pcwd->intr_urb = usb_alloc_urb(0, GFP_KERNEL);
Wolfram Sang78a4a0d2016-08-11 23:23:40 +0200671 if (!usb_pcwd->intr_urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673
674 /* initialise the intr urb's */
675 usb_fill_int_urb(usb_pcwd->intr_urb, udev, pipe,
676 usb_pcwd->intr_buffer, usb_pcwd->intr_size,
677 usb_pcwd_intr_done, usb_pcwd, endpoint->bInterval);
678 usb_pcwd->intr_urb->transfer_dma = usb_pcwd->intr_dma;
679 usb_pcwd->intr_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
680
681 /* register our interrupt URB with the USB system */
682 if (usb_submit_urb(usb_pcwd->intr_urb, GFP_KERNEL)) {
Joe Perches27c766a2012-02-15 15:06:19 -0800683 pr_err("Problem registering interrupt URB\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 retval = -EIO; /* failure */
685 goto error;
686 }
687
688 /* The device exists and can be communicated with */
689 usb_pcwd->exists = 1;
690
691 /* disable card */
692 usb_pcwd_stop(usb_pcwd);
693
694 /* Get the Firmware Version */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000695 got_fw_rev = usb_pcwd_send_command(usb_pcwd, CMD_GET_FIRMWARE_VERSION,
696 &fw_rev_major, &fw_rev_minor);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000697 if (got_fw_rev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 sprintf(fw_ver_str, "%u.%02u", fw_rev_major, fw_rev_minor);
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000699 else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 sprintf(fw_ver_str, "<card no answer>");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701
Joe Perches27c766a2012-02-15 15:06:19 -0800702 pr_info("Found card (Firmware: %s) with temp option\n", fw_ver_str);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703
704 /* Get switch settings */
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000705 usb_pcwd_send_command(usb_pcwd, CMD_GET_DIP_SWITCH_SETTINGS, &dummy,
706 &option_switches);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707
Joe Perches27c766a2012-02-15 15:06:19 -0800708 pr_info("Option switches (0x%02x): Temperature Reset Enable=%s, Power On Delay=%s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 option_switches,
710 ((option_switches & 0x10) ? "ON" : "OFF"),
711 ((option_switches & 0x08) ? "ON" : "OFF"));
712
Wim Van Sebroeck2ef473d2007-01-08 22:45:30 +0100713 /* If heartbeat = 0 then we use the heartbeat from the dip-switches */
714 if (heartbeat == 0)
715 heartbeat = heartbeat_tbl[(option_switches & 0x07)];
716
Wim Van Sebroeck143a2e52009-03-18 08:35:09 +0000717 /* Check that the heartbeat value is within it's range ;
718 * if not reset to the default */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 if (usb_pcwd_set_heartbeat(usb_pcwd, heartbeat)) {
720 usb_pcwd_set_heartbeat(usb_pcwd, WATCHDOG_HEARTBEAT);
Joe Perches27c766a2012-02-15 15:06:19 -0800721 pr_info("heartbeat value must be 0<heartbeat<65536, using %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 WATCHDOG_HEARTBEAT);
723 }
724
725 retval = register_reboot_notifier(&usb_pcwd_notifier);
726 if (retval != 0) {
Joe Perches27c766a2012-02-15 15:06:19 -0800727 pr_err("cannot register reboot notifier (err=%d)\n", retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 goto error;
729 }
730
731 retval = misc_register(&usb_pcwd_temperature_miscdev);
732 if (retval != 0) {
Joe Perches27c766a2012-02-15 15:06:19 -0800733 pr_err("cannot register miscdev on minor=%d (err=%d)\n",
734 TEMP_MINOR, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 goto err_out_unregister_reboot;
736 }
737
738 retval = misc_register(&usb_pcwd_miscdev);
739 if (retval != 0) {
Joe Perches27c766a2012-02-15 15:06:19 -0800740 pr_err("cannot register miscdev on minor=%d (err=%d)\n",
741 WATCHDOG_MINOR, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 goto err_out_misc_deregister;
743 }
744
745 /* we can register the device now, as it is ready */
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000746 usb_set_intfdata(interface, usb_pcwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747
Joe Perches27c766a2012-02-15 15:06:19 -0800748 pr_info("initialized. heartbeat=%d sec (nowayout=%d)\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 heartbeat, nowayout);
750
751 return 0;
752
753err_out_misc_deregister:
754 misc_deregister(&usb_pcwd_temperature_miscdev);
755err_out_unregister_reboot:
756 unregister_reboot_notifier(&usb_pcwd_notifier);
757error:
Adrian Bunkc9d1a0b2006-03-10 19:04:38 +0100758 if (usb_pcwd)
759 usb_pcwd_delete(usb_pcwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 usb_pcwd_device = NULL;
761 return retval;
762}
763
764
765/**
766 * usb_pcwd_disconnect
767 *
768 * Called by the usb core when the device is removed from the system.
769 *
770 * This routine guarantees that the driver will not submit any more urbs
771 * by clearing dev->udev.
772 */
773static void usb_pcwd_disconnect(struct usb_interface *interface)
774{
775 struct usb_pcwd_private *usb_pcwd;
776
777 /* prevent races with open() */
Ingo Molnar6f87f0d2006-03-23 03:00:27 -0800778 mutex_lock(&disconnect_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000780 usb_pcwd = usb_get_intfdata(interface);
781 usb_set_intfdata(interface, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782
Matthias Kaehlcke9f7afa62007-05-03 20:15:14 -0700783 mutex_lock(&usb_pcwd->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784
785 /* Stop the timer before we leave */
786 if (!nowayout)
787 usb_pcwd_stop(usb_pcwd);
788
789 /* We should now stop communicating with the USB PCWD device */
790 usb_pcwd->exists = 0;
791
792 /* Deregister */
793 misc_deregister(&usb_pcwd_miscdev);
794 misc_deregister(&usb_pcwd_temperature_miscdev);
795 unregister_reboot_notifier(&usb_pcwd_notifier);
796
Matthias Kaehlcke9f7afa62007-05-03 20:15:14 -0700797 mutex_unlock(&usb_pcwd->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
799 /* Delete the USB PCWD device */
800 usb_pcwd_delete(usb_pcwd);
801
802 cards_found--;
803
Ingo Molnar6f87f0d2006-03-23 03:00:27 -0800804 mutex_unlock(&disconnect_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805
Joe Perches27c766a2012-02-15 15:06:19 -0800806 pr_info("USB PC Watchdog disconnected\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807}
808
Greg Kroah-Hartmanfe748482011-11-18 09:52:10 -0800809module_usb_driver(usb_pcwd_driver);