1ff0c13d6SNikolai Kondrashov /* SPDX-License-Identifier: GPL-2.0+ */ 2ff0c13d6SNikolai Kondrashov /* 3ff0c13d6SNikolai Kondrashov * HID driver for UC-Logic devices not fully compliant with HID standard 4ff0c13d6SNikolai Kondrashov * - original and fixed report descriptors 5ff0c13d6SNikolai Kondrashov * 6ff0c13d6SNikolai Kondrashov * Copyright (c) 2010-2018 Nikolai Kondrashov 7ff0c13d6SNikolai Kondrashov * Copyright (c) 2013 Martin Rusko 8ff0c13d6SNikolai Kondrashov */ 9ff0c13d6SNikolai Kondrashov 10ff0c13d6SNikolai Kondrashov /* 11ff0c13d6SNikolai Kondrashov * This program is free software; you can redistribute it and/or modify it 12ff0c13d6SNikolai Kondrashov * under the terms of the GNU General Public License as published by the Free 13ff0c13d6SNikolai Kondrashov * Software Foundation; either version 2 of the License, or (at your option) 14ff0c13d6SNikolai Kondrashov * any later version. 15ff0c13d6SNikolai Kondrashov */ 16ff0c13d6SNikolai Kondrashov 17ff0c13d6SNikolai Kondrashov #ifndef _HID_UCLOGIC_RDESC_H 18ff0c13d6SNikolai Kondrashov #define _HID_UCLOGIC_RDESC_H 19ff0c13d6SNikolai Kondrashov 20ff0c13d6SNikolai Kondrashov #include <linux/usb.h> 21ff0c13d6SNikolai Kondrashov 22ff0c13d6SNikolai Kondrashov /* Size of the original descriptor of WPXXXXU tablets */ 23ff0c13d6SNikolai Kondrashov #define UCLOGIC_RDESC_WPXXXXU_ORIG_SIZE 212 24ff0c13d6SNikolai Kondrashov 25ff0c13d6SNikolai Kondrashov /* Fixed WP4030U report descriptor */ 26*03f8dc1dSThomas Weißschuh extern const __u8 uclogic_rdesc_wp4030u_fixed_arr[]; 27ff0c13d6SNikolai Kondrashov extern const size_t uclogic_rdesc_wp4030u_fixed_size; 28ff0c13d6SNikolai Kondrashov 29ff0c13d6SNikolai Kondrashov /* Fixed WP5540U report descriptor */ 30*03f8dc1dSThomas Weißschuh extern const __u8 uclogic_rdesc_wp5540u_fixed_arr[]; 31ff0c13d6SNikolai Kondrashov extern const size_t uclogic_rdesc_wp5540u_fixed_size; 32ff0c13d6SNikolai Kondrashov 33ff0c13d6SNikolai Kondrashov /* Fixed WP8060U report descriptor */ 34*03f8dc1dSThomas Weißschuh extern const __u8 uclogic_rdesc_wp8060u_fixed_arr[]; 35ff0c13d6SNikolai Kondrashov extern const size_t uclogic_rdesc_wp8060u_fixed_size; 36ff0c13d6SNikolai Kondrashov 379c17f735SNikolai Kondrashov /* Size of the original descriptor of the new WP5540U tablet */ 389c17f735SNikolai Kondrashov #define UCLOGIC_RDESC_WP5540U_V2_ORIG_SIZE 232 399c17f735SNikolai Kondrashov 40ff0c13d6SNikolai Kondrashov /* Size of the original descriptor of WP1062 tablet */ 41ff0c13d6SNikolai Kondrashov #define UCLOGIC_RDESC_WP1062_ORIG_SIZE 254 42ff0c13d6SNikolai Kondrashov 43ff0c13d6SNikolai Kondrashov /* Fixed WP1062 report descriptor */ 44*03f8dc1dSThomas Weißschuh extern const __u8 uclogic_rdesc_wp1062_fixed_arr[]; 45ff0c13d6SNikolai Kondrashov extern const size_t uclogic_rdesc_wp1062_fixed_size; 46ff0c13d6SNikolai Kondrashov 47ff0c13d6SNikolai Kondrashov /* Size of the original descriptor of PF1209 tablet */ 48ff0c13d6SNikolai Kondrashov #define UCLOGIC_RDESC_PF1209_ORIG_SIZE 234 49ff0c13d6SNikolai Kondrashov 50ff0c13d6SNikolai Kondrashov /* Fixed PF1209 report descriptor */ 51*03f8dc1dSThomas Weißschuh extern const __u8 uclogic_rdesc_pf1209_fixed_arr[]; 52ff0c13d6SNikolai Kondrashov extern const size_t uclogic_rdesc_pf1209_fixed_size; 53ff0c13d6SNikolai Kondrashov 54ff0c13d6SNikolai Kondrashov /* Size of the original descriptors of TWHL850 tablet */ 55ff0c13d6SNikolai Kondrashov #define UCLOGIC_RDESC_TWHL850_ORIG0_SIZE 182 56ff0c13d6SNikolai Kondrashov #define UCLOGIC_RDESC_TWHL850_ORIG1_SIZE 161 57ff0c13d6SNikolai Kondrashov #define UCLOGIC_RDESC_TWHL850_ORIG2_SIZE 92 58ff0c13d6SNikolai Kondrashov 59ff0c13d6SNikolai Kondrashov /* Fixed PID 0522 tablet report descriptor, interface 0 (stylus) */ 60*03f8dc1dSThomas Weißschuh extern const __u8 uclogic_rdesc_twhl850_fixed0_arr[]; 61ff0c13d6SNikolai Kondrashov extern const size_t uclogic_rdesc_twhl850_fixed0_size; 62ff0c13d6SNikolai Kondrashov 63ff0c13d6SNikolai Kondrashov /* Fixed PID 0522 tablet report descriptor, interface 1 (mouse) */ 64*03f8dc1dSThomas Weißschuh extern const __u8 uclogic_rdesc_twhl850_fixed1_arr[]; 65ff0c13d6SNikolai Kondrashov extern const size_t uclogic_rdesc_twhl850_fixed1_size; 66ff0c13d6SNikolai Kondrashov 67ff0c13d6SNikolai Kondrashov /* Fixed PID 0522 tablet report descriptor, interface 2 (frame buttons) */ 68*03f8dc1dSThomas Weißschuh extern const __u8 uclogic_rdesc_twhl850_fixed2_arr[]; 69ff0c13d6SNikolai Kondrashov extern const size_t uclogic_rdesc_twhl850_fixed2_size; 70ff0c13d6SNikolai Kondrashov 71ff0c13d6SNikolai Kondrashov /* Size of the original descriptors of TWHA60 tablet */ 72ff0c13d6SNikolai Kondrashov #define UCLOGIC_RDESC_TWHA60_ORIG0_SIZE 254 73ff0c13d6SNikolai Kondrashov #define UCLOGIC_RDESC_TWHA60_ORIG1_SIZE 139 74ff0c13d6SNikolai Kondrashov 75ff0c13d6SNikolai Kondrashov /* Fixed TWHA60 report descriptor, interface 0 (stylus) */ 76*03f8dc1dSThomas Weißschuh extern const __u8 uclogic_rdesc_twha60_fixed0_arr[]; 77ff0c13d6SNikolai Kondrashov extern const size_t uclogic_rdesc_twha60_fixed0_size; 78ff0c13d6SNikolai Kondrashov 79ff0c13d6SNikolai Kondrashov /* Fixed TWHA60 report descriptor, interface 1 (frame buttons) */ 80*03f8dc1dSThomas Weißschuh extern const __u8 uclogic_rdesc_twha60_fixed1_arr[]; 81ff0c13d6SNikolai Kondrashov extern const size_t uclogic_rdesc_twha60_fixed1_size; 82ff0c13d6SNikolai Kondrashov 83ff0c13d6SNikolai Kondrashov /* Report descriptor template placeholder head */ 8476e645beSJosé Expósito #define UCLOGIC_RDESC_PEN_PH_HEAD 0xFE, 0xED, 0x1D 85867c8925SJosé Expósito #define UCLOGIC_RDESC_FRAME_PH_BTN_HEAD 0xFE, 0xED 86ff0c13d6SNikolai Kondrashov 87ff0c13d6SNikolai Kondrashov /* Apply report descriptor parameters to a report descriptor template */ 88ff0c13d6SNikolai Kondrashov extern __u8 *uclogic_rdesc_template_apply(const __u8 *template_ptr, 89ff0c13d6SNikolai Kondrashov size_t template_size, 90ff0c13d6SNikolai Kondrashov const s32 *param_list, 91ff0c13d6SNikolai Kondrashov size_t param_num); 92ff0c13d6SNikolai Kondrashov 9376e645beSJosé Expósito /* Report descriptor template placeholder IDs */ 9476e645beSJosé Expósito enum uclogic_rdesc_ph_id { 95ff0c13d6SNikolai Kondrashov UCLOGIC_RDESC_PEN_PH_ID_X_LM, 96ff0c13d6SNikolai Kondrashov UCLOGIC_RDESC_PEN_PH_ID_X_PM, 97ff0c13d6SNikolai Kondrashov UCLOGIC_RDESC_PEN_PH_ID_Y_LM, 98ff0c13d6SNikolai Kondrashov UCLOGIC_RDESC_PEN_PH_ID_Y_PM, 99ff0c13d6SNikolai Kondrashov UCLOGIC_RDESC_PEN_PH_ID_PRESSURE_LM, 100867c8925SJosé Expósito UCLOGIC_RDESC_FRAME_PH_ID_UM, 10176e645beSJosé Expósito UCLOGIC_RDESC_PH_ID_NUM 102ff0c13d6SNikolai Kondrashov }; 103ff0c13d6SNikolai Kondrashov 104ff0c13d6SNikolai Kondrashov /* Report descriptor pen template placeholder */ 105ff0c13d6SNikolai Kondrashov #define UCLOGIC_RDESC_PEN_PH(_ID) \ 10676e645beSJosé Expósito UCLOGIC_RDESC_PEN_PH_HEAD, UCLOGIC_RDESC_PEN_PH_ID_##_ID 107ff0c13d6SNikolai Kondrashov 108867c8925SJosé Expósito /* Report descriptor frame buttons template placeholder */ 109867c8925SJosé Expósito #define UCLOGIC_RDESC_FRAME_PH_BTN \ 110867c8925SJosé Expósito UCLOGIC_RDESC_FRAME_PH_BTN_HEAD, UCLOGIC_RDESC_FRAME_PH_ID_UM 111867c8925SJosé Expósito 112eecb5b84SNikolai Kondrashov /* Report ID for v1 pen reports */ 113a985de58SNikolai Kondrashov #define UCLOGIC_RDESC_V1_PEN_ID 0x07 114ff0c13d6SNikolai Kondrashov 115eecb5b84SNikolai Kondrashov /* Fixed report descriptor template for (tweaked) v1 pen reports */ 116a985de58SNikolai Kondrashov extern const __u8 uclogic_rdesc_v1_pen_template_arr[]; 117a985de58SNikolai Kondrashov extern const size_t uclogic_rdesc_v1_pen_template_size; 118ff0c13d6SNikolai Kondrashov 1192c3a88c6SNikolai Kondrashov /* Report ID for v2 pen reports */ 120a985de58SNikolai Kondrashov #define UCLOGIC_RDESC_V2_PEN_ID 0x08 1212c3a88c6SNikolai Kondrashov 1222c3a88c6SNikolai Kondrashov /* Fixed report descriptor template for (tweaked) v2 pen reports */ 123a985de58SNikolai Kondrashov extern const __u8 uclogic_rdesc_v2_pen_template_arr[]; 124a985de58SNikolai Kondrashov extern const size_t uclogic_rdesc_v2_pen_template_size; 1252c3a88c6SNikolai Kondrashov 1262daaeff3SNikolai Kondrashov /* Report ID for tweaked v1 frame reports */ 1272daaeff3SNikolai Kondrashov #define UCLOGIC_RDESC_V1_FRAME_ID 0xf7 1282daaeff3SNikolai Kondrashov 1292e28f3e0SNikolai Kondrashov /* Fixed report descriptor for (tweaked) v1 frame reports */ 130a985de58SNikolai Kondrashov extern const __u8 uclogic_rdesc_v1_frame_arr[]; 131a985de58SNikolai Kondrashov extern const size_t uclogic_rdesc_v1_frame_size; 132ff0c13d6SNikolai Kondrashov 133c3e6e59aSNikolai Kondrashov /* Report ID for tweaked v2 frame button reports */ 134c3e6e59aSNikolai Kondrashov #define UCLOGIC_RDESC_V2_FRAME_BUTTONS_ID 0xf7 135ff0c13d6SNikolai Kondrashov 136c3e6e59aSNikolai Kondrashov /* Fixed report descriptor for (tweaked) v2 frame button reports */ 137c3e6e59aSNikolai Kondrashov extern const __u8 uclogic_rdesc_v2_frame_buttons_arr[]; 138c3e6e59aSNikolai Kondrashov extern const size_t uclogic_rdesc_v2_frame_buttons_size; 139c3e6e59aSNikolai Kondrashov 140caf7e934SNikolai Kondrashov /* Report ID for tweaked v2 frame touch ring/strip reports */ 141caf7e934SNikolai Kondrashov #define UCLOGIC_RDESC_V2_FRAME_TOUCH_ID 0xf8 142c3e6e59aSNikolai Kondrashov 143c3e6e59aSNikolai Kondrashov /* Fixed report descriptor for (tweaked) v2 frame touch ring reports */ 144c3e6e59aSNikolai Kondrashov extern const __u8 uclogic_rdesc_v2_frame_touch_ring_arr[]; 145c3e6e59aSNikolai Kondrashov extern const size_t uclogic_rdesc_v2_frame_touch_ring_size; 146c3e6e59aSNikolai Kondrashov 147118dfdeaSNikolai Kondrashov /* Fixed report descriptor for (tweaked) v2 frame touch strip reports */ 148118dfdeaSNikolai Kondrashov extern const __u8 uclogic_rdesc_v2_frame_touch_strip_arr[]; 149118dfdeaSNikolai Kondrashov extern const size_t uclogic_rdesc_v2_frame_touch_strip_size; 150118dfdeaSNikolai Kondrashov 151caf7e934SNikolai Kondrashov /* Device ID byte offset in v2 frame touch ring/strip reports */ 152caf7e934SNikolai Kondrashov #define UCLOGIC_RDESC_V2_FRAME_TOUCH_DEV_ID_BYTE 0x4 1532c3a88c6SNikolai Kondrashov 1546facd076SNikolai Kondrashov /* Report ID for tweaked v2 frame dial reports */ 1556facd076SNikolai Kondrashov #define UCLOGIC_RDESC_V2_FRAME_DIAL_ID 0xf9 1566facd076SNikolai Kondrashov 1576facd076SNikolai Kondrashov /* Fixed report descriptor for (tweaked) v2 frame dial reports */ 1586facd076SNikolai Kondrashov extern const __u8 uclogic_rdesc_v2_frame_dial_arr[]; 1596facd076SNikolai Kondrashov extern const size_t uclogic_rdesc_v2_frame_dial_size; 1606facd076SNikolai Kondrashov 1616facd076SNikolai Kondrashov /* Device ID byte offset in v2 frame dial reports */ 1626facd076SNikolai Kondrashov #define UCLOGIC_RDESC_V2_FRAME_DIAL_DEV_ID_BYTE 0x4 1636facd076SNikolai Kondrashov 164f9ce4db0SJosé Expósito /* Report ID for tweaked UGEE v2 battery reports */ 165f9ce4db0SJosé Expósito #define UCLOGIC_RDESC_UGEE_V2_BATTERY_ID 0xba 166f9ce4db0SJosé Expósito 167bd85c131SJosé Expósito /* Magic data expected by UGEEv2 devices on probe */ 168bd85c131SJosé Expósito extern const __u8 uclogic_ugee_v2_probe_arr[]; 169bd85c131SJosé Expósito extern const size_t uclogic_ugee_v2_probe_size; 170bd85c131SJosé Expósito extern const int uclogic_ugee_v2_probe_endpoint; 171bd85c131SJosé Expósito 1720cb1fc09SJosé Expósito /* Fixed report descriptor template for UGEE v2 pen reports */ 1730cb1fc09SJosé Expósito extern const __u8 uclogic_rdesc_ugee_v2_pen_template_arr[]; 1740cb1fc09SJosé Expósito extern const size_t uclogic_rdesc_ugee_v2_pen_template_size; 1750cb1fc09SJosé Expósito 1760cb1fc09SJosé Expósito /* Fixed report descriptor template for UGEE v2 frame reports (buttons only) */ 1770cb1fc09SJosé Expósito extern const __u8 uclogic_rdesc_ugee_v2_frame_btn_template_arr[]; 1780cb1fc09SJosé Expósito extern const size_t uclogic_rdesc_ugee_v2_frame_btn_template_size; 1790cb1fc09SJosé Expósito 180b67439d7SJosé Expósito /* Fixed report descriptor template for UGEE v2 frame reports (dial) */ 181b67439d7SJosé Expósito extern const __u8 uclogic_rdesc_ugee_v2_frame_dial_template_arr[]; 182b67439d7SJosé Expósito extern const size_t uclogic_rdesc_ugee_v2_frame_dial_template_size; 183b67439d7SJosé Expósito 184387dcab7SJosé Expósito /* Fixed report descriptor template for UGEE v2 frame reports (mouse) */ 185387dcab7SJosé Expósito extern const __u8 uclogic_rdesc_ugee_v2_frame_mouse_template_arr[]; 186387dcab7SJosé Expósito extern const size_t uclogic_rdesc_ugee_v2_frame_mouse_template_size; 187387dcab7SJosé Expósito 188f9ce4db0SJosé Expósito /* Fixed report descriptor template for UGEE v2 battery reports */ 189f9ce4db0SJosé Expósito extern const __u8 uclogic_rdesc_ugee_v2_battery_template_arr[]; 190f9ce4db0SJosé Expósito extern const size_t uclogic_rdesc_ugee_v2_battery_template_size; 191f9ce4db0SJosé Expósito 1922e28f3e0SNikolai Kondrashov /* Fixed report descriptor for Ugee EX07 frame */ 1932e28f3e0SNikolai Kondrashov extern const __u8 uclogic_rdesc_ugee_ex07_frame_arr[]; 1942e28f3e0SNikolai Kondrashov extern const size_t uclogic_rdesc_ugee_ex07_frame_size; 1951ee7c685SNikolai Kondrashov 19608367be1SNikolai Kondrashov /* Fixed report descriptor for XP-Pen Deco 01 frame controls */ 19708367be1SNikolai Kondrashov extern const __u8 uclogic_rdesc_xppen_deco01_frame_arr[]; 19808367be1SNikolai Kondrashov extern const size_t uclogic_rdesc_xppen_deco01_frame_size; 19908367be1SNikolai Kondrashov 200e902ed93SNikolai Kondrashov /* Fixed report descriptor for Ugee G5 frame controls */ 201e902ed93SNikolai Kondrashov extern const __u8 uclogic_rdesc_ugee_g5_frame_arr[]; 202e902ed93SNikolai Kondrashov extern const size_t uclogic_rdesc_ugee_g5_frame_size; 203e902ed93SNikolai Kondrashov 204e902ed93SNikolai Kondrashov /* Report ID of Ugee G5 frame control reports */ 205e902ed93SNikolai Kondrashov #define UCLOGIC_RDESC_UGEE_G5_FRAME_ID 0x06 206e902ed93SNikolai Kondrashov 207e902ed93SNikolai Kondrashov /* Device ID byte offset in Ugee G5 frame report */ 208e902ed93SNikolai Kondrashov #define UCLOGIC_RDESC_UGEE_G5_FRAME_DEV_ID_BYTE 0x2 209e902ed93SNikolai Kondrashov 210e902ed93SNikolai Kondrashov /* Least-significant bit of Ugee G5 frame rotary encoder state */ 211e902ed93SNikolai Kondrashov #define UCLOGIC_RDESC_UGEE_G5_FRAME_RE_LSB 38 212e902ed93SNikolai Kondrashov 213ff0c13d6SNikolai Kondrashov #endif /* _HID_UCLOGIC_RDESC_H */ 214