[linux-2.6-block.git] / drivers / media / video / em28xx / em28xx-input.c

/*
  handle em28xx IR remotes via linux kernel input layer.

   Copyright (C) 2005 Ludovico Cavedon <cavedon@sssup.it>
		      Markus Rechberger <mrechberger@gmail.com>
		      Mauro Carvalho Chehab <mchehab@infradead.org>
		      Sascha Sommer <saschasommer@freenet.de>

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

#include <linux/module.h>
#include <linux/init.h>
#include <linux/delay.h>
#include <linux/interrupt.h>
#include <linux/usb.h>
#include <linux/slab.h>

#include "em28xx.h"

#define EM28XX_SNAPSHOT_KEY KEY_CAMERA
#define EM28XX_SBUTTON_QUERY_INTERVAL 500
#define EM28XX_R0C_USBSUSP_SNAPSHOT 0x20

static unsigned int ir_debug;
module_param(ir_debug, int, 0644);
MODULE_PARM_DESC(ir_debug, "enable debug messages [IR]");

#define MODULE_NAME "em28xx"

#define i2cdprintk(fmt, arg...) \
	if (ir_debug) { \
		printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
	}

#define dprintk(fmt, arg...) \
	if (ir_debug) { \
		printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
	}

/**********************************************************
 Polling structure used by em28xx IR's
 **********************************************************/

struct em28xx_ir_poll_result {
	unsigned int toggle_bit:1;
	unsigned int read_count:7;
	u8 rc_address;
	u8 rc_data[4]; /* 1 byte on em2860/2880, 4 on em2874 */
};

struct em28xx_IR {
	struct em28xx *dev;
	struct rc_dev *rc;
	char name[32];
	char phys[32];

	/* poll external decoder */
	int polling;
	struct delayed_work work;
	unsigned int full_code:1;
	unsigned int last_readcount;

	int  (*get_key)(struct em28xx_IR *, struct em28xx_ir_poll_result *);
};

/**********************************************************
 I2C IR based get keycodes - should be used with ir-kbd-i2c
 **********************************************************/

int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
{
	unsigned char b;

	/* poll IR chip */
	if (1 != i2c_master_recv(ir->c, &b, 1)) {
		i2cdprintk("read error\n");
		return -EIO;
	}

	/* it seems that 0xFE indicates that a button is still hold
	   down, while 0xff indicates that no button is hold
	   down. 0xfe sequences are sometimes interrupted by 0xFF */

	i2cdprintk("key %02x\n", b);

	if (b == 0xff)
		return 0;

	if (b == 0xfe)
		/* keep old data */
		return 1;

	*ir_key = b;
	*ir_raw = b;
	return 1;
}

int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
{
	unsigned char buf[2];
	u16 code;
	int size;

	/* poll IR chip */
	size = i2c_master_recv(ir->c, buf, sizeof(buf));

	if (size != 2)
		return -EIO;

	/* Does eliminate repeated parity code */
	if (buf[1] == 0xff)
		return 0;

	ir->old = buf[1];

	/*
	 * Rearranges bits to the right order.
	 * The bit order were determined experimentally by using
	 * The original Hauppauge Grey IR and another RC5 that uses addr=0x08
	 * The RC5 code has 14 bits, but we've experimentally determined
	 * the meaning for only 11 bits.
	 * So, the code translation is not complete. Yet, it is enough to
	 * work with the provided RC5 IR.
	 */
	code =
		 ((buf[0] & 0x01) ? 0x0020 : 0) | /* 		0010 0000 */
		 ((buf[0] & 0x02) ? 0x0010 : 0) | /* 		0001 0000 */
		 ((buf[0] & 0x04) ? 0x0008 : 0) | /* 		0000 1000 */
		 ((buf[0] & 0x08) ? 0x0004 : 0) | /* 		0000 0100 */
		 ((buf[0] & 0x10) ? 0x0002 : 0) | /* 		0000 0010 */
		 ((buf[0] & 0x20) ? 0x0001 : 0) | /* 		0000 0001 */
		 ((buf[1] & 0x08) ? 0x1000 : 0) | /* 0001 0000		  */
		 ((buf[1] & 0x10) ? 0x0800 : 0) | /* 0000 1000		  */
		 ((buf[1] & 0x20) ? 0x0400 : 0) | /* 0000 0100		  */
		 ((buf[1] & 0x40) ? 0x0200 : 0) | /* 0000 0010		  */
		 ((buf[1] & 0x80) ? 0x0100 : 0);  /* 0000 0001		  */

	i2cdprintk("ir hauppauge (em2840): code=0x%02x (rcv=0x%02x%02x)\n",
			code, buf[1], buf[0]);

	/* return key */
	*ir_key = code;
	*ir_raw = code;
	return 1;
}

int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
				     u32 *ir_raw)
{
	unsigned char buf[3];

	/* poll IR chip */

	if (3 != i2c_master_recv(ir->c, buf, 3)) {
		i2cdprintk("read error\n");
		return -EIO;
	}

	i2cdprintk("key %02x\n", buf[2]&0x3f);
	if (buf[0] != 0x00)
		return 0;

	*ir_key = buf[2]&0x3f;
	*ir_raw = buf[2]&0x3f;

	return 1;
}

int em28xx_get_key_winfast_usbii_deluxe(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
{
	unsigned char subaddr, keydetect, key;

	struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0, .buf = &subaddr, .len = 1},

				{ .addr = ir->c->addr, .flags = I2C_M_RD, .buf = &keydetect, .len = 1} };

	subaddr = 0x10;
	if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
		i2cdprintk("read error\n");
		return -EIO;
	}
	if (keydetect == 0x00)
		return 0;

	subaddr = 0x00;
	msg[1].buf = &key;
	if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
		i2cdprintk("read error\n");
	return -EIO;
	}
	if (key == 0x00)
		return 0;

	*ir_key = key;
	*ir_raw = key;
	return 1;
}

