| Message ID | 2068502.VLH7GnMWUR@adrastea |
|---|---|
| State | New |
| Headers | show |
| Series | HID: uclogic: Add support for XP-PEN Artist 22R Pro | expand |
Hi Joshua,
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/Joshua-Goins/HID-uclogic-Add-support-for-XP-PEN-Artist-22R-Pro/20221226-112302
base: https://git.kernel.org/pub/scm/linux/kernel/git/hid/hid.git for-next
patch link: https://lore.kernel.org/r/2068502.VLH7GnMWUR%40adrastea
patch subject: [PATCH] HID: uclogic: Add support for XP-PEN Artist 22R Pro
config: i386-randconfig-m021-20221226
compiler: gcc-11 (Debian 11.3.0-8) 11.3.0
If you fix the issue, kindly add following tag where applicable
| Reported-by: kernel test robot <lkp@intel.com>
| Reported-by: Dan Carpenter <error27@gmail.com>
New smatch warnings:
drivers/hid/hid-uclogic-params.c:1453 uclogic_params_init_ugee_xppen_pro() warn: variable dereferenced before check 'hdev' (see line 1447)
drivers/hid/hid-uclogic-params.c:1454 uclogic_params_init_ugee_xppen_pro() warn: possible memory leak of 'buf'
drivers/hid/hid-uclogic-params.c:1492 uclogic_params_init_ugee_xppen_pro() error: double free of 'buf'
Old smatch warnings:
drivers/hid/hid-uclogic-params.c:1502 uclogic_params_init_ugee_xppen_pro() error: double free of 'buf'
vim +/hdev +1453 drivers/hid/hid-uclogic-params.c
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1436 static int uclogic_params_init_ugee_xppen_pro(struct hid_device *hdev,
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1437 struct uclogic_params *p,
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1438 const u8 probe_endpoint,
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1439 const u8 rdesc_init_packet[],
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1440 const size_t rdesc_init_size,
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1441 const u8 rdesc_tablet_arr[],
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1442 const size_t rdesc_tablet_size,
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1443 const u8 rdesc_frame_arr[],
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1444 const size_t rdesc_frame_size)
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1445 {
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1446 const size_t str_desc_len = 12;
51d8c9b14fc55dc Aren Villanueva 2022-12-25 @1447 struct usb_device *udev = hid_to_usb_dev(hdev);
^^^^
Dereference.
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1448 u8 *buf = kmemdup(rdesc_init_packet, rdesc_init_size, GFP_KERNEL);
Never put functions which can fail in the declaration block. This
allocation has no check for NULL (common problem when done in
declaration block).
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1449 s32 desc_params[UCLOGIC_RDESC_PH_ID_NUM];
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1450 int actual_len, rc;
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1451 u16 resolution;
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1452
51d8c9b14fc55dc Aren Villanueva 2022-12-25 @1453 if (hdev == NULL || p == NULL)
^^^^^^^^^^^^
Checked to late.
51d8c9b14fc55dc Aren Villanueva 2022-12-25 @1454 return -EINVAL;
Needs a kfree(buf);
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1455
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1456 rc = usb_interrupt_msg(
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1457 udev,
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1458 usb_sndintpipe(udev, probe_endpoint),
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1459 buf,
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1460 rdesc_init_size,
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1461 &actual_len,
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1462 USB_CTRL_SET_TIMEOUT);
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1463 kfree(buf);
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1464 if (rc == -EPIPE) {
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1465 hid_err(hdev, "broken pipe sending init packet\n");
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1466 return rc;
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1467 } else if (rc < 0) {
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1468 hid_err(hdev, "failed sending init packet: %d\n", rc);
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1469 return rc;
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1470 } else if (actual_len != rdesc_init_size) {
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1471 hid_err(hdev,
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1472 "failed to transfer complete init packet, only %d bytes sent\n",
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1473 actual_len);
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1474 return -1;
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1475 }
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1476
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1477 rc = uclogic_params_get_str_desc(&buf, hdev, 100, str_desc_len);
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1478 if (rc != str_desc_len) {
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1479 if (rc == -EPIPE) {
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1480 hid_err(hdev,
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1481 "string descriptor with pen parameters not found\n");
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1482 } else if (rc < 0) {
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1483 hid_err(hdev,
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1484 "failed retrieving pen parameters: %d\n", rc);
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1485 } else {
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1486 hid_err(hdev,
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1487 "string descriptor with pen parameters has invalid length (got %d, expected %lu)\n",
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1488 rc,
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1489 str_desc_len);
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1490 rc = -1;
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1491 }
51d8c9b14fc55dc Aren Villanueva 2022-12-25 @1492 kfree(buf);
If uclogic_params_get_str_desc() fails then this is a double free.
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1493 return rc;
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1494 }
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1495
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1496 desc_params[UCLOGIC_RDESC_PEN_PH_ID_X_LM] = get_unaligned_le16(buf + 2);
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1497 desc_params[UCLOGIC_RDESC_PEN_PH_ID_Y_LM] = get_unaligned_le16(buf + 4);
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1498 /* buf + 6 is the number of pad buttons? Its 0x0008 */
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1499 desc_params[UCLOGIC_RDESC_PEN_PH_ID_PRESSURE_LM] =
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1500 get_unaligned_le16(buf + 8);
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1501 resolution = get_unaligned_le16(buf + 10);
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1502 kfree(buf);
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1503 if (resolution == 0) {
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1504 hid_err(hdev, "resolution of 0 in descriptor string\n");
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1505 return -1;
51d8c9b14fc55dc Aren Villanueva 2022-12-25 1506 }
Hi Joshua, Thanks a lot for your patch! It might cause conflicts with [1] and [2], so we'll need to rebase on top of each other work at some point. [1] https://lore.kernel.org/linux-input/20221226123456.14822-1-jose.exposito89@gmail.com/T/ [2] https://lore.kernel.org/linux-input/20221226125454.16106-1-jose.exposito89@gmail.com/T/ > From: Aren Villanueva <kurikaesu@users.noreply.github.com> > > Adds support for the XP-PEN Artist 22R Pro in uclogic, including the stylus, > frame and pen pressure support. > > I did not do the research for this hardware, or the original patch - that work > has been done by Aren Villanueva. For some reason they decided not to merge > it. My changes include remapping the stupid amount of tablet frame buttons, > cleaning up the code to match kernel style, and other small stuff. > > The tablet is (almost) fully functional even when uclogic doesn't handle it. > Without initialization, the tablet has some sort of "basic driverless mode" > that allows the tablet frame buttons to have some default keys associated with > them (CTRL-S, CTRL-Z, that kind of stuff), but unfortunately the stylus pen > semi-works. While pressure sensitivity works, only one stylus button functions > correctly. Since the initialization process differs for Pro series tablets, the > new function uclogic_params_init_ugee_xppen_pro had to be introduced. I also > added USB HID IDs for this tablet too, but it's classified under the UGEE > vendor ID. > > One of the more strange things I had to do is figure out a way to remap the > buttons since there are 20 of them in total, and of course there are more > buttons than there are BTN constants defined for us. When running without > uclogic, it starts at BTN_0, ends at BTN_8 and the tablet starts reporting > nonsensical keycodes so just leaving it alone isn't an option. I'm testing > this under a libinput system, which has a list of buttons it considers "tablet > pad buttons" which are notably BTN_0, BTN_1, so on and some > gamepad/joystick buttons. So I created a new array called > uclogic_extra_input_mapping for 20 working inputs. > > Another weird feature of this tablet is the second dial, which the original > patchset introduced a new uclogic_frame param to handle since it seems it > throws both dials values into one byte. The left wheel is considered EV_WHEEL > and the other, EV_HWHEEL which seems fine to me. I also added the new param to > the debug messages too. > > Link: https://github.com/DIGImend/digimend-kernel-drivers/pull/557 > Signed-off-by: Joshua Goins <josh@redstrate.com> > --- > drivers/hid/hid-ids.h | 1 + > drivers/hid/hid-uclogic-core.c | 68 +++++++++++++- > drivers/hid/hid-uclogic-params.c | 147 +++++++++++++++++++++++++++++++ > drivers/hid/hid-uclogic-params.h | 5 ++ > drivers/hid/hid-uclogic-rdesc.c | 119 +++++++++++++++++++++++++ > drivers/hid/hid-uclogic-rdesc.h | 15 ++++ > 6 files changed, 351 insertions(+), 4 deletions(-) > > diff --git a/drivers/hid/hid-ids.h b/drivers/hid/hid-ids.h > index 82713ef3aaa6..81d04054229a 100644 > --- a/drivers/hid/hid-ids.h > +++ b/drivers/hid/hid-ids.h > @@ -1298,6 +1298,7 @@ > #define USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO_L 0x0935 > #define USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO_PRO_S 0x0909 > #define USB_DEVICE_ID_UGEE_XPPEN_TABLET_STAR06 0x0078 > +#define USB_DEVICE_ID_UGEE_XPPEN_TABLET_22R_PRO 0x091b > #define USB_DEVICE_ID_UGEE_TABLET_G5 0x0074 > #define USB_DEVICE_ID_UGEE_TABLET_EX07S 0x0071 > #define USB_DEVICE_ID_UGEE_TABLET_RAINBOW_CV720 0x0055 > diff --git a/drivers/hid/hid-uclogic-core.c b/drivers/hid/hid-uclogic-core.c > index 7fa6fe04f1b2..ebc93b354f7a 100644 > --- a/drivers/hid/hid-uclogic-core.c > +++ b/drivers/hid/hid-uclogic-core.c > @@ -81,6 +81,30 @@ static __u8 *uclogic_report_fixup(struct hid_device *hdev, __u8 *rdesc, > return rdesc; > } > > +/* Buttons considered valid tablet pad inputs. */ > +const unsigned int uclogic_extra_input_mapping[] = { Sparse nitpick: "uclogic_extra_input_mapping" can be made static. > + BTN_0, > + BTN_1, > + BTN_2, > + BTN_3, > + BTN_4, > + BTN_5, > + BTN_6, > + BTN_7, > + BTN_8, > + BTN_RIGHT, > + BTN_MIDDLE, > + BTN_SIDE, > + BTN_EXTRA, > + BTN_FORWARD, > + BTN_BACK, > + BTN_B, > + BTN_A, > + BTN_BASE, > + BTN_BASE2, > + BTN_X > +}; > + > static int uclogic_input_mapping(struct hid_device *hdev, > struct hid_input *hi, > struct hid_field *field, > @@ -91,9 +115,27 @@ static int uclogic_input_mapping(struct hid_device *hdev, > struct uclogic_drvdata *drvdata = hid_get_drvdata(hdev); > struct uclogic_params *params = &drvdata->params; > > - /* Discard invalid pen usages */ > - if (params->pen.usage_invalid && (field->application == HID_DG_PEN)) > - return -1; > + if (field->application == HID_GD_KEYPAD) { > + /* > + * Remap input buttons to sensible ones that are not invalid. > + * This only affects previous behavior for devices with more than ten or so buttons. > + */ > + const int key = (usage->hid & HID_USAGE) - 1; > + > + if (key > 0 && key < ARRAY_SIZE(uclogic_extra_input_mapping)) { > + hid_map_usage(hi, > + usage, > + bit, > + max, > + EV_KEY, > + uclogic_extra_input_mapping[key]); > + return 1; > + } > + } else if (field->application == HID_DG_PEN) { > + /* Discard invalid pen usages */ > + if (params->pen.usage_invalid) > + return -1; > + } > > /* Let hid-core decide what to do */ > return 0; > @@ -403,8 +445,24 @@ static int uclogic_raw_event_frame( > > /* If need to, and can, transform the bitmap dial reports */ > if (frame->bitmap_dial_byte > 0 && frame->bitmap_dial_byte < size) { > - if (data[frame->bitmap_dial_byte] == 2) > + switch (data[frame->bitmap_dial_byte]) { > + case 2: > data[frame->bitmap_dial_byte] = -1; > + break; > + > + /* Everything below here is for tablets that shove multiple dials into 1 byte */ > + case 4: > + case 0x10: > + data[frame->bitmap_dial_byte] = 0; > + data[frame->bitmap_second_dial_destination_byte] = 1; > + break; > + > + case 8: > + case 0x20: > + data[frame->bitmap_dial_byte] = 0; > + data[frame->bitmap_second_dial_destination_byte] = -1; > + break; > + } Is it possible to receive a report with information from both dials at the same time? I'm asking because I'm trying to understand what is the meaning of the 0x10 and 0x20 values and I wonder if they are generated when both dials are used at the same time. > } > > return 0; > @@ -531,6 +589,8 @@ static const struct hid_device_id uclogic_devices[] = { > USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO_PRO_S) }, > { HID_USB_DEVICE(USB_VENDOR_ID_UGEE, > USB_DEVICE_ID_UGEE_XPPEN_TABLET_STAR06) }, > + { HID_USB_DEVICE(USB_VENDOR_ID_UGEE, > + USB_DEVICE_ID_UGEE_XPPEN_TABLET_22R_PRO) }, > { } > }; > MODULE_DEVICE_TABLE(hid, uclogic_devices); > diff --git a/drivers/hid/hid-uclogic-params.c b/drivers/hid/hid-uclogic-params.c > index cd1233d7e253..86a1dfa2a4c0 100644 > --- a/drivers/hid/hid-uclogic-params.c > +++ b/drivers/hid/hid-uclogic-params.c > @@ -103,6 +103,8 @@ static void uclogic_params_frame_hid_dbg( > frame->touch_flip_at); > hid_dbg(hdev, "\t\t.bitmap_dial_byte = %u\n", > frame->bitmap_dial_byte); > + hid_dbg(hdev, "\t\t.bitmap_second_dial_destination_byte = %u\n", > + frame->bitmap_second_dial_destination_byte); > } > > /** > @@ -1418,6 +1420,126 @@ static int uclogic_params_ugee_v2_init(struct uclogic_params *params, > return rc; > } > > + > +/* > + * uclogic_params_init_ugee_xppen_pro() - Initializes a UGEE XP-Pen Pro tablet device. > + * > + * @hdev: The HID device of the tablet interface to initialize and get > + * parameters from. Cannot be NULL. > + * @params: Parameters to fill in (to be cleaned with > + * uclogic_params_cleanup()). Not modified in case of error. > + * Cannot be NULL. > + * > + * Returns: > + * Zero, if successful. A negative errno code on error. > + */ > +static int uclogic_params_init_ugee_xppen_pro(struct hid_device *hdev, You can probably reuse uclogic_params_ugee_v2_init() or at least reuse uclogic_probe_interface() and uclogic_params_parse_ugee_v2_desc() if for some reason we need custom logic for this tablet. > + struct uclogic_params *p, > + const u8 probe_endpoint, > + const u8 rdesc_init_packet[], > + const size_t rdesc_init_size, > + const u8 rdesc_tablet_arr[], > + const size_t rdesc_tablet_size, > + const u8 rdesc_frame_arr[], > + const size_t rdesc_frame_size) > +{ > + const size_t str_desc_len = 12; > + struct usb_device *udev = hid_to_usb_dev(hdev); > + u8 *buf = kmemdup(rdesc_init_packet, rdesc_init_size, GFP_KERNEL); > + s32 desc_params[UCLOGIC_RDESC_PH_ID_NUM]; > + int actual_len, rc; > + u16 resolution; > + > + if (hdev == NULL || p == NULL) > + return -EINVAL; > + > + rc = usb_interrupt_msg( > + udev, > + usb_sndintpipe(udev, probe_endpoint), > + buf, > + rdesc_init_size, > + &actual_len, > + USB_CTRL_SET_TIMEOUT); > + kfree(buf); > + if (rc == -EPIPE) { > + hid_err(hdev, "broken pipe sending init packet\n"); > + return rc; > + } else if (rc < 0) { > + hid_err(hdev, "failed sending init packet: %d\n", rc); > + return rc; > + } else if (actual_len != rdesc_init_size) { > + hid_err(hdev, > + "failed to transfer complete init packet, only %d bytes sent\n", > + actual_len); > + return -1; > + } > + > + rc = uclogic_params_get_str_desc(&buf, hdev, 100, str_desc_len); > + if (rc != str_desc_len) { > + if (rc == -EPIPE) { > + hid_err(hdev, > + "string descriptor with pen parameters not found\n"); > + } else if (rc < 0) { > + hid_err(hdev, > + "failed retrieving pen parameters: %d\n", rc); > + } else { > + hid_err(hdev, > + "string descriptor with pen parameters has invalid length (got %d, expected %lu)\n", > + rc, > + str_desc_len); > + rc = -1; > + } > + kfree(buf); > + return rc; > + } > + > + desc_params[UCLOGIC_RDESC_PEN_PH_ID_X_LM] = get_unaligned_le16(buf + 2); > + desc_params[UCLOGIC_RDESC_PEN_PH_ID_Y_LM] = get_unaligned_le16(buf + 4); > + /* buf + 6 is the number of pad buttons? Its 0x0008 */ Is this value 8? In all the models I have seen so far this is indeed the number of buttons. Also, what's the value of buf[6]? As you can see in uclogic_params_parse_ugee_v2_desc(), this field is the frame type. I'd be nice to know whether a different frame type is reported when 2 dials are present or not. Could you attach the contents of the 14 bytes of "buf", please? I'd be nice to have a look and see if we can reuse as much code as possible. > + desc_params[UCLOGIC_RDESC_PEN_PH_ID_PRESSURE_LM] = > + get_unaligned_le16(buf + 8); > + resolution = get_unaligned_le16(buf + 10); > + kfree(buf); > + if (resolution == 0) { > + hid_err(hdev, "resolution of 0 in descriptor string\n"); > + return -1; > + } > + desc_params[UCLOGIC_RDESC_PEN_PH_ID_X_PM] = > + desc_params[UCLOGIC_RDESC_PEN_PH_ID_X_LM] * 1000 / resolution; > + desc_params[UCLOGIC_RDESC_PEN_PH_ID_Y_PM] = > + desc_params[UCLOGIC_RDESC_PEN_PH_ID_Y_LM] * 1000 / resolution; > + > + hid_dbg(hdev, > + "Received parameters: X: %d Y: %d Pressure: %d Resolution: %u\n", > + desc_params[UCLOGIC_RDESC_PEN_PH_ID_X_LM], > + desc_params[UCLOGIC_RDESC_PEN_PH_ID_Y_LM], > + desc_params[UCLOGIC_RDESC_PEN_PH_ID_PRESSURE_LM], > + resolution); > + > + p->pen.desc_ptr = uclogic_rdesc_template_apply( > + rdesc_tablet_arr, > + rdesc_tablet_size, > + desc_params, > + ARRAY_SIZE(desc_params)); > + p->pen.desc_size = rdesc_tablet_size; > + p->pen.id = 0x02; > + > + rc = uclogic_params_frame_init_with_desc( > + &p->frame_list[0], > + rdesc_frame_arr, > + rdesc_frame_size, > + UCLOGIC_RDESC_V1_FRAME_ID); > + if (rc < 0) { > + hid_err(hdev, "initializing frame params failed: %d\n", rc); > + return rc; > + } > + > + p->pen.subreport_list[0].value = 0xf0; > + p->pen.subreport_list[0].id = p->frame_list[0].id; > + > + return 0; > +} > + > /** > * uclogic_params_init() - initialize a tablet interface and discover its > * parameters. > @@ -1728,6 +1850,31 @@ int uclogic_params_init(struct uclogic_params *params, > uclogic_params_init_invalid(&p); > } > > + break; > + case VID_PID(USB_VENDOR_ID_UGEE, > + USB_DEVICE_ID_UGEE_XPPEN_TABLET_22R_PRO): Ideally, we should be able to handle this tablet with the other UGEE v2 tablets. > + /* Ignore non-pen interfaces */ > + if (bInterfaceNumber != 2) { > + uclogic_params_init_invalid(&p); > + break; > + } > + > + rc = uclogic_params_init_ugee_xppen_pro( > + hdev, &p, UCLOGIC_RDESC_UGEE_XPPEN_PROBE_ENDPOINT_TYPE1, > + uclogic_rdesc_xppen_init_packet_type1_arr, > + uclogic_rdesc_xppen_init_packet_type1_size, > + uclogic_rdesc_xppen_pro_stylus_type1_arr, > + uclogic_rdesc_xppen_pro_stylus_type1_size, > + uclogic_rdesc_xppen_artist_22r_pro_frame_arr, > + uclogic_rdesc_xppen_artist_22r_pro_frame_size); > + if (rc != 0) { > + hid_err(hdev, "failed creating frame parameters: %d\n", rc); > + goto cleanup; > + } > + > + p.frame_list[0].bitmap_dial_byte = 7; > + p.frame_list[0].bitmap_second_dial_destination_byte = 8; > + > break; > } > > diff --git a/drivers/hid/hid-uclogic-params.h b/drivers/hid/hid-uclogic-params.h > index a97477c02ff8..6621a75a4b1a 100644 > --- a/drivers/hid/hid-uclogic-params.h > +++ b/drivers/hid/hid-uclogic-params.h > @@ -171,6 +171,11 @@ struct uclogic_params_frame { > * counterclockwise, as opposed to the normal 1 and -1. > */ > unsigned int bitmap_dial_byte; > + /* > + * Destination offset for the second bitmap dial byte, if the tablet > + * supports a second dial at all. > + */ > + unsigned int bitmap_second_dial_destination_byte; > }; > > /* > diff --git a/drivers/hid/hid-uclogic-rdesc.c b/drivers/hid/hid-uclogic-rdesc.c > index fb40775f5f5b..b55dbe5017c1 100644 > --- a/drivers/hid/hid-uclogic-rdesc.c > +++ b/drivers/hid/hid-uclogic-rdesc.c > @@ -1185,6 +1185,125 @@ const __u8 uclogic_rdesc_xppen_deco01_frame_arr[] = { > const size_t uclogic_rdesc_xppen_deco01_frame_size = > sizeof(uclogic_rdesc_xppen_deco01_frame_arr); > > +/* Fix report descriptor for XP-Pen init packet type 1 */ > +const __u8 uclogic_rdesc_xppen_init_packet_type1_arr[] = { > + 0x02, 0xb0, 0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 > +}; This array is already declared in uclogic_params_ugee_v2_init(), which, hopefully, we will be able to reuse. Otherwise, you might be interested in this commit (not merged yet): https://lore.kernel.org/linux-input/20221226125454.16106-4-jose.exposito89@gmail.com/T/#u > + > +const size_t uclogic_rdesc_xppen_init_packet_type1_size = > + sizeof(uclogic_rdesc_xppen_init_packet_type1_arr); > + > +/* Fixed report descriptor for XP-Pen Pro Stylus type 1 (10 bytes) */ > +const __u8 uclogic_rdesc_xppen_pro_stylus_type1_arr[] = { Can't "uclogic_rdesc_ugee_v2_pen_template_arr" be used instead? > + 0x05, 0x0D, /* Usage Page (Digitizer), */ > + 0x09, 0x02, /* Usage (Pen), */ > + 0xA1, 0x01, /* Collection (Application), */ > + 0x85, 0x02, /* Report ID (2), */ > + 0x09, 0x20, /* Usage (Stylus), */ > + 0xA0, /* Collection (Physical), */ > + 0x14, /* Logical Minimum (0), */ > + 0x25, 0x01, /* Logical Maximum (1), */ > + 0x09, 0x42, /* Usage (Tip Switch), */ > + 0x09, 0x44, /* Usage (Barrel Switch), */ > + 0x09, 0x46, /* Usage (Tablet Pick), */ > + 0x75, 0x01, /* Report Size (1), */ > + 0x95, 0x03, /* Report Count (3), */ > + 0x81, 0x02, /* Input (Variable), */ > + 0x95, 0x02, /* Report Count (2), */ > + 0x81, 0x01, /* Input (Constant), */ > + 0x09, 0x32, /* Usage (In Range), */ > + 0x95, 0x01, /* Report Count (1), */ > + 0x81, 0x02, /* Input (Variable), */ > + 0x95, 0x02, /* Report Count (2), */ > + 0x81, 0x01, /* Input (Constant), */ > + 0x75, 0x10, /* Report Size (16), */ > + 0x95, 0x01, /* Report Count (1), */ > + 0xA4, /* Push, */ > + 0x05, 0x01, /* Usage Page (Desktop), */ > + 0x55, 0xFD, /* Unit Exponent (-3), */ > + 0x65, 0x13, /* Unit (Inch), */ > + 0x34, /* Physical Minimum (0), */ > + 0x09, 0x30, /* Usage (X), */ > + 0x27, UCLOGIC_RDESC_PEN_PH(X_LM), > + /* Logical Maximum (PLACEHOLDER), */ > + 0x47, UCLOGIC_RDESC_PEN_PH(X_PM), > + /* Physical Maximum (PLACEHOLDER), */ > + 0x81, 0x02, /* Input (Variable), */ > + 0x09, 0x31, /* Usage (Y), */ > + 0x27, UCLOGIC_RDESC_PEN_PH(Y_LM), > + /* Logical Maximum (PLACEHOLDER), */ > + 0x47, UCLOGIC_RDESC_PEN_PH(Y_PM), > + /* Physical Maximum (PLACEHOLDER), */ > + 0x81, 0x02, /* Input (Variable), */ > + 0xB4, /* Pop, */ > + 0x09, 0x30, /* Usage (Tip Pressure), */ > + 0x27, UCLOGIC_RDESC_PEN_PH(PRESSURE_LM), > + /* Logical Maximum (PLACEHOLDER), */ > + 0x81, 0x02, /* Input (Variable), */ > + 0xA4, /* Push, */ > + 0x54, /* Unit Exponent (0), */ > + 0x65, 0x14, /* Unit (Degrees), */ > + 0x35, 0xC3, /* Physical Minimum (-61), */ > + 0x45, 0x3C, /* Physical Maximum (60), */ > + 0x15, 0xC3, /* Logical Minimum (-61), */ > + 0x25, 0x3C, /* Logical Maximum (60), */ > + 0x75, 0x08, /* Report Size (8), */ > + 0x95, 0x02, /* Report Count (2), */ > + 0x09, 0x3D, /* Usage (X Tilt), */ > + 0x09, 0x3E, /* Usage (Y Tilt), */ > + 0x81, 0x02, /* Input (Variable), */ > + 0xB4, /* Pop, */ > + 0xC0, /* End Collection, */ > + 0xC0 /* End Collection */ > +}; > + > +const size_t uclogic_rdesc_xppen_pro_stylus_type1_size = > + sizeof(uclogic_rdesc_xppen_pro_stylus_type1_arr); > + > +/* Fixed report descriptor for XP-Pen Arist 22R Pro frame */ > +const __u8 uclogic_rdesc_xppen_artist_22r_pro_frame_arr[] = { Have a look to "uclogic_rdesc_ugee_v2_frame_dial_template_arr", I don't know if it could be used for your tablet. > + 0x05, 0x01, /* Usage Page (Desktop), */ > + 0x09, 0x07, /* Usage (Keypad), */ > + 0xA1, 0x01, /* Collection (Application), */ > + 0x85, UCLOGIC_RDESC_V1_FRAME_ID, > + /* Report ID (Virtual report), */ > + 0x05, 0x0D, /* Usage Page (Digitizer), */ > + 0x09, 0x39, /* Usage (Tablet Function Keys), */ > + 0xA0, /* Collection (Physical), */ > + 0x14, /* Logical Minimum (0), */ > + 0x25, 0x01, /* Logical Maximum (1), */ > + 0x75, 0x01, /* Report Size (1), */ > + 0x95, 0x08, /* Report Count (8), */ > + 0x81, 0x01, /* Input (Constant), */ > + 0x05, 0x09, /* Usage Page (Button), */ > + 0x19, 0x01, /* Usage Minimum (01h), */ > + 0x29, 0x14, /* Usage Maximum (14h), */ If your tablet reports its number of buttons, UCLOGIC_RDESC_FRAME_PH_BTN can be used here. > + 0x95, 0x14, /* Report Count (20), */ > + 0x81, 0x02, /* Input (Variable), */ > + 0x95, 0x14, /* Report Count (20), */ > + 0x81, 0x01, /* Input (Constant), */ > + 0x05, 0x01, /* Usage Page (Desktop), */ > + 0x09, 0x38, /* Usage (Wheel), */ > + 0x75, 0x08, /* Report Size (8), */ > + 0x95, 0x01, /* Report Count (1), */ > + 0x15, 0xFF, /* Logical Minimum (-1), */ > + 0x25, 0x08, /* Logical Maximum (8), */ > + 0x81, 0x06, /* Input (Variable, Relative), */ > + 0x05, 0x0C, /* Usage Page (Consumer Devices), */ > + 0x0A, 0x38, 0x02, /* Usage (AC PAN), */ > + 0x95, 0x01, /* Report Count (1), */ > + 0x81, 0x06, /* Input (Variable, Relative), */ > + 0x26, 0xFF, 0x00, /* Logical Maximum (255), */ > + 0x75, 0x08, /* Report Size (8), */ > + 0x95, 0x01, /* Report Count (1), */ > + 0x81, 0x02, /* Input (Variable), */ > + 0xC0, /* End Collection */ > + 0xC0, /* End Collection */ > +}; > + > +const size_t uclogic_rdesc_xppen_artist_22r_pro_frame_size = > + sizeof(uclogic_rdesc_xppen_artist_22r_pro_frame_arr); > + > /** > * uclogic_rdesc_template_apply() - apply report descriptor parameters to a > * report descriptor template, creating a report descriptor. Copies the > diff --git a/drivers/hid/hid-uclogic-rdesc.h b/drivers/hid/hid-uclogic-rdesc.h > index a1f78c07293f..9e4055a5016e 100644 > --- a/drivers/hid/hid-uclogic-rdesc.h > +++ b/drivers/hid/hid-uclogic-rdesc.h > @@ -205,4 +205,19 @@ extern const size_t uclogic_rdesc_ugee_g5_frame_size; > /* Least-significant bit of Ugee G5 frame rotary encoder state */ > #define UCLOGIC_RDESC_UGEE_G5_FRAME_RE_LSB 38 > > +/* Probe endpoints for XP-Pen key activators */ > +#define UCLOGIC_RDESC_UGEE_XPPEN_PROBE_ENDPOINT_TYPE1 0x03 > + > +/* Fix report descriptor for XP-Pen init packet type 1 */ > +extern const __u8 uclogic_rdesc_xppen_init_packet_type1_arr[]; > +extern const size_t uclogic_rdesc_xppen_init_packet_type1_size; > + > +/* Fixed report descriptor for XP-Pen Pro Stylus type 1 (10 bytes) */ > +extern const __u8 uclogic_rdesc_xppen_pro_stylus_type1_arr[]; > +extern const size_t uclogic_rdesc_xppen_pro_stylus_type1_size; > + > +/* Fixed report descriptor for XP-Pen Arist 22R Pro frame */ > +extern const __u8 uclogic_rdesc_xppen_artist_22r_pro_frame_arr[]; > +extern const size_t uclogic_rdesc_xppen_artist_22r_pro_frame_size; > + > #endif /* _HID_UCLOGIC_RDESC_H */
> Hi Joshua, > > Thanks a lot for your patch! > > It might cause conflicts with [1] and [2], so we'll need to rebase on > top of each other work at some point. > > [1] > https://lore.kernel.org/linux-input/20221226123456.14822-1-jose.exposito89@ > gmail.com/T/ [2] > https://lore.kernel.org/linux-input/20221226125454.16106-1-jose.exposito89@ > gmail.com/T/ I've seen those patches in the mailing list (and I thought they already got merged heh) so I'll keep a close eye and rebase as needed. > > Sparse nitpick: "uclogic_extra_input_mapping" can be made static. > I somehow missed that, will change. > > Is it possible to receive a report with information from both dials at > the same time? > > I'm asking because I'm trying to understand what is the meaning of the > 0x10 and 0x20 values and I wonder if they are generated when both dials > are used at the same time. > According to Aren's reference sheet he wrote up for this tablet, the 0x10 and 0x20 values are reported by the right dial (left frame: 02:f0:00:00:00:00:00:20:00:14, right frame: 02:f0:00:00:00:00:00:10:00:14). Dumping the contents of data[frame->bitmap_dial_byte] yields the same result. The left dial works like usual, 02 for left and 01 for right. As for recieving reports of the two dials turning at the same time... I can't seem to make it do that. This tablet is pretty big, and I can't turn the dials fast enough. > > You can probably reuse uclogic_params_ugee_v2_init() or at least reuse > uclogic_probe_interface() and uclogic_params_parse_ugee_v2_desc() if > for some reason we need custom logic for this tablet. > I actually looked a little into the UGEE v2 init functions to see if I could reuse anything (but to be honest, I really just skimmed) but I will take a second look to see if I can consolidate it. > > Is this value 8? In all the models I have seen so far this is indeed > the number of buttons. > > Also, what's the value of buf[6]? As you can see in > uclogic_params_parse_ugee_v2_desc(), this field is the frame type. I'd be > nice to know whether a different frame type is reported when 2 dials are > present or not. > > Could you attach the contents of the 14 bytes of "buf", please? I'd be > nice to have a look and see if we can reuse as much code as possible. > Yeah here's the 14 bytes of "buf" here: buf[0] = 000c buf[1] = 0003 buf[2] = 0030 buf[3] = 00ba buf[4] = 009a buf[5] = 0068 buf[6] = 0006 buf[7] = 0000 buf[8] = 00ff buf[9] = 001f buf[10] = 00ec buf[11] = 0009 buf[12] = 0080 buf[13] = 0072 I'm not sure you made a typo, but buf[6] in uclogic_params_parse_ugee_v2_desc is reading the button count, which reports as 6 for some reason. buf[7] is 0 though, so it appears that its still reporting as UCLOGIC_PARAMS_FRAME_BUTTONS (I could just be misunderstanding the strdescs) or the frames are completely different. > > Ideally, we should be able to handle this tablet with the other UGEE v2 > tablets. > Yeah I will consolidate this case if I manage to merge this with the other UGEE v2 tablet support. > > This array is already declared in uclogic_params_ugee_v2_init(), which, > hopefully, we will be able to reuse. Otherwise, you might be interested > in this commit (not merged yet): > https://lore.kernel.org/linux-input/20221226125454.16106-4-jose.exposito89@g > mail.com/T/#u I didn't see that array in ugee_v2_init, what I'll do is match the variables defined in your cleanup patch (I believe it's closely identical already), so it makes rebasing easier no matter what order they're merged in. > > Can't "uclogic_rdesc_ugee_v2_pen_template_arr" be used instead? > Yeah I think so, at first I didn't consider it but on closer inspection - the offsets are the same (just for some reason, out of order). I'll be looking into testing the pen using this descriptor on the second revision, maybe Pro-series and UGEE v2 aren't so different after all! > > Have a look to "uclogic_rdesc_ugee_v2_frame_dial_template_arr", I don't > know if it could be used for your tablet. > Same as above, same structure - different order (but it's all semantic, same offsets) so I'll be consolidating if it works out. > > If your tablet reports its number of buttons, UCLOGIC_RDESC_FRAME_PH_BTN > can be used here. > I'll be reviewing the descriptor data, ideally it should but I don't have high hopes (as shown above) but I'm going to be testing it more. Thank you for the review! I'll be resubmitting a second version of the patch with your suggestions and making sure the kernel test bot is happy - and hopefully there will be a lot less duplication structure-wise.
Hi! On Fri, Dec 30, 2022 at 03:02:41PM -0500, redstrate wrote: > > Hi Joshua, > > > > Thanks a lot for your patch! > > > > It might cause conflicts with [1] and [2], so we'll need to rebase on > > top of each other work at some point. > > > > [1] > > https://lore.kernel.org/linux-input/20221226123456.14822-1-jose.exposito89@ > > gmail.com/T/ [2] > > https://lore.kernel.org/linux-input/20221226125454.16106-1-jose.exposito89@ > > gmail.com/T/ > > I've seen those patches in the mailing list (and I thought they already got > merged heh) so I'll keep a close eye and rebase as needed. > > > > > Sparse nitpick: "uclogic_extra_input_mapping" can be made static. > > > > I somehow missed that, will change. > > > > > Is it possible to receive a report with information from both dials at > > the same time? > > > > I'm asking because I'm trying to understand what is the meaning of the > > 0x10 and 0x20 values and I wonder if they are generated when both dials > > are used at the same time. > > > > According to Aren's reference sheet he wrote up for this tablet, the 0x10 and > 0x20 values are reported by the right dial (left frame: > 02:f0:00:00:00:00:00:20:00:14, right frame: 02:f0:00:00:00:00:00:10:00:14). > Dumping the contents of data[frame->bitmap_dial_byte] yields the same result. > The left dial works like usual, 02 for left and 01 for right. > > As for recieving reports of the two dials turning at the same time... I can't > seem to make it do that. This tablet is pretty big, and I can't turn the dials > fast enough. Ah cool, then I guess we can remove the cases for "4" and "8"? I'd be nice to stick with decimal numbers in all cases for consistency. > > > > You can probably reuse uclogic_params_ugee_v2_init() or at least reuse > > uclogic_probe_interface() and uclogic_params_parse_ugee_v2_desc() if > > for some reason we need custom logic for this tablet. > > > > I actually looked a little into the UGEE v2 init functions to see if I could > reuse anything (but to be honest, I really just skimmed) but I will take a > second look to see if I can consolidate it. > > > > > Is this value 8? In all the models I have seen so far this is indeed > > the number of buttons. > > > > Also, what's the value of buf[6]? As you can see in > > uclogic_params_parse_ugee_v2_desc(), this field is the frame type. I'd be > > nice to know whether a different frame type is reported when 2 dials are > > present or not. > > > > Could you attach the contents of the 14 bytes of "buf", please? I'd be > > nice to have a look and see if we can reuse as much code as possible. > > > > Yeah here's the 14 bytes of "buf" here: > buf[0] = 000c > buf[1] = 0003 > buf[2] = 0030 > buf[3] = 00ba > buf[4] = 009a > buf[5] = 0068 > buf[6] = 0006 > buf[7] = 0000 > buf[8] = 00ff > buf[9] = 001f > buf[10] = 00ec > buf[11] = 0009 > buf[12] = 0080 > buf[13] = 0072 > > I'm not sure you made a typo, but buf[6] in uclogic_params_parse_ugee_v2_desc > is reading the button count, which reports as 6 for some reason. buf[7] is 0 > though, so it appears that its still reporting as UCLOGIC_PARAMS_FRAME_BUTTONS > (I could just be misunderstanding the strdescs) or the frames are completely > different. Yes, my bad, I meant buf[7]. For the tablets I added so far it indicated the frame type. However, it doesn't seem to be the case for your tablet. Also, buf[6] does not indicate the number of buttons (20?). Did you check with Wireshark if the Windows driver is doing something different for your tablet? It'd be nice to avoid adding quirks but it might not be possible :S We can ignore buf[12] and buf[14]. buf[0] indicates the size of the descriptor (12), so the last two bytes are random memory. > > > > Ideally, we should be able to handle this tablet with the other UGEE v2 > > tablets. > > > > Yeah I will consolidate this case if I manage to merge this with the other > UGEE v2 tablet support. > > > > > This array is already declared in uclogic_params_ugee_v2_init(), which, > > hopefully, we will be able to reuse. Otherwise, you might be interested > > in this commit (not merged yet): > > https://lore.kernel.org/linux-input/20221226125454.16106-4-jose.exposito89@g > > mail.com/T/#u > > I didn't see that array in ugee_v2_init, what I'll do is match the variables > defined in your cleanup patch (I believe it's closely identical already), so it > makes rebasing easier no matter what order they're merged in. > > > > > Can't "uclogic_rdesc_ugee_v2_pen_template_arr" be used instead? > > > > Yeah I think so, at first I didn't consider it but on closer inspection - the > offsets are the same (just for some reason, out of order). I'll be looking into > testing the pen using this descriptor on the second revision, maybe Pro-series > and UGEE v2 aren't so different after all! > > > > > Have a look to "uclogic_rdesc_ugee_v2_frame_dial_template_arr", I don't > > know if it could be used for your tablet. > > > > Same as above, same structure - different order (but it's all semantic, same > offsets) so I'll be consolidating if it works out. > > > > > If your tablet reports its number of buttons, UCLOGIC_RDESC_FRAME_PH_BTN > > can be used here. > > > > I'll be reviewing the descriptor data, ideally it should but I don't have high > hopes (as shown above) but I'm going to be testing it more. > > Thank you for the review! I'll be resubmitting a second version of the patch > with your suggestions and making sure the kernel test bot is happy - and > hopefully there will be a lot less duplication structure-wise. > > > >
> > Ah cool, then I guess we can remove the cases for "4" and "8"? I'd be > nice to stick with decimal numbers in all cases for consistency. > Oh yeah we totally could, I'm not sure why the double cases were there in the first place - it might have been for another device included in the original patch. > > Also, buf[6] does not indicate the number of buttons (20?). > > Did you check with Wireshark if the Windows driver is doing something > different for your tablet? It'd be nice to avoid adding quirks but it > might not be possible :S > > We can ignore buf[12] and buf[14]. buf[0] indicates the size of the > descriptor (12), so the last two bytes are random memory. > I don't even think I have to drop into Windows, we have a userspace linux program for XP-PEN but I haven't tested it with this tablet yet. Yeah, I'd also like to avoid implementing device-specific quirks - hopefully I'll be able to shrink the init code but I might not be able to get rid of all of it. It's really weird that almost everything else (data frame wise) is the same, with the exception of init. And yes, this tablet contains 20 buttons and nothing in that buffer indicates button count :-/
diff --git a/drivers/hid/hid-ids.h b/drivers/hid/hid-ids.h index 82713ef3aaa6..81d04054229a 100644 --- a/drivers/hid/hid-ids.h +++ b/drivers/hid/hid-ids.h @@ -1298,6 +1298,7 @@ #define USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO_L 0x0935 #define USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO_PRO_S 0x0909 #define USB_DEVICE_ID_UGEE_XPPEN_TABLET_STAR06 0x0078 +#define USB_DEVICE_ID_UGEE_XPPEN_TABLET_22R_PRO 0x091b #define USB_DEVICE_ID_UGEE_TABLET_G5 0x0074 #define USB_DEVICE_ID_UGEE_TABLET_EX07S 0x0071 #define USB_DEVICE_ID_UGEE_TABLET_RAINBOW_CV720 0x0055 diff --git a/drivers/hid/hid-uclogic-core.c b/drivers/hid/hid-uclogic-core.c index 7fa6fe04f1b2..ebc93b354f7a 100644 --- a/drivers/hid/hid-uclogic-core.c +++ b/drivers/hid/hid-uclogic-core.c @@ -81,6 +81,30 @@ static __u8 *uclogic_report_fixup(struct hid_device *hdev, __u8 *rdesc, return rdesc; } +/* Buttons considered valid tablet pad inputs. */ +const unsigned int uclogic_extra_input_mapping[] = { + BTN_0, + BTN_1, + BTN_2, + BTN_3, + BTN_4, + BTN_5, + BTN_6, + BTN_7, + BTN_8, + BTN_RIGHT, + BTN_MIDDLE, + BTN_SIDE, + BTN_EXTRA, + BTN_FORWARD, + BTN_BACK, + BTN_B, + BTN_A, + BTN_BASE, + BTN_BASE2, + BTN_X +}; + static int uclogic_input_mapping(struct hid_device *hdev, struct hid_input *hi, struct hid_field *field, @@ -91,9 +115,27 @@ static int uclogic_input_mapping(struct hid_device *hdev, struct uclogic_drvdata *drvdata = hid_get_drvdata(hdev); struct uclogic_params *params = &drvdata->params; - /* Discard invalid pen usages */ - if (params->pen.usage_invalid && (field->application == HID_DG_PEN)) - return -1; + if (field->application == HID_GD_KEYPAD) { + /* + * Remap input buttons to sensible ones that are not invalid. + * This only affects previous behavior for devices with more than ten or so buttons. + */ + const int key = (usage->hid & HID_USAGE) - 1; + + if (key > 0 && key < ARRAY_SIZE(uclogic_extra_input_mapping)) { + hid_map_usage(hi, + usage, + bit, + max, + EV_KEY, + uclogic_extra_input_mapping[key]); + return 1; + } + } else if (field->application == HID_DG_PEN) { + /* Discard invalid pen usages */ + if (params->pen.usage_invalid) + return -1; + } /* Let hid-core decide what to do */ return 0; @@ -403,8 +445,24 @@ static int uclogic_raw_event_frame( /* If need to, and can, transform the bitmap dial reports */ if (frame->bitmap_dial_byte > 0 && frame->bitmap_dial_byte < size) { - if (data[frame->bitmap_dial_byte] == 2) + switch (data[frame->bitmap_dial_byte]) { + case 2: data[frame->bitmap_dial_byte] = -1; + break; + + /* Everything below here is for tablets that shove multiple dials into 1 byte */ + case 4: + case 0x10: + data[frame->bitmap_dial_byte] = 0; + data[frame->bitmap_second_dial_destination_byte] = 1; + break; + + case 8: + case 0x20: + data[frame->bitmap_dial_byte] = 0; + data[frame->bitmap_second_dial_destination_byte] = -1; + break; + } } return 0; @@ -531,6 +589,8 @@ static const struct hid_device_id uclogic_devices[] = { USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO_PRO_S) }, { HID_USB_DEVICE(USB_VENDOR_ID_UGEE, USB_DEVICE_ID_UGEE_XPPEN_TABLET_STAR06) }, + { HID_USB_DEVICE(USB_VENDOR_ID_UGEE, + USB_DEVICE_ID_UGEE_XPPEN_TABLET_22R_PRO) }, { } }; MODULE_DEVICE_TABLE(hid, uclogic_devices); diff --git a/drivers/hid/hid-uclogic-params.c b/drivers/hid/hid-uclogic-params.c index cd1233d7e253..86a1dfa2a4c0 100644 --- a/drivers/hid/hid-uclogic-params.c +++ b/drivers/hid/hid-uclogic-params.c @@ -103,6 +103,8 @@ static void uclogic_params_frame_hid_dbg( frame->touch_flip_at); hid_dbg(hdev, "\t\t.bitmap_dial_byte = %u\n", frame->bitmap_dial_byte); + hid_dbg(hdev, "\t\t.bitmap_second_dial_destination_byte = %u\n", + frame->bitmap_second_dial_destination_byte); } /** @@ -1418,6 +1420,126 @@ static int uclogic_params_ugee_v2_init(struct uclogic_params *params, return rc; } + +/* + * uclogic_params_init_ugee_xppen_pro() - Initializes a UGEE XP-Pen Pro tablet device. + * + * @hdev: The HID device of the tablet interface to initialize and get + * parameters from. Cannot be NULL. + * @params: Parameters to fill in (to be cleaned with + * uclogic_params_cleanup()). Not modified in case of error. + * Cannot be NULL. + * + * Returns: + * Zero, if successful. A negative errno code on error. + */ +static int uclogic_params_init_ugee_xppen_pro(struct hid_device *hdev, + struct uclogic_params *p, + const u8 probe_endpoint, + const u8 rdesc_init_packet[], + const size_t rdesc_init_size, + const u8 rdesc_tablet_arr[], + const size_t rdesc_tablet_size, + const u8 rdesc_frame_arr[], + const size_t rdesc_frame_size) +{ + const size_t str_desc_len = 12; + struct usb_device *udev = hid_to_usb_dev(hdev); + u8 *buf = kmemdup(rdesc_init_packet, rdesc_init_size, GFP_KERNEL); + s32 desc_params[UCLOGIC_RDESC_PH_ID_NUM]; + int actual_len, rc; + u16 resolution; + + if (hdev == NULL || p == NULL) + return -EINVAL; + + rc = usb_interrupt_msg( + udev, + usb_sndintpipe(udev, probe_endpoint), + buf, + rdesc_init_size, + &actual_len, + USB_CTRL_SET_TIMEOUT); + kfree(buf); + if (rc == -EPIPE) { + hid_err(hdev, "broken pipe sending init packet\n"); + return rc; + } else if (rc < 0) { + hid_err(hdev, "failed sending init packet: %d\n", rc); + return rc; + } else if (actual_len != rdesc_init_size) { + hid_err(hdev, + "failed to transfer complete init packet, only %d bytes sent\n", + actual_len); + return -1; + } + + rc = uclogic_params_get_str_desc(&buf, hdev, 100, str_desc_len); + if (rc != str_desc_len) { + if (rc == -EPIPE) { + hid_err(hdev, + "string descriptor with pen parameters not found\n"); + } else if (rc < 0) { + hid_err(hdev, + "failed retrieving pen parameters: %d\n", rc); + } else { + hid_err(hdev, + "string descriptor with pen parameters has invalid length (got %d, expected %lu)\n", + rc, + str_desc_len); + rc = -1; + } + kfree(buf); + return rc; + } + + desc_params[UCLOGIC_RDESC_PEN_PH_ID_X_LM] = get_unaligned_le16(buf + 2); + desc_params[UCLOGIC_RDESC_PEN_PH_ID_Y_LM] = get_unaligned_le16(buf + 4); + /* buf + 6 is the number of pad buttons? Its 0x0008 */ + desc_params[UCLOGIC_RDESC_PEN_PH_ID_PRESSURE_LM] = + get_unaligned_le16(buf + 8); + resolution = get_unaligned_le16(buf + 10); + kfree(buf); + if (resolution == 0) { + hid_err(hdev, "resolution of 0 in descriptor string\n"); + return -1; + } + desc_params[UCLOGIC_RDESC_PEN_PH_ID_X_PM] = + desc_params[UCLOGIC_RDESC_PEN_PH_ID_X_LM] * 1000 / resolution; + desc_params[UCLOGIC_RDESC_PEN_PH_ID_Y_PM] = + desc_params[UCLOGIC_RDESC_PEN_PH_ID_Y_LM] * 1000 / resolution; + + hid_dbg(hdev, + "Received parameters: X: %d Y: %d Pressure: %d Resolution: %u\n", + desc_params[UCLOGIC_RDESC_PEN_PH_ID_X_LM], + desc_params[UCLOGIC_RDESC_PEN_PH_ID_Y_LM], + desc_params[UCLOGIC_RDESC_PEN_PH_ID_PRESSURE_LM], + resolution); + + p->pen.desc_ptr = uclogic_rdesc_template_apply( + rdesc_tablet_arr, + rdesc_tablet_size, + desc_params, + ARRAY_SIZE(desc_params)); + p->pen.desc_size = rdesc_tablet_size; + p->pen.id = 0x02; + + rc = uclogic_params_frame_init_with_desc( + &p->frame_list[0], + rdesc_frame_arr, + rdesc_frame_size, + UCLOGIC_RDESC_V1_FRAME_ID); + if (rc < 0) { + hid_err(hdev, "initializing frame params failed: %d\n", rc); + return rc; + } + + p->pen.subreport_list[0].value = 0xf0; + p->pen.subreport_list[0].id = p->frame_list[0].id; + + return 0; +} + /** * uclogic_params_init() - initialize a tablet interface and discover its * parameters. @@ -1728,6 +1850,31 @@ int uclogic_params_init(struct uclogic_params *params, uclogic_params_init_invalid(&p); } + break; + case VID_PID(USB_VENDOR_ID_UGEE, + USB_DEVICE_ID_UGEE_XPPEN_TABLET_22R_PRO): + /* Ignore non-pen interfaces */ + if (bInterfaceNumber != 2) { + uclogic_params_init_invalid(&p); + break; + } + + rc = uclogic_params_init_ugee_xppen_pro( + hdev, &p, UCLOGIC_RDESC_UGEE_XPPEN_PROBE_ENDPOINT_TYPE1, + uclogic_rdesc_xppen_init_packet_type1_arr, + uclogic_rdesc_xppen_init_packet_type1_size, + uclogic_rdesc_xppen_pro_stylus_type1_arr, + uclogic_rdesc_xppen_pro_stylus_type1_size, + uclogic_rdesc_xppen_artist_22r_pro_frame_arr, + uclogic_rdesc_xppen_artist_22r_pro_frame_size); + if (rc != 0) { + hid_err(hdev, "failed creating frame parameters: %d\n", rc); + goto cleanup; + } + + p.frame_list[0].bitmap_dial_byte = 7; + p.frame_list[0].bitmap_second_dial_destination_byte = 8; + break; } diff --git a/drivers/hid/hid-uclogic-params.h b/drivers/hid/hid-uclogic-params.h index a97477c02ff8..6621a75a4b1a 100644 --- a/drivers/hid/hid-uclogic-params.h +++ b/drivers/hid/hid-uclogic-params.h @@ -171,6 +171,11 @@ struct uclogic_params_frame { * counterclockwise, as opposed to the normal 1 and -1. */ unsigned int bitmap_dial_byte; + /* + * Destination offset for the second bitmap dial byte, if the tablet + * supports a second dial at all. + */ + unsigned int bitmap_second_dial_destination_byte; }; /* diff --git a/drivers/hid/hid-uclogic-rdesc.c b/drivers/hid/hid-uclogic-rdesc.c index fb40775f5f5b..b55dbe5017c1 100644 --- a/drivers/hid/hid-uclogic-rdesc.c +++ b/drivers/hid/hid-uclogic-rdesc.c @@ -1185,6 +1185,125 @@ const __u8 uclogic_rdesc_xppen_deco01_frame_arr[] = { const size_t uclogic_rdesc_xppen_deco01_frame_size = sizeof(uclogic_rdesc_xppen_deco01_frame_arr); +/* Fix report descriptor for XP-Pen init packet type 1 */ +const __u8 uclogic_rdesc_xppen_init_packet_type1_arr[] = { + 0x02, 0xb0, 0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 +}; + +const size_t uclogic_rdesc_xppen_init_packet_type1_size = + sizeof(uclogic_rdesc_xppen_init_packet_type1_arr); + +/* Fixed report descriptor for XP-Pen Pro Stylus type 1 (10 bytes) */ +const __u8 uclogic_rdesc_xppen_pro_stylus_type1_arr[] = { + 0x05, 0x0D, /* Usage Page (Digitizer), */ + 0x09, 0x02, /* Usage (Pen), */ + 0xA1, 0x01, /* Collection (Application), */ + 0x85, 0x02, /* Report ID (2), */ + 0x09, 0x20, /* Usage (Stylus), */ + 0xA0, /* Collection (Physical), */ + 0x14, /* Logical Minimum (0), */ + 0x25, 0x01, /* Logical Maximum (1), */ + 0x09, 0x42, /* Usage (Tip Switch), */ + 0x09, 0x44, /* Usage (Barrel Switch), */ + 0x09, 0x46, /* Usage (Tablet Pick), */ + 0x75, 0x01, /* Report Size (1), */ + 0x95, 0x03, /* Report Count (3), */ + 0x81, 0x02, /* Input (Variable), */ + 0x95, 0x02, /* Report Count (2), */ + 0x81, 0x01, /* Input (Constant), */ + 0x09, 0x32, /* Usage (In Range), */ + 0x95, 0x01, /* Report Count (1), */ + 0x81, 0x02, /* Input (Variable), */ + 0x95, 0x02, /* Report Count (2), */ + 0x81, 0x01, /* Input (Constant), */ + 0x75, 0x10, /* Report Size (16), */ + 0x95, 0x01, /* Report Count (1), */ + 0xA4, /* Push, */ + 0x05, 0x01, /* Usage Page (Desktop), */ + 0x55, 0xFD, /* Unit Exponent (-3), */ + 0x65, 0x13, /* Unit (Inch), */ + 0x34, /* Physical Minimum (0), */ + 0x09, 0x30, /* Usage (X), */ + 0x27, UCLOGIC_RDESC_PEN_PH(X_LM), + /* Logical Maximum (PLACEHOLDER), */ + 0x47, UCLOGIC_RDESC_PEN_PH(X_PM), + /* Physical Maximum (PLACEHOLDER), */ + 0x81, 0x02, /* Input (Variable), */ + 0x09, 0x31, /* Usage (Y), */ + 0x27, UCLOGIC_RDESC_PEN_PH(Y_LM), + /* Logical Maximum (PLACEHOLDER), */ + 0x47, UCLOGIC_RDESC_PEN_PH(Y_PM), + /* Physical Maximum (PLACEHOLDER), */ + 0x81, 0x02, /* Input (Variable), */ + 0xB4, /* Pop, */ + 0x09, 0x30, /* Usage (Tip Pressure), */ + 0x27, UCLOGIC_RDESC_PEN_PH(PRESSURE_LM), + /* Logical Maximum (PLACEHOLDER), */ + 0x81, 0x02, /* Input (Variable), */ + 0xA4, /* Push, */ + 0x54, /* Unit Exponent (0), */ + 0x65, 0x14, /* Unit (Degrees), */ + 0x35, 0xC3, /* Physical Minimum (-61), */ + 0x45, 0x3C, /* Physical Maximum (60), */ + 0x15, 0xC3, /* Logical Minimum (-61), */ + 0x25, 0x3C, /* Logical Maximum (60), */ + 0x75, 0x08, /* Report Size (8), */ + 0x95, 0x02, /* Report Count (2), */ + 0x09, 0x3D, /* Usage (X Tilt), */ + 0x09, 0x3E, /* Usage (Y Tilt), */ + 0x81, 0x02, /* Input (Variable), */ + 0xB4, /* Pop, */ + 0xC0, /* End Collection, */ + 0xC0 /* End Collection */ +}; + +const size_t uclogic_rdesc_xppen_pro_stylus_type1_size = + sizeof(uclogic_rdesc_xppen_pro_stylus_type1_arr); + +/* Fixed report descriptor for XP-Pen Arist 22R Pro frame */ +const __u8 uclogic_rdesc_xppen_artist_22r_pro_frame_arr[] = { + 0x05, 0x01, /* Usage Page (Desktop), */ + 0x09, 0x07, /* Usage (Keypad), */ + 0xA1, 0x01, /* Collection (Application), */ + 0x85, UCLOGIC_RDESC_V1_FRAME_ID, + /* Report ID (Virtual report), */ + 0x05, 0x0D, /* Usage Page (Digitizer), */ + 0x09, 0x39, /* Usage (Tablet Function Keys), */ + 0xA0, /* Collection (Physical), */ + 0x14, /* Logical Minimum (0), */ + 0x25, 0x01, /* Logical Maximum (1), */ + 0x75, 0x01, /* Report Size (1), */ + 0x95, 0x08, /* Report Count (8), */ + 0x81, 0x01, /* Input (Constant), */ + 0x05, 0x09, /* Usage Page (Button), */ + 0x19, 0x01, /* Usage Minimum (01h), */ + 0x29, 0x14, /* Usage Maximum (14h), */ + 0x95, 0x14, /* Report Count (20), */ + 0x81, 0x02, /* Input (Variable), */ + 0x95, 0x14, /* Report Count (20), */ + 0x81, 0x01, /* Input (Constant), */ + 0x05, 0x01, /* Usage Page (Desktop), */ + 0x09, 0x38, /* Usage (Wheel), */ + 0x75, 0x08, /* Report Size (8), */ + 0x95, 0x01, /* Report Count (1), */ + 0x15, 0xFF, /* Logical Minimum (-1), */ + 0x25, 0x08, /* Logical Maximum (8), */ + 0x81, 0x06, /* Input (Variable, Relative), */ + 0x05, 0x0C, /* Usage Page (Consumer Devices), */ + 0x0A, 0x38, 0x02, /* Usage (AC PAN), */ + 0x95, 0x01, /* Report Count (1), */ + 0x81, 0x06, /* Input (Variable, Relative), */ + 0x26, 0xFF, 0x00, /* Logical Maximum (255), */ + 0x75, 0x08, /* Report Size (8), */ + 0x95, 0x01, /* Report Count (1), */ + 0x81, 0x02, /* Input (Variable), */ + 0xC0, /* End Collection */ + 0xC0, /* End Collection */ +}; + +const size_t uclogic_rdesc_xppen_artist_22r_pro_frame_size = + sizeof(uclogic_rdesc_xppen_artist_22r_pro_frame_arr); + /** * uclogic_rdesc_template_apply() - apply report descriptor parameters to a * report descriptor template, creating a report descriptor. Copies the diff --git a/drivers/hid/hid-uclogic-rdesc.h b/drivers/hid/hid-uclogic-rdesc.h index a1f78c07293f..9e4055a5016e 100644 --- a/drivers/hid/hid-uclogic-rdesc.h +++ b/drivers/hid/hid-uclogic-rdesc.h @@ -205,4 +205,19 @@ extern const size_t uclogic_rdesc_ugee_g5_frame_size; /* Least-significant bit of Ugee G5 frame rotary encoder state */ #define UCLOGIC_RDESC_UGEE_G5_FRAME_RE_LSB 38 +/* Probe endpoints for XP-Pen key activators */ +#define UCLOGIC_RDESC_UGEE_XPPEN_PROBE_ENDPOINT_TYPE1 0x03 + +/* Fix report descriptor for XP-Pen init packet type 1 */ +extern const __u8 uclogic_rdesc_xppen_init_packet_type1_arr[]; +extern const size_t uclogic_rdesc_xppen_init_packet_type1_size; + +/* Fixed report descriptor for XP-Pen Pro Stylus type 1 (10 bytes) */ +extern const __u8 uclogic_rdesc_xppen_pro_stylus_type1_arr[]; +extern const size_t uclogic_rdesc_xppen_pro_stylus_type1_size; + +/* Fixed report descriptor for XP-Pen Arist 22R Pro frame */ +extern const __u8 uclogic_rdesc_xppen_artist_22r_pro_frame_arr[]; +extern const size_t uclogic_rdesc_xppen_artist_22r_pro_frame_size; + #endif /* _HID_UCLOGIC_RDESC_H */