imon.c 70 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0-or-later
2 3 4
/*
 *   imon.c:	input and display driver for SoundGraph iMON IR/VFD/LCD
 *
5
 *   Copyright(C) 2010  Jarod Wilson <jarod@wilsonet.com>
6 7 8 9 10 11 12 13 14 15
 *   Portions based on the original lirc_imon driver,
 *	Copyright(C) 2004  Venky Raju(dev@venky.ws)
 *
 *   Huge thanks to R. Geoff Newbury for invaluable debugging on the
 *   0xffdc iMON devices, and for sending me one to hack on, without
 *   which the support for them wouldn't be nearly as good. Thanks
 *   also to the numerous 0xffdc device owners that tested auto-config
 *   support for me and provided debug dumps from their devices.
 */

16 17
#define pr_fmt(fmt) KBUILD_MODNAME ":%s: " fmt, __func__

18 19 20
#include <linux/errno.h>
#include <linux/init.h>
#include <linux/kernel.h>
21
#include <linux/ktime.h>
22 23 24
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/uaccess.h>
25
#include <linux/ratelimit.h>
26 27 28 29

#include <linux/input.h>
#include <linux/usb.h>
#include <linux/usb/input.h>
30
#include <media/rc-core.h>
31 32 33 34 35 36

#include <linux/timer.h>

#define MOD_AUTHOR	"Jarod Wilson <jarod@wilsonet.com>"
#define MOD_DESC	"Driver for SoundGraph iMON MultiMedia IR/Display"
#define MOD_NAME	"imon"
37
#define MOD_VERSION	"0.9.4"
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67

#define DISPLAY_MINOR_BASE	144
#define DEVICE_NAME	"lcd%d"

#define BUF_CHUNK_SIZE	8
#define BUF_SIZE	128

#define BIT_DURATION	250	/* each bit received is 250us */

#define IMON_CLOCK_ENABLE_PACKETS	2

/*** P R O T O T Y P E S ***/

/* USB Callback prototypes */
static int imon_probe(struct usb_interface *interface,
		      const struct usb_device_id *id);
static void imon_disconnect(struct usb_interface *interface);
static void usb_rx_callback_intf0(struct urb *urb);
static void usb_rx_callback_intf1(struct urb *urb);
static void usb_tx_callback(struct urb *urb);

/* suspend/resume support */
static int imon_resume(struct usb_interface *intf);
static int imon_suspend(struct usb_interface *intf, pm_message_t message);

/* Display file_operations function prototypes */
static int display_open(struct inode *inode, struct file *file);
static int display_close(struct inode *inode, struct file *file);

/* VFD write operation */
68
static ssize_t vfd_write(struct file *file, const char __user *buf,
69 70 71
			 size_t n_bytes, loff_t *pos);

/* LCD file_operations override function prototypes */
72
static ssize_t lcd_write(struct file *file, const char __user *buf,
73 74 75 76
			 size_t n_bytes, loff_t *pos);

/*** G L O B A L S ***/

77 78 79 80 81 82 83 84 85
struct imon_panel_key_table {
	u64 hw_code;
	u32 keycode;
};

struct imon_usb_dev_descr {
	__u16 flags;
#define IMON_NO_FLAGS 0
#define IMON_NEED_20MS_PKT_DELAY 1
86
#define IMON_SUPPRESS_REPEATED_KEYS 2
87 88 89
	struct imon_panel_key_table key_table[];
};

90 91 92 93 94 95 96 97
struct imon_context {
	struct device *dev;
	/* Newer devices have two interfaces */
	struct usb_device *usbdev_intf0;
	struct usb_device *usbdev_intf1;

	bool display_supported;		/* not all controllers do */
	bool display_isopen;		/* display port has been opened */
98
	bool rf_device;			/* true if iMON 2.4G LT/DT RF device */
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
	bool rf_isassociating;		/* RF remote associating */
	bool dev_present_intf0;		/* USB device presence, interface 0 */
	bool dev_present_intf1;		/* USB device presence, interface 1 */

	struct mutex lock;		/* to lock this object */
	wait_queue_head_t remove_ok;	/* For unexpected USB disconnects */

	struct usb_endpoint_descriptor *rx_endpoint_intf0;
	struct usb_endpoint_descriptor *rx_endpoint_intf1;
	struct usb_endpoint_descriptor *tx_endpoint;
	struct urb *rx_urb_intf0;
	struct urb *rx_urb_intf1;
	struct urb *tx_urb;
	bool tx_control;
	unsigned char usb_rx_buf[8];
	unsigned char usb_tx_buf[8];
115
	unsigned int send_packet_delay;
116 117 118 119 120 121 122 123 124 125 126

	struct tx_t {
		unsigned char data_buf[35];	/* user data buffer */
		struct completion finished;	/* wait for write to finish */
		bool busy;			/* write in progress */
		int status;			/* status of tx completion */
	} tx;

	u16 vendor;			/* usb vendor ID */
	u16 product;			/* usb product ID */

127
	struct rc_dev *rdev;		/* rc-core device for remote */
128
	struct input_dev *idev;		/* input device for panel & IR mouse */
129 130
	struct input_dev *touch;	/* input device for touchscreen */

131
	spinlock_t kc_lock;		/* make sure we get keycodes right */
132 133
	u32 kc;				/* current input keycode */
	u32 last_keycode;		/* last reported input keycode */
134 135
	u32 rc_scancode;		/* the computed remote scancode */
	u8 rc_toggle;			/* the computed remote toggle bit */
136
	u64 rc_proto;			/* iMON or MCE (RC6) IR protocol? */
137 138 139 140 141
	bool release_code;		/* some keys send a release code */

	u8 display_type;		/* store the display type */
	bool pad_mouse;			/* toggle kbd(0)/mouse(1) mode */

142 143 144
	char name_rdev[128];		/* rc input device name */
	char phys_rdev[64];		/* rc input device phys path */

145 146 147 148 149 150 151 152
	char name_idev[128];		/* input device name */
	char phys_idev[64];		/* input device phys path */

	char name_touch[128];		/* touch screen name */
	char phys_touch[64];		/* touch screen phys path */
	struct timer_list ttimer;	/* touch screen timer */
	int touch_x;			/* x coordinate on touchscreen */
	int touch_y;			/* y coordinate on touchscreen */
153 154 155
	const struct imon_usb_dev_descr *dev_descr;
					/* device description with key */
					/* table for front panels */
156 157 158 159 160 161 162 163 164
};

#define TOUCH_TIMEOUT	(HZ/30)

/* vfd character device file operations */
static const struct file_operations vfd_fops = {
	.owner		= THIS_MODULE,
	.open		= &display_open,
	.write		= &vfd_write,
165 166
	.release	= &display_close,
	.llseek		= noop_llseek,
167 168 169 170 171 172 173
};

/* lcd character device file operations */
static const struct file_operations lcd_fops = {
	.owner		= THIS_MODULE,
	.open		= &display_open,
	.write		= &lcd_write,
174 175
	.release	= &display_close,
	.llseek		= noop_llseek,
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
};

enum {
	IMON_DISPLAY_TYPE_AUTO = 0,
	IMON_DISPLAY_TYPE_VFD  = 1,
	IMON_DISPLAY_TYPE_LCD  = 2,
	IMON_DISPLAY_TYPE_VGA  = 3,
	IMON_DISPLAY_TYPE_NONE = 4,
};

enum {
	IMON_KEY_IMON	= 0,
	IMON_KEY_MCE	= 1,
	IMON_KEY_PANEL	= 2,
};

192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
static struct usb_class_driver imon_vfd_class = {
	.name		= DEVICE_NAME,
	.fops		= &vfd_fops,
	.minor_base	= DISPLAY_MINOR_BASE,
};

static struct usb_class_driver imon_lcd_class = {
	.name		= DEVICE_NAME,
	.fops		= &lcd_fops,
	.minor_base	= DISPLAY_MINOR_BASE,
};

/* imon receiver front panel/knob key table */
static const struct imon_usb_dev_descr imon_default_table = {
	.flags = IMON_NO_FLAGS,
	.key_table = {
		{ 0x000000000f00ffeell, KEY_MEDIA }, /* Go */
		{ 0x000000001200ffeell, KEY_UP },
		{ 0x000000001300ffeell, KEY_DOWN },
		{ 0x000000001400ffeell, KEY_LEFT },
		{ 0x000000001500ffeell, KEY_RIGHT },
		{ 0x000000001600ffeell, KEY_ENTER },
		{ 0x000000001700ffeell, KEY_ESC },
		{ 0x000000001f00ffeell, KEY_AUDIO },
		{ 0x000000002000ffeell, KEY_VIDEO },
		{ 0x000000002100ffeell, KEY_CAMERA },
		{ 0x000000002700ffeell, KEY_DVD },
		{ 0x000000002300ffeell, KEY_TV },
		{ 0x000000002b00ffeell, KEY_EXIT },
		{ 0x000000002c00ffeell, KEY_SELECT },
		{ 0x000000002d00ffeell, KEY_MENU },
		{ 0x000000000500ffeell, KEY_PREVIOUS },
		{ 0x000000000700ffeell, KEY_REWIND },
		{ 0x000000000400ffeell, KEY_STOP },
		{ 0x000000003c00ffeell, KEY_PLAYPAUSE },
		{ 0x000000000800ffeell, KEY_FASTFORWARD },
		{ 0x000000000600ffeell, KEY_NEXT },
		{ 0x000000010000ffeell, KEY_RIGHT },
		{ 0x000001000000ffeell, KEY_LEFT },
		{ 0x000000003d00ffeell, KEY_SELECT },
		{ 0x000100000000ffeell, KEY_VOLUMEUP },
		{ 0x010000000000ffeell, KEY_VOLUMEDOWN },
		{ 0x000000000100ffeell, KEY_MUTE },
		/* 0xffdc iMON MCE VFD */
		{ 0x00010000ffffffeell, KEY_VOLUMEUP },
		{ 0x01000000ffffffeell, KEY_VOLUMEDOWN },
		{ 0x00000001ffffffeell, KEY_MUTE },
		{ 0x0000000fffffffeell, KEY_MEDIA },
		{ 0x00000012ffffffeell, KEY_UP },
		{ 0x00000013ffffffeell, KEY_DOWN },
		{ 0x00000014ffffffeell, KEY_LEFT },
		{ 0x00000015ffffffeell, KEY_RIGHT },
		{ 0x00000016ffffffeell, KEY_ENTER },
		{ 0x00000017ffffffeell, KEY_ESC },
		/* iMON Knob values */
		{ 0x000100ffffffffeell, KEY_VOLUMEUP },
		{ 0x010000ffffffffeell, KEY_VOLUMEDOWN },
		{ 0x000008ffffffffeell, KEY_MUTE },
		{ 0, KEY_RESERVED },
	}
};

static const struct imon_usb_dev_descr imon_OEM_VFD = {
	.flags = IMON_NEED_20MS_PKT_DELAY,
	.key_table = {
		{ 0x000000000f00ffeell, KEY_MEDIA }, /* Go */
		{ 0x000000001200ffeell, KEY_UP },
		{ 0x000000001300ffeell, KEY_DOWN },
		{ 0x000000001400ffeell, KEY_LEFT },
		{ 0x000000001500ffeell, KEY_RIGHT },
		{ 0x000000001600ffeell, KEY_ENTER },
		{ 0x000000001700ffeell, KEY_ESC },
		{ 0x000000001f00ffeell, KEY_AUDIO },
		{ 0x000000002b00ffeell, KEY_EXIT },
		{ 0x000000002c00ffeell, KEY_SELECT },
		{ 0x000000002d00ffeell, KEY_MENU },
		{ 0x000000000500ffeell, KEY_PREVIOUS },
		{ 0x000000000700ffeell, KEY_REWIND },
		{ 0x000000000400ffeell, KEY_STOP },
		{ 0x000000003c00ffeell, KEY_PLAYPAUSE },
		{ 0x000000000800ffeell, KEY_FASTFORWARD },
		{ 0x000000000600ffeell, KEY_NEXT },
		{ 0x000000010000ffeell, KEY_RIGHT },
		{ 0x000001000000ffeell, KEY_LEFT },
		{ 0x000000003d00ffeell, KEY_SELECT },
		{ 0x000100000000ffeell, KEY_VOLUMEUP },
		{ 0x010000000000ffeell, KEY_VOLUMEDOWN },
		{ 0x000000000100ffeell, KEY_MUTE },
		/* 0xffdc iMON MCE VFD */
		{ 0x00010000ffffffeell, KEY_VOLUMEUP },
		{ 0x01000000ffffffeell, KEY_VOLUMEDOWN },
		{ 0x00000001ffffffeell, KEY_MUTE },
		{ 0x0000000fffffffeell, KEY_MEDIA },
		{ 0x00000012ffffffeell, KEY_UP },
		{ 0x00000013ffffffeell, KEY_DOWN },
		{ 0x00000014ffffffeell, KEY_LEFT },
		{ 0x00000015ffffffeell, KEY_RIGHT },
		{ 0x00000016ffffffeell, KEY_ENTER },
		{ 0x00000017ffffffeell, KEY_ESC },
		/* iMON Knob values */
		{ 0x000100ffffffffeell, KEY_VOLUMEUP },
		{ 0x010000ffffffffeell, KEY_VOLUMEDOWN },
		{ 0x000008ffffffffeell, KEY_MUTE },
		{ 0, KEY_RESERVED },
	}
297 298
};

