drivers/hid/hid-samsung.c

   1 /*
   2  *  HID driver for some samsung "special" devices
   3  *
   4  *  Copyright (c) 1999 Andreas Gal
   5  *  Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
   6  *  Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
   7  *  Copyright (c) 2006-2007 Jiri Kosina
   8  *  Copyright (c) 2007 Paul Walmsley
   9  *  Copyright (c) 2008 Jiri Slaby
  10  *  Copyright (c) 2010 Don Prince <dhprince.devel@yahoo.co.uk>
  11  *
  12  *
  13  *  This driver supports several HID devices:
  14  *
  15  *  [0419:0001] Samsung IrDA remote controller (reports as Cypress USB Mouse).
  16  *      various hid report fixups for different variants.
  17  *
  18  *  [0419:0600] Creative Desktop Wireless 6000 keyboard/mouse combo
  19  *      several key mappings used from the consumer usage page
  20  *      deviate from the USB HUT 1.12 standard.
  21  *
  22  */
  23
  24 /*
  25  * This program is free software; you can redistribute it and/or modify it
  26  * under the terms of the GNU General Public License as published by the Free
  27  * Software Foundation; either version 2 of the License, or (at your option)
  28  * any later version.
  29  */
  30
  31 #include <linux/device.h>
  32 #include <linux/usb.h>
  33 #include <linux/hid.h>
  34 #include <linux/module.h>
  35
  36 #include "hid-ids.h"
  37
  38 /*
  39  * There are several variants for 0419:0001:
  40  *
  41  * 1. 184 byte report descriptor
  42  * Vendor specific report #4 has a size of 48 bit,
  43  * and therefore is not accepted when inspecting the descriptors.
  44  * As a workaround we reinterpret the report as:
  45  *   Variable type, count 6, size 8 bit, log. maximum 255
  46  * The burden to reconstruct the data is moved into user space.
  47  *
  48  * 2. 203 byte report descriptor
  49  * Report #4 has an array field with logical range 0..18 instead of 1..15.
  50  *
  51  * 3. 135 byte report descriptor
  52  * Report #4 has an array field with logical range 0..17 instead of 1..14.
  53  *
  54  * 4. 171 byte report descriptor
  55  * Report #3 has an array field with logical range 0..1 instead of 1..3.
  56  */
  57 static inline void samsung_irda_dev_trace(struct hid_device *hdev,
  58                 unsigned int rsize)
  59 {
  60         hid_info(hdev, "fixing up Samsung IrDA %d byte report descriptor\n",
  61                  rsize);
  62 }
  63
  64 static __u8 *samsung_irda_report_fixup(struct hid_device *hdev, __u8 *rdesc,
  65                 unsigned int *rsize)
  66 {
  67         if (*rsize == 184 && rdesc[175] == 0x25 && rdesc[176] == 0x40 &&
  68                         rdesc[177] == 0x75 && rdesc[178] == 0x30 &&
  69                         rdesc[179] == 0x95 && rdesc[180] == 0x01 &&
  70                         rdesc[182] == 0x40) {
  71                 samsung_irda_dev_trace(hdev, 184);
  72                 rdesc[176] = 0xff;
  73                 rdesc[178] = 0x08;
  74                 rdesc[180] = 0x06;
  75                 rdesc[182] = 0x42;
  76         } else
  77         if (*rsize == 203 && rdesc[192] == 0x15 && rdesc[193] == 0x0 &&
  78                         rdesc[194] == 0x25 && rdesc[195] == 0x12) {
  79                 samsung_irda_dev_trace(hdev, 203);
  80                 rdesc[193] = 0x1;
  81                 rdesc[195] = 0xf;
  82         } else
  83         if (*rsize == 135 && rdesc[124] == 0x15 && rdesc[125] == 0x0 &&
  84                         rdesc[126] == 0x25 && rdesc[127] == 0x11) {
  85                 samsung_irda_dev_trace(hdev, 135);
  86                 rdesc[125] = 0x1;
  87                 rdesc[127] = 0xe;
  88         } else
  89         if (*rsize == 171 && rdesc[160] == 0x15 && rdesc[161] == 0x0 &&
  90                         rdesc[162] == 0x25 && rdesc[163] == 0x01) {
  91                 samsung_irda_dev_trace(hdev, 171);
  92                 rdesc[161] = 0x1;
  93                 rdesc[163] = 0x3;
  94         }
  95         return rdesc;
  96 }
  97
  98 #define samsung_kbd_mouse_map_key_clear(c) \
  99         hid_map_usage_clear(hi, usage, bit, max, EV_KEY, (c))
 100
 101 static int samsung_kbd_mouse_input_mapping(struct hid_device *hdev,
 102         struct hid_input *hi, struct hid_field *field, struct hid_usage *usage,
 103         unsigned long **bit, int *max)
 104 {
 105         struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
 106         unsigned short ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
 107
 108         if (1 != ifnum || HID_UP_CONSUMER != (usage->hid & HID_USAGE_PAGE))
 109                 return 0;
 110
 111         dbg_hid("samsung wireless keyboard/mouse input mapping event [0x%x]\n",
 112                 usage->hid & HID_USAGE);
 113
 114         switch (usage->hid & HID_USAGE) {
 115         /* report 2 */
 116         case 0x183: samsung_kbd_mouse_map_key_clear(KEY_MEDIA); break;
 117         case 0x195: samsung_kbd_mouse_map_key_clear(KEY_EMAIL); break;
 118         case 0x196: samsung_kbd_mouse_map_key_clear(KEY_CALC); break;
 119         case 0x197: samsung_kbd_mouse_map_key_clear(KEY_COMPUTER); break;
 120         case 0x22b: samsung_kbd_mouse_map_key_clear(KEY_SEARCH); break;
 121         case 0x22c: samsung_kbd_mouse_map_key_clear(KEY_WWW); break;
 122         case 0x22d: samsung_kbd_mouse_map_key_clear(KEY_BACK); break;
 123         case 0x22e: samsung_kbd_mouse_map_key_clear(KEY_FORWARD); break;
 124         case 0x22f: samsung_kbd_mouse_map_key_clear(KEY_FAVORITES); break;
 125         case 0x230: samsung_kbd_mouse_map_key_clear(KEY_REFRESH); break;
 126         case 0x231: samsung_kbd_mouse_map_key_clear(KEY_STOP); break;
 127         default:
 128                 return 0;
 129         }
 130
 131         return 1;
 132 }
 133
 134 static int samsung_kbd_input_mapping(struct hid_device *hdev,
 135         struct hid_input *hi, struct hid_field *field, struct hid_usage *usage,
 136         unsigned long **bit, int *max)
 137 {
 138         if (!(HID_UP_CONSUMER == (usage->hid & HID_USAGE_PAGE) ||
 139                         HID_UP_KEYBOARD == (usage->hid & HID_USAGE_PAGE)))
 140                 return 0;
 141
 142         dbg_hid("samsung wireless keyboard input mapping event [0x%x]\n",
 143                 usage->hid & HID_USAGE);
 144
 145         if (HID_UP_KEYBOARD == (usage->hid & HID_USAGE_PAGE)) {
 146                 switch (usage->hid & HID_USAGE) {
 147                 set_bit(EV_REP, hi->input->evbit);
 148                 /* Only for UK keyboard */
 149                 /* key found */
 150                 case 0x32: samsung_kbd_mouse_map_key_clear(KEY_BACKSLASH); break;
 151                 case 0x29: samsung_kbd_mouse_map_key_clear(KEY_BACK); break;
 152                 default:
 153                         return 0;
 154                 }
 155         }
 156
 157         if (HID_UP_CONSUMER == (usage->hid & HID_USAGE_PAGE)) {
 158                 switch (usage->hid & HID_USAGE) {
 159                 /* report 2 */
 160                 /* MENU */
 161                 case 0x040: samsung_kbd_mouse_map_key_clear(KEY_PHONE); break;
 162                 case 0x18a: samsung_kbd_mouse_map_key_clear(KEY_MAIL); break;
 163                 case 0x196: samsung_kbd_mouse_map_key_clear(KEY_WWW); break;
 164                 case 0x19e: samsung_kbd_mouse_map_key_clear(KEY_SCREENLOCK); break;
 165                 case 0x221: samsung_kbd_mouse_map_key_clear(KEY_SEARCH); break;
 166                 case 0x223: samsung_kbd_mouse_map_key_clear(KEY_MENU); break;
 167                 /* RECENTAPPS */
 168                 case 0x301: samsung_kbd_mouse_map_key_clear(KEY_F14); break;
 169                 /* APPLICATION */
 170                 case 0x302: samsung_kbd_mouse_map_key_clear(KEY_DASHBOARD); break;
 171                 /* Voice search */
 172                 case 0x305: samsung_kbd_mouse_map_key_clear(KEY_PROG2); break;
 173                 /* QPANEL on/off */
 174                 case 0x306: samsung_kbd_mouse_map_key_clear(KEY_F13); break;
 175                 /* SIP on/off */
 176                 case 0x307: samsung_kbd_mouse_map_key_clear(KEY_PROG1); break;
 177                 /* LANG */
 178                 case 0x308: samsung_kbd_mouse_map_key_clear(KEY_HANGEUL); break;
 179                 case 0x30a: samsung_kbd_mouse_map_key_clear(KEY_BRIGHTNESSDOWN); break;
 180                 case 0x30b: samsung_kbd_mouse_map_key_clear(KEY_BRIGHTNESSUP); break;
 181                 default:
 182                         return 0;
 183                 }
 184         }
 185
 186         return 1;
 187 }
 188
 189 static __u8 *samsung_report_fixup(struct hid_device *hdev, __u8 *rdesc,
 190         unsigned int *rsize)
 191 {
 192         if (USB_DEVICE_ID_SAMSUNG_IR_REMOTE == hdev->product)
 193                 rdesc = samsung_irda_report_fixup(hdev, rdesc, rsize);
 194         return rdesc;
 195 }
 196
 197 static int samsung_input_mapping(struct hid_device *hdev, struct hid_input *hi,
 198         struct hid_field *field, struct hid_usage *usage,
 199         unsigned long **bit, int *max)
 200 {
 201         int ret = 0;
 202
 203         if (USB_DEVICE_ID_SAMSUNG_WIRELESS_KBD_MOUSE == hdev->product)
 204                 ret = samsung_kbd_mouse_input_mapping(hdev,
 205                         hi, field, usage, bit, max);
 206         else if (USB_DEVICE_ID_SAMSUNG_WIRELESS_KBD == hdev->product)
 207                 ret = samsung_kbd_input_mapping(hdev,
 208                         hi, field, usage, bit, max);
 209
 210         return ret;
 211 }
 212
 213 static int samsung_probe(struct hid_device *hdev,
 214                 const struct hid_device_id *id)
 215 {
 216         int ret;
 217         unsigned int cmask = HID_CONNECT_DEFAULT;
 218
 219         ret = hid_parse(hdev);
 220         if (ret) {
 221                 hid_err(hdev, "parse failed\n");
 222                 goto err_free;
 223         }
 224
 225         if (USB_DEVICE_ID_SAMSUNG_IR_REMOTE == hdev->product) {
 226                 if (hdev->rsize == 184) {
 227                         /* disable hidinput, force hiddev */
 228                         cmask = (cmask & ~HID_CONNECT_HIDINPUT) |
 229                                 HID_CONNECT_HIDDEV_FORCE;
 230                 }
 231         }
 232
 233         ret = hid_hw_start(hdev, cmask);
 234         if (ret) {
 235                 hid_err(hdev, "hw start failed\n");
 236                 goto err_free;
 237         }
 238
 239         return 0;
 240 err_free:
 241         return ret;
 242 }
 243
 244 static const struct hid_device_id samsung_devices[] = {
 245         { HID_USB_DEVICE(USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE) },
 246         { HID_USB_DEVICE(USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_WIRELESS_KBD_MOUSE) },
 247         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_SAMSUNG_ELECTRONICS, USB_DEVICE_ID_SAMSUNG_WIRELESS_KBD) },
 248         { }
 249 };
 250 MODULE_DEVICE_TABLE(hid, samsung_devices);
 251
 252 static struct hid_driver samsung_driver = {
 253         .name = "samsung",
 254         .id_table = samsung_devices,
 255         .report_fixup = samsung_report_fixup,
 256         .input_mapping = samsung_input_mapping,
 257         .probe = samsung_probe,
 258 };
 259
 260 static int __init samsung_init(void)
 261 {
 262         return hid_register_driver(&samsung_driver);
 263 }
 264
 265 static void __exit samsung_exit(void)
 266 {
 267         hid_unregister_driver(&samsung_driver);
 268 }
 269
 270 module_init(samsung_init);
 271 module_exit(samsung_exit);
 272 MODULE_LICENSE("GPL");