mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-15 23:25:07 +00:00
f9ce4db0ec
The XP-PEN Deco LW is a UGEE v2 device with a frame with 8 buttons. Its pen has 2 buttons, supports tilt and pressure. It can be connected by USB cable or using a USB Bluetooth dongle to use it in wireless mode. When it is connected using the dongle, the device battery is used to power it. Its vendor, product and version are identical to the Deco L. The only difference reported by its firmware is the product name. In order to add support for battery reporting, add a new HID descriptor and a quirk to detect the wireless version of the tablet. Link: https://github.com/DIGImend/digimend-kernel-drivers/issues/635 Tested-by: Mia Kanashi <chad@redpilled.dev> Tested-by: Andreas Grosse <andig.mail@t-online.de> Tested-by: Mia Kanashi <chad@redpilled.dev> Signed-off-by: José Expósito <jose.exposito89@gmail.com> Signed-off-by: Jiri Kosina <jkosina@suse.cz>
208 lines
7.7 KiB
C
208 lines
7.7 KiB
C
/* SPDX-License-Identifier: GPL-2.0+ */
|
|
/*
|
|
* HID driver for UC-Logic devices not fully compliant with HID standard
|
|
* - original and fixed report descriptors
|
|
*
|
|
* Copyright (c) 2010-2018 Nikolai Kondrashov
|
|
* Copyright (c) 2013 Martin Rusko
|
|
*/
|
|
|
|
/*
|
|
* This program is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License as published by the Free
|
|
* Software Foundation; either version 2 of the License, or (at your option)
|
|
* any later version.
|
|
*/
|
|
|
|
#ifndef _HID_UCLOGIC_RDESC_H
|
|
#define _HID_UCLOGIC_RDESC_H
|
|
|
|
#include <linux/usb.h>
|
|
|
|
/* Size of the original descriptor of WPXXXXU tablets */
|
|
#define UCLOGIC_RDESC_WPXXXXU_ORIG_SIZE 212
|
|
|
|
/* Fixed WP4030U report descriptor */
|
|
extern __u8 uclogic_rdesc_wp4030u_fixed_arr[];
|
|
extern const size_t uclogic_rdesc_wp4030u_fixed_size;
|
|
|
|
/* Fixed WP5540U report descriptor */
|
|
extern __u8 uclogic_rdesc_wp5540u_fixed_arr[];
|
|
extern const size_t uclogic_rdesc_wp5540u_fixed_size;
|
|
|
|
/* Fixed WP8060U report descriptor */
|
|
extern __u8 uclogic_rdesc_wp8060u_fixed_arr[];
|
|
extern const size_t uclogic_rdesc_wp8060u_fixed_size;
|
|
|
|
/* Size of the original descriptor of the new WP5540U tablet */
|
|
#define UCLOGIC_RDESC_WP5540U_V2_ORIG_SIZE 232
|
|
|
|
/* Size of the original descriptor of WP1062 tablet */
|
|
#define UCLOGIC_RDESC_WP1062_ORIG_SIZE 254
|
|
|
|
/* Fixed WP1062 report descriptor */
|
|
extern __u8 uclogic_rdesc_wp1062_fixed_arr[];
|
|
extern const size_t uclogic_rdesc_wp1062_fixed_size;
|
|
|
|
/* Size of the original descriptor of PF1209 tablet */
|
|
#define UCLOGIC_RDESC_PF1209_ORIG_SIZE 234
|
|
|
|
/* Fixed PF1209 report descriptor */
|
|
extern __u8 uclogic_rdesc_pf1209_fixed_arr[];
|
|
extern const size_t uclogic_rdesc_pf1209_fixed_size;
|
|
|
|
/* Size of the original descriptors of TWHL850 tablet */
|
|
#define UCLOGIC_RDESC_TWHL850_ORIG0_SIZE 182
|
|
#define UCLOGIC_RDESC_TWHL850_ORIG1_SIZE 161
|
|
#define UCLOGIC_RDESC_TWHL850_ORIG2_SIZE 92
|
|
|
|
/* Fixed PID 0522 tablet report descriptor, interface 0 (stylus) */
|
|
extern __u8 uclogic_rdesc_twhl850_fixed0_arr[];
|
|
extern const size_t uclogic_rdesc_twhl850_fixed0_size;
|
|
|
|
/* Fixed PID 0522 tablet report descriptor, interface 1 (mouse) */
|
|
extern __u8 uclogic_rdesc_twhl850_fixed1_arr[];
|
|
extern const size_t uclogic_rdesc_twhl850_fixed1_size;
|
|
|
|
/* Fixed PID 0522 tablet report descriptor, interface 2 (frame buttons) */
|
|
extern __u8 uclogic_rdesc_twhl850_fixed2_arr[];
|
|
extern const size_t uclogic_rdesc_twhl850_fixed2_size;
|
|
|
|
/* Size of the original descriptors of TWHA60 tablet */
|
|
#define UCLOGIC_RDESC_TWHA60_ORIG0_SIZE 254
|
|
#define UCLOGIC_RDESC_TWHA60_ORIG1_SIZE 139
|
|
|
|
/* Fixed TWHA60 report descriptor, interface 0 (stylus) */
|
|
extern __u8 uclogic_rdesc_twha60_fixed0_arr[];
|
|
extern const size_t uclogic_rdesc_twha60_fixed0_size;
|
|
|
|
/* Fixed TWHA60 report descriptor, interface 1 (frame buttons) */
|
|
extern __u8 uclogic_rdesc_twha60_fixed1_arr[];
|
|
extern const size_t uclogic_rdesc_twha60_fixed1_size;
|
|
|
|
/* Report descriptor template placeholder head */
|
|
#define UCLOGIC_RDESC_PEN_PH_HEAD 0xFE, 0xED, 0x1D
|
|
#define UCLOGIC_RDESC_FRAME_PH_BTN_HEAD 0xFE, 0xED
|
|
|
|
/* Apply report descriptor parameters to a report descriptor template */
|
|
extern __u8 *uclogic_rdesc_template_apply(const __u8 *template_ptr,
|
|
size_t template_size,
|
|
const s32 *param_list,
|
|
size_t param_num);
|
|
|
|
/* Report descriptor template placeholder IDs */
|
|
enum uclogic_rdesc_ph_id {
|
|
UCLOGIC_RDESC_PEN_PH_ID_X_LM,
|
|
UCLOGIC_RDESC_PEN_PH_ID_X_PM,
|
|
UCLOGIC_RDESC_PEN_PH_ID_Y_LM,
|
|
UCLOGIC_RDESC_PEN_PH_ID_Y_PM,
|
|
UCLOGIC_RDESC_PEN_PH_ID_PRESSURE_LM,
|
|
UCLOGIC_RDESC_FRAME_PH_ID_UM,
|
|
UCLOGIC_RDESC_PH_ID_NUM
|
|
};
|
|
|
|
/* Report descriptor pen template placeholder */
|
|
#define UCLOGIC_RDESC_PEN_PH(_ID) \
|
|
UCLOGIC_RDESC_PEN_PH_HEAD, UCLOGIC_RDESC_PEN_PH_ID_##_ID
|
|
|
|
/* Report descriptor frame buttons template placeholder */
|
|
#define UCLOGIC_RDESC_FRAME_PH_BTN \
|
|
UCLOGIC_RDESC_FRAME_PH_BTN_HEAD, UCLOGIC_RDESC_FRAME_PH_ID_UM
|
|
|
|
/* Report ID for v1 pen reports */
|
|
#define UCLOGIC_RDESC_V1_PEN_ID 0x07
|
|
|
|
/* Fixed report descriptor template for (tweaked) v1 pen reports */
|
|
extern const __u8 uclogic_rdesc_v1_pen_template_arr[];
|
|
extern const size_t uclogic_rdesc_v1_pen_template_size;
|
|
|
|
/* Report ID for v2 pen reports */
|
|
#define UCLOGIC_RDESC_V2_PEN_ID 0x08
|
|
|
|
/* Fixed report descriptor template for (tweaked) v2 pen reports */
|
|
extern const __u8 uclogic_rdesc_v2_pen_template_arr[];
|
|
extern const size_t uclogic_rdesc_v2_pen_template_size;
|
|
|
|
/* Report ID for tweaked v1 frame reports */
|
|
#define UCLOGIC_RDESC_V1_FRAME_ID 0xf7
|
|
|
|
/* Fixed report descriptor for (tweaked) v1 frame reports */
|
|
extern const __u8 uclogic_rdesc_v1_frame_arr[];
|
|
extern const size_t uclogic_rdesc_v1_frame_size;
|
|
|
|
/* Report ID for tweaked v2 frame button reports */
|
|
#define UCLOGIC_RDESC_V2_FRAME_BUTTONS_ID 0xf7
|
|
|
|
/* Fixed report descriptor for (tweaked) v2 frame button reports */
|
|
extern const __u8 uclogic_rdesc_v2_frame_buttons_arr[];
|
|
extern const size_t uclogic_rdesc_v2_frame_buttons_size;
|
|
|
|
/* Report ID for tweaked v2 frame touch ring/strip reports */
|
|
#define UCLOGIC_RDESC_V2_FRAME_TOUCH_ID 0xf8
|
|
|
|
/* Fixed report descriptor for (tweaked) v2 frame touch ring reports */
|
|
extern const __u8 uclogic_rdesc_v2_frame_touch_ring_arr[];
|
|
extern const size_t uclogic_rdesc_v2_frame_touch_ring_size;
|
|
|
|
/* Fixed report descriptor for (tweaked) v2 frame touch strip reports */
|
|
extern const __u8 uclogic_rdesc_v2_frame_touch_strip_arr[];
|
|
extern const size_t uclogic_rdesc_v2_frame_touch_strip_size;
|
|
|
|
/* Device ID byte offset in v2 frame touch ring/strip reports */
|
|
#define UCLOGIC_RDESC_V2_FRAME_TOUCH_DEV_ID_BYTE 0x4
|
|
|
|
/* Report ID for tweaked v2 frame dial reports */
|
|
#define UCLOGIC_RDESC_V2_FRAME_DIAL_ID 0xf9
|
|
|
|
/* Fixed report descriptor for (tweaked) v2 frame dial reports */
|
|
extern const __u8 uclogic_rdesc_v2_frame_dial_arr[];
|
|
extern const size_t uclogic_rdesc_v2_frame_dial_size;
|
|
|
|
/* Device ID byte offset in v2 frame dial reports */
|
|
#define UCLOGIC_RDESC_V2_FRAME_DIAL_DEV_ID_BYTE 0x4
|
|
|
|
/* Report ID for tweaked UGEE v2 battery reports */
|
|
#define UCLOGIC_RDESC_UGEE_V2_BATTERY_ID 0xba
|
|
|
|
/* Fixed report descriptor template for UGEE v2 pen reports */
|
|
extern const __u8 uclogic_rdesc_ugee_v2_pen_template_arr[];
|
|
extern const size_t uclogic_rdesc_ugee_v2_pen_template_size;
|
|
|
|
/* Fixed report descriptor template for UGEE v2 frame reports (buttons only) */
|
|
extern const __u8 uclogic_rdesc_ugee_v2_frame_btn_template_arr[];
|
|
extern const size_t uclogic_rdesc_ugee_v2_frame_btn_template_size;
|
|
|
|
/* Fixed report descriptor template for UGEE v2 frame reports (dial) */
|
|
extern const __u8 uclogic_rdesc_ugee_v2_frame_dial_template_arr[];
|
|
extern const size_t uclogic_rdesc_ugee_v2_frame_dial_template_size;
|
|
|
|
/* Fixed report descriptor template for UGEE v2 frame reports (mouse) */
|
|
extern const __u8 uclogic_rdesc_ugee_v2_frame_mouse_template_arr[];
|
|
extern const size_t uclogic_rdesc_ugee_v2_frame_mouse_template_size;
|
|
|
|
/* Fixed report descriptor template for UGEE v2 battery reports */
|
|
extern const __u8 uclogic_rdesc_ugee_v2_battery_template_arr[];
|
|
extern const size_t uclogic_rdesc_ugee_v2_battery_template_size;
|
|
|
|
/* Fixed report descriptor for Ugee EX07 frame */
|
|
extern const __u8 uclogic_rdesc_ugee_ex07_frame_arr[];
|
|
extern const size_t uclogic_rdesc_ugee_ex07_frame_size;
|
|
|
|
/* Fixed report descriptor for XP-Pen Deco 01 frame controls */
|
|
extern const __u8 uclogic_rdesc_xppen_deco01_frame_arr[];
|
|
extern const size_t uclogic_rdesc_xppen_deco01_frame_size;
|
|
|
|
/* Fixed report descriptor for Ugee G5 frame controls */
|
|
extern const __u8 uclogic_rdesc_ugee_g5_frame_arr[];
|
|
extern const size_t uclogic_rdesc_ugee_g5_frame_size;
|
|
|
|
/* Report ID of Ugee G5 frame control reports */
|
|
#define UCLOGIC_RDESC_UGEE_G5_FRAME_ID 0x06
|
|
|
|
/* Device ID byte offset in Ugee G5 frame report */
|
|
#define UCLOGIC_RDESC_UGEE_G5_FRAME_DEV_ID_BYTE 0x2
|
|
|
|
/* Least-significant bit of Ugee G5 frame rotary encoder state */
|
|
#define UCLOGIC_RDESC_UGEE_G5_FRAME_RE_LSB 38
|
|
|
|
#endif /* _HID_UCLOGIC_RDESC_H */
|