299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
/* imon receiver front panel/knob key table for DH102*/
static const struct imon_usb_dev_descr imon_DH102 = {
	.flags = IMON_NO_FLAGS,
	.key_table = {
		{ 0x000100000000ffeell, KEY_VOLUMEUP },
		{ 0x010000000000ffeell, KEY_VOLUMEDOWN },
		{ 0x000000010000ffeell, KEY_MUTE },
		{ 0x0000000f0000ffeell, KEY_MEDIA },
		{ 0x000000120000ffeell, KEY_UP },
		{ 0x000000130000ffeell, KEY_DOWN },
		{ 0x000000140000ffeell, KEY_LEFT },
		{ 0x000000150000ffeell, KEY_RIGHT },
		{ 0x000000160000ffeell, KEY_ENTER },
		{ 0x000000170000ffeell, KEY_ESC },
		{ 0x0000002b0000ffeell, KEY_EXIT },
		{ 0x0000002c0000ffeell, KEY_SELECT },
		{ 0x0000002d0000ffeell, KEY_MENU },
		{ 0, KEY_RESERVED }
	}
};

320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
/* imon ultrabay front panel key table */
static const struct imon_usb_dev_descr ultrabay_table = {
	.flags = IMON_SUPPRESS_REPEATED_KEYS,
	.key_table = {
		{ 0x0000000f0000ffeell, KEY_MEDIA },      /* Go */
		{ 0x000000000100ffeell, KEY_UP },
		{ 0x000000000001ffeell, KEY_DOWN },
		{ 0x000000160000ffeell, KEY_ENTER },
		{ 0x0000001f0000ffeell, KEY_AUDIO },      /* Music */
		{ 0x000000200000ffeell, KEY_VIDEO },      /* Movie */
		{ 0x000000210000ffeell, KEY_CAMERA },     /* Photo */
		{ 0x000000270000ffeell, KEY_DVD },        /* DVD */
		{ 0x000000230000ffeell, KEY_TV },         /* TV */
		{ 0x000000050000ffeell, KEY_PREVIOUS },   /* Previous */
		{ 0x000000070000ffeell, KEY_REWIND },
		{ 0x000000040000ffeell, KEY_STOP },
		{ 0x000000020000ffeell, KEY_PLAYPAUSE },
		{ 0x000000080000ffeell, KEY_FASTFORWARD },
		{ 0x000000060000ffeell, KEY_NEXT },       /* Next */
		{ 0x000100000000ffeell, KEY_VOLUMEUP },
		{ 0x010000000000ffeell, KEY_VOLUMEDOWN },
		{ 0x000000010000ffeell, KEY_MUTE },
		{ 0, KEY_RESERVED },
	}
};

346 347 348 349 350 351 352 353 354 355 356
/*
 * USB Device ID for iMON USB Control Boards
 *
 * The Windows drivers contain 6 different inf files, more or less one for
 * each new device until the 0x0034-0x0046 devices, which all use the same
 * driver. Some of the devices in the 34-46 range haven't been definitively
 * identified yet. Early devices have either a TriGem Computer, Inc. or a
 * Samsung vendor ID (0x0aa8 and 0x04e8 respectively), while all later
 * devices use the SoundGraph vendor ID (0x15c2). This driver only supports
 * the ffdc and later devices, which do onboard decoding.
 */
357
static const struct usb_device_id imon_usb_id_table[] = {
358 359 360 361 362 363
	/*
	 * Several devices with this same device ID, all use iMON_PAD.inf
	 * SoundGraph iMON PAD (IR & VFD)
	 * SoundGraph iMON PAD (IR & LCD)
	 * SoundGraph iMON Knob (IR only)
	 */
364 365
	{ USB_DEVICE(0x15c2, 0xffdc),
	  .driver_info = (unsigned long)&imon_default_table },
366 367 368 369 370 371 372

	/*
	 * Newer devices, all driven by the latest iMON Windows driver, full
	 * list of device IDs extracted via 'strings Setup/data1.hdr |grep 15c2'
	 * Need user input to fill in details on unknown devices.
	 */
	/* SoundGraph iMON OEM Touch LCD (IR & 7" VGA LCD) */
373
	{ USB_DEVICE(0x15c2, 0x0034),
374
	  .driver_info = (unsigned long)&imon_DH102 },
375
	/* SoundGraph iMON OEM Touch LCD (IR & 4.3" VGA LCD) */
376 377
	{ USB_DEVICE(0x15c2, 0x0035),
	  .driver_info = (unsigned long)&imon_default_table},
378
	/* SoundGraph iMON OEM VFD (IR & VFD) */
379 380
	{ USB_DEVICE(0x15c2, 0x0036),
	  .driver_info = (unsigned long)&imon_OEM_VFD },
381
	/* device specifics unknown */
382 383
	{ USB_DEVICE(0x15c2, 0x0037),
	  .driver_info = (unsigned long)&imon_default_table},
384
	/* SoundGraph iMON OEM LCD (IR & LCD) */
385 386
	{ USB_DEVICE(0x15c2, 0x0038),
	  .driver_info = (unsigned long)&imon_default_table},
387
	/* SoundGraph iMON UltraBay (IR & LCD) */
388 389
	{ USB_DEVICE(0x15c2, 0x0039),
	  .driver_info = (unsigned long)&imon_default_table},
390
	/* device specifics unknown */
391 392
	{ USB_DEVICE(0x15c2, 0x003a),
	  .driver_info = (unsigned long)&imon_default_table},
393
	/* device specifics unknown */
394 395
	{ USB_DEVICE(0x15c2, 0x003b),
	  .driver_info = (unsigned long)&imon_default_table},
396
	/* SoundGraph iMON OEM Inside (IR only) */
397 398
	{ USB_DEVICE(0x15c2, 0x003c),
	  .driver_info = (unsigned long)&imon_default_table},
399
	/* device specifics unknown */
400 401
	{ USB_DEVICE(0x15c2, 0x003d),
	  .driver_info = (unsigned long)&imon_default_table},
402
	/* device specifics unknown */
403 404
	{ USB_DEVICE(0x15c2, 0x003e),
	  .driver_info = (unsigned long)&imon_default_table},
405
	/* device specifics unknown */
406 407
	{ USB_DEVICE(0x15c2, 0x003f),
	  .driver_info = (unsigned long)&imon_default_table},
408
	/* device specifics unknown */
409 410
	{ USB_DEVICE(0x15c2, 0x0040),
	  .driver_info = (unsigned long)&imon_default_table},
411
	/* SoundGraph iMON MINI (IR only) */
412 413
	{ USB_DEVICE(0x15c2, 0x0041),
	  .driver_info = (unsigned long)&imon_default_table},
414
	/* Antec Veris Multimedia Station EZ External (IR only) */
415 416
	{ USB_DEVICE(0x15c2, 0x0042),
	  .driver_info = (unsigned long)&imon_default_table},
417
	/* Antec Veris Multimedia Station Basic Internal (IR only) */
418 419
	{ USB_DEVICE(0x15c2, 0x0043),
	  .driver_info = (unsigned long)&imon_default_table},
420
	/* Antec Veris Multimedia Station Elite (IR & VFD) */
421 422
	{ USB_DEVICE(0x15c2, 0x0044),
	  .driver_info = (unsigned long)&imon_default_table},
423
	/* Antec Veris Multimedia Station Premiere (IR & LCD) */
424 425
	{ USB_DEVICE(0x15c2, 0x0045),
	  .driver_info = (unsigned long)&imon_default_table},
426
	/* device specifics unknown */
427 428
	{ USB_DEVICE(0x15c2, 0x0046),
	  .driver_info = (unsigned long)&imon_default_table},
429 430 431 432 433 434 435
	{}
};

/* USB Device data */
static struct usb_driver imon_driver = {
	.name		= MOD_NAME,
	.probe		= imon_probe,
436
	.disconnect	= imon_disconnect,
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
	.suspend	= imon_suspend,
	.resume		= imon_resume,
	.id_table	= imon_usb_id_table,
};

/* to prevent races between open() and disconnect(), probing, etc */
static DEFINE_MUTEX(driver_lock);

/* Module bookkeeping bits */
MODULE_AUTHOR(MOD_AUTHOR);
MODULE_DESCRIPTION(MOD_DESC);
MODULE_VERSION(MOD_VERSION);
MODULE_LICENSE("GPL");
MODULE_DEVICE_TABLE(usb, imon_usb_id_table);

static bool debug;
module_param(debug, bool, S_IRUGO | S_IWUSR);
454
MODULE_PARM_DESC(debug, "Debug messages: 0=no, 1=yes (default: no)");
455 456 457 458

/* lcd, vfd, vga or none? should be auto-detected, but can be overridden... */
static int display_type;
module_param(display_type, int, S_IRUGO);
459
MODULE_PARM_DESC(display_type, "Type of attached display. 0=autodetect, 1=vfd, 2=lcd, 3=vga, 4=none (default: autodetect)");
460

461 462
static int pad_stabilize = 1;
module_param(pad_stabilize, int, S_IRUGO | S_IWUSR);
463
MODULE_PARM_DESC(pad_stabilize, "Apply stabilization algorithm to iMON PAD presses in arrow key mode. 0=disable, 1=enable (default).");
464 465 466 467 468 469 470

/*
 * In certain use cases, mouse mode isn't really helpful, and could actually
 * cause confusion, so allow disabling it when the IR device is open.
 */
static bool nomouse;
module_param(nomouse, bool, S_IRUGO | S_IWUSR);
471
MODULE_PARM_DESC(nomouse, "Disable mouse input device mode when IR device is open. 0=don't disable, 1=disable. (default: don't disable)");
472 473 474 475

/* threshold at which a pad push registers as an arrow key in kbd mode */
static int pad_thresh;
module_param(pad_thresh, int, S_IRUGO | S_IWUSR);
476
MODULE_PARM_DESC(pad_thresh, "Threshold at which a pad push registers as an arrow key in kbd mode (default: 28)");
477 478 479 480 481 482 483 484 485 486 487 488 489 490


static void free_imon_context(struct imon_context *ictx)
{
	struct device *dev = ictx->dev;

	usb_free_urb(ictx->tx_urb);
	usb_free_urb(ictx->rx_urb_intf0);
	usb_free_urb(ictx->rx_urb_intf1);
	kfree(ictx);

	dev_dbg(dev, "%s: iMON context freed\n", __func__);
}

491
/*
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
 * Called when the Display device (e.g. /dev/lcd0)
 * is opened by the application.
 */
static int display_open(struct inode *inode, struct file *file)
{
	struct usb_interface *interface;
	struct imon_context *ictx = NULL;
	int subminor;
	int retval = 0;

	/* prevent races with disconnect */
	mutex_lock(&driver_lock);

	subminor = iminor(inode);
	interface = usb_find_interface(&imon_driver, subminor);
	if (!interface) {
508
		pr_err("could not find interface for minor %d\n", subminor);
509 510 511 512 513 514
		retval = -ENODEV;
		goto exit;
	}
	ictx = usb_get_intfdata(interface);

	if (!ictx) {
515
		pr_err("no context found for minor %d\n", subminor);
516 517 518 519 520 521 522
		retval = -ENODEV;
		goto exit;
	}

	mutex_lock(&ictx->lock);

	if (!ictx->display_supported) {
523
		pr_err("display not supported by device\n");
524 525
		retval = -ENODEV;
	} else if (ictx->display_isopen) {
526
		pr_err("display port is already open\n");
527 528
		retval = -EBUSY;
	} else {
529
		ictx->display_isopen = true;
530 531 532 533 534 535 536 537 538 539 540
		file->private_data = ictx;
		dev_dbg(ictx->dev, "display port opened\n");
	}

	mutex_unlock(&ictx->lock);

exit:
	mutex_unlock(&driver_lock);
	return retval;
}

541
/*
542 543 544 545 546 547 548 549
 * Called when the display device (e.g. /dev/lcd0)
 * is closed by the application.
 */
static int display_close(struct inode *inode, struct file *file)
{
	struct imon_context *ictx = NULL;
	int retval = 0;

550
	ictx = file->private_data;
551 552

	if (!ictx) {
553
		pr_err("no context for device\n");
554 555 556 557 558 559
		return -ENODEV;
	}

	mutex_lock(&ictx->lock);

	if (!ictx->display_supported) {
560
		pr_err("display not supported by device\n");
561 562
		retval = -ENODEV;
	} else if (!ictx->display_isopen) {
563
		pr_err("display is not open\n");
564 565
		retval = -EIO;
	} else {
566
		ictx->display_isopen = false;
567 568 569 570 571 572 573
		dev_dbg(ictx->dev, "display port closed\n");
	}

	mutex_unlock(&ictx->lock);
	return retval;
}

