Respect user-defined CDC string descriptor#580
Open
verylowfreq wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the CDC-ACM interface initialization so a user sketch can set a custom CDC interface string descriptor via setStringDescriptor() without it being overwritten during Adafruit_USBD_CDC::begin().
Changes:
- Only applies the default CDC interface string (“TinyUSB Serial”) if
_stridhas not already been set by the user.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
104
to
+107
| _instance = _instance_count++; | ||
| this->setStringDescriptor("TinyUSB Serial"); | ||
| if (_strid == 0) { | ||
| this->setStringDescriptor("TinyUSB Serial"); | ||
| } |
This file contains hidden or 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
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 allows user sketches to set a custom string descriptor for the CDC-ACM interface.
What changed
Previously,
Adafruit_USBD_CDC::begin()always set the CDC interface string descriptor to"TinyUSB Serial". This prevented user sketches from overriding the CDC interface string withsetStringDescriptor().This patch changes the behavior to:
_stridhas already been set by the user sketch._stridis still0, use the default string descriptor"TinyUSB Serial".setStringDescriptor(), keep that user-defined string.Use case
On some boards supported by Adafruit TinyUSB,
Serial.begin()may be called beforesetup(). In that case, a sketch can clear and rebuild the USB configuration with a custom CDC interface string:This makes it possible for the custom CDC-ACM interface name to appear on the host instead of always using "TinyUSB Serial".