pub fn scan_frame(buf: &[u8]) -> FrameScanExpand description
Scan a raw HID report buffer for a complete leading message without copying
the body. The USB counterpart to crate::scan_frame; len in
FrameScan::Complete is the raw byte count to drain (a whole number of
REPORT_SIZE reports). FrameScan::Desync means the length prefix is
impossible (zero or over MAX_MESSAGE_LEN); drop one report and rescan.
Examples found in repository?
examples/cli.rs (line 268)
250fn usb_reader_loop(
251 file: Arc<File>,
252 layout: Shared<Option<Layout>>,
253 root: Shared<Option<Node>>,
254 watch: Arc<AtomicBool>,
255) {
256 let mut buf = Vec::<u8>::with_capacity(usb::REPORT_SIZE * 4);
257 let mut report = [0u8; usb::REPORT_SIZE];
258 loop {
259 let mut f: &File = &file;
260 let n = match f.read(&mut report) {
261 Ok(0) => return, // EOF: device went away or main dropped its handle
262 Ok(n) => n,
263 Err(e) if e.kind() == io::ErrorKind::Interrupted => continue,
264 Err(_) => return,
265 };
266 buf.extend_from_slice(&report[..n]);
267 loop {
268 match usb::scan_frame(&buf) {
269 FrameScan::Incomplete => break,
270 FrameScan::Desync => {
271 // One report's worth is junk; drop and rescan.
272 let drop = usb::REPORT_SIZE.min(buf.len());
273 buf.drain(..drop);
274 }
275 FrameScan::Complete { len } => {
276 let Some((packet, consumed)) = usb::Packet::from_bytes(&buf[..len]) else {
277 buf.drain(..len);
278 continue;
279 };
280 buf.drain(..consumed);
281 handle_body(packet.payload, &layout, &root, &watch);
282 }
283 }
284 }
285 }
286}More examples
examples/usb_monitor.rs (line 28)
11fn main() -> Result<(), Box<dyn std::error::Error>> {
12 let path = env::args_os()
13 .nth(1)
14 .ok_or("usage: usb_monitor <path-to-hidraw>")?;
15 let file = OpenOptions::new().read(true).write(true).open(path)?;
16
17 // The device stays silent until a client requests its initial full sync.
18 (&file).write_all(&usb::Packet::new(usb::HANDSHAKE_BODY.to_vec()).to_bytes())?;
19
20 let mut session = ProtocolSession::new();
21 let mut buffered = Vec::new();
22 let mut report = [0_u8; usb::REPORT_SIZE];
23 loop {
24 let read = (&file).read(&mut report)?;
25 buffered.extend_from_slice(&report[..read]);
26
27 loop {
28 let len = match usb::scan_frame(&buffered) {
29 FrameScan::Complete { len } => len,
30 FrameScan::Incomplete => break,
31 FrameScan::Desync => {
32 buffered.drain(..usb::REPORT_SIZE.min(buffered.len()));
33 continue;
34 }
35 };
36 let (packet, consumed) = usb::Packet::from_bytes(&buffered[..len])
37 .ok_or("USB scanner returned an invalid packet")?;
38 buffered.drain(..consumed);
39
40 match session.ingest(&packet.payload)? {
41 SessionUpdate::Ready { initial_events } => {
42 let capabilities = session.capabilities().unwrap();
43 println!(
44 "connected: {} fw {} ({} faders, {} sources, {} mixes)",
45 capabilities.model(),
46 capabilities.firmware().unwrap_or("unknown"),
47 capabilities.faders().len(),
48 capabilities.sources().len(),
49 capabilities.mix_outputs().len(),
50 );
51 println!("initial state: {} typed events", initial_events.len());
52 }
53 SessionUpdate::Event(event) => println!("{event:?}"),
54 SessionUpdate::NeedsFullSync => {
55 eprintln!("layout changed, requesting a fresh full sync");
56 (&file)
57 .write_all(&usb::Packet::new(usb::HANDSHAKE_BODY.to_vec()).to_bytes())?;
58 }
59 }
60 }
61 }
62}