574
/*
575 576 577
 * Sends a packet to the device -- this function must be called with
 * ictx->lock held, or its unlock/lock sequence while waiting for tx
 * to complete can/will lead to a deadlock.
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
 */
static int send_packet(struct imon_context *ictx)
{
	unsigned int pipe;
	unsigned long timeout;
	int interval = 0;
	int retval = 0;
	struct usb_ctrlrequest *control_req = NULL;

	/* Check if we need to use control or interrupt urb */
	if (!ictx->tx_control) {
		pipe = usb_sndintpipe(ictx->usbdev_intf0,
				      ictx->tx_endpoint->bEndpointAddress);
		interval = ictx->tx_endpoint->bInterval;

		usb_fill_int_urb(ictx->tx_urb, ictx->usbdev_intf0, pipe,
				 ictx->usb_tx_buf,
				 sizeof(ictx->usb_tx_buf),
				 usb_tx_callback, ictx, interval);

		ictx->tx_urb->actual_length = 0;
	} else {
		/* fill request into kmalloc'ed space: */
601
		control_req = kmalloc(sizeof(*control_req), GFP_KERNEL);
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
		if (control_req == NULL)
			return -ENOMEM;

		/* setup packet is '21 09 0200 0001 0008' */
		control_req->bRequestType = 0x21;
		control_req->bRequest = 0x09;
		control_req->wValue = cpu_to_le16(0x0200);
		control_req->wIndex = cpu_to_le16(0x0001);
		control_req->wLength = cpu_to_le16(0x0008);

		/* control pipe is endpoint 0x00 */
		pipe = usb_sndctrlpipe(ictx->usbdev_intf0, 0);

		/* build the control urb */
		usb_fill_control_urb(ictx->tx_urb, ictx->usbdev_intf0,
				     pipe, (unsigned char *)control_req,
				     ictx->usb_tx_buf,
				     sizeof(ictx->usb_tx_buf),
				     usb_tx_callback, ictx);
		ictx->tx_urb->actual_length = 0;
	}

624
	reinit_completion(&ictx->tx.finished);
625
	ictx->tx.busy = true;
626 627 628 629
	smp_rmb(); /* ensure later readers know we're busy */

	retval = usb_submit_urb(ictx->tx_urb, GFP_KERNEL);
	if (retval) {
630
		ictx->tx.busy = false;
631
		smp_rmb(); /* ensure later readers know we're not busy */
632
		pr_err_ratelimited("error submitting urb(%d)\n", retval);
633 634 635 636 637
	} else {
		/* Wait for transmission to complete (or abort) */
		mutex_unlock(&ictx->lock);
		retval = wait_for_completion_interruptible(
				&ictx->tx.finished);
638 639
		if (retval) {
			usb_kill_urb(ictx->tx_urb);
640
			pr_err_ratelimited("task interrupted\n");
641
		}
642 643 644 645
		mutex_lock(&ictx->lock);

		retval = ictx->tx.status;
		if (retval)
646
			pr_err_ratelimited("packet tx failed (%d)\n", retval);
647 648 649 650 651
	}

	kfree(control_req);

	/*
652
	 * Induce a mandatory delay before returning, as otherwise,
653 654 655
	 * send_packet can get called so rapidly as to overwhelm the device,
	 * particularly on faster systems and/or those with quirky usb.
	 */
656 657
	timeout = msecs_to_jiffies(ictx->send_packet_delay);
	set_current_state(TASK_INTERRUPTIBLE);
658 659 660 661 662
	schedule_timeout(timeout);

	return retval;
}

663
/*
664 665 666 667 668 669 670 671 672 673 674 675 676 677
 * Sends an associate packet to the iMON 2.4G.
 *
 * This might not be such a good idea, since it has an id collision with
 * some versions of the "IR & VFD" combo. The only way to determine if it
 * is an RF version is to look at the product description string. (Which
 * we currently do not fetch).
 */
static int send_associate_24g(struct imon_context *ictx)
{
	int retval;
	const unsigned char packet[8] = { 0x01, 0x00, 0x00, 0x00,
					  0x00, 0x00, 0x00, 0x20 };

	if (!ictx) {
678
		pr_err("no context for device\n");
679 680 681 682
		return -ENODEV;
	}

	if (!ictx->dev_present_intf0) {
683
		pr_err("no iMON device present\n");
684 685 686 687 688 689 690 691 692
		return -ENODEV;
	}

	memcpy(ictx->usb_tx_buf, packet, sizeof(packet));
	retval = send_packet(ictx);

	return retval;
}

693
/*
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710
 * Sends packets to setup and show clock on iMON display
 *
 * Arguments: year - last 2 digits of year, month - 1..12,
 * day - 1..31, dow - day of the week (0-Sun...6-Sat),
 * hour - 0..23, minute - 0..59, second - 0..59
 */
static int send_set_imon_clock(struct imon_context *ictx,
			       unsigned int year, unsigned int month,
			       unsigned int day, unsigned int dow,
			       unsigned int hour, unsigned int minute,
			       unsigned int second)
{
	unsigned char clock_enable_pkt[IMON_CLOCK_ENABLE_PACKETS][8];
	int retval = 0;
	int i;

	if (!ictx) {
711
		pr_err("no context for device\n");
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771
		return -ENODEV;
	}

	switch (ictx->display_type) {
	case IMON_DISPLAY_TYPE_LCD:
		clock_enable_pkt[0][0] = 0x80;
		clock_enable_pkt[0][1] = year;
		clock_enable_pkt[0][2] = month-1;
		clock_enable_pkt[0][3] = day;
		clock_enable_pkt[0][4] = hour;
		clock_enable_pkt[0][5] = minute;
		clock_enable_pkt[0][6] = second;

		clock_enable_pkt[1][0] = 0x80;
		clock_enable_pkt[1][1] = 0;
		clock_enable_pkt[1][2] = 0;
		clock_enable_pkt[1][3] = 0;
		clock_enable_pkt[1][4] = 0;
		clock_enable_pkt[1][5] = 0;
		clock_enable_pkt[1][6] = 0;

		if (ictx->product == 0xffdc) {
			clock_enable_pkt[0][7] = 0x50;
			clock_enable_pkt[1][7] = 0x51;
		} else {
			clock_enable_pkt[0][7] = 0x88;
			clock_enable_pkt[1][7] = 0x8a;
		}

		break;

	case IMON_DISPLAY_TYPE_VFD:
		clock_enable_pkt[0][0] = year;
		clock_enable_pkt[0][1] = month-1;
		clock_enable_pkt[0][2] = day;
		clock_enable_pkt[0][3] = dow;
		clock_enable_pkt[0][4] = hour;
		clock_enable_pkt[0][5] = minute;
		clock_enable_pkt[0][6] = second;
		clock_enable_pkt[0][7] = 0x40;

		clock_enable_pkt[1][0] = 0;
		clock_enable_pkt[1][1] = 0;
		clock_enable_pkt[1][2] = 1;
		clock_enable_pkt[1][3] = 0;
		clock_enable_pkt[1][4] = 0;
		clock_enable_pkt[1][5] = 0;
		clock_enable_pkt[1][6] = 0;
		clock_enable_pkt[1][7] = 0x42;

		break;

	default:
		return -ENODEV;
	}

	for (i = 0; i < IMON_CLOCK_ENABLE_PACKETS; i++) {
		memcpy(ictx->usb_tx_buf, clock_enable_pkt[i], 8);
		retval = send_packet(ictx);
		if (retval) {
772
			pr_err("send_packet failed for packet %d\n", i);
773 774 775 776 777 778 779
			break;
		}
	}

	return retval;
}

780
/*
781 782
 * These are the sysfs functions to handle the association on the iMON 2.4G LT.
 */
783
static ssize_t associate_remote_show(struct device *d,
784 785 786 787 788 789 790 791 792 793
				     struct device_attribute *attr,
				     char *buf)
{
	struct imon_context *ictx = dev_get_drvdata(d);

	if (!ictx)
		return -ENODEV;

	mutex_lock(&ictx->lock);
	if (ictx->rf_isassociating)
794
		strscpy(buf, "associating\n", PAGE_SIZE);
795
	else
796
		strscpy(buf, "closed\n", PAGE_SIZE);
797

798
	dev_info(d, "Visit https://www.lirc.org/html/imon-24g.html for instructions on how to associate your iMON 2.4G DT/LT remote\n");
799 800 801 802
	mutex_unlock(&ictx->lock);
	return strlen(buf);
}

803
static ssize_t associate_remote_store(struct device *d,
804 805 806 807 808 809 810 811 812 813 814
				      struct device_attribute *attr,
				      const char *buf, size_t count)
{
	struct imon_context *ictx;

	ictx = dev_get_drvdata(d);

	if (!ictx)
		return -ENODEV;

	mutex_lock(&ictx->lock);
815
	ictx->rf_isassociating = true;
816 817 818 819 820 821
	send_associate_24g(ictx);
	mutex_unlock(&ictx->lock);

	return count;
}

822
/*
823 824
 * sysfs functions to control internal imon clock
 */
825
static ssize_t imon_clock_show(struct device *d,
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
			       struct device_attribute *attr, char *buf)
{
	struct imon_context *ictx = dev_get_drvdata(d);
	size_t len;

	if (!ictx)
		return -ENODEV;

	mutex_lock(&ictx->lock);

	if (!ictx->display_supported) {
		len = snprintf(buf, PAGE_SIZE, "Not supported.");
	} else {
		len = snprintf(buf, PAGE_SIZE,
			"To set the clock on your iMON display:\n"
			"# date \"+%%y %%m %%d %%w %%H %%M %%S\" > imon_clock\n"
			"%s", ictx->display_isopen ?
			"\nNOTE: imon device must be closed\n" : "");
	}

	mutex_unlock(&ictx->lock);

	return len;
}

851
static ssize_t imon_clock_store(struct device *d,
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
				struct device_attribute *attr,
				const char *buf, size_t count)
{
	struct imon_context *ictx = dev_get_drvdata(d);
	ssize_t retval;
	unsigned int year, month, day, dow, hour, minute, second;

	if (!ictx)
		return -ENODEV;

	mutex_lock(&ictx->lock);

	if (!ictx->display_supported) {
		retval = -ENODEV;
		goto exit;
	} else if (ictx->display_isopen) {
		retval = -EBUSY;
		goto exit;
	}

	if (sscanf(buf, "%u %u %u %u %u %u %u",	&year, &month, &day, &dow,
		   &hour, &minute, &second) != 7) {
		retval = -EINVAL;
		goto exit;
	}

	if ((month < 1 || month > 12) ||
	    (day < 1 || day > 31) || (dow > 6) ||
	    (hour > 23) || (minute > 59) || (second > 59)) {
		retval = -EINVAL;
		goto exit;
	}

	retval = send_set_imon_clock(ictx, year, month, day, dow,
				     hour, minute, second);
	if (retval)
		goto exit;

	retval = count;
exit:
	mutex_unlock(&ictx->lock);

	return retval;
}


898 899
static DEVICE_ATTR_RW(imon_clock);
static DEVICE_ATTR_RW(associate_remote);
900 901 902 903 904 905

static struct attribute *imon_display_sysfs_entries[] = {
	&dev_attr_imon_clock.attr,
	NULL
};

906
static const struct attribute_group imon_display_attr_group = {
907 908 909 910 911 912 913 914
	.attrs = imon_display_sysfs_entries
};

static struct attribute *imon_rf_sysfs_entries[] = {
	&dev_attr_associate_remote.attr,
	NULL
};

915
static const struct attribute_group imon_rf_attr_group = {
916 917 918
	.attrs = imon_rf_sysfs_entries
};

919
/*
920 921 922 923 924 925 926 927 928 929
 * Writes data to the VFD.  The iMON VFD is 2x16 characters
 * and requires data in 5 consecutive USB interrupt packets,
 * each packet but the last carrying 7 bytes.
 *
 * I don't know if the VFD board supports features such as
 * scrolling, clearing rows, blanking, etc. so at
 * the caller must provide a full screen of data.  If fewer
 * than 32 bytes are provided spaces will be appended to
 * generate a full screen.
 */