/**********************************************************
 Poll based get keycode functions
 **********************************************************/

/* This is for the em2860/em2880 */
static int default_polling_getkey(struct em28xx_IR *ir,
				  struct em28xx_ir_poll_result *poll_result)
{
	struct em28xx *dev = ir->dev;
	int rc;
	u8 msg[3] = { 0, 0, 0 };

	/* Read key toggle, brand, and key code
	   on registers 0x45, 0x46 and 0x47
	 */
	rc = dev->em28xx_read_reg_req_len(dev, 0, EM28XX_R45_IR,
					  msg, sizeof(msg));
	if (rc < 0)
		return rc;

	/* Infrared toggle (Reg 0x45[7]) */
	poll_result->toggle_bit = (msg[0] >> 7);

	/* Infrared read count (Reg 0x45[6:0] */
	poll_result->read_count = (msg[0] & 0x7f);

	/* Remote Control Address (Reg 0x46) */
	poll_result->rc_address = msg[1];

	/* Remote Control Data (Reg 0x47) */
	poll_result->rc_data[0] = msg[2];

	return 0;
}

static int em2874_polling_getkey(struct em28xx_IR *ir,
				 struct em28xx_ir_poll_result *poll_result)
{
	struct em28xx *dev = ir->dev;
	int rc;
	u8 msg[5] = { 0, 0, 0, 0, 0 };

	/* Read key toggle, brand, and key code
	   on registers 0x51-55
	 */
	rc = dev->em28xx_read_reg_req_len(dev, 0, EM2874_R51_IR,
					  msg, sizeof(msg));
	if (rc < 0)
		return rc;

	/* Infrared toggle (Reg 0x51[7]) */
	poll_result->toggle_bit = (msg[0] >> 7);

	/* Infrared read count (Reg 0x51[6:0] */
	poll_result->read_count = (msg[0] & 0x7f);

	/* Remote Control Address (Reg 0x52) */
	poll_result->rc_address = msg[1];

	/* Remote Control Data (Reg 0x53-55) */
	poll_result->rc_data[0] = msg[2];
	poll_result->rc_data[1] = msg[3];
	poll_result->rc_data[2] = msg[4];

	return 0;
}

/**********************************************************
 Polling code for em28xx
 **********************************************************/

static void em28xx_ir_handle_key(struct em28xx_IR *ir)
{
	int result;
	struct em28xx_ir_poll_result poll_result;

	/* read the registers containing the IR status */
	result = ir->get_key(ir, &poll_result);
	if (unlikely(result < 0)) {
		dprintk("ir->get_key() failed %d\n", result);
		return;
	}

	if (unlikely(poll_result.read_count != ir->last_readcount)) {
		dprintk("%s: toggle: %d, count: %d, key 0x%02x%02x\n", __func__,
			poll_result.toggle_bit, poll_result.read_count,
			poll_result.rc_address, poll_result.rc_data[0]);
		if (ir->full_code)
			rc_keydown(ir->rc,
				   poll_result.rc_address << 8 |
				   poll_result.rc_data[0],
				   poll_result.toggle_bit);
		else
			rc_keydown(ir->rc,
				   poll_result.rc_data[0],
				   poll_result.toggle_bit);

		if (ir->dev->chip_id == CHIP_ID_EM2874 ||
		    ir->dev->chip_id == CHIP_ID_EM2884)
			/* The em2874 clears the readcount field every time the
			   register is read.  The em2860/2880 datasheet says that it
			   is supposed to clear the readcount, but it doesn't.  So with
			   the em2874, we are looking for a non-zero read count as
			   opposed to a readcount that is incrementing */
			ir->last_readcount = 0;
		else
			ir->last_readcount = poll_result.read_count;
	}
}

static void em28xx_ir_work(struct work_struct *work)
{
	struct em28xx_IR *ir = container_of(work, struct em28xx_IR, work.work);

	em28xx_ir_handle_key(ir);
	schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling));
}

static int em28xx_ir_start(struct rc_dev *rc)
{
	struct em28xx_IR *ir = rc->priv;

	INIT_DELAYED_WORK(&ir->work, em28xx_ir_work);
	schedule_delayed_work(&ir->work, 0);

	return 0;
}

static void em28xx_ir_stop(struct rc_dev *rc)
{
	struct em28xx_IR *ir = rc->priv;

	cancel_delayed_work_sync(&ir->work);
}

int em28xx_ir_change_protocol(struct rc_dev *rc_dev, u64 rc_type)
{
	int rc = 0;
	struct em28xx_IR *ir = rc_dev->priv;
	struct em28xx *dev = ir->dev;
	u8 ir_config = EM2874_IR_RC5;

	/* Adjust xclk based o IR table for RC5/NEC tables */

	if (rc_type == RC_TYPE_RC5) {
		dev->board.xclk |= EM28XX_XCLK_IR_RC5_MODE;
		ir->full_code = 1;
	} else if (rc_type == RC_TYPE_NEC) {
		dev->board.xclk &= ~EM28XX_XCLK_IR_RC5_MODE;
		ir_config = EM2874_IR_NEC;
		ir->full_code = 1;
	} else if (rc_type != RC_TYPE_UNKNOWN)
		rc = -EINVAL;

	em28xx_write_reg_bits(dev, EM28XX_R0F_XCLK, dev->board.xclk,
			      EM28XX_XCLK_IR_RC5_MODE);

	/* Setup the proper handler based on the chip */
	switch (dev->chip_id) {
	case CHIP_ID_EM2860:
	case CHIP_ID_EM2883:
		ir->get_key = default_polling_getkey;
		break;
	case CHIP_ID_EM2884:
	case CHIP_ID_EM2874:
	case CHIP_ID_EM28174:
		ir->get_key = em2874_polling_getkey;
		em28xx_write_regs(dev, EM2874_R50_IR_CONFIG, &ir_config, 1);
		break;
	default:
		printk("Unrecognized em28xx chip id 0x%02x: IR not supported\n",
			dev->chip_id);
		rc = -EINVAL;
	}

	return rc;
}

