^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 Google Fiber TV Box remote controls
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Copyright (c) 2014-2015 Google Inc.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) * Author: Petri Gynther <pgynther@google.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) #include <linux/device.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) #include <linux/hid.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) #include <linux/input.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) #include <linux/module.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) #include "hid-ids.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #define GFRM100 1 /* Google Fiber GFRM100 (Bluetooth classic) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) #define GFRM200 2 /* Google Fiber GFRM200 (Bluetooth LE) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) #define GFRM100_SEARCH_KEY_REPORT_ID 0xF7
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) #define GFRM100_SEARCH_KEY_DOWN 0x0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) #define GFRM100_SEARCH_KEY_AUDIO_DATA 0x1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) #define GFRM100_SEARCH_KEY_UP 0x2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) static u8 search_key_dn[3] = {0x40, 0x21, 0x02};
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) static u8 search_key_up[3] = {0x40, 0x00, 0x00};
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) static int gfrm_input_mapping(struct hid_device *hdev, struct hid_input *hi,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) struct hid_field *field, struct hid_usage *usage,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) unsigned long **bit, int *max)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) unsigned long hdev_type = (unsigned long) hid_get_drvdata(hdev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) if (hdev_type == GFRM100) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) if (usage->hid == (HID_UP_CONSUMER | 0x4)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) /* Consumer.0004 -> KEY_INFO */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) hid_map_usage_clear(hi, usage, bit, max, EV_KEY, KEY_INFO);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) return 1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) if (usage->hid == (HID_UP_CONSUMER | 0x41)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) /* Consumer.0041 -> KEY_OK */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) hid_map_usage_clear(hi, usage, bit, max, EV_KEY, KEY_OK);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) return 1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) static int gfrm_raw_event(struct hid_device *hdev, struct hid_report *report,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) u8 *data, int size)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) unsigned long hdev_type = (unsigned long) hid_get_drvdata(hdev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) int ret = 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) if (hdev_type != GFRM100)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) if (size < 2 || data[0] != GFRM100_SEARCH_KEY_REPORT_ID)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) * Convert GFRM100 Search key reports into Consumer.0221 (Key.Search)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) * reports. Ignore audio data.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) switch (data[1]) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) case GFRM100_SEARCH_KEY_DOWN:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) ret = hid_report_raw_event(hdev, HID_INPUT_REPORT, search_key_dn,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) sizeof(search_key_dn), 1);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) break;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) case GFRM100_SEARCH_KEY_AUDIO_DATA:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) break;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) case GFRM100_SEARCH_KEY_UP:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) ret = hid_report_raw_event(hdev, HID_INPUT_REPORT, search_key_up,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) sizeof(search_key_up), 1);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) break;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) default:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) break;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) return (ret < 0) ? ret : -1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) static int gfrm_input_configured(struct hid_device *hid, struct hid_input *hidinput)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) * Enable software autorepeat with:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) * - repeat delay: 400 msec
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) * - repeat period: 100 msec
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) input_enable_softrepeat(hidinput->input, 400, 100);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) static int gfrm_probe(struct hid_device *hdev, const struct hid_device_id *id)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) int ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) hid_set_drvdata(hdev, (void *) id->driver_data);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) ret = hid_parse(hdev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) if (ret)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) goto done;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) if (id->driver_data == GFRM100) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) * GFRM100 HID Report Descriptor does not describe the Search
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) * key reports. Thus, we need to add it manually here, so that
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) * those reports reach gfrm_raw_event() from hid_input_report().
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) if (!hid_register_report(hdev, HID_INPUT_REPORT,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) GFRM100_SEARCH_KEY_REPORT_ID, 0)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) ret = -ENOMEM;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) goto done;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) done:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) return ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) static const struct hid_device_id gfrm_devices[] = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) { HID_BLUETOOTH_DEVICE(0x58, 0x2000),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) .driver_data = GFRM100 },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) { HID_BLUETOOTH_DEVICE(0x471, 0x2210),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) .driver_data = GFRM200 },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) { }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) MODULE_DEVICE_TABLE(hid, gfrm_devices);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) static struct hid_driver gfrm_driver = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) .name = "gfrm",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) .id_table = gfrm_devices,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) .probe = gfrm_probe,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) .input_mapping = gfrm_input_mapping,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) .raw_event = gfrm_raw_event,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) .input_configured = gfrm_input_configured,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) module_hid_driver(gfrm_driver);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) MODULE_AUTHOR("Petri Gynther <pgynther@google.com>");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) MODULE_DESCRIPTION("Google Fiber TV Box remote control driver");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) MODULE_LICENSE("GPL");