xref: /openbmc/linux/drivers/watchdog/pcwd_usb.c (revision 42747d712de56cf2087b702d2ad90af114c53138)
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 
27b7e04f8cSWim Van Sebroeck #include <linux/module.h>	/* For module specific items */
28b7e04f8cSWim Van Sebroeck #include <linux/moduleparam.h>	/* For new moduleparam's */
29b7e04f8cSWim Van Sebroeck #include <linux/types.h>	/* For standard types (like size_t) */
30b7e04f8cSWim Van Sebroeck #include <linux/errno.h>	/* For the -ENODEV/... values */
31b7e04f8cSWim Van Sebroeck #include <linux/kernel.h>	/* For printk/panic/... */
32b7e04f8cSWim Van Sebroeck #include <linux/delay.h>	/* For mdelay function */
33b7e04f8cSWim Van Sebroeck #include <linux/miscdevice.h>	/* For MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR) */
34b7e04f8cSWim Van Sebroeck #include <linux/watchdog.h>	/* For the watchdog specific items */
35b7e04f8cSWim Van Sebroeck #include <linux/notifier.h>	/* For notifier support */
36b7e04f8cSWim Van Sebroeck #include <linux/reboot.h>	/* For reboot_notifier stuff */
37b7e04f8cSWim Van Sebroeck #include <linux/init.h>		/* For __init/__exit/... */
38b7e04f8cSWim Van Sebroeck #include <linux/fs.h>		/* For file operations */
39b7e04f8cSWim Van Sebroeck #include <linux/usb.h>		/* For USB functions */
40b7e04f8cSWim Van Sebroeck #include <linux/slab.h>		/* For kmalloc, ... */
41b7e04f8cSWim Van Sebroeck #include <linux/mutex.h>	/* For mutex locking */
42b7e04f8cSWim Van Sebroeck #include <linux/hid.h>		/* For HID_REQ_SET_REPORT & HID_DT_REPORT */
43089ab079SWim Van Sebroeck #include <linux/uaccess.h>	/* For copy_to_user/put_user/... */
44b7e04f8cSWim Van Sebroeck 
45b7e04f8cSWim Van Sebroeck 
46b7e04f8cSWim Van Sebroeck #ifdef CONFIG_USB_DEBUG
47b7e04f8cSWim Van Sebroeck 	static int debug = 1;
48b7e04f8cSWim Van Sebroeck #else
49b7e04f8cSWim Van Sebroeck 	static int debug;
50b7e04f8cSWim Van Sebroeck #endif
51b7e04f8cSWim Van Sebroeck 
52b7e04f8cSWim Van Sebroeck /* Use our own dbg macro */
53b7e04f8cSWim Van Sebroeck #undef dbg
54143a2e54SWim Van Sebroeck #define dbg(format, arg...) \
55143a2e54SWim Van Sebroeck 	do { if (debug) printk(KERN_DEBUG PFX format "\n" , ## arg); } while (0)
56b7e04f8cSWim Van Sebroeck 
57b7e04f8cSWim Van Sebroeck /* Module and Version Information */
58b7e04f8cSWim Van Sebroeck #define DRIVER_VERSION "1.02"
59b7e04f8cSWim Van Sebroeck #define DRIVER_AUTHOR "Wim Van Sebroeck <wim@iguana.be>"
60b7e04f8cSWim Van Sebroeck #define DRIVER_DESC "Berkshire USB-PC Watchdog driver"
61b7e04f8cSWim Van Sebroeck #define DRIVER_LICENSE "GPL"
62b7e04f8cSWim Van Sebroeck #define DRIVER_NAME "pcwd_usb"
63b7e04f8cSWim Van Sebroeck #define PFX DRIVER_NAME ": "
64b7e04f8cSWim Van Sebroeck 
65b7e04f8cSWim Van Sebroeck MODULE_AUTHOR(DRIVER_AUTHOR);
66b7e04f8cSWim Van Sebroeck MODULE_DESCRIPTION(DRIVER_DESC);
67b7e04f8cSWim Van Sebroeck MODULE_LICENSE(DRIVER_LICENSE);
68b7e04f8cSWim Van Sebroeck MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);
69b7e04f8cSWim Van Sebroeck MODULE_ALIAS_MISCDEV(TEMP_MINOR);
70b7e04f8cSWim Van Sebroeck 
71b7e04f8cSWim Van Sebroeck /* Module Parameters */
72b7e04f8cSWim Van Sebroeck module_param(debug, int, 0);
73b7e04f8cSWim Van Sebroeck MODULE_PARM_DESC(debug, "Debug enabled or not");
74b7e04f8cSWim Van Sebroeck 
75143a2e54SWim Van Sebroeck #define WATCHDOG_HEARTBEAT 0	/* default heartbeat =
76143a2e54SWim Van Sebroeck 						delay-time from dip-switches */
77b7e04f8cSWim Van Sebroeck static int heartbeat = WATCHDOG_HEARTBEAT;
78b7e04f8cSWim Van Sebroeck module_param(heartbeat, int, 0);
79143a2e54SWim Van Sebroeck MODULE_PARM_DESC(heartbeat, "Watchdog heartbeat in seconds. "
80143a2e54SWim Van Sebroeck 	"(0<heartbeat<65536 or 0=delay-time from dip-switches, default="
81143a2e54SWim Van Sebroeck 				__MODULE_STRING(WATCHDOG_HEARTBEAT) ")");
82b7e04f8cSWim Van Sebroeck 
83b7e04f8cSWim Van Sebroeck static int nowayout = WATCHDOG_NOWAYOUT;
84b7e04f8cSWim Van Sebroeck module_param(nowayout, int, 0);
85143a2e54SWim Van Sebroeck MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default="
86143a2e54SWim Van Sebroeck 				__MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
87b7e04f8cSWim Van Sebroeck 
88b7e04f8cSWim Van Sebroeck /* The vendor and product id's for the USB-PC Watchdog card */
89b7e04f8cSWim Van Sebroeck #define USB_PCWD_VENDOR_ID	0x0c98
90b7e04f8cSWim Van Sebroeck #define USB_PCWD_PRODUCT_ID	0x1140
91b7e04f8cSWim Van Sebroeck 
92b7e04f8cSWim Van Sebroeck /* table of devices that work with this driver */
93b7e04f8cSWim Van Sebroeck static struct usb_device_id usb_pcwd_table[] = {
94b7e04f8cSWim Van Sebroeck 	{ USB_DEVICE(USB_PCWD_VENDOR_ID, USB_PCWD_PRODUCT_ID) },
95b7e04f8cSWim Van Sebroeck 	{ }					/* Terminating entry */
96b7e04f8cSWim Van Sebroeck };
97b7e04f8cSWim Van Sebroeck MODULE_DEVICE_TABLE(usb, usb_pcwd_table);
98b7e04f8cSWim Van Sebroeck 
99b7e04f8cSWim Van Sebroeck /* according to documentation max. time to process a command for the USB
100b7e04f8cSWim Van Sebroeck  * watchdog card is 100 or 200 ms, so we give it 250 ms to do it's job */
101b7e04f8cSWim Van Sebroeck #define USB_COMMAND_TIMEOUT	250
102b7e04f8cSWim Van Sebroeck 
103b7e04f8cSWim Van Sebroeck /* Watchdog's internal commands */
104143a2e54SWim Van Sebroeck #define CMD_READ_TEMP			0x02	/* Read Temperature;
105143a2e54SWim Van Sebroeck 							Re-trigger Watchdog */
106b7e04f8cSWim Van Sebroeck #define CMD_TRIGGER			CMD_READ_TEMP
107b7e04f8cSWim Van Sebroeck #define CMD_GET_STATUS			0x04	/* Get Status Information */
108b7e04f8cSWim Van Sebroeck #define CMD_GET_FIRMWARE_VERSION	0x08	/* Get Firmware Version */
109b7e04f8cSWim Van Sebroeck #define CMD_GET_DIP_SWITCH_SETTINGS	0x0c	/* Get Dip Switch Settings */
110b7e04f8cSWim Van Sebroeck #define CMD_READ_WATCHDOG_TIMEOUT	0x18	/* Read Current Watchdog Time */
111b7e04f8cSWim Van Sebroeck #define CMD_WRITE_WATCHDOG_TIMEOUT	0x19	/* Write Current WatchdogTime */
112b7e04f8cSWim Van Sebroeck #define CMD_ENABLE_WATCHDOG		0x30	/* Enable / Disable Watchdog */
113b7e04f8cSWim Van Sebroeck #define CMD_DISABLE_WATCHDOG		CMD_ENABLE_WATCHDOG
114b7e04f8cSWim Van Sebroeck 
115b7e04f8cSWim Van Sebroeck /* Watchdog's Dip Switch heartbeat values */
116b7e04f8cSWim Van Sebroeck static const int heartbeat_tbl[] = {
117b7e04f8cSWim Van Sebroeck 	5,	/* OFF-OFF-OFF	=  5 Sec  */
118b7e04f8cSWim Van Sebroeck 	10,	/* OFF-OFF-ON	= 10 Sec  */
119b7e04f8cSWim Van Sebroeck 	30,	/* OFF-ON-OFF	= 30 Sec  */
120b7e04f8cSWim Van Sebroeck 	60,	/* OFF-ON-ON	=  1 Min  */
121b7e04f8cSWim Van Sebroeck 	300,	/* ON-OFF-OFF	=  5 Min  */
122b7e04f8cSWim Van Sebroeck 	600,	/* ON-OFF-ON	= 10 Min  */
123b7e04f8cSWim Van Sebroeck 	1800,	/* ON-ON-OFF	= 30 Min  */
124b7e04f8cSWim Van Sebroeck 	3600,	/* ON-ON-ON	=  1 hour */
125b7e04f8cSWim Van Sebroeck };
126b7e04f8cSWim Van Sebroeck 
127b7e04f8cSWim Van Sebroeck /* We can only use 1 card due to the /dev/watchdog restriction */
128b7e04f8cSWim Van Sebroeck static int cards_found;
129b7e04f8cSWim Van Sebroeck 
130b7e04f8cSWim Van Sebroeck /* some internal variables */
131b7e04f8cSWim Van Sebroeck static unsigned long is_active;
132b7e04f8cSWim Van Sebroeck static char expect_release;
133b7e04f8cSWim Van Sebroeck 
134b7e04f8cSWim Van Sebroeck /* Structure to hold all of our device specific stuff */
135b7e04f8cSWim Van Sebroeck struct usb_pcwd_private {
136143a2e54SWim Van Sebroeck 	/* save off the usb device pointer */
137143a2e54SWim Van Sebroeck 	struct usb_device	*udev;
138143a2e54SWim Van Sebroeck 	/* the interface for this device */
139143a2e54SWim Van Sebroeck 	struct usb_interface	*interface;
140b7e04f8cSWim Van Sebroeck 
141143a2e54SWim Van Sebroeck 	/* the interface number used for cmd's */
142143a2e54SWim Van Sebroeck 	unsigned int		interface_number;
143b7e04f8cSWim Van Sebroeck 
144143a2e54SWim Van Sebroeck 	/* the buffer to intr data */
145143a2e54SWim Van Sebroeck 	unsigned char		*intr_buffer;
146143a2e54SWim Van Sebroeck 	/* the dma address for the intr buffer */
147143a2e54SWim Van Sebroeck 	dma_addr_t		intr_dma;
148143a2e54SWim Van Sebroeck 	/* the size of the intr buffer */
149143a2e54SWim Van Sebroeck 	size_t			intr_size;
150143a2e54SWim Van Sebroeck 	/* the urb used for the intr pipe */
151143a2e54SWim Van Sebroeck 	struct urb		*intr_urb;
152b7e04f8cSWim Van Sebroeck 
153143a2e54SWim Van Sebroeck 	/* The command that is reported back */
154143a2e54SWim Van Sebroeck 	unsigned char		cmd_command;
155143a2e54SWim Van Sebroeck 	/* The data MSB that is reported back */
156143a2e54SWim Van Sebroeck 	unsigned char		cmd_data_msb;
157143a2e54SWim Van Sebroeck 	/* The data LSB that is reported back */
158143a2e54SWim Van Sebroeck 	unsigned char		cmd_data_lsb;
159143a2e54SWim Van Sebroeck 	/* true if we received a report after a command */
160143a2e54SWim Van Sebroeck 	atomic_t		cmd_received;
161b7e04f8cSWim Van Sebroeck 
162143a2e54SWim Van Sebroeck 	/* Wether or not the device exists */
163143a2e54SWim Van Sebroeck 	int			exists;
164143a2e54SWim Van Sebroeck 	/* locks this structure */
165143a2e54SWim Van Sebroeck 	struct mutex		mtx;
166b7e04f8cSWim Van Sebroeck };
167b7e04f8cSWim Van Sebroeck static struct usb_pcwd_private *usb_pcwd_device;
168b7e04f8cSWim Van Sebroeck 
169b7e04f8cSWim Van Sebroeck /* prevent races between open() and disconnect() */
170b7e04f8cSWim Van Sebroeck static DEFINE_MUTEX(disconnect_mutex);
171b7e04f8cSWim Van Sebroeck 
172b7e04f8cSWim Van Sebroeck /* local function prototypes */
173143a2e54SWim Van Sebroeck static int usb_pcwd_probe(struct usb_interface *interface,
174143a2e54SWim Van Sebroeck 						const struct usb_device_id *id);
175b7e04f8cSWim Van Sebroeck static void usb_pcwd_disconnect(struct usb_interface *interface);
176b7e04f8cSWim Van Sebroeck 
177b7e04f8cSWim Van Sebroeck /* usb specific object needed to register this driver with the usb subsystem */
178b7e04f8cSWim Van Sebroeck static struct usb_driver usb_pcwd_driver = {
179b7e04f8cSWim Van Sebroeck 	.name =		DRIVER_NAME,
180b7e04f8cSWim Van Sebroeck 	.probe =	usb_pcwd_probe,
181b7e04f8cSWim Van Sebroeck 	.disconnect =	usb_pcwd_disconnect,
182b7e04f8cSWim Van Sebroeck 	.id_table =	usb_pcwd_table,
183b7e04f8cSWim Van Sebroeck };
184b7e04f8cSWim Van Sebroeck 
185b7e04f8cSWim Van Sebroeck 
186b7e04f8cSWim Van Sebroeck static void usb_pcwd_intr_done(struct urb *urb)
187b7e04f8cSWim Van Sebroeck {
188143a2e54SWim Van Sebroeck 	struct usb_pcwd_private *usb_pcwd =
189143a2e54SWim Van Sebroeck 				(struct usb_pcwd_private *)urb->context;
190b7e04f8cSWim Van Sebroeck 	unsigned char *data = usb_pcwd->intr_buffer;
191b7e04f8cSWim Van Sebroeck 	int retval;
192b7e04f8cSWim Van Sebroeck 
193b7e04f8cSWim Van Sebroeck 	switch (urb->status) {
194b7e04f8cSWim Van Sebroeck 	case 0:			/* success */
195b7e04f8cSWim Van Sebroeck 		break;
196b7e04f8cSWim Van Sebroeck 	case -ECONNRESET:	/* unlink */
197b7e04f8cSWim Van Sebroeck 	case -ENOENT:
198b7e04f8cSWim Van Sebroeck 	case -ESHUTDOWN:
199b7e04f8cSWim Van Sebroeck 		/* this urb is terminated, clean up */
200143a2e54SWim Van Sebroeck 		dbg("%s - urb shutting down with status: %d", __func__,
201143a2e54SWim Van Sebroeck 								urb->status);
202b7e04f8cSWim Van Sebroeck 		return;
203b7e04f8cSWim Van Sebroeck 	/* -EPIPE:  should clear the halt */
204b7e04f8cSWim Van Sebroeck 	default:		/* error */
205143a2e54SWim Van Sebroeck 		dbg("%s - nonzero urb status received: %d", __func__,
206143a2e54SWim Van Sebroeck 								urb->status);
207b7e04f8cSWim Van Sebroeck 		goto resubmit;
208b7e04f8cSWim Van Sebroeck 	}
209b7e04f8cSWim Van Sebroeck 
210b7e04f8cSWim Van Sebroeck 	dbg("received following data cmd=0x%02x msb=0x%02x lsb=0x%02x",
211b7e04f8cSWim Van Sebroeck 		data[0], data[1], data[2]);
212b7e04f8cSWim Van Sebroeck 
213b7e04f8cSWim Van Sebroeck 	usb_pcwd->cmd_command  = data[0];
214b7e04f8cSWim Van Sebroeck 	usb_pcwd->cmd_data_msb = data[1];
215b7e04f8cSWim Van Sebroeck 	usb_pcwd->cmd_data_lsb = data[2];
216b7e04f8cSWim Van Sebroeck 
217b7e04f8cSWim Van Sebroeck 	/* notify anyone waiting that the cmd has finished */
218b7e04f8cSWim Van Sebroeck 	atomic_set(&usb_pcwd->cmd_received, 1);
219b7e04f8cSWim Van Sebroeck 
220b7e04f8cSWim Van Sebroeck resubmit:
221b7e04f8cSWim Van Sebroeck 	retval = usb_submit_urb(urb, GFP_ATOMIC);
222b7e04f8cSWim Van Sebroeck 	if (retval)
223143a2e54SWim Van Sebroeck 		printk(KERN_ERR PFX "can't resubmit intr, "
224143a2e54SWim Van Sebroeck 			"usb_submit_urb failed with result %d\n", retval);
225b7e04f8cSWim Van Sebroeck }
226b7e04f8cSWim Van Sebroeck 
227143a2e54SWim Van Sebroeck static int usb_pcwd_send_command(struct usb_pcwd_private *usb_pcwd,
228143a2e54SWim Van Sebroeck 		unsigned char cmd, unsigned char *msb, unsigned char *lsb)
229b7e04f8cSWim Van Sebroeck {
230b7e04f8cSWim Van Sebroeck 	int got_response, count;
231b7e04f8cSWim Van Sebroeck 	unsigned char buf[6];
232b7e04f8cSWim Van Sebroeck 
233143a2e54SWim Van Sebroeck 	/* We will not send any commands if the USB PCWD device does
234143a2e54SWim Van Sebroeck 	 * not exist */
235b7e04f8cSWim Van Sebroeck 	if ((!usb_pcwd) || (!usb_pcwd->exists))
236b7e04f8cSWim Van Sebroeck 		return -1;
237b7e04f8cSWim Van Sebroeck 
238143a2e54SWim Van Sebroeck 	/* The USB PC Watchdog uses a 6 byte report format.
239143a2e54SWim Van Sebroeck 	 * The board currently uses only 3 of the six bytes of the report. */
240b7e04f8cSWim Van Sebroeck 	buf[0] = cmd;			/* Byte 0 = CMD */
241b7e04f8cSWim Van Sebroeck 	buf[1] = *msb;			/* Byte 1 = Data MSB */
242b7e04f8cSWim Van Sebroeck 	buf[2] = *lsb;			/* Byte 2 = Data LSB */
243b7e04f8cSWim Van Sebroeck 	buf[3] = buf[4] = buf[5] = 0;	/* All other bytes not used */
244b7e04f8cSWim Van Sebroeck 
245b7e04f8cSWim Van Sebroeck 	dbg("sending following data cmd=0x%02x msb=0x%02x lsb=0x%02x",
246b7e04f8cSWim Van Sebroeck 		buf[0], buf[1], buf[2]);
247b7e04f8cSWim Van Sebroeck 
248b7e04f8cSWim Van Sebroeck 	atomic_set(&usb_pcwd->cmd_received, 0);
249b7e04f8cSWim Van Sebroeck 
250b7e04f8cSWim Van Sebroeck 	if (usb_control_msg(usb_pcwd->udev, usb_sndctrlpipe(usb_pcwd->udev, 0),
251b7e04f8cSWim Van Sebroeck 			HID_REQ_SET_REPORT, HID_DT_REPORT,
252b7e04f8cSWim Van Sebroeck 			0x0200, usb_pcwd->interface_number, buf, sizeof(buf),
253b7e04f8cSWim Van Sebroeck 			USB_COMMAND_TIMEOUT) != sizeof(buf)) {
254143a2e54SWim Van Sebroeck 		dbg("usb_pcwd_send_command: error in usb_control_msg for "
255143a2e54SWim Van Sebroeck 				"cmd 0x%x 0x%x 0x%x\n", cmd, *msb, *lsb);
256b7e04f8cSWim Van Sebroeck 	}
257b7e04f8cSWim Van Sebroeck 	/* wait till the usb card processed the command,
258b7e04f8cSWim Van Sebroeck 	 * with a max. timeout of USB_COMMAND_TIMEOUT */
259b7e04f8cSWim Van Sebroeck 	got_response = 0;
260143a2e54SWim Van Sebroeck 	for (count = 0; (count < USB_COMMAND_TIMEOUT) && (!got_response);
261143a2e54SWim Van Sebroeck 								count++) {
262b7e04f8cSWim Van Sebroeck 		mdelay(1);
263b7e04f8cSWim Van Sebroeck 		if (atomic_read(&usb_pcwd->cmd_received))
264b7e04f8cSWim Van Sebroeck 			got_response = 1;
265b7e04f8cSWim Van Sebroeck 	}
266b7e04f8cSWim Van Sebroeck 
267b7e04f8cSWim Van Sebroeck 	if ((got_response) && (cmd == usb_pcwd->cmd_command)) {
268b7e04f8cSWim Van Sebroeck 		/* read back response */
269b7e04f8cSWim Van Sebroeck 		*msb = usb_pcwd->cmd_data_msb;
270b7e04f8cSWim Van Sebroeck 		*lsb = usb_pcwd->cmd_data_lsb;
271b7e04f8cSWim Van Sebroeck 	}
272b7e04f8cSWim Van Sebroeck 
273b7e04f8cSWim Van Sebroeck 	return got_response;
274b7e04f8cSWim Van Sebroeck }
275b7e04f8cSWim Van Sebroeck 
276b7e04f8cSWim Van Sebroeck static int usb_pcwd_start(struct usb_pcwd_private *usb_pcwd)
277b7e04f8cSWim Van Sebroeck {
278b7e04f8cSWim Van Sebroeck 	unsigned char msb = 0x00;
279b7e04f8cSWim Van Sebroeck 	unsigned char lsb = 0x00;
280b7e04f8cSWim Van Sebroeck 	int retval;
281b7e04f8cSWim Van Sebroeck 
282b7e04f8cSWim Van Sebroeck 	/* Enable Watchdog */
283143a2e54SWim Van Sebroeck 	retval = usb_pcwd_send_command(usb_pcwd, CMD_ENABLE_WATCHDOG,
284143a2e54SWim Van Sebroeck 								&msb, &lsb);
285b7e04f8cSWim Van Sebroeck 
286b7e04f8cSWim Van Sebroeck 	if ((retval == 0) || (lsb == 0)) {
287143a2e54SWim Van Sebroeck 		printk(KERN_ERR PFX
288143a2e54SWim Van Sebroeck 				"Card did not acknowledge enable attempt\n");
289b7e04f8cSWim Van Sebroeck 		return -1;
290b7e04f8cSWim Van Sebroeck 	}
291b7e04f8cSWim Van Sebroeck 
292b7e04f8cSWim Van Sebroeck 	return 0;
293b7e04f8cSWim Van Sebroeck }
294b7e04f8cSWim Van Sebroeck 
295b7e04f8cSWim Van Sebroeck static int usb_pcwd_stop(struct usb_pcwd_private *usb_pcwd)
296b7e04f8cSWim Van Sebroeck {
297b7e04f8cSWim Van Sebroeck 	unsigned char msb = 0xA5;
298b7e04f8cSWim Van Sebroeck 	unsigned char lsb = 0xC3;
299b7e04f8cSWim Van Sebroeck 	int retval;
300b7e04f8cSWim Van Sebroeck 
301b7e04f8cSWim Van Sebroeck 	/* Disable Watchdog */
302143a2e54SWim Van Sebroeck 	retval = usb_pcwd_send_command(usb_pcwd, CMD_DISABLE_WATCHDOG,
303143a2e54SWim Van Sebroeck 								&msb, &lsb);
304b7e04f8cSWim Van Sebroeck 
305b7e04f8cSWim Van Sebroeck 	if ((retval == 0) || (lsb != 0)) {
306143a2e54SWim Van Sebroeck 		printk(KERN_ERR PFX
307143a2e54SWim Van Sebroeck 			"Card did not acknowledge disable attempt\n");
308b7e04f8cSWim Van Sebroeck 		return -1;
309b7e04f8cSWim Van Sebroeck 	}
310b7e04f8cSWim Van Sebroeck 
311b7e04f8cSWim Van Sebroeck 	return 0;
312b7e04f8cSWim Van Sebroeck }
313b7e04f8cSWim Van Sebroeck 
314b7e04f8cSWim Van Sebroeck static int usb_pcwd_keepalive(struct usb_pcwd_private *usb_pcwd)
315b7e04f8cSWim Van Sebroeck {
316b7e04f8cSWim Van Sebroeck 	unsigned char dummy;
317b7e04f8cSWim Van Sebroeck 
318b7e04f8cSWim Van Sebroeck 	/* Re-trigger Watchdog */
319b7e04f8cSWim Van Sebroeck 	usb_pcwd_send_command(usb_pcwd, CMD_TRIGGER, &dummy, &dummy);
320b7e04f8cSWim Van Sebroeck 
321b7e04f8cSWim Van Sebroeck 	return 0;
322b7e04f8cSWim Van Sebroeck }
323b7e04f8cSWim Van Sebroeck 
324b7e04f8cSWim Van Sebroeck static int usb_pcwd_set_heartbeat(struct usb_pcwd_private *usb_pcwd, int t)
325b7e04f8cSWim Van Sebroeck {
326b7e04f8cSWim Van Sebroeck 	unsigned char msb = t / 256;
327b7e04f8cSWim Van Sebroeck 	unsigned char lsb = t % 256;
328b7e04f8cSWim Van Sebroeck 
329b7e04f8cSWim Van Sebroeck 	if ((t < 0x0001) || (t > 0xFFFF))
330b7e04f8cSWim Van Sebroeck 		return -EINVAL;
331b7e04f8cSWim Van Sebroeck 
332b7e04f8cSWim Van Sebroeck 	/* Write new heartbeat to watchdog */
333b7e04f8cSWim Van Sebroeck 	usb_pcwd_send_command(usb_pcwd, CMD_WRITE_WATCHDOG_TIMEOUT, &msb, &lsb);
334b7e04f8cSWim Van Sebroeck 
335b7e04f8cSWim Van Sebroeck 	heartbeat = t;
336b7e04f8cSWim Van Sebroeck 	return 0;
337b7e04f8cSWim Van Sebroeck }
338b7e04f8cSWim Van Sebroeck 
339143a2e54SWim Van Sebroeck static int usb_pcwd_get_temperature(struct usb_pcwd_private *usb_pcwd,
340143a2e54SWim Van Sebroeck 							int *temperature)
341b7e04f8cSWim Van Sebroeck {
342b7e04f8cSWim Van Sebroeck 	unsigned char msb, lsb;
343b7e04f8cSWim Van Sebroeck 
344b7e04f8cSWim Van Sebroeck 	usb_pcwd_send_command(usb_pcwd, CMD_READ_TEMP, &msb, &lsb);
345b7e04f8cSWim Van Sebroeck 
346b7e04f8cSWim Van Sebroeck 	/*
347b7e04f8cSWim Van Sebroeck 	 * Convert celsius to fahrenheit, since this was
348b7e04f8cSWim Van Sebroeck 	 * the decided 'standard' for this return value.
349b7e04f8cSWim Van Sebroeck 	 */
350b7e04f8cSWim Van Sebroeck 	*temperature = (lsb * 9 / 5) + 32;
351b7e04f8cSWim Van Sebroeck 
352b7e04f8cSWim Van Sebroeck 	return 0;
353b7e04f8cSWim Van Sebroeck }
354b7e04f8cSWim Van Sebroeck 
355143a2e54SWim Van Sebroeck static int usb_pcwd_get_timeleft(struct usb_pcwd_private *usb_pcwd,
356143a2e54SWim Van Sebroeck 								int *time_left)
357b7e04f8cSWim Van Sebroeck {
358b7e04f8cSWim Van Sebroeck 	unsigned char msb, lsb;
359b7e04f8cSWim Van Sebroeck 
360b7e04f8cSWim Van Sebroeck 	/* Read the time that's left before rebooting */
361b7e04f8cSWim Van Sebroeck 	/* Note: if the board is not yet armed then we will read 0xFFFF */
362b7e04f8cSWim Van Sebroeck 	usb_pcwd_send_command(usb_pcwd, CMD_READ_WATCHDOG_TIMEOUT, &msb, &lsb);
363b7e04f8cSWim Van Sebroeck 
364b7e04f8cSWim Van Sebroeck 	*time_left = (msb << 8) + lsb;
365b7e04f8cSWim Van Sebroeck 
366b7e04f8cSWim Van Sebroeck 	return 0;
367b7e04f8cSWim Van Sebroeck }
368b7e04f8cSWim Van Sebroeck 
369b7e04f8cSWim Van Sebroeck /*
370b7e04f8cSWim Van Sebroeck  *	/dev/watchdog handling
371b7e04f8cSWim Van Sebroeck  */
372b7e04f8cSWim Van Sebroeck 
373b7e04f8cSWim Van Sebroeck static ssize_t usb_pcwd_write(struct file *file, const char __user *data,
374b7e04f8cSWim Van Sebroeck 						size_t len, loff_t *ppos)
375b7e04f8cSWim Van Sebroeck {
376b7e04f8cSWim Van Sebroeck 	/* See if we got the magic character 'V' and reload the timer */
377b7e04f8cSWim Van Sebroeck 	if (len) {
378b7e04f8cSWim Van Sebroeck 		if (!nowayout) {
379b7e04f8cSWim Van Sebroeck 			size_t i;
380b7e04f8cSWim Van Sebroeck 
381b7e04f8cSWim Van Sebroeck 			/* note: just in case someone wrote the magic character
382b7e04f8cSWim Van Sebroeck 			 * five months ago... */
383b7e04f8cSWim Van Sebroeck 			expect_release = 0;
384b7e04f8cSWim Van Sebroeck 
385143a2e54SWim Van Sebroeck 			/* scan to see whether or not we got the
386143a2e54SWim Van Sebroeck 			 * magic character */
387b7e04f8cSWim Van Sebroeck 			for (i = 0; i != len; i++) {
388b7e04f8cSWim Van Sebroeck 				char c;
389b7e04f8cSWim Van Sebroeck 				if (get_user(c, data + i))
390b7e04f8cSWim Van Sebroeck 					return -EFAULT;
391b7e04f8cSWim Van Sebroeck 				if (c == 'V')
392b7e04f8cSWim Van Sebroeck 					expect_release = 42;
393b7e04f8cSWim Van Sebroeck 			}
394b7e04f8cSWim Van Sebroeck 		}
395b7e04f8cSWim Van Sebroeck 
396b7e04f8cSWim Van Sebroeck 		/* someone wrote to us, we should reload the timer */
397b7e04f8cSWim Van Sebroeck 		usb_pcwd_keepalive(usb_pcwd_device);
398b7e04f8cSWim Van Sebroeck 	}
399b7e04f8cSWim Van Sebroeck 	return len;
400b7e04f8cSWim Van Sebroeck }
401b7e04f8cSWim Van Sebroeck 
402c9488520SAlan Cox static long usb_pcwd_ioctl(struct file *file, unsigned int cmd,
403c9488520SAlan Cox 						unsigned long arg)
404b7e04f8cSWim Van Sebroeck {
405b7e04f8cSWim Van Sebroeck 	void __user *argp = (void __user *)arg;
406b7e04f8cSWim Van Sebroeck 	int __user *p = argp;
407*42747d71SWim Van Sebroeck 	static const struct watchdog_info ident = {
408b7e04f8cSWim Van Sebroeck 		.options =		WDIOF_KEEPALIVEPING |
409b7e04f8cSWim Van Sebroeck 					WDIOF_SETTIMEOUT |
410b7e04f8cSWim Van Sebroeck 					WDIOF_MAGICCLOSE,
411b7e04f8cSWim Van Sebroeck 		.firmware_version =	1,
412b7e04f8cSWim Van Sebroeck 		.identity =		DRIVER_NAME,
413b7e04f8cSWim Van Sebroeck 	};
414b7e04f8cSWim Van Sebroeck 
415b7e04f8cSWim Van Sebroeck 	switch (cmd) {
416b7e04f8cSWim Van Sebroeck 	case WDIOC_GETSUPPORT:
4177944d3a5SWim Van Sebroeck 		return copy_to_user(argp, &ident, sizeof(ident)) ? -EFAULT : 0;
418b7e04f8cSWim Van Sebroeck 
419b7e04f8cSWim Van Sebroeck 	case WDIOC_GETSTATUS:
420b7e04f8cSWim Van Sebroeck 	case WDIOC_GETBOOTSTATUS:
421b7e04f8cSWim Van Sebroeck 		return put_user(0, p);
422b7e04f8cSWim Van Sebroeck 
423b7e04f8cSWim Van Sebroeck 	case WDIOC_GETTEMP:
424b7e04f8cSWim Van Sebroeck 	{
425b7e04f8cSWim Van Sebroeck 		int temperature;
426b7e04f8cSWim Van Sebroeck 
427b7e04f8cSWim Van Sebroeck 		if (usb_pcwd_get_temperature(usb_pcwd_device, &temperature))
428b7e04f8cSWim Van Sebroeck 			return -EFAULT;
429b7e04f8cSWim Van Sebroeck 
430b7e04f8cSWim Van Sebroeck 		return put_user(temperature, p);
431b7e04f8cSWim Van Sebroeck 	}
432b7e04f8cSWim Van Sebroeck 
433b7e04f8cSWim Van Sebroeck 	case WDIOC_SETOPTIONS:
434b7e04f8cSWim Van Sebroeck 	{
435b7e04f8cSWim Van Sebroeck 		int new_options, retval = -EINVAL;
436b7e04f8cSWim Van Sebroeck 
437b7e04f8cSWim Van Sebroeck 		if (get_user(new_options, p))
438b7e04f8cSWim Van Sebroeck 			return -EFAULT;
439b7e04f8cSWim Van Sebroeck 
440b7e04f8cSWim Van Sebroeck 		if (new_options & WDIOS_DISABLECARD) {
441b7e04f8cSWim Van Sebroeck 			usb_pcwd_stop(usb_pcwd_device);
442b7e04f8cSWim Van Sebroeck 			retval = 0;
443b7e04f8cSWim Van Sebroeck 		}
444b7e04f8cSWim Van Sebroeck 
445b7e04f8cSWim Van Sebroeck 		if (new_options & WDIOS_ENABLECARD) {
446b7e04f8cSWim Van Sebroeck 			usb_pcwd_start(usb_pcwd_device);
447b7e04f8cSWim Van Sebroeck 			retval = 0;
448b7e04f8cSWim Van Sebroeck 		}
449b7e04f8cSWim Van Sebroeck 
450b7e04f8cSWim Van Sebroeck 		return retval;
451b7e04f8cSWim Van Sebroeck 	}
452b7e04f8cSWim Van Sebroeck 
4530c06090cSWim Van Sebroeck 	case WDIOC_KEEPALIVE:
4540c06090cSWim Van Sebroeck 		usb_pcwd_keepalive(usb_pcwd_device);
4550c06090cSWim Van Sebroeck 		return 0;
4560c06090cSWim Van Sebroeck 
457b7e04f8cSWim Van Sebroeck 	case WDIOC_SETTIMEOUT:
458b7e04f8cSWim Van Sebroeck 	{
459b7e04f8cSWim Van Sebroeck 		int new_heartbeat;
460b7e04f8cSWim Van Sebroeck 
461b7e04f8cSWim Van Sebroeck 		if (get_user(new_heartbeat, p))
462b7e04f8cSWim Van Sebroeck 			return -EFAULT;
463b7e04f8cSWim Van Sebroeck 
464b7e04f8cSWim Van Sebroeck 		if (usb_pcwd_set_heartbeat(usb_pcwd_device, new_heartbeat))
465b7e04f8cSWim Van Sebroeck 			return -EINVAL;
466b7e04f8cSWim Van Sebroeck 
467b7e04f8cSWim Van Sebroeck 		usb_pcwd_keepalive(usb_pcwd_device);
468b7e04f8cSWim Van Sebroeck 		/* Fall */
469b7e04f8cSWim Van Sebroeck 	}
470b7e04f8cSWim Van Sebroeck 
471b7e04f8cSWim Van Sebroeck 	case WDIOC_GETTIMEOUT:
472b7e04f8cSWim Van Sebroeck 		return put_user(heartbeat, p);
473b7e04f8cSWim Van Sebroeck 
474b7e04f8cSWim Van Sebroeck 	case WDIOC_GETTIMELEFT:
475b7e04f8cSWim Van Sebroeck 	{
476b7e04f8cSWim Van Sebroeck 		int time_left;
477b7e04f8cSWim Van Sebroeck 
478b7e04f8cSWim Van Sebroeck 		if (usb_pcwd_get_timeleft(usb_pcwd_device, &time_left))
479b7e04f8cSWim Van Sebroeck 			return -EFAULT;
480b7e04f8cSWim Van Sebroeck 
481b7e04f8cSWim Van Sebroeck 		return put_user(time_left, p);
482b7e04f8cSWim Van Sebroeck 	}
483b7e04f8cSWim Van Sebroeck 
484b7e04f8cSWim Van Sebroeck 	default:
485b7e04f8cSWim Van Sebroeck 		return -ENOTTY;
486b7e04f8cSWim Van Sebroeck 	}
487b7e04f8cSWim Van Sebroeck }
488b7e04f8cSWim Van Sebroeck 
489b7e04f8cSWim Van Sebroeck static int usb_pcwd_open(struct inode *inode, struct file *file)
490b7e04f8cSWim Van Sebroeck {
491b7e04f8cSWim Van Sebroeck 	/* /dev/watchdog can only be opened once */
492b7e04f8cSWim Van Sebroeck 	if (test_and_set_bit(0, &is_active))
493b7e04f8cSWim Van Sebroeck 		return -EBUSY;
494b7e04f8cSWim Van Sebroeck 
495b7e04f8cSWim Van Sebroeck 	/* Activate */
496b7e04f8cSWim Van Sebroeck 	usb_pcwd_start(usb_pcwd_device);
497b7e04f8cSWim Van Sebroeck 	usb_pcwd_keepalive(usb_pcwd_device);
498b7e04f8cSWim Van Sebroeck 	return nonseekable_open(inode, file);
499b7e04f8cSWim Van Sebroeck }
500b7e04f8cSWim Van Sebroeck 
501b7e04f8cSWim Van Sebroeck static int usb_pcwd_release(struct inode *inode, struct file *file)
502b7e04f8cSWim Van Sebroeck {
503b7e04f8cSWim Van Sebroeck 	/*
504b7e04f8cSWim Van Sebroeck 	 *      Shut off the timer.
505b7e04f8cSWim Van Sebroeck 	 */
506b7e04f8cSWim Van Sebroeck 	if (expect_release == 42) {
507b7e04f8cSWim Van Sebroeck 		usb_pcwd_stop(usb_pcwd_device);
508b7e04f8cSWim Van Sebroeck 	} else {
509143a2e54SWim Van Sebroeck 		printk(KERN_CRIT PFX
510143a2e54SWim Van Sebroeck 			"Unexpected close, not stopping watchdog!\n");
511b7e04f8cSWim Van Sebroeck 		usb_pcwd_keepalive(usb_pcwd_device);
512b7e04f8cSWim Van Sebroeck 	}
513b7e04f8cSWim Van Sebroeck 	expect_release = 0;
514b7e04f8cSWim Van Sebroeck 	clear_bit(0, &is_active);
515b7e04f8cSWim Van Sebroeck 	return 0;
516b7e04f8cSWim Van Sebroeck }
517b7e04f8cSWim Van Sebroeck 
518b7e04f8cSWim Van Sebroeck /*
519b7e04f8cSWim Van Sebroeck  *	/dev/temperature handling
520b7e04f8cSWim Van Sebroeck  */
521b7e04f8cSWim Van Sebroeck 
522b7e04f8cSWim Van Sebroeck static ssize_t usb_pcwd_temperature_read(struct file *file, char __user *data,
523b7e04f8cSWim Van Sebroeck 				size_t len, loff_t *ppos)
524b7e04f8cSWim Van Sebroeck {
525b7e04f8cSWim Van Sebroeck 	int temperature;
526b7e04f8cSWim Van Sebroeck 
527b7e04f8cSWim Van Sebroeck 	if (usb_pcwd_get_temperature(usb_pcwd_device, &temperature))
528b7e04f8cSWim Van Sebroeck 		return -EFAULT;
529b7e04f8cSWim Van Sebroeck 
530b7e04f8cSWim Van Sebroeck 	if (copy_to_user(data, &temperature, 1))
531b7e04f8cSWim Van Sebroeck 		return -EFAULT;
532b7e04f8cSWim Van Sebroeck 
533b7e04f8cSWim Van Sebroeck 	return 1;
534b7e04f8cSWim Van Sebroeck }
535b7e04f8cSWim Van Sebroeck 
536b7e04f8cSWim Van Sebroeck static int usb_pcwd_temperature_open(struct inode *inode, struct file *file)
537b7e04f8cSWim Van Sebroeck {
538b7e04f8cSWim Van Sebroeck 	return nonseekable_open(inode, file);
539b7e04f8cSWim Van Sebroeck }
540b7e04f8cSWim Van Sebroeck 
541b7e04f8cSWim Van Sebroeck static int usb_pcwd_temperature_release(struct inode *inode, struct file *file)
542b7e04f8cSWim Van Sebroeck {
543b7e04f8cSWim Van Sebroeck 	return 0;
544b7e04f8cSWim Van Sebroeck }
545b7e04f8cSWim Van Sebroeck 
546b7e04f8cSWim Van Sebroeck /*
547b7e04f8cSWim Van Sebroeck  *	Notify system
548b7e04f8cSWim Van Sebroeck  */
549b7e04f8cSWim Van Sebroeck 
550143a2e54SWim Van Sebroeck static int usb_pcwd_notify_sys(struct notifier_block *this, unsigned long code,
551143a2e54SWim Van Sebroeck 								void *unused)
552b7e04f8cSWim Van Sebroeck {
5537944d3a5SWim Van Sebroeck 	if (code == SYS_DOWN || code == SYS_HALT)
5547944d3a5SWim Van Sebroeck 		usb_pcwd_stop(usb_pcwd_device);	/* Turn the WDT off */
555b7e04f8cSWim Van Sebroeck 
556b7e04f8cSWim Van Sebroeck 	return NOTIFY_DONE;
557b7e04f8cSWim Van Sebroeck }
558b7e04f8cSWim Van Sebroeck 
559b7e04f8cSWim Van Sebroeck /*
560b7e04f8cSWim Van Sebroeck  *	Kernel Interfaces
561b7e04f8cSWim Van Sebroeck  */
562b7e04f8cSWim Van Sebroeck 
563b7e04f8cSWim Van Sebroeck static const struct file_operations usb_pcwd_fops = {
564b7e04f8cSWim Van Sebroeck 	.owner =	THIS_MODULE,
565b7e04f8cSWim Van Sebroeck 	.llseek =	no_llseek,
566b7e04f8cSWim Van Sebroeck 	.write =	usb_pcwd_write,
567c9488520SAlan Cox 	.unlocked_ioctl = usb_pcwd_ioctl,
568b7e04f8cSWim Van Sebroeck 	.open =		usb_pcwd_open,
569b7e04f8cSWim Van Sebroeck 	.release =	usb_pcwd_release,
570b7e04f8cSWim Van Sebroeck };
571b7e04f8cSWim Van Sebroeck 
572b7e04f8cSWim Van Sebroeck static struct miscdevice usb_pcwd_miscdev = {
573b7e04f8cSWim Van Sebroeck 	.minor =	WATCHDOG_MINOR,
574b7e04f8cSWim Van Sebroeck 	.name =		"watchdog",
575b7e04f8cSWim Van Sebroeck 	.fops =		&usb_pcwd_fops,
576b7e04f8cSWim Van Sebroeck };
577b7e04f8cSWim Van Sebroeck 
578b7e04f8cSWim Van Sebroeck static const struct file_operations usb_pcwd_temperature_fops = {
579b7e04f8cSWim Van Sebroeck 	.owner =	THIS_MODULE,
580b7e04f8cSWim Van Sebroeck 	.llseek =	no_llseek,
581b7e04f8cSWim Van Sebroeck 	.read =		usb_pcwd_temperature_read,
582b7e04f8cSWim Van Sebroeck 	.open =		usb_pcwd_temperature_open,
583b7e04f8cSWim Van Sebroeck 	.release =	usb_pcwd_temperature_release,
584b7e04f8cSWim Van Sebroeck };
585b7e04f8cSWim Van Sebroeck 
586b7e04f8cSWim Van Sebroeck static struct miscdevice usb_pcwd_temperature_miscdev = {
587b7e04f8cSWim Van Sebroeck 	.minor =	TEMP_MINOR,
588b7e04f8cSWim Van Sebroeck 	.name =		"temperature",
589b7e04f8cSWim Van Sebroeck 	.fops =		&usb_pcwd_temperature_fops,
590b7e04f8cSWim Van Sebroeck };
591b7e04f8cSWim Van Sebroeck 
592b7e04f8cSWim Van Sebroeck static struct notifier_block usb_pcwd_notifier = {
593b7e04f8cSWim Van Sebroeck 	.notifier_call =	usb_pcwd_notify_sys,
594b7e04f8cSWim Van Sebroeck };
595b7e04f8cSWim Van Sebroeck 
596b7e04f8cSWim Van Sebroeck /**
597b7e04f8cSWim Van Sebroeck  *	usb_pcwd_delete
598b7e04f8cSWim Van Sebroeck  */
599b7e04f8cSWim Van Sebroeck static inline void usb_pcwd_delete(struct usb_pcwd_private *usb_pcwd)
600b7e04f8cSWim Van Sebroeck {
601b7e04f8cSWim Van Sebroeck 	usb_free_urb(usb_pcwd->intr_urb);
602b7e04f8cSWim Van Sebroeck 	if (usb_pcwd->intr_buffer != NULL)
603b7e04f8cSWim Van Sebroeck 		usb_buffer_free(usb_pcwd->udev, usb_pcwd->intr_size,
604b7e04f8cSWim Van Sebroeck 				usb_pcwd->intr_buffer, usb_pcwd->intr_dma);
605b7e04f8cSWim Van Sebroeck 	kfree(usb_pcwd);
606b7e04f8cSWim Van Sebroeck }
607b7e04f8cSWim Van Sebroeck 
608b7e04f8cSWim Van Sebroeck /**
609b7e04f8cSWim Van Sebroeck  *	usb_pcwd_probe
610b7e04f8cSWim Van Sebroeck  *
611b7e04f8cSWim Van Sebroeck  *	Called by the usb core when a new device is connected that it thinks
612b7e04f8cSWim Van Sebroeck  *	this driver might be interested in.
613b7e04f8cSWim Van Sebroeck  */
614143a2e54SWim Van Sebroeck static int usb_pcwd_probe(struct usb_interface *interface,
615143a2e54SWim Van Sebroeck 						const struct usb_device_id *id)
616b7e04f8cSWim Van Sebroeck {
617b7e04f8cSWim Van Sebroeck 	struct usb_device *udev = interface_to_usbdev(interface);
618b7e04f8cSWim Van Sebroeck 	struct usb_host_interface *iface_desc;
619b7e04f8cSWim Van Sebroeck 	struct usb_endpoint_descriptor *endpoint;
620b7e04f8cSWim Van Sebroeck 	struct usb_pcwd_private *usb_pcwd = NULL;
621b7e04f8cSWim Van Sebroeck 	int pipe, maxp;
622b7e04f8cSWim Van Sebroeck 	int retval = -ENOMEM;
623b7e04f8cSWim Van Sebroeck 	int got_fw_rev;
624b7e04f8cSWim Van Sebroeck 	unsigned char fw_rev_major, fw_rev_minor;
625b7e04f8cSWim Van Sebroeck 	char fw_ver_str[20];
626b7e04f8cSWim Van Sebroeck 	unsigned char option_switches, dummy;
627b7e04f8cSWim Van Sebroeck 
628b7e04f8cSWim Van Sebroeck 	cards_found++;
629b7e04f8cSWim Van Sebroeck 	if (cards_found > 1) {
630b7e04f8cSWim Van Sebroeck 		printk(KERN_ERR PFX "This driver only supports 1 device\n");
631b7e04f8cSWim Van Sebroeck 		return -ENODEV;
632b7e04f8cSWim Van Sebroeck 	}
633b7e04f8cSWim Van Sebroeck 
634b7e04f8cSWim Van Sebroeck 	/* get the active interface descriptor */
635b7e04f8cSWim Van Sebroeck 	iface_desc = interface->cur_altsetting;
636b7e04f8cSWim Van Sebroeck 
637b7e04f8cSWim Van Sebroeck 	/* check out that we have a HID device */
638b7e04f8cSWim Van Sebroeck 	if (!(iface_desc->desc.bInterfaceClass == USB_CLASS_HID)) {
639143a2e54SWim Van Sebroeck 		printk(KERN_ERR PFX
640143a2e54SWim Van Sebroeck 			"The device isn't a Human Interface Device\n");
641b7e04f8cSWim Van Sebroeck 		return -ENODEV;
642b7e04f8cSWim Van Sebroeck 	}
643b7e04f8cSWim Van Sebroeck 
644b7e04f8cSWim Van Sebroeck 	/* check out the endpoint: it has to be Interrupt & IN */
645b7e04f8cSWim Van Sebroeck 	endpoint = &iface_desc->endpoint[0].desc;
646b7e04f8cSWim Van Sebroeck 
6472855d28aSJulia Lawall 	if (!usb_endpoint_is_int_in(endpoint)) {
648b7e04f8cSWim Van Sebroeck 		/* we didn't find a Interrupt endpoint with direction IN */
649b7e04f8cSWim Van Sebroeck 		printk(KERN_ERR PFX "Couldn't find an INTR & IN endpoint\n");
650b7e04f8cSWim Van Sebroeck 		return -ENODEV;
651b7e04f8cSWim Van Sebroeck 	}
652b7e04f8cSWim Van Sebroeck 
653b7e04f8cSWim Van Sebroeck 	/* get a handle to the interrupt data pipe */
654b7e04f8cSWim Van Sebroeck 	pipe = usb_rcvintpipe(udev, endpoint->bEndpointAddress);
655b7e04f8cSWim Van Sebroeck 	maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
656b7e04f8cSWim Van Sebroeck 
657b7e04f8cSWim Van Sebroeck 	/* allocate memory for our device and initialize it */
658b7e04f8cSWim Van Sebroeck 	usb_pcwd = kzalloc(sizeof(struct usb_pcwd_private), GFP_KERNEL);
659b7e04f8cSWim Van Sebroeck 	if (usb_pcwd == NULL) {
660b7e04f8cSWim Van Sebroeck 		printk(KERN_ERR PFX "Out of memory\n");
661b7e04f8cSWim Van Sebroeck 		goto error;
662b7e04f8cSWim Van Sebroeck 	}
663b7e04f8cSWim Van Sebroeck 
664b7e04f8cSWim Van Sebroeck 	usb_pcwd_device = usb_pcwd;
665b7e04f8cSWim Van Sebroeck 
666b7e04f8cSWim Van Sebroeck 	mutex_init(&usb_pcwd->mtx);
667b7e04f8cSWim Van Sebroeck 	usb_pcwd->udev = udev;
668b7e04f8cSWim Van Sebroeck 	usb_pcwd->interface = interface;
669b7e04f8cSWim Van Sebroeck 	usb_pcwd->interface_number = iface_desc->desc.bInterfaceNumber;
670143a2e54SWim Van Sebroeck 	usb_pcwd->intr_size = (le16_to_cpu(endpoint->wMaxPacketSize) > 8 ?
671143a2e54SWim Van Sebroeck 				le16_to_cpu(endpoint->wMaxPacketSize) : 8);
672b7e04f8cSWim Van Sebroeck 
673b7e04f8cSWim Van Sebroeck 	/* set up the memory buffer's */
674143a2e54SWim Van Sebroeck 	usb_pcwd->intr_buffer = usb_buffer_alloc(udev, usb_pcwd->intr_size,
675143a2e54SWim Van Sebroeck 					GFP_ATOMIC, &usb_pcwd->intr_dma);
6767944d3a5SWim Van Sebroeck 	if (!usb_pcwd->intr_buffer) {
677b7e04f8cSWim Van Sebroeck 		printk(KERN_ERR PFX "Out of memory\n");
678b7e04f8cSWim Van Sebroeck 		goto error;
679b7e04f8cSWim Van Sebroeck 	}
680b7e04f8cSWim Van Sebroeck 
681b7e04f8cSWim Van Sebroeck 	/* allocate the urb's */
682b7e04f8cSWim Van Sebroeck 	usb_pcwd->intr_urb = usb_alloc_urb(0, GFP_KERNEL);
683b7e04f8cSWim Van Sebroeck 	if (!usb_pcwd->intr_urb) {
684b7e04f8cSWim Van Sebroeck 		printk(KERN_ERR PFX "Out of memory\n");
685b7e04f8cSWim Van Sebroeck 		goto error;
686b7e04f8cSWim Van Sebroeck 	}
687b7e04f8cSWim Van Sebroeck 
688b7e04f8cSWim Van Sebroeck 	/* initialise the intr urb's */
689b7e04f8cSWim Van Sebroeck 	usb_fill_int_urb(usb_pcwd->intr_urb, udev, pipe,
690b7e04f8cSWim Van Sebroeck 			usb_pcwd->intr_buffer, usb_pcwd->intr_size,
691b7e04f8cSWim Van Sebroeck 			usb_pcwd_intr_done, usb_pcwd, endpoint->bInterval);
692b7e04f8cSWim Van Sebroeck 	usb_pcwd->intr_urb->transfer_dma = usb_pcwd->intr_dma;
693b7e04f8cSWim Van Sebroeck 	usb_pcwd->intr_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
694b7e04f8cSWim Van Sebroeck 
695b7e04f8cSWim Van Sebroeck 	/* register our interrupt URB with the USB system */
696b7e04f8cSWim Van Sebroeck 	if (usb_submit_urb(usb_pcwd->intr_urb, GFP_KERNEL)) {
697b7e04f8cSWim Van Sebroeck 		printk(KERN_ERR PFX "Problem registering interrupt URB\n");
698b7e04f8cSWim Van Sebroeck 		retval = -EIO; /* failure */
699b7e04f8cSWim Van Sebroeck 		goto error;
700b7e04f8cSWim Van Sebroeck 	}
701b7e04f8cSWim Van Sebroeck 
702b7e04f8cSWim Van Sebroeck 	/* The device exists and can be communicated with */
703b7e04f8cSWim Van Sebroeck 	usb_pcwd->exists = 1;
704b7e04f8cSWim Van Sebroeck 
705b7e04f8cSWim Van Sebroeck 	/* disable card */
706b7e04f8cSWim Van Sebroeck 	usb_pcwd_stop(usb_pcwd);
707b7e04f8cSWim Van Sebroeck 
708b7e04f8cSWim Van Sebroeck 	/* Get the Firmware Version */
709143a2e54SWim Van Sebroeck 	got_fw_rev = usb_pcwd_send_command(usb_pcwd, CMD_GET_FIRMWARE_VERSION,
710143a2e54SWim Van Sebroeck 						&fw_rev_major, &fw_rev_minor);
7117944d3a5SWim Van Sebroeck 	if (got_fw_rev)
712b7e04f8cSWim Van Sebroeck 		sprintf(fw_ver_str, "%u.%02u", fw_rev_major, fw_rev_minor);
7137944d3a5SWim Van Sebroeck 	else
714b7e04f8cSWim Van Sebroeck 		sprintf(fw_ver_str, "<card no answer>");
715b7e04f8cSWim Van Sebroeck 
716b7e04f8cSWim Van Sebroeck 	printk(KERN_INFO PFX "Found card (Firmware: %s) with temp option\n",
717b7e04f8cSWim Van Sebroeck 		fw_ver_str);
718b7e04f8cSWim Van Sebroeck 
719b7e04f8cSWim Van Sebroeck 	/* Get switch settings */
720143a2e54SWim Van Sebroeck 	usb_pcwd_send_command(usb_pcwd, CMD_GET_DIP_SWITCH_SETTINGS, &dummy,
721143a2e54SWim Van Sebroeck 							&option_switches);
722b7e04f8cSWim Van Sebroeck 
723143a2e54SWim Van Sebroeck 	printk(KERN_INFO PFX "Option switches (0x%02x): "
724143a2e54SWim Van Sebroeck 		"Temperature Reset Enable=%s, Power On Delay=%s\n",
725b7e04f8cSWim Van Sebroeck 		option_switches,
726b7e04f8cSWim Van Sebroeck 		((option_switches & 0x10) ? "ON" : "OFF"),
727b7e04f8cSWim Van Sebroeck 		((option_switches & 0x08) ? "ON" : "OFF"));
728b7e04f8cSWim Van Sebroeck 
729b7e04f8cSWim Van Sebroeck 	/* If heartbeat = 0 then we use the heartbeat from the dip-switches */
730b7e04f8cSWim Van Sebroeck 	if (heartbeat == 0)
731b7e04f8cSWim Van Sebroeck 		heartbeat = heartbeat_tbl[(option_switches & 0x07)];
732b7e04f8cSWim Van Sebroeck 
733143a2e54SWim Van Sebroeck 	/* Check that the heartbeat value is within it's range ;
734143a2e54SWim Van Sebroeck 	 * if not reset to the default */
735b7e04f8cSWim Van Sebroeck 	if (usb_pcwd_set_heartbeat(usb_pcwd, heartbeat)) {
736b7e04f8cSWim Van Sebroeck 		usb_pcwd_set_heartbeat(usb_pcwd, WATCHDOG_HEARTBEAT);
737143a2e54SWim Van Sebroeck 		printk(KERN_INFO PFX
738143a2e54SWim Van Sebroeck 			"heartbeat value must be 0<heartbeat<65536, using %d\n",
739b7e04f8cSWim Van Sebroeck 			WATCHDOG_HEARTBEAT);
740b7e04f8cSWim Van Sebroeck 	}
741b7e04f8cSWim Van Sebroeck 
742b7e04f8cSWim Van Sebroeck 	retval = register_reboot_notifier(&usb_pcwd_notifier);
743b7e04f8cSWim Van Sebroeck 	if (retval != 0) {
744143a2e54SWim Van Sebroeck 		printk(KERN_ERR PFX
745143a2e54SWim Van Sebroeck 			"cannot register reboot notifier (err=%d)\n",
746b7e04f8cSWim Van Sebroeck 			retval);
747b7e04f8cSWim Van Sebroeck 		goto error;
748b7e04f8cSWim Van Sebroeck 	}
749b7e04f8cSWim Van Sebroeck 
750b7e04f8cSWim Van Sebroeck 	retval = misc_register(&usb_pcwd_temperature_miscdev);
751b7e04f8cSWim Van Sebroeck 	if (retval != 0) {
752143a2e54SWim Van Sebroeck 		printk(KERN_ERR PFX
753143a2e54SWim Van Sebroeck 			"cannot register miscdev on minor=%d (err=%d)\n",
754b7e04f8cSWim Van Sebroeck 			TEMP_MINOR, retval);
755b7e04f8cSWim Van Sebroeck 		goto err_out_unregister_reboot;
756b7e04f8cSWim Van Sebroeck 	}
757b7e04f8cSWim Van Sebroeck 
758b7e04f8cSWim Van Sebroeck 	retval = misc_register(&usb_pcwd_miscdev);
759b7e04f8cSWim Van Sebroeck 	if (retval != 0) {
760143a2e54SWim Van Sebroeck 		printk(KERN_ERR PFX
761143a2e54SWim Van Sebroeck 			"cannot register miscdev on minor=%d (err=%d)\n",
762b7e04f8cSWim Van Sebroeck 			WATCHDOG_MINOR, retval);
763b7e04f8cSWim Van Sebroeck 		goto err_out_misc_deregister;
764b7e04f8cSWim Van Sebroeck 	}
765b7e04f8cSWim Van Sebroeck 
766b7e04f8cSWim Van Sebroeck 	/* we can register the device now, as it is ready */
767b7e04f8cSWim Van Sebroeck 	usb_set_intfdata(interface, usb_pcwd);
768b7e04f8cSWim Van Sebroeck 
769b7e04f8cSWim Van Sebroeck 	printk(KERN_INFO PFX "initialized. heartbeat=%d sec (nowayout=%d)\n",
770b7e04f8cSWim Van Sebroeck 		heartbeat, nowayout);
771b7e04f8cSWim Van Sebroeck 
772b7e04f8cSWim Van Sebroeck 	return 0;
773b7e04f8cSWim Van Sebroeck 
774b7e04f8cSWim Van Sebroeck err_out_misc_deregister:
775b7e04f8cSWim Van Sebroeck 	misc_deregister(&usb_pcwd_temperature_miscdev);
776b7e04f8cSWim Van Sebroeck err_out_unregister_reboot:
777b7e04f8cSWim Van Sebroeck 	unregister_reboot_notifier(&usb_pcwd_notifier);
778b7e04f8cSWim Van Sebroeck error:
779b7e04f8cSWim Van Sebroeck 	if (usb_pcwd)
780b7e04f8cSWim Van Sebroeck 		usb_pcwd_delete(usb_pcwd);
781b7e04f8cSWim Van Sebroeck 	usb_pcwd_device = NULL;
782b7e04f8cSWim Van Sebroeck 	return retval;
783b7e04f8cSWim Van Sebroeck }
784b7e04f8cSWim Van Sebroeck 
785b7e04f8cSWim Van Sebroeck 
786b7e04f8cSWim Van Sebroeck /**
787b7e04f8cSWim Van Sebroeck  *	usb_pcwd_disconnect
788b7e04f8cSWim Van Sebroeck  *
789b7e04f8cSWim Van Sebroeck  *	Called by the usb core when the device is removed from the system.
790b7e04f8cSWim Van Sebroeck  *
791b7e04f8cSWim Van Sebroeck  *	This routine guarantees that the driver will not submit any more urbs
792b7e04f8cSWim Van Sebroeck  *	by clearing dev->udev.
793b7e04f8cSWim Van Sebroeck  */
794b7e04f8cSWim Van Sebroeck static void usb_pcwd_disconnect(struct usb_interface *interface)
795b7e04f8cSWim Van Sebroeck {
796b7e04f8cSWim Van Sebroeck 	struct usb_pcwd_private *usb_pcwd;
797b7e04f8cSWim Van Sebroeck 
798b7e04f8cSWim Van Sebroeck 	/* prevent races with open() */
799b7e04f8cSWim Van Sebroeck 	mutex_lock(&disconnect_mutex);
800b7e04f8cSWim Van Sebroeck 
801b7e04f8cSWim Van Sebroeck 	usb_pcwd = usb_get_intfdata(interface);
802b7e04f8cSWim Van Sebroeck 	usb_set_intfdata(interface, NULL);
803b7e04f8cSWim Van Sebroeck 
804b7e04f8cSWim Van Sebroeck 	mutex_lock(&usb_pcwd->mtx);
805b7e04f8cSWim Van Sebroeck 
806b7e04f8cSWim Van Sebroeck 	/* Stop the timer before we leave */
807b7e04f8cSWim Van Sebroeck 	if (!nowayout)
808b7e04f8cSWim Van Sebroeck 		usb_pcwd_stop(usb_pcwd);
809b7e04f8cSWim Van Sebroeck 
810b7e04f8cSWim Van Sebroeck 	/* We should now stop communicating with the USB PCWD device */
811b7e04f8cSWim Van Sebroeck 	usb_pcwd->exists = 0;
812b7e04f8cSWim Van Sebroeck 
813b7e04f8cSWim Van Sebroeck 	/* Deregister */
814b7e04f8cSWim Van Sebroeck 	misc_deregister(&usb_pcwd_miscdev);
815b7e04f8cSWim Van Sebroeck 	misc_deregister(&usb_pcwd_temperature_miscdev);
816b7e04f8cSWim Van Sebroeck 	unregister_reboot_notifier(&usb_pcwd_notifier);
817b7e04f8cSWim Van Sebroeck 
818b7e04f8cSWim Van Sebroeck 	mutex_unlock(&usb_pcwd->mtx);
819b7e04f8cSWim Van Sebroeck 
820b7e04f8cSWim Van Sebroeck 	/* Delete the USB PCWD device */
821b7e04f8cSWim Van Sebroeck 	usb_pcwd_delete(usb_pcwd);
822b7e04f8cSWim Van Sebroeck 
823b7e04f8cSWim Van Sebroeck 	cards_found--;
824b7e04f8cSWim Van Sebroeck 
825b7e04f8cSWim Van Sebroeck 	mutex_unlock(&disconnect_mutex);
826b7e04f8cSWim Van Sebroeck 
827b7e04f8cSWim Van Sebroeck 	printk(KERN_INFO PFX "USB PC Watchdog disconnected\n");
828b7e04f8cSWim Van Sebroeck }
829b7e04f8cSWim Van Sebroeck 
830b7e04f8cSWim Van Sebroeck 
831b7e04f8cSWim Van Sebroeck 
832b7e04f8cSWim Van Sebroeck /**
833b7e04f8cSWim Van Sebroeck  *	usb_pcwd_init
834b7e04f8cSWim Van Sebroeck  */
835b7e04f8cSWim Van Sebroeck static int __init usb_pcwd_init(void)
836b7e04f8cSWim Van Sebroeck {
837b7e04f8cSWim Van Sebroeck 	int result;
838b7e04f8cSWim Van Sebroeck 
839b7e04f8cSWim Van Sebroeck 	/* register this driver with the USB subsystem */
840b7e04f8cSWim Van Sebroeck 	result = usb_register(&usb_pcwd_driver);
841b7e04f8cSWim Van Sebroeck 	if (result) {
842b7e04f8cSWim Van Sebroeck 		printk(KERN_ERR PFX "usb_register failed. Error number %d\n",
843b7e04f8cSWim Van Sebroeck 		    result);
844b7e04f8cSWim Van Sebroeck 		return result;
845b7e04f8cSWim Van Sebroeck 	}
846b7e04f8cSWim Van Sebroeck 
847143a2e54SWim Van Sebroeck 	printk(KERN_INFO PFX DRIVER_DESC " v" DRIVER_VERSION "\n");
848b7e04f8cSWim Van Sebroeck 	return 0;
849b7e04f8cSWim Van Sebroeck }
850b7e04f8cSWim Van Sebroeck 
851b7e04f8cSWim Van Sebroeck 
852b7e04f8cSWim Van Sebroeck /**
853b7e04f8cSWim Van Sebroeck  *	usb_pcwd_exit
854b7e04f8cSWim Van Sebroeck  */
855b7e04f8cSWim Van Sebroeck static void __exit usb_pcwd_exit(void)
856b7e04f8cSWim Van Sebroeck {
857b7e04f8cSWim Van Sebroeck 	/* deregister this driver with the USB subsystem */
858b7e04f8cSWim Van Sebroeck 	usb_deregister(&usb_pcwd_driver);
859b7e04f8cSWim Van Sebroeck }
860b7e04f8cSWim Van Sebroeck 
861b7e04f8cSWim Van Sebroeck 
862b7e04f8cSWim Van Sebroeck module_init(usb_pcwd_init);
863b7e04f8cSWim Van Sebroeck module_exit(usb_pcwd_exit);
864