930
static ssize_t vfd_write(struct file *file, const char __user *buf,
931 932 933 934 935 936 937
			 size_t n_bytes, loff_t *pos)
{
	int i;
	int offset;
	int seq;
	int retval = 0;
	struct imon_context *ictx;
938
	static const unsigned char vfd_packet6[] = {
939 940
		0x01, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF };

941
	ictx = file->private_data;
942
	if (!ictx) {
943
		pr_err_ratelimited("no context for device\n");
944 945 946 947 948 949
		return -ENODEV;
	}

	mutex_lock(&ictx->lock);

	if (!ictx->dev_present_intf0) {
950
		pr_err_ratelimited("no iMON device present\n");
951 952 953 954 955
		retval = -ENODEV;
		goto exit;
	}

	if (n_bytes <= 0 || n_bytes > 32) {
956
		pr_err_ratelimited("invalid payload size\n");
957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981
		retval = -EINVAL;
		goto exit;
	}

	if (copy_from_user(ictx->tx.data_buf, buf, n_bytes)) {
		retval = -EFAULT;
		goto exit;
	}

	/* Pad with spaces */
	for (i = n_bytes; i < 32; ++i)
		ictx->tx.data_buf[i] = ' ';

	for (i = 32; i < 35; ++i)
		ictx->tx.data_buf[i] = 0xFF;

	offset = 0;
	seq = 0;

	do {
		memcpy(ictx->usb_tx_buf, ictx->tx.data_buf + offset, 7);
		ictx->usb_tx_buf[7] = (unsigned char) seq;

		retval = send_packet(ictx);
		if (retval) {
982
			pr_err_ratelimited("send packet #%d failed\n", seq / 2);
983 984 985 986 987 988 989 990 991 992 993 994 995
			goto exit;
		} else {
			seq += 2;
			offset += 7;
		}

	} while (offset < 35);

	/* Send packet #6 */
	memcpy(ictx->usb_tx_buf, &vfd_packet6, sizeof(vfd_packet6));
	ictx->usb_tx_buf[7] = (unsigned char) seq;
	retval = send_packet(ictx);
	if (retval)
996
		pr_err_ratelimited("send packet #%d failed\n", seq / 2);
997 998 999 1000 1001 1002 1003

exit:
	mutex_unlock(&ictx->lock);

	return (!retval) ? n_bytes : retval;
}

1004
/*
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
 * Writes data to the LCD.  The iMON OEM LCD screen expects 8-byte
 * packets. We accept data as 16 hexadecimal digits, followed by a
 * newline (to make it easy to drive the device from a command-line
 * -- even though the actual binary data is a bit complicated).
 *
 * The device itself is not a "traditional" text-mode display. It's
 * actually a 16x96 pixel bitmap display. That means if you want to
 * display text, you've got to have your own "font" and translate the
 * text into bitmaps for display. This is really flexible (you can
 * display whatever diacritics you need, and so on), but it's also
 * a lot more complicated than most LCDs...
 */
1017
static ssize_t lcd_write(struct file *file, const char __user *buf,
1018 1019 1020 1021 1022
			 size_t n_bytes, loff_t *pos)
{
	int retval = 0;
	struct imon_context *ictx;

1023
	ictx = file->private_data;
1024
	if (!ictx) {
1025
		pr_err_ratelimited("no context for device\n");
1026 1027 1028 1029 1030 1031
		return -ENODEV;
	}

	mutex_lock(&ictx->lock);

	if (!ictx->display_supported) {
1032
		pr_err_ratelimited("no iMON display present\n");
1033 1034 1035 1036 1037
		retval = -ENODEV;
		goto exit;
	}

	if (n_bytes != 8) {
1038 1039
		pr_err_ratelimited("invalid payload size: %d (expected 8)\n",
				   (int)n_bytes);
1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
		retval = -EINVAL;
		goto exit;
	}

	if (copy_from_user(ictx->usb_tx_buf, buf, 8)) {
		retval = -EFAULT;
		goto exit;
	}

	retval = send_packet(ictx);
	if (retval) {
1051
		pr_err_ratelimited("send packet failed!\n");
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
		goto exit;
	} else {
		dev_dbg(ictx->dev, "%s: write %d bytes to LCD\n",
			__func__, (int) n_bytes);
	}
exit:
	mutex_unlock(&ictx->lock);
	return (!retval) ? n_bytes : retval;
}

1062
/*
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
 * Callback function for USB core API: transmit data
 */
static void usb_tx_callback(struct urb *urb)
{
	struct imon_context *ictx;

	if (!urb)
		return;
	ictx = (struct imon_context *)urb->context;
	if (!ictx)
		return;

	ictx->tx.status = urb->status;

	/* notify waiters that write has finished */
1078
	ictx->tx.busy = false;
1079 1080 1081 1082
	smp_rmb(); /* ensure later readers know we're not busy */
	complete(&ictx->tx.finished);
}

1083
/*
1084 1085
 * report touchscreen input
 */
1086
static void imon_touch_display_timeout(struct timer_list *t)
1087
{
1088
	struct imon_context *ictx = from_timer(ictx, t, ttimer);
1089

1090
	if (ictx->display_type != IMON_DISPLAY_TYPE_VGA)
1091 1092 1093 1094 1095 1096 1097 1098
		return;

	input_report_abs(ictx->touch, ABS_X, ictx->touch_x);
	input_report_abs(ictx->touch, ABS_Y, ictx->touch_y);
	input_report_key(ictx->touch, BTN_TOUCH, 0x00);
	input_sync(ictx->touch);
}

1099
/*
1100 1101 1102 1103
 * iMON IR receivers support two different signal sets -- those used by
 * the iMON remotes, and those used by the Windows MCE remotes (which is
 * really just RC-6), but only one or the other at a time, as the signals
 * are decoded onboard the receiver.
1104 1105 1106 1107 1108 1109 1110 1111
 *
 * This function gets called two different ways, one way is from
 * rc_register_device, for initial protocol selection/setup, and the other is
 * via a userspace-initiated protocol change request, either by direct sysfs
 * prodding or by something like ir-keytable. In the rc_register_device case,
 * the imon context lock is already held, but when initiated from userspace,
 * it is not, so we must acquire it prior to calling send_packet, which
 * requires that the lock is held.
1112
 */
1113
static int imon_ir_change_protocol(struct rc_dev *rc, u64 *rc_proto)
1114 1115
{
	int retval;
1116
	struct imon_context *ictx = rc->priv;
1117
	struct device *dev = ictx->dev;
1118
	bool unlock = false;
1119 1120 1121
	unsigned char ir_proto_packet[] = {
		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x86 };

1122
	if (*rc_proto && !(*rc_proto & rc->allowed_protocols))
1123
		dev_warn(dev, "Looks like you're trying to use an IR protocol this device does not support\n");
1124

1125
	if (*rc_proto & RC_PROTO_BIT_RC6_MCE) {
1126 1127
		dev_dbg(dev, "Configuring IR receiver for MCE protocol\n");
		ir_proto_packet[0] = 0x01;
1128
		*rc_proto = RC_PROTO_BIT_RC6_MCE;
1129
	} else if (*rc_proto & RC_PROTO_BIT_IMON) {
1130
		dev_dbg(dev, "Configuring IR receiver for iMON protocol\n");
1131
		if (!pad_stabilize)
1132
			dev_dbg(dev, "PAD stabilize functionality disabled\n");
1133
		/* ir_proto_packet[0] = 0x00; // already the default */
1134
		*rc_proto = RC_PROTO_BIT_IMON;
1135
	} else {
1136
		dev_warn(dev, "Unsupported IR protocol specified, overriding to iMON IR protocol\n");
1137
		if (!pad_stabilize)
1138
			dev_dbg(dev, "PAD stabilize functionality disabled\n");
1139
		/* ir_proto_packet[0] = 0x00; // already the default */
1140
		*rc_proto = RC_PROTO_BIT_IMON;
1141 1142 1143 1144
	}

	memcpy(ictx->usb_tx_buf, &ir_proto_packet, sizeof(ir_proto_packet));

1145 1146 1147 1148 1149
	if (!mutex_is_locked(&ictx->lock)) {
		unlock = true;
		mutex_lock(&ictx->lock);
	}

1150
	retval = send_packet(ictx);
1151 1152 1153
	if (retval)
		goto out;

1154
	ictx->rc_proto = *rc_proto;
1155
	ictx->pad_mouse = false;
1156 1157

out:
1158 1159 1160
	if (unlock)
		mutex_unlock(&ictx->lock);

1161
	return retval;
1162 1163
}

1164
/*
1165 1166 1167 1168 1169 1170 1171 1172 1173
 * The directional pad behaves a bit differently, depending on whether this is
 * one of the older ffdc devices or a newer device. Newer devices appear to
 * have a higher resolution matrix for more precise mouse movement, but it
 * makes things overly sensitive in keyboard mode, so we do some interesting
 * contortions to make it less touchy. Older devices run through the same
 * routine with shorter timeout and a smaller threshold.
 */
static int stabilize(int a, int b, u16 timeout, u16 threshold)
{
1174 1175 1176
	ktime_t ct;
	static ktime_t prev_time;
	static ktime_t hit_time;
1177 1178
	static int x, y, prev_result, hits;
	int result = 0;
1179
	long msec, msec_hit;
1180

1181 1182 1183
	ct = ktime_get();
	msec = ktime_ms_delta(ct, prev_time);
	msec_hit = ktime_ms_delta(ct, hit_time);
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238

	if (msec > 100) {
		x = 0;
		y = 0;
		hits = 0;
	}

	x += a;
	y += b;

	prev_time = ct;

	if (abs(x) > threshold || abs(y) > threshold) {
		if (abs(y) > abs(x))
			result = (y > 0) ? 0x7F : 0x80;
		else
			result = (x > 0) ? 0x7F00 : 0x8000;

		x = 0;
		y = 0;

		if (result == prev_result) {
			hits++;

			if (hits > 3) {
				switch (result) {
				case 0x7F:
					y = 17 * threshold / 30;
					break;
				case 0x80:
					y -= 17 * threshold / 30;
					break;
				case 0x7F00:
					x = 17 * threshold / 30;
					break;
				case 0x8000:
					x -= 17 * threshold / 30;
					break;
				}
			}

			if (hits == 2 && msec_hit < timeout) {
				result = 0;
				hits = 1;
			}
		} else {
			prev_result = result;
			hits = 1;
			hit_time = ct;
		}
	}

	return result;
}

1239
static u32 imon_remote_key_lookup(struct imon_context *ictx, u32 scancode)
1240 1241 1242 1243 1244 1245
{
	u32 keycode;
	u32 release;
	bool is_release_code = false;

	/* Look for the initial press of a button */
1246
	keycode = rc_g_keycode_from_table(ictx->rdev, scancode);
1247 1248
	ictx->rc_toggle = 0x0;
	ictx->rc_scancode = scancode;
1249 1250 1251 1252

	/* Look for the release of a button */
	if (keycode == KEY_RESERVED) {
		release = scancode & ~0x4000;
1253
		keycode = rc_g_keycode_from_table(ictx->rdev, release);
1254 1255 1256 1257 1258 1259 1260 1261 1262
		if (keycode != KEY_RESERVED)
			is_release_code = true;
	}

	ictx->release_code = is_release_code;

	return keycode;
}

1263
static u32 imon_mce_key_lookup(struct imon_context *ictx, u32 scancode)
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277
{
	u32 keycode;

#define MCE_KEY_MASK 0x7000
#define MCE_TOGGLE_BIT 0x8000

	/*
	 * On some receivers, mce keys decode to 0x8000f04xx and 0x8000f84xx
	 * (the toggle bit flipping between alternating key presses), while
	 * on other receivers, we see 0x8000f74xx and 0x8000ff4xx. To keep
	 * the table trim, we always or in the bits to look up 0x8000ff4xx,
	 * but we can't or them into all codes, as some keys are decoded in
	 * a different way w/o the same use of the toggle bit...
	 */
1278
	if (scancode & 0x80000000)
1279 1280
		scancode = scancode | MCE_KEY_MASK | MCE_TOGGLE_BIT;

1281
	ictx->rc_scancode = scancode;
1282
	keycode = rc_g_keycode_from_table(ictx->rdev, scancode);
1283 1284 1285

	/* not used in mce mode, but make sure we know its false */
	ictx->release_code = false;
1286 1287 1288 1289

	return keycode;
}

1290
static u32 imon_panel_key_lookup(struct imon_context *ictx, u64 code)
1291
{
1292
	const struct imon_panel_key_table *key_table;
1293
	u32 keycode = KEY_RESERVED;
1294 1295 1296
	int i;

	key_table = ictx->dev_descr->key_table;
1297

1298 1299 1300
	for (i = 0; key_table[i].hw_code != 0; i++) {
		if (key_table[i].hw_code == (code | 0xffee)) {
			keycode = key_table[i].keycode;
1301
			break;
1302 1303
		}
	}
1304
	ictx->release_code = false;
1305 1306 1307 1308 1309 1310
	return keycode;
}