void em28xx_register_i2c_ir(struct em28xx *dev)
{
	/* Leadtek winfast tv USBII deluxe can find a non working IR-device */
	/* at address 0x18, so if that address is needed for another board in */
	/* the future, please put it after 0x1f. */
	struct i2c_board_info info;
	const unsigned short addr_list[] = {
		 0x1f, 0x30, 0x47, I2C_CLIENT_END
	};

	memset(&info, 0, sizeof(struct i2c_board_info));
	memset(&dev->init_data, 0, sizeof(dev->init_data));
	strlcpy(info.type, "ir_video", I2C_NAME_SIZE);

	/* detect & configure */
	switch (dev->model) {
	case EM2800_BOARD_TERRATEC_CINERGY_200:
	case EM2820_BOARD_TERRATEC_CINERGY_250:
		dev->init_data.ir_codes = RC_MAP_EM_TERRATEC;
		dev->init_data.get_key = em28xx_get_key_terratec;
		dev->init_data.name = "i2c IR (EM28XX Terratec)";
		break;
	case EM2820_BOARD_PINNACLE_USB_2:
		dev->init_data.ir_codes = RC_MAP_PINNACLE_GREY;
		dev->init_data.get_key = em28xx_get_key_pinnacle_usb_grey;
		dev->init_data.name = "i2c IR (EM28XX Pinnacle PCTV)";
		break;
	case EM2820_BOARD_HAUPPAUGE_WINTV_USB_2:
		dev->init_data.ir_codes = RC_MAP_HAUPPAUGE;
		dev->init_data.get_key = em28xx_get_key_em_haup;
		dev->init_data.name = "i2c IR (EM2840 Hauppauge)";
		break;
	case EM2820_BOARD_LEADTEK_WINFAST_USBII_DELUXE:
		dev->init_data.ir_codes = RC_MAP_WINFAST_USBII_DELUXE;
		dev->init_data.get_key = em28xx_get_key_winfast_usbii_deluxe;
		dev->init_data.name = "i2c IR (EM2820 Winfast TV USBII Deluxe)";
		break;
	}

	if (dev->init_data.name)
		info.platform_data = &dev->init_data;
	i2c_new_probed_device(&dev->i2c_adap, &info, addr_list, NULL);
}

int em28xx_ir_init(struct em28xx *dev)
{
	struct em28xx_IR *ir;
	struct rc_dev *rc;
	int err = -ENOMEM;

	if (dev->board.ir_codes == NULL) {
		/* No remote control support */
		return 0;
	}

	ir = kzalloc(sizeof(*ir), GFP_KERNEL);
	rc = rc_allocate_device();
	if (!ir || !rc)
		goto err_out_free;

	/* record handles to ourself */
	ir->dev = dev;
	dev->ir = ir;
	ir->rc = rc;

	/*
	 * em2874 supports more protocols. For now, let's just announce
	 * the two protocols that were already tested
	 */
	rc->allowed_protos = RC_TYPE_RC5 | RC_TYPE_NEC;
	rc->priv = ir;
	rc->change_protocol = em28xx_ir_change_protocol;
	rc->open = em28xx_ir_start;
	rc->close = em28xx_ir_stop;

	/* By default, keep protocol field untouched */
	err = em28xx_ir_change_protocol(rc, RC_TYPE_UNKNOWN);
	if (err)
		goto err_out_free;

	/* This is how often we ask the chip for IR information */
	ir->polling = 100; /* ms */

	/* init input device */
	snprintf(ir->name, sizeof(ir->name), "em28xx IR (%s)",
						dev->name);

	usb_make_path(dev->udev, ir->phys, sizeof(ir->phys));
	strlcat(ir->phys, "/input0", sizeof(ir->phys));

	rc->input_name = ir->name;
	rc->input_phys = ir->phys;
	rc->input_id.bustype = BUS_USB;
	rc->input_id.version = 1;
	rc->input_id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
	rc->input_id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
	rc->dev.parent = &dev->udev->dev;
	rc->map_name = dev->board.ir_codes;
	rc->driver_name = MODULE_NAME;

	/* all done */
	err = rc_register_device(rc);
	if (err)
		goto err_out_stop;

	em28xx_register_i2c_ir(dev);

#if defined(CONFIG_MODULES) && defined(MODULE)
	if (dev->board.has_ir_i2c)
		request_module("ir-kbd-i2c");
#endif
	if (dev->board.has_snapshot_button)
		em28xx_register_snapshot_button(dev);

	return 0;

 err_out_stop:
	dev->ir = NULL;
 err_out_free:
	rc_free_device(rc);
	kfree(ir);
	return err;
}

int em28xx_ir_fini(struct em28xx *dev)
{
	struct em28xx_IR *ir = dev->ir;

	em28xx_deregister_snapshot_button(dev);

	/* skip detach on non attached boards */
	if (!ir)
		return 0;

	if (ir->rc)
		rc_unregister_device(ir->rc);

	/* done */
	kfree(ir);
	dev->ir = NULL;
	return 0;
}

/**********************************************************
 Handle Webcam snapshot button
 **********************************************************/

static void em28xx_query_sbutton(struct work_struct *work)
{
	/* Poll the register and see if the button is depressed */
	struct em28xx *dev =
		container_of(work, struct em28xx, sbutton_query_work.work);
	int ret;

	ret = em28xx_read_reg(dev, EM28XX_R0C_USBSUSP);

	if (ret & EM28XX_R0C_USBSUSP_SNAPSHOT) {
		u8 cleared;
		/* Button is depressed, clear the register */
		cleared = ((u8) ret) & ~EM28XX_R0C_USBSUSP_SNAPSHOT;
		em28xx_write_regs(dev, EM28XX_R0C_USBSUSP, &cleared, 1);

		/* Not emulate the keypress */
		input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
				 1);
		/* Now unpress the key */
		input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
				 0);
	}

	/* Schedule next poll */
	schedule_delayed_work(&dev->sbutton_query_work,
			      msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
}

