Commit ad0e669b authored by Nikolai Kondrashov's avatar Nikolai Kondrashov Committed by Jiri Kosina

HID: Fix unit exponent parsing again

Revert some changes done in 77463838.

Revert all changes done in hidinput_calc_abs_res as it mistakingly used
"Unit" item exponent nibbles to affect resolution value. This wasn't
breaking resolution calculation of relevant axes of any existing
devices, though, as they have only one dimension to their units and thus
1 in the corresponding nible.

Revert to reading "Unit Exponent" item value as a signed integer in
hid_parser_global to fix reading specification-complying values. This
fixes resolution calculation of devices complying to the HID standard,
including Huion, KYE, Waltop and UC-Logic graphics tablets which have
their report descriptors fixed by the drivers.

Explanations follow.

There are two "unit exponents" in HID specification and it is important
not to mix them. One is the global "Unit Exponent" item and another is
nibble values in the global "Unit" item. See 6.2.2.7 Global Items.

The "Unit Exponent" value is just a signed integer and is used to scale
the integer resolution unit values, so fractions can be expressed.

The nibbles of "Unit" value are used to select the unit system (nibble
0), and presence of a particular basic unit type in the unit formula and
its *exponent* (or power, nibbles 1-6). And yes, the latter is in two
complement and zero means absence of the unit type.

Taking the representation example of (integer) joules from the
specification:

[mass(grams)][length(centimeters)^2][time(seconds)^-2] * 10^-7

the "Unit Exponent" would be -7 (or 0xF9, if stored as a byte) and the
"Unit" value would be 0xE121, signifying:

Nibble  Part        Value   Meaning
-----   ----        -----   -------
0       System      1       SI Linear
1       Length      2       Centimeters^2
2       Mass        1       Grams
3       Time        -2      Seconds^-2

To give the resolution in e.g. hundredth of joules the "Unit Exponent"
item value should have been -9.

See also the examples of "Unit" values for some common units in the same
chapter.

However, there is a common misunderstanding about the "Unit Exponent"
value encoding, where it is assumed to be stored the same as nibbles in
"Unit" item. This is most likely due to the specification being a bit
vague and overloading the term "unit exponent". This also was and still
is proliferated by the official "HID Descriptor Tool", which makes this
mistake and stores "Unit Exponent" as such. This format is also
mentioned in books such as "USB Complete" and in Microsoft's hardware
design guides.

As a result many devices currently on the market use this encoding and
so the driver should support them.
Signed-off-by: default avatarNikolai Kondrashov <spbnick@gmail.com>
Acked-by: default avatarBenjamin Tissoires <benjamin.tissoires@redhat.com>
Signed-off-by: default avatarJiri Kosina <jkosina@suse.cz>
parent 684524d3
...@@ -319,7 +319,7 @@ static s32 item_sdata(struct hid_item *item) ...@@ -319,7 +319,7 @@ static s32 item_sdata(struct hid_item *item)
static int hid_parser_global(struct hid_parser *parser, struct hid_item *item) static int hid_parser_global(struct hid_parser *parser, struct hid_item *item)
{ {
__u32 raw_value; __s32 raw_value;
switch (item->tag) { switch (item->tag) {
case HID_GLOBAL_ITEM_TAG_PUSH: case HID_GLOBAL_ITEM_TAG_PUSH:
...@@ -370,10 +370,11 @@ static int hid_parser_global(struct hid_parser *parser, struct hid_item *item) ...@@ -370,10 +370,11 @@ static int hid_parser_global(struct hid_parser *parser, struct hid_item *item)
return 0; return 0;
case HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT: case HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT:
/* Units exponent negative numbers are given through a /* Many devices provide unit exponent as a two's complement
* two's complement. * nibble due to the common misunderstanding of HID
* See "6.2.2.7 Global Items" for more information. */ * specification 1.11, 6.2.2.7 Global Items. Attempt to handle
raw_value = item_udata(item); * both this and the standard encoding. */
raw_value = item_sdata(item);
if (!(raw_value & 0xfffffff0)) if (!(raw_value & 0xfffffff0))
parser->global.unit_exponent = hid_snto32(raw_value, 4); parser->global.unit_exponent = hid_snto32(raw_value, 4);
else else
......
...@@ -192,6 +192,7 @@ static int hidinput_setkeycode(struct input_dev *dev, ...@@ -192,6 +192,7 @@ static int hidinput_setkeycode(struct input_dev *dev,
return -EINVAL; return -EINVAL;
} }
/** /**
* hidinput_calc_abs_res - calculate an absolute axis resolution * hidinput_calc_abs_res - calculate an absolute axis resolution
* @field: the HID report field to calculate resolution for * @field: the HID report field to calculate resolution for
...@@ -234,23 +235,17 @@ __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code) ...@@ -234,23 +235,17 @@ __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code)
case ABS_MT_TOOL_Y: case ABS_MT_TOOL_Y:
case ABS_MT_TOUCH_MAJOR: case ABS_MT_TOUCH_MAJOR:
case ABS_MT_TOUCH_MINOR: case ABS_MT_TOUCH_MINOR:
if (field->unit & 0xffffff00) /* Not a length */ if (field->unit == 0x11) { /* If centimeters */
return 0;
unit_exponent += hid_snto32(field->unit >> 4, 4) - 1;
switch (field->unit & 0xf) {
case 0x1: /* If centimeters */
/* Convert to millimeters */ /* Convert to millimeters */
unit_exponent += 1; unit_exponent += 1;
break; } else if (field->unit == 0x13) { /* If inches */
case 0x3: /* If inches */
/* Convert to millimeters */ /* Convert to millimeters */
prev = physical_extents; prev = physical_extents;
physical_extents *= 254; physical_extents *= 254;
if (physical_extents < prev) if (physical_extents < prev)
return 0; return 0;
unit_exponent -= 1; unit_exponent -= 1;
break; } else {
default:
return 0; return 0;
} }
break; break;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment