Skip to content

usb: make device-next default and move legacy sample code to legacy directory #87269

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
Open
wants to merge 28 commits into
base: main
Choose a base branch
from
Open

usb: make device-next default and move legacy sample code to legacy directory #87269

wants to merge 28 commits into from
+2,867 −2,256

Conversation

jfischer-no
Copy link
Contributor

Make USB device-next samples default and move legacy code to legacy directory.

@jfischer-no jfischer-no added area: USB Universal Serial Bus area: Samples Samples DNM This PR should not be merged (Do Not Merge) labels Mar 18, 2025
@jfischer-no jfischer-no added this to the v4.2.0 milestone Mar 18, 2025
@carlescufi carlescufi mentioned this pull request Mar 19, 2025
Open
57 tasks
tmon-nordic
tmon-nordic requested changes Mar 24, 2025
View reviewed changes
Copy link
Contributor

@tmon-nordic tmon-nordic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are also some CDC ACM twister failures, some where both USB stacks seem to be active simultaneously and some where there doesn't seem to be CDC ACM devicetree instance.

henrikbrixandersen
henrikbrixandersen requested changes Mar 24, 2025
View reviewed changes
Copy link
Member

@henrikbrixandersen henrikbrixandersen left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pretty much same comment as last time this was proposed (see #80985 (comment)):

As already stated in an earlier comment on this PR (#80985 (review)) I do not think "device_next" is ready becoming the default USB device stack in Zephyr v4.1.

There's the issue with lack of "vendor" testing (tested it on a random selection of development boards, three of the new USB device drivers failed to enumerate on MS Windows), the lack of support for a number of platforms (I know some people find it acceptable to "leave these behind"), the list of open bug reports - and especially the vastly increased RAM/ROM footprint as reported in #83309. These are all mentioned in #42066 but not yet handled with 9 days until v4.1 feature freeze.

@jfischer-no jfischer-no force-pushed the pr-samples-usb-use-device_next branch from 53c9919 to 15be1f2 Compare March 26, 2025 12:08
@carlescufi
Copy link
Member

the lack of support for a number of platforms (I know some people find it acceptable to "leave these behind"),

We agreed those would not be a factor I believe, after I sent an informative email to devel@

the list of open bug reports

Which are those? I am not familiar with these.

and especially the vastly increased RAM/ROM footprint as reported in #83309.

Agreed, this needs to be addressed.

@henrikbrixandersen
Copy link
Member

Which are those? I am not familiar with these.

I meant the open issues reported against the device_next stack here on GitHub. Personally, I think the following would be relevant to look at before making this the default stack. Some of these have gone months without any maintainer feedback:

@carlescufi
Copy link
Member

I meant the open issues reported against the device_next stack here on GitHub. Personally, I think the following would be relevant to look at before making this the default stack. Some of these have gone months without any maintainer feedback:

I agree with you. @jfischer-no and @tmon-nordic could you please go over these and see what can be fixed?

@jfischer-no
Copy link
Contributor Author

I meant the open issues reported against the device_next stack here on GitHub. Personally, I think the following would be relevant to look at before making this the default stack. Some of these have gone months without any maintainer feedback:

I agree with you. @jfischer-no and @tmon-nordic could you please go over these and see what can be fixed?

I am on
#74058
#87732 (is not a bug)
#86718 (is not a bug)

jfischer-no added 12 commits July 22, 2025 13:21
@jfischer-no
samples: usb: add a sample that covers legacy netusb
cad0fcd 
Add a sample that covers legacy CDC EEM/ECM and RNDIS functions.
Network functionality is limited to ICMP.

Signed-off-by: Johann Fischer <[email protected]>
@jfischer-no
sample: net: remove legacy USB code from the zperf sample
6fb0e82 
Remove legacy netusb code.

Signed-off-by: Johann Fischer <[email protected]>
@jfischer-no
samples: modbus: use new USB device stack
779a258 
Use new USB device stack.

Signed-off-by: Johann Fischer <[email protected]>
@jfischer-no
samples: hci_uart: use new USB device stack
658cd32 
The change only affects board nrf52840dongle_nrf52840.

Signed-off-by: Johann Fischer <[email protected]>
@jfischer-no
samples: sensortile_box: use new USB device stack
cfac175 
Use new USB device stack.

Signed-off-by: Johann Fischer <[email protected]>
@jfischer-no
samples: wpan_serial: use new USB device stack
895cc01 
Use new USB device stack.

Signed-off-by: Johann Fischer <[email protected]>
@jfischer-no
samples: smp_svr: use new USB device stack
7f1e1ca 
Use new USB device stack.

Signed-off-by: Johann Fischer <[email protected]>
@jfischer-no
samples: echo_server: use new USB device stack
cbfb6a8 
Remove netusb code and use new USB device stack.

Signed-off-by: Johann Fischer <[email protected]>
@jfischer-no
samples: http_server: use new USB device stack
a489d6f 
Remove netusb code, use new USB device stack and CDC NCM implementation.

Signed-off-by: Johann Fischer <[email protected]>
@jfischer-no
samples: shell_module: use new USB device stack
171457b 
Use new USB device stack.

Signed-off-by: Johann Fischer <[email protected]>
@jfischer-no
tests: bluetooth: use new USB device stack
2e43275 
Use new USB device stack.

Signed-off-by: Johann Fischer <[email protected]>
@jfischer-no
tests: uart_basic_api: use new USB device stack
f5ba0a8 
Use new USB device stack.

Signed-off-by: Johann Fischer <[email protected]>
@jfischer-no jfischer-no force-pushed the pr-samples-usb-use-device_next branch 2 times, most recently from 57d2e04 to c7ef307 Compare July 23, 2025 11:35
@jfischer-no
scripts: ci: check_compliance.py: add BOOT_SERIAL_UART to ALLOWLIST
d1682c0 
Add Kconfig option BOOT_SERIAL_UART, defined in the MCUboot module but
needed to be used in tests, to the UNDEF_KCONFIG_ALLOWLIST.

Signed-off-by: Johann Fischer <[email protected]>
@jfischer-no
tests: mcuboot_recovery_retention: use UARTE1 for device management
6b06da8 
The test requires two UARTs: one for console output and one for device
management. Use UART1 for device management instead of CDC ACM because
the legacy stack is deprecated and it will take some time for MCUboot to
adapt.

Signed-off-by: Johann Fischer <[email protected]>
@jfischer-no
samples: usb: update USB samples root documentation
142df16 
Add note about legacy samples and update USB samples root documentation.

Signed-off-by: Johann Fischer <[email protected]>
@jfischer-no
usb: deprecate legacy USB device support
6da651f 
Deprecate legacy USB device support.

Signed-off-by: Johann Fischer <[email protected]>
@jfischer-no
usb: mark new stack as unstable and set it as the default
080c91a 
Document that the legacy stack is now deprecated.

Signed-off-by: Johann Fischer <[email protected]>
@jfischer-no
manifest: update MCUboot version
b8ead61 
Update MCUboot to the version needed for the deprecation of the legacy
stack.

Signed-off-by: Johann Fischer <[email protected]>
@jfischer-no jfischer-no force-pushed the pr-samples-usb-use-device_next branch from c7ef307 to b8ead61 Compare July 23, 2025 12:23
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
93 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
13.1% Duplication on New Code

See analysis details on SonarQube Cloud

tmon-nordic
tmon-nordic reviewed Jul 25, 2025
View reviewed changes
samples/subsys/usb/legacy/audio_headphones_microphone/sample.yaml
sample.usb.legacy.audio.headphones_microphone:
depends_on: usb_device
tags: usb
build_only: true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we really be changing the samples to build only? I would prefer to just move the files intact.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fabiobaltieri fabiobaltieri fabiobaltieri approved these changes

@jukkar jukkar jukkar approved these changes

@carlescufi carlescufi carlescufi approved these changes

@tmon-nordic tmon-nordic tmon-nordic approved these changes

@alwa-nordic alwa-nordic Awaiting requested review from alwa-nordic

@hermabe hermabe Awaiting requested review from hermabe

@jhedberg jhedberg Awaiting requested review from jhedberg

@mrodgers-witekio mrodgers-witekio Awaiting requested review from mrodgers-witekio

@nashif nashif Awaiting requested review from nashif

@pdgendt pdgendt Awaiting requested review from pdgendt

@rlubos rlubos Awaiting requested review from rlubos

@ssharks ssharks Awaiting requested review from ssharks

@tbursztyka tbursztyka Awaiting requested review from tbursztyka

@henrikbrixandersen henrikbrixandersen Awaiting requested review from henrikbrixandersen

@kartben kartben Awaiting requested review from kartben

Requested changes must be addressed to merge this pull request.

Assignees

@jfischer-no jfischer-no

Labels
area: Samples Samples area: USB Universal Serial Bus DNM (manifest) This PR should not be merged (controlled by action-manifest) manifest manifest-mcuboot
Projects
None yet
Milestone
v4.3.0
Development

Successfully merging this pull request may close these issues.
7 participants
@jfischer-no @carlescufi @henrikbrixandersen @kartben @fabiobaltieri @jukkar @tmon-nordic