Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the WSL2 firmware development guide to better address USB device forwarding reliability across WSL kernel versions (notably 6.6.x), and to tighten/refresh related guidance and attribution.
Changes:
- Simplifies and de-personalizes the recommendation for WSL USB Manager.
- Adds a new “Test USB Device Forwarding” section using
lsusb, plus avhci-hcdworkaround and persistence via/etc/wsl.conf. - Updates the summary attribution text and contributor list.
Comments suppressed due to low confidence (5)
_posts/2024-12-18-wsl2-for-firmware-development.md:307
- Link text should use the correct capitalization: “GitHub” (not “Github”).
- [Github](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account?platform=linux)
- [BitBucket](https://support.atlassian.com/bitbucket-cloud/docs/set-up-personal-ssh-keys-on-linux/)
### Test USB Device Forwarding
_posts/2024-12-18-wsl2-for-firmware-development.md:307
- Consider using the standard branding “Bitbucket” (not “BitBucket”) in the bullet and link text for consistency with Atlassian’s product name.
- Create and add SSH keys to GitHub and BitBucket (as necessary):
- [Github](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account?platform=linux)
- [BitBucket](https://support.atlassian.com/bitbucket-cloud/docs/set-up-personal-ssh-keys-on-linux/)
### Test USB Device Forwarding
_posts/2024-12-18-wsl2-for-firmware-development.md:406
- The link text uses “sitepoint” in lowercase; the publication’s name is typically capitalized as “SitePoint”. Updating the link text would avoid looking like a typo.
dig into some more complicated use cases, I highly recommend reviewing Craig
Buckler's [Complete Tutorial at sitepoint](https://www.sitepoint.com/wsl2/).
_posts/2024-12-18-wsl2-for-firmware-development.md:349
- After editing
/etc/wsl.conf, WSL needs a restart for the[boot]section to take effect (e.g.,wsl --shutdownfrom Windows, then reopen the distro). Consider adding that step here so readers don’t think the change is applied immediately.
> To enable `vhci-hcd` on every boot of WSL2, add the following to
> `/etc/wsl.conf` under the `[boot]` section:
>
> ```ini
> command = modprobe vhci-hcd
> ```
_posts/2024-12-18-wsl2-for-firmware-development.md:340
- The note implies USBIP support is just “not enabled by default”, but in some WSL kernel builds the module may be missing entirely. It would help to mention what users should do if
modprobe vhci-hcdfails with “module not found” (e.g., update WSL/kernel, or use a custom kernel).
> If you do not see the USB root hubs in `lsusb`, then you may be on a version
> of the WSL2 kernel that does not enable USBIP support by default.
>
> Run this command to load the kernel module:
>
> ```bash
> sudo modprobe vhci-hcd
> ```
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
We've found that Microsoft may or may not have enabled kernel modules needed for WSL USB device forwarding in various kernel versions. We're updating the guide with a fix that was tested on WSL kernel 6.6.x.