void em28xx_register_snapshot_button(struct em28xx *dev)
{
	struct input_dev *input_dev;
	int err;

	em28xx_info("Registering snapshot button...\n");
	input_dev = input_allocate_device();
	if (!input_dev) {
		em28xx_errdev("input_allocate_device failed\n");
		return;
	}

	usb_make_path(dev->udev, dev->snapshot_button_path,
		      sizeof(dev->snapshot_button_path));
	strlcat(dev->snapshot_button_path, "/sbutton",
		sizeof(dev->snapshot_button_path));
	INIT_DELAYED_WORK(&dev->sbutton_query_work, em28xx_query_sbutton);

	input_dev->name = "em28xx snapshot button";
	input_dev->phys = dev->snapshot_button_path;
	input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP);
	set_bit(EM28XX_SNAPSHOT_KEY, input_dev->keybit);
	input_dev->keycodesize = 0;
	input_dev->keycodemax = 0;
	input_dev->id.bustype = BUS_USB;
	input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
	input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
	input_dev->id.version = 1;
	input_dev->dev.parent = &dev->udev->dev;

	err = input_register_device(input_dev);
	if (err) {
		em28xx_errdev("input_register_device failed\n");
		input_free_device(input_dev);
		return;
	}

	dev->sbutton_input_dev = input_dev;
	schedule_delayed_work(&dev->sbutton_query_work,
			      msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
	return;

}

void em28xx_deregister_snapshot_button(struct em28xx *dev)
{
	if (dev->sbutton_input_dev != NULL) {
		em28xx_info("Deregistering snapshot button\n");
		cancel_delayed_work_sync(&dev->sbutton_query_work);
		input_unregister_device(dev->sbutton_input_dev);
		dev->sbutton_input_dev = NULL;
	}
	return;
}
Commit	Line	Data
d5e52653	1	/*
f7abcd38 MCC	2	handle em28xx IR remotes via linux kernel input layer.
	3
	4	Copyright (C) 2005 Ludovico Cavedon <cavedon@sssup.it>
	5	Markus Rechberger <mrechberger@gmail.com>
2e7c6dc3	6	Mauro Carvalho Chehab <mchehab@infradead.org>
f7abcd38 MCC	7	Sascha Sommer <saschasommer@freenet.de>
	8
	9	This program is free software; you can redistribute it and/or modify
	10	it under the terms of the GNU General Public License as published by
	11	the Free Software Foundation; either version 2 of the License, or
	12	(at your option) any later version.
	13
	14	This program is distributed in the hope that it will be useful,
	15	but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	GNU General Public License for more details.
	18
	19	You should have received a copy of the GNU General Public License
	20	along with this program; if not, write to the Free Software
	21	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
d5e52653 MCC	22	*/
	23
	24	#include <linux/module.h>
d5e52653 MCC	25	#include <linux/init.h>
d5e52653 MCC	26	#include <linux/delay.h>
d5e52653	27	#include <linux/interrupt.h>
d5e52653	28	#include <linux/usb.h>
5a0e3ad6	29	#include <linux/slab.h>
d5e52653	30
f7abcd38	31	#include "em28xx.h"
d5e52653	32
a9fc52bc DH	33	#define EM28XX_SNAPSHOT_KEY KEY_CAMERA
	34	#define EM28XX_SBUTTON_QUERY_INTERVAL 500
	35	#define EM28XX_R0C_USBSUSP_SNAPSHOT 0x20
	36
c8793b03	37	static unsigned int ir_debug;
d5e52653	38	module_param(ir_debug, int, 0644);
6ea54d93	39	MODULE_PARM_DESC(ir_debug, "enable debug messages [IR]");
d5e52653	40
727e625c MCC	41	#define MODULE_NAME "em28xx"
727e625c MCC	42
a924a499	43	#define i2cdprintk(fmt, arg...) \
6ea54d93	44	if (ir_debug) { \
1df8e986	45	printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
6ea54d93	46	}
d5e52653	47
a924a499 MCC	48	#define dprintk(fmt, arg...) \
	49	if (ir_debug) { \
	50	printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
	51	}
	52
	53	/**********************************************************
	54	Polling structure used by em28xx IR's
	55	**********************************************************/
	56
4b92253a DH	57	struct em28xx_ir_poll_result {
	58	unsigned int toggle_bit:1;
	59	unsigned int read_count:7;
	60	u8 rc_address;
	61	u8 rc_data[4]; /* 1 byte on em2860/2880, 4 on em2874 */
	62	};
	63
a924a499 MCC	64	struct em28xx_IR {
a924a499 MCC	65	struct em28xx *dev;
d8b4b582	66	struct rc_dev *rc;
a924a499 MCC	67	char name[32];
	68	char phys[32];
	69
	70	/* poll external decoder */
	71	int polling;
f263bac9	72	struct delayed_work work;
0278155c	73	unsigned int full_code:1;
4b92253a	74	unsigned int last_readcount;
a924a499	75
4b92253a	76	int (get_key)(struct em28xx_IR , struct em28xx_ir_poll_result *);
a924a499 MCC	77	};
	78
	79	/**********************************************************
	80	I2C IR based get keycodes - should be used with ir-kbd-i2c
	81	**********************************************************/
