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                 /* Only for BR keyboard */
 153                 case 0x87: samsung_kbd_mouse_map_key_clear(KEY_RO); break;
 154                 default:
 155                         return 0;
 156                 }
 157         }
 158
 159         if (HID_UP_CONSUMER == (usage->hid & HID_USAGE_PAGE)) {
 160                 switch (usage->hid & HID_USAGE) {
 161                 /* report 2 */
 162                 /* MENU */
 163                 case 0x040: samsung_kbd_mouse_map_key_clear(KEY_PHONE); break;
 164                 case 0x18a: samsung_kbd_mouse_map_key_clear(KEY_MAIL); break;
 165                 case 0x196: samsung_kbd_mouse_map_key_clear(KEY_WWW); break;
 166                 case 0x19e: samsung_kbd_mouse_map_key_clear(KEY_SCREENLOCK); break;
 167                 case 0x221: samsung_kbd_mouse_map_key_clear(KEY_SEARCH); break;
 168                 case 0x223: samsung_kbd_mouse_map_key_clear(KEY_MENU); break;
 169                 /* RECENTAPPS */
 170                 case 0x301: samsung_kbd_mouse_map_key_clear(KEY_F14); break;
 171                 /* APPLICATION */
 172                 case 0x302: samsung_kbd_mouse_map_key_clear(KEY_DASHBOARD); break;
 173                 /* Voice search */
 174                 case 0x305: samsung_kbd_mouse_map_key_clear(KEY_PROG2); break;
 175                 /* QPANEL on/off */
 176                 case 0x306: samsung_kbd_mouse_map_key_clear(KEY_F13); break;
 177                 /* SIP on/off */
 178                 case 0x307: samsung_kbd_mouse_map_key_clear(KEY_PROG1); break;
 179                 /* LANG */
 180                 case 0x308: samsung_kbd_mouse_map_key_clear(KEY_HANGEUL); break;
 181                 case 0x30a: samsung_kbd_mouse_map_key_clear(KEY_BRIGHTNESSDOWN); break;
 182                 case 0x30b: samsung_kbd_mouse_map_key_clear(KEY_BRIGHTNESSUP); break;
 183                 default:
 184                         return 0;
 185                 }
 186         }
 187
 188         return 1;
 189 }
 190
 191 static int samsung_gamepad_input_mapping(struct hid_device *hdev,
 192         struct hid_input *hi, struct hid_field *field, struct hid_usage *usage,
 193         unsigned long **bit, int *max)
 194 {
 195         if (!(HID_UP_BUTTON == (usage->hid & HID_USAGE_PAGE) ||
 196                HID_UP_CONSUMER == (usage->hid & HID_USAGE_PAGE)))
 197                 return 0;
 198
 199         dbg_hid("samsung wireless gamepad input mapping event [0x%x], %ld, %ld, [0x%x]\n",
 200                 usage->hid & HID_USAGE, hi->input->evbit[0], hi->input->absbit[0], usage->hid & HID_USAGE_PAGE);
 201
 202         if (HID_UP_BUTTON == (usage->hid & HID_USAGE_PAGE)) {
 203                 switch(usage->hid & HID_USAGE) {
 204                 case 0x01: samsung_kbd_mouse_map_key_clear(BTN_A); break;
 205                 case 0x02: samsung_kbd_mouse_map_key_clear(BTN_B); break;
 206                 case 0x03: samsung_kbd_mouse_map_key_clear(BTN_C); break;
 207                 case 0x04: samsung_kbd_mouse_map_key_clear(BTN_X); break;
 208                 case 0x05: samsung_kbd_mouse_map_key_clear(BTN_Y); break;
 209                 case 0x06: samsung_kbd_mouse_map_key_clear(BTN_Z); break;
 210                 case 0x07: samsung_kbd_mouse_map_key_clear(BTN_TL); break;
 211                 case 0x08: samsung_kbd_mouse_map_key_clear(BTN_TR); break;
 212                 case 0x09: samsung_kbd_mouse_map_key_clear(BTN_TL2); break;
 213                 case 0x0a: samsung_kbd_mouse_map_key_clear(BTN_TR2); break;
 214                 case 0x0b: samsung_kbd_mouse_map_key_clear(BTN_SELECT); break;
 215                 case 0x0c: samsung_kbd_mouse_map_key_clear(BTN_START); break;
 216                 case 0x0d: samsung_kbd_mouse_map_key_clear(BTN_MODE); break;
 217                 case 0x0e: samsung_kbd_mouse_map_key_clear(BTN_THUMBL); break;
 218                 case 0x0f: samsung_kbd_mouse_map_key_clear(BTN_THUMBR); break;
 219                 case 0x10: samsung_kbd_mouse_map_key_clear(BTN_GAME); break; /* Android code -> BTN_GAME but it is not exist in latest kernel */
 220                 default:
 221                         return 0;
 222                 }
 223         }
 224
 225         if (HID_UP_CONSUMER == (usage->hid & HID_USAGE_PAGE)) {
 226                 switch (usage->hid & HID_USAGE) {
 227                 case 0x040: samsung_kbd_mouse_map_key_clear(KEY_MENU); break;
 228                 case 0x223: samsung_kbd_mouse_map_key_clear(KEY_HOMEPAGE); break;
 229                 case 0x224: samsung_kbd_mouse_map_key_clear(KEY_BACK); break;
 230
 231                 /* Screen Capture */
 232                 case 0x303: samsung_kbd_mouse_map_key_clear(KEY_SYSRQ); break;
 233
 234                 default:
 235                         return 0;
 236                 }
 237         }
 238
 239         return 1;
 240 }
 241
 242 static int samsung_actionmouse_input_mapping(struct hid_device *hdev,
 243         struct hid_input *hi, struct hid_field *field, struct hid_usage *usage,
 244         unsigned long **bit, int *max)
 245 {
 246
 247         dbg_hid("samsung wireless actionmouse input mapping event [0x%x], [0x%x], %ld, %ld, [0x%x]\n",
 248                         usage->hid, usage->hid & HID_USAGE, hi->input->evbit[0], hi->input->absbit[0], usage->hid & HID_USAGE_PAGE);
 249
 250         if(((usage->hid & HID_USAGE_PAGE) != HID_UP_CONSUMER) && ((usage->hid & HID_USAGE_PAGE) != HID_UP_BUTTON))
 251                 return 0;
 252
 253         switch (usage->hid & HID_USAGE) {
 254                 case 0x301: samsung_kbd_mouse_map_key_clear(KEY_RECENT); break;
 255                 default:
 256                         return 0;
 257         }
 258
 259         return 1;
 260 }
 261
 262 static int samsung_universal_kbd_input_mapping(struct hid_device *hdev,
 263         struct hid_input *hi, struct hid_field *field, struct hid_usage *usage,
 264         unsigned long **bit, int *max)
 265 {
 266         if (!(HID_UP_CONSUMER == (usage->hid & HID_USAGE_PAGE) ||
 267                         HID_UP_KEYBOARD == (usage->hid & HID_USAGE_PAGE)))
 268                 return 0;
 269
 270         dbg_hid("samsung wireless keyboard input mapping event [0x%x]\n",
 271                 usage->hid & HID_USAGE);
 272
 273         if (HID_UP_KEYBOARD == (usage->hid & HID_USAGE_PAGE)) {
 274                 switch (usage->hid & HID_USAGE) {
 275                 set_bit(EV_REP, hi->input->evbit);
 276                 /* Only for UK keyboard */
 277                 /* key found */
 278 #ifdef CONFIG_HID_KK_UPGRADE
 279                 case 0x32: samsung_kbd_mouse_map_key_clear(KEY_KBDILLUMTOGGLE); break;
 280                 case 0x64: samsung_kbd_mouse_map_key_clear(KEY_BACKSLASH); break;
 281 #else
 282                 case 0x32: samsung_kbd_mouse_map_key_clear(KEY_BACKSLASH); break;
 283                 case 0x64: samsung_kbd_mouse_map_key_clear(KEY_102ND); break;
 284 #endif
 285                 /* Only for BR keyboard */
 286                 case 0x87: samsung_kbd_mouse_map_key_clear(KEY_RO); break;
 287                 default:
 288                         return 0;
 289                 }
 290         }
 291
 292         if (HID_UP_CONSUMER == (usage->hid & HID_USAGE_PAGE)) {
 293                 switch (usage->hid & HID_USAGE) {
 294                 /* report 2 */
 295                 /* MENU */
 296                 case 0x040: samsung_kbd_mouse_map_key_clear(KEY_MENU); break;
 297                 case 0x18a: samsung_kbd_mouse_map_key_clear(KEY_MAIL); break;
 298                 case 0x196: samsung_kbd_mouse_map_key_clear(KEY_WWW); break;
 299                 case 0x19e: samsung_kbd_mouse_map_key_clear(KEY_SCREENLOCK); break;
 300                 case 0x221: samsung_kbd_mouse_map_key_clear(KEY_SEARCH); break;
 301                 case 0x223: samsung_kbd_mouse_map_key_clear(KEY_HOMEPAGE); break;
 302                 /* RECENTAPPS */
 303                 case 0x301: samsung_kbd_mouse_map_key_clear(BTN_TRIGGER_HAPPY1); break;
 304                 /* APPLICATION */
 305                 case 0x302: samsung_kbd_mouse_map_key_clear(BTN_TRIGGER_HAPPY2); break;
 306                 /* Voice search */
 307                 case 0x305: samsung_kbd_mouse_map_key_clear(BTN_TRIGGER_HAPPY4); break;
 308                 /* QPANEL on/off */
 309                 case 0x306: samsung_kbd_mouse_map_key_clear(BTN_TRIGGER_HAPPY5); break;
 310                 /* SIP on/off */
 311                 case 0x307: samsung_kbd_mouse_map_key_clear(BTN_TRIGGER_HAPPY3); break;
 312                 /* LANG */
 313                 case 0x308: samsung_kbd_mouse_map_key_clear(KEY_LANGUAGE); break;
 314                 case 0x30a: samsung_kbd_mouse_map_key_clear(KEY_BRIGHTNESSDOWN); break;
 315                 case 0x070: samsung_kbd_mouse_map_key_clear(KEY_BRIGHTNESSDOWN); break;
 316                 case 0x30b: samsung_kbd_mouse_map_key_clear(KEY_BRIGHTNESSUP); break;
 317                 case 0x06f: samsung_kbd_mouse_map_key_clear(KEY_BRIGHTNESSUP); break;
 318                 /* S-Finder */
 319                 case 0x304: samsung_kbd_mouse_map_key_clear(BTN_TRIGGER_HAPPY7); break;
 320                 /* Screen Capture */
 321                 case 0x303: samsung_kbd_mouse_map_key_clear(KEY_SYSRQ); break;
 322                 /* Multi Window */
 323                 case 0x309: samsung_kbd_mouse_map_key_clear(BTN_TRIGGER_HAPPY9); break;
 324                 default:
 325                         return 0;
 326                 }
 327         }
 328
 329         return 1;
 330 }
 331
 332 static __u8 *samsung_report_fixup(struct hid_device *hdev, __u8 *rdesc,
 333         unsigned int *rsize)
 334 {
 335         if (USB_DEVICE_ID_SAMSUNG_IR_REMOTE == hdev->product)
 336                 rdesc = samsung_irda_report_fixup(hdev, rdesc, rsize);
 337         return rdesc;
 338 }
 339
 340 static int samsung_input_mapping(struct hid_device *hdev, struct hid_input *hi,
 341         struct hid_field *field, struct hid_usage *usage,
 342         unsigned long **bit, int *max)
 343 {
 344         int ret = 0;
 345
 346         if (USB_DEVICE_ID_SAMSUNG_WIRELESS_KBD_MOUSE == hdev->product)
 347                 ret = samsung_kbd_mouse_input_mapping(hdev,
 348                         hi, field, usage, bit, max);
 349         else if (USB_DEVICE_ID_SAMSUNG_WIRELESS_KBD == hdev->product)
 350                 ret = samsung_kbd_input_mapping(hdev,
 351                         hi, field, usage, bit, max);
 352         else if(USB_DEVICE_ID_SAMSUNG_WIRELESS_GAMEPAD == hdev->product)
 353                 ret = samsung_gamepad_input_mapping(hdev,
 354                         hi, field, usage, bit, max);
 355         else if(USB_DEVICE_ID_SAMSUNG_WIRELESS_ACTIONMOUSE == hdev->product)
 356                 ret = samsung_actionmouse_input_mapping(hdev,
 357                         hi, field, usage, bit, max);
 358         else if(USB_DEVICE_ID_SAMSUNG_WIRELESS_UNIVERSAL_KBD == hdev->product)
 359                 ret = samsung_universal_kbd_input_mapping(hdev,
 360                         hi, field, usage, bit, max);
 361
 362         return ret;
 363 }
 364
 365 static int samsung_probe(struct hid_device *hdev,
 366                 const struct hid_device_id *id)
 367 {
 368         int ret;
 369         unsigned int cmask = HID_CONNECT_DEFAULT;
 370
 371         ret = hid_parse(hdev);
 372         if (ret) {
 373                 hid_err(hdev, "parse failed\n");
 374                 goto err_free;
 375         }
 376
 377         if (USB_DEVICE_ID_SAMSUNG_IR_REMOTE == hdev->product) {
 378                 if (hdev->rsize == 184) {
 379                         /* disable hidinput, force hiddev */
 380                         cmask = (cmask & ~HID_CONNECT_HIDINPUT) |
 381                                 HID_CONNECT_HIDDEV_FORCE;
 382                 }
 383         }
 384
 385         ret = hid_hw_start(hdev, cmask);
 386         if (ret) {
 387                 hid_err(hdev, "hw start failed\n");
 388                 goto err_free;
 389         }
 390
 391         return 0;
 392 err_free:
 393         return ret;
 394 }
 395
 396 static const struct hid_device_id samsung_devices[] = {
 397         { HID_USB_DEVICE(USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE) },
 398         { HID_USB_DEVICE(USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_WIRELESS_KBD_MOUSE) },
 399         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_SAMSUNG_ELECTRONICS, USB_DEVICE_ID_SAMSUNG_WIRELESS_KBD) },
 400         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_SAMSUNG_ELECTRONICS, USB_DEVICE_ID_SAMSUNG_WIRELESS_GAMEPAD) },
 401         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_SAMSUNG_ELECTRONICS, USB_DEVICE_ID_SAMSUNG_WIRELESS_ACTIONMOUSE) },
 402         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_SAMSUNG_ELECTRONICS, USB_DEVICE_ID_SAMSUNG_WIRELESS_UNIVERSAL_KBD) },
 403         { }
 404 };
 405 MODULE_DEVICE_TABLE(hid, samsung_devices);
 406
 407 static struct hid_driver samsung_driver = {
 408         .name = "samsung",
 409         .id_table = samsung_devices,
 410         .report_fixup = samsung_report_fixup,
 411         .input_mapping = samsung_input_mapping,
 412         .probe = samsung_probe,
 413 };
 414
 415 static int __init samsung_init(void)
 416 {
 417         return hid_register_driver(&samsung_driver);
 418 }
 419
 420 static void __exit samsung_exit(void)
 421 {
 422         hid_unregister_driver(&samsung_driver);
 423 }
 424
 425 module_init(samsung_init);
 426 module_exit(samsung_exit);
 427 MODULE_LICENSE("GPL");