usbus/msc: add CONFIG_USBUS_MSC_AUTO_MTD option to create LUNs on init #19356

benpicco · 2023-03-06T23:59:05Z

Contribution description

I had some trouble combining tests/usbus_msc with stdio_cdc_acm.
Turns out the test was creating it's own usbus and was therefore not compatible with other modules that make use of usbus.

Fix this by adding USB MSC to auto_init_usbus and add a config option CONFIG_USBUS_MSC_AUTO_MTD to export all MTD devices on startup.

Testing procedure

tests/usbus_msc now provides all MTD devices via USB without manual configutaiton.

More importantly, it now also works on boards that use stdio_cdc_acm like adafruit-itsybitsy-m4:

[ 5252.107261] usb 1-1.4: new full-speed USB device number 40 using ehci-pci
[ 5252.217906] usb 1-1.4: New USB device found, idVendor=1209, idProduct=7d01, bcdDevice= 1.00
[ 5252.217917] usb 1-1.4: New USB device strings: Mfr=3, Product=2, SerialNumber=4
[ 5252.217920] usb 1-1.4: Product: adafruit-itsybitsy-m4
[ 5252.217923] usb 1-1.4: Manufacturer: RIOT-os.org
[ 5252.217925] usb 1-1.4: SerialNumber: 6B1818B4AF9DA5EE
[ 5252.220677] cdc_acm 1-1.4:1.0: ttyACM0: USB ACM device
[ 5252.221092] usb-storage 1-1.4:1.2: USB Mass Storage device detected
[ 5252.221457] scsi host8: usb-storage 1-1.4:1.2
[ 5253.240488] scsi 8:0:0:0: Direct-Access     RIOT-OS  RIOT_MSC_DISK     1.0 PQ: 0 ANSI: 1
[ 5253.240895] sd 8:0:0:0: Attached scsi generic sg3 type 0
[ 5253.241621] sd 8:0:0:0: [sdc] 512 4096-byte logical blocks: (2.10 MB/2.00 MiB)
[ 5253.242220] sd 8:0:0:0: [sdc] Write Protect is off
[ 5253.242223] sd 8:0:0:0: [sdc] Mode Sense: 03 00 00 00
[ 5253.242855] sd 8:0:0:0: [sdc] No Caching mode page found
[ 5253.242858] sd 8:0:0:0: [sdc] Assuming drive cache: write through
[ 5253.266933] sd 8:0:0:0: [sdc] Attached SCSI removable disk

Issues/PRs references

riot-ci · 2023-03-07T00:13:05Z

Murdock results

✔️ PASSED

73400cb tests/usbus_msc: don't use custom usbus

Success	Failures	Total	Runtime
6882	0	6882	09m:19s

Artifacts

Documentation preview

dylad

I'm quite puzzled by this PR right now.
I'd like the idea to initialize USBUS through auto_init() but on the other side, I don't think we should export all MTD devices by default and I don't like the idea of keeping the MSC ON all the time.

As I said in #19242, there are some use cases for this but I still don't think it should be the default behavior.

Boards which provides STDIO through CDC-ACM are tricky because in the current state, users need to have USB attached to the host to have the shell and configure which MTD devices to be exported. But we need to configure those devices before attaching USB to the host so we're a bit stuck here unless we accept to quickly detach/attach the USB (and thus, lose the serial connection for a few ms).

sys/auto_init/usb/auto_init_usb.c

sys/include/usb/usbus.h

dylad · 2023-03-07T08:25:23Z

tests/usbus_msc/Makefile

-# Purposely disable auto_attach for this application
-CFLAGS += -DCONFIG_USBUS_AUTO_ATTACH=0


if CONFIG_USBUS_MSC_AUTO_MTD is set to 0, removing this will lead to issue in the application test.

tbh I wonder why - attaching with no LUNs configured should be no problem if we then detach before adding LUNs, right?

I think I saw an empty (0 byte) device on the host instead, but that might be a bug.

If CONFIG_USBUS_MSC_AUTO_MTD is set to 0 and if we auto attach USB device. No LUNs will be available at the enumuration. Then host will asks the number of available LUNs to the device with an USB_MSC_SETUP_REQ_GML request and answering 0 is not possible by the spec.

I guess we can remove it for now as CONFIG_USBUS_MSC_AUTO_MTD is set by default.

I'll figured it out later.

But can we simply not advertise the MSC endpoint if no LUNs are configured?