static bool imon_mouse_event(struct imon_context *ictx,
			     unsigned char *buf, int len)
{
1311
	signed char rel_x = 0x00, rel_y = 0x00;
1312
	u8 right_shift = 1;
1313
	bool mouse_input = true;
1314
	int dir = 0;
1315 1316 1317
	unsigned long flags;

	spin_lock_irqsave(&ictx->kc_lock, flags);
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346

	/* newer iMON device PAD or mouse button */
	if (ictx->product != 0xffdc && (buf[0] & 0x01) && len == 5) {
		rel_x = buf[2];
		rel_y = buf[3];
		right_shift = 1;
	/* 0xffdc iMON PAD or mouse button input */
	} else if (ictx->product == 0xffdc && (buf[0] & 0x40) &&
			!((buf[1] & 0x01) || ((buf[1] >> 2) & 0x01))) {
		rel_x = (buf[1] & 0x08) | (buf[1] & 0x10) >> 2 |
			(buf[1] & 0x20) >> 4 | (buf[1] & 0x40) >> 6;
		if (buf[0] & 0x02)
			rel_x |= ~0x0f;
		rel_x = rel_x + rel_x / 2;
		rel_y = (buf[2] & 0x08) | (buf[2] & 0x10) >> 2 |
			(buf[2] & 0x20) >> 4 | (buf[2] & 0x40) >> 6;
		if (buf[0] & 0x01)
			rel_y |= ~0x0f;
		rel_y = rel_y + rel_y / 2;
		right_shift = 2;
	/* some ffdc devices decode mouse buttons differently... */
	} else if (ictx->product == 0xffdc && (buf[0] == 0x68)) {
		right_shift = 2;
	/* ch+/- buttons, which we use for an emulated scroll wheel */
	} else if (ictx->kc == KEY_CHANNELUP && (buf[2] & 0x40) != 0x40) {
		dir = 1;
	} else if (ictx->kc == KEY_CHANNELDOWN && (buf[2] & 0x40) != 0x40) {
		dir = -1;
	} else
1347
		mouse_input = false;
1348

1349 1350
	spin_unlock_irqrestore(&ictx->kc_lock, flags);

1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364
	if (mouse_input) {
		dev_dbg(ictx->dev, "sending mouse data via input subsystem\n");

		if (dir) {
			input_report_rel(ictx->idev, REL_WHEEL, dir);
		} else if (rel_x || rel_y) {
			input_report_rel(ictx->idev, REL_X, rel_x);
			input_report_rel(ictx->idev, REL_Y, rel_y);
		} else {
			input_report_key(ictx->idev, BTN_LEFT, buf[1] & 0x1);
			input_report_key(ictx->idev, BTN_RIGHT,
					 buf[1] >> right_shift & 0x1);
		}
		input_sync(ictx->idev);
1365
		spin_lock_irqsave(&ictx->kc_lock, flags);
1366
		ictx->last_keycode = ictx->kc;
1367
		spin_unlock_irqrestore(&ictx->kc_lock, flags);
1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386
	}

	return mouse_input;
}

static void imon_touch_event(struct imon_context *ictx, unsigned char *buf)
{
	mod_timer(&ictx->ttimer, jiffies + TOUCH_TIMEOUT);
	ictx->touch_x = (buf[0] << 4) | (buf[1] >> 4);
	ictx->touch_y = 0xfff - ((buf[2] << 4) | (buf[1] & 0xf));
	input_report_abs(ictx->touch, ABS_X, ictx->touch_x);
	input_report_abs(ictx->touch, ABS_Y, ictx->touch_y);
	input_report_key(ictx->touch, BTN_TOUCH, 0x01);
	input_sync(ictx->touch);
}

static void imon_pad_to_keys(struct imon_context *ictx, unsigned char *buf)
{
	int dir = 0;
1387
	signed char rel_x = 0x00, rel_y = 0x00;
1388
	u16 timeout, threshold;
1389
	u32 scancode = KEY_RESERVED;
1390
	unsigned long flags;
1391 1392 1393 1394 1395 1396

	/*
	 * The imon directional pad functions more like a touchpad. Bytes 3 & 4
	 * contain a position coordinate (x,y), with each component ranging
	 * from -14 to 14. We want to down-sample this to only 4 discrete values
	 * for up/down/left/right arrow keys. Also, when you get too close to
Lucas De Marchi's avatar
Lucas De Marchi committed
1397
	 * diagonals, it has a tendency to jump back and forth, so lets try to
1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408
	 * ignore when they get too close.
	 */
	if (ictx->product != 0xffdc) {
		/* first, pad to 8 bytes so it conforms with everything else */
		buf[5] = buf[6] = buf[7] = 0;
		timeout = 500;	/* in msecs */
		/* (2*threshold) x (2*threshold) square */
		threshold = pad_thresh ? pad_thresh : 28;
		rel_x = buf[2];
		rel_y = buf[3];

1409
		if (ictx->rc_proto == RC_PROTO_BIT_IMON && pad_stabilize) {
1410 1411 1412 1413
			if ((buf[1] == 0) && ((rel_x != 0) || (rel_y != 0))) {
				dir = stabilize((int)rel_x, (int)rel_y,
						timeout, threshold);
				if (!dir) {
1414 1415
					spin_lock_irqsave(&ictx->kc_lock,
							  flags);
1416
					ictx->kc = KEY_UNKNOWN;
1417 1418
					spin_unlock_irqrestore(&ictx->kc_lock,
							       flags);
1419 1420 1421 1422
					return;
				}
				buf[2] = dir & 0xFF;
				buf[3] = (dir >> 8) & 0xFF;
1423
				scancode = be32_to_cpu(*((__be32 *)buf));
1424 1425
			}
		} else {
1426 1427 1428 1429
			/*
			 * Hack alert: instead of using keycodes, we have
			 * to use hard-coded scancodes here...
			 */
1430 1431 1432
			if (abs(rel_y) > abs(rel_x)) {
				buf[2] = (rel_y > 0) ? 0x7F : 0x80;
				buf[3] = 0;
1433 1434 1435 1436
				if (rel_y > 0)
					scancode = 0x01007f00; /* KEY_DOWN */
				else
					scancode = 0x01008000; /* KEY_UP */
1437 1438 1439
			} else {
				buf[2] = 0;
				buf[3] = (rel_x > 0) ? 0x7F : 0x80;
1440 1441 1442 1443
				if (rel_x > 0)
					scancode = 0x0100007f; /* KEY_RIGHT */
				else
					scancode = 0x01000080; /* KEY_LEFT */
1444 1445 1446 1447 1448 1449 1450 1451 1452
			}
		}

	/*
	 * Handle on-board decoded pad events for e.g. older VFD/iMON-Pad
	 * device (15c2:ffdc). The remote generates various codes from
	 * 0x68nnnnB7 to 0x6AnnnnB7, the left mouse button generates
	 * 0x688301b7 and the right one 0x688481b7. All other keys generate
	 * 0x2nnnnnnn. Position coordinate is encoded in buf[1] and buf[2] with
1453
	 * reversed endianness. Extract direction from buffer, rotate endianness,
1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475
	 * adjust sign and feed the values into stabilize(). The resulting codes
	 * will be 0x01008000, 0x01007F00, which match the newer devices.
	 */
	} else {
		timeout = 10;	/* in msecs */
		/* (2*threshold) x (2*threshold) square */
		threshold = pad_thresh ? pad_thresh : 15;

		/* buf[1] is x */
		rel_x = (buf[1] & 0x08) | (buf[1] & 0x10) >> 2 |
			(buf[1] & 0x20) >> 4 | (buf[1] & 0x40) >> 6;
		if (buf[0] & 0x02)
			rel_x |= ~0x10+1;
		/* buf[2] is y */
		rel_y = (buf[2] & 0x08) | (buf[2] & 0x10) >> 2 |
			(buf[2] & 0x20) >> 4 | (buf[2] & 0x40) >> 6;
		if (buf[0] & 0x01)
			rel_y |= ~0x10+1;

		buf[0] = 0x01;
		buf[1] = buf[4] = buf[5] = buf[6] = buf[7] = 0;

1476
		if (ictx->rc_proto == RC_PROTO_BIT_IMON && pad_stabilize) {
1477 1478 1479
			dir = stabilize((int)rel_x, (int)rel_y,
					timeout, threshold);
			if (!dir) {
1480
				spin_lock_irqsave(&ictx->kc_lock, flags);
1481
				ictx->kc = KEY_UNKNOWN;
1482
				spin_unlock_irqrestore(&ictx->kc_lock, flags);
1483 1484 1485 1486
				return;
			}
			buf[2] = dir & 0xFF;
			buf[3] = (dir >> 8) & 0xFF;
1487
			scancode = be32_to_cpu(*((__be32 *)buf));
1488
		} else {
1489 1490 1491 1492
			/*
			 * Hack alert: instead of using keycodes, we have
			 * to use hard-coded scancodes here...
			 */
1493 1494 1495
			if (abs(rel_y) > abs(rel_x)) {
				buf[2] = (rel_y > 0) ? 0x7F : 0x80;
				buf[3] = 0;
1496 1497 1498 1499
				if (rel_y > 0)
					scancode = 0x01007f00; /* KEY_DOWN */
				else
					scancode = 0x01008000; /* KEY_UP */
1500 1501 1502
			} else {
				buf[2] = 0;
				buf[3] = (rel_x > 0) ? 0x7F : 0x80;
1503 1504 1505 1506
				if (rel_x > 0)
					scancode = 0x0100007f; /* KEY_RIGHT */
				else
					scancode = 0x01000080; /* KEY_LEFT */
1507 1508 1509
			}
		}
	}
1510

1511 1512
	if (scancode) {
		spin_lock_irqsave(&ictx->kc_lock, flags);
1513
		ictx->kc = imon_remote_key_lookup(ictx, scancode);
1514 1515
		spin_unlock_irqrestore(&ictx->kc_lock, flags);
	}
1516 1517
}

1518
/*
1519 1520 1521 1522
 * figure out if these is a press or a release. We don't actually
 * care about repeats, as those will be auto-generated within the IR
 * subsystem for repeating scancodes.
 */
1523 1524 1525 1526
static int imon_parse_press_type(struct imon_context *ictx,
				 unsigned char *buf, u8 ktype)
{
	int press_type = 0;
1527 1528 1529
	unsigned long flags;

	spin_lock_irqsave(&ictx->kc_lock, flags);
1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544

	/* key release of 0x02XXXXXX key */
	if (ictx->kc == KEY_RESERVED && buf[0] == 0x02 && buf[3] == 0x00)
		ictx->kc = ictx->last_keycode;

	/* mouse button release on (some) 0xffdc devices */
	else if (ictx->kc == KEY_RESERVED && buf[0] == 0x68 && buf[1] == 0x82 &&
		 buf[2] == 0x81 && buf[3] == 0xb7)
		ictx->kc = ictx->last_keycode;

	/* mouse button release on (some other) 0xffdc devices */
	else if (ictx->kc == KEY_RESERVED && buf[0] == 0x01 && buf[1] == 0x00 &&
		 buf[2] == 0x81 && buf[3] == 0xb7)
		ictx->kc = ictx->last_keycode;

1545
	/* mce-specific button handling, no keyup events */
1546
	else if (ktype == IMON_KEY_MCE) {
1547 1548
		ictx->rc_toggle = buf[2];
		press_type = 1;
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561

	/* incoherent or irrelevant data */
	} else if (ictx->kc == KEY_RESERVED)
		press_type = -EINVAL;

	/* key release of 0xXXXXXXb7 key */
	else if (ictx->release_code)
		press_type = 0;

	/* this is a button press */
	else
		press_type = 1;

1562 1563
	spin_unlock_irqrestore(&ictx->kc_lock, flags);

1564 1565 1566
	return press_type;
}

1567
/*
1568 1569
 * Process the incoming packet
 */
1570
static void imon_incoming_packet(struct imon_context *ictx,
1571 1572 1573 1574 1575
				 struct urb *urb, int intf)
{
	int len = urb->actual_length;
	unsigned char *buf = urb->transfer_buffer;
	struct device *dev = ictx->dev;
1576
	unsigned long flags;
1577
	u32 kc;
1578
	u64 scancode;
1579
	int press_type = 0;
1580 1581
	ktime_t t;
	static ktime_t prev_time;
1582
	u8 ktype;
1583 1584

	/* filter out junk data on the older 0xffdc imon devices */
1585
	if ((buf[0] == 0xff) && (buf[1] == 0xff) && (buf[2] == 0xff))
1586 1587 1588 1589
		return;

	/* Figure out what key was pressed */
	if (len == 8 && buf[7] == 0xee) {
1590
		scancode = be64_to_cpu(*((__be64 *)buf));
1591
		ktype = IMON_KEY_PANEL;
1592
		kc = imon_panel_key_lookup(ictx, scancode);
1593
		ictx->release_code = false;
1594
	} else {
1595
		scancode = be32_to_cpu(*((__be32 *)buf));
1596
		if (ictx->rc_proto == RC_PROTO_BIT_RC6_MCE) {
1597
			ktype = IMON_KEY_IMON;
1598 1599
			if (buf[0] == 0x80)
				ktype = IMON_KEY_MCE;
1600 1601 1602 1603 1604
			kc = imon_mce_key_lookup(ictx, scancode);
		} else {
			ktype = IMON_KEY_IMON;
			kc = imon_remote_key_lookup(ictx, scancode);
		}
1605 1606
	}

1607
	spin_lock_irqsave(&ictx->kc_lock, flags);
1608 1609 1610 1611
	/* keyboard/mouse mode toggle button */
	if (kc == KEY_KEYBOARD && !ictx->release_code) {
		ictx->last_keycode = kc;
		if (!nomouse) {
1612
			ictx->pad_mouse = !ictx->pad_mouse;
1613 1614
			dev_dbg(dev, "toggling to %s mode\n",
				ictx->pad_mouse ? "mouse" : "keyboard");
1615
			spin_unlock_irqrestore(&ictx->kc_lock, flags);
1616 1617
			return;
		} else {
1618
			ictx->pad_mouse = false;
1619 1620 1621 1622 1623
			dev_dbg(dev, "mouse mode disabled, passing key value\n");
		}
	}

