[mirror_ubuntu-focal-kernel.git] / drivers / input / misc / dm355evm_keys.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * dm355evm_keys.c - support buttons and IR remote on DM355 EVM board
 *
 * Copyright (c) 2008 by David Brownell
 */
#include <linux/kernel.h>
#include <linux/slab.h>
#include <linux/input.h>
#include <linux/input/sparse-keymap.h>
#include <linux/platform_device.h>
#include <linux/interrupt.h>

#include <linux/mfd/dm355evm_msp.h>
#include <linux/module.h>


/*
 * The MSP430 firmware on the DM355 EVM monitors on-board pushbuttons
 * and an IR receptor used for the remote control.  When any key is
 * pressed, or its autorepeat kicks in, an event is sent.  This driver
 * read those events from the small (32 event) queue and reports them.
 *
 * Note that physically there can only be one of these devices.
 *
 * This driver was tested with firmware revision A4.
 */
struct dm355evm_keys {
	struct input_dev	*input;
	struct device		*dev;
};

/* These initial keycodes can be remapped */
static const struct key_entry dm355evm_keys[] = {
	/*
	 * Pushbuttons on the EVM board ... note that the labels for these
	 * are SW10/SW11/etc on the PC board.  The left/right orientation
	 * comes only from the firmware's documentation, and presumes the
	 * power connector is immediately in front of you and the IR sensor
	 * is to the right.  (That is, rotate the board counter-clockwise
	 * by 90 degrees from the SW10/etc and "DM355 EVM" labels.)
	 */
	{ KE_KEY, 0x00d8, { KEY_OK } },		/* SW12 */
	{ KE_KEY, 0x00b8, { KEY_UP } },		/* SW13 */
	{ KE_KEY, 0x00e8, { KEY_DOWN } },	/* SW11 */
	{ KE_KEY, 0x0078, { KEY_LEFT } },	/* SW14 */
	{ KE_KEY, 0x00f0, { KEY_RIGHT } },	/* SW10 */

	/*
	 * IR buttons ... codes assigned to match the universal remote
	 * provided with the EVM (Philips PM4S) using DVD code 0020.
	 *
	 * These event codes match firmware documentation, but other
	 * remote controls could easily send more RC5-encoded events.
	 * The PM4S manual was used in several cases to help select
	 * a keycode reflecting the intended usage.
	 *
	 * RC5 codes are 14 bits, with two start bits (0x3 prefix)
	 * and a toggle bit (masked out below).
	 */
	{ KE_KEY, 0x300c, { KEY_POWER } },	/* NOTE: docs omit this */
	{ KE_KEY, 0x3000, { KEY_NUMERIC_0 } },
	{ KE_KEY, 0x3001, { KEY_NUMERIC_1 } },
	{ KE_KEY, 0x3002, { KEY_NUMERIC_2 } },
	{ KE_KEY, 0x3003, { KEY_NUMERIC_3 } },
	{ KE_KEY, 0x3004, { KEY_NUMERIC_4 } },
	{ KE_KEY, 0x3005, { KEY_NUMERIC_5 } },
	{ KE_KEY, 0x3006, { KEY_NUMERIC_6 } },
	{ KE_KEY, 0x3007, { KEY_NUMERIC_7 } },
	{ KE_KEY, 0x3008, { KEY_NUMERIC_8 } },
	{ KE_KEY, 0x3009, { KEY_NUMERIC_9 } },
	{ KE_KEY, 0x3022, { KEY_ENTER } },
	{ KE_KEY, 0x30ec, { KEY_MODE } },	/* "tv/vcr/..." */
	{ KE_KEY, 0x300f, { KEY_SELECT } },	/* "info" */
	{ KE_KEY, 0x3020, { KEY_CHANNELUP } },	/* "up" */
	{ KE_KEY, 0x302e, { KEY_MENU } },	/* "in/out" */
	{ KE_KEY, 0x3011, { KEY_VOLUMEDOWN } },	/* "left" */
	{ KE_KEY, 0x300d, { KEY_MUTE } },	/* "ok" */
	{ KE_KEY, 0x3010, { KEY_VOLUMEUP } },	/* "right" */
	{ KE_KEY, 0x301e, { KEY_SUBTITLE } },	/* "cc" */
	{ KE_KEY, 0x3021, { KEY_CHANNELDOWN } },/* "down" */
	{ KE_KEY, 0x3022, { KEY_PREVIOUS } },
	{ KE_KEY, 0x3026, { KEY_SLEEP } },
	{ KE_KEY, 0x3172, { KEY_REWIND } },	/* NOTE: docs wrongly say 0x30ca */
	{ KE_KEY, 0x3175, { KEY_PLAY } },
	{ KE_KEY, 0x3174, { KEY_FASTFORWARD } },
	{ KE_KEY, 0x3177, { KEY_RECORD } },
	{ KE_KEY, 0x3176, { KEY_STOP } },
	{ KE_KEY, 0x3169, { KEY_PAUSE } },
};

