Back to home page

OSCL-LXR
 
 

     

0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /*
0003  *  HID driver for some microsoft "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  */
0011 
0012 /*
0013  */
0014 
0015 #include <linux/device.h>
0016 #include <linux/input.h>
0017 #include <linux/hid.h>
0018 #include <linux/module.h>
0019 
0020 #include "hid-ids.h"
0021 
0022 #define MS_HIDINPUT     BIT(0)
0023 #define MS_ERGONOMY     BIT(1)
0024 #define MS_PRESENTER        BIT(2)
0025 #define MS_RDESC        BIT(3)
0026 #define MS_NOGET        BIT(4)
0027 #define MS_DUPLICATE_USAGES BIT(5)
0028 #define MS_SURFACE_DIAL     BIT(6)
0029 #define MS_QUIRK_FF     BIT(7)
0030 
0031 struct ms_data {
0032     unsigned long quirks;
0033     struct hid_device *hdev;
0034     struct work_struct ff_worker;
0035     __u8 strong;
0036     __u8 weak;
0037     void *output_report_dmabuf;
0038 };
0039 
0040 #define XB1S_FF_REPORT      3
0041 #define ENABLE_WEAK     BIT(0)
0042 #define ENABLE_STRONG       BIT(1)
0043 
0044 enum {
0045     MAGNITUDE_STRONG = 2,
0046     MAGNITUDE_WEAK,
0047     MAGNITUDE_NUM
0048 };
0049 
0050 struct xb1s_ff_report {
0051     __u8    report_id;
0052     __u8    enable;
0053     __u8    magnitude[MAGNITUDE_NUM];
0054     __u8    duration_10ms;
0055     __u8    start_delay_10ms;
0056     __u8    loop_count;
0057 } __packed;
0058 
0059 static __u8 *ms_report_fixup(struct hid_device *hdev, __u8 *rdesc,
0060         unsigned int *rsize)
0061 {
0062     struct ms_data *ms = hid_get_drvdata(hdev);
0063     unsigned long quirks = ms->quirks;
0064 
0065     /*
0066      * Microsoft Wireless Desktop Receiver (Model 1028) has
0067      * 'Usage Min/Max' where it ought to have 'Physical Min/Max'
0068      */
0069     if ((quirks & MS_RDESC) && *rsize == 571 && rdesc[557] == 0x19 &&
0070             rdesc[559] == 0x29) {
0071         hid_info(hdev, "fixing up Microsoft Wireless Receiver Model 1028 report descriptor\n");
0072         rdesc[557] = 0x35;
0073         rdesc[559] = 0x45;
0074     }
0075     return rdesc;
0076 }
0077 
0078 #define ms_map_key_clear(c) hid_map_usage_clear(hi, usage, bit, max, \
0079                     EV_KEY, (c))
0080 static int ms_ergonomy_kb_quirk(struct hid_input *hi, struct hid_usage *usage,
0081         unsigned long **bit, int *max)
0082 {
0083     struct input_dev *input = hi->input;
0084 
0085     if ((usage->hid & HID_USAGE_PAGE) == HID_UP_CONSUMER) {
0086         switch (usage->hid & HID_USAGE) {
0087         /*
0088          * Microsoft uses these 2 reserved usage ids for 2 keys on
0089          * the MS office kb labelled "Office Home" and "Task Pane".
0090          */
0091         case 0x29d:
0092             ms_map_key_clear(KEY_PROG1);
0093             return 1;
0094         case 0x29e:
0095             ms_map_key_clear(KEY_PROG2);
0096             return 1;
0097         }
0098         return 0;
0099     }
0100 
0101     if ((usage->hid & HID_USAGE_PAGE) != HID_UP_MSVENDOR)
0102         return 0;
0103 
0104     switch (usage->hid & HID_USAGE) {
0105     case 0xfd06: ms_map_key_clear(KEY_CHAT);    break;
0106     case 0xfd07: ms_map_key_clear(KEY_PHONE);   break;
0107     case 0xff00:
0108         /* Special keypad keys */
0109         ms_map_key_clear(KEY_KPEQUAL);
0110         set_bit(KEY_KPLEFTPAREN, input->keybit);
0111         set_bit(KEY_KPRIGHTPAREN, input->keybit);
0112         break;
0113     case 0xff01:
0114         /* Scroll wheel */
0115         hid_map_usage_clear(hi, usage, bit, max, EV_REL, REL_WHEEL);
0116         break;
0117     case 0xff02:
0118         /*
0119          * This byte contains a copy of the modifier keys byte of a
0120          * standard hid keyboard report, as send by interface 0
0121          * (this usage is found on interface 1).
0122          *
0123          * This byte only gets send when another key in the same report
0124          * changes state, and as such is useless, ignore it.
0125          */
0126         return -1;
0127     case 0xff05:
0128         set_bit(EV_REP, input->evbit);
0129         ms_map_key_clear(KEY_F13);
0130         set_bit(KEY_F14, input->keybit);
0131         set_bit(KEY_F15, input->keybit);
0132         set_bit(KEY_F16, input->keybit);
0133         set_bit(KEY_F17, input->keybit);
0134         set_bit(KEY_F18, input->keybit);
0135         break;
0136     default:
0137         return 0;
0138     }
0139     return 1;
0140 }
0141 
0142 static int ms_presenter_8k_quirk(struct hid_input *hi, struct hid_usage *usage,
0143         unsigned long **bit, int *max)
0144 {
0145     if ((usage->hid & HID_USAGE_PAGE) != HID_UP_MSVENDOR)
0146         return 0;
0147 
0148     set_bit(EV_REP, hi->input->evbit);
0149     switch (usage->hid & HID_USAGE) {
0150     case 0xfd08: ms_map_key_clear(KEY_FORWARD); break;
0151     case 0xfd09: ms_map_key_clear(KEY_BACK);    break;
0152     case 0xfd0b: ms_map_key_clear(KEY_PLAYPAUSE);   break;
0153     case 0xfd0e: ms_map_key_clear(KEY_CLOSE);   break;
0154     case 0xfd0f: ms_map_key_clear(KEY_PLAY);    break;
0155     default:
0156         return 0;
0157     }
0158     return 1;
0159 }
0160 
0161 static int ms_surface_dial_quirk(struct hid_input *hi, struct hid_field *field,
0162         struct hid_usage *usage, unsigned long **bit, int *max)
0163 {
0164     switch (usage->hid & HID_USAGE_PAGE) {
0165     case 0xff070000:
0166     case HID_UP_DIGITIZER:
0167         /* ignore those axis */
0168         return -1;
0169     case HID_UP_GENDESK:
0170         switch (usage->hid) {
0171         case HID_GD_X:
0172         case HID_GD_Y:
0173         case HID_GD_RFKILL_BTN:
0174             /* ignore those axis */
0175             return -1;
0176         }
0177     }
0178 
0179     return 0;
0180 }
0181 
0182 static int ms_input_mapping(struct hid_device *hdev, struct hid_input *hi,
0183         struct hid_field *field, struct hid_usage *usage,
0184         unsigned long **bit, int *max)
0185 {
0186     struct ms_data *ms = hid_get_drvdata(hdev);
0187     unsigned long quirks = ms->quirks;
0188 
0189     if (quirks & MS_ERGONOMY) {
0190         int ret = ms_ergonomy_kb_quirk(hi, usage, bit, max);
0191         if (ret)
0192             return ret;
0193     }
0194 
0195     if ((quirks & MS_PRESENTER) &&
0196             ms_presenter_8k_quirk(hi, usage, bit, max))
0197         return 1;
0198 
0199     if (quirks & MS_SURFACE_DIAL) {
0200         int ret = ms_surface_dial_quirk(hi, field, usage, bit, max);
0201 
0202         if (ret)
0203             return ret;
0204     }
0205 
0206     return 0;
0207 }
0208 
0209 static int ms_input_mapped(struct hid_device *hdev, struct hid_input *hi,
0210         struct hid_field *field, struct hid_usage *usage,
0211         unsigned long **bit, int *max)
0212 {
0213     struct ms_data *ms = hid_get_drvdata(hdev);
0214     unsigned long quirks = ms->quirks;
0215 
0216     if (quirks & MS_DUPLICATE_USAGES)
0217         clear_bit(usage->code, *bit);
0218 
0219     return 0;
0220 }
0221 
0222 static int ms_event(struct hid_device *hdev, struct hid_field *field,
0223         struct hid_usage *usage, __s32 value)
0224 {
0225     struct ms_data *ms = hid_get_drvdata(hdev);
0226     unsigned long quirks = ms->quirks;
0227     struct input_dev *input;
0228 
0229     if (!(hdev->claimed & HID_CLAIMED_INPUT) || !field->hidinput ||
0230             !usage->type)
0231         return 0;
0232 
0233     input = field->hidinput->input;
0234 
0235     /* Handling MS keyboards special buttons */
0236     if (quirks & MS_ERGONOMY && usage->hid == (HID_UP_MSVENDOR | 0xff00)) {
0237         /* Special keypad keys */
0238         input_report_key(input, KEY_KPEQUAL, value & 0x01);
0239         input_report_key(input, KEY_KPLEFTPAREN, value & 0x02);
0240         input_report_key(input, KEY_KPRIGHTPAREN, value & 0x04);
0241         return 1;
0242     }
0243 
0244     if (quirks & MS_ERGONOMY && usage->hid == (HID_UP_MSVENDOR | 0xff01)) {
0245         /* Scroll wheel */
0246         int step = ((value & 0x60) >> 5) + 1;
0247 
0248         switch (value & 0x1f) {
0249         case 0x01:
0250             input_report_rel(input, REL_WHEEL, step);
0251             break;
0252         case 0x1f:
0253             input_report_rel(input, REL_WHEEL, -step);
0254             break;
0255         }
0256         return 1;
0257     }
0258 
0259     if (quirks & MS_ERGONOMY && usage->hid == (HID_UP_MSVENDOR | 0xff05)) {
0260         static unsigned int last_key = 0;
0261         unsigned int key = 0;
0262         switch (value) {
0263         case 0x01: key = KEY_F14; break;
0264         case 0x02: key = KEY_F15; break;
0265         case 0x04: key = KEY_F16; break;
0266         case 0x08: key = KEY_F17; break;
0267         case 0x10: key = KEY_F18; break;
0268         }
0269         if (key) {
0270             input_event(input, usage->type, key, 1);
0271             last_key = key;
0272         } else
0273             input_event(input, usage->type, last_key, 0);
0274 
0275         return 1;
0276     }
0277 
0278     return 0;
0279 }
0280 
0281 static void ms_ff_worker(struct work_struct *work)
0282 {
0283     struct ms_data *ms = container_of(work, struct ms_data, ff_worker);
0284     struct hid_device *hdev = ms->hdev;
0285     struct xb1s_ff_report *r = ms->output_report_dmabuf;
0286     int ret;
0287 
0288     memset(r, 0, sizeof(*r));
0289 
0290     r->report_id = XB1S_FF_REPORT;
0291     r->enable = ENABLE_WEAK | ENABLE_STRONG;
0292     /*
0293      * Specifying maximum duration and maximum loop count should
0294      * cover maximum duration of a single effect, which is 65536
0295      * ms
0296      */
0297     r->duration_10ms = U8_MAX;
0298     r->loop_count = U8_MAX;
0299     r->magnitude[MAGNITUDE_STRONG] = ms->strong; /* left actuator */
0300     r->magnitude[MAGNITUDE_WEAK] = ms->weak;     /* right actuator */
0301 
0302     ret = hid_hw_output_report(hdev, (__u8 *)r, sizeof(*r));
0303     if (ret < 0)
0304         hid_warn(hdev, "failed to send FF report\n");
0305 }
0306 
0307 static int ms_play_effect(struct input_dev *dev, void *data,
0308               struct ff_effect *effect)
0309 {
0310     struct hid_device *hid = input_get_drvdata(dev);
0311     struct ms_data *ms = hid_get_drvdata(hid);
0312 
0313     if (effect->type != FF_RUMBLE)
0314         return 0;
0315 
0316     /*
0317      * Magnitude is 0..100 so scale the 16-bit input here
0318      */
0319     ms->strong = ((u32) effect->u.rumble.strong_magnitude * 100) / U16_MAX;
0320     ms->weak = ((u32) effect->u.rumble.weak_magnitude * 100) / U16_MAX;
0321 
0322     schedule_work(&ms->ff_worker);
0323     return 0;
0324 }
0325 
0326 static int ms_init_ff(struct hid_device *hdev)
0327 {
0328     struct hid_input *hidinput;
0329     struct input_dev *input_dev;
0330     struct ms_data *ms = hid_get_drvdata(hdev);
0331 
0332     if (list_empty(&hdev->inputs)) {
0333         hid_err(hdev, "no inputs found\n");
0334         return -ENODEV;
0335     }
0336     hidinput = list_entry(hdev->inputs.next, struct hid_input, list);
0337     input_dev = hidinput->input;
0338 
0339     if (!(ms->quirks & MS_QUIRK_FF))
0340         return 0;
0341 
0342     ms->hdev = hdev;
0343     INIT_WORK(&ms->ff_worker, ms_ff_worker);
0344 
0345     ms->output_report_dmabuf = devm_kzalloc(&hdev->dev,
0346                         sizeof(struct xb1s_ff_report),
0347                         GFP_KERNEL);
0348     if (ms->output_report_dmabuf == NULL)
0349         return -ENOMEM;
0350 
0351     input_set_capability(input_dev, EV_FF, FF_RUMBLE);
0352     return input_ff_create_memless(input_dev, NULL, ms_play_effect);
0353 }
0354 
0355 static void ms_remove_ff(struct hid_device *hdev)
0356 {
0357     struct ms_data *ms = hid_get_drvdata(hdev);
0358 
0359     if (!(ms->quirks & MS_QUIRK_FF))
0360         return;
0361 
0362     cancel_work_sync(&ms->ff_worker);
0363 }
0364 
0365 static int ms_probe(struct hid_device *hdev, const struct hid_device_id *id)
0366 {
0367     unsigned long quirks = id->driver_data;
0368     struct ms_data *ms;
0369     int ret;
0370 
0371     ms = devm_kzalloc(&hdev->dev, sizeof(*ms), GFP_KERNEL);
0372     if (ms == NULL)
0373         return -ENOMEM;
0374 
0375     ms->quirks = quirks;
0376 
0377     hid_set_drvdata(hdev, ms);
0378 
0379     if (quirks & MS_NOGET)
0380         hdev->quirks |= HID_QUIRK_NOGET;
0381 
0382     if (quirks & MS_SURFACE_DIAL)
0383         hdev->quirks |= HID_QUIRK_INPUT_PER_APP;
0384 
0385     ret = hid_parse(hdev);
0386     if (ret) {
0387         hid_err(hdev, "parse failed\n");
0388         goto err_free;
0389     }
0390 
0391     ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT | ((quirks & MS_HIDINPUT) ?
0392                 HID_CONNECT_HIDINPUT_FORCE : 0));
0393     if (ret) {
0394         hid_err(hdev, "hw start failed\n");
0395         goto err_free;
0396     }
0397 
0398     ret = ms_init_ff(hdev);
0399     if (ret)
0400         hid_err(hdev, "could not initialize ff, continuing anyway");
0401 
0402     return 0;
0403 err_free:
0404     return ret;
0405 }
0406 
0407 static void ms_remove(struct hid_device *hdev)
0408 {
0409     hid_hw_stop(hdev);
0410     ms_remove_ff(hdev);
0411 }
0412 
0413 static const struct hid_device_id ms_devices[] = {
0414     { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_SIDEWINDER_GV),
0415         .driver_data = MS_HIDINPUT },
0416     { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_OFFICE_KB),
0417         .driver_data = MS_ERGONOMY },
0418     { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_NE4K),
0419         .driver_data = MS_ERGONOMY },
0420     { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_NE4K_JP),
0421         .driver_data = MS_ERGONOMY },
0422     { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_NE7K),
0423         .driver_data = MS_ERGONOMY },
0424     { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_LK6K),
0425         .driver_data = MS_ERGONOMY | MS_RDESC },
0426     { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_PRESENTER_8K_USB),
0427         .driver_data = MS_PRESENTER },
0428     { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_DIGITAL_MEDIA_3K),
0429         .driver_data = MS_ERGONOMY },
0430     { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_DIGITAL_MEDIA_7K),
0431         .driver_data = MS_ERGONOMY },
0432     { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_DIGITAL_MEDIA_600),
0433         .driver_data = MS_ERGONOMY },
0434     { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_DIGITAL_MEDIA_3KV1),
0435         .driver_data = MS_ERGONOMY },
0436     { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_WIRELESS_OPTICAL_DESKTOP_3_0),
0437         .driver_data = MS_NOGET },
0438     { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_COMFORT_MOUSE_4500),
0439         .driver_data = MS_DUPLICATE_USAGES },
0440     { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_POWER_COVER),
0441         .driver_data = MS_HIDINPUT },
0442     { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_COMFORT_KEYBOARD),
0443         .driver_data = MS_ERGONOMY},
0444 
0445     { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_PRESENTER_8K_BT),
0446         .driver_data = MS_PRESENTER },
0447     { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, 0x091B),
0448         .driver_data = MS_SURFACE_DIAL },
0449     { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_XBOX_ONE_S_CONTROLLER),
0450         .driver_data = MS_QUIRK_FF },
0451     { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_8BITDO_SN30_PRO_PLUS),
0452         .driver_data = MS_QUIRK_FF },
0453     { }
0454 };
0455 MODULE_DEVICE_TABLE(hid, ms_devices);
0456 
0457 static struct hid_driver ms_driver = {
0458     .name = "microsoft",
0459     .id_table = ms_devices,
0460     .report_fixup = ms_report_fixup,
0461     .input_mapping = ms_input_mapping,
0462     .input_mapped = ms_input_mapped,
0463     .event = ms_event,
0464     .probe = ms_probe,
0465     .remove = ms_remove,
0466 };
0467 module_hid_driver(ms_driver);
0468 
0469 MODULE_LICENSE("GPL");
[ Source navigation ] [ Diff markup ] [ Identifier search ] [ general search ]

This page was automatically generated by the 2.1.0 LXR engine.

The LXR team
Valid CSS 2.1! Valid HTML 4.01!