Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Display all descriptor types in device view #197

Merged
merged 21 commits into from
Oct 12, 2024
Merged

Display all descriptor types in device view #197

merged 21 commits into from
Oct 12, 2024

Conversation

martinling
Copy link
Member

@martinling martinling commented Oct 10, 2024 •
edited
Loading

This PR extends the device view to display additional descriptor types.

  • Interface Association Descriptors are now decoded, and their interfaces grouped into a Function.
  • All descriptors are now shown, even where not understood by Packetry.
  • Arbitrary descriptors are shown attached to configurations, interfaces or endpoints, according to where they appear in the configuration data.
  • Functions and interfaces are displayed with their associated class, based on usb.ids data.

Example:
image

A subsequent PR will support saving descriptors to files for further analysis, building on the features in #196.

@martinling martinling requested a review from miek October 10, 2024 16:09
@martinling martinling mentioned this pull request Oct 10, 2024
Merged
@miek
Copy link
Member

miek commented Oct 11, 2024

Could you rebase this? There's just a minor conflict from merging #193

@martinling
tests: Make summarize_item and write_item generic over items/modes.
df1acd6
@martinling
Add testing of the device tree generated for each test capture.
670e065
@martinling
Remove previous tests of device tree expansion.
5c80136 
These tests have proven hard to maintain, since they depend on items
in the device tree appearing at specific indexes which will break as
further descriptors are added.
@martinling
Retain additional descriptors when parsing configurations.
4d25b22
@martinling
Display unknown descriptors in device tree.
b12cfdd
@martinling
Add some additional standard descriptor types.
4b25de6
@martinling
Interpret interface association descriptors.
f8a333f
@martinling
Relax requirements on tree items to Clone rather than Copy.
705c9c1
@martinling
Revise the DeviceItem format to simplify code.
8f1c97a 
Move DeviceId and DeviceVersion to struct fields, and define a new
DeviceItemContent enum which embeds descriptor data where needed.
@martinling
Avoid taking references unnecessarily in helper methods.
a94f430 
These methods took references previously because it reduced the number
of '*' operators needed when working with DeviceItem variants by reference.

With the new DeviceItem type this is no longer an issue.
@martinling
Attach configuration number to Function items.
c0e474f
@martinling
Set device tree indents based on parent items.
bac7388
@martinling
Merge the IfaceOtherDescriptor and ConfigOtherDescriptor item types.
92b87dd 
These previously differed only by their fixed indent.
@martinling
Group associated interfaces under their functions.
300db87
@martinling
Add helper method to fetch interface matching descriptor.
ee33370
@martinling
Display descriptors attached to interfaces before their endpoints.
dde3185
@martinling
Add InterfaceKey alias for (InterfaceNum, InterfaceAlt).
7c6736a
@martinling
Move endpoint descriptors below endpoints in the device tree.
97a782e
@martinling
Remove some unnecessary index types.
3cb5609 
These were more useful when they were fields on DeviceItem, but now they
just complicate things.
@martinling
Allow additional descriptors to be attached to endpoints too.
a2e28e7
@martinling
Copy link
Member Author

Done!

@martinling
Copy link
Member Author

martinling commented Oct 11, 2024 •
edited
Loading

I've just realised that one thing in the last commit might need some further thought.

I shortened the notation Interface 1 (alternate 2) to Interface 1.2, to make more space for the interface class beside it.

However, in the traffic view we use that same notation to indicate <device number>.<interface>, e.g. in this request description:

Setting alternate setting 0 for interface 25.2

So perhaps we should go with something else like Interface 1 alt 2: Communications in the device view.

@martinling
Display interface classes.
be24322 
Alternate settings are abbreviated to an "N alt M" format to leave more
space for the interface class text.
@martinling
Copy link
Member Author

I've gone ahead and made the change to Interface 1 alt 2 etc in the last commit.

@miek miek merged commit 6331cd3 into greatscottgadgets:main Oct 12, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@miek miek Awaiting requested review from miek

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@martinling @miek