/*
 * Because we communicate with the MSP430 using I2C, and all I2C calls
 * in Linux sleep, we use a threaded IRQ handler.  The IRQ itself is
 * active low, but we go through the GPIO controller so we can trigger
 * on falling edges and not worry about enabling/disabling the IRQ in
 * the keypress handling path.
 */
static irqreturn_t dm355evm_keys_irq(int irq, void *_keys)
{
	static u16 last_event;
	struct dm355evm_keys *keys = _keys;
	const struct key_entry *ke;
	unsigned int keycode;
	int status;
	u16 event;

	/* For simplicity we ignore INPUT_COUNT and just read
	 * events until we get the "queue empty" indicator.
	 * Reading INPUT_LOW decrements the count.
	 */
	for (;;) {
		status = dm355evm_msp_read(DM355EVM_MSP_INPUT_HIGH);
		if (status < 0) {
			dev_dbg(keys->dev, "input high err %d\n",
					status);
			break;
		}
		event = status << 8;

		status = dm355evm_msp_read(DM355EVM_MSP_INPUT_LOW);
		if (status < 0) {
			dev_dbg(keys->dev, "input low err %d\n",
					status);
			break;
		}
		event |= status;
		if (event == 0xdead)
			break;

		/* Press and release a button:  two events, same code.
		 * Press and hold (autorepeat), then release: N events
		 * (N > 2), same code.  For RC5 buttons the toggle bits
		 * distinguish (for example) "1-autorepeat" from "1 1";
		 * but PCB buttons don't support that bit.
		 *
		 * So we must synthesize release events.  We do that by
		 * mapping events to a press/release event pair; then
		 * to avoid adding extra events, skip the second event
		 * of each pair.
		 */
		if (event == last_event) {
			last_event = 0;
			continue;
		}
		last_event = event;

		/* ignore the RC5 toggle bit */
		event &= ~0x0800;

		/* find the key, or report it as unknown */
		ke = sparse_keymap_entry_from_scancode(keys->input, event);
		keycode = ke ? ke->keycode : KEY_UNKNOWN;
		dev_dbg(keys->dev,
			"input event 0x%04x--> keycode %d\n",
			event, keycode);

		/* report press + release */
		input_report_key(keys->input, keycode, 1);
		input_sync(keys->input);
		input_report_key(keys->input, keycode, 0);
		input_sync(keys->input);
	}

	return IRQ_HANDLED;
}

/*----------------------------------------------------------------------*/

static int dm355evm_keys_probe(struct platform_device *pdev)
{
	struct dm355evm_keys	*keys;
	struct input_dev	*input;
	int			irq;
	int			error;

	keys = devm_kzalloc(&pdev->dev, sizeof (*keys), GFP_KERNEL);
	if (!keys)
		return -ENOMEM;

	input = devm_input_allocate_device(&pdev->dev);
	if (!input)
		return -ENOMEM;

	keys->dev = &pdev->dev;
	keys->input = input;

	input->name = "DM355 EVM Controls";
	input->phys = "dm355evm/input0";

	input->id.bustype = BUS_I2C;
	input->id.product = 0x0355;
	input->id.version = dm355evm_msp_read(DM355EVM_MSP_FIRMREV);

	error = sparse_keymap_setup(input, dm355evm_keys, NULL);
	if (error)
		return error;

	/* REVISIT:  flush the event queue? */

	/* set up "threaded IRQ handler" */
	irq = platform_get_irq(pdev, 0);
	if (irq < 0)
		return irq;

	error = devm_request_threaded_irq(&pdev->dev, irq,
					  NULL, dm355evm_keys_irq,
					  IRQF_TRIGGER_FALLING | IRQF_ONESHOT,
					  dev_name(&pdev->dev), keys);
	if (error)
		return error;

	/* register */
	error = input_register_device(input);
	if (error)
		return error;

	return 0;
}

