[mirror_ubuntu-bionic-kernel.git] / drivers / media / video / cx231xx / cx231xx-input.c

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

  Copyright (C) 2008 <srinivasa.deevi at conexant dot com>
		Based on em28xx driver

		< This is a place holder for IR now.>

  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/input.h>
#include <linux/usb.h>

#include "cx231xx.h"

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

#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 cx231xx IR's
 **********************************************************/

struct cx231xx_ir_poll_result {
	unsigned int toggle_bit:1;
	unsigned int read_count:7;
	u8 rc_address;
	u8 rc_data[4];
};

struct cx231xx_IR {
	struct cx231xx *dev;
	struct input_dev *input;
	struct ir_input_state ir;
	char name[32];
	char phys[32];

	/* poll external decoder */
	int polling;
	struct work_struct work;
	struct timer_list timer;
	unsigned int last_toggle:1;
	unsigned int last_readcount;
	unsigned int repeat_interval;

	int (*get_key) (struct cx231xx_IR *, struct cx231xx_ir_poll_result *);
};

/**********************************************************
 Polling code for cx231xx
 **********************************************************/

static void cx231xx_ir_handle_key(struct cx231xx_IR *ir)
{
	int result;
	int do_sendkey = 0;
	struct cx231xx_ir_poll_result poll_result;

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

	dprintk("ir->get_key result tb=%02x rc=%02x lr=%02x data=%02x\n",
		poll_result.toggle_bit, poll_result.read_count,
		ir->last_readcount, poll_result.rc_data[0]);

	if (ir->dev->chip_id == CHIP_ID_EM2874) {
		/* 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;
	}

	if (poll_result.read_count == 0) {
		/* The button has not been pressed since the last read */
	} else if (ir->last_toggle != poll_result.toggle_bit) {
		/* A button has been pressed */
		dprintk("button has been pressed\n");
		ir->last_toggle = poll_result.toggle_bit;
		ir->repeat_interval = 0;
		do_sendkey = 1;
	} else if (poll_result.toggle_bit == ir->last_toggle &&
		   poll_result.read_count > 0 &&
		   poll_result.read_count != ir->last_readcount) {
		/* The button is still being held down */
		dprintk("button being held down\n");

		/* Debouncer for first keypress */
		if (ir->repeat_interval++ > 9) {
			/* Start repeating after 1 second */
			do_sendkey = 1;
		}
	}

	if (do_sendkey) {
		dprintk("sending keypress\n");
		ir_input_keydown(ir->input, &ir->ir, poll_result.rc_data[0],
				 poll_result.rc_data[0]);
		ir_input_nokey(ir->input, &ir->ir);
	}

	ir->last_readcount = poll_result.read_count;
	return;
}

static void ir_timer(unsigned long data)
{
	struct cx231xx_IR *ir = (struct cx231xx_IR *)data;

	schedule_work(&ir->work);
}

static void cx231xx_ir_work(struct work_struct *work)
{
	struct cx231xx_IR *ir = container_of(work, struct cx231xx_IR, work);

	cx231xx_ir_handle_key(ir);
	mod_timer(&ir->timer, jiffies + msecs_to_jiffies(ir->polling));
}

void cx231xx_ir_start(struct cx231xx_IR *ir)
{
	setup_timer(&ir->timer, ir_timer, (unsigned long)ir);
	INIT_WORK(&ir->work, cx231xx_ir_work);
	schedule_work(&ir->work);
}

static void cx231xx_ir_stop(struct cx231xx_IR *ir)
{
	del_timer_sync(&ir->timer);
	flush_scheduled_work();
}

int cx231xx_ir_init(struct cx231xx *dev)
{
	struct cx231xx_IR *ir;
	struct input_dev *input_dev;
	u8 ir_config;
	int err = -ENOMEM;

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

	ir = kzalloc(sizeof(*ir), GFP_KERNEL);
	input_dev = input_allocate_device();
	if (!ir || !input_dev)
		goto err_out_free;

	ir->input = input_dev;

	/* Setup the proper handler based on the chip */
	switch (dev->chip_id) {
	default:
		printk("Unrecognized cx231xx chip id: IR not supported\n");
		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), "cx231xx IR (%s)", dev->name);

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

	ir_input_init(input_dev, &ir->ir, IR_TYPE_OTHER, dev->board.ir_codes);
	input_dev->name = ir->name;
	input_dev->phys = ir->phys;
	input_dev->id.bustype = BUS_USB;
	input_dev->id.version = 1;
	input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
	input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);

	input_dev->dev.parent = &dev->udev->dev;
	/* record handles to ourself */
	ir->dev = dev;
	dev->ir = ir;

	cx231xx_ir_start(ir);

	/* all done */
	err = input_register_device(ir->input);
	if (err)
		goto err_out_stop;

	return 0;