	ictx->kc = kc;
1624
	spin_unlock_irqrestore(&ictx->kc_lock, flags);
1625 1626

	/* send touchscreen events through input subsystem if touchpad data */
1627
	if (ictx->touch && len == 8 && buf[7] == 0x86) {
1628
		imon_touch_event(ictx, buf);
1629
		return;
1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645

	/* look for mouse events with pad in mouse mode */
	} else if (ictx->pad_mouse) {
		if (imon_mouse_event(ictx, buf, len))
			return;
	}

	/* Now for some special handling to convert pad input to arrow keys */
	if (((len == 5) && (buf[0] == 0x01) && (buf[4] == 0x00)) ||
	    ((len == 8) && (buf[0] & 0x40) &&
	     !(buf[1] & 0x1 || buf[1] >> 2 & 0x1))) {
		len = 8;
		imon_pad_to_keys(ictx, buf);
	}

	if (debug) {
1646 1647
		printk(KERN_INFO "intf%d decoded packet: %*ph\n",
		       intf, len, buf);
1648 1649 1650 1651 1652 1653
	}

	press_type = imon_parse_press_type(ictx, buf, ktype);
	if (press_type < 0)
		goto not_input_data;

1654 1655
	if (ktype != IMON_KEY_PANEL) {
		if (press_type == 0)
1656
			rc_keyup(ictx->rdev);
1657
		else {
1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669
			enum rc_proto proto;

			if (ictx->rc_proto == RC_PROTO_BIT_RC6_MCE)
				proto = RC_PROTO_RC6_MCE;
			else if (ictx->rc_proto == RC_PROTO_BIT_IMON)
				proto = RC_PROTO_IMON;
			else
				return;

			rc_keydown(ictx->rdev, proto, ictx->rc_scancode,
				   ictx->rc_toggle);

1670
			spin_lock_irqsave(&ictx->kc_lock, flags);
1671
			ictx->last_keycode = ictx->kc;
1672
			spin_unlock_irqrestore(&ictx->kc_lock, flags);
1673 1674 1675
		}
		return;
	}
1676

1677
	/* Only panel type events left to process now */
1678 1679
	spin_lock_irqsave(&ictx->kc_lock, flags);

1680
	t = ktime_get();
1681 1682 1683 1684 1685
	/* KEY repeats from knob and panel that need to be suppressed */
	if (ictx->kc == KEY_MUTE ||
	    ictx->dev_descr->flags & IMON_SUPPRESS_REPEATED_KEYS) {
		if (ictx->kc == ictx->last_keycode &&
		    ktime_ms_delta(t, prev_time) < ictx->idev->rep[REP_DELAY]) {
1686
			spin_unlock_irqrestore(&ictx->kc_lock, flags);
1687
			return;
1688
		}
1689
	}
1690

1691
	prev_time = t;
1692
	kc = ictx->kc;
1693

1694
	spin_unlock_irqrestore(&ictx->kc_lock, flags);
1695

1696 1697
	input_report_key(ictx->idev, kc, press_type);
	input_sync(ictx->idev);
1698

1699
	/* panel keys don't generate a release */
1700 1701
	input_report_key(ictx->idev, kc, 0);
	input_sync(ictx->idev);
1702

1703
	spin_lock_irqsave(&ictx->kc_lock, flags);
1704
	ictx->last_keycode = kc;
1705
	spin_unlock_irqrestore(&ictx->kc_lock, flags);
1706 1707 1708 1709 1710

	return;

not_input_data:
	if (len != 8) {
1711 1712
		dev_warn(dev, "imon %s: invalid incoming packet size (len = %d, intf%d)\n",
			 __func__, len, intf);
1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725
		return;
	}

	/* iMON 2.4G associate frame */
	if (buf[0] == 0x00 &&
	    buf[2] == 0xFF &&				/* REFID */
	    buf[3] == 0xFF &&
	    buf[4] == 0xFF &&
	    buf[5] == 0xFF &&				/* iMON 2.4G */
	   ((buf[6] == 0x4E && buf[7] == 0xDF) ||	/* LT */
	    (buf[6] == 0x5E && buf[7] == 0xDF))) {	/* DT */
		dev_warn(dev, "%s: remote associated refid=%02X\n",
			 __func__, buf[1]);
1726
		ictx->rf_isassociating = false;
1727 1728 1729
	}
}

1730
/*
1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741
 * Callback function for USB core API: receive data
 */
static void usb_rx_callback_intf0(struct urb *urb)
{
	struct imon_context *ictx;
	int intfnum = 0;

	if (!urb)
		return;

	ictx = (struct imon_context *)urb->context;
1742
	if (!ictx)
1743 1744
		return;

1745 1746 1747 1748 1749 1750 1751 1752
	/*
	 * if we get a callback before we're done configuring the hardware, we
	 * can't yet process the data, as there's nowhere to send it, but we
	 * still need to submit a new rx URB to avoid wedging the hardware
	 */
	if (!ictx->dev_present_intf0)
		goto out;

1753 1754 1755 1756 1757 1758 1759 1760
	switch (urb->status) {
	case -ENOENT:		/* usbcore unlink successful! */
		return;

	case -ESHUTDOWN:	/* transport endpoint was shut down */
		break;

	case 0:
1761
		imon_incoming_packet(ictx, urb, intfnum);
1762 1763 1764 1765 1766 1767 1768 1769
		break;

	default:
		dev_warn(ictx->dev, "imon %s: status(%d): ignored\n",
			 __func__, urb->status);
		break;
	}

1770
out:
1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782
	usb_submit_urb(ictx->rx_urb_intf0, GFP_ATOMIC);
}

static void usb_rx_callback_intf1(struct urb *urb)
{
	struct imon_context *ictx;
	int intfnum = 1;

	if (!urb)
		return;

	ictx = (struct imon_context *)urb->context;
1783
	if (!ictx)
1784 1785
		return;

1786 1787 1788 1789 1790 1791 1792 1793
	/*
	 * if we get a callback before we're done configuring the hardware, we
	 * can't yet process the data, as there's nowhere to send it, but we
	 * still need to submit a new rx URB to avoid wedging the hardware
	 */
	if (!ictx->dev_present_intf1)
		goto out;

1794 1795 1796 1797 1798 1799 1800 1801
	switch (urb->status) {
	case -ENOENT:		/* usbcore unlink successful! */
		return;

	case -ESHUTDOWN:	/* transport endpoint was shut down */
		break;

	case 0:
1802
		imon_incoming_packet(ictx, urb, intfnum);
1803 1804 1805 1806 1807 1808 1809 1810
		break;

	default:
		dev_warn(ictx->dev, "imon %s: status(%d): ignored\n",
			 __func__, urb->status);
		break;
	}

1811
out:
1812 1813 1814
	usb_submit_urb(ictx->rx_urb_intf1, GFP_ATOMIC);
}

1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827
/*
 * The 0x15c2:0xffdc device ID was used for umpteen different imon
 * devices, and all of them constantly spew interrupts, even when there
 * is no actual data to report. However, byte 6 of this buffer looks like
 * its unique across device variants, so we're trying to key off that to
 * figure out which display type (if any) and what IR protocol the device
 * actually supports. These devices have their IR protocol hard-coded into
 * their firmware, they can't be changed on the fly like the newer hardware.
 */
static void imon_get_ffdc_type(struct imon_context *ictx)
{
	u8 ffdc_cfg_byte = ictx->usb_rx_buf[6];
	u8 detected_display_type = IMON_DISPLAY_TYPE_NONE;
1828
	u64 allowed_protos = RC_PROTO_BIT_IMON;
1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848

	switch (ffdc_cfg_byte) {
	/* iMON Knob, no display, iMON IR + vol knob */
	case 0x21:
		dev_info(ictx->dev, "0xffdc iMON Knob, iMON IR");
		ictx->display_supported = false;
		break;
	/* iMON 2.4G LT (usb stick), no display, iMON RF */
	case 0x4e:
		dev_info(ictx->dev, "0xffdc iMON 2.4G LT, iMON RF");
		ictx->display_supported = false;
		ictx->rf_device = true;
		break;
	/* iMON VFD, no IR (does have vol knob tho) */
	case 0x35:
		dev_info(ictx->dev, "0xffdc iMON VFD + knob, no IR");
		detected_display_type = IMON_DISPLAY_TYPE_VFD;
		break;
	/* iMON VFD, iMON IR */
	case 0x24:
1849
	case 0x30:
1850 1851 1852 1853 1854
	case 0x85:
		dev_info(ictx->dev, "0xffdc iMON VFD, iMON IR");
		detected_display_type = IMON_DISPLAY_TYPE_VFD;
		break;
	/* iMON VFD, MCE IR */
1855
	case 0x46:
1856 1857 1858
	case 0x9e:
		dev_info(ictx->dev, "0xffdc iMON VFD, MCE IR");
		detected_display_type = IMON_DISPLAY_TYPE_VFD;
1859
		allowed_protos = RC_PROTO_BIT_RC6_MCE;
1860
		break;
1861 1862 1863 1864 1865 1866
	/* iMON VFD, iMON or MCE IR */
	case 0x7e:
		dev_info(ictx->dev, "0xffdc iMON VFD, iMON or MCE IR");
		detected_display_type = IMON_DISPLAY_TYPE_VFD;
		allowed_protos |= RC_PROTO_BIT_RC6_MCE;
		break;
1867 1868 1869 1870
	/* iMON LCD, MCE IR */
	case 0x9f:
		dev_info(ictx->dev, "0xffdc iMON LCD, MCE IR");
		detected_display_type = IMON_DISPLAY_TYPE_LCD;
1871
		allowed_protos = RC_PROTO_BIT_RC6_MCE;
1872
		break;
1873 1874 1875 1876 1877
	/* no display, iMON IR */
	case 0x26:
		dev_info(ictx->dev, "0xffdc iMON Inside, iMON IR");
		ictx->display_supported = false;
		break;
1878 1879 1880 1881 1882 1883 1884 1885
	/* Soundgraph iMON UltraBay */
	case 0x98:
		dev_info(ictx->dev, "0xffdc iMON UltraBay, LCD + IR");
		detected_display_type = IMON_DISPLAY_TYPE_LCD;
		allowed_protos = RC_PROTO_BIT_IMON | RC_PROTO_BIT_RC6_MCE;
		ictx->dev_descr = &ultrabay_table;
		break;

1886
	default:
1887
		dev_info(ictx->dev, "Unknown 0xffdc device, defaulting to VFD and iMON IR");
1888
		detected_display_type = IMON_DISPLAY_TYPE_VFD;
1889 1890 1891 1892
		/*
		 * We don't know which one it is, allow user to set the
		 * RC6 one from userspace if IMON wasn't correct.
		 */
1893
		allowed_protos |= RC_PROTO_BIT_RC6_MCE;
1894 1895 1896 1897 1898 1899
		break;
	}

	printk(KERN_CONT " (id 0x%02x)\n", ffdc_cfg_byte);

	ictx->display_type = detected_display_type;
1900
	ictx->rc_proto = allowed_protos;
1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945
}

static void imon_set_display_type(struct imon_context *ictx)
{
	u8 configured_display_type = IMON_DISPLAY_TYPE_VFD;

	/*
	 * Try to auto-detect the type of display if the user hasn't set
	 * it by hand via the display_type modparam. Default is VFD.
	 */

	if (display_type == IMON_DISPLAY_TYPE_AUTO) {
		switch (ictx->product) {
		case 0xffdc:
			/* set in imon_get_ffdc_type() */
			configured_display_type = ictx->display_type;
			break;
		case 0x0034:
		case 0x0035:
			configured_display_type = IMON_DISPLAY_TYPE_VGA;
			break;
		case 0x0038:
		case 0x0039:
		case 0x0045:
			configured_display_type = IMON_DISPLAY_TYPE_LCD;
			break;
		case 0x003c:
		case 0x0041:
		case 0x0042:
		case 0x0043:
			configured_display_type = IMON_DISPLAY_TYPE_NONE;
			ictx->display_supported = false;
			break;
		case 0x0036:
		case 0x0044:
		default:
			configured_display_type = IMON_DISPLAY_TYPE_VFD;
			break;
		}
	} else {
		configured_display_type = display_type;
		if (display_type == IMON_DISPLAY_TYPE_NONE)
			ictx->display_supported = false;
		else
			ictx->display_supported = true;
1946 1947
		dev_info(ictx->dev, "%s: overriding display type to %d via modparam\n",
			 __func__, display_type);
1948 1949 1950 1951 1952
	}

	ictx->display_type = configured_display_type;
}