/* REVISIT:  add suspend/resume when DaVinci supports it.  The IRQ should
 * be able to wake up the system.  When device_may_wakeup(&pdev->dev), call
 * enable_irq_wake() on suspend, and disable_irq_wake() on resume.
 */

/*
 * I2C is used to talk to the MSP430, but this platform device is
 * exposed by an MFD driver that manages I2C communications.
 */
static struct platform_driver dm355evm_keys_driver = {
	.probe		= dm355evm_keys_probe,
	.driver		= {
		.name	= "dm355evm_keys",
	},
};
module_platform_driver(dm355evm_keys_driver);

MODULE_LICENSE("GPL");
Commit	Line	Data
2874c5fd	1	// SPDX-License-Identifier: GPL-2.0-or-later
eb990b55 DB	2	/*
	3	* dm355evm_keys.c - support buttons and IR remote on DM355 EVM board
	4	*
	5	* Copyright (c) 2008 by David Brownell
eb990b55 DB	6	*/
eb990b55 DB	7	#include <linux/kernel.h>
5a0e3ad6	8	#include <linux/slab.h>
eb990b55	9	#include <linux/input.h>
66040727	10	#include <linux/input/sparse-keymap.h>
eb990b55 DB	11	#include <linux/platform_device.h>
	12	#include <linux/interrupt.h>
	13
