medius 3.4.6

Rust library for Medius, replacement firmware for the MAKCU box
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
//! `CATCH` (§3.9): address space, the three event frames, `RESP(CATCH)`, the HEALTH bit and the
//! EventStream lifecycle, with bytes pinned to ctrl_proto.h.
use std::time::Duration;

#[cfg(feature = "mock")]
use crate::Usage;
use crate::protocol::command::catch_payload;
use crate::protocol::opcode::{CATCH_CLS_ANY, CATCH_ID_ANY, H_CATCH_ON};
use crate::protocol::response::{Resp, parse_resp};
use crate::types::{
    Axis, BusEvent, Capture, CatchClass, CatchFilter, CatchState, Class, ClockDomain,
    ControlStatus, Direction, Health, MotionEvent, TrafficClass, TrafficEvent, TransferStatus,
    UsageSnapshot,
};
use crate::{Button, Key};

#[test]
fn catch_payload_bytes() {
    // Subscribe to everything: class and id both wildcards, state 1.
    assert_eq!(
        catch_payload(CATCH_CLS_ANY, CATCH_ID_ANY, 0, 1, 0),
        [0xFF, 0xFF, 0xFF, 0, 1, 0]
    );
    // One vendor bulk endpoint, IN only, cut to 16 bytes.
    assert_eq!(catch_payload(7, 3, 1, 1, 16), [7, 3, 0x00, 1, 1, 16]);
    // The blanket clear a host sends to tear the whole table down.
    assert_eq!(
        catch_payload(CATCH_CLS_ANY, CATCH_ID_ANY, 0, 0, 0),
        [0xFF, 0xFF, 0xFF, 0, 0, 0]
    );
}

#[test]
fn catch_classes_match_the_wire() {
    // Classes 0..3 must equal LOCK's and INJECT's, or one vocabulary becomes two with no error.
    assert_eq!(CatchClass::Button.as_u8(), 0);
    assert_eq!(CatchClass::Key.as_u8(), 1);
    assert_eq!(CatchClass::Media.as_u8(), 2);
    assert_eq!(CatchClass::Axis.as_u8(), 3);
    assert_eq!(CatchClass::HidIn.as_u8(), 4);
    assert_eq!(CatchClass::HidOut.as_u8(), 5);
    assert_eq!(CatchClass::VendorInterrupt.as_u8(), 6);
    assert_eq!(CatchClass::VendorBulk.as_u8(), 7);
    assert_eq!(CatchClass::Control.as_u8(), 8);
    assert_eq!(CatchClass::Emit.as_u8(), 9);
    assert_eq!(CatchClass::Bus.as_u8(), 10);
    assert_eq!(CatchClass::ClipTransfer.as_u8(), 11);
    assert_eq!(CatchClass::from_u8(10), Some(CatchClass::Bus));
    assert_eq!(CatchClass::from_u8(11), Some(CatchClass::ClipTransfer));
    assert_eq!(CatchClass::from_u8(12), None);
    assert_eq!(CatchClass::from_u8(0xFF), None); // the wildcard is not a class
}

#[test]
fn the_two_class_vocabularies_agree() {
    // Class (INJECT/LOCK) and CatchClass share byte values, so a UsageSnapshot's class compares to
    // the filter that asked for it.
    for (c, want) in [
        (Class::Button, CatchClass::Button),
        (Class::Key, CatchClass::Key),
        (Class::Media, CatchClass::Media),
    ] {
        assert_eq!(CatchClass::from(c), want);
        assert_eq!(c.as_u8(), want.as_u8());
    }
    for t in TrafficClass::ALL {
        let c = CatchClass::from(t);
        assert_eq!(t.as_u8(), c.as_u8());
        assert!(c.is_traffic() && !c.is_input());
        assert_eq!(TrafficClass::try_from(c), Ok(t));
    }
    // The input half refuses to become a traffic class, returning itself as the error.
    assert_eq!(
        TrafficClass::try_from(CatchClass::Key),
        Err(CatchClass::Key)
    );
    assert!(CatchClass::Axis.is_input());
}

#[test]
fn direction_reads_three_ways_over_two_values() {
    assert_eq!(Direction::PRESS, Direction::Positive);
    assert_eq!(Direction::IN, Direction::Positive);
    assert_eq!(Direction::RELEASE, Direction::Negative);
    assert_eq!(Direction::OUT, Direction::Negative);
    assert!(Direction::Both.admits(Direction::Positive));
    assert!(Direction::Positive.admits(Direction::Both));
    assert!(!Direction::Positive.admits(Direction::Negative));
    assert_eq!(Direction::of_delta(3), Direction::Positive);
    assert_eq!(Direction::of_delta(-3), Direction::Negative);
    assert_eq!(Direction::of_delta(0), Direction::Both);
}

#[test]
fn capture_normalises_and_widens() {
    assert_eq!(Capture::Whole.bytes(), None);
    assert_eq!(
        Capture::First(0).bytes(),
        None,
        "First(0) is the whole packet"
    );
    assert_eq!(Capture::First(16).bytes(), Some(16));
    // 0 on the wire means whole, so whole is wider than every finite length in both orders.
    assert_eq!(
        Capture::First(16).widest(Capture::First(64)),
        Capture::First(64)
    );
    assert_eq!(
        Capture::First(64).widest(Capture::First(16)),
        Capture::First(64)
    );
    assert_eq!(Capture::First(16).widest(Capture::Whole), Capture::Whole);
    assert_eq!(Capture::Whole.widest(Capture::First(16)), Capture::Whole);
    assert_eq!(Capture::First(0).widest(Capture::First(16)), Capture::Whole);
}

#[test]
fn equality_covers_the_capture_and_addressing_does_not() {
    // Filters differing only in capture are one box entry (the box dedups on class, id, direction)
    // but behave differently. So PartialEq covers capture; otherwise assert_eq! passes on both.
    // same_address() compares the address alone.
    let a = CatchFilter::traffic(TrafficClass::VendorBulk, 3);
    let b = a.with_capture(Capture::First(16));
    assert_ne!(a, b);
    assert!(a.same_address(b));
    let c = a.with_direction(Direction::OUT);
    assert!(!a.same_address(c), "direction is part of the box's key");
}

#[test]
fn watching_an_input_is_written_like_locking_it() {
    // `lock(Key::A, ..)` and `watch(Key::A)` name the same thing alike, with no id arithmetic.
    assert_eq!(
        CatchFilter::watch(Key::new(0x04)).wire(),
        (CatchClass::Key.as_u8(), 0x04)
    );
    assert_eq!(
        CatchFilter::watch(Button::LEFT).wire(),
        (CatchClass::Button.as_u8(), Button::LEFT.as_id() as u16)
    );
    assert_eq!(
        CatchFilter::watch_axis(Axis::Wheel).wire(),
        (CatchClass::Axis.as_u8(), Axis::Wheel.as_u16())
    );
    assert_eq!(
        CatchFilter::watch_class(Class::Media).wire(),
        (CatchClass::Media.as_u8(), CATCH_ID_ANY)
    );
    let all = CatchFilter::all_input();
    assert_eq!(all.len(), 4);
    assert!(all.iter().all(|f| f.class().unwrap().is_input()));
    assert!(all.iter().all(|f| f.id().is_none()));
}

#[test]
fn filter_builders_produce_the_right_wire_pair() {
    assert_eq!(
        CatchFilter::everything().wire(),
        (CATCH_CLS_ANY, CATCH_ID_ANY)
    );
    assert_eq!(
        CatchFilter::traffic_class(TrafficClass::Emit).wire(),
        (9, CATCH_ID_ANY)
    );
    assert_eq!(
        CatchFilter::traffic(TrafficClass::VendorBulk, 3).wire(),
        (7, 3)
    );
    let f = CatchFilter::traffic(TrafficClass::HidOut, 2)
        .outbound()
        .with_capture(Capture::First(24));
    assert_eq!(f.direction(), Direction::Negative);
    assert_eq!(f.capture(), Capture::First(24));
    assert_eq!(
        CatchFilter::watch(Key::new(0x04)).on_press().direction(),
        Direction::Positive
    );
    assert_eq!(
        CatchFilter::traffic_class(TrafficClass::HidIn)
            .inbound()
            .direction(),
        Direction::Positive
    );
}

#[test]
fn a_wildcard_class_carrying_a_real_id_addresses_nothing() {
    // `id` means something different in every class, so the box refuses this and so must the host;
    // read as a wildcard it would subscribe to everything, with no error.
    assert!(CatchFilter::from_wire(CATCH_CLS_ANY, 5, 0, 0).is_none());
    assert!(CatchFilter::from_wire(CATCH_CLS_ANY, CATCH_ID_ANY, 0, 0).is_some());
    assert!(CatchFilter::from_wire(200, 5, 0, 0).is_none()); // unknown class
    assert!(CatchFilter::from_wire(7, 5, 9, 0).is_none()); // unknown direction
    let f = CatchFilter::from_wire(7, 3, 2, 16).unwrap();
    assert_eq!(f.class(), Some(CatchClass::VendorBulk));
    assert_eq!(f.id(), Some(3));
    assert_eq!(f.direction(), Direction::OUT);
    assert_eq!(f.capture(), Capture::First(16));
    assert_eq!(f.wire(), (7, 3));
}

