LailaTheElf/embassy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

rp: WebUSB example - add Windows compatibility

Browse Source
This commit is contained in:
kalkyl 2024-04-30 09:59:06 +02:00
parent 56a7b10064
commit 7896e8aba7
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
examples/rp/src/bin/usb_webusb.rs
View File

@ -25,6 +25,7 @@ use embassy_rp::peripherals::USB;
use embassy_rp::usb::{Driver as UsbDriver, InterruptHandler}; use embassy_rp::usb::{Driver as UsbDriver, InterruptHandler};
use embassy_usb::class::web_usb::{Config as WebUsbConfig, State, Url, WebUsb}; use embassy_usb::class::web_usb::{Config as WebUsbConfig, State, Url, WebUsb};
use embassy_usb::driver::{Driver, Endpoint, EndpointIn, EndpointOut}; use embassy_usb::driver::{Driver, Endpoint, EndpointIn, EndpointOut};
use embassy_usb::msos::{self, windows_version};
use embassy_usb::{Builder, Config}; use embassy_usb::{Builder, Config};
use {defmt_rtt as _, panic_probe as _}; use {defmt_rtt as _, panic_probe as _};
@ -32,6 +33,9 @@ bind_interrupts!(struct Irqs {
USBCTRL_IRQ => InterruptHandler<USB>; USBCTRL_IRQ => InterruptHandler<USB>;
}); });
// This is a randomly generated GUID to allow clients on Windows to find our device
const DEVICE_INTERFACE_GUIDS: &[&str] = &["{AFB9A6FB-30BA-44BC-9232-806CFC875321}"];
#[embassy_executor::main] #[embassy_executor::main]
async fn main(_spawner: Spawner) { async fn main(_spawner: Spawner) {
let p = embassy_rp::init(Default::default()); let p = embassy_rp::init(Default::default());
@ -58,6 +62,7 @@ async fn main(_spawner: Spawner) {
let mut config_descriptor = [0; 256]; let mut config_descriptor = [0; 256];
let mut bos_descriptor = [0; 256]; let mut bos_descriptor = [0; 256];
let mut control_buf = [0; 64]; let mut control_buf = [0; 64];
let mut msos_descriptor = [0; 256];
let webusb_config = WebUsbConfig { let webusb_config = WebUsbConfig {
max_packet_size: 64, max_packet_size: 64,
@ -73,10 +78,23 @@ async fn main(_spawner: Spawner) {
config, config,
&mut config_descriptor, &mut config_descriptor,
&mut bos_descriptor, &mut bos_descriptor,
&mut [], // no msos descriptors &mut msos_descriptor,
&mut control_buf, &mut control_buf,
); );
// Add the Microsoft OS Descriptor (MSOS/MOD) descriptor.
// We tell Windows that this entire device is compatible with the "WINUSB" feature,
// which causes it to use the built-in WinUSB driver automatically, which in turn
// can be used by libusb/rusb software without needing a custom driver or INF file.
// In principle you might want to call msos_feature() just on a specific function,
// if your device also has other functions that still use standard class drivers.
builder.msos_descriptor(windows_version::WIN8_1, 0);
builder.msos_feature(msos::CompatibleIdFeatureDescriptor::new("WINUSB", ""));
builder.msos_feature(msos::RegistryPropertyFeatureDescriptor::new(
"DeviceInterfaceGUIDs",
msos::PropertyData::RegMultiSz(DEVICE_INTERFACE_GUIDS),
));
// Create classes on the builder (WebUSB just needs some setup, but doesn't return anything) // Create classes on the builder (WebUSB just needs some setup, but doesn't return anything)
WebUsb::configure(&mut builder, &mut state, &webusb_config); WebUsb::configure(&mut builder, &mut state, &webusb_config);
// Create some USB bulk endpoints for testing. // Create some USB bulk endpoints for testing.