Yup, but enable MSC at runtime will require to reset the USB and this might be troublesome for CDC-ACM stdio devices especially on Windows.

dylad · 2023-03-07T08:27:53Z

drivers/include/mtd_default.h

+ * @return  MTD_0 for @p idx 0 and so on
+ *          NULL if no MTD device exists for the given index
+ */
+static inline mtd_dev_t *mtd_default_get_dev(unsigned idx)


Just wondering here:
Why the default part ? mtd_get_dev() would fit well too.

It only works if the MTD devices follow the default naming convention

dylad · 2023-03-09T15:54:10Z

Please squash.

dylad

ACK.

dylad · 2023-03-09T19:49:34Z

bors merge

bors · 2023-03-09T22:01:27Z

Build succeeded:

benpicco added 3 commits March 7, 2023 00:08

sys/auto_init: add support for USB MSC

b6d2209

drivers/mtd_default: add helper function for default MTD devices

092009e

tests/mtd_raw: make use of mtd_default.h

f3dc90c

benpicco requested review from smlng, leandrolanzieri, aabadie, MichelRottleuthner, fjmolinas, bergzand and dylad as code owners March 6, 2023 23:59

github-actions bot added Area: drivers Area: Device drivers Area: sys Area: System Area: tests Area: tests and testing framework Area: USB Area: Universal Serial Bus labels Mar 6, 2023

benpicco added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Mar 6, 2023

dylad reviewed Mar 7, 2023

View reviewed changes

benpicco requested review from jia200x and MrKevinWeiss as code owners March 9, 2023 13:38

github-actions bot added the Area: Kconfig Area: Kconfig integration label Mar 9, 2023

benpicco added 2 commits March 9, 2023 16:57

usbus/msc: add CONFIG_USBUS_MSC_AUTO_MTD option to create LUNs on init

bbda852

tests/usbus_msc: don't use custom usbus

73400cb

benpicco force-pushed the usbus_msc-auto_init branch from 6fc64d4 to 73400cb Compare March 9, 2023 15:57

dylad approved these changes Mar 9, 2023

View reviewed changes

bors bot merged commit bdecf57 into RIOT-OS:master Mar 9, 2023
26 checks passed

benpicco deleted the usbus_msc-auto_init branch March 9, 2023 22:02

MrKevinWeiss added this to the Release 2023.04 milestone Apr 25, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

usbus/msc: add CONFIG_USBUS_MSC_AUTO_MTD option to create LUNs on init #19356

usbus/msc: add CONFIG_USBUS_MSC_AUTO_MTD option to create LUNs on init #19356

benpicco commented Mar 6, 2023

riot-ci commented Mar 7, 2023 •

edited

dylad left a comment

dylad Mar 7, 2023

benpicco Mar 9, 2023 •

edited

dylad Mar 9, 2023

benpicco Mar 9, 2023

dylad Mar 9, 2023

dylad Mar 7, 2023

benpicco Mar 9, 2023

dylad commented Mar 9, 2023

dylad left a comment

dylad commented Mar 9, 2023

bors bot commented Mar 9, 2023

		# Purposely disable auto_attach for this application
		CFLAGS += -DCONFIG_USBUS_AUTO_ATTACH=0

usbus/msc: add CONFIG_USBUS_MSC_AUTO_MTD option to create LUNs on init #19356

usbus/msc: add CONFIG_USBUS_MSC_AUTO_MTD option to create LUNs on init #19356

Conversation

benpicco commented Mar 6, 2023

Contribution description

Testing procedure

Issues/PRs references

riot-ci commented Mar 7, 2023 • edited

Murdock results

Artifacts

dylad left a comment

Choose a reason for hiding this comment

dylad Mar 7, 2023

Choose a reason for hiding this comment

benpicco Mar 9, 2023 • edited

Choose a reason for hiding this comment

dylad Mar 9, 2023

Choose a reason for hiding this comment

benpicco Mar 9, 2023

Choose a reason for hiding this comment

dylad Mar 9, 2023

Choose a reason for hiding this comment

dylad Mar 7, 2023

Choose a reason for hiding this comment

benpicco Mar 9, 2023

Choose a reason for hiding this comment

dylad commented Mar 9, 2023

dylad left a comment

Choose a reason for hiding this comment

dylad commented Mar 9, 2023

bors bot commented Mar 9, 2023

riot-ci commented Mar 7, 2023 •

edited

benpicco Mar 9, 2023 •

edited