0335a955	14	#include <linux/mfd/dm355evm_msp.h>
d2d8442d	15	#include <linux/module.h>
eb990b55 DB	16
	17
	18	/*
	19	* The MSP430 firmware on the DM355 EVM monitors on-board pushbuttons
	20	* and an IR receptor used for the remote control. When any key is
	21	* pressed, or its autorepeat kicks in, an event is sent. This driver
	22	* read those events from the small (32 event) queue and reports them.
	23	*
eb990b55 DB	24	* Note that physically there can only be one of these devices.
	25	*
	26	* This driver was tested with firmware revision A4.
	27	*/
	28	struct dm355evm_keys {
eb990b55 DB	29	struct input_dev *input;
eb990b55 DB	30	struct device *dev;
eb990b55 DB	31	};
eb990b55 DB	32
66040727 DT	33	/* These initial keycodes can be remapped */
66040727 DT	34	static const struct key_entry dm355evm_keys[] = {
eb990b55 DB	35	/*
	36	* Pushbuttons on the EVM board ... note that the labels for these
	37	* are SW10/SW11/etc on the PC board. The left/right orientation
	38	* comes only from the firmware's documentation, and presumes the
	39	* power connector is immediately in front of you and the IR sensor
	40	* is to the right. (That is, rotate the board counter-clockwise
	41	* by 90 degrees from the SW10/etc and "DM355 EVM" labels.)
	42	*/
66040727 DT	43	{ KE_KEY, 0x00d8, { KEY_OK } }, /* SW12 */
	44	{ KE_KEY, 0x00b8, { KEY_UP } }, /* SW13 */
	45	{ KE_KEY, 0x00e8, { KEY_DOWN } }, /* SW11 */
	46	{ KE_KEY, 0x0078, { KEY_LEFT } }, /* SW14 */
	47	{ KE_KEY, 0x00f0, { KEY_RIGHT } }, /* SW10 */
eb990b55 DB	48
	49	/*
	50	* IR buttons ... codes assigned to match the universal remote
	51	* provided with the EVM (Philips PM4S) using DVD code 0020.
	52	*
	53	* These event codes match firmware documentation, but other
	54	* remote controls could easily send more RC5-encoded events.
	55	* The PM4S manual was used in several cases to help select
	56	* a keycode reflecting the intended usage.
	57	*
	58	* RC5 codes are 14 bits, with two start bits (0x3 prefix)
	59	* and a toggle bit (masked out below).
	60	*/
66040727 DT	61	{ KE_KEY, 0x300c, { KEY_POWER } }, /* NOTE: docs omit this */
	62	{ KE_KEY, 0x3000, { KEY_NUMERIC_0 } },
	63	{ KE_KEY, 0x3001, { KEY_NUMERIC_1 } },
	64	{ KE_KEY, 0x3002, { KEY_NUMERIC_2 } },
	65	{ KE_KEY, 0x3003, { KEY_NUMERIC_3 } },
	66	{ KE_KEY, 0x3004, { KEY_NUMERIC_4 } },
	67	{ KE_KEY, 0x3005, { KEY_NUMERIC_5 } },
	68	{ KE_KEY, 0x3006, { KEY_NUMERIC_6 } },
	69	{ KE_KEY, 0x3007, { KEY_NUMERIC_7 } },
	70	{ KE_KEY, 0x3008, { KEY_NUMERIC_8 } },
	71	{ KE_KEY, 0x3009, { KEY_NUMERIC_9 } },
	72	{ KE_KEY, 0x3022, { KEY_ENTER } },
	73	{ KE_KEY, 0x30ec, { KEY_MODE } }, /* "tv/vcr/..." */
	74	{ KE_KEY, 0x300f, { KEY_SELECT } }, /* "info" */
	75	{ KE_KEY, 0x3020, { KEY_CHANNELUP } }, /* "up" */
	76	{ KE_KEY, 0x302e, { KEY_MENU } }, /* "in/out" */
	77	{ KE_KEY, 0x3011, { KEY_VOLUMEDOWN } }, /* "left" */
	78	{ KE_KEY, 0x300d, { KEY_MUTE } }, /* "ok" */
	79	{ KE_KEY, 0x3010, { KEY_VOLUMEUP } }, /* "right" */
	80	{ KE_KEY, 0x301e, { KEY_SUBTITLE } }, /* "cc" */
	81	{ KE_KEY, 0x3021, { KEY_CHANNELDOWN } },/* "down" */
	82	{ KE_KEY, 0x3022, { KEY_PREVIOUS } },
	83	{ KE_KEY, 0x3026, { KEY_SLEEP } },
	84	{ KE_KEY, 0x3172, { KEY_REWIND } }, /* NOTE: docs wrongly say 0x30ca */
	85	{ KE_KEY, 0x3175, { KEY_PLAY } },
	86	{ KE_KEY, 0x3174, { KEY_FASTFORWARD } },
	87	{ KE_KEY, 0x3177, { KEY_RECORD } },
	88	{ KE_KEY, 0x3176, { KEY_STOP } },
	89	{ KE_KEY, 0x3169, { KEY_PAUSE } },
eb990b55 DB	90	};
eb990b55 DB	91
3b0a9ce0 DT	92	/*
	93	* Because we communicate with the MSP430 using I2C, and all I2C calls
	94	* in Linux sleep, we use a threaded IRQ handler. The IRQ itself is
	95	* active low, but we go through the GPIO controller so we can trigger
	96	* on falling edges and not worry about enabling/disabling the IRQ in
	97	* the keypress handling path.
	98	*/
