| commit | 52609f30bd5defec81eb407fb82f0bef0b4c0aba | [log] [tgz] |
|---|---|---|
| author | Kenneth Albanowski <kenalba@google.com> | Thu Apr 07 19:37:45 2022 |
| committer | Kenneth Albanowski <kenalba@google.com> | Thu Apr 14 23:27:43 2022 |
| tree | 0b5ac7b7d230ded7f007c028734a109efc09dbb8 | |
| parent | ca7b4b66c18c97e1d7e21b36a9c76239ea0530ef [diff] |
usi-test: Update for USI 2.0 features Update usi-test with USI 2.0 features, as well as significant clean-up to error and warning reporting for a variety of USI 1.0 and 2.0 scenarios. BUG=b:216846636 TEST=Verified functional on wormdingler and morphius, among others. Change-Id: I8a2d5a2fc94519c0b0301ab5f869bdfc940e36e7 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/usi-test/+/3440723 Reviewed-by: Sean O'Brien <seobrien@chromium.org> Commit-Queue: Kenneth Albanowski <kenalba@google.com> Tested-by: Kenneth Albanowski <kenalba@google.com> Reviewed-by: Harry Cutts <hcutts@chromium.org>
This repository contains a tool for testing a Universal Stylus Initiative (USI) digitizer and stylus at the HID protocol level.
Make sure that your device has a dev or test image. You can use cros flash to flash a test image. Then you will need to enter the command prompt. Finally, you can run the tool with the usi-test command.
usi-test has five subcommands: descriptor, data, get, set, and diagnostic.
For any of these commands, you can set the path to the device with the -p or --path option. The default device path is /dev/hidraw0.
This command simply prints out the report descriptor in human-readable format.
example:
$ usi-test --path /dev/hidraw0 descriptor
This command prints incoming events from the device in human-readable format. You can quit with Ctl-C.
example:
$ usi-test -p /dev/hidraw0 data
This command sends a HID feature request to the device and prints the response. All of these commands query a stylus paired with the device, which can be specified with the -i or --index option. This is the temporary index assigned to the stylus by the digitizer when it pairs. The default index is 1.
This command will wait for the specified stylus to pair with the digitizer, so you can send the command without having the stylus pressed to the digitizer.
The values you can query are:
color: The current 8-bit indexed color of the stylus strokewidth: The current width of the stylus strokestyle: The current style of the stylus stroke (ink, pencil, etc.)buttons: The mapping from physical stylus buttons to the button types they are set to be emulating.firmware: The vendor ID, product ID, serial number, and firmware version of the stylus.usi_version: The USI protocol version this pen is using.examples:
$ usi-test -p /dev/hidraw0 get color $ usi-test get width --index 1 $ usi-test get buttons -i 2
This command sets the specified values for the stylus using a HID feature report. The stylus index is specified the same as with the get command.
This command will wait for the specified stylus to pair with the digitizer, so you can send the command without having the stylus pressed to the digitizer.
The values you can set are:
--color, -c: Values between 0 and 255. See the USI spec for color mapping. (255 specifies no preference.)--color24, -C: Values between 0x000000 and 0xFFFFFF, as 0xRRGGBB.--color24-no-preference: Used in conjunction with --color24, indicates that there is no preferred color.--width, -w: Values between 0 and 255, in 0.1 mm increments. For example, A value of 25 gives a stroke width of 2.5 mm. (255 specifies no preference.)--style, -s: Choose from ink, pencil, highlighter, marker, brush, and none. (‘none’ indicates no preferred style)--button, -b: This option requires two arguments. It will set the first button argument to emulate the second button argument. The first (physical) button may be (barrel, secondary, eraser/tail), and the second (emulated) button may be (barrel, secondary, eraser, disabled)You may set one or all of the values in the same command. The button option can be set once for each physical button.
examples:
$ usi-test set --color 50 $ usi-test set -c 50 $ usi-test set --style pencil --index 2 $ usi-test set -c 50 -w 20 -s pencil # set the barrel button to act as the secondary button: $ usi-test set --button barrel secondary $ usi-test set --button barrel secondary --button secondary eraser
This command sends a diagnostic command to the stylus and reads the response. If you want you can set the preamble and cyclic redundancy check (CRC) manually, but by default this tool will calculate and send the preamble and CRC defined by the USI spec. The stylus index can be set the same as with the get command.
This command expects the command ID as the first argument, and the data as the second argument.
It will print the full response from the stylus, and break the response into the error bit, error code, and command response.
If used with a display that requires USI 2.0 flex beacons, add the --flex argument.
examples:
# send the echo command, with value 8 $ usi-test diagnostic 52 8 full response: 0x0000000000000008 error information available? 0 error code: 0x00 command response: 0x0008 $ usi-test diagnostic 52 7 --preamble 2 --crc 3