Add support for XP-PEN Deco L
v2 cover Add support for XP-PEN Deco L
Hello everyone,
This patchset adds support for the UGEE XP-PEN Deco L tablet. This device belongs to a family of tablets that must receive a chunk of magic data in order to be enabled (named UGEE v2 internally).
Once the device is enabled, its parameters can be discovered by parsing a report descriptor. HUION v1 tablets have a similar report descriptor but, in the case of UGEE v2 tablets, the number of buttons are also discoverable [1].
The ability to discover the number of buttons is the reason for the first 3 patches. They enable frame templates.
Because I lack the hardware to fully test this driver, I added some KUnit tests to make sure no bugs are introduced.
I didn't see any other test in the subsystem (and I doubt I'm the first person writing one) so please let me know if I need to move the test to a different place.
The last patch enables the tablet and it should give Stefan a stable code to work on his XP-PEN Deco Mini 7 tablet.
Stefan: I didn't include the code for the Mini 4 because once connected no events are received until I unload and load the driver. If anyone has a clue about why this could happen, I'd really appreciate some help. [2]
Best wishes,
José Expósito
[1] I don't own a HUION v1 device, so I'm not sure if the information about the number of buttons is also present and it is not used in the driver for some reason.
[2] https://lore.kernel.org/linux-input/20220516112159.GA74406@elementary/T/#t
---
v2 - Fix some errors reported by the kernel test robot:
- Add MODULE_DESCRIPTION/LICENSE/AUTHOR to hid-uclogic-rdesc-test.c
- Remove unused variable in uclogic_params_ugee_v2_init
- Add sparse __force anotation in the result of cpu_to_le16
- Add DISABLE_STRUCTLEAK_PLUGIN for KUnit tests
José Expósito (4):
HID: uclogic: Make template placeholder IDs generic
HID: uclogic: Add KUnit tests for uclogic_rdesc_template_apply()
HID: uclogic: Allow to generate frame templates
HID: uclogic: Add support for XP-PEN Deco L
drivers/hid/Kconfig | 7 + drivers/hid/Makefile | 3 + drivers/hid/hid-ids.h | 1 + drivers/hid/hid-uclogic-core.c | 2 + drivers/hid/hid-uclogic-params.c | 201 +++++++++++++++++++++++- drivers/hid/hid-uclogic-rdesc-test.c | 219 +++++++++++++++++++++++++++ drivers/hid/hid-uclogic-rdesc.c | 124 ++++++++++++++- drivers/hid/hid-uclogic-rdesc.h | 24 ++- 8 files changed, 567 insertions(+), 14 deletions(-) create mode 100644 drivers/hid/hid-uclogic-rdesc-test.c
base-commit: f7d8e387d9aeff963e6691c0166269b8042b4ff9
Signature · 1 line
2.25.1
PATCH v2 1/4 HID: uclogic: Make template placeholder IDs generic
Up until now, the report descriptor template parameter IDs were only used with pen report descriptors and they were named accordingly.
Rename the enum and the total number of IDs to make them interface agnostic.
Refactor, no functional changes.
--- drivers/hid/hid-uclogic-params.c | 4 ++-- drivers/hid/hid-uclogic-rdesc.c | 14 +++++++------- drivers/hid/hid-uclogic-rdesc.h | 10 +++++----- 3 files changed, 14 insertions(+), 14 deletions(-)
drivers/hid/hid-uclogic-params.c +2 -2
@@ -234,7 +234,7 @@ static int uclogic_params_pen_init_v1(struct uclogic_params_pen *pen,const int len =12 ;s32 resolution;/* Pen report descriptor template parameters */ -s32 desc_params[UCLOGIC_RDESC_PEN_PH_ID_NUM ]; +s32 desc_params[UCLOGIC_RDESC_PH_ID_NUM ];__u8 *desc_ptr =NULL ;/* Check arguments */
@@ -379,7 +379,7 @@ static int uclogic_params_pen_init_v2(struct uclogic_params_pen *pen,size_t i;s32 resolution;/* Pen report descriptor template parameters */ -s32 desc_params[UCLOGIC_RDESC_PEN_PH_ID_NUM ]; +s32 desc_params[UCLOGIC_RDESC_PH_ID_NUM ];__u8 *desc_ptr =NULL ;/* Check arguments */
drivers/hid/hid-uclogic-rdesc.c +7 -7
@@ -979,7 +979,7 @@ const size_t uclogic_rdesc_xppen_deco01_frame_size =* uclogic_rdesc_template_apply() - apply report descriptor parameters to a * report descriptor template, creating a report descriptor. Copies the * template over to the new report descriptor and replaces every occurrence of -* UCLOGIC_RDESC_PH_HEAD, followed by an index byte, with the value from the +* UCLOGIC_RDESC_PEN_PH_HEAD, followed by an index byte, with the value from the * parameter list at that index. * * @template_ptr: Pointer to the template buffer.
@@ -996,7 +996,7 @@ __u8 *uclogic_rdesc_template_apply(const __u8 *template_ptr, const s32 *param_list, size_t param_num) { -static const __u8 head[] = {UCLOGIC_RDESC_PH_HEAD }; +static const __u8 pen_head[] = {UCLOGIC_RDESC_PEN_PH_HEAD };__u8 *rdesc_ptr;__u8 *p;s32 v;
@@ -1005,12 +1005,12 @@ __u8 *uclogic_rdesc_template_apply(const __u8 *template_ptr,if (rdesc_ptr ==NULL )return NULL ; -for (p = rdesc_ptr; p +sizeof (head) < rdesc_ptr + template_size;) { -if (memcmp (p, head,sizeof (head)) ==0 && - p[sizeof (head)] < param_num) { - v = param_list[p[sizeof (head)]]; +for (p = rdesc_ptr; p +sizeof (pen_head) < rdesc_ptr + template_size;) { +if (memcmp (p, pen_head,sizeof (pen_head)) ==0 && + p[sizeof (pen_head)] < param_num) { + v = param_list[p[sizeof (pen_head)]];put_unaligned (cpu_to_le32 (v), (s32 *)p); - p +=sizeof (head) +1 ; + p +=sizeof (pen_head) +1 ; }else { p++; }
drivers/hid/hid-uclogic-rdesc.h +5 -5
@@ -81,7 +81,7 @@ extern __u8 uclogic_rdesc_twha60_fixed1_arr[];extern const size_t uclogic_rdesc_twha60_fixed1_size;/* Report descriptor template placeholder head */ -#define UCLOGIC_RDESC_PH_HEAD 0xFE, 0xED, 0x1D +#define UCLOGIC_RDESC_PEN_PH_HEAD 0xFE, 0xED, 0x1D/* Apply report descriptor parameters to a report descriptor template */ extern __u8 *uclogic_rdesc_template_apply(const __u8 *template_ptr,
@@ -89,19 +89,19 @@ extern __u8 *uclogic_rdesc_template_apply(const __u8 *template_ptr,const s32 *param_list, size_t param_num); -/* Pen report descriptor template placeholder IDs */ -enum uclogic_rdesc_pen_ph_id { +/* 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_PEN_PH_ID_NUM +UCLOGIC_RDESC_PH_ID_NUM };/* Report descriptor pen template placeholder */ #define UCLOGIC_RDESC_PEN_PH (_ID) \ - UCLOGIC_RDESC_PH_HEAD, UCLOGIC_RDESC_PEN_PH_ID_##_ID + UCLOGIC_RDESC_PEN_PH_HEAD, UCLOGIC_RDESC_PEN_PH_ID_##_ID/* Report ID for v1 pen reports */ #define UCLOGIC_RDESC_V1_PEN_ID 0x07
Signature · 1 line
2.25.1
PATCH v2 2/4 HID: uclogic: Add KUnit tests for uclogic_rdesc_template_apply()
In reply to José ExpósitoThe uclogic_rdesc_template_apply() function is used by the driver to generate HID descriptors from templates.
In order to avoid regressions in future patches, add KUnit tests to test the function.
--- drivers/hid/Kconfig | 7 + drivers/hid/Makefile | 3 + drivers/hid/hid-uclogic-rdesc-test.c | 183 +++++++++++++++++++++++++++ 3 files changed, 193 insertions(+) create mode 100644 drivers/hid/hid-uclogic-rdesc-test.c
drivers/hid/Kconfig +7 -0
@@ -458,6 +458,13 @@ config HID_UCLOGIC help Support for UC-Logic and Huion tablets. +config HID_UCLOGIC_KUNIT_TEST + bool "UC-Logic tests" if !KUNIT_ALL_TESTS + depends on KUNIT=y + default KUNIT_ALL_TESTS + help + KUnit tests for the UC-Logic driver. + config HID_WALTOP tristate "Waltop" depends on HID
drivers/hid/Makefile +3 -0
@@ -127,6 +127,9 @@ hid-uclogic-objs := hid-uclogic-core.o \ hid-uclogic-rdesc.o \ hid-uclogic-params.o obj-$(CONFIG_HID_UCLOGIC) += hid-uclogic.o +obj-$(CONFIG_HID_UCLOGIC_KUNIT_TEST) += hid-uclogic-rdesc.o \ + hid-uclogic-rdesc-test.o +CFLAGS_hid-uclogic-rdesc-test.o += $(DISABLE_STRUCTLEAK_PLUGIN) obj-$(CONFIG_HID_UDRAW_PS3) += hid-udraw-ps3.o obj-$(CONFIG_HID_LED) += hid-led.o obj-$(CONFIG_HID_XIAOMI) += hid-xiaomi.o
drivers/hid/hid-uclogic-rdesc-test.c new file +183 -0
183 lines not on this page · raw message
Signature · 1 line
2.25.1
PATCH v2 3/4 HID: uclogic: Allow to generate frame templates
In reply to José ExpósitoAdd a new template placeholder to allow configuring the number of buttons in the drawing tablet frame and update the KUnit tests to cover the new case.
--- drivers/hid/hid-uclogic-rdesc-test.c | 36 ++++++++++++++++++++++++++++ drivers/hid/hid-uclogic-rdesc.c | 14 ++++++++--- drivers/hid/hid-uclogic-rdesc.h | 6 +++++ 3 files changed, 53 insertions(+), 3 deletions(-)
drivers/hid/hid-uclogic-rdesc-test.c +36 -0
@@ -31,6 +31,10 @@ static const s32 params_pen_some[] = { [UCLOGIC_RDESC_PEN_PH_ID_X_PM] = 0xBB, }; +static const s32 params_frame_all[UCLOGIC_RDESC_PH_ID_NUM ] = { + [UCLOGIC_RDESC_FRAME_PH_ID_UM ] =0xFF , +}; +static const __u8 template_empty[] = { };static const __u8 template_small[] = {0x00 };static const __u8 template_no_ph[] = {0xAA ,0xFE ,0xAA ,0xED ,0x1D };
@@ -39,6 +43,10 @@ static const __u8 template_pen_ph_end[] = {0xAA ,0xBB ,UCLOGIC_RDESC_PEN_PH_HEAD }; +static const __u8 template_btn_ph_end[] = { +0xAA ,0xBB ,UCLOGIC_RDESC_FRAME_PH_BTN_HEAD +}; +static const __u8 template_pen_all_params[] = {UCLOGIC_RDESC_PEN_PH (X_LM ), 0x47, UCLOGIC_RDESC_PEN_PH(X_PM),
@@ -55,6 +63,18 @@ static const __u8 expected_pen_all_params[] = { 0x00, 0xEE, 0x00, 0x00, 0x00, }; +static const __u8 template_frame_all_params[] = { +0x01 ,0x02 , +UCLOGIC_RDESC_FRAME_PH_BTN , +0x99 , +}; + +static const __u8 expected_frame_all_params[] = { +0x01 ,0x02 , +0x2A ,0xFF ,0x00 , +0x99 , +}; +static const __u8 template_pen_some_params[] = {0x01 ,0x02 ,UCLOGIC_RDESC_PEN_PH (X_LM ),
@@ -108,6 +128,14 @@ static struct uclogic_template_case uclogic_template_cases[] = { .param_num = ARRAY_SIZE(params_pen_all), .expected = template_pen_ph_end, }, + { + .name = "Frame button placeholder at the end, without ID", + .template = template_btn_ph_end, + .template_size = sizeof(template_btn_ph_end), + .param_list = params_frame_all, + .param_num = ARRAY_SIZE(params_frame_all), + .expected = template_btn_ph_end, + }, { .name = "All params present in the pen template", .template = template_pen_all_params,
@@ -116,6 +144,14 @@ static struct uclogic_template_case uclogic_template_cases[] = { .param_num = ARRAY_SIZE(params_pen_all), .expected = expected_pen_all_params, }, + { + .name = "All params present in the frame template", + .template = template_frame_all_params, + .template_size = sizeof(template_frame_all_params), + .param_list = params_frame_all, + .param_num = ARRAY_SIZE(params_frame_all), + .expected = expected_frame_all_params, + }, { .name = "Some params present in the pen template (complete param list)", .template = template_pen_some_params,
drivers/hid/hid-uclogic-rdesc.c +11 -3
@@ -979,7 +979,7 @@ const size_t uclogic_rdesc_xppen_deco01_frame_size =* uclogic_rdesc_template_apply() - apply report descriptor parameters to a * report descriptor template, creating a report descriptor. Copies the * template over to the new report descriptor and replaces every occurrence of -* UCLOGIC_RDESC_PEN_PH_HEAD, followed by an index byte, with the value from the +* the template placeholders, followed by an index byte, with the value from the * parameter list at that index. * * @template_ptr: Pointer to the template buffer.
@@ -996,6 +996,7 @@ __u8 *uclogic_rdesc_template_apply(const __u8 *template_ptr, const s32 *param_list, size_t param_num) { +static const __u8 btn_head[] = {UCLOGIC_RDESC_FRAME_PH_BTN_HEAD };static const __u8 pen_head[] = {UCLOGIC_RDESC_PEN_PH_HEAD };__u8 *rdesc_ptr;__u8 *p;
@@ -1005,12 +1006,19 @@ __u8 *uclogic_rdesc_template_apply(const __u8 *template_ptr,if (rdesc_ptr ==NULL )return NULL ; -for (p = rdesc_ptr; p +sizeof (pen_head) < rdesc_ptr + template_size;) { -if (memcmp (p, pen_head,sizeof (pen_head)) ==0 && +for (p = rdesc_ptr; p +sizeof (btn_head) < rdesc_ptr + template_size;) { +if (p +sizeof (pen_head) < rdesc_ptr + template_size && +memcmp (p, pen_head,sizeof (pen_head)) ==0 && p[sizeof (pen_head)] < param_num) { v = param_list[p[sizeof (pen_head)]];put_unaligned (cpu_to_le32 (v), (s32 *)p); p +=sizeof (pen_head) +1 ; + }else if (memcmp (p, btn_head,sizeof (btn_head)) ==0 && + p[sizeof (btn_head)] < param_num) { + v = param_list[p[sizeof (btn_head)]]; +put_unaligned ((__u8 )0x2A , p);/* Usage Maximum */ +put_unaligned_le16 ((__force u16 )cpu_to_le16 (v), p +1 ); + p +=sizeof (btn_head) +1 ; }else { p++; }
drivers/hid/hid-uclogic-rdesc.h +6 -0
@@ -82,6 +82,7 @@ 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,
@@ -96,6 +97,7 @@ enum uclogic_rdesc_ph_id {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 };
@@ -103,6 +105,10 @@ enum uclogic_rdesc_ph_id {#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
Signature · 1 line
2.25.1
PATCH 1/1 HID: uclogic: Remove useless loop
The while in question does nothing except provide the possibility to have an infinite loop in case the subreport id is actually the same as the pen id.
--- drivers/hid/hid-uclogic-core.c | 55 ++++++++++++++++------------------ 1 file changed, 25 insertions(+), 30 deletions(-)
drivers/hid/hid-uclogic-core.c +25 -30
@@ -423,40 +423,35 @@ static int uclogic_raw_event(struct hid_device *hdev,if (report->type !=HID_INPUT_REPORT )return 0 ; -while (true) { -/* Tweak pen reports, if necessary */ -if ((report_id == params->pen.id) && (size >=2 )) { - subreport_list_end = - params->pen.subreport_list + -ARRAY_SIZE (params->pen.subreport_list); -/* Try to match a subreport */ -for (subreport = params->pen.subreport_list; - subreport < subreport_list_end; subreport++) { -if (subreport->value !=0 && - subreport->value == data[1 ]) { -break ; - } - } -/* If a subreport matched */ -if (subreport < subreport_list_end) { -/* Change to subreport ID, and restart */ - report_id = data[0 ] = subreport->id; -continue ; - }else { -return uclogic_raw_event_pen (drvdata, data, size); +/* Tweak pen reports, if necessary */ +if ((report_id == params->pen.id) && (size >=2 )) { + subreport_list_end = + params->pen.subreport_list + +ARRAY_SIZE (params->pen.subreport_list); +/* Try to match a subreport */ +for (subreport = params->pen.subreport_list; + subreport < subreport_list_end; subreport++) { +if (subreport->value !=0 && + subreport->value == data[1 ]) { +break ; } } - -/* Tweak frame control reports, if necessary */ -for (i =0 ; i <ARRAY_SIZE (params->frame_list); i++) { -if (report_id == params->frame_list[i].id) { -return uclogic_raw_event_frame ( - drvdata, ¶ms->frame_list[i], - data, size); - } +/* If a subreport matched */ +if (subreport < subreport_list_end) { +/* Change to subreport ID, and restart */ + report_id = data[0 ] = subreport->id; + }else { +return uclogic_raw_event_pen (drvdata, data, size); } + } -break ; +/* Tweak frame control reports, if necessary */ +for (i =0 ; i <ARRAY_SIZE (params->frame_list); i++) { +if (report_id == params->frame_list[i].id) { +return uclogic_raw_event_frame ( + drvdata, ¶ms->frame_list[i], + data, size); + } }return 0 ;
Signature · 1 line
2.36.1
Re: [PATCH for-5.19/uclogic] HID: uclogic: Remove useless loop
Hi Stefan,
Thanks for the patch. You can send it as an standalone patch rather than as a response to my patches, I don't know if it could be missed by maintaners this way.
Quoted 27 lines · Stefan Berzl
The while in question does nothing except provide the possibility to have an infinite loop in case the subreport id is actually the same as the pen id.
Signed-off-by Stefan Berzl <[email protected]>--- drivers/hid/hid-uclogic-core.c | 55 ++++++++++++++++------------------ 1 file changed, 25 insertions(+), 30 deletions(-)drivers/hid/hid-uclogic-core.c +0
-9@@ -423,40 +423,35 @@ static int uclogic_raw_event(struct hid_device *hdev,if (report->type !=HID_INPUT_REPORT )return 0 ; -while (true) { -/* Tweak pen reports, if necessary */ -if ((report_id == params->pen.id) && (size >=2 )) { - subreport_list_end = - params->pen.subreport_list + -ARRAY_SIZE (params->pen.subreport_list); -/* Try to match a subreport */ -for (subreport = params->pen.subreport_list; - subreport < subreport_list_end; subreport++) {
drivers/hid/hid-uclogic-core.c static int uclogic_raw_event(struct hid_device *hdev, · line 444
Quoted 10 lines
drivers/hid/hid-uclogic-core.c +0
-10-if (subreport->value !=0 && - subreport->value == data[1 ]) { -break ; - } - } -/* If a subreport matched */ -if (subreport < subreport_list_end) { -/* Change to subreport ID, and restart */ - report_id = data[0 ] = subreport->id; -continue ;
Here, in the previous code, the "report_id" is set to the subreport ID and the while loop is executed again with the new ID. The loop acts as a recursive function.
Isn't this behaviour removed by your patch?
Jose
Quoted 47 lines
drivers/hid/hid-uclogic-core.c +25
-11- }else { -return uclogic_raw_event_pen (drvdata, data, size); +/* Tweak pen reports, if necessary */ +if ((report_id == params->pen.id) && (size >=2 )) { + subreport_list_end = + params->pen.subreport_list + +ARRAY_SIZE (params->pen.subreport_list); +/* Try to match a subreport */ +for (subreport = params->pen.subreport_list; + subreport < subreport_list_end; subreport++) { +if (subreport->value !=0 && + subreport->value == data[1 ]) { +break ; } } - -/* Tweak frame control reports, if necessary */ -for (i =0 ; i <ARRAY_SIZE (params->frame_list); i++) { -if (report_id == params->frame_list[i].id) { -return uclogic_raw_event_frame ( - drvdata, ¶ms->frame_list[i], - data, size); - } +/* If a subreport matched */ +if (subreport < subreport_list_end) { +/* Change to subreport ID, and restart */ + report_id = data[0 ] = subreport->id; + }else { +return uclogic_raw_event_pen (drvdata, data, size); } + } -break ; +/* Tweak frame control reports, if necessary */ +for (i =0 ; i <ARRAY_SIZE (params->frame_list); i++) { +if (report_id == params->frame_list[i].id) { +return uclogic_raw_event_frame ( + drvdata, ¶ms->frame_list[i], + data, size); + } }return 0 ;Signature · 1 line
2.36.1
Re: [PATCH for-5.19/uclogic] HID: uclogic: Remove useless loop
Hello everynyan!
Quoted 5 lines
Hi Stefan,
Thanks for the patch. You can send it as an standalone patch rather than as a response to my patches, I don't know if it could be missed by maintaners this way.
You are right about that, I'll keep it in mind. But for consistency, I think it's better to reply here for now.
Quoted 42 lines
Quoted 27 lines
The while in question does nothing except provide the possibility to have an infinite loop in case the subreport id is actually the same as the pen id.
Signed-off-by Stefan Berzl <[email protected]>--- drivers/hid/hid-uclogic-core.c | 55 ++++++++++++++++------------------ 1 file changed, 25 insertions(+), 30 deletions(-)drivers/hid/hid-uclogic-core.c +0
-9@@ -423,40 +423,35 @@ static int uclogic_raw_event(struct hid_device *hdev,if (report->type !=HID_INPUT_REPORT )return 0 ; -while (true) { -/* Tweak pen reports, if necessary */ -if ((report_id == params->pen.id) && (size >=2 )) { - subreport_list_end = - params->pen.subreport_list + -ARRAY_SIZE (params->pen.subreport_list); -/* Try to match a subreport */ -for (subreport = params->pen.subreport_list; - subreport < subreport_list_end; subreport++) {drivers/hid/hid-uclogic-core.c static int uclogic_raw_event(struct hid_device *hdev, · line 444
Quoted 10 lines
drivers/hid/hid-uclogic-core.c +0
-10-if (subreport->value !=0 && - subreport->value == data[1 ]) { -break ; - } - } -/* If a subreport matched */ -if (subreport < subreport_list_end) { -/* Change to subreport ID, and restart */ - report_id = data[0 ] = subreport->id; -continue ;Here, in the previous code, the "
report_id" is set to the subreport ID and the while loop is executed again with the new ID. The loop acts as a recursive function.
Quoted 3 lines
Isn't this behaviour removed by your patch?
Jose
Think about what this behavior really achieves. In the first iteration, we check if params->pen.id equals the report_id, which is the actual report id from the usb message. If that is the case, we check if the second byte of the message is such that we need an updated "subreport" for this particular message. Therefore, the report_id is set to the subreport->id. This subreport->id is by design supposed to be different from the original params->pen.id, because otherwise, why would we need this update? If we then "continue" with this useless loop, either one of two cases can happen:
The best case is that the (report_id = subreport->id) != params->pen.id in which case the if-block won't be executed and we only wasted time.
If the (report_id = subreport->id) == params->pen.id however, things get interesting. The "subreport_list_end" and "subreport" variables will again be set to entries based on "params->pen.subreport_list", which is totally unchanged from the last iteration. We will iterate the same subreports, find the same result, set report_id to the same subreport->id and, that's the beauty of it, "continue" this ingenious loop, creating an infinite loop.
This contraption is in the best case only wasteful, yet it has been accepted all willy-nilly like. Really gets the noggin joggin.
Quoted 43 lines
Quoted 43 lines
drivers/hid/hid-uclogic-core.c +25
-11- }else { -return uclogic_raw_event_pen (drvdata, data, size); +/* Tweak pen reports, if necessary */ +if ((report_id == params->pen.id) && (size >=2 )) { + subreport_list_end = + params->pen.subreport_list + +ARRAY_SIZE (params->pen.subreport_list); +/* Try to match a subreport */ +for (subreport = params->pen.subreport_list; + subreport < subreport_list_end; subreport++) { +if (subreport->value !=0 && + subreport->value == data[1 ]) { +break ; } } - -/* Tweak frame control reports, if necessary */ -for (i =0 ; i <ARRAY_SIZE (params->frame_list); i++) { -if (report_id == params->frame_list[i].id) { -return uclogic_raw_event_frame ( - drvdata, ¶ms->frame_list[i], - data, size); - } +/* If a subreport matched */ +if (subreport < subreport_list_end) { +/* Change to subreport ID, and restart */ + report_id = data[0 ] = subreport->id; + }else { +return uclogic_raw_event_pen (drvdata, data, size); } + } -break ; +/* Tweak frame control reports, if necessary */ +for (i =0 ; i <ARRAY_SIZE (params->frame_list); i++) { +if (report_id == params->frame_list[i].id) { +return uclogic_raw_event_frame ( + drvdata, ¶ms->frame_list[i], + data, size); + } }
Quoted 5 lines
Quoted 5 lines
drivers/hid/hid-uclogic-core.c +0
-0return 0 ;Signature · 1 line
2.36.1
Bye bye
Stefan Berzl
Re: [PATCH for-5.19/uclogic] HID: uclogic: Remove useless loop
Quoted 13 lines · Stefan Berzl
Think about what this behavior really achieves. In the first iteration, we check if
params->pen.idequals thereport_id, which is the actual report id from the usb message. If that is the case, we check if the second byte of the message is such that we need an updated "subreport" for this particular message. Therefore, thereport_idis set to thesubreport->id. Thissubreport->idis by design supposed to be different from the originalparams->pen.id, because otherwise, why would we need this update? If we then "continue" with this useless loop, either one of two cases can happen:The best case is that the (
report_id=subreport->id) !=params->pen.idin which case the if-block won't be executed and we only wasted time.
Quoted 7 lines
If the (
report_id=subreport->id) ==params->pen.idhowever, things get interesting. The "subreport_list_end" and "subreport" variables will again be set to entries based on "params->pen.subreport_list", which is totally unchanged from the last iteration. We will iterate the same subreports, find the same result, setreport_idto the samesubreport->idand, that's the beauty of it, "continue" this ingenious loop, creating an infinite loop.
True, data[1] doesn't change, so an extra if is executed for no reason. I mean, it is not dramatic, but I guess the while loop could be removed for clarity.
I wonder why it was implemented in a loop though, check commit 8b013098be ("HID: uclogic: Replace pen_frame_flag with subreport_list").
The while loop is intrudeced there and I can imagine that for a good reason... However, I can not think in a case where removing the loop could cause issues.
Quoted 55 lines
This contraption is in the best case only wasteful, yet it has been accepted all willy-nilly like. Really gets the noggin joggin.
Quoted 43 lines
Quoted 43 lines
drivers/hid/hid-uclogic-core.c +25
-11- }else { -return uclogic_raw_event_pen (drvdata, data, size); +/* Tweak pen reports, if necessary */ +if ((report_id == params->pen.id) && (size >=2 )) { + subreport_list_end = + params->pen.subreport_list + +ARRAY_SIZE (params->pen.subreport_list); +/* Try to match a subreport */ +for (subreport = params->pen.subreport_list; + subreport < subreport_list_end; subreport++) { +if (subreport->value !=0 && + subreport->value == data[1 ]) { +break ; } } - -/* Tweak frame control reports, if necessary */ -for (i =0 ; i <ARRAY_SIZE (params->frame_list); i++) { -if (report_id == params->frame_list[i].id) { -return uclogic_raw_event_frame ( - drvdata, ¶ms->frame_list[i], - data, size); - } +/* If a subreport matched */ +if (subreport < subreport_list_end) { +/* Change to subreport ID, and restart */ + report_id = data[0 ] = subreport->id; + }else { +return uclogic_raw_event_pen (drvdata, data, size); } + } -break ; +/* Tweak frame control reports, if necessary */ +for (i =0 ; i <ARRAY_SIZE (params->frame_list); i++) { +if (report_id == params->frame_list[i].id) { +return uclogic_raw_event_frame ( + drvdata, ¶ms->frame_list[i], + data, size); + } }Quoted 5 lines
Quoted 5 lines
return 0;
Signature · 1 line
2.36.1Bye bye
Stefan Berzl
PATCH v2 4/4 HID: uclogic: Add support for XP-PEN Deco L
In reply to José ExpósitoThe XP-PEN Deco L (UGEE) needs to be initialized by sending a buffer of magic data, discovered by sniffing the Windows driver traffic.
In order to differentiate UGEE tablets that need this kind of initialization from the previous ones, name them v2 internally and create an entry point for them.
After initialization, the template report descriptors can be discovered by parsing a string descriptor, similar to the one exposed by HUION v1 devices.
Add all the required elements to support the device.
--- drivers/hid/hid-ids.h | 1 + drivers/hid/hid-uclogic-core.c | 2 + drivers/hid/hid-uclogic-params.c | 197 +++++++++++++++++++++++++++++++ drivers/hid/hid-uclogic-rdesc.c | 102 ++++++++++++++++ drivers/hid/hid-uclogic-rdesc.h | 8 ++ 5 files changed, 310 insertions(+)
drivers/hid/hid-ids.h +1 -0
@@ -1272,6 +1272,7 @@#define USB_DEVICE_ID_UGEE_XPPEN_TABLET_G540 0x0075#define USB_DEVICE_ID_UGEE_XPPEN_TABLET_G640 0x0094#define USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO01 0x0042 +#define USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO_L 0x0935#define USB_DEVICE_ID_UGEE_XPPEN_TABLET_STAR06 0x0078#define USB_DEVICE_ID_UGEE_TABLET_G5 0x0074#define USB_DEVICE_ID_UGEE_TABLET_EX07S 0x0071
drivers/hid/hid-uclogic-core.c +2 -0
@@ -521,6 +521,8 @@ static const struct hid_device_id uclogic_devices[] = { USB_DEVICE_ID_UGEE_XPPEN_TABLET_G640) }, { HID_USB_DEVICE(USB_VENDOR_ID_UGEE, USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO01) }, + { HID_USB_DEVICE(USB_VENDOR_ID_UGEE, + USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO_L) }, { HID_USB_DEVICE(USB_VENDOR_ID_UGEE, USB_DEVICE_ID_UGEE_XPPEN_TABLET_STAR06) }, { }
drivers/hid/hid-uclogic-params.c +197 -0
209 lines not on this page · raw message
drivers/hid/hid-uclogic-rdesc.c +102 -0
108 lines not on this page · raw message
drivers/hid/hid-uclogic-rdesc.h +8 -0
@@ -161,6 +161,14 @@ 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 +/* 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 for Ugee EX07 frame */ extern const __u8 uclogic_rdesc_ugee_ex07_frame_arr[];extern const size_t uclogic_rdesc_ugee_ex07_frame_size;
Signature · 1 line
2.25.1