#[test]
fn motion_event_decodes_with_its_clock_domain() {
    // [ts u32][clk u8][dx][dy][dz][dpan]: clk between ts and the axes, dpan after the wheel.
    // Hand-laid so any field offset shift fails the asserts.
    let p = [
        0x04, 0x03, 0x02, 0x01, 0, 0x2C, 0x01, 0xCE, 0xFF, 0xFF, 0xFF, 0x07, 0x00,
    ];
    let m = MotionEvent::from_payload(&p).unwrap();
    assert_eq!(m.ts_us, 0x0102_0304);
    assert_eq!(m.clock, ClockDomain::HostChip);
    assert_eq!((m.dx, m.dy, m.dz, m.pan), (300, -50, -1, 7));
    // One byte short of the four-axis frame decodes to nothing.
    assert!(MotionEvent::from_payload(&p[..12]).is_none());
    // axes() names only what moved; all_axes() names all four whatever they are.
    let moved: Vec<_> = m.axes().collect();
    assert_eq!(
        moved,
        [
            (Axis::X, 300),
            (Axis::Y, -50),
            (Axis::Wheel, -1),
            (Axis::Pan, 7)
        ]
    );
    let still = MotionEvent {
        dx: 0,
        dy: 0,
        dz: 4,
        pan: 0,
        ..m
    };
    assert_eq!(still.axes().collect::<Vec<_>>(), [(Axis::Wheel, 4)]);
    assert_eq!(still.all_axes().len(), 4);
}

#[test]
fn usage_snapshot_decodes_with_its_clock_domain() {
    // [ts u32][clk=0][cls=0 Button][dir=1 press][n=2] then two usages.
    let p = [0, 0, 0, 0, 0, 0, 1, 2, 0, 0, 0, 1, 0x04, 0x00];
    let s = UsageSnapshot::from_payload(&p).unwrap();
    assert_eq!(s.clock, ClockDomain::HostChip);
    assert_eq!(s.usages.len(), 2);
    assert_eq!(s.class, Class::Button);
    assert!(s.is_held(Button::LEFT));
    assert!(s.is_held(Key::new(0x04)));
}

#[test]
fn an_empty_snapshot_still_names_the_class_that_went_quiet() {
    // Releasing the last held usage is the edge a caller is waiting for, and it lists nothing.
    for (byte, want) in [(0u8, Class::Button), (1, Class::Key), (2, Class::Media)] {
        let p = [7, 0, 0, 0, 0, byte, 2, 0];
        let s = UsageSnapshot::from_payload(&p).unwrap();
        assert_eq!(s.class, want);
        assert_eq!(s.direction, Direction::Negative);
        assert!(s.usages.is_empty());
        assert_eq!(s.ts_us, 7);
    }
    assert!(UsageSnapshot::from_payload(&[7, 0, 0, 0, 0, 9, 2, 0]).is_none()); // unknown class
    assert!(UsageSnapshot::from_payload(&[7, 0, 0, 0, 0, 0, 9, 0]).is_none()); // unknown direction
    assert!(UsageSnapshot::from_payload(&[7, 0, 0, 0, 0, 0]).is_none()); // no direction byte at all
}

#[test]
fn a_cut_setup_packet_is_not_reported_as_a_data_stage() {
    // A control event captured under 8 bytes keeps only part of its setup packet.
    let p = [0, 0, 0, 0, 1, 8, 0, 0, 0, 0, 8, 0, 0x80, 0x06, 0x00, 0x01];
    let t = TrafficEvent::from_payload(&p).unwrap();
    assert_eq!(t.class, CatchClass::Control);
    assert_eq!(t.bytes.len(), 4);
    assert!(t.truncated());
    assert_eq!(t.setup(), None);
    assert!(t.data().is_empty(), "got {:?}", t.data());

    // The whole packet present: setup and data split where they should.
    let full = [
        0, 0, 0, 0, 1, 8, 0, 0, 0, 0, 10, 0, 0x80, 0x06, 0x00, 0x01, 0, 0, 0x12, 0, 0x12, 0x01,
    ];
    let t = TrafficEvent::from_payload(&full).unwrap();
    assert_eq!(t.setup().unwrap(), &[0x80, 0x06, 0x00, 0x01, 0, 0, 0x12, 0]);
    assert_eq!(t.data(), &[0x12, 0x01]);
}

#[test]
fn control_status_covers_every_handshake_the_pc_can_get() {
    let with_flags = |flags: u8| {
        let p = [0, 0, 0, 0, 1, 8, 0, 0, 0, flags, 0, 0];
        TrafficEvent::from_payload(&p).unwrap().control_status()
    };
    assert_eq!(with_flags(0x00), Some(ControlStatus::Ok));
    assert_eq!(with_flags(0x01), Some(ControlStatus::Stalled));
    assert_eq!(with_flags(0x02), Some(ControlStatus::Naked));
    // The handshake is bits 0-1 alone: the rule bit beside it changes nothing.
    assert_eq!(with_flags(0x81), Some(ControlStatus::Stalled));
    assert_eq!(with_flags(0x80), Some(ControlStatus::Ok));
    // An unknown value stays unknown: a catch-all arm would read a newer firmware's value as a
    // timeout, a device fault that never happened.
    assert_eq!(with_flags(0x03), Some(ControlStatus::Other(0x03)));
    // A class that is not Control has no control status at all, whatever its flags say.
    let p = [0, 0, 0, 0, 1, 7, 3, 0x00, 1, 0x01, 0, 0];
    assert_eq!(
        TrafficEvent::from_payload(&p).unwrap().control_status(),
        None
    );
}

// Bit 7 is the rule bit only on the six classes a rule acts at: a clip transfer's flags are a
// TRANSFER status, whose 0xFD STALL has bit 7 set.
#[test]
fn the_rule_bit_is_read_only_where_a_rule_acts() {
    let event = |class: u8, flags: u8| {
        let p = [0, 0, 0, 0, 1, class, 0, 0, 1, flags, 0, 0];
        TrafficEvent::from_payload(&p).unwrap()
    };
    for class in [
        CatchClass::HidIn,
        CatchClass::HidOut,
        CatchClass::VendorInterrupt,
        CatchClass::VendorBulk,
        CatchClass::Control,
        CatchClass::Emit,
    ] {
        assert!(event(class.as_u8(), 0x80).rule_acted(), "{class:?}");
        assert!(!event(class.as_u8(), 0x03).rule_acted(), "{class:?}");
    }
    let xfer = event(CatchClass::ClipTransfer.as_u8(), 0xFD);
    assert!(!xfer.rule_acted());
    assert_eq!(xfer.transfer_status(), Some(TransferStatus::Stall));
    assert!(!event(CatchClass::Bus.as_u8(), 0x80).rule_acted());
    // A bulk event keeps two separate bits beside it.
    let bulk = event(CatchClass::VendorBulk.as_u8(), 0x81);
    assert!(bulk.rule_acted() && bulk.bulk_end_of_transfer() && !bulk.zlp());
}

#[test]
fn a_zero_length_packet_is_flagged_on_every_packet_class() {
    let zlp = |class: CatchClass, flags: u8| {
        let p = [0, 0, 0, 0, 1, class.as_u8(), 3, 0x00, 1, flags, 0, 0];
        TrafficEvent::from_payload(&p).unwrap().zlp()
    };
    for class in [
        CatchClass::HidIn,
        CatchClass::HidOut,
        CatchClass::VendorInterrupt,
        CatchClass::VendorBulk,
        CatchClass::Emit,
    ] {
        assert!(!zlp(class, 0x00), "{class:?}");
        assert!(zlp(class, 0x02), "{class:?}");
        assert!(zlp(class, 0x82), "{class:?}: beside a rule");
    }
    assert!(!zlp(CatchClass::VendorBulk, 0x01)); // END alone is not a ZLP
    assert!(zlp(CatchClass::VendorBulk, 0x03)); // END and ZLP together
    // Bit 1 is a control event's NAK handshake and a transfer's status, never a ZLP.
    assert!(!zlp(CatchClass::Control, 0x02));
    assert!(!zlp(CatchClass::ClipTransfer, 0x02));
}

#[test]
fn traffic_event_decodes() {
    // [ts][clk=1][class=7 VendorBulk][id=3][dir=1 IN][flags=1 END][true_len=4][4 bytes]
    let p = [
        0x04, 0x03, 0x02, 0x01, 1, 7, 3, 0x00, 1, 0x01, 0x04, 0x00, 0xDE, 0xAD, 0xBE, 0xEF,
    ];
    let t = TrafficEvent::from_payload(&p).unwrap();
    assert_eq!(t.ts_us, 0x0102_0304);
    assert_eq!(t.clock, ClockDomain::DeviceChip);
    assert_eq!(t.class, CatchClass::VendorBulk);
    assert_eq!(t.id, 3);
    assert_eq!(t.direction, Direction::IN);
    assert_eq!(t.true_len, 4);
    assert_eq!(t.bytes, [0xDE, 0xAD, 0xBE, 0xEF]);
    assert!(!t.truncated());
    assert!(t.bulk_end_of_transfer());
    assert!(!t.zlp());
    assert!(TrafficEvent::from_payload(&p[..11]).is_none());
    // An unknown class must not decode into a plausible one.
    let mut bad = p;
    bad[5] = 200;
    assert!(TrafficEvent::from_payload(&bad).is_none());
}

#[test]
fn truncation_is_visible() {
    // true_len 64 with 8 bytes delivered: only true_len tells a cut capture from a short packet.
    let mut p = vec![0, 0, 0, 0, 1, 6, 3, 0x00, 1, 0, 64, 0];
    p.extend_from_slice(&[1, 2, 3, 4, 5, 6, 7, 8]);
    let t = TrafficEvent::from_payload(&p).unwrap();
    assert_eq!(t.true_len, 64);
    assert_eq!(t.bytes.len(), 8);
    assert!(t.truncated());
}

