drivers/hid/hid-cypress.c

0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /*
0003  *  HID driver for some cypress "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/hid.h>
0017 #include <linux/input.h>
0018 #include <linux/module.h>
0019
0020 #include "hid-ids.h"
0021
0022 #define CP_RDESC_SWAPPED_MIN_MAX    0x01
0023 #define CP_2WHEEL_MOUSE_HACK        0x02
0024 #define CP_2WHEEL_MOUSE_HACK_ON     0x04
0025
0026 #define VA_INVAL_LOGICAL_BOUNDARY   0x08
0027
0028 /*
0029  * Some USB barcode readers from cypress have usage min and usage max in
0030  * the wrong order
0031  */
0032 static __u8 *cp_rdesc_fixup(struct hid_device *hdev, __u8 *rdesc,
0033         unsigned int *rsize)
0034 {
0035     unsigned int i;
0036
0037     if (*rsize < 4)
0038         return rdesc;
0039
0040     for (i = 0; i < *rsize - 4; i++)
0041         if (rdesc[i] == 0x29 && rdesc[i + 2] == 0x19) {
0042             rdesc[i] = 0x19;
0043             rdesc[i + 2] = 0x29;
0044             swap(rdesc[i + 3], rdesc[i + 1]);
0045         }
0046     return rdesc;
0047 }
0048
0049 static __u8 *va_logical_boundary_fixup(struct hid_device *hdev, __u8 *rdesc,
0050         unsigned int *rsize)
0051 {
0052     /*
0053      * Varmilo VA104M (with VID Cypress and device ID 07B1) incorrectly
0054      * reports Logical Minimum of its Consumer Control device as 572
0055      * (0x02 0x3c). Fix this by setting its Logical Minimum to zero.
0056      */
0057     if (*rsize == 25 &&
0058             rdesc[0] == 0x05 && rdesc[1] == 0x0c &&
0059             rdesc[2] == 0x09 && rdesc[3] == 0x01 &&
0060             rdesc[6] == 0x19 && rdesc[7] == 0x00 &&
0061             rdesc[11] == 0x16 && rdesc[12] == 0x3c && rdesc[13] == 0x02) {
0062         hid_info(hdev,
0063              "fixing up varmilo VA104M consumer control report descriptor\n");
0064         rdesc[12] = 0x00;
0065         rdesc[13] = 0x00;
0066     }
0067     return rdesc;
0068 }
0069
0070 static __u8 *cp_report_fixup(struct hid_device *hdev, __u8 *rdesc,
0071         unsigned int *rsize)
0072 {
0073     unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);
0074
0075     if (quirks & CP_RDESC_SWAPPED_MIN_MAX)
0076         rdesc = cp_rdesc_fixup(hdev, rdesc, rsize);
0077     if (quirks & VA_INVAL_LOGICAL_BOUNDARY)
0078         rdesc = va_logical_boundary_fixup(hdev, rdesc, rsize);
0079
0080     return rdesc;
0081 }
0082
0083 static int cp_input_mapped(struct hid_device *hdev, struct hid_input *hi,
0084         struct hid_field *field, struct hid_usage *usage,
0085         unsigned long **bit, int *max)
0086 {
0087     unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);
0088
0089     if (!(quirks & CP_2WHEEL_MOUSE_HACK))
0090         return 0;
0091
0092     if (usage->type == EV_REL && usage->code == REL_WHEEL)
0093         set_bit(REL_HWHEEL, *bit);
0094     if (usage->hid == 0x00090005)
0095         return -1;
0096
0097     return 0;
0098 }
0099
0100 static int cp_event(struct hid_device *hdev, struct hid_field *field,
0101         struct hid_usage *usage, __s32 value)
0102 {
0103     unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);
0104
0105     if (!(hdev->claimed & HID_CLAIMED_INPUT) || !field->hidinput ||
0106             !usage->type || !(quirks & CP_2WHEEL_MOUSE_HACK))
0107         return 0;
0108
0109     if (usage->hid == 0x00090005) {
0110         if (value)
0111             quirks |=  CP_2WHEEL_MOUSE_HACK_ON;
0112         else
0113             quirks &= ~CP_2WHEEL_MOUSE_HACK_ON;
0114         hid_set_drvdata(hdev, (void *)quirks);
0115         return 1;
0116     }
0117
0118     if (usage->code == REL_WHEEL && (quirks & CP_2WHEEL_MOUSE_HACK_ON)) {
0119         struct input_dev *input = field->hidinput->input;
0120
0121         input_event(input, usage->type, REL_HWHEEL, value);
0122         return 1;
0123     }
0124
0125     return 0;
0126 }
0127
0128 static int cp_probe(struct hid_device *hdev, const struct hid_device_id *id)
0129 {
0130     unsigned long quirks = id->driver_data;
0131     int ret;
0132
0133     hid_set_drvdata(hdev, (void *)quirks);
0134
0135     ret = hid_parse(hdev);
0136     if (ret) {
0137         hid_err(hdev, "parse failed\n");
0138         goto err_free;
0139     }
0140
0141     ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
0142     if (ret) {
0143         hid_err(hdev, "hw start failed\n");
0144         goto err_free;
0145     }
0146
0147     return 0;
0148 err_free:
0149     return ret;
0150 }
0151
0152 static const struct hid_device_id cp_devices[] = {
0153     { HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_BARCODE_1),
0154         .driver_data = CP_RDESC_SWAPPED_MIN_MAX },
0155     { HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_BARCODE_2),
0156         .driver_data = CP_RDESC_SWAPPED_MIN_MAX },
0157     { HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_BARCODE_3),
0158         .driver_data = CP_RDESC_SWAPPED_MIN_MAX },
0159     { HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_BARCODE_4),
0160         .driver_data = CP_RDESC_SWAPPED_MIN_MAX },
0161     { HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_MOUSE),
0162         .driver_data = CP_2WHEEL_MOUSE_HACK },
0163     { HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_VARMILO_VA104M_07B1),
0164         .driver_data = VA_INVAL_LOGICAL_BOUNDARY },
0165     { }
0166 };
0167 MODULE_DEVICE_TABLE(hid, cp_devices);
0168
0169 static struct hid_driver cp_driver = {
0170     .name = "cypress",
0171     .id_table = cp_devices,
0172     .report_fixup = cp_report_fixup,
0173     .input_mapped = cp_input_mapped,
0174     .event = cp_event,
0175     .probe = cp_probe,
0176 };
0177 module_hid_driver(cp_driver);
0178
0179 MODULE_LICENSE("GPL");