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> 219614219eSNikolai Kondrashov 22*14b71e6aSJosé Expósito #define UCLOGIC_MOUSE_FRAME_QUIRK BIT(0) 23*14b71e6aSJosé Expósito 249614219eSNikolai Kondrashov /* Types of pen in-range reporting */ 259614219eSNikolai Kondrashov enum uclogic_params_pen_inrange { 269614219eSNikolai Kondrashov /* Normal reports: zero - out of proximity, one - in proximity */ 279614219eSNikolai Kondrashov UCLOGIC_PARAMS_PEN_INRANGE_NORMAL = 0, 289614219eSNikolai Kondrashov /* Inverted reports: zero - in proximity, one - out of proximity */ 299614219eSNikolai Kondrashov UCLOGIC_PARAMS_PEN_INRANGE_INVERTED, 3001309e29SNikolai Kondrashov /* No reports */ 3101309e29SNikolai Kondrashov UCLOGIC_PARAMS_PEN_INRANGE_NONE, 329614219eSNikolai Kondrashov }; 339614219eSNikolai Kondrashov 34a092986fSJosé Expósito /* Types of frames */ 35a092986fSJosé Expósito enum uclogic_params_frame_type { 36a092986fSJosé Expósito /* Frame with buttons */ 37a092986fSJosé Expósito UCLOGIC_PARAMS_FRAME_BUTTONS = 0, 38a092986fSJosé Expósito /* Frame with buttons and a dial */ 39a092986fSJosé Expósito UCLOGIC_PARAMS_FRAME_DIAL, 40a092986fSJosé Expósito /* Frame with buttons and a mouse (shaped as a dial + touchpad) */ 41a092986fSJosé Expósito UCLOGIC_PARAMS_FRAME_MOUSE, 42a092986fSJosé Expósito }; 43a092986fSJosé Expósito 448b013098SNikolai Kondrashov /* 458b013098SNikolai Kondrashov * Pen report's subreport data. 468b013098SNikolai Kondrashov */ 478b013098SNikolai Kondrashov struct uclogic_params_pen_subreport { 488b013098SNikolai Kondrashov /* 49e6be956fSNikolai Kondrashov * The value of the second byte of the pen report indicating this 50e6be956fSNikolai Kondrashov * subreport. If zero, the subreport should be considered invalid and 51e6be956fSNikolai Kondrashov * not matched. 528b013098SNikolai Kondrashov */ 53e6be956fSNikolai Kondrashov __u8 value; 548b013098SNikolai Kondrashov 558b013098SNikolai Kondrashov /* 56e6be956fSNikolai Kondrashov * The ID to be assigned to the report, if the second byte of the pen 57e6be956fSNikolai Kondrashov * report is equal to "value". Only valid if "value" is not zero. 588b013098SNikolai Kondrashov */ 598b013098SNikolai Kondrashov __u8 id; 608b013098SNikolai Kondrashov }; 618b013098SNikolai Kondrashov 629614219eSNikolai Kondrashov /* 639614219eSNikolai Kondrashov * Tablet interface's pen input parameters. 649614219eSNikolai Kondrashov * 659614219eSNikolai Kondrashov * Must use declarative (descriptive) language, not imperative, to simplify 669614219eSNikolai Kondrashov * understanding and maintain consistency. 679614219eSNikolai Kondrashov * 689614219eSNikolai Kondrashov * Noop (preserving functionality) when filled with zeroes. 699614219eSNikolai Kondrashov */ 709614219eSNikolai Kondrashov struct uclogic_params_pen { 719614219eSNikolai Kondrashov /* 72f5927973SNikolai Kondrashov * True if pen usage is invalid for this interface and should be 73f5927973SNikolai Kondrashov * ignored, false otherwise. 74f5927973SNikolai Kondrashov */ 75f5927973SNikolai Kondrashov bool usage_invalid; 76f5927973SNikolai Kondrashov /* 774933a722SNikolai Kondrashov * Pointer to report descriptor part describing the pen inputs. 784933a722SNikolai Kondrashov * Allocated with kmalloc. NULL if the part is not specified. 799614219eSNikolai Kondrashov */ 809614219eSNikolai Kondrashov __u8 *desc_ptr; 819614219eSNikolai Kondrashov /* 829614219eSNikolai Kondrashov * Size of the report descriptor. 839614219eSNikolai Kondrashov * Only valid, if "desc_ptr" is not NULL. 849614219eSNikolai Kondrashov */ 859614219eSNikolai Kondrashov unsigned int desc_size; 869614219eSNikolai Kondrashov /* Report ID, if reports should be tweaked, zero if not */ 879614219eSNikolai Kondrashov unsigned int id; 883e200d6cSNikolai Kondrashov /* The list of subreports, only valid if "id" is not zero */ 893e200d6cSNikolai Kondrashov struct uclogic_params_pen_subreport subreport_list[3]; 909614219eSNikolai Kondrashov /* Type of in-range reporting, only valid if "id" is not zero */ 919614219eSNikolai Kondrashov enum uclogic_params_pen_inrange inrange; 9259f2e0fcSNikolai Kondrashov /* 9359f2e0fcSNikolai Kondrashov * True, if reports include fragmented high resolution coords, with 9459f2e0fcSNikolai Kondrashov * high-order X and then Y bytes following the pressure field. 9559f2e0fcSNikolai Kondrashov * Only valid if "id" is not zero. 9659f2e0fcSNikolai Kondrashov */ 9759f2e0fcSNikolai Kondrashov bool fragmented_hires; 981324c5acSNikolai Kondrashov /* 991324c5acSNikolai Kondrashov * True if the pen reports tilt in bytes at offset 10 (X) and 11 (Y), 1001324c5acSNikolai Kondrashov * and the Y tilt direction is flipped. 1011324c5acSNikolai Kondrashov * Only valid if "id" is not zero. 1021324c5acSNikolai Kondrashov */ 1031324c5acSNikolai Kondrashov bool tilt_y_flipped; 1049614219eSNikolai Kondrashov }; 1059614219eSNikolai Kondrashov 1069614219eSNikolai Kondrashov /* 1079614219eSNikolai Kondrashov * Parameters of frame control inputs of a tablet interface. 1089614219eSNikolai Kondrashov * 1099614219eSNikolai Kondrashov * Must use declarative (descriptive) language, not imperative, to simplify 1109614219eSNikolai Kondrashov * understanding and maintain consistency. 1119614219eSNikolai Kondrashov * 1129614219eSNikolai Kondrashov * Noop (preserving functionality) when filled with zeroes. 1139614219eSNikolai Kondrashov */ 1149614219eSNikolai Kondrashov struct uclogic_params_frame { 1159614219eSNikolai Kondrashov /* 1164933a722SNikolai Kondrashov * Pointer to report descriptor part describing the frame inputs. 1174933a722SNikolai Kondrashov * Allocated with kmalloc. NULL if the part is not specified. 1189614219eSNikolai Kondrashov */ 1199614219eSNikolai Kondrashov __u8 *desc_ptr; 1209614219eSNikolai Kondrashov /* 1219614219eSNikolai Kondrashov * Size of the report descriptor. 1229614219eSNikolai Kondrashov * Only valid, if "desc_ptr" is not NULL. 1239614219eSNikolai Kondrashov */ 1249614219eSNikolai Kondrashov unsigned int desc_size; 1259614219eSNikolai Kondrashov /* 1269614219eSNikolai Kondrashov * Report ID, if reports should be tweaked, zero if not. 1279614219eSNikolai Kondrashov */ 1289614219eSNikolai Kondrashov unsigned int id; 129fde44ac5SNikolai Kondrashov /* 130ee007036SNikolai Kondrashov * The suffix to add to the input device name, if not NULL. 131ee007036SNikolai Kondrashov */ 132ee007036SNikolai Kondrashov const char *suffix; 133ee007036SNikolai Kondrashov /* 1348a47670cSNikolai Kondrashov * Number of the least-significant bit of the 2-bit state of a rotary 1358a47670cSNikolai Kondrashov * encoder, in the report. Cannot point to a 2-bit field crossing a 1368a47670cSNikolai Kondrashov * byte boundary. Zero if not present. Only valid if "id" is not zero. 1378a47670cSNikolai Kondrashov */ 1388a47670cSNikolai Kondrashov unsigned int re_lsb; 1398a47670cSNikolai Kondrashov /* 140fde44ac5SNikolai Kondrashov * Offset of the Wacom-style device ID byte in the report, to be set 141fde44ac5SNikolai Kondrashov * to pad device ID (0xf), for compatibility with Wacom drivers. Zero 142d170e8e0SNikolai Kondrashov * if no changes to the report should be made. The ID byte will be set 143caf7e934SNikolai Kondrashov * to zero whenever the byte pointed by "touch_byte" is zero, if 144d170e8e0SNikolai Kondrashov * the latter is valid. Only valid if "id" is not zero. 145fde44ac5SNikolai Kondrashov */ 146fde44ac5SNikolai Kondrashov unsigned int dev_id_byte; 147d170e8e0SNikolai Kondrashov /* 148caf7e934SNikolai Kondrashov * Offset of the touch ring/strip state byte, in the report. 149d170e8e0SNikolai Kondrashov * Zero if not present. If dev_id_byte is also valid and non-zero, 150d170e8e0SNikolai Kondrashov * then the device ID byte will be cleared when the byte pointed to by 151d170e8e0SNikolai Kondrashov * this offset is zero. Only valid if "id" is not zero. 152d170e8e0SNikolai Kondrashov */ 153caf7e934SNikolai Kondrashov unsigned int touch_byte; 154d170e8e0SNikolai Kondrashov /* 155caf7e934SNikolai Kondrashov * The value to anchor the reversed touch ring/strip reports at. 156d170e8e0SNikolai Kondrashov * I.e. one, if the reports should be flipped without offset. 157d170e8e0SNikolai Kondrashov * Zero if no reversal should be done. 158caf7e934SNikolai Kondrashov * Only valid if "touch_byte" is valid and not zero. 159d170e8e0SNikolai Kondrashov */ 160caf7e934SNikolai Kondrashov __s8 touch_flip_at; 161caf7e934SNikolai Kondrashov /* 162caf7e934SNikolai Kondrashov * Maximum value of the touch ring/strip report around which the value 163caf7e934SNikolai Kondrashov * should be wrapped when flipping according to "touch_flip_at". 164caf7e934SNikolai Kondrashov * The minimum valid value is considered to be one, with zero being 165caf7e934SNikolai Kondrashov * out-of-proximity (finger lift) value. 166caf7e934SNikolai Kondrashov * Only valid if "touch_flip_at" is valid and not zero. 167caf7e934SNikolai Kondrashov */ 168caf7e934SNikolai Kondrashov __s8 touch_max; 1692112b49eSNikolai Kondrashov /* 1702112b49eSNikolai Kondrashov * Offset of the bitmap dial byte, in the report. Zero if not present. 1712112b49eSNikolai Kondrashov * Only valid if "id" is not zero. A bitmap dial sends reports with a 1722112b49eSNikolai Kondrashov * dedicated bit per direction: 1 means clockwise rotation, 2 means 1732112b49eSNikolai Kondrashov * counterclockwise, as opposed to the normal 1 and -1. 1742112b49eSNikolai Kondrashov */ 1752112b49eSNikolai Kondrashov unsigned int bitmap_dial_byte; 1769614219eSNikolai Kondrashov }; 1779614219eSNikolai Kondrashov 1789614219eSNikolai Kondrashov /* 1799614219eSNikolai Kondrashov * Tablet interface report parameters. 1809614219eSNikolai Kondrashov * 1819614219eSNikolai Kondrashov * Must use declarative (descriptive) language, not imperative, to simplify 1829614219eSNikolai Kondrashov * understanding and maintain consistency. 1839614219eSNikolai Kondrashov * 1849614219eSNikolai Kondrashov * When filled with zeros represents a "noop" configuration - passes all 1859614219eSNikolai Kondrashov * reports unchanged and lets the generic HID driver handle everything. 1869614219eSNikolai Kondrashov * 1879614219eSNikolai Kondrashov * The resulting device report descriptor is assembled from all the report 1889614219eSNikolai Kondrashov * descriptor parts referenced by the structure. No order of assembly should 1899614219eSNikolai Kondrashov * be assumed. The structure represents original device report descriptor if 1909614219eSNikolai Kondrashov * all the parts are NULL. 1919614219eSNikolai Kondrashov */ 1929614219eSNikolai Kondrashov struct uclogic_params { 1939614219eSNikolai Kondrashov /* 1949614219eSNikolai Kondrashov * True if the whole interface is invalid, false otherwise. 1959614219eSNikolai Kondrashov */ 1969614219eSNikolai Kondrashov bool invalid; 1979614219eSNikolai Kondrashov /* 1989614219eSNikolai Kondrashov * Pointer to the common part of the replacement report descriptor, 1999614219eSNikolai Kondrashov * allocated with kmalloc. NULL if no common part is needed. 2009614219eSNikolai Kondrashov * Only valid, if "invalid" is false. 2019614219eSNikolai Kondrashov */ 2029614219eSNikolai Kondrashov __u8 *desc_ptr; 2039614219eSNikolai Kondrashov /* 2049614219eSNikolai Kondrashov * Size of the common part of the replacement report descriptor. 20587dc28ebSNikolai Kondrashov * Only valid, if "desc_ptr" is valid and not NULL. 2069614219eSNikolai Kondrashov */ 2079614219eSNikolai Kondrashov unsigned int desc_size; 2089614219eSNikolai Kondrashov /* 2099614219eSNikolai Kondrashov * Pen parameters and optional report descriptor part. 210606dadc1SNikolai Kondrashov * Only valid, if "invalid" is false. 2119614219eSNikolai Kondrashov */ 2129614219eSNikolai Kondrashov struct uclogic_params_pen pen; 2139614219eSNikolai Kondrashov /* 214337fa051SNikolai Kondrashov * The list of frame control parameters and optional report descriptor 215337fa051SNikolai Kondrashov * parts. Only valid, if "invalid" is false. 2169614219eSNikolai Kondrashov */ 2173e200d6cSNikolai Kondrashov struct uclogic_params_frame frame_list[3]; 2189614219eSNikolai Kondrashov }; 2199614219eSNikolai Kondrashov 220*14b71e6aSJosé Expósito /* Driver data */ 221*14b71e6aSJosé Expósito struct uclogic_drvdata { 222*14b71e6aSJosé Expósito /* Interface parameters */ 223*14b71e6aSJosé Expósito struct uclogic_params params; 224*14b71e6aSJosé Expósito /* Pointer to the replacement report descriptor. NULL if none. */ 225*14b71e6aSJosé Expósito __u8 *desc_ptr; 226*14b71e6aSJosé Expósito /* 227*14b71e6aSJosé Expósito * Size of the replacement report descriptor. 228*14b71e6aSJosé Expósito * Only valid if desc_ptr is not NULL 229*14b71e6aSJosé Expósito */ 230*14b71e6aSJosé Expósito unsigned int desc_size; 231*14b71e6aSJosé Expósito /* Pen input device */ 232*14b71e6aSJosé Expósito struct input_dev *pen_input; 233*14b71e6aSJosé Expósito /* In-range timer */ 234*14b71e6aSJosé Expósito struct timer_list inrange_timer; 235*14b71e6aSJosé Expósito /* Last rotary encoder state, or U8_MAX for none */ 236*14b71e6aSJosé Expósito u8 re_state; 237*14b71e6aSJosé Expósito /* Device quirks */ 238*14b71e6aSJosé Expósito unsigned long quirks; 239*14b71e6aSJosé Expósito }; 240*14b71e6aSJosé Expósito 2419614219eSNikolai Kondrashov /* Initialize a tablet interface and discover its parameters */ 2429614219eSNikolai Kondrashov extern int uclogic_params_init(struct uclogic_params *params, 2439614219eSNikolai Kondrashov struct hid_device *hdev); 2449614219eSNikolai Kondrashov 2459614219eSNikolai Kondrashov /* Get a replacement report descriptor for a tablet's interface. */ 2469614219eSNikolai Kondrashov extern int uclogic_params_get_desc(const struct uclogic_params *params, 2479614219eSNikolai Kondrashov __u8 **pdesc, 2489614219eSNikolai Kondrashov unsigned int *psize); 2499614219eSNikolai Kondrashov 2509614219eSNikolai Kondrashov /* Free resources used by tablet interface's parameters */ 2519614219eSNikolai Kondrashov extern void uclogic_params_cleanup(struct uclogic_params *params); 2529614219eSNikolai Kondrashov 253a228809fSNikolai Kondrashov /* Dump tablet interface parameters with hid_dbg() */ 254a228809fSNikolai Kondrashov extern void uclogic_params_hid_dbg(const struct hid_device *hdev, 255a228809fSNikolai Kondrashov const struct uclogic_params *params); 256a228809fSNikolai Kondrashov 2579614219eSNikolai Kondrashov #endif /* _HID_UCLOGIC_PARAMS_H */ 258