#[test]
fn control_event_splits_setup_from_data() {
    let mut p = vec![0, 0, 0, 0, 1, 8, 0x00, 0x00, 1, 0x00, 10, 0];
    p.extend_from_slice(&[0xA1, 0x01, 0x00, 0x02, 0x00, 0x00, 0x02, 0x00]); // setup
    p.extend_from_slice(&[0xAA, 0xBB]); // data stage
    let t = TrafficEvent::from_payload(&p).unwrap();
    assert_eq!(
        t.setup().unwrap(),
        &[0xA1, 0x01, 0x00, 0x02, 0x00, 0x00, 0x02, 0x00]
    );
    assert_eq!(t.data(), &[0xAA, 0xBB]);
    assert_eq!(t.control_status(), Some(ControlStatus::Ok));
    let mut stalled = p.clone();
    stalled[9] = 0x01;
    assert_eq!(
        TrafficEvent::from_payload(&stalled)
            .unwrap()
            .control_status(),
        Some(ControlStatus::Stalled)
    );
    // Other classes have no setup packet, and their whole payload is data.
    let other = [0u8, 0, 0, 0, 1, 9, 0, 0, 1, 0, 2, 0, 0x11, 0x22];
    let o = TrafficEvent::from_payload(&other).unwrap();
    assert!(o.setup().is_none());
    assert_eq!(o.data(), &[0x11, 0x22]);
    assert!(o.control_status().is_none());
}

// A clip's transfer comes back in a control event's shape, with the status a transfer returns.
#[test]
fn clip_transfer_event_splits_like_a_control_event_and_carries_a_transfer_status() {
    let mut p = vec![0, 0, 0, 0, 1, 11, 0x00, 0x00, 1, 0x00, 26, 0];
    p.extend_from_slice(&[0x80, 0x06, 0x00, 0x01, 0x00, 0x00, 0x12, 0x00]);
    p.extend_from_slice(&[0x12, 0x01, 0x00, 0x02]);
    let t = TrafficEvent::from_payload(&p).unwrap();
    assert_eq!(t.class, CatchClass::ClipTransfer);
    assert_eq!(t.setup().unwrap(), &p[12..20]);
    assert_eq!(t.data(), &[0x12, 0x01, 0x00, 0x02]);
    assert_eq!(t.transfer_status(), Some(TransferStatus::Ok));
    assert!(t.control_status().is_none());
    for (flags, want) in [
        (0xFD, TransferStatus::Stall),
        (0xFE, TransferStatus::Nak),
        (0xFF, TransferStatus::NoDevice),
        (0xFC, TransferStatus::Refused),
    ] {
        let mut q = p.clone();
        q[9] = flags;
        assert_eq!(
            TrafficEvent::from_payload(&q).unwrap().transfer_status(),
            Some(want)
        );
    }
    // A control event's flags are the handshake the game PC received, not a transfer's status.
    let mut ctl = p.clone();
    ctl[5] = 8;
    assert!(
        TrafficEvent::from_payload(&ctl)
            .unwrap()
            .transfer_status()
            .is_none()
    );
    // Cut inside the setup packet, the surviving bytes are the request and not data.
    let cut = TrafficEvent::from_payload(&p[..16]).unwrap();
    assert!(cut.setup().is_none());
    assert!(cut.data().is_empty());
}

#[test]
fn bus_event_decodes_its_kind() {
    let mk = |flags: u8, a: u8, b: u8| {
        TrafficEvent::from_payload(&[0, 0, 0, 0, 1, 10, 0xFF, 0xFF, 0, flags, 2, 0, a, b]).unwrap()
    };
    assert_eq!(mk(0, 0, 0).bus_event(), Some(BusEvent::Reset));
    assert_eq!(mk(3, 2, 0).bus_event(), Some(BusEvent::Configured(2)));
    assert_eq!(
        mk(5, 1, 3).bus_event(),
        Some(BusEvent::SetInterface {
            interface: 1,
            alt: 3
        })
    );
    assert_eq!(mk(9, 0, 0).bus_event(), Some(BusEvent::CloneDown));
    assert_eq!(mk(200, 0, 0).bus_event(), None);
}

#[test]
fn a_catch_event_answers_class_id_and_direction_uniformly() {
    use crate::types::CatchEvent;
    let motion = CatchEvent::Motion(
        MotionEvent::from_payload(&[0, 0, 0, 0, 0, 1, 0, 0xFF, 0xFF, 0, 0, 0, 0]).unwrap(),
    );
    assert_eq!(motion.class(), CatchClass::Axis);
    assert_eq!(motion.id(), None);
    // Both, not a guess: this report moved X positive and Y negative at once.
    assert_eq!(motion.direction(), Direction::Both);
    assert!(motion.bytes().is_empty());

    let usages =
        CatchEvent::Usages(UsageSnapshot::from_payload(&[0, 0, 0, 0, 0, 1, 1, 0]).unwrap());
    assert_eq!(usages.class(), CatchClass::Key);
    assert_eq!(usages.id(), None);
    assert_eq!(usages.direction(), Direction::PRESS);
    assert!(usages.bytes().is_empty());

    let traffic = CatchEvent::Traffic(
        TrafficEvent::from_payload(&[0, 0, 0, 0, 1, 7, 3, 0, 2, 0, 1, 0, 9]).unwrap(),
    );
    assert_eq!(traffic.class(), CatchClass::VendorBulk);
    assert_eq!(traffic.id(), Some(3));
    assert_eq!(traffic.direction(), Direction::OUT);
    assert_eq!(traffic.bytes(), &[9]);
}

#[test]
fn catch_state_decodes_header_entries_and_clock() {
    let mut p = vec![7u8, 0x01]; // what, flags: table full
    p.extend_from_slice(&0x0102_0304u32.to_le_bytes()); // dropped
    p.extend_from_slice(&(-250i32).to_le_bytes()); // clk_offset_us
    p.extend_from_slice(&(-1500i32).to_le_bytes()); // clk_rate_ppb
    p.extend_from_slice(&90u16.to_le_bytes()); // clk_delay_us
    p.extend_from_slice(&12u16.to_le_bytes()); // clk_age_ms
    p.push(2); // n
    p.extend_from_slice(&[3, 0xFF, 0xFF, 0, 0, 7, 0]); // axis blanket, 7 drops
    p.extend_from_slice(&[7, 3, 0x00, 1, 16, 0xA0, 0x0F]); // vend bulk ep, 4000 drops

    let c = CatchState::from_payload(&p).unwrap();
    assert!(c.table_full);
    assert_eq!(c.dropped, 0x0102_0304);
    assert_eq!(c.clock.offset_us, -250);
    assert_eq!(c.clock.rate_ppb, Some(-1500));
    assert_eq!(c.clock.delay_us, 90);
    assert_eq!(c.clock.error_bound_us(), 45);
    assert_eq!(c.clock.age.unwrap().as_millis(), 12);
    assert_eq!(c.entries.len(), 2);
    assert_eq!(c.entries[0].filter.class(), Some(CatchClass::Axis));
    assert_eq!(c.entries[0].filter.id(), None);
    assert_eq!(c.entries[0].dropped, 7);
    assert_eq!(c.entries[1].filter.id(), Some(3));
    assert_eq!(c.entries[1].filter.capture(), Capture::First(16));
    assert_eq!(c.entries[1].dropped, 4000);
    assert!(CatchState::from_payload(&p[..18]).is_none());
}

#[test]
fn one_unrecognised_entry_does_not_discard_the_whole_reply() {
    // A class this build does not know must cost that entry and nothing else.
    let mut p = vec![7u8, 0];
    p.extend_from_slice(&99u32.to_le_bytes());
    p.extend_from_slice(&0i32.to_le_bytes());
    p.extend_from_slice(&0i32.to_le_bytes());
    p.extend_from_slice(&90u16.to_le_bytes());
    p.extend_from_slice(&12u16.to_le_bytes());
    p.push(3);
    p.extend_from_slice(&[3, 0xFF, 0xFF, 0, 0, 7, 0]); // axis blanket
    p.extend_from_slice(&[77, 0x01, 0x00, 0, 0, 1, 0]); // a class from some later firmware
    p.extend_from_slice(&[7, 3, 0x00, 1, 16, 5, 0]); // vendor bulk

    let c = CatchState::from_payload(&p).unwrap();
    assert_eq!(c.dropped, 99);
    assert_eq!(c.clock.delay_us, 90);
    assert_eq!(c.entries.len(), 2);
    assert_eq!(c.entries[0].filter.class(), Some(CatchClass::Axis));
    assert_eq!(c.entries[1].filter.class(), Some(CatchClass::VendorBulk));
    assert_eq!(c.entries[1].dropped, 5);
}

#[test]
fn a_device_stamp_translates_into_the_host_domain() {
    // The box reports host-minus-device, so a positive offset moves a device stamp forward. Testing
    // only the None path let a sign inversion pass.
    let build = |offset: i32, age: u16| {
        let mut p = vec![7u8, 0];
        p.extend_from_slice(&0u32.to_le_bytes());
        p.extend_from_slice(&offset.to_le_bytes());
        p.extend_from_slice(&0i32.to_le_bytes());
        p.extend_from_slice(&90u16.to_le_bytes());
        p.extend_from_slice(&age.to_le_bytes());
        p.push(0);
        CatchState::from_payload(&p).unwrap().clock
    };
    assert_eq!(build(250, 12).to_host_domain(1_000), Some(1_250));
    assert_eq!(build(-250, 12).to_host_domain(1_000), Some(750));
    // Past the u32 wrap it stays arithmetic rather than saturating: the caller gets an i64.
    assert_eq!(
        build(1_000, 12).to_host_domain(u32::MAX),
        Some(4_294_968_295)
    );
    assert_eq!(build(250, u16::MAX).to_host_domain(1_000), None);
}