1953
static struct rc_dev *imon_init_rdev(struct imon_context *ictx)
1954
{
1955
	struct rc_dev *rdev;
1956
	int ret;
1957 1958
	static const unsigned char fp_packet[] = {
		0x40, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x88 };
1959

1960
	rdev = rc_allocate_device(RC_DRIVER_SCANCODE);
1961
	if (!rdev) {
1962 1963 1964 1965 1966 1967 1968 1969 1970 1971
		dev_err(ictx->dev, "remote control dev allocation failed\n");
		goto out;
	}

	snprintf(ictx->name_rdev, sizeof(ictx->name_rdev),
		 "iMON Remote (%04x:%04x)", ictx->vendor, ictx->product);
	usb_make_path(ictx->usbdev_intf0, ictx->phys_rdev,
		      sizeof(ictx->phys_rdev));
	strlcat(ictx->phys_rdev, "/input0", sizeof(ictx->phys_rdev));

1972
	rdev->device_name = ictx->name_rdev;
1973 1974
	rdev->input_phys = ictx->phys_rdev;
	usb_to_input_id(ictx->usbdev_intf0, &rdev->input_id);
1975 1976
	rdev->dev.parent = ictx->dev;

1977
	rdev->priv = ictx;
1978
	/* iMON PAD or MCE */
1979
	rdev->allowed_protocols = RC_PROTO_BIT_IMON | RC_PROTO_BIT_RC6_MCE;
1980 1981
	rdev->change_protocol = imon_ir_change_protocol;
	rdev->driver_name = MOD_NAME;
1982

1983 1984 1985 1986 1987 1988 1989
	/* Enable front-panel buttons and/or knobs */
	memcpy(ictx->usb_tx_buf, &fp_packet, sizeof(fp_packet));
	ret = send_packet(ictx);
	/* Not fatal, but warn about it */
	if (ret)
		dev_info(ictx->dev, "panel buttons/knobs setup failed\n");

1990
	if (ictx->product == 0xffdc) {
1991
		imon_get_ffdc_type(ictx);
1992
		rdev->allowed_protocols = ictx->rc_proto;
1993
	}
1994 1995 1996

	imon_set_display_type(ictx);

1997
	if (ictx->rc_proto == RC_PROTO_BIT_RC6_MCE)
1998 1999 2000 2001
		rdev->map_name = RC_MAP_IMON_MCE;
	else
		rdev->map_name = RC_MAP_IMON_PAD;

2002
	ret = rc_register_device(rdev);
2003 2004 2005 2006 2007 2008 2009 2010
	if (ret < 0) {
		dev_err(ictx->dev, "remote input dev register failed\n");
		goto out;
	}

	return rdev;

out:
2011
	rc_free_device(rdev);
2012 2013 2014
	return NULL;
}

2015 2016
static struct input_dev *imon_init_idev(struct imon_context *ictx)
{
2017
	const struct imon_panel_key_table *key_table;
2018 2019 2020
	struct input_dev *idev;
	int ret, i;

2021 2022
	key_table = ictx->dev_descr->key_table;

2023
	idev = input_allocate_device();
2024
	if (!idev)
2025
		goto out;
2026 2027

	snprintf(ictx->name_idev, sizeof(ictx->name_idev),
2028 2029
		 "iMON Panel, Knob and Mouse(%04x:%04x)",
		 ictx->vendor, ictx->product);
2030 2031 2032 2033
	idev->name = ictx->name_idev;

	usb_make_path(ictx->usbdev_intf0, ictx->phys_idev,
		      sizeof(ictx->phys_idev));
2034
	strlcat(ictx->phys_idev, "/input1", sizeof(ictx->phys_idev));
2035 2036
	idev->phys = ictx->phys_idev;

2037
	idev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP) | BIT_MASK(EV_REL);
2038 2039 2040 2041 2042 2043 2044

	idev->keybit[BIT_WORD(BTN_MOUSE)] =
		BIT_MASK(BTN_LEFT) | BIT_MASK(BTN_RIGHT);
	idev->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y) |
		BIT_MASK(REL_WHEEL);

	/* panel and/or knob code support */
2045 2046
	for (i = 0; key_table[i].hw_code != 0; i++) {
		u32 kc = key_table[i].keycode;
2047 2048 2049 2050 2051
		__set_bit(kc, idev->keybit);
	}

	usb_to_input_id(ictx->usbdev_intf0, &idev->id);
	idev->dev.parent = ictx->dev;
2052
	input_set_drvdata(idev, ictx);
2053

2054
	ret = input_register_device(idev);
2055
	if (ret < 0) {
2056 2057
		dev_err(ictx->dev, "input dev register failed\n");
		goto out;
2058 2059 2060 2061
	}

	return idev;

2062
out:
2063 2064 2065 2066 2067 2068 2069 2070 2071 2072
	input_free_device(idev);
	return NULL;
}

static struct input_dev *imon_init_touch(struct imon_context *ictx)
{
	struct input_dev *touch;
	int ret;

	touch = input_allocate_device();
2073
	if (!touch)
2074 2075 2076 2077 2078 2079 2080 2081 2082
		goto touch_alloc_failed;

	snprintf(ictx->name_touch, sizeof(ictx->name_touch),
		 "iMON USB Touchscreen (%04x:%04x)",
		 ictx->vendor, ictx->product);
	touch->name = ictx->name_touch;

	usb_make_path(ictx->usbdev_intf1, ictx->phys_touch,
		      sizeof(ictx->phys_touch));
2083
	strlcat(ictx->phys_touch, "/input2", sizeof(ictx->phys_touch));
2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107
	touch->phys = ictx->phys_touch;

	touch->evbit[0] =
		BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
	touch->keybit[BIT_WORD(BTN_TOUCH)] =
		BIT_MASK(BTN_TOUCH);
	input_set_abs_params(touch, ABS_X,
			     0x00, 0xfff, 0, 0);
	input_set_abs_params(touch, ABS_Y,
			     0x00, 0xfff, 0, 0);

	input_set_drvdata(touch, ictx);

	usb_to_input_id(ictx->usbdev_intf1, &touch->id);
	touch->dev.parent = ictx->dev;
	ret = input_register_device(touch);
	if (ret <  0) {
		dev_info(ictx->dev, "touchscreen input dev register failed\n");
		goto touch_register_failed;
	}

	return touch;

touch_register_failed:
2108
	input_free_device(touch);
2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122

touch_alloc_failed:
	return NULL;
}

static bool imon_find_endpoints(struct imon_context *ictx,
				struct usb_host_interface *iface_desc)
{
	struct usb_endpoint_descriptor *ep;
	struct usb_endpoint_descriptor *rx_endpoint = NULL;
	struct usb_endpoint_descriptor *tx_endpoint = NULL;
	int ifnum = iface_desc->desc.bInterfaceNumber;
	int num_endpts = iface_desc->desc.bNumEndpoints;
	int i, ep_dir, ep_type;
2123 2124 2125
	bool ir_ep_found = false;
	bool display_ep_found = false;
	bool tx_control = false;
2126 2127 2128 2129 2130 2131 2132 2133 2134

	/*
	 * Scan the endpoint list and set:
	 *	first input endpoint = IR endpoint
	 *	first output endpoint = display endpoint
	 */
	for (i = 0; i < num_endpts && !(ir_ep_found && display_ep_found); ++i) {
		ep = &iface_desc->endpoint[i].desc;
		ep_dir = ep->bEndpointAddress & USB_ENDPOINT_DIR_MASK;
2135
		ep_type = usb_endpoint_type(ep);
2136 2137 2138 2139 2140

		if (!ir_ep_found && ep_dir == USB_DIR_IN &&
		    ep_type == USB_ENDPOINT_XFER_INT) {

			rx_endpoint = ep;
2141
			ir_ep_found = true;
2142 2143 2144 2145 2146
			dev_dbg(ictx->dev, "%s: found IR endpoint\n", __func__);

		} else if (!display_ep_found && ep_dir == USB_DIR_OUT &&
			   ep_type == USB_ENDPOINT_XFER_INT) {
			tx_endpoint = ep;
2147
			display_ep_found = true;
2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167
			dev_dbg(ictx->dev, "%s: found display endpoint\n", __func__);
		}
	}

	if (ifnum == 0) {
		ictx->rx_endpoint_intf0 = rx_endpoint;
		/*
		 * tx is used to send characters to lcd/vfd, associate RF
		 * remotes, set IR protocol, and maybe more...
		 */
		ictx->tx_endpoint = tx_endpoint;
	} else {
		ictx->rx_endpoint_intf1 = rx_endpoint;
	}

	/*
	 * If we didn't find a display endpoint, this is probably one of the
	 * newer iMON devices that use control urb instead of interrupt
	 */
	if (!display_ep_found) {
2168 2169
		tx_control = true;
		display_ep_found = true;
2170 2171
		dev_dbg(ictx->dev, "%s: device uses control endpoint, not interface OUT endpoint\n",
			__func__);
2172 2173 2174 2175 2176 2177 2178 2179
	}

	/*
	 * Some iMON receivers have no display. Unfortunately, it seems
	 * that SoundGraph recycles device IDs between devices both with
	 * and without... :\
	 */
	if (ictx->display_type == IMON_DISPLAY_TYPE_NONE) {
2180
		display_ep_found = false;
2181 2182 2183 2184 2185 2186 2187 2188
		dev_dbg(ictx->dev, "%s: device has no display\n", __func__);
	}

	/*
	 * iMON Touch devices have a VGA touchscreen, but no "display", as
	 * that refers to e.g. /dev/lcd0 (a character device LCD or VFD).
	 */
	if (ictx->display_type == IMON_DISPLAY_TYPE_VGA) {
2189
		display_ep_found = false;
2190 2191 2192 2193 2194
		dev_dbg(ictx->dev, "%s: iMON Touch device found\n", __func__);
	}

	/* Input endpoint is mandatory */
	if (!ir_ep_found)
2195
		pr_err("no valid input (IR) endpoint found\n");
2196 2197 2198 2199 2200 2201 2202 2203 2204 2205

	ictx->tx_control = tx_control;

	if (display_ep_found)
		ictx->display_supported = true;

	return ir_ep_found;

}

2206 2207
static struct imon_context *imon_init_intf0(struct usb_interface *intf,
					    const struct usb_device_id *id)
2208 2209 2210 2211 2212 2213
{
	struct imon_context *ictx;
	struct urb *rx_urb;
	struct urb *tx_urb;
	struct device *dev = &intf->dev;
	struct usb_host_interface *iface_desc;
2214
	int ret = -ENOMEM;
2215

2216
	ictx = kzalloc(sizeof(*ictx), GFP_KERNEL);
2217
	if (!ictx)
2218
		goto exit;
2219

2220
	rx_urb = usb_alloc_urb(0, GFP_KERNEL);
2221
	if (!rx_urb)
2222 2223
		goto rx_urb_alloc_failed;
	tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2224
	if (!tx_urb)
2225 2226 2227
		goto tx_urb_alloc_failed;

	mutex_init(&ictx->lock);
2228
	spin_lock_init(&ictx->kc_lock);
2229 2230 2231 2232 2233 2234 2235

	mutex_lock(&ictx->lock);

	ictx->dev = dev;
	ictx->usbdev_intf0 = usb_get_dev(interface_to_usbdev(intf));
	ictx->rx_urb_intf0 = rx_urb;
	ictx->tx_urb = tx_urb;
2236
	ictx->rf_device = false;
2237

2238 2239
	init_completion(&ictx->tx.finished);

2240 2241 2242
	ictx->vendor  = le16_to_cpu(ictx->usbdev_intf0->descriptor.idVendor);
	ictx->product = le16_to_cpu(ictx->usbdev_intf0->descriptor.idProduct);

2243 2244
	/* save drive info for later accessing the panel/knob key table */
	ictx->dev_descr = (struct imon_usb_dev_descr *)id->driver_info;
2245
	/* default send_packet delay is 5ms but some devices need more */
2246 2247
	ictx->send_packet_delay = ictx->dev_descr->flags &
				  IMON_NEED_20MS_PKT_DELAY ? 20 : 5;
2248

2249
	ret = -ENODEV;
2250
	iface_desc = intf->cur_altsetting;
2251
	if (!imon_find_endpoints(ictx, iface_desc)) {
2252
		goto find_endpoint_failed;
2253
	}
2254 2255 2256 2257 2258 2259 2260 2261 2262 2263

	usb_fill_int_urb(ictx->rx_urb_intf0, ictx->usbdev_intf0,
		usb_rcvintpipe(ictx->usbdev_intf0,
			ictx->rx_endpoint_intf0->bEndpointAddress),
		ictx->usb_rx_buf, sizeof(ictx->usb_rx_buf),
		usb_rx_callback_intf0, ictx,
		ictx->rx_endpoint_intf0->bInterval);

	ret = usb_submit_urb(ictx->rx_urb_intf0, GFP_KERNEL);
	if (ret) {
2264
		pr_err("usb_submit_urb failed for intf0 (%d)\n", ret);
2265 2266 2267
		goto urb_submit_failed;
	}

2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279
	ictx->idev = imon_init_idev(ictx);
	if (!ictx->idev) {
		dev_err(dev, "%s: input device setup failed\n", __func__);
		goto idev_setup_failed;
	}

	ictx->rdev = imon_init_rdev(ictx);
	if (!ictx->rdev) {
		dev_err(dev, "%s: rc device setup failed\n", __func__);
		goto rdev_setup_failed;
	}

2280 2281
	ictx->dev_present_intf0 = true;

2282
	mutex_unlock(&ictx->lock);
2283 2284
	return ictx;

2285 2286
rdev_setup_failed:
	input_unregister_device(ictx->idev);
2287
idev_setup_failed:
2288 2289
	usb_kill_urb(ictx->rx_urb_intf0);
urb_submit_failed:
2290
find_endpoint_failed:
2291
	usb_put_dev(ictx->usbdev_intf0);
2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308
	mutex_unlock(&ictx->lock);
	usb_free_urb(tx_urb);
tx_urb_alloc_failed:
	usb_free_urb(rx_urb);
rx_urb_alloc_failed:
	kfree(ictx);
exit:
	dev_err(dev, "unable to initialize intf0, err %d\n", ret);

	return NULL;
}