d5e52653	82
c8793b03	83	int em28xx_get_key_terratec(struct IR_i2c ir, u32 ir_key, u32 *ir_raw)
e43f14af MR	84	{
	85	unsigned char b;
	86
	87	/* poll IR chip */
c668f32d	88	if (1 != i2c_master_recv(ir->c, &b, 1)) {
a924a499	89	i2cdprintk("read error\n");
e43f14af MR	90	return -EIO;
	91	}
	92
	93	/* it seems that 0xFE indicates that a button is still hold
4f9c05aa MCC	94	down, while 0xff indicates that no button is hold
4f9c05aa MCC	95	down. 0xfe sequences are sometimes interrupted by 0xFF */
e43f14af	96
a924a499	97	i2cdprintk("key %02x\n", b);
e43f14af	98
4f9c05aa	99	if (b == 0xff)
e43f14af MR	100	return 0;
e43f14af MR	101
4f9c05aa	102	if (b == 0xfe)
e43f14af MR	103	/* keep old data */
	104	return 1;
	105
	106	*ir_key = b;
	107	*ir_raw = b;
	108	return 1;
	109	}
	110
c8793b03	111	int em28xx_get_key_em_haup(struct IR_i2c ir, u32 ir_key, u32 *ir_raw)
d5e52653 MCC	112	{
d5e52653 MCC	113	unsigned char buf[2];
b779974b MCC	114	u16 code;
b779974b MCC	115	int size;
d5e52653 MCC	116
d5e52653 MCC	117	/* poll IR chip */
b779974b MCC	118	size = i2c_master_recv(ir->c, buf, sizeof(buf));
	119
	120	if (size != 2)
d5e52653 MCC	121	return -EIO;
	122
	123	/* Does eliminate repeated parity code */
6ea54d93	124	if (buf[1] == 0xff)
d5e52653 MCC	125	return 0;
d5e52653 MCC	126
6ea54d93	127	ir->old = buf[1];
d5e52653	128
b779974b MCC	129	/*
	130	* Rearranges bits to the right order.
	131	* The bit order were determined experimentally by using
	132	* The original Hauppauge Grey IR and another RC5 that uses addr=0x08
	133	* The RC5 code has 14 bits, but we've experimentally determined
	134	* the meaning for only 11 bits.
	135	* So, the code translation is not complete. Yet, it is enough to
	136	* work with the provided RC5 IR.
	137	*/
	138	code =
	139	((buf[0] & 0x01) ? 0x0020 : 0) \| /* 0010 0000 */
	140	((buf[0] & 0x02) ? 0x0010 : 0) \| /* 0001 0000 */
	141	((buf[0] & 0x04) ? 0x0008 : 0) \| /* 0000 1000 */
	142	((buf[0] & 0x08) ? 0x0004 : 0) \| /* 0000 0100 */
	143	((buf[0] & 0x10) ? 0x0002 : 0) \| /* 0000 0010 */
	144	((buf[0] & 0x20) ? 0x0001 : 0) \| /* 0000 0001 */
	145	((buf[1] & 0x08) ? 0x1000 : 0) \| /* 0001 0000 */
	146	((buf[1] & 0x10) ? 0x0800 : 0) \| /* 0000 1000 */
	147	((buf[1] & 0x20) ? 0x0400 : 0) \| /* 0000 0100 */
	148	((buf[1] & 0x40) ? 0x0200 : 0) \| /* 0000 0010 */
	149	((buf[1] & 0x80) ? 0x0100 : 0); /* 0000 0001 */
	150
	151	i2cdprintk("ir hauppauge (em2840): code=0x%02x (rcv=0x%02x%02x)\n",
	152	code, buf[1], buf[0]);
d5e52653 MCC	153
	154	/* return key */
	155	*ir_key = code;
	156	*ir_raw = code;
	157	return 1;
	158	}
	159
c8793b03 MCC	160	int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c ir, u32 ir_key,
c8793b03 MCC	161	u32 *ir_raw)
366cc64b MR	162	{
	163	unsigned char buf[3];
	164
	165	/* poll IR chip */
	166
c668f32d	167	if (3 != i2c_master_recv(ir->c, buf, 3)) {
a924a499	168	i2cdprintk("read error\n");
366cc64b MR	169	return -EIO;
	170	}
	171
a924a499	172	i2cdprintk("key %02x\n", buf[2]&0x3f);
6ea54d93	173	if (buf[0] != 0x00)
366cc64b	174	return 0;
366cc64b MR	175
	176	*ir_key = buf[2]&0x3f;
	177	*ir_raw = buf[2]&0x3f;
	178
	179	return 1;
	180	}
	181
ca39d84d MA	182	int em28xx_get_key_winfast_usbii_deluxe(struct IR_i2c ir, u32 ir_key, u32 *ir_raw)
	183	{
	184	unsigned char subaddr, keydetect, key;
	185
	186	struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0, .buf = &subaddr, .len = 1},
	187
	188	{ .addr = ir->c->addr, .flags = I2C_M_RD, .buf = &keydetect, .len = 1} };
	189
	190	subaddr = 0x10;
	191	if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
	192	i2cdprintk("read error\n");
	193	return -EIO;
	194	}
	195	if (keydetect == 0x00)
	196	return 0;
	197
	198	subaddr = 0x00;
	199	msg[1].buf = &key;
	200	if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
	201	i2cdprintk("read error\n");
	202	return -EIO;
	203	}
	204	if (key == 0x00)
	205	return 0;
	206
	207	*ir_key = key;
	208	*ir_raw = key;
	209	return 1;
	210	}
	211
a924a499 MCC	212	/**********************************************************
	213	Poll based get keycode functions
	214	**********************************************************/
	215
4b92253a DH	216	/* This is for the em2860/em2880 */
	217	static int default_polling_getkey(struct em28xx_IR *ir,
	218	struct em28xx_ir_poll_result *poll_result)
