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 */ 26ff0c13d6SNikolai Kondrashov extern __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 */ 30ff0c13d6SNikolai Kondrashov extern __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 */ 34ff0c13d6SNikolai Kondrashov extern __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 */ 44ff0c13d6SNikolai Kondrashov extern __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 */ 51ff0c13d6SNikolai Kondrashov extern __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) */ 60ff0c13d6SNikolai Kondrashov extern __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) */ 64ff0c13d6SNikolai Kondrashov extern __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) */ 68ff0c13d6SNikolai Kondrashov extern __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) */ 76ff0c13d6SNikolai Kondrashov extern __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) */ 80ff0c13d6SNikolai Kondrashov extern __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 */ 84*76e645beSJosé Expósito #define UCLOGIC_RDESC_PEN_PH_HEAD 0xFE, 0xED, 0x1D 85ff0c13d6SNikolai Kondrashov 86ff0c13d6SNikolai Kondrashov /* Apply report descriptor parameters to a report descriptor template */ 87ff0c13d6SNikolai Kondrashov extern __u8 *uclogic_rdesc_template_apply(const __u8 *template_ptr, 88ff0c13d6SNikolai Kondrashov size_t template_size, 89ff0c13d6SNikolai Kondrashov const s32 *param_list, 90ff0c13d6SNikolai Kondrashov size_t param_num); 91ff0c13d6SNikolai Kondrashov 92*76e645beSJosé Expósito /* Report descriptor template placeholder IDs */ 93*76e645beSJosé Expósito enum uclogic_rdesc_ph_id { 94ff0c13d6SNikolai Kondrashov UCLOGIC_RDESC_PEN_PH_ID_X_LM, 95ff0c13d6SNikolai Kondrashov UCLOGIC_RDESC_PEN_PH_ID_X_PM, 96ff0c13d6SNikolai Kondrashov UCLOGIC_RDESC_PEN_PH_ID_Y_LM, 97ff0c13d6SNikolai Kondrashov UCLOGIC_RDESC_PEN_PH_ID_Y_PM, 98ff0c13d6SNikolai Kondrashov UCLOGIC_RDESC_PEN_PH_ID_PRESSURE_LM, 99*76e645beSJosé Expósito UCLOGIC_RDESC_PH_ID_NUM 100ff0c13d6SNikolai Kondrashov }; 101ff0c13d6SNikolai Kondrashov 102ff0c13d6SNikolai Kondrashov /* Report descriptor pen template placeholder */ 103ff0c13d6SNikolai Kondrashov #define UCLOGIC_RDESC_PEN_PH(_ID) \ 104*76e645beSJosé Expósito UCLOGIC_RDESC_PEN_PH_HEAD, UCLOGIC_RDESC_PEN_PH_ID_##_ID 105ff0c13d6SNikolai Kondrashov 106eecb5b84SNikolai Kondrashov /* Report ID for v1 pen reports */ 107a985de58SNikolai Kondrashov #define UCLOGIC_RDESC_V1_PEN_ID 0x07 108ff0c13d6SNikolai Kondrashov 109eecb5b84SNikolai Kondrashov /* Fixed report descriptor template for (tweaked) v1 pen reports */ 110a985de58SNikolai Kondrashov extern const __u8 uclogic_rdesc_v1_pen_template_arr[]; 111a985de58SNikolai Kondrashov extern const size_t uclogic_rdesc_v1_pen_template_size; 112ff0c13d6SNikolai Kondrashov 1132c3a88c6SNikolai Kondrashov /* Report ID for v2 pen reports */ 114a985de58SNikolai Kondrashov #define UCLOGIC_RDESC_V2_PEN_ID 0x08 1152c3a88c6SNikolai Kondrashov 1162c3a88c6SNikolai Kondrashov /* Fixed report descriptor template for (tweaked) v2 pen reports */ 117a985de58SNikolai Kondrashov extern const __u8 uclogic_rdesc_v2_pen_template_arr[]; 118a985de58SNikolai Kondrashov extern const size_t uclogic_rdesc_v2_pen_template_size; 1192c3a88c6SNikolai Kondrashov 1202daaeff3SNikolai Kondrashov /* Report ID for tweaked v1 frame reports */ 1212daaeff3SNikolai Kondrashov #define UCLOGIC_RDESC_V1_FRAME_ID 0xf7 1222daaeff3SNikolai Kondrashov 1232e28f3e0SNikolai Kondrashov /* Fixed report descriptor for (tweaked) v1 frame reports */ 124a985de58SNikolai Kondrashov extern const __u8 uclogic_rdesc_v1_frame_arr[]; 125a985de58SNikolai Kondrashov extern const size_t uclogic_rdesc_v1_frame_size; 126ff0c13d6SNikolai Kondrashov 127c3e6e59aSNikolai Kondrashov /* Report ID for tweaked v2 frame button reports */ 128c3e6e59aSNikolai Kondrashov #define UCLOGIC_RDESC_V2_FRAME_BUTTONS_ID 0xf7 129ff0c13d6SNikolai Kondrashov 130c3e6e59aSNikolai Kondrashov /* Fixed report descriptor for (tweaked) v2 frame button reports */ 131c3e6e59aSNikolai Kondrashov extern const __u8 uclogic_rdesc_v2_frame_buttons_arr[]; 132c3e6e59aSNikolai Kondrashov extern const size_t uclogic_rdesc_v2_frame_buttons_size; 133c3e6e59aSNikolai Kondrashov 134caf7e934SNikolai Kondrashov /* Report ID for tweaked v2 frame touch ring/strip reports */ 135caf7e934SNikolai Kondrashov #define UCLOGIC_RDESC_V2_FRAME_TOUCH_ID 0xf8 136c3e6e59aSNikolai Kondrashov 137c3e6e59aSNikolai Kondrashov /* Fixed report descriptor for (tweaked) v2 frame touch ring reports */ 138c3e6e59aSNikolai Kondrashov extern const __u8 uclogic_rdesc_v2_frame_touch_ring_arr[]; 139c3e6e59aSNikolai Kondrashov extern const size_t uclogic_rdesc_v2_frame_touch_ring_size; 140c3e6e59aSNikolai Kondrashov 141118dfdeaSNikolai Kondrashov /* Fixed report descriptor for (tweaked) v2 frame touch strip reports */ 142118dfdeaSNikolai Kondrashov extern const __u8 uclogic_rdesc_v2_frame_touch_strip_arr[]; 143118dfdeaSNikolai Kondrashov extern const size_t uclogic_rdesc_v2_frame_touch_strip_size; 144118dfdeaSNikolai Kondrashov 145caf7e934SNikolai Kondrashov /* Device ID byte offset in v2 frame touch ring/strip reports */ 146caf7e934SNikolai Kondrashov #define UCLOGIC_RDESC_V2_FRAME_TOUCH_DEV_ID_BYTE 0x4 1472c3a88c6SNikolai Kondrashov 1486facd076SNikolai Kondrashov /* Report ID for tweaked v2 frame dial reports */ 1496facd076SNikolai Kondrashov #define UCLOGIC_RDESC_V2_FRAME_DIAL_ID 0xf9 1506facd076SNikolai Kondrashov 1516facd076SNikolai Kondrashov /* Fixed report descriptor for (tweaked) v2 frame dial reports */ 1526facd076SNikolai Kondrashov extern const __u8 uclogic_rdesc_v2_frame_dial_arr[]; 1536facd076SNikolai Kondrashov extern const size_t uclogic_rdesc_v2_frame_dial_size; 1546facd076SNikolai Kondrashov 1556facd076SNikolai Kondrashov /* Device ID byte offset in v2 frame dial reports */ 1566facd076SNikolai Kondrashov #define UCLOGIC_RDESC_V2_FRAME_DIAL_DEV_ID_BYTE 0x4 1576facd076SNikolai Kondrashov 1582e28f3e0SNikolai Kondrashov /* Fixed report descriptor for Ugee EX07 frame */ 1592e28f3e0SNikolai Kondrashov extern const __u8 uclogic_rdesc_ugee_ex07_frame_arr[]; 1602e28f3e0SNikolai Kondrashov extern const size_t uclogic_rdesc_ugee_ex07_frame_size; 1611ee7c685SNikolai Kondrashov 16208367be1SNikolai Kondrashov /* Fixed report descriptor for XP-Pen Deco 01 frame controls */ 16308367be1SNikolai Kondrashov extern const __u8 uclogic_rdesc_xppen_deco01_frame_arr[]; 16408367be1SNikolai Kondrashov extern const size_t uclogic_rdesc_xppen_deco01_frame_size; 16508367be1SNikolai Kondrashov 166e902ed93SNikolai Kondrashov /* Fixed report descriptor for Ugee G5 frame controls */ 167e902ed93SNikolai Kondrashov extern const __u8 uclogic_rdesc_ugee_g5_frame_arr[]; 168e902ed93SNikolai Kondrashov extern const size_t uclogic_rdesc_ugee_g5_frame_size; 169e902ed93SNikolai Kondrashov 170e902ed93SNikolai Kondrashov /* Report ID of Ugee G5 frame control reports */ 171e902ed93SNikolai Kondrashov #define UCLOGIC_RDESC_UGEE_G5_FRAME_ID 0x06 172e902ed93SNikolai Kondrashov 173e902ed93SNikolai Kondrashov /* Device ID byte offset in Ugee G5 frame report */ 174e902ed93SNikolai Kondrashov #define UCLOGIC_RDESC_UGEE_G5_FRAME_DEV_ID_BYTE 0x2 175e902ed93SNikolai Kondrashov 176e902ed93SNikolai Kondrashov /* Least-significant bit of Ugee G5 frame rotary encoder state */ 177e902ed93SNikolai Kondrashov #define UCLOGIC_RDESC_UGEE_G5_FRAME_RE_LSB 38 178e902ed93SNikolai Kondrashov 179ff0c13d6SNikolai Kondrashov #endif /* _HID_UCLOGIC_RDESC_H */ 180