static struct imon_context *imon_init_intf1(struct usb_interface *intf,
					    struct imon_context *ictx)
{
	struct urb *rx_urb;
	struct usb_host_interface *iface_desc;
2309
	int ret = -ENOMEM;
2310 2311

	rx_urb = usb_alloc_urb(0, GFP_KERNEL);
2312
	if (!rx_urb)
2313 2314 2315 2316 2317
		goto rx_urb_alloc_failed;

	mutex_lock(&ictx->lock);

	if (ictx->display_type == IMON_DISPLAY_TYPE_VGA) {
2318
		timer_setup(&ictx->ttimer, imon_touch_display_timeout, 0);
2319 2320 2321 2322 2323
	}

	ictx->usbdev_intf1 = usb_get_dev(interface_to_usbdev(intf));
	ictx->rx_urb_intf1 = rx_urb;

2324
	ret = -ENODEV;
2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345
	iface_desc = intf->cur_altsetting;
	if (!imon_find_endpoints(ictx, iface_desc))
		goto find_endpoint_failed;

	if (ictx->display_type == IMON_DISPLAY_TYPE_VGA) {
		ictx->touch = imon_init_touch(ictx);
		if (!ictx->touch)
			goto touch_setup_failed;
	} else
		ictx->touch = NULL;

	usb_fill_int_urb(ictx->rx_urb_intf1, ictx->usbdev_intf1,
		usb_rcvintpipe(ictx->usbdev_intf1,
			ictx->rx_endpoint_intf1->bEndpointAddress),
		ictx->usb_rx_buf, sizeof(ictx->usb_rx_buf),
		usb_rx_callback_intf1, ictx,
		ictx->rx_endpoint_intf1->bInterval);

	ret = usb_submit_urb(ictx->rx_urb_intf1, GFP_KERNEL);

	if (ret) {
2346
		pr_err("usb_submit_urb failed for intf1 (%d)\n", ret);
2347 2348 2349
		goto urb_submit_failed;
	}

2350 2351
	ictx->dev_present_intf1 = true;

2352
	mutex_unlock(&ictx->lock);
2353 2354 2355
	return ictx;

urb_submit_failed:
2356
	if (ictx->touch)
2357 2358 2359
		input_unregister_device(ictx->touch);
touch_setup_failed:
find_endpoint_failed:
2360
	usb_put_dev(ictx->usbdev_intf1);
2361
	ictx->usbdev_intf1 = NULL;
2362 2363
	mutex_unlock(&ictx->lock);
	usb_free_urb(rx_urb);
2364
	ictx->rx_urb_intf1 = NULL;
2365
rx_urb_alloc_failed:
2366
	dev_err(ictx->dev, "unable to initialize intf1, err %d\n", ret);
2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378

	return NULL;
}

static void imon_init_display(struct imon_context *ictx,
			      struct usb_interface *intf)
{
	int ret;

	dev_dbg(ictx->dev, "Registering iMON display with sysfs\n");

	/* set up sysfs entry for built-in clock */
2379
	ret = sysfs_create_group(&intf->dev.kobj, &imon_display_attr_group);
2380
	if (ret)
2381 2382
		dev_err(ictx->dev, "Could not create display sysfs entries(%d)",
			ret);
2383 2384 2385 2386 2387 2388 2389

	if (ictx->display_type == IMON_DISPLAY_TYPE_LCD)
		ret = usb_register_dev(intf, &imon_lcd_class);
	else
		ret = usb_register_dev(intf, &imon_vfd_class);
	if (ret)
		/* Not a fatal error, so ignore */
2390
		dev_info(ictx->dev, "could not get a minor number for display\n");
2391 2392 2393

}

2394
/*
2395 2396
 * Callback function for USB core API: Probe
 */
2397 2398
static int imon_probe(struct usb_interface *interface,
		      const struct usb_device_id *id)
2399 2400 2401 2402 2403
{
	struct usb_device *usbdev = NULL;
	struct usb_host_interface *iface_desc = NULL;
	struct usb_interface *first_if;
	struct device *dev = &interface->dev;
2404
	int ifnum, sysfs_err;
2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422
	int ret = 0;
	struct imon_context *ictx = NULL;
	struct imon_context *first_if_ctx = NULL;
	u16 vendor, product;

	usbdev     = usb_get_dev(interface_to_usbdev(interface));
	iface_desc = interface->cur_altsetting;
	ifnum      = iface_desc->desc.bInterfaceNumber;
	vendor     = le16_to_cpu(usbdev->descriptor.idVendor);
	product    = le16_to_cpu(usbdev->descriptor.idProduct);

	dev_dbg(dev, "%s: found iMON device (%04x:%04x, intf%d)\n",
		__func__, vendor, product, ifnum);

	/* prevent races probing devices w/multiple interfaces */
	mutex_lock(&driver_lock);

	first_if = usb_ifnum_to_if(usbdev, 0);
2423 2424 2425 2426 2427
	if (!first_if) {
		ret = -ENODEV;
		goto fail;
	}

2428
	first_if_ctx = usb_get_intfdata(first_if);
2429 2430

	if (ifnum == 0) {
2431
		ictx = imon_init_intf0(interface, id);
2432
		if (!ictx) {
2433
			pr_err("failed to initialize context!\n");
2434 2435 2436 2437 2438
			ret = -ENODEV;
			goto fail;
		}

	} else {
2439 2440 2441 2442 2443 2444 2445 2446
		/* this is the secondary interface on the device */

		/* fail early if first intf failed to register */
		if (!first_if_ctx) {
			ret = -ENODEV;
			goto fail;
		}

2447 2448
		ictx = imon_init_intf1(interface, first_if_ctx);
		if (!ictx) {
2449
			pr_err("failed to attach to context!\n");
2450 2451 2452 2453 2454 2455 2456 2457 2458
			ret = -ENODEV;
			goto fail;
		}

	}

	usb_set_intfdata(interface, ictx);

	if (ifnum == 0) {
2459 2460
		mutex_lock(&ictx->lock);

2461 2462
		if (product == 0xffdc && ictx->rf_device) {
			sysfs_err = sysfs_create_group(&interface->dev.kobj,
2463
						       &imon_rf_attr_group);
2464
			if (sysfs_err)
2465 2466
				pr_err("Could not create RF sysfs entries(%d)\n",
				       sysfs_err);
2467 2468
		}

2469 2470
		if (ictx->display_supported)
			imon_init_display(ictx, interface);
2471 2472

		mutex_unlock(&ictx->lock);
2473 2474
	}

2475 2476
	dev_info(dev, "iMON device (%04x:%04x, intf%d) on usb<%d:%d> initialized\n",
		 vendor, product, ifnum,
2477 2478 2479
		 usbdev->bus->busnum, usbdev->devnum);

	mutex_unlock(&driver_lock);
2480
	usb_put_dev(usbdev);
2481 2482 2483 2484 2485

	return 0;

fail:
	mutex_unlock(&driver_lock);
2486
	usb_put_dev(usbdev);
2487 2488 2489 2490 2491
	dev_err(dev, "unable to register, err %d\n", ret);

	return ret;
}

2492
/*
2493 2494
 * Callback function for USB core API: disconnect
 */
2495
static void imon_disconnect(struct usb_interface *interface)
2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511
{
	struct imon_context *ictx;
	struct device *dev;
	int ifnum;

	/* prevent races with multi-interface device probing and display_open */
	mutex_lock(&driver_lock);

	ictx = usb_get_intfdata(interface);
	dev = ictx->dev;
	ifnum = interface->cur_altsetting->desc.bInterfaceNumber;

	/*
	 * sysfs_remove_group is safe to call even if sysfs_create_group
	 * hasn't been called
	 */
2512 2513
	sysfs_remove_group(&interface->dev.kobj, &imon_display_attr_group);
	sysfs_remove_group(&interface->dev.kobj, &imon_rf_attr_group);
2514 2515 2516 2517 2518 2519

	usb_set_intfdata(interface, NULL);

	/* Abort ongoing write */
	if (ictx->tx.busy) {
		usb_kill_urb(ictx->tx_urb);
2520
		complete(&ictx->tx.finished);
2521 2522 2523
	}

	if (ifnum == 0) {
2524
		ictx->dev_present_intf0 = false;
2525
		usb_kill_urb(ictx->rx_urb_intf0);
2526
		usb_put_dev(ictx->usbdev_intf0);
2527
		input_unregister_device(ictx->idev);
2528
		rc_unregister_device(ictx->rdev);
2529 2530 2531
		if (ictx->display_supported) {
			if (ictx->display_type == IMON_DISPLAY_TYPE_LCD)
				usb_deregister_dev(interface, &imon_lcd_class);
2532
			else if (ictx->display_type == IMON_DISPLAY_TYPE_VFD)
2533 2534 2535
				usb_deregister_dev(interface, &imon_vfd_class);
		}
	} else {
2536
		ictx->dev_present_intf1 = false;
2537
		usb_kill_urb(ictx->rx_urb_intf1);
2538
		usb_put_dev(ictx->usbdev_intf1);
2539
		if (ictx->display_type == IMON_DISPLAY_TYPE_VGA) {
2540
			input_unregister_device(ictx->touch);
2541 2542
			del_timer_sync(&ictx->ttimer);
		}
2543 2544
	}

2545 2546
	if (!ictx->dev_present_intf0 && !ictx->dev_present_intf1)
		free_imon_context(ictx);
2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580

	mutex_unlock(&driver_lock);

	dev_dbg(dev, "%s: iMON device (intf%d) disconnected\n",
		__func__, ifnum);
}

static int imon_suspend(struct usb_interface *intf, pm_message_t message)
{
	struct imon_context *ictx = usb_get_intfdata(intf);
	int ifnum = intf->cur_altsetting->desc.bInterfaceNumber;

	if (ifnum == 0)
		usb_kill_urb(ictx->rx_urb_intf0);
	else
		usb_kill_urb(ictx->rx_urb_intf1);

	return 0;
}

static int imon_resume(struct usb_interface *intf)
{
	int rc = 0;
	struct imon_context *ictx = usb_get_intfdata(intf);
	int ifnum = intf->cur_altsetting->desc.bInterfaceNumber;

	if (ifnum == 0) {
		usb_fill_int_urb(ictx->rx_urb_intf0, ictx->usbdev_intf0,
			usb_rcvintpipe(ictx->usbdev_intf0,
				ictx->rx_endpoint_intf0->bEndpointAddress),
			ictx->usb_rx_buf, sizeof(ictx->usb_rx_buf),
			usb_rx_callback_intf0, ictx,
			ictx->rx_endpoint_intf0->bInterval);

2581
		rc = usb_submit_urb(ictx->rx_urb_intf0, GFP_NOIO);
2582 2583 2584 2585 2586 2587 2588 2589 2590

	} else {
		usb_fill_int_urb(ictx->rx_urb_intf1, ictx->usbdev_intf1,
			usb_rcvintpipe(ictx->usbdev_intf1,
				ictx->rx_endpoint_intf1->bEndpointAddress),
			ictx->usb_rx_buf, sizeof(ictx->usb_rx_buf),
			usb_rx_callback_intf1, ictx,
			ictx->rx_endpoint_intf1->bInterval);

2591
		rc = usb_submit_urb(ictx->rx_urb_intf1, GFP_NOIO);
2592 2593 2594 2595 2596
	}

	return rc;
}

2597
module_usb_driver(imon_driver);