Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 853f0d32 authored by Farid Chahla's avatar Farid Chahla Committed by Siarhei Vishniakou
Browse files

Updated documentation for CTS uhid tests 

A new field was added where bus can be specified for testing uhid
devices. This commit adds the relevant documention to the README.

Bug: 144949707
Test: none

Change-Id: If5f6673dd0fdd268b702119b6ccd4abdc37f65bd
parent 91b4f26c

cmds/hid/README.md

+7 −2
Original line number Diff line number Diff line
@@ -44,11 +44,15 @@ Register a new uhid device 
| name          | string        | Device name                |

| vid           | 16-bit integer| Vendor id                  |

| pid           | 16-bit integer| Product id                 |

| bus           | string        | Bus that device should use |

| descriptor    | byte array    | USB HID report descriptor  |



Device ID is used for matching the subsequent commands to a specific device

to avoid ambiguity when multiple devices are registered.



Device bus is used to determine how the uhid device is connected to the host.

The options are "usb" and "bluetooth".



USB HID report descriptor should be generated according the the USB HID spec

and can be checked by reverse parsing using a variety of tools, for example

[usbdescreqparser][5].
@@ -61,6 +65,7 @@ Example: 
  "name": "Odie (Test)",

  "vid": 0x18d1,

  "pid": 0x2c40,

  "bus": "usb",

  "descriptor": [0x05, 0x01, 0x09, 0x05, 0xa1, 0x01, 0x85, 0x01, 0x05, 0x09, 0x0a, 0x01, 0x00,

    0x0a, 0x02, 0x00, 0x0a, 0x04, 0x00, 0x0a, 0x05, 0x00, 0x0a, 0x07, 0x00, 0x0a, 0x08, 0x00,

    0x0a, 0x0e, 0x00, 0x0a, 0x0f, 0x00, 0x0a, 0x0d, 0x00, 0x05, 0x0c, 0x0a, 0x24, 0x02, 0x0a,