drivers/hid/hid-samsung.c

0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /*
0003  *  HID driver for some samsung "special" devices
0004  *
0005  *  Copyright (c) 1999 Andreas Gal
0006  *  Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
0007  *  Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
0008  *  Copyright (c) 2006-2007 Jiri Kosina
0009  *  Copyright (c) 2008 Jiri Slaby
0010  *  Copyright (c) 2010 Don Prince <dhprince.devel@yahoo.co.uk>
0011  *
0012  *  This driver supports several HID devices:
0013  *
0014  *  [0419:0001] Samsung IrDA remote controller (reports as Cypress USB Mouse).
0015  *  various hid report fixups for different variants.
0016  *
0017  *  [0419:0600] Creative Desktop Wireless 6000 keyboard/mouse combo
0018  *  several key mappings used from the consumer usage page
0019  *  deviate from the USB HUT 1.12 standard.
0020  */
0021
0022 /*
0023  */
0024
0025 #include <linux/device.h>
0026 #include <linux/usb.h>
0027 #include <linux/hid.h>
0028 #include <linux/module.h>
0029
0030 #include "hid-ids.h"
0031
0032 /*
0033  * There are several variants for 0419:0001:
0034  *
0035  * 1. 184 byte report descriptor
0036  * Vendor specific report #4 has a size of 48 bit,
0037  * and therefore is not accepted when inspecting the descriptors.
0038  * As a workaround we reinterpret the report as:
0039  *   Variable type, count 6, size 8 bit, log. maximum 255
0040  * The burden to reconstruct the data is moved into user space.
0041  *
0042  * 2. 203 byte report descriptor
0043  * Report #4 has an array field with logical range 0..18 instead of 1..15.
0044  *
0045  * 3. 135 byte report descriptor
0046  * Report #4 has an array field with logical range 0..17 instead of 1..14.
0047  *
0048  * 4. 171 byte report descriptor
0049  * Report #3 has an array field with logical range 0..1 instead of 1..3.
0050  */
0051 static inline void samsung_irda_dev_trace(struct hid_device *hdev,
0052         unsigned int rsize)
0053 {
0054     hid_info(hdev, "fixing up Samsung IrDA %d byte report descriptor\n",
0055          rsize);
0056 }
0057
0058 static __u8 *samsung_irda_report_fixup(struct hid_device *hdev, __u8 *rdesc,
0059         unsigned int *rsize)
0060 {
0061     if (*rsize == 184 && rdesc[175] == 0x25 && rdesc[176] == 0x40 &&
0062             rdesc[177] == 0x75 && rdesc[178] == 0x30 &&
0063             rdesc[179] == 0x95 && rdesc[180] == 0x01 &&
0064             rdesc[182] == 0x40) {
0065         samsung_irda_dev_trace(hdev, 184);
0066         rdesc[176] = 0xff;
0067         rdesc[178] = 0x08;
0068         rdesc[180] = 0x06;
0069         rdesc[182] = 0x42;
0070     } else
0071     if (*rsize == 203 && rdesc[192] == 0x15 && rdesc[193] == 0x0 &&
0072             rdesc[194] == 0x25 && rdesc[195] == 0x12) {
0073         samsung_irda_dev_trace(hdev, 203);
0074         rdesc[193] = 0x1;
0075         rdesc[195] = 0xf;
0076     } else
0077     if (*rsize == 135 && rdesc[124] == 0x15 && rdesc[125] == 0x0 &&
0078             rdesc[126] == 0x25 && rdesc[127] == 0x11) {
0079         samsung_irda_dev_trace(hdev, 135);
0080         rdesc[125] = 0x1;
0081         rdesc[127] = 0xe;
0082     } else
0083     if (*rsize == 171 && rdesc[160] == 0x15 && rdesc[161] == 0x0 &&
0084             rdesc[162] == 0x25 && rdesc[163] == 0x01) {
0085         samsung_irda_dev_trace(hdev, 171);
0086         rdesc[161] = 0x1;
0087         rdesc[163] = 0x3;
0088     }
0089     return rdesc;
0090 }
0091
0092 #define samsung_kbd_mouse_map_key_clear(c) \
0093     hid_map_usage_clear(hi, usage, bit, max, EV_KEY, (c))
0094
0095 static int samsung_kbd_mouse_input_mapping(struct hid_device *hdev,
0096     struct hid_input *hi, struct hid_field *field, struct hid_usage *usage,
0097     unsigned long **bit, int *max)
0098 {
0099     struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
0100     unsigned short ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
0101
0102     if (1 != ifnum || HID_UP_CONSUMER != (usage->hid & HID_USAGE_PAGE))
0103         return 0;
0104
0105     dbg_hid("samsung wireless keyboard/mouse input mapping event [0x%x]\n",
0106         usage->hid & HID_USAGE);
0107
0108     switch (usage->hid & HID_USAGE) {
0109     /* report 2 */
0110     case 0x183: samsung_kbd_mouse_map_key_clear(KEY_MEDIA); break;
0111     case 0x195: samsung_kbd_mouse_map_key_clear(KEY_EMAIL); break;
0112     case 0x196: samsung_kbd_mouse_map_key_clear(KEY_CALC); break;
0113     case 0x197: samsung_kbd_mouse_map_key_clear(KEY_COMPUTER); break;
0114     case 0x22b: samsung_kbd_mouse_map_key_clear(KEY_SEARCH); break;
0115     case 0x22c: samsung_kbd_mouse_map_key_clear(KEY_WWW); break;
0116     case 0x22d: samsung_kbd_mouse_map_key_clear(KEY_BACK); break;
0117     case 0x22e: samsung_kbd_mouse_map_key_clear(KEY_FORWARD); break;
0118     case 0x22f: samsung_kbd_mouse_map_key_clear(KEY_FAVORITES); break;
0119     case 0x230: samsung_kbd_mouse_map_key_clear(KEY_REFRESH); break;
0120     case 0x231: samsung_kbd_mouse_map_key_clear(KEY_STOP); break;
0121     default:
0122         return 0;
0123     }
0124
0125     return 1;
0126 }
0127
0128 static __u8 *samsung_report_fixup(struct hid_device *hdev, __u8 *rdesc,
0129     unsigned int *rsize)
0130 {
0131     if (USB_DEVICE_ID_SAMSUNG_IR_REMOTE == hdev->product)
0132         rdesc = samsung_irda_report_fixup(hdev, rdesc, rsize);
0133     return rdesc;
0134 }
0135
0136 static int samsung_input_mapping(struct hid_device *hdev, struct hid_input *hi,
0137     struct hid_field *field, struct hid_usage *usage,
0138     unsigned long **bit, int *max)
0139 {
0140     int ret = 0;
0141
0142     if (USB_DEVICE_ID_SAMSUNG_WIRELESS_KBD_MOUSE == hdev->product)
0143         ret = samsung_kbd_mouse_input_mapping(hdev,
0144             hi, field, usage, bit, max);
0145
0146     return ret;
0147 }
0148
0149 static int samsung_probe(struct hid_device *hdev,
0150         const struct hid_device_id *id)
0151 {
0152     int ret;
0153     unsigned int cmask = HID_CONNECT_DEFAULT;
0154
0155     if (!hid_is_usb(hdev))
0156         return -EINVAL;
0157
0158     ret = hid_parse(hdev);
0159     if (ret) {
0160         hid_err(hdev, "parse failed\n");
0161         goto err_free;
0162     }
0163
0164     if (USB_DEVICE_ID_SAMSUNG_IR_REMOTE == hdev->product) {
0165         if (hdev->rsize == 184) {
0166             /* disable hidinput, force hiddev */
0167             cmask = (cmask & ~HID_CONNECT_HIDINPUT) |
0168                 HID_CONNECT_HIDDEV_FORCE;
0169         }
0170     }
0171
0172     ret = hid_hw_start(hdev, cmask);
0173     if (ret) {
0174         hid_err(hdev, "hw start failed\n");
0175         goto err_free;
0176     }
0177
0178     return 0;
0179 err_free:
0180     return ret;
0181 }
0182
0183 static const struct hid_device_id samsung_devices[] = {
0184     { HID_USB_DEVICE(USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE) },
0185     { HID_USB_DEVICE(USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_WIRELESS_KBD_MOUSE) },
0186     { }
0187 };
0188 MODULE_DEVICE_TABLE(hid, samsung_devices);
0189
0190 static struct hid_driver samsung_driver = {
0191     .name = "samsung",
0192     .id_table = samsung_devices,
0193     .report_fixup = samsung_report_fixup,
0194     .input_mapping = samsung_input_mapping,
0195     .probe = samsung_probe,
0196 };
0197 module_hid_driver(samsung_driver);
0198
0199 MODULE_LICENSE("GPL");