#[test]
fn an_unfitted_rate_is_distinct_from_a_measured_zero() {
    // Two different values over the same wire field.
    let build = |rate: i32| {
        let mut p = vec![7u8, 0];
        p.extend_from_slice(&0u32.to_le_bytes());
        p.extend_from_slice(&0i32.to_le_bytes());
        p.extend_from_slice(&rate.to_le_bytes());
        p.extend_from_slice(&90u16.to_le_bytes());
        p.extend_from_slice(&12u16.to_le_bytes());
        p.push(0);
        CatchState::from_payload(&p).unwrap()
    };
    let none = build(crate::protocol::opcode::CLK_RATE_NONE);
    assert_eq!(none.clock.rate_ppb, None);
    assert_eq!(none.clock.drift_us_over(Duration::from_secs(10)), 0);

    let flat = build(0);
    assert_eq!(flat.clock.rate_ppb, Some(0));
    assert_eq!(flat.clock.drift_us_over(Duration::from_secs(10)), 0);
    assert_ne!(none.clock.rate_ppb, flat.clock.rate_ppb);

    // A real rate extrapolates: 20 ppm over 10 s is 200 us, far past the reply's 45 us error bound.
    let drifting = build(20_000);
    assert_eq!(drifting.clock.drift_us_over(Duration::from_secs(10)), 200);
    assert_eq!(drifting.clock.drift_us_over(Duration::from_secs(0)), 0);
}

#[test]
fn no_clock_estimate_is_distinct_from_a_zero_offset() {
    // 0xFFFF age means no estimate; read as 0 ms old, a caller would trust an unmeasured offset.
    let mut p = vec![7u8, 0];
    p.extend_from_slice(&0u32.to_le_bytes());
    p.extend_from_slice(&0i32.to_le_bytes());
    p.extend_from_slice(&0i32.to_le_bytes());
    p.extend_from_slice(&0u16.to_le_bytes());
    p.extend_from_slice(&u16::MAX.to_le_bytes());
    p.push(0);
    let c = CatchState::from_payload(&p).unwrap();
    assert_eq!(c.clock.age, None);
    assert_eq!(c.clock.offset_us, 0);
    assert_eq!(c.clock.to_host_domain(1000), None);
    assert!(c.is_empty());
}

#[test]
fn decode_catch_through_parse_resp() {
    let mut p = vec![7u8, 0];
    p.extend_from_slice(&[0; 16]);
    p.push(0);
    assert!(matches!(parse_resp(&p), Some(Resp::Catch(_))));
}

#[test]
fn health_catch_on_bit_roundtrips() {
    let h = Health::from_flags(u16::from(H_CATCH_ON));
    assert!(h.catch_on);
    assert_eq!(h.to_flags(), u16::from(H_CATCH_ON));
}

#[cfg(feature = "mock")]
mod with_mock {
    use super::*;
    use crate::types::Input;
    use crate::{CatchEvent, Device, Error, FrameType, MockBox};

    fn bulk(id: u16) -> CatchFilter {
        CatchFilter::traffic(TrafficClass::VendorBulk, id)
    }

    #[test]
    fn subscribing_sends_one_frame_per_entry_and_dropping_unsubscribes() {
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        {
            let _s = dev
                .catch_events([
                    CatchFilter::everything().with_capture(Capture::First(16)),
                    bulk(3),
                ])
                .unwrap();
            let sent: Vec<_> = mock
                .recorded_frames()
                .into_iter()
                .filter(|f| f.ty == FrameType::Catch)
                .collect();
            assert_eq!(sent.len(), 2);
            assert!(sent.iter().all(|f| f.payload[4] == 1)); // both are subscribes
        }
        // The guard fires on drop; the box must be told to stop.
        let last = mock
            .recorded_frames()
            .into_iter()
            .rfind(|f| f.ty == FrameType::Catch)
            .unwrap();
        assert_eq!(last.payload[4], 0);
    }

    #[test]
    fn an_empty_subscription_is_refused() {
        // Otherwise the caller holds a stream that never yields, which reads as a dead box.
        let dev = Device::with_mock(MockBox::new());
        assert!(matches!(
            dev.catch_events([]).unwrap_err(),
            Error::EmptySubscription
        ));
        assert!(matches!(
            dev.input_events([]).unwrap_err(),
            Error::EmptySubscription
        ));
    }

    #[test]
    fn a_capture_on_an_input_class_is_refused_not_ignored() {
        // The firmware's input taps ignore the capture (NULL where the traffic tap passes
        // &snaplen), so accepting one would be a setting with no effect.
        let dev = Device::with_mock(MockBox::new());
        let err = dev
            .catch_events([CatchFilter::watch_class(Class::Key).with_capture(Capture::First(8))])
            .unwrap_err();
        assert!(
            matches!(err, Error::CaptureNotApplicable { class } if class == CatchClass::Key),
            "got {err:?}"
        );
        // The wildcard covers traffic, so capping it is correct and must still be allowed.
        let _ok = dev
            .catch_events([CatchFilter::everything().with_capture(Capture::First(16))])
            .expect("everything() may be capped");
    }

    #[test]
    fn an_exact_id_of_the_blanket_sentinel_is_refused() {
        // 0xFFFF is the every-id sentinel on the wire.
        let dev = Device::with_mock(MockBox::new());
        let err = dev
            .catch_events([CatchFilter::watch(Usage::new(Class::Media, 0xFFFF))])
            .unwrap_err();
        assert!(
            matches!(err, Error::ReservedId { class, id } if class == CatchClass::Media && id == 0xFFFF),
            "got {err:?}"
        );
        // The blanket itself is still fine: it means the whole class on purpose.
        let _ok = dev
            .catch_events([CatchFilter::watch_class(Class::Media)])
            .expect("a blanket is not an exact id");
        // And one below the sentinel is a valid usage.
        let _fine = dev
            .catch_events([CatchFilter::watch(Usage::new(Class::Media, 0xFFFE))])
            .expect("0xFFFE addresses one usage");
    }

    #[test]
    fn input_events_refuses_what_it_cannot_decode() {
        let dev = Device::with_mock(MockBox::new());
        let err = dev
            .input_events([CatchFilter::traffic_class(TrafficClass::VendorBulk)])
            .unwrap_err();
        assert!(
            matches!(err, Error::NotAnInputFilter { class } if class == CatchClass::VendorBulk),
            "got {err:?}"
        );
        assert!(matches!(
            dev.input_events([CatchFilter::everything()]).unwrap_err(),
            Error::WildcardNotInput
        ));
        // A press-only subscription never receives the release, so the next press looks like a
        // chord and the decoder stops reporting the key after its first press.
        assert!(matches!(
            dev.input_events([CatchFilter::watch(Key::new(0x04)).on_press()])
                .unwrap_err(),
            Error::HalfEdgeInputFilter
        ));
        let _ok = dev
            .input_events(CatchFilter::all_input())
            .expect("all_input is what input_events is for");
    }

    #[test]
    fn pushed_events_of_every_kind_arrive_on_the_stream() {
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let s = dev.catch_events([CatchFilter::everything()]).unwrap();

        mock.push_motion(0, 1_000, 5, -7, 1, 0);
        mock.push_usages(
            1,
            2_000,
            Class::Button,
            Direction::PRESS,
            &[Usage::from(Button::SIDE1)],
        );
        mock.push_traffic(
            2,
            3_000,
            ClockDomain::DeviceChip,
            CatchClass::Emit,
            0,
            Direction::IN,
            0,
            3,
            &[1, 2, 3],
        );

        match s.recv().unwrap() {
            CatchEvent::Motion(m) => assert_eq!((m.dx, m.dy, m.dz), (5, -7, 1)),
            other => panic!("expected motion, got {other:?}"),
        }
        match s.recv().unwrap() {
            CatchEvent::Usages(u) => assert!(u.is_held(Button::SIDE1)),
            other => panic!("expected usages, got {other:?}"),
        }
        match s.recv().unwrap() {
            CatchEvent::Traffic(t) => {
                assert_eq!(t.class, CatchClass::Emit);
                assert_eq!(t.clock, ClockDomain::DeviceChip);
                assert_eq!(t.bytes, [1, 2, 3]);
            }
            other => panic!("expected traffic, got {other:?}"),
        }
    }

    #[test]
    fn the_stream_is_an_iterator() {
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let s = dev.catch_events([CatchFilter::everything()]).unwrap();
        for i in 0..3u8 {
            mock.push_motion(i, 100 + i as u32, i as i16 + 1, 0, 0, 0);
        }
        let dx: Vec<i16> = (&s)
            .into_iter()
            .take(3)
            .map(|e| match e {
                CatchEvent::Motion(m) => m.dx,
                other => panic!("expected motion, got {other:?}"),
            })
            .collect();
        assert_eq!(dx, [1, 2, 3]);
    }

    #[test]
    fn every_variant_reports_its_stamp_and_domain_uniformly() {
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let s = dev.catch_events([CatchFilter::everything()]).unwrap();
        mock.push_motion(0, 111, 1, 0, 0, 0);
        mock.push_traffic(
            1,
            222,
            ClockDomain::DeviceChip,
            CatchClass::Bus,
            0xFFFF,
            Direction::Both,
            0,
            2,
            &[0, 0],
        );
        let a = s.recv().unwrap();
        let b = s.recv().unwrap();
        assert_eq!((a.ts_us(), a.clock()), (111, ClockDomain::HostChip));
        assert_eq!((b.ts_us(), b.clock()), (222, ClockDomain::DeviceChip));
    }

    #[test]
    fn the_widest_capture_reaches_the_box() {
        // One box entry per address, so two subscribers' captures resolve to the wider one.
        let capture_sent_to_box = |a: Capture, b: Capture| {
            let mock = MockBox::new();
            let dev = Device::with_mock(mock.clone());
            let _first = dev.catch_events([bulk(3).with_capture(a)]).unwrap();
            let _second = dev.catch_events([bulk(3).with_capture(b)]).unwrap();
            mock.recorded_frames()
                .iter()
                .filter(|f| f.ty == FrameType::Catch)
                .filter_map(|f| f.payload.get(5).copied())
                .next_back()
                .expect("a CATCH frame")
        };
        let f = Capture::First;
        assert_eq!(capture_sent_to_box(f(16), f(64)), 64);
        assert_eq!(capture_sent_to_box(f(64), f(16)), 64);
        assert_eq!(capture_sent_to_box(f(16), Capture::Whole), 0);
        assert_eq!(capture_sent_to_box(Capture::Whole, f(16)), 0);
    }