err_out_stop:
	cx231xx_ir_stop(ir);
	dev->ir = NULL;
err_out_free:
	input_free_device(input_dev);
	kfree(ir);
	return err;
}

int cx231xx_ir_fini(struct cx231xx *dev)
{
	struct cx231xx_IR *ir = dev->ir;

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

	cx231xx_ir_stop(ir);
	input_unregister_device(ir->input);
	kfree(ir);

	/* done */
	dev->ir = NULL;
	return 0;
}
Commit	Line	Data
e0d3bafd SD	1	/*
	2	handle cx231xx IR remotes via linux kernel input layer.
	3
	4	Copyright (C) 2008 <srinivasa.deevi at conexant dot com>
b9255176	5	Based on em28xx driver
e0d3bafd	6
b9255176	7	< This is a place holder for IR now.>
e0d3bafd SD	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
	22	*/
	23
	24	#include <linux/module.h>
	25	#include <linux/init.h>
	26	#include <linux/delay.h>
	27	#include <linux/interrupt.h>
	28	#include <linux/input.h>
	29	#include <linux/usb.h>
	30
	31	#include "cx231xx.h"
	32
e0d3bafd SD	33	static unsigned int ir_debug;
	34	module_param(ir_debug, int, 0644);
	35	MODULE_PARM_DESC(ir_debug, "enable debug messages [IR]");
	36
	37	#define i2cdprintk(fmt, arg...) \
	38	if (ir_debug) { \
1df8e986	39	printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
e0d3bafd SD	40	}
	41
	42	#define dprintk(fmt, arg...) \
	43	if (ir_debug) { \
	44	printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
	45	}
	46
	47	/**********************************************************
	48	Polling structure used by cx231xx IR's
	49	**********************************************************/
	50
	51	struct cx231xx_ir_poll_result {
	52	unsigned int toggle_bit:1;
	53	unsigned int read_count:7;
	54	u8 rc_address;
	55	u8 rc_data[4];
	56	};
	57
	58	struct cx231xx_IR {
	59	struct cx231xx *dev;
	60	struct input_dev *input;
	61	struct ir_input_state ir;
	62	char name[32];
	63	char phys[32];
	64
	65	/* poll external decoder */
	66	int polling;
	67	struct work_struct work;
	68	struct timer_list timer;
	69	unsigned int last_toggle:1;
	70	unsigned int last_readcount;
	71	unsigned int repeat_interval;
	72
84b5dbf3	73	int (get_key) (struct cx231xx_IR , struct cx231xx_ir_poll_result *);
e0d3bafd SD	74	};
e0d3bafd SD	75
e0d3bafd SD	76	/**********************************************************
	77	Polling code for cx231xx
	78	**********************************************************/
	79
	80	static void cx231xx_ir_handle_key(struct cx231xx_IR *ir)
	81	{
	82	int result;
	83	int do_sendkey = 0;
	84	struct cx231xx_ir_poll_result poll_result;
	85
	86	/* read the registers containing the IR status */
	87	result = ir->get_key(ir, &poll_result);
	88	if (result < 0) {
	89	dprintk("ir->get_key() failed %d\n", result);
	90	return;
	91	}
	92
	93	dprintk("ir->get_key result tb=%02x rc=%02x lr=%02x data=%02x\n",
	94	poll_result.toggle_bit, poll_result.read_count,
	95	ir->last_readcount, poll_result.rc_data[0]);
	96
	97	if (ir->dev->chip_id == CHIP_ID_EM2874) {
	98	/* The em2874 clears the readcount field every time the
	99	register is read. The em2860/2880 datasheet says that it
	100	is supposed to clear the readcount, but it doesn't. So with
	101	the em2874, we are looking for a non-zero read count as
	102	opposed to a readcount that is incrementing */
	103	ir->last_readcount = 0;
	104	}
	105
	106	if (poll_result.read_count == 0) {
	107	/* The button has not been pressed since the last read */
	108	} else if (ir->last_toggle != poll_result.toggle_bit) {
	109	/* A button has been pressed */
	110	dprintk("button has been pressed\n");
	111	ir->last_toggle = poll_result.toggle_bit;
	112	ir->repeat_interval = 0;
	113	do_sendkey = 1;
	114	} else if (poll_result.toggle_bit == ir->last_toggle &&
	115	poll_result.read_count > 0 &&
	116	poll_result.read_count != ir->last_readcount) {
	117	/* The button is still being held down */
	118	dprintk("button being held down\n");
	119
	120	/* Debouncer for first keypress */
	121	if (ir->repeat_interval++ > 9) {
	122	/* Start repeating after 1 second */
	123	do_sendkey = 1;
	124	}
	125	}
	126
	127	if (do_sendkey) {
	128	dprintk("sending keypress\n");
	129	ir_input_keydown(ir->input, &ir->ir, poll_result.rc_data[0],
	130	poll_result.rc_data[0]);
	131	ir_input_nokey(ir->input, &ir->ir);
	132	}
	133
	134	ir->last_readcount = poll_result.read_count;
	135	return;
	136	}
	137
	138	static void ir_timer(unsigned long data)
	139	{
140	struct cx231xx_IR ir = (struct cx231xx_IR )data;
141
142	schedule_work(&ir->work);
143	}
144
145	static void cx231xx_ir_work(struct work_struct *work)
146	{
147	struct cx231xx_IR *ir = container_of(work, struct cx231xx_IR, work);
148
149	cx231xx_ir_handle_key(ir);
150	mod_timer(&ir->timer, jiffies + msecs_to_jiffies(ir->polling));
151	}
152
153	void cx231xx_ir_start(struct cx231xx_IR *ir)
154	{
155	setup_timer(&ir->timer, ir_timer, (unsigned long)ir);
156	INIT_WORK(&ir->work, cx231xx_ir_work);
157	schedule_work(&ir->work);
158	}
159
160	static void cx231xx_ir_stop(struct cx231xx_IR *ir)
161	{
162	del_timer_sync(&ir->timer);
163	flush_scheduled_work();
164	}
165
166	int cx231xx_ir_init(struct cx231xx *dev)
167	{
168	struct cx231xx_IR *ir;
169	struct input_dev *input_dev;
170	u8 ir_config;
171	int err = -ENOMEM;
172
173	if (dev->board.ir_codes == NULL) {
174	/* No remote control support */
175	return 0;
176	}
177
178	ir = kzalloc(sizeof(*ir), GFP_KERNEL);
179	input_dev = input_allocate_device();
180	if (!ir \|\| !input_dev)
181	goto err_out_free;
182
183	ir->input = input_dev;
184
185	/* Setup the proper handler based on the chip */
186	switch (dev->chip_id) {
84b5dbf3 MCC	187	default:
	188	printk("Unrecognized cx231xx chip id: IR not supported\n");
	189	goto err_out_free;
e0d3bafd SD	190	}
	191
	192	/* This is how often we ask the chip for IR information */
84b5dbf3	193	ir->polling = 100; /* ms */
e0d3bafd SD	194
e0d3bafd SD	195	/* init input device */
84b5dbf3	196	snprintf(ir->name, sizeof(ir->name), "cx231xx IR (%s)", dev->name);
e0d3bafd SD	197
	198	usb_make_path(dev->udev, ir->phys, sizeof(ir->phys));
	199	strlcat(ir->phys, "/input0", sizeof(ir->phys));
	200
	201	ir_input_init(input_dev, &ir->ir, IR_TYPE_OTHER, dev->board.ir_codes);
	202	input_dev->name = ir->name;
	203	input_dev->phys = ir->phys;
	204	input_dev->id.bustype = BUS_USB;
	205	input_dev->id.version = 1;
	206	input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
	207	input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
	208
	209	input_dev->dev.parent = &dev->udev->dev;
	210	/* record handles to ourself */
	211	ir->dev = dev;
	212	dev->ir = ir;
	213
	214	cx231xx_ir_start(ir);
	215
	216	/* all done */
	217	err = input_register_device(ir->input);
	218	if (err)
	219	goto err_out_stop;
	220
	221	return 0;
b9255176	222	err_out_stop:
e0d3bafd SD	223	cx231xx_ir_stop(ir);
e0d3bafd SD	224	dev->ir = NULL;
b9255176	225	err_out_free:
e0d3bafd SD	226	input_free_device(input_dev);
	227	kfree(ir);
	228	return err;
	229	}
	230
	231	int cx231xx_ir_fini(struct cx231xx *dev)
	232	{
	233	struct cx231xx_IR *ir = dev->ir;
	234
	235	/* skip detach on non attached boards */
	236	if (!ir)
	237	return 0;
	238
	239	cx231xx_ir_stop(ir);
	240	input_unregister_device(ir->input);
	241	kfree(ir);
	242
	243	/* done */
	244	dev->ir = NULL;
	245	return 0;
	246	}