666cbe34	99	static irqreturn_t dm355evm_keys_irq(int irq, void *_keys)
eb990b55	100	{
66040727 DT	101	static u16 last_event;
	102	struct dm355evm_keys *keys = _keys;
	103	const struct key_entry *ke;
	104	unsigned int keycode;
	105	int status;
	106	u16 event;
eb990b55	107
eb990b55 DB	108	/* For simplicity we ignore INPUT_COUNT and just read
	109	* events until we get the "queue empty" indicator.
	110	* Reading INPUT_LOW decrements the count.
	111	*/
	112	for (;;) {
eb990b55 DB	113	status = dm355evm_msp_read(DM355EVM_MSP_INPUT_HIGH);
	114	if (status < 0) {
	115	dev_dbg(keys->dev, "input high err %d\n",
	116	status);
	117	break;
	118	}
	119	event = status << 8;
	120
	121	status = dm355evm_msp_read(DM355EVM_MSP_INPUT_LOW);
	122	if (status < 0) {
	123	dev_dbg(keys->dev, "input low err %d\n",
	124	status);
	125	break;
	126	}
	127	event \|= status;
	128	if (event == 0xdead)
	129	break;
	130
	131	/* Press and release a button: two events, same code.
	132	* Press and hold (autorepeat), then release: N events
	133	* (N > 2), same code. For RC5 buttons the toggle bits
	134	* distinguish (for example) "1-autorepeat" from "1 1";
	135	* but PCB buttons don't support that bit.
	136	*
	137	* So we must synthesize release events. We do that by
	138	* mapping events to a press/release event pair; then
	139	* to avoid adding extra events, skip the second event
	140	* of each pair.
	141	*/
	142	if (event == last_event) {
	143	last_event = 0;
	144	continue;
	145	}
	146	last_event = event;
	147
	148	/* ignore the RC5 toggle bit */
	149	event &= ~0x0800;
	150
66040727 DT	151	/* find the key, or report it as unknown */
	152	ke = sparse_keymap_entry_from_scancode(keys->input, event);
	153	keycode = ke ? ke->keycode : KEY_UNKNOWN;
eb990b55 DB	154	dev_dbg(keys->dev,
	155	"input event 0x%04x--> keycode %d\n",
	156	event, keycode);
	157
	158	/* report press + release */
	159	input_report_key(keys->input, keycode, 1);
	160	input_sync(keys->input);
	161	input_report_key(keys->input, keycode, 0);
	162	input_sync(keys->input);
	163	}
666cbe34	164
66040727	165	return IRQ_HANDLED;
eb990b55 DB	166	}
	167
	168	/----------------------------------------------------------------------/
	169
5298cc4c	170	static int dm355evm_keys_probe(struct platform_device *pdev)
eb990b55 DB	171	{
	172	struct dm355evm_keys *keys;
	173	struct input_dev *input;
52e4f1d6 DT	174	int irq;
52e4f1d6 DT	175	int error;
eb990b55	176
52e4f1d6 DT	177	keys = devm_kzalloc(&pdev->dev, sizeof (*keys), GFP_KERNEL);
	178	if (!keys)
	179	return -ENOMEM;
	180
	181	input = devm_input_allocate_device(&pdev->dev);
	182	if (!input)
	183	return -ENOMEM;
eb990b55 DB	184
	185	keys->dev = &pdev->dev;
	186	keys->input = input;
eb990b55	187
eb990b55 DB	188	input->name = "DM355 EVM Controls";
eb990b55 DB	189	input->phys = "dm355evm/input0";
eb990b55 DB	190
	191	input->id.bustype = BUS_I2C;
	192	input->id.product = 0x0355;
	193	input->id.version = dm355evm_msp_read(DM355EVM_MSP_FIRMREV);
	194
52e4f1d6 DT	195	error = sparse_keymap_setup(input, dm355evm_keys, NULL);
	196	if (error)
	197	return error;
eb990b55 DB	198
	199	/* REVISIT: flush the event queue? */
	200
52e4f1d6 DT	201	/* set up "threaded IRQ handler" */
	202	irq = platform_get_irq(pdev, 0);
	203	if (irq < 0)
	204	return irq;
eb990b55	205
52e4f1d6 DT	206	error = devm_request_threaded_irq(&pdev->dev, irq,
	207	NULL, dm355evm_keys_irq,
	208	IRQF_TRIGGER_FALLING \| IRQF_ONESHOT,
	209	dev_name(&pdev->dev), keys);
	210	if (error)
	211	return error;
eb990b55	212
52e4f1d6 DT	213	/* register */
	214	error = input_register_device(input);
	215	if (error)
	216	return error;
eb990b55 DB	217
	218	return 0;
	219	}
	220
	221	/* REVISIT: add suspend/resume when DaVinci supports it. The IRQ should
	222	* be able to wake up the system. When device_may_wakeup(&pdev->dev), call
	223	* enable_irq_wake() on suspend, and disable_irq_wake() on resume.
	224	*/
	225
	226	/*
	227	* I2C is used to talk to the MSP430, but this platform device is
	228	* exposed by an MFD driver that manages I2C communications.
	229	*/
	230	static struct platform_driver dm355evm_keys_driver = {
	231	.probe = dm355evm_keys_probe,
eb990b55	232	.driver = {
eb990b55 DB	233	.name = "dm355evm_keys",
	234	},
	235	};
840a746b	236	module_platform_driver(dm355evm_keys_driver);
eb990b55 DB	237
eb990b55 DB	238	MODULE_LICENSE("GPL");