a924a499 MCC	219	{
	220	struct em28xx *dev = ir->dev;
	221	int rc;
4b92253a	222	u8 msg[3] = { 0, 0, 0 };
a924a499	223
0a6b8a85 MCC	224	/* Read key toggle, brand, and key code
	225	on registers 0x45, 0x46 and 0x47
	226	*/
a924a499	227	rc = dev->em28xx_read_reg_req_len(dev, 0, EM28XX_R45_IR,
0a6b8a85	228	msg, sizeof(msg));
a924a499 MCC	229	if (rc < 0)
	230	return rc;
	231
4b92253a DH	232	/* Infrared toggle (Reg 0x45[7]) */
	233	poll_result->toggle_bit = (msg[0] >> 7);
	234
	235	/* Infrared read count (Reg 0x45[6:0] */
	236	poll_result->read_count = (msg[0] & 0x7f);
	237
	238	/* Remote Control Address (Reg 0x46) */
	239	poll_result->rc_address = msg[1];
	240
	241	/* Remote Control Data (Reg 0x47) */
	242	poll_result->rc_data[0] = msg[2];
	243
	244	return 0;
	245	}
	246
	247	static int em2874_polling_getkey(struct em28xx_IR *ir,
	248	struct em28xx_ir_poll_result *poll_result)
	249	{
	250	struct em28xx *dev = ir->dev;
	251	int rc;
	252	u8 msg[5] = { 0, 0, 0, 0, 0 };
	253
	254	/* Read key toggle, brand, and key code
	255	on registers 0x51-55
	256	*/
	257	rc = dev->em28xx_read_reg_req_len(dev, 0, EM2874_R51_IR,
	258	msg, sizeof(msg));
	259	if (rc < 0)
	260	return rc;
	261
	262	/* Infrared toggle (Reg 0x51[7]) */
	263	poll_result->toggle_bit = (msg[0] >> 7);
	264
	265	/* Infrared read count (Reg 0x51[6:0] */
	266	poll_result->read_count = (msg[0] & 0x7f);
	267
	268	/* Remote Control Address (Reg 0x52) */
	269	poll_result->rc_address = msg[1];
	270
	271	/* Remote Control Data (Reg 0x53-55) */
	272	poll_result->rc_data[0] = msg[2];
	273	poll_result->rc_data[1] = msg[3];
	274	poll_result->rc_data[2] = msg[4];
	275
	276	return 0;
a924a499 MCC	277	}
	278
	279	/**********************************************************
	280	Polling code for em28xx
	281	**********************************************************/
	282
	283	static void em28xx_ir_handle_key(struct em28xx_IR *ir)
	284	{
4b92253a	285	int result;
4b92253a DH	286	struct em28xx_ir_poll_result poll_result;
	287
	288	/* read the registers containing the IR status */
	289	result = ir->get_key(ir, &poll_result);
603044d8	290	if (unlikely(result < 0)) {
4b92253a	291	dprintk("ir->get_key() failed %d\n", result);
a924a499	292	return;
4b92253a	293	}
a924a499	294
603044d8 MCC	295	if (unlikely(poll_result.read_count != ir->last_readcount)) {
	296	dprintk("%s: toggle: %d, count: %d, key 0x%02x%02x\n", __func__,
	297	poll_result.toggle_bit, poll_result.read_count,
	298	poll_result.rc_address, poll_result.rc_data[0]);
a469585b	299	if (ir->full_code)
ca86674b	300	rc_keydown(ir->rc,
a469585b DH	301	poll_result.rc_address << 8 \|
	302	poll_result.rc_data[0],
	303	poll_result.toggle_bit);
	304	else
ca86674b	305	rc_keydown(ir->rc,
a469585b DH	306	poll_result.rc_data[0],
a469585b DH	307	poll_result.toggle_bit);
a469585b	308
20ae9742 MCC	309	if (ir->dev->chip_id == CHIP_ID_EM2874 \|\|
20ae9742 MCC	310	ir->dev->chip_id == CHIP_ID_EM2884)
603044d8 MCC	311	/* The em2874 clears the readcount field every time the
	312	register is read. The em2860/2880 datasheet says that it
	313	is supposed to clear the readcount, but it doesn't. So with
	314	the em2874, we are looking for a non-zero read count as
	315	opposed to a readcount that is incrementing */
	316	ir->last_readcount = 0;
	317	else
	318	ir->last_readcount = poll_result.read_count;
	319	}
a924a499 MCC	320	}
a924a499 MCC	321
a924a499 MCC	322	static void em28xx_ir_work(struct work_struct *work)
a924a499 MCC	323	{
f263bac9	324	struct em28xx_IR *ir = container_of(work, struct em28xx_IR, work.work);
a924a499 MCC	325
a924a499 MCC	326	em28xx_ir_handle_key(ir);
f263bac9	327	schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling));
a924a499 MCC	328	}
a924a499 MCC	329
d8b4b582	330	static int em28xx_ir_start(struct rc_dev *rc)
a924a499	331	{
d8b4b582	332	struct em28xx_IR *ir = rc->priv;
c373cabf	333
f263bac9 JD	334	INIT_DELAYED_WORK(&ir->work, em28xx_ir_work);
f263bac9 JD	335	schedule_delayed_work(&ir->work, 0);
c373cabf MCC	336
c373cabf MCC	337	return 0;
a924a499 MCC	338	}
a924a499 MCC	339
d8b4b582	340	static void em28xx_ir_stop(struct rc_dev *rc)
a924a499	341	{
d8b4b582	342	struct em28xx_IR *ir = rc->priv;
c373cabf	343
f263bac9	344	cancel_delayed_work_sync(&ir->work);
a924a499 MCC	345	}
a924a499 MCC	346
52b66144	347	int em28xx_ir_change_protocol(struct rc_dev *rc_dev, u64 rc_type)
a924a499	348	{
950b0f5a	349	int rc = 0;
d8b4b582	350	struct em28xx_IR *ir = rc_dev->priv;
950b0f5a MCC	351	struct em28xx *dev = ir->dev;
950b0f5a MCC	352	u8 ir_config = EM2874_IR_RC5;
1bad429e MCC	353
1bad429e MCC	354	/* Adjust xclk based o IR table for RC5/NEC tables */
950b0f5a	355
52b66144	356	if (rc_type == RC_TYPE_RC5) {
1bad429e MCC	357	dev->board.xclk \|= EM28XX_XCLK_IR_RC5_MODE;
1bad429e MCC	358	ir->full_code = 1;
52b66144	359	} else if (rc_type == RC_TYPE_NEC) {
1bad429e MCC	360	dev->board.xclk &= ~EM28XX_XCLK_IR_RC5_MODE;
	361	ir_config = EM2874_IR_NEC;
	362	ir->full_code = 1;
52b66144	363	} else if (rc_type != RC_TYPE_UNKNOWN)
950b0f5a MCC	364	rc = -EINVAL;
950b0f5a MCC	365
1bad429e MCC	366	em28xx_write_reg_bits(dev, EM28XX_R0F_XCLK, dev->board.xclk,
1bad429e MCC	367	EM28XX_XCLK_IR_RC5_MODE);
a924a499	368
4b92253a DH	369	/* Setup the proper handler based on the chip */
	370	switch (dev->chip_id) {
	371	case CHIP_ID_EM2860:
	372	case CHIP_ID_EM2883:
	373	ir->get_key = default_polling_getkey;
91812fa7	374	break;
20ae9742	375	case CHIP_ID_EM2884:
4b92253a	376	case CHIP_ID_EM2874:
a24ec448	377	case CHIP_ID_EM28174:
4b92253a	378	ir->get_key = em2874_polling_getkey;
4b92253a DH	379	em28xx_write_regs(dev, EM2874_R50_IR_CONFIG, &ir_config, 1);
	380	break;
	381	default:
20ae9742 MCC	382	printk("Unrecognized em28xx chip id 0x%02x: IR not supported\n",
20ae9742 MCC	383	dev->chip_id);
950b0f5a MCC	384	rc = -EINVAL;
	385	}
	386
	387	return rc;
	388	}
	389
