^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) // SPDX-License-Identifier: GPL-2.0-or-later
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * HID driver for some cypress "special" devices
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Copyright (c) 1999 Andreas Gal
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) * Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) * Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) * Copyright (c) 2006-2007 Jiri Kosina
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) * Copyright (c) 2008 Jiri Slaby
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) #include <linux/device.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #include <linux/hid.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) #include <linux/input.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) #include <linux/module.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) #include "hid-ids.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) #define CP_RDESC_SWAPPED_MIN_MAX 0x01
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) #define CP_2WHEEL_MOUSE_HACK 0x02
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) #define CP_2WHEEL_MOUSE_HACK_ON 0x04
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) #define VA_INVAL_LOGICAL_BOUNDARY 0x08
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) * Some USB barcode readers from cypress have usage min and usage max in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) * the wrong order
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) static __u8 *cp_rdesc_fixup(struct hid_device *hdev, __u8 *rdesc,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) unsigned int *rsize)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) unsigned int i;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) if (*rsize < 4)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) return rdesc;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) for (i = 0; i < *rsize - 4; i++)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) if (rdesc[i] == 0x29 && rdesc[i + 2] == 0x19) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) rdesc[i] = 0x19;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) rdesc[i + 2] = 0x29;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) swap(rdesc[i + 3], rdesc[i + 1]);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) return rdesc;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) static __u8 *va_logical_boundary_fixup(struct hid_device *hdev, __u8 *rdesc,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) unsigned int *rsize)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) * Varmilo VA104M (with VID Cypress and device ID 07B1) incorrectly
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) * reports Logical Minimum of its Consumer Control device as 572
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) * (0x02 0x3c). Fix this by setting its Logical Minimum to zero.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) if (*rsize == 25 &&
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) rdesc[0] == 0x05 && rdesc[1] == 0x0c &&
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) rdesc[2] == 0x09 && rdesc[3] == 0x01 &&
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) rdesc[6] == 0x19 && rdesc[7] == 0x00 &&
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) rdesc[11] == 0x16 && rdesc[12] == 0x3c && rdesc[13] == 0x02) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) hid_info(hdev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) "fixing up varmilo VA104M consumer control report descriptor\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) rdesc[12] = 0x00;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) rdesc[13] = 0x00;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) return rdesc;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) static __u8 *cp_report_fixup(struct hid_device *hdev, __u8 *rdesc,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) unsigned int *rsize)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) if (quirks & CP_RDESC_SWAPPED_MIN_MAX)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) rdesc = cp_rdesc_fixup(hdev, rdesc, rsize);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) if (quirks & VA_INVAL_LOGICAL_BOUNDARY)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) rdesc = va_logical_boundary_fixup(hdev, rdesc, rsize);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) return rdesc;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) static int cp_input_mapped(struct hid_device *hdev, struct hid_input *hi,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) struct hid_field *field, struct hid_usage *usage,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) unsigned long **bit, int *max)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) if (!(quirks & CP_2WHEEL_MOUSE_HACK))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) if (usage->type == EV_REL && usage->code == REL_WHEEL)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) set_bit(REL_HWHEEL, *bit);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) if (usage->hid == 0x00090005)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) return -1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) static int cp_event(struct hid_device *hdev, struct hid_field *field,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) struct hid_usage *usage, __s32 value)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) if (!(hdev->claimed & HID_CLAIMED_INPUT) || !field->hidinput ||
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) !usage->type || !(quirks & CP_2WHEEL_MOUSE_HACK))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) if (usage->hid == 0x00090005) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) if (value)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) quirks |= CP_2WHEEL_MOUSE_HACK_ON;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) quirks &= ~CP_2WHEEL_MOUSE_HACK_ON;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) hid_set_drvdata(hdev, (void *)quirks);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) return 1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) if (usage->code == REL_WHEEL && (quirks & CP_2WHEEL_MOUSE_HACK_ON)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) struct input_dev *input = field->hidinput->input;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) input_event(input, usage->type, REL_HWHEEL, value);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) return 1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) static int cp_probe(struct hid_device *hdev, const struct hid_device_id *id)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) unsigned long quirks = id->driver_data;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) int ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) hid_set_drvdata(hdev, (void *)quirks);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) ret = hid_parse(hdev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) if (ret) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) hid_err(hdev, "parse failed\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) goto err_free;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) if (ret) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) hid_err(hdev, "hw start failed\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) goto err_free;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) err_free:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) return ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) static const struct hid_device_id cp_devices[] = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) { HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_BARCODE_1),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) .driver_data = CP_RDESC_SWAPPED_MIN_MAX },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) { HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_BARCODE_2),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) .driver_data = CP_RDESC_SWAPPED_MIN_MAX },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) { HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_BARCODE_3),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) .driver_data = CP_RDESC_SWAPPED_MIN_MAX },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) { HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_BARCODE_4),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) .driver_data = CP_RDESC_SWAPPED_MIN_MAX },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) { HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_MOUSE),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) .driver_data = CP_2WHEEL_MOUSE_HACK },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) { HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_VARMILO_VA104M_07B1),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) .driver_data = VA_INVAL_LOGICAL_BOUNDARY },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) { }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) MODULE_DEVICE_TABLE(hid, cp_devices);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) static struct hid_driver cp_driver = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) .name = "cypress",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) .id_table = cp_devices,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) .report_fixup = cp_report_fixup,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) .input_mapped = cp_input_mapped,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) .event = cp_event,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) .probe = cp_probe,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) module_hid_driver(cp_driver);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) MODULE_LICENSE("GPL");