usb-gadget 1.2.0

Expose standard or fully custom USB peripherals (gadgets) through a USB device controller (UDC) on Linux.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

use std::os::unix::prelude::FileTypeExt;

use serial_test::serial;
use usb_gadget::function::serial::{Serial, SerialClass};

mod common;
use common::*;

fn serial(serial_class: SerialClass) {
    init();

    let mut builder = Serial::builder(serial_class);
    builder.console = Some(false);
    let (serial, func) = builder.build();

    let reg = reg(func);
    let tty = serial.tty().unwrap();

    println!("Serial device {} function at {}", tty.display(), serial.status().path().unwrap().display());

    assert!(tty.metadata().unwrap().file_type().is_char_device());

    check_host(|_device, cfg| {
        match serial_class {
            SerialClass::Acm => {
                // CDC ACM: class 2 (Communications), subclass 2 (ACM).
                let cdc_intf =
                    cfg.interface_alt_settings().find(|desc| desc.class() == 2 && desc.subclass() == 2);
                assert!(cdc_intf.is_some(), "no CDC ACM interface (class 2, subclass 2) found on host");
                let cdc_intf = cdc_intf.unwrap();
                println!(
                    "CDC ACM interface {}: class={}, subclass={}, protocol={}",
                    cdc_intf.interface_number(),
                    cdc_intf.class(),
                    cdc_intf.subclass(),
                    cdc_intf.protocol(),
                );

                // CDC Data interface: class 10.
                let data_intf = cfg.interface_alt_settings().find(|desc| desc.class() == 10);
                assert!(data_intf.is_some(), "no CDC Data interface (class 10) found on host");
            }
            SerialClass::Generic => {
                // Generic serial: vendor-specific class 255.
                let vendor_intf = cfg.interface_alt_settings().find(|desc| desc.class() == 255);
                assert!(vendor_intf.is_some(), "no vendor-specific interface (class 255) found on host");
                let vendor_intf = vendor_intf.unwrap();
                println!(
                    "generic serial interface {}: class={}, subclass={}, protocol={}",
                    vendor_intf.interface_number(),
                    vendor_intf.class(),
                    vendor_intf.subclass(),
                    vendor_intf.protocol(),
                );
            }
            _ => {}
        }
    });

    if unreg(reg).unwrap() {
        assert!(serial.status().path().is_none());
        assert!(serial.tty().is_err());
    }
}

#[test]
#[serial]
fn acm() {
    serial(SerialClass::Acm)
}

#[test]
#[serial]
fn generic_serial() {
    serial(SerialClass::Generic)
}

#[cfg(feature = "tokio")]
#[tokio::test]
#[serial]
async fn serial_status() {
    use std::time::Duration;
    use tokio::time::sleep;
    use usb_gadget::function::util::State;

    init();

    let mut builder = Serial::builder(SerialClass::Acm);
    builder.console = Some(false);
    let (serial, func) = builder.build();

    let status = serial.status();
    assert_eq!(status.state(), State::Unregistered);

    let task = tokio::spawn(async move { status.bound().await });
    sleep(Duration::from_secs(1)).await;

    let reg = reg(func);

    println!("waiting for bound");
    task.await.unwrap().unwrap();

    let status = serial.status();
    assert_eq!(status.state(), State::Bound);

    let status = serial.status();
    let task = tokio::spawn(async move { status.unbound().await });
    sleep(Duration::from_secs(1)).await;

    if unreg(reg).unwrap() {
        let status = serial.status();
        assert_eq!(status.state(), State::Removed);

        println!("waiting for unbound");
        task.await.unwrap();
    }
}