Revise the descriptor API #126
Merged
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
martinling
force-pushed
the
arbitrary-descriptors
branch
from
7453315 to
4f9d760
Compare
martinling
force-pushed
the
arbitrary-descriptors
branch
from
4f9d760 to
2bbe8d2
Compare
|
This is dependent on #122 but otherwise ready to go. |
The bMaxPower value is stored in units of 2mA, per USB 2.0 Table 9-10.
The key change here is the `include_in_config` property of USBDescriptor, which specifies whether the descriptor should be included in a GET_CONFIGURATION response. Descriptors with this property set to True will appear following their parent in the GET_CONFIGURATION response, in the same order in which they were added with the add_descriptor() method. They will not be fetchable with a GET_DESCRIPTOR request, and do not require the `number` property to be set. Descriptors with this property set to False will not be included in a GET_CONFIGURATION response. They can be fetched with a GET_DESCRIPTOR request, and must have the `number` property set to an integer value, so that they can be retrieved by the identifying tuple of (type_number, number). The USBClassDescriptor class is deprecated, but retained for backwards compatibility. It now simply sets `include_in_config` to True.
martinling
force-pushed
the
arbitrary-descriptors
branch
from
2bbe8d2 to
bd38f7f
Compare
|
Rebased now that #122 is merged. |
antoinevg
approved these changes
Nov 22, 2024
Merged
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.
An attempt to fix #125.
The key change here is the new
include_in_configproperty ofUSBDescriptor, which specifies whether the descriptor should be included in aGET_CONFIGURATIONresponse.Descriptors with this property set to
Truewill appear following their parent in theGET_CONFIGURATIONresponse, in the same order in which they were added with theadd_descriptor()method. They will not be fetchable with aGET_DESCRIPTORrequest, and do not require thenumberproperty to be set.Descriptors with this property set to
Falsewill not be included in aGET_CONFIGURATIONresponse. They can be fetched with aGET_DESCRIPTORrequest, and must have thenumberproperty set to an integer value, so that they can be retrieved by the identifying tuple of(type_number, number).The
USBClassDescriptorclass is deprecated, but retained for backwards compatibility. It now simply setsinclude_in_configtoTrue.Stacked on #122 for now.