9d9f479b EG	390	void em28xx_register_i2c_ir(struct em28xx *dev)
	391	{
	392	/* Leadtek winfast tv USBII deluxe can find a non working IR-device */
	393	/* at address 0x18, so if that address is needed for another board in */
	394	/* the future, please put it after 0x1f. */
	395	struct i2c_board_info info;
	396	const unsigned short addr_list[] = {
	397	0x1f, 0x30, 0x47, I2C_CLIENT_END
	398	};
	399
	400	memset(&info, 0, sizeof(struct i2c_board_info));
	401	memset(&dev->init_data, 0, sizeof(dev->init_data));
	402	strlcpy(info.type, "ir_video", I2C_NAME_SIZE);
	403
	404	/* detect & configure */
	405	switch (dev->model) {
	406	case EM2800_BOARD_TERRATEC_CINERGY_200:
	407	case EM2820_BOARD_TERRATEC_CINERGY_250:
	408	dev->init_data.ir_codes = RC_MAP_EM_TERRATEC;
	409	dev->init_data.get_key = em28xx_get_key_terratec;
	410	dev->init_data.name = "i2c IR (EM28XX Terratec)";
	411	break;
	412	case EM2820_BOARD_PINNACLE_USB_2:
	413	dev->init_data.ir_codes = RC_MAP_PINNACLE_GREY;
	414	dev->init_data.get_key = em28xx_get_key_pinnacle_usb_grey;
	415	dev->init_data.name = "i2c IR (EM28XX Pinnacle PCTV)";
	416	break;
	417	case EM2820_BOARD_HAUPPAUGE_WINTV_USB_2:
	418	dev->init_data.ir_codes = RC_MAP_HAUPPAUGE;
	419	dev->init_data.get_key = em28xx_get_key_em_haup;
	420	dev->init_data.name = "i2c IR (EM2840 Hauppauge)";
	421	break;
	422	case EM2820_BOARD_LEADTEK_WINFAST_USBII_DELUXE:
	423	dev->init_data.ir_codes = RC_MAP_WINFAST_USBII_DELUXE;
	424	dev->init_data.get_key = em28xx_get_key_winfast_usbii_deluxe;
	425	dev->init_data.name = "i2c IR (EM2820 Winfast TV USBII Deluxe)";
	426	break;
	427	}
	428
	429	if (dev->init_data.name)
	430	info.platform_data = &dev->init_data;
	431	i2c_new_probed_device(&dev->i2c_adap, &info, addr_list, NULL);
	432	}
	433
