Windows report descriptor reconstructor unit test #343
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…eport_descriptor_reconstructor_v2
…ptor debug printout
…eport_descriptor_reconstructor
- macOS implementation for it; - stubs for all other platforms;
…ws_report_descriptor_reconstructor
…ate to the hid_get_report_descriptor API function of PR libusb#303
- macOS implementation for it; - stubs for all other platforms;
…eport_descriptor_reconstructor
Added debug output for possible failure cases in button array code
…s_report_descriptor_reconstructor_reengineered_pp_struct
…ich contains additional elements).
…ascending order (IsMultipleItemsForArray == 1)
…tton field Restructured main item list helper functions for better readability
|
Cmake build is okay. |
|
Zip of the dump data |
JoergAtGithub
force-pushed
the
windows_report_descriptor_reconstructor_unit_test
branch
from
21135c4 to
e327426
Compare
|
@mcuee I added tests for your devices, where I could find the real report descriptor in the comments from #262/#306. Without the real report descriptor, I can't check the correctness of the generated data.
|
Unfortunately I do not know how to get the real report descriptor of the following built-in HID devices.
|
|
As for the Plantronics Blackwire 3220 Series 047f c056, I think I have posted it before, I get it from macOS USB Prober application. Let me check where I posted it. Edit to add: sorry the following is for 047f:c025. I will get 047f:c056 later. #306 (comment) click to expand |
|
@JoergAtGithub |
|
hut1_12v1_apendixB_delimiter_example.txt @mcuee: I attached a file hut1_12v1_apendixB_delimiter_example.txt , where I typed manually the report descriptor for the the Delimiter Example from the USB HID Usage table specification 12v2. |
|
This may take some time. I have not really touched the PIC FW development for a long time. But let me try during the holiday period. I have long holiday in December and I can not go anywhere anyway. |
|
If you can do this, it would really help. Because this functionality is quite complex, and I've no data to test the code. |
JoergAtGithub
force-pushed
the
windows_report_descriptor_reconstructor_unit_test
branch
from
e73dedc to
5a80a0d
Compare
Do you see a chance to program the hand coded ReportDescriptor from https://github.com/libusb/hidapi/files/7528936/hut1_12v1_apendixB_delimiter_example.txt ? This would cover the last untested feature of the report descriptor syntax. |
|
If it helps, I can create physical devices that return arbitrary HID Report Descriptors and test what Windows hidapi is returning. I've been making a small collection of descriptors useful to me in |
|
@todbot : That would be great! You need to connect the device to a Windows PC and execute If you want to try the report descriptor reconstructor itself, execute the 'hidtest.exe' example program from #306 |
|
I'm actively reworking this one (test infrastructure and implementation). |
@todbot Are you still intend to program the Report Descriptor with the missing test case to your TinyUSB device? It would be of great help! |
Youw
force-pushed
the
get-descriptor
branch
3 times, most recently
from
7cd7533 to
676c7e6
Compare
|
All of these changes are now in https://github.com/libusb/hidapi/tree/get-descriptor . One of the items to work on - include pp_data_dump so the dumper is a part of this repo too. In any case, at least now the get-descriptor is in sync with master and with separated implementation, which should minimize a chance of a conflict. |
|
Great. At least now we can test using the get-descriptor branch which is in sync with the master. |
|
@Youw Great work! Thank you! If I should do some tasks, please tell me. Otherwise I wait, to prevent conflicting work. I never intended to include pp_data_dump into the main repo. Therefore it's just a quick and dirty implementation, where I never started a Pull-Request for. But if you want, I could clean this up and start a Pull-Request. |
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is based on #306 and implements a unit test, which allows to test the report descriptor reconstructor offline, whithout access to HID devices. It runs on GitHub build actions.
To allow this, I stored the preparsed data of the HID devices in text files. The test reads this data and executes the reconstructor code and compares the output with a reference file.
For each HID device, the unit test contains 3 files:
*.pp_data -> Text file with the Preparsed Data
_expected.rpt_desc -> The expected output of the reconstructor
_real.rpt_desc -> The real report descriptor of the device