19614219eSNikolai Kondrashov /* SPDX-License-Identifier: GPL-2.0+ */ 29614219eSNikolai Kondrashov /* 39614219eSNikolai Kondrashov * HID driver for UC-Logic devices not fully compliant with HID standard 49614219eSNikolai Kondrashov * - tablet initialization and parameter retrieval 59614219eSNikolai Kondrashov * 69614219eSNikolai Kondrashov * Copyright (c) 2018 Nikolai Kondrashov 79614219eSNikolai Kondrashov */ 89614219eSNikolai Kondrashov 99614219eSNikolai Kondrashov /* 109614219eSNikolai Kondrashov * This program is free software; you can redistribute it and/or modify it 119614219eSNikolai Kondrashov * under the terms of the GNU General Public License as published by the Free 129614219eSNikolai Kondrashov * Software Foundation; either version 2 of the License, or (at your option) 139614219eSNikolai Kondrashov * any later version. 149614219eSNikolai Kondrashov */ 159614219eSNikolai Kondrashov 169614219eSNikolai Kondrashov #ifndef _HID_UCLOGIC_PARAMS_H 179614219eSNikolai Kondrashov #define _HID_UCLOGIC_PARAMS_H 189614219eSNikolai Kondrashov 199614219eSNikolai Kondrashov #include <linux/usb.h> 209614219eSNikolai Kondrashov #include <linux/hid.h> 21*a251d657SJosé Expósito #include <linux/list.h> 229614219eSNikolai Kondrashov 2314b71e6aSJosé Expósito #define UCLOGIC_MOUSE_FRAME_QUIRK BIT(0) 24f60c377fSJosé Expósito #define UCLOGIC_BATTERY_QUIRK BIT(1) 2514b71e6aSJosé Expósito 269614219eSNikolai Kondrashov /* Types of pen in-range reporting */ 279614219eSNikolai Kondrashov enum uclogic_params_pen_inrange { 289614219eSNikolai Kondrashov /* Normal reports: zero - out of proximity, one - in proximity */ 299614219eSNikolai Kondrashov UCLOGIC_PARAMS_PEN_INRANGE_NORMAL = 0, 309614219eSNikolai Kondrashov /* Inverted reports: zero - in proximity, one - out of proximity */ 319614219eSNikolai Kondrashov UCLOGIC_PARAMS_PEN_INRANGE_INVERTED, 3201309e29SNikolai Kondrashov /* No reports */ 3301309e29SNikolai Kondrashov UCLOGIC_PARAMS_PEN_INRANGE_NONE, 349614219eSNikolai Kondrashov }; 359614219eSNikolai Kondrashov 36a092986fSJosé Expósito /* Types of frames */ 37a092986fSJosé Expósito enum uclogic_params_frame_type { 38a092986fSJosé Expósito /* Frame with buttons */ 39a092986fSJosé Expósito UCLOGIC_PARAMS_FRAME_BUTTONS = 0, 40a092986fSJosé Expósito /* Frame with buttons and a dial */ 41a092986fSJosé Expósito UCLOGIC_PARAMS_FRAME_DIAL, 42a092986fSJosé Expósito /* Frame with buttons and a mouse (shaped as a dial + touchpad) */ 43a092986fSJosé Expósito UCLOGIC_PARAMS_FRAME_MOUSE, 44a092986fSJosé Expósito }; 45a092986fSJosé Expósito 468b013098SNikolai Kondrashov /* 478b013098SNikolai Kondrashov * Pen report's subreport data. 488b013098SNikolai Kondrashov */ 498b013098SNikolai Kondrashov struct uclogic_params_pen_subreport { 508b013098SNikolai Kondrashov /* 51e6be956fSNikolai Kondrashov * The value of the second byte of the pen report indicating this 52e6be956fSNikolai Kondrashov * subreport. If zero, the subreport should be considered invalid and 53e6be956fSNikolai Kondrashov * not matched. 548b013098SNikolai Kondrashov */ 55e6be956fSNikolai Kondrashov __u8 value; 568b013098SNikolai Kondrashov 578b013098SNikolai Kondrashov /* 58e6be956fSNikolai Kondrashov * The ID to be assigned to the report, if the second byte of the pen 59e6be956fSNikolai Kondrashov * report is equal to "value". Only valid if "value" is not zero. 608b013098SNikolai Kondrashov */ 618b013098SNikolai Kondrashov __u8 id; 628b013098SNikolai Kondrashov }; 638b013098SNikolai Kondrashov 649614219eSNikolai Kondrashov /* 659614219eSNikolai Kondrashov * Tablet interface's pen input parameters. 669614219eSNikolai Kondrashov * 679614219eSNikolai Kondrashov * Must use declarative (descriptive) language, not imperative, to simplify 689614219eSNikolai Kondrashov * understanding and maintain consistency. 699614219eSNikolai Kondrashov * 709614219eSNikolai Kondrashov * Noop (preserving functionality) when filled with zeroes. 719614219eSNikolai Kondrashov */ 729614219eSNikolai Kondrashov struct uclogic_params_pen { 739614219eSNikolai Kondrashov /* 74f5927973SNikolai Kondrashov * True if pen usage is invalid for this interface and should be 75f5927973SNikolai Kondrashov * ignored, false otherwise. 76f5927973SNikolai Kondrashov */ 77f5927973SNikolai Kondrashov bool usage_invalid; 78f5927973SNikolai Kondrashov /* 794933a722SNikolai Kondrashov * Pointer to report descriptor part describing the pen inputs. 804933a722SNikolai Kondrashov * Allocated with kmalloc. NULL if the part is not specified. 819614219eSNikolai Kondrashov */ 829614219eSNikolai Kondrashov __u8 *desc_ptr; 839614219eSNikolai Kondrashov /* 849614219eSNikolai Kondrashov * Size of the report descriptor. 859614219eSNikolai Kondrashov * Only valid, if "desc_ptr" is not NULL. 869614219eSNikolai Kondrashov */ 879614219eSNikolai Kondrashov unsigned int desc_size; 889614219eSNikolai Kondrashov /* Report ID, if reports should be tweaked, zero if not */ 899614219eSNikolai Kondrashov unsigned int id; 903e200d6cSNikolai Kondrashov /* The list of subreports, only valid if "id" is not zero */ 913e200d6cSNikolai Kondrashov struct uclogic_params_pen_subreport subreport_list[3]; 929614219eSNikolai Kondrashov /* Type of in-range reporting, only valid if "id" is not zero */ 939614219eSNikolai Kondrashov enum uclogic_params_pen_inrange inrange; 9459f2e0fcSNikolai Kondrashov /* 9559f2e0fcSNikolai Kondrashov * True, if reports include fragmented high resolution coords, with 9659f2e0fcSNikolai Kondrashov * high-order X and then Y bytes following the pressure field. 9759f2e0fcSNikolai Kondrashov * Only valid if "id" is not zero. 9859f2e0fcSNikolai Kondrashov */ 9959f2e0fcSNikolai Kondrashov bool fragmented_hires; 1001324c5acSNikolai Kondrashov /* 1011324c5acSNikolai Kondrashov * True if the pen reports tilt in bytes at offset 10 (X) and 11 (Y), 1021324c5acSNikolai Kondrashov * and the Y tilt direction is flipped. 1031324c5acSNikolai Kondrashov * Only valid if "id" is not zero. 1041324c5acSNikolai Kondrashov */ 1051324c5acSNikolai Kondrashov bool tilt_y_flipped; 1069614219eSNikolai Kondrashov }; 1079614219eSNikolai Kondrashov 1089614219eSNikolai Kondrashov /* 1099614219eSNikolai Kondrashov * Parameters of frame control inputs of a tablet interface. 1109614219eSNikolai Kondrashov * 1119614219eSNikolai Kondrashov * Must use declarative (descriptive) language, not imperative, to simplify 1129614219eSNikolai Kondrashov * understanding and maintain consistency. 1139614219eSNikolai Kondrashov * 1149614219eSNikolai Kondrashov * Noop (preserving functionality) when filled with zeroes. 1159614219eSNikolai Kondrashov */ 1169614219eSNikolai Kondrashov struct uclogic_params_frame { 1179614219eSNikolai Kondrashov /* 1184933a722SNikolai Kondrashov * Pointer to report descriptor part describing the frame inputs. 1194933a722SNikolai Kondrashov * Allocated with kmalloc. NULL if the part is not specified. 1209614219eSNikolai Kondrashov */ 1219614219eSNikolai Kondrashov __u8 *desc_ptr; 1229614219eSNikolai Kondrashov /* 1239614219eSNikolai Kondrashov * Size of the report descriptor. 1249614219eSNikolai Kondrashov * Only valid, if "desc_ptr" is not NULL. 1259614219eSNikolai Kondrashov */ 1269614219eSNikolai Kondrashov unsigned int desc_size; 1279614219eSNikolai Kondrashov /* 1289614219eSNikolai Kondrashov * Report ID, if reports should be tweaked, zero if not. 1299614219eSNikolai Kondrashov */ 1309614219eSNikolai Kondrashov unsigned int id; 131fde44ac5SNikolai Kondrashov /* 132ee007036SNikolai Kondrashov * The suffix to add to the input device name, if not NULL. 133ee007036SNikolai Kondrashov */ 134ee007036SNikolai Kondrashov const char *suffix; 135ee007036SNikolai Kondrashov /* 1368a47670cSNikolai Kondrashov * Number of the least-significant bit of the 2-bit state of a rotary 1378a47670cSNikolai Kondrashov * encoder, in the report. Cannot point to a 2-bit field crossing a 1388a47670cSNikolai Kondrashov * byte boundary. Zero if not present. Only valid if "id" is not zero. 1398a47670cSNikolai Kondrashov */ 1408a47670cSNikolai Kondrashov unsigned int re_lsb; 1418a47670cSNikolai Kondrashov /* 142fde44ac5SNikolai Kondrashov * Offset of the Wacom-style device ID byte in the report, to be set 143fde44ac5SNikolai Kondrashov * to pad device ID (0xf), for compatibility with Wacom drivers. Zero 144d170e8e0SNikolai Kondrashov * if no changes to the report should be made. The ID byte will be set 145caf7e934SNikolai Kondrashov * to zero whenever the byte pointed by "touch_byte" is zero, if 146d170e8e0SNikolai Kondrashov * the latter is valid. Only valid if "id" is not zero. 147fde44ac5SNikolai Kondrashov */ 148fde44ac5SNikolai Kondrashov unsigned int dev_id_byte; 149d170e8e0SNikolai Kondrashov /* 150caf7e934SNikolai Kondrashov * Offset of the touch ring/strip state byte, in the report. 151d170e8e0SNikolai Kondrashov * Zero if not present. If dev_id_byte is also valid and non-zero, 152d170e8e0SNikolai Kondrashov * then the device ID byte will be cleared when the byte pointed to by 153d170e8e0SNikolai Kondrashov * this offset is zero. Only valid if "id" is not zero. 154d170e8e0SNikolai Kondrashov */ 155caf7e934SNikolai Kondrashov unsigned int touch_byte; 156d170e8e0SNikolai Kondrashov /* 157caf7e934SNikolai Kondrashov * The value to anchor the reversed touch ring/strip reports at. 158d170e8e0SNikolai Kondrashov * I.e. one, if the reports should be flipped without offset. 159d170e8e0SNikolai Kondrashov * Zero if no reversal should be done. 160caf7e934SNikolai Kondrashov * Only valid if "touch_byte" is valid and not zero. 161d170e8e0SNikolai Kondrashov */ 162caf7e934SNikolai Kondrashov __s8 touch_flip_at; 163caf7e934SNikolai Kondrashov /* 164caf7e934SNikolai Kondrashov * Maximum value of the touch ring/strip report around which the value 165caf7e934SNikolai Kondrashov * should be wrapped when flipping according to "touch_flip_at". 166caf7e934SNikolai Kondrashov * The minimum valid value is considered to be one, with zero being 167caf7e934SNikolai Kondrashov * out-of-proximity (finger lift) value. 168caf7e934SNikolai Kondrashov * Only valid if "touch_flip_at" is valid and not zero. 169caf7e934SNikolai Kondrashov */ 170caf7e934SNikolai Kondrashov __s8 touch_max; 1712112b49eSNikolai Kondrashov /* 1722112b49eSNikolai Kondrashov * Offset of the bitmap dial byte, in the report. Zero if not present. 1732112b49eSNikolai Kondrashov * Only valid if "id" is not zero. A bitmap dial sends reports with a 1742112b49eSNikolai Kondrashov * dedicated bit per direction: 1 means clockwise rotation, 2 means 1752112b49eSNikolai Kondrashov * counterclockwise, as opposed to the normal 1 and -1. 1762112b49eSNikolai Kondrashov */ 1772112b49eSNikolai Kondrashov unsigned int bitmap_dial_byte; 1789614219eSNikolai Kondrashov }; 1799614219eSNikolai Kondrashov 1809614219eSNikolai Kondrashov /* 181*a251d657SJosé Expósito * List of works to be performed when a certain raw event is received. 182*a251d657SJosé Expósito */ 183*a251d657SJosé Expósito struct uclogic_raw_event_hook { 184*a251d657SJosé Expósito struct hid_device *hdev; 185*a251d657SJosé Expósito __u8 *event; 186*a251d657SJosé Expósito size_t size; 187*a251d657SJosé Expósito struct work_struct work; 188*a251d657SJosé Expósito struct list_head list; 189*a251d657SJosé Expósito }; 190*a251d657SJosé Expósito 191*a251d657SJosé Expósito /* 1929614219eSNikolai Kondrashov * Tablet interface report parameters. 1939614219eSNikolai Kondrashov * 1949614219eSNikolai Kondrashov * Must use declarative (descriptive) language, not imperative, to simplify 1959614219eSNikolai Kondrashov * understanding and maintain consistency. 1969614219eSNikolai Kondrashov * 1979614219eSNikolai Kondrashov * When filled with zeros represents a "noop" configuration - passes all 1989614219eSNikolai Kondrashov * reports unchanged and lets the generic HID driver handle everything. 1999614219eSNikolai Kondrashov * 2009614219eSNikolai Kondrashov * The resulting device report descriptor is assembled from all the report 2019614219eSNikolai Kondrashov * descriptor parts referenced by the structure. No order of assembly should 2029614219eSNikolai Kondrashov * be assumed. The structure represents original device report descriptor if 2039614219eSNikolai Kondrashov * all the parts are NULL. 2049614219eSNikolai Kondrashov */ 2059614219eSNikolai Kondrashov struct uclogic_params { 2069614219eSNikolai Kondrashov /* 2079614219eSNikolai Kondrashov * True if the whole interface is invalid, false otherwise. 2089614219eSNikolai Kondrashov */ 2099614219eSNikolai Kondrashov bool invalid; 2109614219eSNikolai Kondrashov /* 2119614219eSNikolai Kondrashov * Pointer to the common part of the replacement report descriptor, 2129614219eSNikolai Kondrashov * allocated with kmalloc. NULL if no common part is needed. 2139614219eSNikolai Kondrashov * Only valid, if "invalid" is false. 2149614219eSNikolai Kondrashov */ 2159614219eSNikolai Kondrashov __u8 *desc_ptr; 2169614219eSNikolai Kondrashov /* 2179614219eSNikolai Kondrashov * Size of the common part of the replacement report descriptor. 21887dc28ebSNikolai Kondrashov * Only valid, if "desc_ptr" is valid and not NULL. 2199614219eSNikolai Kondrashov */ 2209614219eSNikolai Kondrashov unsigned int desc_size; 2219614219eSNikolai Kondrashov /* 2229614219eSNikolai Kondrashov * Pen parameters and optional report descriptor part. 223606dadc1SNikolai Kondrashov * Only valid, if "invalid" is false. 2249614219eSNikolai Kondrashov */ 2259614219eSNikolai Kondrashov struct uclogic_params_pen pen; 2269614219eSNikolai Kondrashov /* 227337fa051SNikolai Kondrashov * The list of frame control parameters and optional report descriptor 228337fa051SNikolai Kondrashov * parts. Only valid, if "invalid" is false. 2299614219eSNikolai Kondrashov */ 2303e200d6cSNikolai Kondrashov struct uclogic_params_frame frame_list[3]; 231*a251d657SJosé Expósito /* 232*a251d657SJosé Expósito * List of event hooks. 233*a251d657SJosé Expósito */ 234*a251d657SJosé Expósito struct uclogic_raw_event_hook *event_hooks; 2359614219eSNikolai Kondrashov }; 2369614219eSNikolai Kondrashov 23714b71e6aSJosé Expósito /* Driver data */ 23814b71e6aSJosé Expósito struct uclogic_drvdata { 23914b71e6aSJosé Expósito /* Interface parameters */ 24014b71e6aSJosé Expósito struct uclogic_params params; 24114b71e6aSJosé Expósito /* Pointer to the replacement report descriptor. NULL if none. */ 24214b71e6aSJosé Expósito __u8 *desc_ptr; 24314b71e6aSJosé Expósito /* 24414b71e6aSJosé Expósito * Size of the replacement report descriptor. 24514b71e6aSJosé Expósito * Only valid if desc_ptr is not NULL 24614b71e6aSJosé Expósito */ 24714b71e6aSJosé Expósito unsigned int desc_size; 24814b71e6aSJosé Expósito /* Pen input device */ 24914b71e6aSJosé Expósito struct input_dev *pen_input; 25014b71e6aSJosé Expósito /* In-range timer */ 25114b71e6aSJosé Expósito struct timer_list inrange_timer; 25214b71e6aSJosé Expósito /* Last rotary encoder state, or U8_MAX for none */ 25314b71e6aSJosé Expósito u8 re_state; 25414b71e6aSJosé Expósito /* Device quirks */ 25514b71e6aSJosé Expósito unsigned long quirks; 25614b71e6aSJosé Expósito }; 25714b71e6aSJosé Expósito 2589614219eSNikolai Kondrashov /* Initialize a tablet interface and discover its parameters */ 2599614219eSNikolai Kondrashov extern int uclogic_params_init(struct uclogic_params *params, 2609614219eSNikolai Kondrashov struct hid_device *hdev); 2619614219eSNikolai Kondrashov 2629614219eSNikolai Kondrashov /* Get a replacement report descriptor for a tablet's interface. */ 2639614219eSNikolai Kondrashov extern int uclogic_params_get_desc(const struct uclogic_params *params, 2649614219eSNikolai Kondrashov __u8 **pdesc, 2659614219eSNikolai Kondrashov unsigned int *psize); 2669614219eSNikolai Kondrashov 2679614219eSNikolai Kondrashov /* Free resources used by tablet interface's parameters */ 2689614219eSNikolai Kondrashov extern void uclogic_params_cleanup(struct uclogic_params *params); 2699614219eSNikolai Kondrashov 270a228809fSNikolai Kondrashov /* Dump tablet interface parameters with hid_dbg() */ 271a228809fSNikolai Kondrashov extern void uclogic_params_hid_dbg(const struct hid_device *hdev, 272a228809fSNikolai Kondrashov const struct uclogic_params *params); 273a228809fSNikolai Kondrashov 2749614219eSNikolai Kondrashov #endif /* _HID_UCLOGIC_PARAMS_H */ 275