950b0f5a MCC	434	int em28xx_ir_init(struct em28xx *dev)
	435	{
	436	struct em28xx_IR *ir;
d8b4b582	437	struct rc_dev *rc;
950b0f5a MCC	438	int err = -ENOMEM;
	439
	440	if (dev->board.ir_codes == NULL) {
	441	/* No remote control support */
	442	return 0;
a924a499 MCC	443	}
a924a499 MCC	444
950b0f5a	445	ir = kzalloc(sizeof(*ir), GFP_KERNEL);
d8b4b582 DH	446	rc = rc_allocate_device();
d8b4b582 DH	447	if (!ir \|\| !rc)
950b0f5a MCC	448	goto err_out_free;
	449
	450	/* record handles to ourself */
	451	ir->dev = dev;
	452	dev->ir = ir;
d8b4b582	453	ir->rc = rc;
950b0f5a MCC	454
	455	/*
	456	* em2874 supports more protocols. For now, let's just announce
	457	* the two protocols that were already tested
	458	*/
52b66144	459	rc->allowed_protos = RC_TYPE_RC5 \| RC_TYPE_NEC;
d8b4b582 DH	460	rc->priv = ir;
	461	rc->change_protocol = em28xx_ir_change_protocol;
	462	rc->open = em28xx_ir_start;
	463	rc->close = em28xx_ir_stop;
c373cabf MCC	464
c373cabf MCC	465	/* By default, keep protocol field untouched */
52b66144	466	err = em28xx_ir_change_protocol(rc, RC_TYPE_UNKNOWN);
c373cabf MCC	467	if (err)
c373cabf MCC	468	goto err_out_free;
950b0f5a	469
4b92253a DH	470	/* This is how often we ask the chip for IR information */
	471	ir->polling = 100; /* ms */
	472
a924a499 MCC	473	/* init input device */
	474	snprintf(ir->name, sizeof(ir->name), "em28xx IR (%s)",
	475	dev->name);
	476
	477	usb_make_path(dev->udev, ir->phys, sizeof(ir->phys));
	478	strlcat(ir->phys, "/input0", sizeof(ir->phys));
	479
d8b4b582 DH	480	rc->input_name = ir->name;
	481	rc->input_phys = ir->phys;
	482	rc->input_id.bustype = BUS_USB;
	483	rc->input_id.version = 1;
	484	rc->input_id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
	485	rc->input_id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
	486	rc->dev.parent = &dev->udev->dev;
	487	rc->map_name = dev->board.ir_codes;
	488	rc->driver_name = MODULE_NAME;
a924a499 MCC	489
a924a499 MCC	490	/* all done */
d8b4b582	491	err = rc_register_device(rc);
a924a499 MCC	492	if (err)
	493	goto err_out_stop;
	494
2fd6f8d1 EG	495	em28xx_register_i2c_ir(dev);
	496
	497	#if defined(CONFIG_MODULES) && defined(MODULE)
	498	if (dev->board.has_ir_i2c)
	499	request_module("ir-kbd-i2c");
	500	#endif
	501	if (dev->board.has_snapshot_button)
	502	em28xx_register_snapshot_button(dev);
	503
a924a499	504	return 0;
d8b4b582	505
a924a499	506	err_out_stop:
a924a499 MCC	507	dev->ir = NULL;
a924a499 MCC	508	err_out_free:
d8b4b582	509	rc_free_device(rc);
a924a499 MCC	510	kfree(ir);
	511	return err;
	512	}
	513
	514	int em28xx_ir_fini(struct em28xx *dev)
	515	{
	516	struct em28xx_IR *ir = dev->ir;
	517
2fd6f8d1 EG	518	em28xx_deregister_snapshot_button(dev);
2fd6f8d1 EG	519
a924a499 MCC	520	/* skip detach on non attached boards */
	521	if (!ir)
	522	return 0;
	523
6d514774 MCC	524	if (ir->rc)
6d514774 MCC	525	rc_unregister_device(ir->rc);
a924a499 MCC	526
a924a499 MCC	527	/* done */
6d514774	528	kfree(ir);
a924a499 MCC	529	dev->ir = NULL;
	530	return 0;
	531	}
	532
	533	/**********************************************************
	534	Handle Webcam snapshot button
	535	**********************************************************/
	536
a9fc52bc DH	537	static void em28xx_query_sbutton(struct work_struct *work)
	538	{
	539	/* Poll the register and see if the button is depressed */
	540	struct em28xx *dev =
	541	container_of(work, struct em28xx, sbutton_query_work.work);
	542	int ret;
	543
	544	ret = em28xx_read_reg(dev, EM28XX_R0C_USBSUSP);
	545
	546	if (ret & EM28XX_R0C_USBSUSP_SNAPSHOT) {
	547	u8 cleared;
	548	/* Button is depressed, clear the register */
	549	cleared = ((u8) ret) & ~EM28XX_R0C_USBSUSP_SNAPSHOT;
	550	em28xx_write_regs(dev, EM28XX_R0C_USBSUSP, &cleared, 1);
	551
	552	/* Not emulate the keypress */
	553	input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
	554	1);
	555	/* Now unpress the key */
	556	input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
	557	0);
	558	}
	559
	560	/* Schedule next poll */
	561	schedule_delayed_work(&dev->sbutton_query_work,
	562	msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
	563	}
	564
	565	void em28xx_register_snapshot_button(struct em28xx *dev)
	566	{
	567	struct input_dev *input_dev;
	568	int err;
	569
	570	em28xx_info("Registering snapshot button...\n");
	571	input_dev = input_allocate_device();
	572	if (!input_dev) {
	573	em28xx_errdev("input_allocate_device failed\n");
	574	return;
	575	}
	576
	577	usb_make_path(dev->udev, dev->snapshot_button_path,
	578	sizeof(dev->snapshot_button_path));
	579	strlcat(dev->snapshot_button_path, "/sbutton",
	580	sizeof(dev->snapshot_button_path));
	581	INIT_DELAYED_WORK(&dev->sbutton_query_work, em28xx_query_sbutton);
	582
	583	input_dev->name = "em28xx snapshot button";
	584	input_dev->phys = dev->snapshot_button_path;
	585	input_dev->evbit[0] = BIT_MASK(EV_KEY) \| BIT_MASK(EV_REP);
	586	set_bit(EM28XX_SNAPSHOT_KEY, input_dev->keybit);
	587	input_dev->keycodesize = 0;
	588	input_dev->keycodemax = 0;
	589	input_dev->id.bustype = BUS_USB;
	590	input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
	591	input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
	592	input_dev->id.version = 1;
	593	input_dev->dev.parent = &dev->udev->dev;
	594
	595	err = input_register_device(input_dev);
	596	if (err) {
	597	em28xx_errdev("input_register_device failed\n");
	598	input_free_device(input_dev);
	599	return;
	600	}
601
602	dev->sbutton_input_dev = input_dev;
603	schedule_delayed_work(&dev->sbutton_query_work,
604	msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
605	return;
606
607	}
608
609	void em28xx_deregister_snapshot_button(struct em28xx *dev)
610	{
611	if (dev->sbutton_input_dev != NULL) {
612	em28xx_info("Deregistering snapshot button\n");
afe2c511	613	cancel_delayed_work_sync(&dev->sbutton_query_work);
a9fc52bc DH	614	input_unregister_device(dev->sbutton_input_dev);
	615	dev->sbutton_input_dev = NULL;
	616	}
	617	return;
	618	}