    #[test]
    fn a_narrow_entry_does_not_cut_a_broad_subscribers_packets() {
        // The box captures at the length of the most specific matching entry.
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let _broad = dev.catch_events([CatchFilter::everything()]).unwrap();
        let _narrow = dev
            .catch_events([bulk(3).with_capture(Capture::First(8))])
            .unwrap();
        let captures: Vec<u8> = mock
            .recorded_frames()
            .iter()
            .filter(|f| f.ty == FrameType::Catch)
            .filter_map(|f| f.payload.get(5).copied())
            .collect();
        assert!(!captures.is_empty());
        assert!(
            captures.iter().all(|s| *s == 0),
            "every entry must still capture whole packets, got {captures:?}"
        );
    }

    #[test]
    fn a_more_specific_entry_does_not_widen_a_broader_one() {
        // The reverse must not happen: an exact endpoint asking for whole packets leaves the
        // blanket (serving every other endpoint) capped. Folding on any overlap would put the
        // blanket at whole packets and send every byte of every bulk pipe down the link.
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let _capped = dev
            .catch_events([CatchFilter::traffic_class(TrafficClass::VendorBulk)
                .with_capture(Capture::First(16))])
            .unwrap();
        let _whole = dev.catch_events([bulk(3)]).unwrap();
        let sent: Vec<(u16, u8)> = mock
            .recorded_frames()
            .iter()
            .filter(|f| f.ty == FrameType::Catch && f.payload[4] == 1)
            .map(|f| {
                (
                    u16::from_le_bytes([f.payload[1], f.payload[2]]),
                    f.payload[5],
                )
            })
            .collect();
        assert!(
            sent.contains(&(CATCH_ID_ANY, 16)),
            "the blanket stays capped, got {sent:?}"
        );
        assert!(
            sent.contains(&(3, 0)),
            "the exact endpoint gets whole packets, got {sent:?}"
        );
    }

    #[test]
    fn direction_ranks_in_the_fold_the_same_way_it_ranks_in_the_box() {
        // Direction is part of specificity, so it ranks in the capture fold too.
        let sent = |broad: Capture, narrow: Capture| {
            let mock = MockBox::new();
            let dev = Device::with_mock(mock.clone());
            let _b = dev.catch_events([bulk(3).with_capture(broad)]).unwrap();
            let _n = dev
                .catch_events([bulk(3).outbound().with_capture(narrow)])
                .unwrap();
            let mut out: Vec<(u8, u8)> = mock
                .recorded_frames()
                .iter()
                .filter(|f| f.ty == FrameType::Catch && f.payload[4] == 1)
                .map(|f| (f.payload[3], f.payload[5]))
                .collect();
            out.dedup();
            out
        };
        // Broad wants whole packets: the narrow OUT entry is widened to match.
        let widened = sent(Capture::Whole, Capture::First(8));
        assert!(
            widened.contains(&(Direction::Both.as_u8(), 0))
                && widened.contains(&(Direction::OUT.as_u8(), 0)),
            "got {widened:?}"
        );
        // The reverse must not happen: a narrower OUT entry asking for whole packets leaves the BOTH
        // entry (which also serves IN events) capped.
        let kept = sent(Capture::First(8), Capture::Whole);
        assert!(
            kept.contains(&(Direction::Both.as_u8(), 8))
                && kept.contains(&(Direction::OUT.as_u8(), 0)),
            "got {kept:?}"
        );
    }

    #[test]
    fn a_subscription_past_the_box_s_table_is_refused_not_truncated() {
        // The box holds 32 entries and drops the rest, flagged only in `table_full`, so the stream
        // would miss whatever didn't fit.
        use crate::protocol::opcode::CATCH_MAX_ENTRIES;
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let fits: Vec<CatchFilter> = (0..CATCH_MAX_ENTRIES as u16).map(bulk).collect();
        let _ok = dev
            .catch_events(fits.clone())
            .expect("exactly the table size fits");

        let one_more = CatchFilter::traffic(TrafficClass::VendorInterrupt, 9);
        let err = dev.catch_events([one_more]).unwrap_err();
        assert!(
            matches!(
                err,
                Error::CatchTableFull { needed, limit }
                    if needed == CATCH_MAX_ENTRIES + 1 && limit == CATCH_MAX_ENTRIES
            ),
            "got {err:?}"
        );
        // The refusal leaves the registry and union unchanged, so a later subscribe that fits works.
        drop(_ok);
        let _after = dev
            .catch_events([CatchFilter::traffic_class(TrafficClass::Bus)])
            .expect("the refused subscription left nothing behind");
    }

    #[test]
    fn an_unchanged_entry_is_not_re_sent() {
        // catch_sync runs holding catch_lock, and every frame is a blocking serial write.
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let a = dev
            .catch_events([
                bulk(3),
                bulk(4),
                CatchFilter::traffic_class(TrafficClass::Bus),
            ])
            .unwrap();
        let b = dev
            .catch_events([CatchFilter::traffic(TrafficClass::VendorInterrupt, 5)])
            .unwrap();
        let before = mock
            .recorded_frames()
            .iter()
            .filter(|f| f.ty == FrameType::Catch)
            .count();
        drop(b);
        let sent: Vec<Vec<u8>> = mock
            .recorded_frames()
            .iter()
            .filter(|f| f.ty == FrameType::Catch)
            .skip(before)
            .map(|f| f.payload.clone())
            .collect();
        // One frame: the unsubscribe for B's entry. A's three entries stay unwritten.
        assert_eq!(sent.len(), 1, "sent {sent:?}");
        assert_eq!(sent[0][4], 0, "the one frame is an unsubscribe");
        assert_eq!(sent[0][0], CatchClass::VendorInterrupt.as_u8());
        drop(a);
    }

    #[test]
    fn a_changed_capture_still_reaches_the_box() {
        // Capture is not part of a filter's address, so the key-set diff misses a capture change;
        // it is compared explicitly.
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let a = dev
            .catch_events([bulk(3).with_capture(Capture::First(8))])
            .unwrap();
        let before = mock
            .recorded_frames()
            .iter()
            .filter(|f| f.ty == FrameType::Catch)
            .count();
        // A second subscriber wants whole packets on the same address: the entry must be rewritten.
        let _b = dev.catch_events([bulk(3)]).unwrap();
        let sent: Vec<Vec<u8>> = mock
            .recorded_frames()
            .iter()
            .filter(|f| f.ty == FrameType::Catch)
            .skip(before)
            .map(|f| f.payload.clone())
            .collect();
        assert_eq!(sent.len(), 1, "sent {sent:?}");
        assert_eq!(sent[0][5], 0, "rewritten at the widest capture");
        drop(a);
    }

    #[test]
    fn duplicate_addresses_in_one_call_take_the_widest() {
        // Same rule within one subscribe: both orderings of one pair must agree (collecting into a
        // set would keep the last-listed duplicate).
        let sent = |filters: [CatchFilter; 2]| {
            let mock = MockBox::new();
            let dev = Device::with_mock(mock.clone());
            let _s = dev.catch_events(filters).unwrap();
            mock.recorded_frames()
                .iter()
                .filter(|f| f.ty == FrameType::Catch)
                .filter_map(|f| f.payload.get(5).copied())
                .next_back()
                .expect("a CATCH frame")
        };
        let a = bulk(3);
        let f = Capture::First;
        assert_eq!(sent([a.with_capture(f(16)), a.with_capture(f(64))]), 64);
        assert_eq!(sent([a.with_capture(f(64)), a.with_capture(f(16))]), 64);
        assert_eq!(
            sent([a.with_capture(f(16)), a.with_capture(Capture::Whole)]),
            0
        );
        assert_eq!(
            sent([a.with_capture(Capture::Whole), a.with_capture(f(16))]),
            0
        );
    }

    #[test]
    fn an_exact_input_filter_receives_its_class_and_diffs_it() {
        // Input frames carry content, not an address, so routing reads the address from the
        // content. Routed on the wire's wildcard id, every exact-id input subscription would match
        // nothing: the box accepts and lists the entry, counts no drops, and the stream stays
        // empty.
        //
        // A snapshot lists what is held, so Left's release is the snapshot without Left. Delivering
        // only snapshots that contain the subscriber's usage would drop that edge, but only while
        // another subscriber's usage is held, so a single-subscriber test can't see it.
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let s = dev
            .catch_events([CatchFilter::watch(Button::LEFT)])
            .unwrap();
        let next = |what: &str| match s.recv_timeout(Duration::from_secs(1)) {
            Some(CatchEvent::Usages(u)) => u,
            other => panic!("expected {what}, got {other:?}"),
        };
        mock.push_usages(
            0,
            1_000,
            Class::Button,
            Direction::PRESS,
            &[Usage::from(Button::LEFT)],
        );
        assert!(next("the press").is_held(Button::LEFT));

        // Left released while another subscriber holds Side1: the snapshot listing only Side1 is how
        // this subscriber learns Left came up.
        mock.push_usages(
            1,
            2_000,
            Class::Button,
            Direction::RELEASE,
            &[Usage::from(Button::SIDE1)],
        );
        assert!(!next("the release").is_held(Button::LEFT));

        // Another class still is not delivered. Asserted after an event that must arrive, so it
        // cannot pass by outrunning the reader thread.
        mock.push_usages(
            2,
            3_000,
            Class::Key,
            Direction::PRESS,
            &[Usage::from(Key::new(0x04))],
        );
        mock.push_usages(3, 4_000, Class::Button, Direction::RELEASE, &[]);
        assert!(next("the empty button snapshot").usages.is_empty());
    }

