1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * HID driver for TwinHan IR remote control
4 *
5 * Based on hid-gyration.c
6 *
7 * Copyright (c) 2009 Bruno Pr��mont <bonbons@linux-vserver.org>
8 */
9
10/*
11 */
12
13#include <linux/device.h>
14#include <linux/input.h>
15#include <linux/hid.h>
16#include <linux/module.h>
17
18#include "hid-ids.h"
19
20/*	Remote control key layout + listing:
21 *
22 * 	Full Screen                              Power
23 *	KEY_SCREEN                          KEY_POWER2
24 *
25 *	1                     2                      3
26 *	KEY_NUMERIC_1   KEY_NUMERIC_2    KEY_NUMERIC_3
27 *
28 *	4                     5                      6
29 *	KEY_NUMERIC_4   KEY_NUMERIC_5    KEY_NUMERIC_6
30 *
31 *	7                     8                      9
32 *	KEY_NUMERIC_7   KEY_NUMERIC_8    KEY_NUMERIC_9
33 *
34 *	REC                   0               Favorite
35 *	KEY_RECORD      KEY_NUMERIC_0    KEY_FAVORITES
36 *
37 *	Rewind                                 Forward
38 *	KEY_REWIND           CH+           KEY_FORWARD
39 *	               KEY_CHANNELUP
40 *
41 *	VOL-                  >                   VOL+
42 *	KEY_VOLUMEDOWN    KEY_PLAY        KEY_VOLUMEUP
43 *
44 *	                     CH-
45 *	              KEY_CHANNELDOWN
46 *	Recall                                    Stop
47 *	KEY_RESTART                           KEY_STOP
48 *
49 *	Timeshift/Pause     Mute                Cancel
50 *	KEY_PAUSE         KEY_MUTE          KEY_CANCEL
51 *
52 *	Capture            Preview                 EPG
53 *	KEY_PRINT        KEY_PROGRAM           KEY_EPG
54 *
55 *	Record List          Tab              Teletext
56 *	KEY_LIST            KEY_TAB           KEY_TEXT
57 */
58
59#define th_map_key_clear(c)	hid_map_usage_clear(hi, usage, bit, max, \
60					EV_KEY, (c))
61static int twinhan_input_mapping(struct hid_device *hdev, struct hid_input *hi,
62		struct hid_field *field, struct hid_usage *usage,
63		unsigned long **bit, int *max)
64{
65	if ((usage->hid & HID_USAGE_PAGE) != HID_UP_KEYBOARD)
66		return 0;
67
68	switch (usage->hid & HID_USAGE) {
69	/* Map all keys from Twinhan Remote */
70	case 0x004: th_map_key_clear(KEY_TEXT);         break;
71	case 0x006: th_map_key_clear(KEY_RESTART);      break;
72	case 0x008: th_map_key_clear(KEY_EPG);          break;
73	case 0x00c: th_map_key_clear(KEY_REWIND);       break;
74	case 0x00e: th_map_key_clear(KEY_PROGRAM);      break;
75	case 0x00f: th_map_key_clear(KEY_LIST);         break;
76	case 0x010: th_map_key_clear(KEY_MUTE);         break;
77	case 0x011: th_map_key_clear(KEY_FORWARD);      break;
78	case 0x013: th_map_key_clear(KEY_PRINT);        break;
79	case 0x017: th_map_key_clear(KEY_PAUSE);        break;
80	case 0x019: th_map_key_clear(KEY_FAVORITES);    break;
81	case 0x01d: th_map_key_clear(KEY_SCREEN);       break;
82	case 0x01e: th_map_key_clear(KEY_NUMERIC_1);    break;
83	case 0x01f: th_map_key_clear(KEY_NUMERIC_2);    break;
84	case 0x020: th_map_key_clear(KEY_NUMERIC_3);    break;
85	case 0x021: th_map_key_clear(KEY_NUMERIC_4);    break;
86	case 0x022: th_map_key_clear(KEY_NUMERIC_5);    break;
87	case 0x023: th_map_key_clear(KEY_NUMERIC_6);    break;
88	case 0x024: th_map_key_clear(KEY_NUMERIC_7);    break;
89	case 0x025: th_map_key_clear(KEY_NUMERIC_8);    break;
90	case 0x026: th_map_key_clear(KEY_NUMERIC_9);    break;
91	case 0x027: th_map_key_clear(KEY_NUMERIC_0);    break;
92	case 0x028: th_map_key_clear(KEY_PLAY);         break;
93	case 0x029: th_map_key_clear(KEY_CANCEL);       break;
94	case 0x02b: th_map_key_clear(KEY_TAB);          break;
95	/* Power       = 0x0e0 + 0x0e1 + 0x0e2 + 0x03f */
96	case 0x03f: th_map_key_clear(KEY_POWER2);       break;
97	case 0x04a: th_map_key_clear(KEY_RECORD);       break;
98	case 0x04b: th_map_key_clear(KEY_CHANNELUP);    break;
99	case 0x04d: th_map_key_clear(KEY_STOP);         break;
100	case 0x04e: th_map_key_clear(KEY_CHANNELDOWN);  break;
101	/* Volume down = 0x0e1 + 0x051                 */
102	case 0x051: th_map_key_clear(KEY_VOLUMEDOWN);   break;
103	/* Volume up   = 0x0e1 + 0x052                 */
104	case 0x052: th_map_key_clear(KEY_VOLUMEUP);     break;
105	/* Kill the extra keys used for multi-key "power" and "volume" keys
106	 * as well as continuously to release CTRL,ALT,META,... keys */
107	case 0x0e0:
108	case 0x0e1:
109	case 0x0e2:
110	case 0x0e3:
111	case 0x0e4:
112	case 0x0e5:
113	case 0x0e6:
114	case 0x0e7:
115	default:
116		return -1;
117	}
118	return 1;
119}
120
121static const struct hid_device_id twinhan_devices[] = {
122	{ HID_USB_DEVICE(USB_VENDOR_ID_TWINHAN, USB_DEVICE_ID_TWINHAN_IR_REMOTE) },
123	{ }
124};
125MODULE_DEVICE_TABLE(hid, twinhan_devices);
126
127static struct hid_driver twinhan_driver = {
128	.name = "twinhan",
129	.id_table = twinhan_devices,
130	.input_mapping = twinhan_input_mapping,
131};
132module_hid_driver(twinhan_driver);
133
134MODULE_LICENSE("GPL");
135