xref: /openbmc/linux/drivers/watchdog/pcwd_usb.c (revision 5412df0bda90a2bdcef2771849ad5472b9ef8100)
1b7e04f8cSWim Van Sebroeck /*
2b7e04f8cSWim Van Sebroeck  *	Berkshire USB-PC Watchdog Card Driver
3b7e04f8cSWim Van Sebroeck  *
4b7e04f8cSWim Van Sebroeck  *	(c) Copyright 2004-2007 Wim Van Sebroeck <wim@iguana.be>.
5b7e04f8cSWim Van Sebroeck  *
6b7e04f8cSWim Van Sebroeck  *	Based on source code of the following authors:
7b7e04f8cSWim Van Sebroeck  *	  Ken Hollis <kenji@bitgate.com>,
829fa0586SAlan Cox  *	  Alan Cox <alan@lxorguk.ukuu.org.uk>,
9b7e04f8cSWim Van Sebroeck  *	  Matt Domsch <Matt_Domsch@dell.com>,
10b7e04f8cSWim Van Sebroeck  *	  Rob Radez <rob@osinvestor.com>,
11b7e04f8cSWim Van Sebroeck  *	  Greg Kroah-Hartman <greg@kroah.com>
12b7e04f8cSWim Van Sebroeck  *
13b7e04f8cSWim Van Sebroeck  *	This program is free software; you can redistribute it and/or
14b7e04f8cSWim Van Sebroeck  *	modify it under the terms of the GNU General Public License
15b7e04f8cSWim Van Sebroeck  *	as published by the Free Software Foundation; either version
16b7e04f8cSWim Van Sebroeck  *	2 of the License, or (at your option) any later version.
17b7e04f8cSWim Van Sebroeck  *
18b7e04f8cSWim Van Sebroeck  *	Neither Wim Van Sebroeck nor Iguana vzw. admit liability nor
19b7e04f8cSWim Van Sebroeck  *	provide warranty for any of this software. This material is
20b7e04f8cSWim Van Sebroeck  *	provided "AS-IS" and at no charge.
21b7e04f8cSWim Van Sebroeck  *
22b7e04f8cSWim Van Sebroeck  *	Thanks also to Simon Machell at Berkshire Products Inc. for
23b7e04f8cSWim Van Sebroeck  *	providing the test hardware. More info is available at
24b7e04f8cSWim Van Sebroeck  *	http://www.berkprod.com/ or http://www.pcwatchdog.com/
25b7e04f8cSWim Van Sebroeck  */
26b7e04f8cSWim Van Sebroeck 
2727c766aaSJoe Perches #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
2827c766aaSJoe Perches 
29b7e04f8cSWim Van Sebroeck #include <linux/module.h>	/* For module specific items */
30b7e04f8cSWim Van Sebroeck #include <linux/moduleparam.h>	/* For new moduleparam's */
31b7e04f8cSWim Van Sebroeck #include <linux/types.h>	/* For standard types (like size_t) */
32b7e04f8cSWim Van Sebroeck #include <linux/errno.h>	/* For the -ENODEV/... values */
33b7e04f8cSWim Van Sebroeck #include <linux/kernel.h>	/* For printk/panic/... */
34b7e04f8cSWim Van Sebroeck #include <linux/delay.h>	/* For mdelay function */
35b7e04f8cSWim Van Sebroeck #include <linux/miscdevice.h>	/* For MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR) */
36b7e04f8cSWim Van Sebroeck #include <linux/watchdog.h>	/* For the watchdog specific items */
37b7e04f8cSWim Van Sebroeck #include <linux/notifier.h>	/* For notifier support */
38b7e04f8cSWim Van Sebroeck #include <linux/reboot.h>	/* For reboot_notifier stuff */
39b7e04f8cSWim Van Sebroeck #include <linux/init.h>		/* For __init/__exit/... */
40b7e04f8cSWim Van Sebroeck #include <linux/fs.h>		/* For file operations */
41b7e04f8cSWim Van Sebroeck #include <linux/usb.h>		/* For USB functions */
42b7e04f8cSWim Van Sebroeck #include <linux/slab.h>		/* For kmalloc, ... */
43b7e04f8cSWim Van Sebroeck #include <linux/mutex.h>	/* For mutex locking */
44b7e04f8cSWim Van Sebroeck #include <linux/hid.h>		/* For HID_REQ_SET_REPORT & HID_DT_REPORT */
45089ab079SWim Van Sebroeck #include <linux/uaccess.h>	/* For copy_to_user/put_user/... */
46b7e04f8cSWim Van Sebroeck 
47b7e04f8cSWim Van Sebroeck #ifdef CONFIG_USB_DEBUG
48b7e04f8cSWim Van Sebroeck static int debug = 1;
49b7e04f8cSWim Van Sebroeck #else
50b7e04f8cSWim Van Sebroeck static int debug;
51b7e04f8cSWim Van Sebroeck #endif
52b7e04f8cSWim Van Sebroeck 
53b7e04f8cSWim Van Sebroeck /* Use our own dbg macro */
5427c766aaSJoe Perches 
55b7e04f8cSWim Van Sebroeck #undef dbg
5627c766aaSJoe Perches #ifndef DEBUG
5727c766aaSJoe Perches #define DEBUG
5827c766aaSJoe Perches #endif
5927c766aaSJoe Perches #define dbg(format, ...)				\
6027c766aaSJoe Perches do {							\
6127c766aaSJoe Perches 	if (debug)					\
6227c766aaSJoe Perches 		pr_debug(format "\n", ##__VA_ARGS__);	\
6327c766aaSJoe Perches } while (0)
64b7e04f8cSWim Van Sebroeck 
65b7e04f8cSWim Van Sebroeck /* Module and Version Information */
66b7e04f8cSWim Van Sebroeck #define DRIVER_VERSION "1.02"
67b7e04f8cSWim Van Sebroeck #define DRIVER_AUTHOR "Wim Van Sebroeck <wim@iguana.be>"
68b7e04f8cSWim Van Sebroeck #define DRIVER_DESC "Berkshire USB-PC Watchdog driver"
69b7e04f8cSWim Van Sebroeck #define DRIVER_LICENSE "GPL"
70b7e04f8cSWim Van Sebroeck #define DRIVER_NAME "pcwd_usb"
71b7e04f8cSWim Van Sebroeck 
72b7e04f8cSWim Van Sebroeck MODULE_AUTHOR(DRIVER_AUTHOR);
73b7e04f8cSWim Van Sebroeck MODULE_DESCRIPTION(DRIVER_DESC);
74b7e04f8cSWim Van Sebroeck MODULE_LICENSE(DRIVER_LICENSE);
75b7e04f8cSWim Van Sebroeck MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);
76b7e04f8cSWim Van Sebroeck MODULE_ALIAS_MISCDEV(TEMP_MINOR);
77b7e04f8cSWim Van Sebroeck 
78b7e04f8cSWim Van Sebroeck /* Module Parameters */
79b7e04f8cSWim Van Sebroeck module_param(debug, int, 0);
80b7e04f8cSWim Van Sebroeck MODULE_PARM_DESC(debug, "Debug enabled or not");
81b7e04f8cSWim Van Sebroeck 
82143a2e54SWim Van Sebroeck #define WATCHDOG_HEARTBEAT 0	/* default heartbeat =
83143a2e54SWim Van Sebroeck 						delay-time from dip-switches */
84b7e04f8cSWim Van Sebroeck static int heartbeat = WATCHDOG_HEARTBEAT;
85b7e04f8cSWim Van Sebroeck module_param(heartbeat, int, 0);
86143a2e54SWim Van Sebroeck MODULE_PARM_DESC(heartbeat, "Watchdog heartbeat in seconds. "
87143a2e54SWim Van Sebroeck 	"(0<heartbeat<65536 or 0=delay-time from dip-switches, default="
88143a2e54SWim Van Sebroeck 				__MODULE_STRING(WATCHDOG_HEARTBEAT) ")");
89b7e04f8cSWim Van Sebroeck 
9086a1e189SWim Van Sebroeck static bool nowayout = WATCHDOG_NOWAYOUT;
9186a1e189SWim Van Sebroeck module_param(nowayout, bool, 0);
92143a2e54SWim Van Sebroeck MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default="
93143a2e54SWim Van Sebroeck 				__MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
94b7e04f8cSWim Van Sebroeck 
95b7e04f8cSWim Van Sebroeck /* The vendor and product id's for the USB-PC Watchdog card */
96b7e04f8cSWim Van Sebroeck #define USB_PCWD_VENDOR_ID	0x0c98
97b7e04f8cSWim Van Sebroeck #define USB_PCWD_PRODUCT_ID	0x1140
98b7e04f8cSWim Van Sebroeck 
99b7e04f8cSWim Van Sebroeck /* table of devices that work with this driver */
100b7e04f8cSWim Van Sebroeck static struct usb_device_id usb_pcwd_table[] = {
101b7e04f8cSWim Van Sebroeck 	{ USB_DEVICE(USB_PCWD_VENDOR_ID, USB_PCWD_PRODUCT_ID) },
102b7e04f8cSWim Van Sebroeck 	{ }					/* Terminating entry */
103b7e04f8cSWim Van Sebroeck };
104b7e04f8cSWim Van Sebroeck MODULE_DEVICE_TABLE(usb, usb_pcwd_table);
105b7e04f8cSWim Van Sebroeck 
106b7e04f8cSWim Van Sebroeck /* according to documentation max. time to process a command for the USB
107b7e04f8cSWim Van Sebroeck  * watchdog card is 100 or 200 ms, so we give it 250 ms to do it's job */
108b7e04f8cSWim Van Sebroeck #define USB_COMMAND_TIMEOUT	250
109b7e04f8cSWim Van Sebroeck 
110b7e04f8cSWim Van Sebroeck /* Watchdog's internal commands */
111143a2e54SWim Van Sebroeck #define CMD_READ_TEMP			0x02	/* Read Temperature;
112143a2e54SWim Van Sebroeck 							Re-trigger Watchdog */
113b7e04f8cSWim Van Sebroeck #define CMD_TRIGGER			CMD_READ_TEMP
114b7e04f8cSWim Van Sebroeck #define CMD_GET_STATUS			0x04	/* Get Status Information */
115b7e04f8cSWim Van Sebroeck #define CMD_GET_FIRMWARE_VERSION	0x08	/* Get Firmware Version */
116b7e04f8cSWim Van Sebroeck #define CMD_GET_DIP_SWITCH_SETTINGS	0x0c	/* Get Dip Switch Settings */
117b7e04f8cSWim Van Sebroeck #define CMD_READ_WATCHDOG_TIMEOUT	0x18	/* Read Current Watchdog Time */
118b7e04f8cSWim Van Sebroeck #define CMD_WRITE_WATCHDOG_TIMEOUT	0x19	/* Write Current WatchdogTime */
119b7e04f8cSWim Van Sebroeck #define CMD_ENABLE_WATCHDOG		0x30	/* Enable / Disable Watchdog */
120b7e04f8cSWim Van Sebroeck #define CMD_DISABLE_WATCHDOG		CMD_ENABLE_WATCHDOG
121b7e04f8cSWim Van Sebroeck 
122b7e04f8cSWim Van Sebroeck /* Watchdog's Dip Switch heartbeat values */
123b7e04f8cSWim Van Sebroeck static const int heartbeat_tbl[] = {
124b7e04f8cSWim Van Sebroeck 	5,	/* OFF-OFF-OFF	=  5 Sec  */
125b7e04f8cSWim Van Sebroeck 	10,	/* OFF-OFF-ON	= 10 Sec  */
126b7e04f8cSWim Van Sebroeck 	30,	/* OFF-ON-OFF	= 30 Sec  */
127b7e04f8cSWim Van Sebroeck 	60,	/* OFF-ON-ON	=  1 Min  */
128b7e04f8cSWim Van Sebroeck 	300,	/* ON-OFF-OFF	=  5 Min  */
129b7e04f8cSWim Van Sebroeck 	600,	/* ON-OFF-ON	= 10 Min  */
130b7e04f8cSWim Van Sebroeck 	1800,	/* ON-ON-OFF	= 30 Min  */
131b7e04f8cSWim Van Sebroeck 	3600,	/* ON-ON-ON	=  1 hour */
132b7e04f8cSWim Van Sebroeck };
133b7e04f8cSWim Van Sebroeck 
134b7e04f8cSWim Van Sebroeck /* We can only use 1 card due to the /dev/watchdog restriction */
135b7e04f8cSWim Van Sebroeck static int cards_found;
136b7e04f8cSWim Van Sebroeck 
137b7e04f8cSWim Van Sebroeck /* some internal variables */
138b7e04f8cSWim Van Sebroeck static unsigned long is_active;
139b7e04f8cSWim Van Sebroeck static char expect_release;
140b7e04f8cSWim Van Sebroeck 
141b7e04f8cSWim Van Sebroeck /* Structure to hold all of our device specific stuff */
142b7e04f8cSWim Van Sebroeck struct usb_pcwd_private {
143143a2e54SWim Van Sebroeck 	/* save off the usb device pointer */
144143a2e54SWim Van Sebroeck 	struct usb_device	*udev;
145143a2e54SWim Van Sebroeck 	/* the interface for this device */
146143a2e54SWim Van Sebroeck 	struct usb_interface	*interface;
147b7e04f8cSWim Van Sebroeck 
148143a2e54SWim Van Sebroeck 	/* the interface number used for cmd's */
149143a2e54SWim Van Sebroeck 	unsigned int		interface_number;
150b7e04f8cSWim Van Sebroeck 
151143a2e54SWim Van Sebroeck 	/* the buffer to intr data */
152143a2e54SWim Van Sebroeck 	unsigned char		*intr_buffer;
153143a2e54SWim Van Sebroeck 	/* the dma address for the intr buffer */
154143a2e54SWim Van Sebroeck 	dma_addr_t		intr_dma;
155143a2e54SWim Van Sebroeck 	/* the size of the intr buffer */
156143a2e54SWim Van Sebroeck 	size_t			intr_size;
157143a2e54SWim Van Sebroeck 	/* the urb used for the intr pipe */
158143a2e54SWim Van Sebroeck 	struct urb		*intr_urb;
159b7e04f8cSWim Van Sebroeck 
160143a2e54SWim Van Sebroeck 	/* The command that is reported back */
161143a2e54SWim Van Sebroeck 	unsigned char		cmd_command;
162143a2e54SWim Van Sebroeck 	/* The data MSB that is reported back */
163143a2e54SWim Van Sebroeck 	unsigned char		cmd_data_msb;
164143a2e54SWim Van Sebroeck 	/* The data LSB that is reported back */
165143a2e54SWim Van Sebroeck 	unsigned char		cmd_data_lsb;
166143a2e54SWim Van Sebroeck 	/* true if we received a report after a command */
167143a2e54SWim Van Sebroeck 	atomic_t		cmd_received;
168b7e04f8cSWim Van Sebroeck 
169143a2e54SWim Van Sebroeck 	/* Wether or not the device exists */
170143a2e54SWim Van Sebroeck 	int			exists;
171143a2e54SWim Van Sebroeck 	/* locks this structure */
172143a2e54SWim Van Sebroeck 	struct mutex		mtx;
173b7e04f8cSWim Van Sebroeck };
174b7e04f8cSWim Van Sebroeck static struct usb_pcwd_private *usb_pcwd_device;
175b7e04f8cSWim Van Sebroeck 
176b7e04f8cSWim Van Sebroeck /* prevent races between open() and disconnect() */
177b7e04f8cSWim Van Sebroeck static DEFINE_MUTEX(disconnect_mutex);
178b7e04f8cSWim Van Sebroeck 
179b7e04f8cSWim Van Sebroeck /* local function prototypes */
180143a2e54SWim Van Sebroeck static int usb_pcwd_probe(struct usb_interface *interface,
181143a2e54SWim Van Sebroeck 						const struct usb_device_id *id);
182b7e04f8cSWim Van Sebroeck static void usb_pcwd_disconnect(struct usb_interface *interface);
183b7e04f8cSWim Van Sebroeck 
184b7e04f8cSWim Van Sebroeck /* usb specific object needed to register this driver with the usb subsystem */
185b7e04f8cSWim Van Sebroeck static struct usb_driver usb_pcwd_driver = {
186b7e04f8cSWim Van Sebroeck 	.name =		DRIVER_NAME,
187b7e04f8cSWim Van Sebroeck 	.probe =	usb_pcwd_probe,
188b7e04f8cSWim Van Sebroeck 	.disconnect =	usb_pcwd_disconnect,
189b7e04f8cSWim Van Sebroeck 	.id_table =	usb_pcwd_table,
190b7e04f8cSWim Van Sebroeck };
191b7e04f8cSWim Van Sebroeck 
192b7e04f8cSWim Van Sebroeck 
193b7e04f8cSWim Van Sebroeck static void usb_pcwd_intr_done(struct urb *urb)
194b7e04f8cSWim Van Sebroeck {
195143a2e54SWim Van Sebroeck 	struct usb_pcwd_private *usb_pcwd =
196143a2e54SWim Van Sebroeck 				(struct usb_pcwd_private *)urb->context;
197b7e04f8cSWim Van Sebroeck 	unsigned char *data = usb_pcwd->intr_buffer;
198b7e04f8cSWim Van Sebroeck 	int retval;
199b7e04f8cSWim Van Sebroeck 
200b7e04f8cSWim Van Sebroeck 	switch (urb->status) {
201b7e04f8cSWim Van Sebroeck 	case 0:			/* success */
202b7e04f8cSWim Van Sebroeck 		break;
203b7e04f8cSWim Van Sebroeck 	case -ECONNRESET:	/* unlink */
204b7e04f8cSWim Van Sebroeck 	case -ENOENT:
205b7e04f8cSWim Van Sebroeck 	case -ESHUTDOWN:
206b7e04f8cSWim Van Sebroeck 		/* this urb is terminated, clean up */
207143a2e54SWim Van Sebroeck 		dbg("%s - urb shutting down with status: %d", __func__,
208143a2e54SWim Van Sebroeck 								urb->status);
209b7e04f8cSWim Van Sebroeck 		return;
210b7e04f8cSWim Van Sebroeck 	/* -EPIPE:  should clear the halt */
211b7e04f8cSWim Van Sebroeck 	default:		/* error */
212143a2e54SWim Van Sebroeck 		dbg("%s - nonzero urb status received: %d", __func__,
213143a2e54SWim Van Sebroeck 								urb->status);
214b7e04f8cSWim Van Sebroeck 		goto resubmit;
215b7e04f8cSWim Van Sebroeck 	}
216b7e04f8cSWim Van Sebroeck 
217b7e04f8cSWim Van Sebroeck 	dbg("received following data cmd=0x%02x msb=0x%02x lsb=0x%02x",
218b7e04f8cSWim Van Sebroeck 		data[0], data[1], data[2]);
219b7e04f8cSWim Van Sebroeck 
220b7e04f8cSWim Van Sebroeck 	usb_pcwd->cmd_command  = data[0];
221b7e04f8cSWim Van Sebroeck 	usb_pcwd->cmd_data_msb = data[1];
222b7e04f8cSWim Van Sebroeck 	usb_pcwd->cmd_data_lsb = data[2];
223b7e04f8cSWim Van Sebroeck 
224b7e04f8cSWim Van Sebroeck 	/* notify anyone waiting that the cmd has finished */
225b7e04f8cSWim Van Sebroeck 	atomic_set(&usb_pcwd->cmd_received, 1);
226b7e04f8cSWim Van Sebroeck 
227b7e04f8cSWim Van Sebroeck resubmit:
228b7e04f8cSWim Van Sebroeck 	retval = usb_submit_urb(urb, GFP_ATOMIC);
229b7e04f8cSWim Van Sebroeck 	if (retval)
23027c766aaSJoe Perches 		pr_err("can't resubmit intr, usb_submit_urb failed with result %d\n",
23127c766aaSJoe Perches 		       retval);
232b7e04f8cSWim Van Sebroeck }
233b7e04f8cSWim Van Sebroeck 
234143a2e54SWim Van Sebroeck static int usb_pcwd_send_command(struct usb_pcwd_private *usb_pcwd,
235143a2e54SWim Van Sebroeck 		unsigned char cmd, unsigned char *msb, unsigned char *lsb)
236b7e04f8cSWim Van Sebroeck {
237b7e04f8cSWim Van Sebroeck 	int got_response, count;
238*5412df0bSGuenter Roeck 	unsigned char *buf;
239b7e04f8cSWim Van Sebroeck 
240143a2e54SWim Van Sebroeck 	/* We will not send any commands if the USB PCWD device does
241143a2e54SWim Van Sebroeck 	 * not exist */
242b7e04f8cSWim Van Sebroeck 	if ((!usb_pcwd) || (!usb_pcwd->exists))
243b7e04f8cSWim Van Sebroeck 		return -1;
244b7e04f8cSWim Van Sebroeck 
245*5412df0bSGuenter Roeck 	buf = kmalloc(6, GFP_KERNEL);
246*5412df0bSGuenter Roeck 	if (buf == NULL)
247*5412df0bSGuenter Roeck 		return 0;
248*5412df0bSGuenter Roeck 
249143a2e54SWim Van Sebroeck 	/* The USB PC Watchdog uses a 6 byte report format.
250143a2e54SWim Van Sebroeck 	 * The board currently uses only 3 of the six bytes of the report. */
251b7e04f8cSWim Van Sebroeck 	buf[0] = cmd;			/* Byte 0 = CMD */
252b7e04f8cSWim Van Sebroeck 	buf[1] = *msb;			/* Byte 1 = Data MSB */
253b7e04f8cSWim Van Sebroeck 	buf[2] = *lsb;			/* Byte 2 = Data LSB */
254b7e04f8cSWim Van Sebroeck 	buf[3] = buf[4] = buf[5] = 0;	/* All other bytes not used */
255b7e04f8cSWim Van Sebroeck 
256b7e04f8cSWim Van Sebroeck 	dbg("sending following data cmd=0x%02x msb=0x%02x lsb=0x%02x",
257b7e04f8cSWim Van Sebroeck 		buf[0], buf[1], buf[2]);
258b7e04f8cSWim Van Sebroeck 
259b7e04f8cSWim Van Sebroeck 	atomic_set(&usb_pcwd->cmd_received, 0);
260b7e04f8cSWim Van Sebroeck 
261b7e04f8cSWim Van Sebroeck 	if (usb_control_msg(usb_pcwd->udev, usb_sndctrlpipe(usb_pcwd->udev, 0),
262b7e04f8cSWim Van Sebroeck 			HID_REQ_SET_REPORT, HID_DT_REPORT,
263b7e04f8cSWim Van Sebroeck 			0x0200, usb_pcwd->interface_number, buf, sizeof(buf),
264b7e04f8cSWim Van Sebroeck 			USB_COMMAND_TIMEOUT) != sizeof(buf)) {
265143a2e54SWim Van Sebroeck 		dbg("usb_pcwd_send_command: error in usb_control_msg for "
266143a2e54SWim Van Sebroeck 				"cmd 0x%x 0x%x 0x%x\n", cmd, *msb, *lsb);
267b7e04f8cSWim Van Sebroeck 	}
268b7e04f8cSWim Van Sebroeck 	/* wait till the usb card processed the command,
269b7e04f8cSWim Van Sebroeck 	 * with a max. timeout of USB_COMMAND_TIMEOUT */
270b7e04f8cSWim Van Sebroeck 	got_response = 0;
271143a2e54SWim Van Sebroeck 	for (count = 0; (count < USB_COMMAND_TIMEOUT) && (!got_response);
272143a2e54SWim Van Sebroeck 								count++) {
273b7e04f8cSWim Van Sebroeck 		mdelay(1);
274b7e04f8cSWim Van Sebroeck 		if (atomic_read(&usb_pcwd->cmd_received))
275b7e04f8cSWim Van Sebroeck 			got_response = 1;
276b7e04f8cSWim Van Sebroeck 	}
277b7e04f8cSWim Van Sebroeck 
278b7e04f8cSWim Van Sebroeck 	if ((got_response) && (cmd == usb_pcwd->cmd_command)) {
279b7e04f8cSWim Van Sebroeck 		/* read back response */
280b7e04f8cSWim Van Sebroeck 		*msb = usb_pcwd->cmd_data_msb;
281b7e04f8cSWim Van Sebroeck 		*lsb = usb_pcwd->cmd_data_lsb;
282b7e04f8cSWim Van Sebroeck 	}
283b7e04f8cSWim Van Sebroeck 
284*5412df0bSGuenter Roeck 	kfree(buf);
285*5412df0bSGuenter Roeck 
286b7e04f8cSWim Van Sebroeck 	return got_response;
287b7e04f8cSWim Van Sebroeck }
288b7e04f8cSWim Van Sebroeck 
289b7e04f8cSWim Van Sebroeck static int usb_pcwd_start(struct usb_pcwd_private *usb_pcwd)
290b7e04f8cSWim Van Sebroeck {
291b7e04f8cSWim Van Sebroeck 	unsigned char msb = 0x00;
292b7e04f8cSWim Van Sebroeck 	unsigned char lsb = 0x00;
293b7e04f8cSWim Van Sebroeck 	int retval;
294b7e04f8cSWim Van Sebroeck 
295b7e04f8cSWim Van Sebroeck 	/* Enable Watchdog */
296143a2e54SWim Van Sebroeck 	retval = usb_pcwd_send_command(usb_pcwd, CMD_ENABLE_WATCHDOG,
297143a2e54SWim Van Sebroeck 								&msb, &lsb);
298b7e04f8cSWim Van Sebroeck 
299b7e04f8cSWim Van Sebroeck 	if ((retval == 0) || (lsb == 0)) {
30027c766aaSJoe Perches 		pr_err("Card did not acknowledge enable attempt\n");
301b7e04f8cSWim Van Sebroeck 		return -1;
302b7e04f8cSWim Van Sebroeck 	}
303b7e04f8cSWim Van Sebroeck 
304b7e04f8cSWim Van Sebroeck 	return 0;
305b7e04f8cSWim Van Sebroeck }
306b7e04f8cSWim Van Sebroeck 
307b7e04f8cSWim Van Sebroeck static int usb_pcwd_stop(struct usb_pcwd_private *usb_pcwd)
308b7e04f8cSWim Van Sebroeck {
309b7e04f8cSWim Van Sebroeck 	unsigned char msb = 0xA5;
310b7e04f8cSWim Van Sebroeck 	unsigned char lsb = 0xC3;
311b7e04f8cSWim Van Sebroeck 	int retval;
312b7e04f8cSWim Van Sebroeck 
313b7e04f8cSWim Van Sebroeck 	/* Disable Watchdog */
314143a2e54SWim Van Sebroeck 	retval = usb_pcwd_send_command(usb_pcwd, CMD_DISABLE_WATCHDOG,
315143a2e54SWim Van Sebroeck 								&msb, &lsb);
316b7e04f8cSWim Van Sebroeck 
317b7e04f8cSWim Van Sebroeck 	if ((retval == 0) || (lsb != 0)) {
31827c766aaSJoe Perches 		pr_err("Card did not acknowledge disable attempt\n");
319b7e04f8cSWim Van Sebroeck 		return -1;
320b7e04f8cSWim Van Sebroeck 	}
321b7e04f8cSWim Van Sebroeck 
322b7e04f8cSWim Van Sebroeck 	return 0;
323b7e04f8cSWim Van Sebroeck }
324b7e04f8cSWim Van Sebroeck 
325b7e04f8cSWim Van Sebroeck static int usb_pcwd_keepalive(struct usb_pcwd_private *usb_pcwd)
326b7e04f8cSWim Van Sebroeck {
327b7e04f8cSWim Van Sebroeck 	unsigned char dummy;
328b7e04f8cSWim Van Sebroeck 
329b7e04f8cSWim Van Sebroeck 	/* Re-trigger Watchdog */
330b7e04f8cSWim Van Sebroeck 	usb_pcwd_send_command(usb_pcwd, CMD_TRIGGER, &dummy, &dummy);
331b7e04f8cSWim Van Sebroeck 
332b7e04f8cSWim Van Sebroeck 	return 0;
333b7e04f8cSWim Van Sebroeck }
334b7e04f8cSWim Van Sebroeck 
335b7e04f8cSWim Van Sebroeck static int usb_pcwd_set_heartbeat(struct usb_pcwd_private *usb_pcwd, int t)
336b7e04f8cSWim Van Sebroeck {
337b7e04f8cSWim Van Sebroeck 	unsigned char msb = t / 256;
338b7e04f8cSWim Van Sebroeck 	unsigned char lsb = t % 256;
339b7e04f8cSWim Van Sebroeck 
340b7e04f8cSWim Van Sebroeck 	if ((t < 0x0001) || (t > 0xFFFF))
341b7e04f8cSWim Van Sebroeck 		return -EINVAL;
342b7e04f8cSWim Van Sebroeck 
343b7e04f8cSWim Van Sebroeck 	/* Write new heartbeat to watchdog */
344b7e04f8cSWim Van Sebroeck 	usb_pcwd_send_command(usb_pcwd, CMD_WRITE_WATCHDOG_TIMEOUT, &msb, &lsb);
345b7e04f8cSWim Van Sebroeck 
346b7e04f8cSWim Van Sebroeck 	heartbeat = t;
347b7e04f8cSWim Van Sebroeck 	return 0;
348b7e04f8cSWim Van Sebroeck }
349b7e04f8cSWim Van Sebroeck 
350143a2e54SWim Van Sebroeck static int usb_pcwd_get_temperature(struct usb_pcwd_private *usb_pcwd,
351143a2e54SWim Van Sebroeck 							int *temperature)
352b7e04f8cSWim Van Sebroeck {
353b7e04f8cSWim Van Sebroeck 	unsigned char msb, lsb;
354b7e04f8cSWim Van Sebroeck 
355b7e04f8cSWim Van Sebroeck 	usb_pcwd_send_command(usb_pcwd, CMD_READ_TEMP, &msb, &lsb);
356b7e04f8cSWim Van Sebroeck 
357b7e04f8cSWim Van Sebroeck 	/*
358b7e04f8cSWim Van Sebroeck 	 * Convert celsius to fahrenheit, since this was
359b7e04f8cSWim Van Sebroeck 	 * the decided 'standard' for this return value.
360b7e04f8cSWim Van Sebroeck 	 */
361b7e04f8cSWim Van Sebroeck 	*temperature = (lsb * 9 / 5) + 32;
362b7e04f8cSWim Van Sebroeck 
363b7e04f8cSWim Van Sebroeck 	return 0;
364b7e04f8cSWim Van Sebroeck }
365b7e04f8cSWim Van Sebroeck 
366143a2e54SWim Van Sebroeck static int usb_pcwd_get_timeleft(struct usb_pcwd_private *usb_pcwd,
367143a2e54SWim Van Sebroeck 								int *time_left)
368b7e04f8cSWim Van Sebroeck {
369b7e04f8cSWim Van Sebroeck 	unsigned char msb, lsb;
370b7e04f8cSWim Van Sebroeck 
371b7e04f8cSWim Van Sebroeck 	/* Read the time that's left before rebooting */
372b7e04f8cSWim Van Sebroeck 	/* Note: if the board is not yet armed then we will read 0xFFFF */
373b7e04f8cSWim Van Sebroeck 	usb_pcwd_send_command(usb_pcwd, CMD_READ_WATCHDOG_TIMEOUT, &msb, &lsb);
374b7e04f8cSWim Van Sebroeck 
375b7e04f8cSWim Van Sebroeck 	*time_left = (msb << 8) + lsb;
376b7e04f8cSWim Van Sebroeck 
377b7e04f8cSWim Van Sebroeck 	return 0;
378b7e04f8cSWim Van Sebroeck }
379b7e04f8cSWim Van Sebroeck 
380b7e04f8cSWim Van Sebroeck /*
381b7e04f8cSWim Van Sebroeck  *	/dev/watchdog handling
382b7e04f8cSWim Van Sebroeck  */
383b7e04f8cSWim Van Sebroeck 
384b7e04f8cSWim Van Sebroeck static ssize_t usb_pcwd_write(struct file *file, const char __user *data,
385b7e04f8cSWim Van Sebroeck 						size_t len, loff_t *ppos)
386b7e04f8cSWim Van Sebroeck {
387b7e04f8cSWim Van Sebroeck 	/* See if we got the magic character 'V' and reload the timer */
388b7e04f8cSWim Van Sebroeck 	if (len) {
389b7e04f8cSWim Van Sebroeck 		if (!nowayout) {
390b7e04f8cSWim Van Sebroeck 			size_t i;
391b7e04f8cSWim Van Sebroeck 
392b7e04f8cSWim Van Sebroeck 			/* note: just in case someone wrote the magic character
393b7e04f8cSWim Van Sebroeck 			 * five months ago... */
394b7e04f8cSWim Van Sebroeck 			expect_release = 0;
395b7e04f8cSWim Van Sebroeck 
396143a2e54SWim Van Sebroeck 			/* scan to see whether or not we got the
397143a2e54SWim Van Sebroeck 			 * magic character */
398b7e04f8cSWim Van Sebroeck 			for (i = 0; i != len; i++) {
399b7e04f8cSWim Van Sebroeck 				char c;
400b7e04f8cSWim Van Sebroeck 				if (get_user(c, data + i))
401b7e04f8cSWim Van Sebroeck 					return -EFAULT;
402b7e04f8cSWim Van Sebroeck 				if (c == 'V')
403b7e04f8cSWim Van Sebroeck 					expect_release = 42;
404b7e04f8cSWim Van Sebroeck 			}
405b7e04f8cSWim Van Sebroeck 		}
406b7e04f8cSWim Van Sebroeck 
407b7e04f8cSWim Van Sebroeck 		/* someone wrote to us, we should reload the timer */
408b7e04f8cSWim Van Sebroeck 		usb_pcwd_keepalive(usb_pcwd_device);
409b7e04f8cSWim Van Sebroeck 	}
410b7e04f8cSWim Van Sebroeck 	return len;
411b7e04f8cSWim Van Sebroeck }
412b7e04f8cSWim Van Sebroeck 
413c9488520SAlan Cox static long usb_pcwd_ioctl(struct file *file, unsigned int cmd,
414c9488520SAlan Cox 						unsigned long arg)
415b7e04f8cSWim Van Sebroeck {
416b7e04f8cSWim Van Sebroeck 	void __user *argp = (void __user *)arg;
417b7e04f8cSWim Van Sebroeck 	int __user *p = argp;
41842747d71SWim Van Sebroeck 	static const struct watchdog_info ident = {
419b7e04f8cSWim Van Sebroeck 		.options =		WDIOF_KEEPALIVEPING |
420b7e04f8cSWim Van Sebroeck 					WDIOF_SETTIMEOUT |
421b7e04f8cSWim Van Sebroeck 					WDIOF_MAGICCLOSE,
422b7e04f8cSWim Van Sebroeck 		.firmware_version =	1,
423b7e04f8cSWim Van Sebroeck 		.identity =		DRIVER_NAME,
424b7e04f8cSWim Van Sebroeck 	};
425b7e04f8cSWim Van Sebroeck 
426b7e04f8cSWim Van Sebroeck 	switch (cmd) {
427b7e04f8cSWim Van Sebroeck 	case WDIOC_GETSUPPORT:
4287944d3a5SWim Van Sebroeck 		return copy_to_user(argp, &ident, sizeof(ident)) ? -EFAULT : 0;
429b7e04f8cSWim Van Sebroeck 
430b7e04f8cSWim Van Sebroeck 	case WDIOC_GETSTATUS:
431b7e04f8cSWim Van Sebroeck 	case WDIOC_GETBOOTSTATUS:
432b7e04f8cSWim Van Sebroeck 		return put_user(0, p);
433b7e04f8cSWim Van Sebroeck 
434b7e04f8cSWim Van Sebroeck 	case WDIOC_GETTEMP:
435b7e04f8cSWim Van Sebroeck 	{
436b7e04f8cSWim Van Sebroeck 		int temperature;
437b7e04f8cSWim Van Sebroeck 
438b7e04f8cSWim Van Sebroeck 		if (usb_pcwd_get_temperature(usb_pcwd_device, &temperature))
439b7e04f8cSWim Van Sebroeck 			return -EFAULT;
440b7e04f8cSWim Van Sebroeck 
441b7e04f8cSWim Van Sebroeck 		return put_user(temperature, p);
442b7e04f8cSWim Van Sebroeck 	}
443b7e04f8cSWim Van Sebroeck 
444b7e04f8cSWim Van Sebroeck 	case WDIOC_SETOPTIONS:
445b7e04f8cSWim Van Sebroeck 	{
446b7e04f8cSWim Van Sebroeck 		int new_options, retval = -EINVAL;
447b7e04f8cSWim Van Sebroeck 
448b7e04f8cSWim Van Sebroeck 		if (get_user(new_options, p))
449b7e04f8cSWim Van Sebroeck 			return -EFAULT;
450b7e04f8cSWim Van Sebroeck 
451b7e04f8cSWim Van Sebroeck 		if (new_options & WDIOS_DISABLECARD) {
452b7e04f8cSWim Van Sebroeck 			usb_pcwd_stop(usb_pcwd_device);
453b7e04f8cSWim Van Sebroeck 			retval = 0;
454b7e04f8cSWim Van Sebroeck 		}
455b7e04f8cSWim Van Sebroeck 
456b7e04f8cSWim Van Sebroeck 		if (new_options & WDIOS_ENABLECARD) {
457b7e04f8cSWim Van Sebroeck 			usb_pcwd_start(usb_pcwd_device);
458b7e04f8cSWim Van Sebroeck 			retval = 0;
459b7e04f8cSWim Van Sebroeck 		}
460b7e04f8cSWim Van Sebroeck 
461b7e04f8cSWim Van Sebroeck 		return retval;
462b7e04f8cSWim Van Sebroeck 	}
463b7e04f8cSWim Van Sebroeck 
4640c06090cSWim Van Sebroeck 	case WDIOC_KEEPALIVE:
4650c06090cSWim Van Sebroeck 		usb_pcwd_keepalive(usb_pcwd_device);
4660c06090cSWim Van Sebroeck 		return 0;
4670c06090cSWim Van Sebroeck 
468b7e04f8cSWim Van Sebroeck 	case WDIOC_SETTIMEOUT:
469b7e04f8cSWim Van Sebroeck 	{
470b7e04f8cSWim Van Sebroeck 		int new_heartbeat;
471b7e04f8cSWim Van Sebroeck 
472b7e04f8cSWim Van Sebroeck 		if (get_user(new_heartbeat, p))
473b7e04f8cSWim Van Sebroeck 			return -EFAULT;
474b7e04f8cSWim Van Sebroeck 
475b7e04f8cSWim Van Sebroeck 		if (usb_pcwd_set_heartbeat(usb_pcwd_device, new_heartbeat))
476b7e04f8cSWim Van Sebroeck 			return -EINVAL;
477b7e04f8cSWim Van Sebroeck 
478b7e04f8cSWim Van Sebroeck 		usb_pcwd_keepalive(usb_pcwd_device);
479b7e04f8cSWim Van Sebroeck 		/* Fall */
480b7e04f8cSWim Van Sebroeck 	}
481b7e04f8cSWim Van Sebroeck 
482b7e04f8cSWim Van Sebroeck 	case WDIOC_GETTIMEOUT:
483b7e04f8cSWim Van Sebroeck 		return put_user(heartbeat, p);
484b7e04f8cSWim Van Sebroeck 
485b7e04f8cSWim Van Sebroeck 	case WDIOC_GETTIMELEFT:
486b7e04f8cSWim Van Sebroeck 	{
487b7e04f8cSWim Van Sebroeck 		int time_left;
488b7e04f8cSWim Van Sebroeck 
489b7e04f8cSWim Van Sebroeck 		if (usb_pcwd_get_timeleft(usb_pcwd_device, &time_left))
490b7e04f8cSWim Van Sebroeck 			return -EFAULT;
491b7e04f8cSWim Van Sebroeck 
492b7e04f8cSWim Van Sebroeck 		return put_user(time_left, p);
493b7e04f8cSWim Van Sebroeck 	}
494b7e04f8cSWim Van Sebroeck 
495b7e04f8cSWim Van Sebroeck 	default:
496b7e04f8cSWim Van Sebroeck 		return -ENOTTY;
497b7e04f8cSWim Van Sebroeck 	}
498b7e04f8cSWim Van Sebroeck }
499b7e04f8cSWim Van Sebroeck 
500b7e04f8cSWim Van Sebroeck static int usb_pcwd_open(struct inode *inode, struct file *file)
501b7e04f8cSWim Van Sebroeck {
502b7e04f8cSWim Van Sebroeck 	/* /dev/watchdog can only be opened once */
503b7e04f8cSWim Van Sebroeck 	if (test_and_set_bit(0, &is_active))
504b7e04f8cSWim Van Sebroeck 		return -EBUSY;
505b7e04f8cSWim Van Sebroeck 
506b7e04f8cSWim Van Sebroeck 	/* Activate */
507b7e04f8cSWim Van Sebroeck 	usb_pcwd_start(usb_pcwd_device);
508b7e04f8cSWim Van Sebroeck 	usb_pcwd_keepalive(usb_pcwd_device);
509b7e04f8cSWim Van Sebroeck 	return nonseekable_open(inode, file);
510b7e04f8cSWim Van Sebroeck }
511b7e04f8cSWim Van Sebroeck 
512b7e04f8cSWim Van Sebroeck static int usb_pcwd_release(struct inode *inode, struct file *file)
513b7e04f8cSWim Van Sebroeck {
514b7e04f8cSWim Van Sebroeck 	/*
515b7e04f8cSWim Van Sebroeck 	 *      Shut off the timer.
516b7e04f8cSWim Van Sebroeck 	 */
517b7e04f8cSWim Van Sebroeck 	if (expect_release == 42) {
518b7e04f8cSWim Van Sebroeck 		usb_pcwd_stop(usb_pcwd_device);
519b7e04f8cSWim Van Sebroeck 	} else {
52027c766aaSJoe Perches 		pr_crit("Unexpected close, not stopping watchdog!\n");
521b7e04f8cSWim Van Sebroeck 		usb_pcwd_keepalive(usb_pcwd_device);
522b7e04f8cSWim Van Sebroeck 	}
523b7e04f8cSWim Van Sebroeck 	expect_release = 0;
524b7e04f8cSWim Van Sebroeck 	clear_bit(0, &is_active);
525b7e04f8cSWim Van Sebroeck 	return 0;
526b7e04f8cSWim Van Sebroeck }
527b7e04f8cSWim Van Sebroeck 
528b7e04f8cSWim Van Sebroeck /*
529b7e04f8cSWim Van Sebroeck  *	/dev/temperature handling
530b7e04f8cSWim Van Sebroeck  */
531b7e04f8cSWim Van Sebroeck 
532b7e04f8cSWim Van Sebroeck static ssize_t usb_pcwd_temperature_read(struct file *file, char __user *data,
533b7e04f8cSWim Van Sebroeck 				size_t len, loff_t *ppos)
534b7e04f8cSWim Van Sebroeck {
535b7e04f8cSWim Van Sebroeck 	int temperature;
536b7e04f8cSWim Van Sebroeck 
537b7e04f8cSWim Van Sebroeck 	if (usb_pcwd_get_temperature(usb_pcwd_device, &temperature))
538b7e04f8cSWim Van Sebroeck 		return -EFAULT;
539b7e04f8cSWim Van Sebroeck 
540b7e04f8cSWim Van Sebroeck 	if (copy_to_user(data, &temperature, 1))
541b7e04f8cSWim Van Sebroeck 		return -EFAULT;
542b7e04f8cSWim Van Sebroeck 
543b7e04f8cSWim Van Sebroeck 	return 1;
544b7e04f8cSWim Van Sebroeck }
545b7e04f8cSWim Van Sebroeck 
546b7e04f8cSWim Van Sebroeck static int usb_pcwd_temperature_open(struct inode *inode, struct file *file)
547b7e04f8cSWim Van Sebroeck {
548b7e04f8cSWim Van Sebroeck 	return nonseekable_open(inode, file);
549b7e04f8cSWim Van Sebroeck }
550b7e04f8cSWim Van Sebroeck 
551b7e04f8cSWim Van Sebroeck static int usb_pcwd_temperature_release(struct inode *inode, struct file *file)
552b7e04f8cSWim Van Sebroeck {
553b7e04f8cSWim Van Sebroeck 	return 0;
554b7e04f8cSWim Van Sebroeck }
555b7e04f8cSWim Van Sebroeck 
556b7e04f8cSWim Van Sebroeck /*
557b7e04f8cSWim Van Sebroeck  *	Notify system
558b7e04f8cSWim Van Sebroeck  */
559b7e04f8cSWim Van Sebroeck 
560143a2e54SWim Van Sebroeck static int usb_pcwd_notify_sys(struct notifier_block *this, unsigned long code,
561143a2e54SWim Van Sebroeck 								void *unused)
562b7e04f8cSWim Van Sebroeck {
5637944d3a5SWim Van Sebroeck 	if (code == SYS_DOWN || code == SYS_HALT)
5647944d3a5SWim Van Sebroeck 		usb_pcwd_stop(usb_pcwd_device);	/* Turn the WDT off */
565b7e04f8cSWim Van Sebroeck 
566b7e04f8cSWim Van Sebroeck 	return NOTIFY_DONE;
567b7e04f8cSWim Van Sebroeck }
568b7e04f8cSWim Van Sebroeck 
569b7e04f8cSWim Van Sebroeck /*
570b7e04f8cSWim Van Sebroeck  *	Kernel Interfaces
571b7e04f8cSWim Van Sebroeck  */
572b7e04f8cSWim Van Sebroeck 
573b7e04f8cSWim Van Sebroeck static const struct file_operations usb_pcwd_fops = {
574b7e04f8cSWim Van Sebroeck 	.owner =	THIS_MODULE,
575b7e04f8cSWim Van Sebroeck 	.llseek =	no_llseek,
576b7e04f8cSWim Van Sebroeck 	.write =	usb_pcwd_write,
577c9488520SAlan Cox 	.unlocked_ioctl = usb_pcwd_ioctl,
578b7e04f8cSWim Van Sebroeck 	.open =		usb_pcwd_open,
579b7e04f8cSWim Van Sebroeck 	.release =	usb_pcwd_release,
580b7e04f8cSWim Van Sebroeck };
581b7e04f8cSWim Van Sebroeck 
582b7e04f8cSWim Van Sebroeck static struct miscdevice usb_pcwd_miscdev = {
583b7e04f8cSWim Van Sebroeck 	.minor =	WATCHDOG_MINOR,
584b7e04f8cSWim Van Sebroeck 	.name =		"watchdog",
585b7e04f8cSWim Van Sebroeck 	.fops =		&usb_pcwd_fops,
586b7e04f8cSWim Van Sebroeck };
587b7e04f8cSWim Van Sebroeck 
588b7e04f8cSWim Van Sebroeck static const struct file_operations usb_pcwd_temperature_fops = {
589b7e04f8cSWim Van Sebroeck 	.owner =	THIS_MODULE,
590b7e04f8cSWim Van Sebroeck 	.llseek =	no_llseek,
591b7e04f8cSWim Van Sebroeck 	.read =		usb_pcwd_temperature_read,
592b7e04f8cSWim Van Sebroeck 	.open =		usb_pcwd_temperature_open,
593b7e04f8cSWim Van Sebroeck 	.release =	usb_pcwd_temperature_release,
594b7e04f8cSWim Van Sebroeck };
595b7e04f8cSWim Van Sebroeck 
596b7e04f8cSWim Van Sebroeck static struct miscdevice usb_pcwd_temperature_miscdev = {
597b7e04f8cSWim Van Sebroeck 	.minor =	TEMP_MINOR,
598b7e04f8cSWim Van Sebroeck 	.name =		"temperature",
599b7e04f8cSWim Van Sebroeck 	.fops =		&usb_pcwd_temperature_fops,
600b7e04f8cSWim Van Sebroeck };
601b7e04f8cSWim Van Sebroeck 
602b7e04f8cSWim Van Sebroeck static struct notifier_block usb_pcwd_notifier = {
603b7e04f8cSWim Van Sebroeck 	.notifier_call =	usb_pcwd_notify_sys,
604b7e04f8cSWim Van Sebroeck };
605b7e04f8cSWim Van Sebroeck 
606b7e04f8cSWim Van Sebroeck /**
607b7e04f8cSWim Van Sebroeck  *	usb_pcwd_delete
608b7e04f8cSWim Van Sebroeck  */
609b7e04f8cSWim Van Sebroeck static inline void usb_pcwd_delete(struct usb_pcwd_private *usb_pcwd)
610b7e04f8cSWim Van Sebroeck {
611b7e04f8cSWim Van Sebroeck 	usb_free_urb(usb_pcwd->intr_urb);
612b7e04f8cSWim Van Sebroeck 	if (usb_pcwd->intr_buffer != NULL)
613997ea58eSDaniel Mack 		usb_free_coherent(usb_pcwd->udev, usb_pcwd->intr_size,
614b7e04f8cSWim Van Sebroeck 				  usb_pcwd->intr_buffer, usb_pcwd->intr_dma);
615b7e04f8cSWim Van Sebroeck 	kfree(usb_pcwd);
616b7e04f8cSWim Van Sebroeck }
617b7e04f8cSWim Van Sebroeck 
618b7e04f8cSWim Van Sebroeck /**
619b7e04f8cSWim Van Sebroeck  *	usb_pcwd_probe
620b7e04f8cSWim Van Sebroeck  *
621b7e04f8cSWim Van Sebroeck  *	Called by the usb core when a new device is connected that it thinks
622b7e04f8cSWim Van Sebroeck  *	this driver might be interested in.
623b7e04f8cSWim Van Sebroeck  */
624143a2e54SWim Van Sebroeck static int usb_pcwd_probe(struct usb_interface *interface,
625143a2e54SWim Van Sebroeck 						const struct usb_device_id *id)
626b7e04f8cSWim Van Sebroeck {
627b7e04f8cSWim Van Sebroeck 	struct usb_device *udev = interface_to_usbdev(interface);
628b7e04f8cSWim Van Sebroeck 	struct usb_host_interface *iface_desc;
629b7e04f8cSWim Van Sebroeck 	struct usb_endpoint_descriptor *endpoint;
630b7e04f8cSWim Van Sebroeck 	struct usb_pcwd_private *usb_pcwd = NULL;
631b7e04f8cSWim Van Sebroeck 	int pipe, maxp;
632b7e04f8cSWim Van Sebroeck 	int retval = -ENOMEM;
633b7e04f8cSWim Van Sebroeck 	int got_fw_rev;
634b7e04f8cSWim Van Sebroeck 	unsigned char fw_rev_major, fw_rev_minor;
635b7e04f8cSWim Van Sebroeck 	char fw_ver_str[20];
636b7e04f8cSWim Van Sebroeck 	unsigned char option_switches, dummy;
637b7e04f8cSWim Van Sebroeck 
638b7e04f8cSWim Van Sebroeck 	cards_found++;
639b7e04f8cSWim Van Sebroeck 	if (cards_found > 1) {
64027c766aaSJoe Perches 		pr_err("This driver only supports 1 device\n");
641b7e04f8cSWim Van Sebroeck 		return -ENODEV;
642b7e04f8cSWim Van Sebroeck 	}
643b7e04f8cSWim Van Sebroeck 
644b7e04f8cSWim Van Sebroeck 	/* get the active interface descriptor */
645b7e04f8cSWim Van Sebroeck 	iface_desc = interface->cur_altsetting;
646b7e04f8cSWim Van Sebroeck 
647b7e04f8cSWim Van Sebroeck 	/* check out that we have a HID device */
648b7e04f8cSWim Van Sebroeck 	if (!(iface_desc->desc.bInterfaceClass == USB_CLASS_HID)) {
64927c766aaSJoe Perches 		pr_err("The device isn't a Human Interface Device\n");
650b7e04f8cSWim Van Sebroeck 		return -ENODEV;
651b7e04f8cSWim Van Sebroeck 	}
652b7e04f8cSWim Van Sebroeck 
653b7e04f8cSWim Van Sebroeck 	/* check out the endpoint: it has to be Interrupt & IN */
654b7e04f8cSWim Van Sebroeck 	endpoint = &iface_desc->endpoint[0].desc;
655b7e04f8cSWim Van Sebroeck 
6562855d28aSJulia Lawall 	if (!usb_endpoint_is_int_in(endpoint)) {
657b7e04f8cSWim Van Sebroeck 		/* we didn't find a Interrupt endpoint with direction IN */
65827c766aaSJoe Perches 		pr_err("Couldn't find an INTR & IN endpoint\n");
659b7e04f8cSWim Van Sebroeck 		return -ENODEV;
660b7e04f8cSWim Van Sebroeck 	}
661b7e04f8cSWim Van Sebroeck 
662b7e04f8cSWim Van Sebroeck 	/* get a handle to the interrupt data pipe */
663b7e04f8cSWim Van Sebroeck 	pipe = usb_rcvintpipe(udev, endpoint->bEndpointAddress);
664b7e04f8cSWim Van Sebroeck 	maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
665b7e04f8cSWim Van Sebroeck 
666b7e04f8cSWim Van Sebroeck 	/* allocate memory for our device and initialize it */
667b7e04f8cSWim Van Sebroeck 	usb_pcwd = kzalloc(sizeof(struct usb_pcwd_private), GFP_KERNEL);
668b7e04f8cSWim Van Sebroeck 	if (usb_pcwd == NULL) {
66927c766aaSJoe Perches 		pr_err("Out of memory\n");
670b7e04f8cSWim Van Sebroeck 		goto error;
671b7e04f8cSWim Van Sebroeck 	}
672b7e04f8cSWim Van Sebroeck 
673b7e04f8cSWim Van Sebroeck 	usb_pcwd_device = usb_pcwd;
674b7e04f8cSWim Van Sebroeck 
675b7e04f8cSWim Van Sebroeck 	mutex_init(&usb_pcwd->mtx);
676b7e04f8cSWim Van Sebroeck 	usb_pcwd->udev = udev;
677b7e04f8cSWim Van Sebroeck 	usb_pcwd->interface = interface;
678b7e04f8cSWim Van Sebroeck 	usb_pcwd->interface_number = iface_desc->desc.bInterfaceNumber;
679143a2e54SWim Van Sebroeck 	usb_pcwd->intr_size = (le16_to_cpu(endpoint->wMaxPacketSize) > 8 ?
680143a2e54SWim Van Sebroeck 				le16_to_cpu(endpoint->wMaxPacketSize) : 8);
681b7e04f8cSWim Van Sebroeck 
682b7e04f8cSWim Van Sebroeck 	/* set up the memory buffer's */
683997ea58eSDaniel Mack 	usb_pcwd->intr_buffer = usb_alloc_coherent(udev, usb_pcwd->intr_size,
684143a2e54SWim Van Sebroeck 					GFP_ATOMIC, &usb_pcwd->intr_dma);
6857944d3a5SWim Van Sebroeck 	if (!usb_pcwd->intr_buffer) {
68627c766aaSJoe Perches 		pr_err("Out of memory\n");
687b7e04f8cSWim Van Sebroeck 		goto error;
688b7e04f8cSWim Van Sebroeck 	}
689b7e04f8cSWim Van Sebroeck 
690b7e04f8cSWim Van Sebroeck 	/* allocate the urb's */
691b7e04f8cSWim Van Sebroeck 	usb_pcwd->intr_urb = usb_alloc_urb(0, GFP_KERNEL);
692b7e04f8cSWim Van Sebroeck 	if (!usb_pcwd->intr_urb) {
69327c766aaSJoe Perches 		pr_err("Out of memory\n");
694b7e04f8cSWim Van Sebroeck 		goto error;
695b7e04f8cSWim Van Sebroeck 	}
696b7e04f8cSWim Van Sebroeck 
697b7e04f8cSWim Van Sebroeck 	/* initialise the intr urb's */
698b7e04f8cSWim Van Sebroeck 	usb_fill_int_urb(usb_pcwd->intr_urb, udev, pipe,
699b7e04f8cSWim Van Sebroeck 			usb_pcwd->intr_buffer, usb_pcwd->intr_size,
700b7e04f8cSWim Van Sebroeck 			usb_pcwd_intr_done, usb_pcwd, endpoint->bInterval);
701b7e04f8cSWim Van Sebroeck 	usb_pcwd->intr_urb->transfer_dma = usb_pcwd->intr_dma;
702b7e04f8cSWim Van Sebroeck 	usb_pcwd->intr_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
703b7e04f8cSWim Van Sebroeck 
704b7e04f8cSWim Van Sebroeck 	/* register our interrupt URB with the USB system */
705b7e04f8cSWim Van Sebroeck 	if (usb_submit_urb(usb_pcwd->intr_urb, GFP_KERNEL)) {
70627c766aaSJoe Perches 		pr_err("Problem registering interrupt URB\n");
707b7e04f8cSWim Van Sebroeck 		retval = -EIO; /* failure */
708b7e04f8cSWim Van Sebroeck 		goto error;
709b7e04f8cSWim Van Sebroeck 	}
710b7e04f8cSWim Van Sebroeck 
711b7e04f8cSWim Van Sebroeck 	/* The device exists and can be communicated with */
712b7e04f8cSWim Van Sebroeck 	usb_pcwd->exists = 1;
713b7e04f8cSWim Van Sebroeck 
714b7e04f8cSWim Van Sebroeck 	/* disable card */
715b7e04f8cSWim Van Sebroeck 	usb_pcwd_stop(usb_pcwd);
716b7e04f8cSWim Van Sebroeck 
717b7e04f8cSWim Van Sebroeck 	/* Get the Firmware Version */
718143a2e54SWim Van Sebroeck 	got_fw_rev = usb_pcwd_send_command(usb_pcwd, CMD_GET_FIRMWARE_VERSION,
719143a2e54SWim Van Sebroeck 						&fw_rev_major, &fw_rev_minor);
7207944d3a5SWim Van Sebroeck 	if (got_fw_rev)
721b7e04f8cSWim Van Sebroeck 		sprintf(fw_ver_str, "%u.%02u", fw_rev_major, fw_rev_minor);
7227944d3a5SWim Van Sebroeck 	else
723b7e04f8cSWim Van Sebroeck 		sprintf(fw_ver_str, "<card no answer>");
724b7e04f8cSWim Van Sebroeck 
72527c766aaSJoe Perches 	pr_info("Found card (Firmware: %s) with temp option\n", fw_ver_str);
726b7e04f8cSWim Van Sebroeck 
727b7e04f8cSWim Van Sebroeck 	/* Get switch settings */
728143a2e54SWim Van Sebroeck 	usb_pcwd_send_command(usb_pcwd, CMD_GET_DIP_SWITCH_SETTINGS, &dummy,
729143a2e54SWim Van Sebroeck 							&option_switches);
730b7e04f8cSWim Van Sebroeck 
73127c766aaSJoe Perches 	pr_info("Option switches (0x%02x): Temperature Reset Enable=%s, Power On Delay=%s\n",
732b7e04f8cSWim Van Sebroeck 		option_switches,
733b7e04f8cSWim Van Sebroeck 		((option_switches & 0x10) ? "ON" : "OFF"),
734b7e04f8cSWim Van Sebroeck 		((option_switches & 0x08) ? "ON" : "OFF"));
735b7e04f8cSWim Van Sebroeck 
736b7e04f8cSWim Van Sebroeck 	/* If heartbeat = 0 then we use the heartbeat from the dip-switches */
737b7e04f8cSWim Van Sebroeck 	if (heartbeat == 0)
738b7e04f8cSWim Van Sebroeck 		heartbeat = heartbeat_tbl[(option_switches & 0x07)];
739b7e04f8cSWim Van Sebroeck 
740143a2e54SWim Van Sebroeck 	/* Check that the heartbeat value is within it's range ;
741143a2e54SWim Van Sebroeck 	 * if not reset to the default */
742b7e04f8cSWim Van Sebroeck 	if (usb_pcwd_set_heartbeat(usb_pcwd, heartbeat)) {
743b7e04f8cSWim Van Sebroeck 		usb_pcwd_set_heartbeat(usb_pcwd, WATCHDOG_HEARTBEAT);
74427c766aaSJoe Perches 		pr_info("heartbeat value must be 0<heartbeat<65536, using %d\n",
745b7e04f8cSWim Van Sebroeck 			WATCHDOG_HEARTBEAT);
746b7e04f8cSWim Van Sebroeck 	}
747b7e04f8cSWim Van Sebroeck 
748b7e04f8cSWim Van Sebroeck 	retval = register_reboot_notifier(&usb_pcwd_notifier);
749b7e04f8cSWim Van Sebroeck 	if (retval != 0) {
75027c766aaSJoe Perches 		pr_err("cannot register reboot notifier (err=%d)\n", retval);
751b7e04f8cSWim Van Sebroeck 		goto error;
752b7e04f8cSWim Van Sebroeck 	}
753b7e04f8cSWim Van Sebroeck 
754b7e04f8cSWim Van Sebroeck 	retval = misc_register(&usb_pcwd_temperature_miscdev);
755b7e04f8cSWim Van Sebroeck 	if (retval != 0) {
75627c766aaSJoe Perches 		pr_err("cannot register miscdev on minor=%d (err=%d)\n",
757b7e04f8cSWim Van Sebroeck 		       TEMP_MINOR, retval);
758b7e04f8cSWim Van Sebroeck 		goto err_out_unregister_reboot;
759b7e04f8cSWim Van Sebroeck 	}
760b7e04f8cSWim Van Sebroeck 
761b7e04f8cSWim Van Sebroeck 	retval = misc_register(&usb_pcwd_miscdev);
762b7e04f8cSWim Van Sebroeck 	if (retval != 0) {
76327c766aaSJoe Perches 		pr_err("cannot register miscdev on minor=%d (err=%d)\n",
764b7e04f8cSWim Van Sebroeck 		       WATCHDOG_MINOR, retval);
765b7e04f8cSWim Van Sebroeck 		goto err_out_misc_deregister;
766b7e04f8cSWim Van Sebroeck 	}
767b7e04f8cSWim Van Sebroeck 
768b7e04f8cSWim Van Sebroeck 	/* we can register the device now, as it is ready */
769b7e04f8cSWim Van Sebroeck 	usb_set_intfdata(interface, usb_pcwd);
770b7e04f8cSWim Van Sebroeck 
77127c766aaSJoe Perches 	pr_info("initialized. heartbeat=%d sec (nowayout=%d)\n",
772b7e04f8cSWim Van Sebroeck 		heartbeat, nowayout);
773b7e04f8cSWim Van Sebroeck 
774b7e04f8cSWim Van Sebroeck 	return 0;
775b7e04f8cSWim Van Sebroeck 
776b7e04f8cSWim Van Sebroeck err_out_misc_deregister:
777b7e04f8cSWim Van Sebroeck 	misc_deregister(&usb_pcwd_temperature_miscdev);
778b7e04f8cSWim Van Sebroeck err_out_unregister_reboot:
779b7e04f8cSWim Van Sebroeck 	unregister_reboot_notifier(&usb_pcwd_notifier);
780b7e04f8cSWim Van Sebroeck error:
781b7e04f8cSWim Van Sebroeck 	if (usb_pcwd)
782b7e04f8cSWim Van Sebroeck 		usb_pcwd_delete(usb_pcwd);
783b7e04f8cSWim Van Sebroeck 	usb_pcwd_device = NULL;
784b7e04f8cSWim Van Sebroeck 	return retval;
785b7e04f8cSWim Van Sebroeck }
786b7e04f8cSWim Van Sebroeck 
787b7e04f8cSWim Van Sebroeck 
788b7e04f8cSWim Van Sebroeck /**
789b7e04f8cSWim Van Sebroeck  *	usb_pcwd_disconnect
790b7e04f8cSWim Van Sebroeck  *
791b7e04f8cSWim Van Sebroeck  *	Called by the usb core when the device is removed from the system.
792b7e04f8cSWim Van Sebroeck  *
793b7e04f8cSWim Van Sebroeck  *	This routine guarantees that the driver will not submit any more urbs
794b7e04f8cSWim Van Sebroeck  *	by clearing dev->udev.
795b7e04f8cSWim Van Sebroeck  */
796b7e04f8cSWim Van Sebroeck static void usb_pcwd_disconnect(struct usb_interface *interface)
797b7e04f8cSWim Van Sebroeck {
798b7e04f8cSWim Van Sebroeck 	struct usb_pcwd_private *usb_pcwd;
799b7e04f8cSWim Van Sebroeck 
800b7e04f8cSWim Van Sebroeck 	/* prevent races with open() */
801b7e04f8cSWim Van Sebroeck 	mutex_lock(&disconnect_mutex);
802b7e04f8cSWim Van Sebroeck 
803b7e04f8cSWim Van Sebroeck 	usb_pcwd = usb_get_intfdata(interface);
804b7e04f8cSWim Van Sebroeck 	usb_set_intfdata(interface, NULL);
805b7e04f8cSWim Van Sebroeck 
806b7e04f8cSWim Van Sebroeck 	mutex_lock(&usb_pcwd->mtx);
807b7e04f8cSWim Van Sebroeck 
808b7e04f8cSWim Van Sebroeck 	/* Stop the timer before we leave */
809b7e04f8cSWim Van Sebroeck 	if (!nowayout)
810b7e04f8cSWim Van Sebroeck 		usb_pcwd_stop(usb_pcwd);
811b7e04f8cSWim Van Sebroeck 
812b7e04f8cSWim Van Sebroeck 	/* We should now stop communicating with the USB PCWD device */
813b7e04f8cSWim Van Sebroeck 	usb_pcwd->exists = 0;
814b7e04f8cSWim Van Sebroeck 
815b7e04f8cSWim Van Sebroeck 	/* Deregister */
816b7e04f8cSWim Van Sebroeck 	misc_deregister(&usb_pcwd_miscdev);
817b7e04f8cSWim Van Sebroeck 	misc_deregister(&usb_pcwd_temperature_miscdev);
818b7e04f8cSWim Van Sebroeck 	unregister_reboot_notifier(&usb_pcwd_notifier);
819b7e04f8cSWim Van Sebroeck 
820b7e04f8cSWim Van Sebroeck 	mutex_unlock(&usb_pcwd->mtx);
821b7e04f8cSWim Van Sebroeck 
822b7e04f8cSWim Van Sebroeck 	/* Delete the USB PCWD device */
823b7e04f8cSWim Van Sebroeck 	usb_pcwd_delete(usb_pcwd);
824b7e04f8cSWim Van Sebroeck 
825b7e04f8cSWim Van Sebroeck 	cards_found--;
826b7e04f8cSWim Van Sebroeck 
827b7e04f8cSWim Van Sebroeck 	mutex_unlock(&disconnect_mutex);
828b7e04f8cSWim Van Sebroeck 
82927c766aaSJoe Perches 	pr_info("USB PC Watchdog disconnected\n");
830b7e04f8cSWim Van Sebroeck }
831b7e04f8cSWim Van Sebroeck 
832fe748483SGreg Kroah-Hartman module_usb_driver(usb_pcwd_driver);
833