    #[test]
    fn an_input_filter_direction_selects_the_edge() {
        // The box emits both edges once another subscriber holds a wider entry, so without the edge
        // on the wire, a press-only subscription would receive releases too.
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let press = dev
            .catch_events([CatchFilter::watch_class(Class::Key).on_press()])
            .unwrap();
        mock.push_usages(0, 1_000, Class::Key, Direction::RELEASE, &[]);
        mock.push_usages(
            1,
            2_000,
            Class::Key,
            Direction::PRESS,
            &[Usage::from(Key::new(0x04))],
        );
        match press.recv_timeout(Duration::from_secs(1)) {
            Some(CatchEvent::Usages(u)) => {
                assert_eq!(u.direction, Direction::PRESS);
                assert!(
                    u.is_held(Key::new(0x04)),
                    "the release must not arrive first"
                );
            }
            other => panic!("expected the press, got {other:?}"),
        }
    }

    #[test]
    fn an_exact_axis_filter_receives_only_that_axis() {
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let s = dev
            .catch_events([CatchFilter::watch_axis(Axis::Wheel)])
            .unwrap();
        mock.push_motion(0, 1_000, 40, -9, 0, 0); // X and Y only
        assert!(s.try_recv().is_none());
        mock.push_motion(1, 2_000, 0, 0, 1, 0);
        match s.recv().unwrap() {
            CatchEvent::Motion(m) => assert_eq!(m.dz, 1),
            other => panic!("expected motion, got {other:?}"),
        }
    }

    #[test]
    fn an_ac_pan_motion_reaches_a_pan_subscriber_and_not_the_wheel() {
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let pan = dev
            .catch_events([CatchFilter::watch_axis(Axis::Pan)])
            .unwrap();
        let wheel = dev
            .catch_events([CatchFilter::watch_axis(Axis::Wheel)])
            .unwrap();
        // A report that scrolled sideways only: wheel dz = 0, pan = 5.
        mock.push_motion(0, 1_000, 0, 0, 0, 5);
        match pan.recv_timeout(Duration::from_secs(1)) {
            Some(CatchEvent::Motion(m)) => {
                assert_eq!(m.pan, 5);
                assert_eq!(m.axes().collect::<Vec<_>>(), [(Axis::Pan, 5)]);
            }
            other => panic!("expected pan motion, got {other:?}"),
        }
        assert!(wheel.try_recv().is_none());
    }

    #[test]
    fn a_button_past_five_is_a_catchable_address() {
        // The subscription wire is (class=button, id=8) unchanged: the id isn't capped.
        assert_eq!(CatchFilter::watch(Button::new(8)).wire(), (0, 8));

        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let s = dev
            .input_events([CatchFilter::watch(Button::new(8))])
            .unwrap();
        mock.push_usages(
            0,
            1_000,
            Class::Button,
            Direction::PRESS,
            &[Usage::from(Button::new(8))],
        );
        mock.push_usages(1, 2_000, Class::Button, Direction::RELEASE, &[]);
        let down = s.recv_timeout(Duration::from_secs(1)).unwrap();
        assert_eq!(down.input, Input::Press(Usage::new(Class::Button, 8)));
        let up = s.recv_timeout(Duration::from_secs(1)).unwrap();
        assert_eq!(up.input, Input::Release(Usage::new(Class::Button, 8)));
    }

    #[test]
    fn an_axis_direction_selects_the_sign_of_the_movement() {
        // An axis's direction is the delta's sign, as in an axis LOCK; wheel-up must not deliver
        // wheel-down.
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let up = dev
            .catch_events(
                [CatchFilter::watch_axis(Axis::Wheel).with_direction(Direction::Positive)],
            )
            .unwrap();
        mock.push_motion(0, 1_000, 0, 0, -1, 0);
        assert!(up.try_recv().is_none());
        mock.push_motion(1, 2_000, 0, 0, 3, 0);
        assert!(matches!(up.recv().unwrap(), CatchEvent::Motion(m) if m.dz == 3));
    }

    #[test]
    fn a_release_to_nothing_reaches_the_class_that_released() {
        // The empty snapshot is the release of the last held usage, and it lists nothing.
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let keys = dev
            .catch_events([CatchFilter::watch_class(Class::Key)])
            .unwrap();
        let traffic = dev.catch_events([bulk(3)]).unwrap();
        mock.push_usages(0, 1_000, Class::Key, Direction::RELEASE, &[]);
        match keys.recv_timeout(Duration::from_secs(1)).expect("release") {
            CatchEvent::Usages(u) => assert!(u.usages.is_empty() && u.class == Class::Key),
            other => panic!("expected the empty key snapshot, got {other:?}"),
        }
        assert!(
            traffic.try_recv().is_none(),
            "an empty snapshot is not everyone's"
        );
    }

    #[test]
    fn each_subscriber_gets_only_what_it_asked_for() {
        // The box holds one table (the union), so without per-subscriber matching a stream changes
        // whenever unrelated code in the process subscribes.
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let b = dev.catch_events([bulk(3)]).unwrap();
        let bus = dev
            .catch_events([CatchFilter::traffic_class(TrafficClass::Bus)])
            .unwrap();

        mock.push_traffic(
            0,
            1,
            ClockDomain::DeviceChip,
            CatchClass::VendorBulk,
            3,
            Direction::IN,
            0,
            2,
            &[1, 2],
        );
        mock.push_traffic(
            1,
            2,
            ClockDomain::DeviceChip,
            CatchClass::Bus,
            0xFFFF,
            Direction::Both,
            0,
            2,
            &[0, 0],
        );

        match b.recv().unwrap() {
            CatchEvent::Traffic(t) => assert_eq!(t.class, CatchClass::VendorBulk),
            other => panic!("expected vendor bulk, got {other:?}"),
        }
        assert!(
            b.try_recv().is_none(),
            "the bus event must not reach the bulk subscriber"
        );

        match bus.recv().unwrap() {
            CatchEvent::Traffic(t) => assert_eq!(t.class, CatchClass::Bus),
            other => panic!("expected bus, got {other:?}"),
        }
        assert!(
            bus.try_recv().is_none(),
            "the bulk event must not reach the bus subscriber"
        );
    }

    #[test]
    fn an_endpoint_filter_excludes_its_neighbours() {
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let s = dev.catch_events([bulk(3)]).unwrap();
        mock.push_traffic(
            0,
            1,
            ClockDomain::DeviceChip,
            CatchClass::VendorBulk,
            4,
            Direction::IN,
            0,
            1,
            &[9],
        );
        mock.push_traffic(
            1,
            2,
            ClockDomain::DeviceChip,
            CatchClass::VendorBulk,
            3,
            Direction::IN,
            0,
            1,
            &[7],
        );
        match s.recv().unwrap() {
            CatchEvent::Traffic(t) => assert_eq!((t.id, t.bytes[0]), (3, 7)),
            other => panic!("expected 3, got {other:?}"),
        }
    }

    #[test]
    fn catch_buffer_drops_oldest_on_overflow() {
        const TOTAL: u16 = 300;
        const KEPT: usize = 256; // CATCH_CAPACITY
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let s = dev.catch_events([CatchFilter::everything()]).unwrap();
        for i in 0..TOTAL {
            mock.push_motion(i as u8, 0, i as i16, 0, 0, 0);
        }
        // The reader delivers on a separate thread, so wait for the count; asserting at once
        // depends on scheduling.
        let want = (TOTAL as usize - KEPT) as u64;
        let deadline = std::time::Instant::now() + std::time::Duration::from_secs(2);
        while s.dropped() < want && std::time::Instant::now() < deadline {
            std::thread::sleep(std::time::Duration::from_millis(5));
        }
        assert_eq!(s.dropped(), want);
        // The survivor is the oldest of what remains, so the newest are the ones kept.
        match s.recv().unwrap() {
            CatchEvent::Motion(m) => assert_eq!(m.dx, (TOTAL as usize - KEPT) as i16),
            other => panic!("expected motion, got {other:?}"),
        }
    }

    #[test]
    fn timestamps_reach_the_consumer_as_the_wire_value() {
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let s = dev.catch_events([CatchFilter::everything()]).unwrap();
        mock.push_motion(0, u32::MAX - 500, 1, 0, 0, 0);
        mock.push_motion(1, 500, 1, 0, 0, 0);
        let first = s.recv().unwrap().ts_us();
        let second = s.recv().unwrap().ts_us();
        assert_eq!(first, u32::MAX - 500);
        assert_eq!(second, 500); // a wrap is the consumer's to notice, not ours to smooth over
    }

    #[test]
    fn input_events_turn_snapshots_into_edges() {
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let mut s = dev.input_events(CatchFilter::all_input()).unwrap();
        let a = Usage::from(Key::new(0x04));
        let b = Usage::from(Key::new(0x05));

        mock.push_usages(0, 1_000, Class::Key, Direction::PRESS, &[a]);
        mock.push_usages(1, 2_000, Class::Key, Direction::PRESS, &[a, b]);
        mock.push_usages(2, 3_000, Class::Key, Direction::RELEASE, &[b]);
        mock.push_usages(3, 4_000, Class::Key, Direction::RELEASE, &[]);
        mock.push_motion(4, 5_000, 3, -4, 0, 0);

        let next = |s: &mut crate::InputStream| s.recv_timeout(Duration::from_secs(1)).unwrap();
        assert_eq!(next(&mut s).input, Input::Press(a));
        assert_eq!(next(&mut s).input, Input::Press(b));
        let e = next(&mut s);
        assert_eq!(e.input, Input::Release(a));
        assert_eq!(e.ts_us, 3_000, "the edge carries its report's stamp");
        assert_eq!(next(&mut s).input, Input::Release(b));
        assert_eq!(
            next(&mut s).input,
            Input::Motion {
                dx: 3,
                dy: -4,
                dz: 0,
                pan: 0
            }
        );
    }

    #[test]
    fn one_report_can_carry_several_edges() {
        // A swap in one report: A up, B down. Both edges surface, release first, or a consumer
        // counting held usages goes negative.
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let mut s = dev.input_events(CatchFilter::all_input()).unwrap();
        let a = Usage::from(Button::LEFT);
        let b = Usage::from(Button::SIDE1);
        mock.push_usages(0, 1_000, Class::Button, Direction::PRESS, &[a]);
        mock.push_usages(1, 2_000, Class::Button, Direction::PRESS, &[b]);
        let next = |s: &mut crate::InputStream| s.recv_timeout(Duration::from_secs(1)).unwrap();
        assert_eq!(next(&mut s).input, Input::Press(a));
        assert_eq!(next(&mut s).input, Input::Release(a));
        assert_eq!(next(&mut s).input, Input::Press(b));
        assert_eq!(s.held(Class::Button), &[b]);
        assert!(s.held(Class::Key).is_empty());
    }

    #[test]
    fn an_input_stream_gets_only_the_usages_it_asked_for() {
        // A snapshot is the class's state, listing every held usage once any subscriber widens the
        // table.
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let f = Usage::from(Key::new(0x09));
        let g = Usage::from(Key::new(0x0A));
        let narrow = dev
            .input_events([CatchFilter::watch(Key::new(0x09))])
            .unwrap();
        let _wide = dev
            .catch_events([CatchFilter::watch_class(Class::Key)])
            .unwrap();

        mock.push_usages(0, 1_000, Class::Key, Direction::PRESS, &[g]);
        mock.push_usages(1, 2_000, Class::Key, Direction::PRESS, &[g, f]);
        mock.push_usages(2, 3_000, Class::Key, Direction::RELEASE, &[g]);
        assert_eq!(
            narrow.recv_timeout(Duration::from_secs(1)).unwrap().input,
            Input::Press(f),
            "the other subscriber's key must not surface here"
        );
        assert_eq!(
            narrow.recv_timeout(Duration::from_secs(1)).unwrap().input,
            Input::Release(f)
        );
        assert_eq!(narrow.held(Class::Key), &[]);
        assert!(narrow.recv_timeout(Duration::from_millis(100)).is_none());
    }

    #[test]
    fn a_malformed_snapshot_cannot_wedge_the_held_set() {
        // Defences against malformed snapshots: a usage listed twice must not fire two presses with
        // no release, or leave `held` a multiset.
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let s = dev.input_events(CatchFilter::all_input()).unwrap();
        let a = Usage::from(Key::new(0x04));
        let button = Usage::from(Button::LEFT);

        mock.push_usages(0, 1_000, Class::Key, Direction::PRESS, &[a, a]);
        assert_eq!(
            s.recv_timeout(Duration::from_secs(1)).unwrap().input,
            Input::Press(a)
        );
        assert!(
            s.recv_timeout(Duration::from_millis(100)).is_none(),
            "once, not twice"
        );
        assert_eq!(s.held(Class::Key), &[a]);

        // A button riding inside a KEY snapshot is dropped, not filed under Key.
        mock.push_usages(1, 2_000, Class::Key, Direction::PRESS, &[a, button]);
        assert!(s.recv_timeout(Duration::from_millis(100)).is_none());
        assert_eq!(s.held(Class::Key), &[a]);
        assert!(s.held(Class::Button).is_empty());
    }

    #[test]
    fn a_report_that_moved_nothing_is_not_an_input_event() {
        // The routing fallback delivers an unaddressable motion report to every axis subscriber.
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let s = dev.input_events(CatchFilter::all_input()).unwrap();
        mock.push_motion(0, 1_000, 0, 0, 0, 0);
        assert!(s.recv_timeout(Duration::from_millis(150)).is_none());
        mock.push_motion(1, 2_000, 0, 0, -2, 0);
        assert_eq!(
            s.recv_timeout(Duration::from_secs(1)).unwrap().input,
            Input::Motion {
                dx: 0,
                dy: 0,
                dz: -2,
                pan: 0
            }
        );
    }

    #[test]
    fn a_snapshot_that_changes_nothing_yields_nothing() {
        // Two identical snapshots are one state. recv_timeout's deadline must not restart on a
        // report that decoded to no edge.
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let s = dev.input_events(CatchFilter::all_input()).unwrap();
        mock.push_usages(0, 1_000, Class::Key, Direction::RELEASE, &[]);
        mock.push_usages(1, 2_000, Class::Media, Direction::RELEASE, &[]);
        // Recomputing the full timeout per loop would turn a 200 ms budget into 700 ms under a
        // stream of empties.
        let began = std::time::Instant::now();
        assert!(s.recv_timeout(Duration::from_millis(150)).is_none());
        let waited = began.elapsed();
        assert!(
            waited >= Duration::from_millis(140) && waited < Duration::from_millis(400),
            "waited {waited:?} for a 150 ms budget"
        );
        assert!(s.try_recv().is_none());
    }

    #[test]
    fn the_input_stream_tracks_each_class_separately() {
        // One held-set per class. Sharing one would make a key press look like a button release.
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let mut s = dev.input_events(CatchFilter::all_input()).unwrap();
        let btn = Usage::from(Button::LEFT);
        let key = Usage::from(Key::new(0x04));
        mock.push_usages(0, 1_000, Class::Button, Direction::PRESS, &[btn]);
        mock.push_usages(1, 2_000, Class::Key, Direction::PRESS, &[key]);
        let next = |s: &mut crate::InputStream| s.recv_timeout(Duration::from_secs(1)).unwrap();
        assert_eq!(next(&mut s).input, Input::Press(btn));
        assert_eq!(next(&mut s).input, Input::Press(key));
        assert!(s.recv_timeout(Duration::from_millis(150)).is_none());
        assert_eq!(s.held(Class::Button), &[btn]);
        assert_eq!(s.held(Class::Key), &[key]);
    }

    #[test]
    fn watching_one_key_needs_no_diffing_at_all() {
        // The shape the docs lead with: one exact usage, and is_held answers the question.
        let mock = MockBox::new();
        let dev = Device::with_mock(mock.clone());
        let f = Usage::from(Key::new(0x09));
        let mut s = dev
            .input_events([CatchFilter::watch(Key::new(0x09))])
            .unwrap();
        mock.push_usages(0, 1_000, Class::Key, Direction::PRESS, &[f]);
        mock.push_usages(1, 2_000, Class::Key, Direction::RELEASE, &[]);
        let next = |s: &mut crate::InputStream| s.recv_timeout(Duration::from_secs(1)).unwrap();
        assert_eq!(next(&mut s).input, Input::Press(f));
        assert_eq!(next(&mut s).input, Input::Release(f));
    }
}

#[cfg(feature = "mock")]
mod timeline {
    use super::*;
    use crate::types::{CatchEvent, Timeline};
    use std::time::Instant;

    fn motion_at(ts_us: u32) -> CatchEvent {
        let mut p = vec![0u8; 13];
        p[..4].copy_from_slice(&ts_us.to_le_bytes());
        p[5] = 1; // dx = 1, so the report moved something
        CatchEvent::Motion(MotionEvent::from_payload(&p).unwrap())
    }

    fn traffic_at(ts_us: u32) -> CatchEvent {
        let mut p = vec![0u8; 12];
        p[..4].copy_from_slice(&ts_us.to_le_bytes());
        p[4] = 1; // device chip
        p[5] = 7; // vendor bulk
        CatchEvent::Traffic(TrafficEvent::from_payload(&p).unwrap())
    }

    #[test]
    fn box_microseconds_unwrap_past_the_rollover() {
        // 32 bits of microseconds is 71.6 minutes; subtracting raw stamps across the wrap is
        // ~4295 s wrong (negative).
        let mut t = Timeline::new();
        assert_eq!(
            t.box_us(&motion_at(u32::MAX - 500)),
            (u32::MAX - 500) as u64
        );
        assert_eq!(t.box_us(&motion_at(500)), (1u64 << 32) + 500);
        assert_eq!(t.box_us(&motion_at(1_500)), (1u64 << 32) + 1_500);
        // Re-reading the same event must not advance the epoch again.
        assert_eq!(t.box_us(&motion_at(1_500)), (1u64 << 32) + 1_500);
    }

    #[test]
    fn the_two_domains_unwrap_independently() {
        // Interleaving a device-chip stamp below a host-chip one is a domain change, not a wrap.
        let mut t = Timeline::new();
        assert_eq!(t.box_us(&motion_at(10_000)), 10_000);
        assert_eq!(t.box_us(&traffic_at(5)), 5);
        assert_eq!(t.box_us(&motion_at(10_001)), 10_001);
        assert_eq!(t.box_us(&traffic_at(6)), 6);
    }

    #[test]
    fn the_timeline_takes_a_decoded_input_event_too() {
        // An input_events edge goes on this machine's clock without the raw stream.
        use crate::types::{Input, InputEvent, Usage};
        let mut t = Timeline::new();
        let origin = Instant::now();
        let edge = InputEvent {
            ts_us: 5_000,
            clock: ClockDomain::HostChip,
            input: Input::Press(Usage::from(Key::new(0x04))),
        };
        let a = t.observe_at(&edge, origin + Duration::from_millis(10));
        assert_eq!(a.box_us, 5_000);
        // And it shares one domain state with the raw events, so a mixed reader stays consistent.
        let raw = t.observe_at(&motion_at(6_000), origin + Duration::from_millis(11));
        assert_eq!(raw.host.duration_since(a.host), Duration::from_millis(1));
        assert_eq!(t.samples(ClockDomain::HostChip), 2);
        // The underlying frame types work directly as well, on the same unwrapped domain.
        let mut p = vec![0u8; 13];
        p[..4].copy_from_slice(&7_000u32.to_le_bytes());
        let m = MotionEvent::from_payload(&p).unwrap();
        assert_eq!(t.box_us(&m), 7_000);
    }

    #[test]
    fn a_reset_forgets_the_rollover_for_a_rebooted_chip() {
        let mut t = Timeline::new();
        assert_eq!(t.box_us(&motion_at(u32::MAX - 5)), (u32::MAX - 5) as u64);
        t.reset(ClockDomain::HostChip);
        assert_eq!(t.box_us(&motion_at(7)), 7, "a reboot is not a wrap");
        assert_eq!(t.samples(ClockDomain::HostChip), 0);
    }

    #[test]
    fn the_host_mapping_follows_the_fastest_sample() {
        // An event arrives late, never early, so the mapping tracks the minimum lag; an average would
        // drift with every slow delivery.
        let origin = Instant::now();
        let mut t = Timeline::new();
        // 50 ms lag on the first sample: the floor, so no excess.
        let a = t.observe_at(&motion_at(1_000), origin + Duration::from_millis(50));
        assert_eq!(a.box_us, 1_000);
        assert_eq!(a.excess, Duration::ZERO);
        // 39 ms later on the wall for 1 ms of box time: 38 ms of excess against the same floor.
        let b = t.observe_at(&motion_at(2_000), origin + Duration::from_millis(89));
        assert!(b.host > a.host, "the later event maps later");
        assert!(b.excess > Duration::from_millis(37), "got {:?}", b.excess);
        // A relatively faster delivery lowers the floor, and the next event is measured against it.
        let _fast = t.observe_at(&motion_at(3_000), origin + Duration::from_millis(51));
        let d = t.observe_at(&motion_at(4_000), origin + Duration::from_millis(52));
        assert_eq!(d.excess, Duration::ZERO, "the new floor is the reference");
        assert_eq!(t.samples(ClockDomain::HostChip), 4);
        assert_eq!(t.samples(ClockDomain::DeviceChip), 0);
    }

    #[test]
    fn a_small_correction_is_absorbed_and_a_large_one_re_anchors() {
        // The floor only improves, shifting later events earlier; a small shift is smoothed so the
        // timeline never runs backwards.
        let origin = Instant::now();
        let mut t = Timeline::new();
        // Sub-millisecond correction: absorbed, no regression.
        let a = t.observe_at(&motion_at(1_000), origin + Duration::from_millis(10));
        let b = t.observe_at(&motion_at(1_100), origin + Duration::from_micros(10_050));
        assert!(b.host >= a.host, "{:?} < {:?}", b.host, a.host);

        // A 40 ms correction re-anchors, and the next event is on the improved mapping, not clamped
        // to the stale one.
        let mut t = Timeline::new();
        let slow = t.observe_at(&motion_at(1_000), origin + Duration::from_millis(50));
        let fast = t.observe_at(&motion_at(1_100), origin + Duration::from_millis(10));
        assert!(fast.host < slow.host, "a large correction re-anchors");
        let next = t.observe_at(&motion_at(2_100), origin + Duration::from_millis(11));
        assert_eq!(
            next.host.duration_since(fast.host),
            Duration::from_millis(1)
        );
        assert_eq!(next.excess, Duration::ZERO);
    }

    #[test]
    fn the_host_mapping_is_anchored_to_the_arrival_not_to_the_box_stamp() {
        // Every other timeline test passes with the floor deleted (host = box_us alone).
        let origin = Instant::now();
        let mut t = Timeline::new();
        // A box that booted an hour before this process: stamps are huge, arrivals are not.
        let far = 3_600_000_000u32;
        let s = t.observe_at(&motion_at(far), origin + Duration::from_millis(20));
        assert_eq!(s.box_us, far as u64);
        assert_eq!(
            s.host.duration_since(origin),
            Duration::from_millis(20),
            "the first sample maps to its arrival"
        );
    }

    #[test]
    fn excess_is_measured_in_the_unit_it_says() {
        // The crate and the FFI once built `excess` with the wrong Duration constructor; asserting
        // only zero and a one-sided bound let a 1000x unit error through.
        let origin = Instant::now();
        let mut t = Timeline::new();
        t.observe_at(&motion_at(1_000), origin + Duration::from_millis(10));
        let late = t.observe_at(&motion_at(2_000), origin + Duration::from_millis(37));
        // 1000 us of box time against 27 ms of wall time: 26 ms late, exactly.
        assert_eq!(late.excess, Duration::from_millis(26));
    }

    #[test]
    fn an_out_of_order_event_is_not_a_rollover() {
        // The box drains taps through strict-priority queues, and both clock domains span several,
        // so a later-tapped event can arrive first.
        let mut t = Timeline::new();
        assert_eq!(t.box_us(&motion_at(10_000)), 10_000);
        assert_eq!(
            t.box_us(&motion_at(9_999)),
            9_999,
            "1 us inversion, not a wrap"
        );
        assert_eq!(t.box_us(&motion_at(11_000)), 11_000);
        // A whole second of reordering is still reordering.
        assert_eq!(t.box_us(&motion_at(10_000_000)), 10_000_000);
        assert_eq!(t.box_us(&motion_at(9_000_000)), 9_000_000);
        // The real wrap still works, approached as a running box does: one jump over half the range
        // is ambiguous and reads as reordering.
        let mut t = Timeline::new();
        for step in [
            1_000u32,
            1_000_000_000,
            2_000_000_000,
            3_000_000_000,
            u32::MAX - 5,
        ] {
            assert_eq!(t.box_us(&motion_at(step)), step as u64);
        }
        assert_eq!(t.box_us(&motion_at(20)), (1u64 << 32) + 20);
        assert_eq!(
            t.box_us(&motion_at(u32::MAX - 2)),
            (u32::MAX - 2) as u64,
            "a straggler from the previous epoch stays in it"
        );
    }

    #[test]
    fn each_domain_keeps_its_own_floor() {
        // Floors are per domain: the chips' clocks are unrelated, and a shared floor would put
        // device-chip stamps wherever the host chip's offset landed them.
        let origin = Instant::now();
        let mut t = Timeline::new();
        // Host chip: stamps near zero, arriving at 10 ms.
        let h = t.observe_at(&motion_at(1_000), origin + Duration::from_millis(10));
        // Device chip: stamps an hour ahead, arriving at 11 ms; a shared floor lands it an hour off.
        let d = t.observe_at(
            &traffic_at(3_600_001_000),
            origin + Duration::from_millis(11),
        );
        assert_eq!(h.host.duration_since(origin), Duration::from_millis(10));
        assert_eq!(d.host.duration_since(origin), Duration::from_millis(11));
        assert_eq!(t.samples(ClockDomain::HostChip), 1);
        assert_eq!(t.samples(ClockDomain::DeviceChip), 1);
    }

    #[test]
    fn a_reset_clears_one_domains_floor_and_leaves_the_other_alone() {
        // Keeping the old boot's floor would put every post-reboot event an epoch away; clearing
        // both domains would discard a good estimate for the chip that didn't restart.
        let origin = Instant::now();
        let mut t = Timeline::new();
        t.observe_at(&motion_at(1_000), origin + Duration::from_millis(500));
        t.observe_at(&traffic_at(1_000), origin + Duration::from_millis(20));
        t.reset(ClockDomain::HostChip);
        assert_eq!(t.samples(ClockDomain::HostChip), 0);
        assert_eq!(
            t.samples(ClockDomain::DeviceChip),
            1,
            "the other chip is untouched"
        );
        // The rebooted chip's first event maps to its arrival, not to the stale 500 ms floor.
        let after = t.observe_at(&motion_at(7), origin + Duration::from_millis(600));
        assert_eq!(
            after.host.duration_since(origin),
            Duration::from_millis(600)
        );
        assert_eq!(after.box_us, 7);
        // And the surviving domain still has its floor: 1000 us on, 1 ms later.
        let other = t.observe_at(&traffic_at(2_000), origin + Duration::from_millis(30));
        assert_eq!(other.host.duration_since(origin), Duration::from_millis(21));
    }

    #[test]
    fn the_floor_window_lets_a_stale_estimate_recover() {
        // Not an all-time minimum: the crystals drift up to 20 ppm, so an hour-old floor is 72 ms
        // wrong and worsening.
        let origin = Instant::now();
        let mut t = Timeline::new();
        // One unusually fast delivery, then a long run of steady ones 5 ms slower.
        t.observe_at(&motion_at(0), origin);
        let mut last = Duration::ZERO;
        for i in 1..=9_000u32 {
            let s = t.observe_at(
                &motion_at(i * 1_000),
                origin + Duration::from_micros(i as u64 * 1_000 + 5_000),
            );
            last = s.excess;
        }
        assert_eq!(
            last,
            Duration::ZERO,
            "the floor rose to the steady delivery"
        );
    }

    #[test]
    fn a_steady_stream_maps_onto_the_boxs_own_spacing() {
        // With the floor found, host instants are spaced as the box stamped them, whatever the
        // jitter; here no delivery is faster than the first sample, so the floor holds.
        let origin = Instant::now();
        let mut t = Timeline::new();
        let mut out = Vec::new();
        for (i, jitter) in [0u64, 7, 2, 31, 1].iter().enumerate() {
            let ts = 1_000 + i as u32 * 1_000;
            out.push(
                t.observe_at(
                    &motion_at(ts),
                    origin + Duration::from_millis(10 + i as u64 + jitter),
                )
                .host,
            );
        }
        for w in out.windows(2) {
            assert_eq!(
                w[1].duration_since(w[0]),
                Duration::from_millis(1),
                "1000 us apart on the box is 1 ms apart here"
            );
        }
    }
}