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
|
/*
* Linux usbfs backend for libusb
* Copyright (C) 2007-2008 Daniel Drake <dsd@gentoo.org>
* Copyright (c) 2001 Johannes Erdfelt <johannes@erdfelt.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#include <config.h>
#include <ctype.h>
#include <dirent.h>
#include <errno.h>
#include <fcntl.h>
#include <poll.h>
#include <pthread.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/ioctl.h>
#include <sys/select.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
#include "libusb.h"
#include "libusbi.h"
#include "linux_usbfs.h"
/* sysfs vs usbfs:
* opening a usbfs node causes the device to be resumed, so we attempt to
* avoid this during enumeration.
*
* sysfs allows us to read the kernel's in-memory copies of device descriptors
* and so forth, avoiding the need to open the device:
* - The binary "descriptors" file was added in 2.6.23.
* - The "busnum" file was added in 2.6.22
* - The "devnum" file has been present since pre-2.6.18
* - the "bConfigurationValue" file has been present since pre-2.6.18
*
* If we have bConfigurationValue, busnum, and devnum, then we can determine
* the active configuration without having to open the usbfs node in RDWR mode.
* We assume this is the case if we see the busnum file (indicates 2.6.22+).
* The busnum file is important as that is the only way we can relate sysfs
* devices to usbfs nodes.
*
* If we also have descriptors, we can obtain the device descriptor and active
* configuration without touching usbfs at all.
*/
static const char *usbfs_path = NULL;
/* do we have a busnum to relate devices? this also implies that we can read
* the active configuration through bConfigurationValue */
static int sysfs_can_relate_devices = -1;
/* do we have a descriptors file? */
static int sysfs_has_descriptors = -1;
struct linux_device_priv {
char sysfs_dir[SYSFS_DIR_LENGTH];
unsigned char *dev_descriptor;
unsigned char *config_descriptor;
};
struct linux_device_handle_priv {
int fd;
};
enum reap_action {
NORMAL = 0,
/* submission failed after the first URB, so await cancellation/completion
* of all the others */
SUBMIT_FAILED,
/* cancelled by user or timeout */
CANCELLED,
};
struct linux_transfer_priv {
union {
struct usbfs_urb *urbs;
struct usbfs_urb **iso_urbs;
};
enum reap_action reap_action;
int num_urbs;
unsigned int awaiting_reap;
unsigned int awaiting_discard;
/* next iso packet in user-supplied transfer to be populated */
int iso_packet_offset;
};
static void __get_usbfs_path(struct libusb_device *dev, char *path)
{
snprintf(path, PATH_MAX, "%s/%03d/%03d", usbfs_path, dev->bus_number,
dev->device_address);
}
static struct linux_device_priv *__device_priv(struct libusb_device *dev)
{
return (struct linux_device_priv *) dev->os_priv;
}
static struct linux_device_handle_priv *__device_handle_priv(
struct libusb_device_handle *handle)
{
return (struct linux_device_handle_priv *) handle->os_priv;
}
static int check_usb_vfs(const char *dirname)
{
DIR *dir;
struct dirent *entry;
int found = 0;
dir = opendir(dirname);
if (!dir)
return 0;
while ((entry = readdir(dir)) != NULL) {
if (entry->d_name[0] == '.')
continue;
/* We assume if we find any files that it must be the right place */
found = 1;
break;
}
closedir(dir);
return found;
}
static const char *find_usbfs_path(void)
{
const char *path = "/dev/bus/usb";
const char *ret = NULL;
if (check_usb_vfs(path)) {
ret = path;
} else {
path = "/proc/bus/usb";
if (check_usb_vfs(path))
ret = path;
}
usbi_dbg("found usbfs at %s", ret);
return ret;
}
static int op_init(void)
{
struct stat statbuf;
int r;
usbfs_path = find_usbfs_path();
if (!usbfs_path) {
usbi_err("could not find usbfs");
return LIBUSB_ERROR_OTHER;
}
r = stat(SYSFS_DEVICE_PATH, &statbuf);
if (r == 0 && S_ISDIR(statbuf.st_mode)) {
usbi_dbg("found usb devices in sysfs");
} else {
usbi_dbg("sysfs usb info not available");
sysfs_has_descriptors = 0;
sysfs_can_relate_devices = 0;
}
return 0;
}
static int usbfs_get_device_descriptor(struct libusb_device *dev,
unsigned char *buffer)
{
struct linux_device_priv *priv = __device_priv(dev);
/* return cached copy */
memcpy(buffer, priv->dev_descriptor, DEVICE_DESC_LENGTH);
return 0;
}
static int __open_sysfs_attr(struct libusb_device *dev, const char *attr)
{
struct linux_device_priv *priv = __device_priv(dev);
char filename[PATH_MAX + 1];
int fd;
snprintf(filename, PATH_MAX, "%s/%s/%s",
SYSFS_DEVICE_PATH, priv->sysfs_dir, attr);
fd = open(filename, O_RDONLY);
if (fd < 0) {
usbi_err("open %s failed ret=%d errno=%d", filename, fd, errno);
return LIBUSB_ERROR_IO;
}
return fd;
}
static int sysfs_get_device_descriptor(struct libusb_device *dev,
unsigned char *buffer)
{
int fd;
ssize_t r;
/* sysfs provides access to an in-memory copy of the device descriptor,
* so we use that rather than keeping our own copy */
fd = __open_sysfs_attr(dev, "descriptors");
if (fd < 0)
return fd;
r = read(fd, buffer, DEVICE_DESC_LENGTH);;
close(fd);
if (r < 0) {
usbi_err("read failed, ret=%d errno=%d", fd, errno);
return LIBUSB_ERROR_IO;
} else if (r < DEVICE_DESC_LENGTH) {
usbi_err("short read %d/%d", r, DEVICE_DESC_LENGTH);
return LIBUSB_ERROR_IO;
}
return 0;
}
static int op_get_device_descriptor(struct libusb_device *dev,
unsigned char *buffer)
{
if (sysfs_has_descriptors)
return sysfs_get_device_descriptor(dev, buffer);
else
return usbfs_get_device_descriptor(dev, buffer);
}
static int usbfs_get_active_config_descriptor(struct libusb_device *dev,
unsigned char *buffer, size_t len)
{
struct linux_device_priv *priv = __device_priv(dev);
if (!priv->config_descriptor)
return LIBUSB_ERROR_NOT_FOUND; /* device is unconfigured */
/* retrieve cached copy */
memcpy(buffer, priv->config_descriptor, len);
return 0;
}
static int sysfs_get_active_config_descriptor(struct libusb_device *dev,
unsigned char *buffer, size_t len)
{
int fd;
ssize_t r;
off_t off;
/* sysfs provides access to an in-memory copy of the device descriptor,
* so we use that rather than keeping our own copy */
fd = __open_sysfs_attr(dev, "descriptors");
if (fd < 0)
return fd;
off = lseek(fd, DEVICE_DESC_LENGTH, SEEK_SET);
if (off < 0) {
usbi_err("seek failed, ret=%d errno=%d", off, errno);
close(fd);
return LIBUSB_ERROR_IO;
}
r = read(fd, buffer, len);
close(fd);
if (r < 0) {
usbi_err("read failed, ret=%d errno=%d", fd, errno);
return LIBUSB_ERROR_IO;
} else if (r == 0) {
usbi_dbg("device is unconfigured");
return LIBUSB_ERROR_NOT_FOUND;
} else if (r < len) {
usbi_err("short read %d/%d", r, len);
return LIBUSB_ERROR_IO;
}
return 0;
}
static int op_get_active_config_descriptor(struct libusb_device *dev,
unsigned char *buffer, size_t len)
{
if (sysfs_has_descriptors)
return sysfs_get_active_config_descriptor(dev, buffer, len);
else
return usbfs_get_active_config_descriptor(dev, buffer, len);
}
/* takes a usbfs fd, attempts to find the requested config and copy a certain
* amount of it into an output buffer. a bConfigurationValue of -1 indicates
* that the first config should be retreived. */
static int get_config_descriptor(int fd, uint8_t config_index,
unsigned char *buffer, size_t len)
{
unsigned char tmp[8];
off_t off;
ssize_t r;
off = lseek(fd, DEVICE_DESC_LENGTH, SEEK_SET);
if (off < 0) {
usbi_err("seek failed ret=%d errno=%d", off, errno);
return LIBUSB_ERROR_IO;
}
/* might need to skip some configuration descriptors to reach the
* requested configuration */
while (config_index) {
struct libusb_config_descriptor config;
/* read first 8 bytes of descriptor */
r = read(fd, tmp, sizeof(tmp));
if (r < 0) {
usbi_err("read failed ret=%d errno=%d", r, errno);
return LIBUSB_ERROR_IO;
} else if (r < sizeof(tmp)) {
usbi_err("short descriptor read %d/%d", r, sizeof(tmp));
return LIBUSB_ERROR_IO;
}
usbi_parse_descriptor(tmp, "bbwbb", &config);
/* seek forward to end of config */
off = lseek(fd, config.wTotalLength - sizeof(tmp), SEEK_CUR);
if (off < 0) {
usbi_err("seek failed ret=%d errno=%d", off, errno);
return LIBUSB_ERROR_IO;
}
config_index--;
}
/* read the rest of the descriptor */
r = read(fd, buffer, len);
if (r < 0) {
usbi_err("read failed ret=%d errno=%d", r, errno);
return LIBUSB_ERROR_IO;
} else if (r < len) {
usbi_err("short output read %d/%d", r, len);
return LIBUSB_ERROR_IO;
}
return 0;
}
static int op_get_config_descriptor(struct libusb_device *dev,
uint8_t config_index, unsigned char *buffer, size_t len)
{
char filename[PATH_MAX + 1];
int fd;
int r;
/* always read from usbfs: sysfs only has the active descriptor
* this will involve waking the device up, but oh well! */
__get_usbfs_path(dev, filename);
fd = open(filename, O_RDONLY);
if (fd < 0) {
usbi_err("open '%s' failed, ret=%d errno=%d", filename, fd, errno);
return LIBUSB_ERROR_IO;
}
r = get_config_descriptor(fd, config_index, buffer, len);
close(fd);
return r;
}
static int cache_active_config(struct libusb_device *dev, int fd,
int active_config)
{
struct linux_device_priv *priv = __device_priv(dev);
struct libusb_config_descriptor config;
unsigned char tmp[8];
unsigned char *buf;
int idx;
int r;
r = usbi_get_config_index_by_value(dev, active_config, &idx);
if (r < 0)
return r;
if (idx == -1)
return LIBUSB_ERROR_NOT_FOUND;
r = get_config_descriptor(fd, idx, tmp, sizeof(tmp));
if (r < 0) {
usbi_err("first read error %d", r);
return r;
}
usbi_parse_descriptor(tmp, "bbw", &config);
buf = malloc(config.wTotalLength);
if (!buf)
return LIBUSB_ERROR_NO_MEM;
r = get_config_descriptor(fd, idx, buf, config.wTotalLength);
if (r < 0) {
free(buf);
return r;
}
if (priv->config_descriptor)
free(priv->config_descriptor);
priv->config_descriptor = buf;
return 0;
}
/* read the bConfigurationValue for a device */
static int sysfs_get_active_config(struct libusb_device *dev, int *config)
{
char *endptr;
char tmp[4] = {0, 0, 0, 0};
long num;
int fd;
size_t r;
fd = __open_sysfs_attr(dev, "bConfigurationValue");
if (fd < 0)
return fd;
r = read(fd, tmp, sizeof(tmp));
close(fd);
if (r < 0) {
usbi_err("read bConfigurationValue failed ret=%d errno=%d",
r, errno);
return LIBUSB_ERROR_IO;
} else if (r == 0) {
usbi_err("device unconfigured");
*config = -1;
return 0;
}
if (tmp[sizeof(tmp) - 1] != 0) {
usbi_err("not null-terminated?");
return LIBUSB_ERROR_IO;
} else if (tmp[0] == 0) {
usbi_err("no configuration value?");
return LIBUSB_ERROR_IO;
}
num = strtol(tmp, &endptr, 10);
if (endptr == tmp) {
usbi_err("error converting '%s' to integer", tmp);
return LIBUSB_ERROR_IO;
}
*config = (int) num;
return 0;
}
/* send a control message to retrieve active configuration */
static int usbfs_get_active_config(struct libusb_device *dev, int fd)
{
int active_config;
int r;
struct usbfs_ctrltransfer ctrl = {
.bmRequestType = LIBUSB_ENDPOINT_IN,
.bRequest = LIBUSB_REQUEST_GET_CONFIGURATION,
.wValue = 0,
.wIndex = 0,
.wLength = 1,
.timeout = 1000,
.data = &active_config
};
r = ioctl(fd, IOCTL_USBFS_CONTROL, &ctrl);
if (r < 0) {
usbi_err("get_configuration failed ret=%d errno=%d", r, errno);
return LIBUSB_ERROR_IO;
}
return active_config;
}
static int initialize_device(struct libusb_device *dev, uint8_t busnum,
uint8_t devaddr, const char *sysfs_dir)
{
struct linux_device_priv *priv = __device_priv(dev);
unsigned char *dev_buf;
char path[PATH_MAX + 1];
int fd;
int active_config = 0;
int device_configured = 1;
ssize_t r;
dev->bus_number = busnum;
dev->device_address = devaddr;
if (sysfs_dir)
strncpy(priv->sysfs_dir, sysfs_dir, SYSFS_DIR_LENGTH);
if (sysfs_has_descriptors)
return 0;
/* cache device descriptor in memory so that we can retrieve it later
* without waking the device up (op_get_device_descriptor) */
priv->dev_descriptor = NULL;
priv->config_descriptor = NULL;
if (sysfs_can_relate_devices) {
int tmp = sysfs_get_active_config(dev, &active_config);
if (tmp < 0)
return tmp;
if (active_config == -1)
device_configured = 0;
}
__get_usbfs_path(dev, path);
fd = open(path, O_RDWR);
if (fd < 0 && errno == EACCES) {
fd = open(path, O_RDONLY);
/* if we only have read-only access to the device, we cannot
* send a control message to determine the active config. just
* assume the first one is active. */
active_config = -1;
}
if (fd < 0) {
usbi_err("open failed, ret=%d errno=%d", fd, errno);
return LIBUSB_ERROR_IO;
}
if (!sysfs_can_relate_devices) {
if (active_config == -1) {
/* if we only have read-only access to the device, we cannot
* send a control message to determine the active config. just
* assume the first one is active. */
usbi_warn("access to %s is read-only; cannot determine "
"active configuration descriptor", path);
} else {
active_config = usbfs_get_active_config(dev, fd);
if (active_config < 0) {
close(fd);
return active_config;
} else if (active_config == 0) {
/* some buggy devices have a configuration 0, but we're
* reaching into the corner of a corner case here, so let's
* not support buggy devices in these circumstances.
* stick to the specs: a configuration value of 0 means
* unconfigured. */
usbi_dbg("assuming unconfigured device");
device_configured = 0;
}
}
}
dev_buf = malloc(DEVICE_DESC_LENGTH);
if (!dev_buf) {
close(fd);
return LIBUSB_ERROR_NO_MEM;
}
r = read(fd, dev_buf, DEVICE_DESC_LENGTH);
if (r < 0) {
usbi_err("read descriptor failed ret=%d errno=%d", fd, errno);
free(dev_buf);
close(fd);
return LIBUSB_ERROR_IO;
} else if (r < DEVICE_DESC_LENGTH) {
usbi_err("short descriptor read (%d)", r);
free(dev_buf);
close(fd);
return LIBUSB_ERROR_IO;
}
/* bit of a hack: set num_configurations now because cache_active_config()
* calls usbi_get_config_index_by_value() which uses it */
dev->num_configurations = dev_buf[DEVICE_DESC_LENGTH - 1];
if (device_configured) {
r = cache_active_config(dev, fd, active_config);
if (r < 0) {
close(fd);
free(dev_buf);
return r;
}
}
close(fd);
priv->dev_descriptor = dev_buf;
return 0;
}
static int enumerate_device(struct discovered_devs **_discdevs,
uint8_t busnum, uint8_t devaddr, const char *sysfs_dir)
{
struct discovered_devs *discdevs;
unsigned long session_id;
int need_unref = 0;
struct libusb_device *dev;
int r = 0;
/* FIXME: session ID is not guaranteed unique as addresses can wrap and
* will be reused. instead we should add a simple sysfs attribute with
* a session ID. */
session_id = busnum << 8 | devaddr;
usbi_dbg("busnum %d devaddr %d session_id %ld", busnum, devaddr,
session_id);
dev = usbi_get_device_by_session_id(session_id);
if (dev) {
usbi_dbg("using existing device for %d/%d (session %ld)",
busnum, devaddr, session_id);
} else {
usbi_dbg("allocating new device for %d/%d (session %ld)",
busnum, devaddr, session_id);
dev = usbi_alloc_device(session_id);
if (!dev)
return LIBUSB_ERROR_NO_MEM;
need_unref = 1;
r = initialize_device(dev, busnum, devaddr, sysfs_dir);
if (r < 0)
goto out;
r = usbi_sanitize_device(dev);
if (r < 0)
goto out;
}
discdevs = discovered_devs_append(*_discdevs, dev);
if (!discdevs)
r = LIBUSB_ERROR_NO_MEM;
else
*_discdevs = discdevs;
out:
if (need_unref)
libusb_unref_device(dev);
return r;
}
/* open a bus directory and adds all discovered devices to discdevs. on
* failure (non-zero return) the pre-existing discdevs should be destroyed
* (and devices freed). on success, the new discdevs pointer should be used
* as it may have been moved. */
static int usbfs_scan_busdir(struct discovered_devs **_discdevs, uint8_t busnum)
{
DIR *dir;
char dirpath[PATH_MAX + 1];
struct dirent *entry;
struct discovered_devs *discdevs = *_discdevs;
int r = 0;
snprintf(dirpath, PATH_MAX, "%s/%03d", usbfs_path, busnum);
usbi_dbg("%s", dirpath);
dir = opendir(dirpath);
if (!dir) {
usbi_err("opendir '%s' failed, errno=%d", dirpath, errno);
/* FIXME: should handle valid race conditions like hub unplugged
* during directory iteration - this is not an error */
return LIBUSB_ERROR_IO;
}
while ((entry = readdir(dir))) {
int devaddr;
if (entry->d_name[0] == '.')
continue;
devaddr = atoi(entry->d_name);
if (devaddr == 0) {
usbi_dbg("unknown dir entry %s", entry->d_name);
continue;
}
r = enumerate_device(&discdevs, busnum, (uint8_t) devaddr, NULL);
if (r < 0)
goto out;
}
*_discdevs = discdevs;
out:
closedir(dir);
return r;
}
static int usbfs_get_device_list(struct discovered_devs **_discdevs)
{
struct dirent *entry;
DIR *buses = opendir(usbfs_path);
struct discovered_devs *discdevs = *_discdevs;
int r = 0;
if (!buses) {
usbi_err("opendir buses failed errno=%d", errno);
return LIBUSB_ERROR_IO;
}
while ((entry = readdir(buses))) {
struct discovered_devs *discdevs_new = discdevs;
int busnum;
if (entry->d_name[0] == '.')
continue;
busnum = atoi(entry->d_name);
if (busnum == 0) {
usbi_dbg("unknown dir entry %s", entry->d_name);
continue;
}
r = usbfs_scan_busdir(&discdevs_new, busnum);
if (r < 0)
goto out;
discdevs = discdevs_new;
}
out:
closedir(buses);
*_discdevs = discdevs;
return r;
}
static int sysfs_scan_device(struct discovered_devs **_discdevs,
const char *devname, int *usbfs_fallback)
{
int r;
FILE *fd;
char filename[PATH_MAX + 1];
int busnum;
int devaddr;
usbi_dbg("scan %s", devname);
/* determine descriptors presence ahead of time, we need to know this
* when we reach initialize_device */
if (sysfs_has_descriptors == -1) {
struct stat statbuf;
snprintf(filename, PATH_MAX, "%s/%s/descriptors", SYSFS_DEVICE_PATH,
devname);
r = stat(filename, &statbuf);
if (r == 0 && S_ISREG(statbuf.st_mode)) {
usbi_dbg("sysfs descriptors available");
sysfs_has_descriptors = 1;
} else {
usbi_dbg("sysfs descriptors not available");
sysfs_has_descriptors = 0;
}
}
snprintf(filename, PATH_MAX, "%s/%s/busnum", SYSFS_DEVICE_PATH, devname);
fd = fopen(filename, "r");
if (!fd) {
if (errno == ENOENT) {
usbi_dbg("busnum not found, cannot relate sysfs to usbfs, "
"falling back on pure usbfs");
sysfs_can_relate_devices = 0;
*usbfs_fallback = 1;
return LIBUSB_ERROR_OTHER;
}
usbi_err("open busnum failed, errno=%d", errno);
return LIBUSB_ERROR_IO;
}
sysfs_can_relate_devices = 1;
r = fscanf(fd, "%d", &busnum);
fclose(fd);
if (r != 1) {
usbi_err("fscanf busnum returned %d, errno=%d", r, errno);
return LIBUSB_ERROR_IO;
}
snprintf(filename, PATH_MAX, "%s/%s/devnum", SYSFS_DEVICE_PATH, devname);
fd = fopen(filename, "r");
if (!fd) {
usbi_err("open devnum failed, errno=%d", errno);
return LIBUSB_ERROR_IO;
}
r = fscanf(fd, "%d", &devaddr);
fclose(fd);
if (r != 1) {
usbi_err("fscanf devnum returned %d, errno=%d", r, errno);
return LIBUSB_ERROR_IO;
}
usbi_dbg("bus=%d dev=%d", busnum, devaddr);
if (busnum > 255 || devaddr > 255)
return LIBUSB_ERROR_INVALID_PARAM;
return enumerate_device(_discdevs, busnum & 0xff, devaddr & 0xff, devname);
}
static int sysfs_get_device_list(struct discovered_devs **_discdevs,
int *usbfs_fallback)
{
struct discovered_devs *discdevs = *_discdevs;
DIR *devices = opendir(SYSFS_DEVICE_PATH);
struct dirent *entry;
int r = 0;
if (!devices) {
usbi_err("opendir devices failed errno=%d", errno);
return LIBUSB_ERROR_IO;
}
while ((entry = readdir(devices))) {
struct discovered_devs *discdevs_new = discdevs;
if ((!isdigit(entry->d_name[0]) && strncmp(entry->d_name, "usb", 3))
|| strchr(entry->d_name, ':'))
continue;
r = sysfs_scan_device(&discdevs_new, entry->d_name, usbfs_fallback);
if (r < 0)
goto out;
discdevs = discdevs_new;
}
out:
closedir(devices);
*_discdevs = discdevs;
return r;
}
static int op_get_device_list(struct discovered_devs **_discdevs)
{
/* we can retrieve device list and descriptors from sysfs or usbfs.
* sysfs is preferable, because if we use usbfs we end up resuming
* any autosuspended USB devices. however, sysfs is not available
* everywhere, so we need a usbfs fallback too.
*
* as described in the "sysfs vs usbfs" comment, sometimes we have
* sysfs but not enough information to relate sysfs devices to usbfs
* nodes. the usbfs_fallback variable is used to indicate that we should
* fall back on usbfs.
*/
if (sysfs_can_relate_devices != 0) {
int usbfs_fallback = 0;
int r = sysfs_get_device_list(_discdevs, &usbfs_fallback);
if (!usbfs_fallback)
return r;
}
return usbfs_get_device_list(_discdevs);
}
static int op_open(struct libusb_device_handle *handle)
{
struct linux_device_handle_priv *hpriv = __device_handle_priv(handle);
char filename[PATH_MAX + 1];
__get_usbfs_path(handle->dev, filename);
hpriv->fd = open(filename, O_RDWR);
if (hpriv->fd < 0) {
if (errno == EACCES) {
fprintf(stderr, "libusb couldn't open USB device %s: "
"Permission denied.\n"
"libusb requires write access to USB device nodes.\n",
filename);
return LIBUSB_ERROR_ACCESS;
} else {
usbi_err("open failed, code %d errno %d", hpriv->fd, errno);
return LIBUSB_ERROR_IO;
}
}
return usbi_add_pollfd(hpriv->fd, POLLOUT);
}
static void op_close(struct libusb_device_handle *dev_handle)
{
int fd = __device_handle_priv(dev_handle)->fd;
usbi_remove_pollfd(fd);
close(fd);
}
static int op_set_configuration(struct libusb_device_handle *handle, int config)
{
struct linux_device_priv *priv = __device_priv(handle->dev);
int fd = __device_handle_priv(handle)->fd;
int r = ioctl(fd, IOCTL_USBFS_SETCONFIG, &config);
if (r) {
if (errno == EINVAL)
return LIBUSB_ERROR_NOT_FOUND;
else if (errno == EBUSY)
return LIBUSB_ERROR_BUSY;
usbi_err("failed, error %d errno %d", r, errno);
return LIBUSB_ERROR_OTHER;
}
if (!sysfs_has_descriptors) {
/* update our cached active config descriptor */
if (config == -1) {
if (priv->config_descriptor) {
free(priv->config_descriptor);
priv->config_descriptor = NULL;
}
} else {
r = cache_active_config(handle->dev, fd, config);
if (r < 0)
usbi_warn("failed to update cached config descriptor, "
"error %d", r);
}
}
return 0;
}
static int op_claim_interface(struct libusb_device_handle *handle, int iface)
{
int fd = __device_handle_priv(handle)->fd;
int r = ioctl(fd, IOCTL_USBFS_CLAIMINTF, &iface);
if (r) {
if (errno == ENOENT)
return LIBUSB_ERROR_NOT_FOUND;
else if (errno == EBUSY)
return LIBUSB_ERROR_BUSY;
usbi_err("claim interface failed, error %d errno %d", r, errno);
return LIBUSB_ERROR_OTHER;
}
return 0;
}
static int op_release_interface(struct libusb_device_handle *handle, int iface)
{
int fd = __device_handle_priv(handle)->fd;
int r = ioctl(fd, IOCTL_USBFS_RELEASEINTF, &iface);
if (r) {
usbi_err("release interface failed, error %d errno %d", r, errno);
return LIBUSB_ERROR_OTHER;
}
return 0;
}
static int op_set_interface(struct libusb_device_handle *handle, int iface,
int altsetting)
{
int fd = __device_handle_priv(handle)->fd;
struct usbfs_setinterface setintf;
int r;
setintf.interface = iface;
setintf.altsetting = altsetting;
r = ioctl(fd, IOCTL_USBFS_SETINTF, &setintf);
if (r) {
if (errno == EINVAL)
return LIBUSB_ERROR_NOT_FOUND;
usbi_err("setintf failed error %d errno %d", r, errno);
return LIBUSB_ERROR_OTHER;
}
return 0;
}
static int op_clear_halt(struct libusb_device_handle *handle,
unsigned char endpoint)
{
int fd = __device_handle_priv(handle)->fd;
unsigned int _endpoint = endpoint;
int r = ioctl(fd, IOCTL_USBFS_CLEAR_HALT, &_endpoint);
if (r) {
if (errno == ENOENT)
return LIBUSB_ERROR_NOT_FOUND;
usbi_err("clear_halt failed error %d errno %d", r, errno);
return LIBUSB_ERROR_OTHER;
}
return 0;
}
static int op_reset_device(struct libusb_device_handle *handle)
{
int fd = __device_handle_priv(handle)->fd;
int r = ioctl(fd, IOCTL_USBFS_RESET, NULL);
if (r) {
if (errno == ENODEV)
return LIBUSB_ERROR_NOT_FOUND;
usbi_err("reset failed error %d errno %d", r, errno);
return LIBUSB_ERROR_OTHER;
}
return 0;
}
static int op_kernel_driver_active(struct libusb_device_handle *handle,
int interface)
{
int fd = __device_handle_priv(handle)->fd;
struct usbfs_getdriver getdrv;
int r;
getdrv.interface = interface;
r = ioctl(fd, IOCTL_USBFS_GETDRIVER, &getdrv);
if (r) {
if (errno == ENODATA)
return 0;
usbi_err("get driver failed error %d errno %d", r, errno);
return LIBUSB_ERROR_OTHER;
}
return 1;
}
static int op_detach_kernel_driver(struct libusb_device_handle *handle,
int interface)
{
int fd = __device_handle_priv(handle)->fd;
struct usbfs_ioctl command;
int r;
command.ifno = interface;
command.ioctl_code = IOCTL_USBFS_DISCONNECT;
command.data = NULL;
r = ioctl(fd, IOCTL_USBFS_IOCTL, &command);
if (r) {
if (errno == ENODATA)
return LIBUSB_ERROR_NOT_FOUND;
else if (errno == EINVAL)
return LIBUSB_ERROR_INVALID_PARAM;
usbi_err("detach failed error %d errno %d", r, errno);
return LIBUSB_ERROR_OTHER;
}
return 0;
}
static void op_destroy_device(struct libusb_device *dev)
{
struct linux_device_priv *priv = __device_priv(dev);
if (!sysfs_has_descriptors) {
if (priv->dev_descriptor)
free(priv->dev_descriptor);
if (priv->config_descriptor)
free(priv->config_descriptor);
}
}
static void free_iso_urbs(struct linux_transfer_priv *tpriv)
{
int i;
for (i = 0; i < tpriv->num_urbs; i++) {
struct usbfs_urb *urb = tpriv->iso_urbs[i];
if (!urb)
break;
free(urb);
}
free(tpriv->iso_urbs);
}
static int submit_bulk_transfer(struct usbi_transfer *itransfer,
unsigned char urb_type)
{
struct libusb_transfer *transfer =
__USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
struct linux_transfer_priv *tpriv = usbi_transfer_get_os_priv(itransfer);
struct linux_device_handle_priv *dpriv =
__device_handle_priv(transfer->dev_handle);
struct usbfs_urb *urbs;
int r;
int i;
size_t alloc_size;
/* usbfs places a 16kb limit on bulk URBs. we divide up larger requests
* into smaller units to meet such restriction, then fire off all the
* units at once. it would be simpler if we just fired one unit at a time,
* but there is a big performance gain through doing it this way. */
int num_urbs = transfer->length / MAX_BULK_BUFFER_LENGTH;
int last_urb_partial = 0;
if ((transfer->length % MAX_BULK_BUFFER_LENGTH) > 0) {
last_urb_partial = 1;
num_urbs++;
}
usbi_dbg("need %d urbs for new transfer with length %d", num_urbs,
transfer->length);
alloc_size = num_urbs * sizeof(struct usbfs_urb);
urbs = malloc(alloc_size);
if (!urbs)
return LIBUSB_ERROR_NO_MEM;
memset(urbs, 0, alloc_size);
tpriv->urbs = urbs;
tpriv->num_urbs = num_urbs;
tpriv->awaiting_discard = 0;
tpriv->awaiting_reap = 0;
tpriv->reap_action = NORMAL;
for (i = 0; i < num_urbs; i++) {
struct usbfs_urb *urb = &urbs[i];
urb->usercontext = itransfer;
urb->type = urb_type;
urb->endpoint = transfer->endpoint;
urb->buffer = transfer->buffer + (i * MAX_BULK_BUFFER_LENGTH);
if (i == num_urbs - 1 && last_urb_partial)
urb->buffer_length = transfer->length % MAX_BULK_BUFFER_LENGTH;
else
urb->buffer_length = MAX_BULK_BUFFER_LENGTH;
r = ioctl(dpriv->fd, IOCTL_USBFS_SUBMITURB, urb);
if (r < 0) {
int j;
usbi_err("submiturb failed error %d errno=%d", r, errno);
/* if the first URB submission fails, we can simply free up and
* return failure immediately. */
if (i == 0) {
usbi_dbg("first URB failed, easy peasy");
free(urbs);
return LIBUSB_ERROR_IO;
}
/* if it's not the first URB that failed, the situation is a bit
* tricky. we must discard all previous URBs. there are
* complications:
* - discarding is asynchronous - discarded urbs will be reaped
* later. the user must not have freed the transfer when the
* discarded URBs are reaped, otherwise libusb will be using
* freed memory.
* - the earlier URBs may have completed successfully and we do
* not want to throw away any data.
* so, in this case we discard all the previous URBs BUT we report
* that the transfer was submitted successfully. then later when
* the final discard completes we can report error to the user.
*/
tpriv->reap_action = SUBMIT_FAILED;
for (j = 0; j < i; j++) {
int tmp = ioctl(dpriv->fd, IOCTL_USBFS_DISCARDURB, &urbs[j]);
if (tmp == 0)
tpriv->awaiting_discard++;
else if (tmp == -EINVAL)
tpriv->awaiting_reap++;
else
usbi_warn("unrecognised discard return %d", tmp);
}
usbi_dbg("reporting successful submission but waiting for %d "
"discards and %d reaps before reporting error",
tpriv->awaiting_discard, tpriv->awaiting_reap);
return 0;
}
}
return 0;
}
static int submit_iso_transfer(struct usbi_transfer *itransfer)
{
struct libusb_transfer *transfer =
__USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
struct linux_transfer_priv *tpriv = usbi_transfer_get_os_priv(itransfer);
struct linux_device_handle_priv *dpriv =
__device_handle_priv(transfer->dev_handle);
struct usbfs_urb **urbs;
size_t alloc_size;
int num_packets = transfer->num_iso_packets;
int i;
int this_urb_len = 0;
int num_urbs = 1;
int packet_offset = 0;
unsigned int packet_len;
unsigned char *urb_buffer = transfer->buffer;
/* usbfs places a 32kb limit on iso URBs. we divide up larger requests
* into smaller units to meet such restriction, then fire off all the
* units at once. it would be simpler if we just fired one unit at a time,
* but there is a big performance gain through doing it this way. */
/* calculate how many URBs we need */
for (i = 0; i < num_packets; i++) {
int space_remaining = MAX_ISO_BUFFER_LENGTH - this_urb_len;
packet_len = transfer->iso_packet_desc[i].length;
if (packet_len > space_remaining) {
num_urbs++;
this_urb_len = packet_len;
} else {
this_urb_len += packet_len;
}
}
usbi_dbg("need %d 32k URBs for transfer", num_urbs);
alloc_size = num_urbs * sizeof(*urbs);
urbs = malloc(alloc_size);
if (!urbs)
return LIBUSB_ERROR_NO_MEM;
memset(urbs, 0, alloc_size);
tpriv->iso_urbs = urbs;
tpriv->num_urbs = num_urbs;
tpriv->awaiting_discard = 0;
tpriv->awaiting_reap = 0;
tpriv->reap_action = NORMAL;
tpriv->iso_packet_offset = 0;
/* allocate + initialize each URB with the correct number of packets */
for (i = 0; i < num_urbs; i++) {
struct usbfs_urb *urb;
int space_remaining_in_urb = MAX_ISO_BUFFER_LENGTH;
int urb_packet_offset = 0;
unsigned char *urb_buffer_orig = urb_buffer;
int j;
int k;
/* swallow up all the packets we can fit into this URB */
while (packet_offset < transfer->num_iso_packets) {
packet_len = transfer->iso_packet_desc[packet_offset].length;
if (packet_len <= space_remaining_in_urb) {
/* throw it in */
urb_packet_offset++;
packet_offset++;
space_remaining_in_urb -= packet_len;
urb_buffer += packet_len;
} else {
/* it can't fit, save it for the next URB */
break;
}
}
alloc_size = sizeof(*urb)
+ (urb_packet_offset * sizeof(struct usbfs_iso_packet_desc));
urb = malloc(alloc_size);
if (!urb) {
free_iso_urbs(tpriv);
return LIBUSB_ERROR_NO_MEM;
}
memset(urb, 0, alloc_size);
urbs[i] = urb;
/* populate packet lengths */
for (j = 0, k = packet_offset - urb_packet_offset;
k < packet_offset; k++, j++) {
packet_len = transfer->iso_packet_desc[k].length;
urb->iso_frame_desc[j].length = packet_len;
}
urb->usercontext = itransfer;
urb->type = USBFS_URB_TYPE_ISO;
/* FIXME: interface for non-ASAP data? */
urb->flags = USBFS_URB_ISO_ASAP;
urb->endpoint = transfer->endpoint;
urb->number_of_packets = urb_packet_offset;
urb->buffer = urb_buffer_orig;
}
/* submit URBs */
for (i = 0; i < num_urbs; i++) {
int r = ioctl(dpriv->fd, IOCTL_USBFS_SUBMITURB, urbs[i]);
if (r < 0) {
int j;
usbi_err("submiturb failed error %d errno=%d", r, errno);
/* if the first URB submission fails, we can simply free up and
* return failure immediately. */
if (i == 0) {
usbi_dbg("first URB failed, easy peasy");
free_iso_urbs(tpriv);
return LIBUSB_ERROR_IO;
}
/* if it's not the first URB that failed, the situation is a bit
* tricky. we must discard all previous URBs. there are
* complications:
* - discarding is asynchronous - discarded urbs will be reaped
* later. the user must not have freed the transfer when the
* discarded URBs are reaped, otherwise libusb will be using
* freed memory.
* - the earlier URBs may have completed successfully and we do
* not want to throw away any data.
* so, in this case we discard all the previous URBs BUT we report
* that the transfer was submitted successfully. then later when
* the final discard completes we can report error to the user.
*/
tpriv->reap_action = SUBMIT_FAILED;
for (j = 0; j < i; j++) {
int tmp = ioctl(dpriv->fd, IOCTL_USBFS_DISCARDURB, urbs[j]);
if (tmp == 0)
tpriv->awaiting_discard++;
else if (tmp == -EINVAL)
tpriv->awaiting_reap++;
else
usbi_warn("unrecognised discard return %d", tmp);
}
usbi_dbg("reporting successful submission but waiting for %d "
"discards and %d reaps before reporting error",
tpriv->awaiting_discard, tpriv->awaiting_reap);
return 0;
}
}
return 0;
}
static int submit_control_transfer(struct usbi_transfer *itransfer)
{
struct linux_transfer_priv *tpriv = usbi_transfer_get_os_priv(itransfer);
struct libusb_transfer *transfer =
__USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
struct linux_device_handle_priv *dpriv =
__device_handle_priv(transfer->dev_handle);
struct usbfs_urb *urb;
int r;
if (transfer->length - LIBUSB_CONTROL_SETUP_SIZE > MAX_CTRL_BUFFER_LENGTH)
return LIBUSB_ERROR_INVALID_PARAM;
urb = malloc(sizeof(struct usbfs_urb));
if (!urb)
return LIBUSB_ERROR_NO_MEM;
memset(urb, 0, sizeof(struct usbfs_urb));
tpriv->urbs = urb;
tpriv->reap_action = NORMAL;
urb->usercontext = itransfer;
urb->type = USBFS_URB_TYPE_CONTROL;
urb->endpoint = transfer->endpoint;
urb->buffer = transfer->buffer;
urb->buffer_length = transfer->length;
r = ioctl(dpriv->fd, IOCTL_USBFS_SUBMITURB, urb);
if (r < 0) {
usbi_err("submiturb failed error %d errno=%d", r, errno);
free(urb);
return LIBUSB_ERROR_IO;
}
return 0;
}
static int op_submit_transfer(struct usbi_transfer *itransfer)
{
struct libusb_transfer *transfer =
__USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
switch (transfer->type) {
case LIBUSB_TRANSFER_TYPE_CONTROL:
return submit_control_transfer(itransfer);
case LIBUSB_TRANSFER_TYPE_BULK:
return submit_bulk_transfer(itransfer, USBFS_URB_TYPE_BULK);
case LIBUSB_TRANSFER_TYPE_INTERRUPT:
return submit_bulk_transfer(itransfer, USBFS_URB_TYPE_INTERRUPT);
case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
return submit_iso_transfer(itransfer);
default:
usbi_err("unknown endpoint type %d", transfer->type);
return LIBUSB_ERROR_INVALID_PARAM;
}
}
static int cancel_control_transfer(struct usbi_transfer *itransfer)
{
struct linux_transfer_priv *tpriv = usbi_transfer_get_os_priv(itransfer);
struct libusb_transfer *transfer =
__USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
struct linux_device_handle_priv *dpriv =
__device_handle_priv(transfer->dev_handle);
int r;
tpriv->reap_action = CANCELLED;
r = ioctl(dpriv->fd, IOCTL_USBFS_DISCARDURB, tpriv->urbs);
if (r == -EINVAL) {
usbi_dbg("URB not found --> assuming ready to be reaped");
return 0;
} else if (r) {
usbi_err("unrecognised DISCARD code %d", r);
return LIBUSB_ERROR_OTHER;
}
return 0;
}
static void cancel_bulk_transfer(struct usbi_transfer *itransfer)
{
struct linux_transfer_priv *tpriv = usbi_transfer_get_os_priv(itransfer);
struct libusb_transfer *transfer =
__USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
struct linux_device_handle_priv *dpriv =
__device_handle_priv(transfer->dev_handle);
int i;
tpriv->reap_action = CANCELLED;
for (i = 0; i < tpriv->num_urbs; i++) {
int tmp = ioctl(dpriv->fd, IOCTL_USBFS_DISCARDURB, &tpriv->urbs[i]);
if (tmp == 0)
tpriv->awaiting_discard++;
else if (tmp == -EINVAL)
tpriv->awaiting_reap++;
else
usbi_warn("unrecognised discard return %d", tmp);
}
}
static void cancel_iso_transfer(struct usbi_transfer *itransfer)
{
struct linux_transfer_priv *tpriv = usbi_transfer_get_os_priv(itransfer);
struct libusb_transfer *transfer =
__USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
struct linux_device_handle_priv *dpriv =
__device_handle_priv(transfer->dev_handle);
int i;
tpriv->reap_action = CANCELLED;
for (i = 0; i < tpriv->num_urbs; i++) {
int tmp = ioctl(dpriv->fd, IOCTL_USBFS_DISCARDURB, tpriv->iso_urbs[i]);
if (tmp == 0)
tpriv->awaiting_discard++;
else if (tmp == -EINVAL)
tpriv->awaiting_reap++;
else
usbi_warn("unrecognised discard return %d", tmp);
}
}
static int op_cancel_transfer(struct usbi_transfer *itransfer)
{
struct libusb_transfer *transfer =
__USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
switch (transfer->type) {
case LIBUSB_TRANSFER_TYPE_CONTROL:
return cancel_control_transfer(itransfer);
case LIBUSB_TRANSFER_TYPE_BULK:
case LIBUSB_TRANSFER_TYPE_INTERRUPT:
cancel_bulk_transfer(itransfer);
return 0;
case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
cancel_iso_transfer(itransfer);
return 0;
default:
usbi_err("unknown endpoint type %d", transfer->type);
return LIBUSB_ERROR_INVALID_PARAM;
}
}
static int handle_bulk_completion(struct usbi_transfer *itransfer,
struct usbfs_urb *urb)
{
struct linux_transfer_priv *tpriv = usbi_transfer_get_os_priv(itransfer);
int num_urbs = tpriv->num_urbs;
int urb_idx = urb - tpriv->urbs;
usbi_dbg("handling completion status %d of bulk urb %d/%d", urb->status,
urb_idx + 1, num_urbs);
if (urb->status == 0)
itransfer->transferred += urb->actual_length;
if (tpriv->reap_action != NORMAL) { /* cancelled or submit_fail */
if (urb->status == -ENOENT) {
usbi_dbg("CANCEL: detected a cancelled URB");
if (tpriv->awaiting_discard == 0)
usbi_err("CANCEL: cancelled URB but not awaiting discards?");
else
tpriv->awaiting_discard--;
} else if (urb->status == 0) {
usbi_dbg("CANCEL: detected a completed URB");
if (tpriv->awaiting_reap == 0)
usbi_err("CANCEL: completed URB not awaiting reap?");
else
tpriv->awaiting_reap--;
} else {
usbi_warn("unhandled CANCEL urb status %d", urb->status);
}
if (tpriv->awaiting_reap == 0 && tpriv->awaiting_discard == 0) {
usbi_dbg("CANCEL: last URB handled, reporting");
free(tpriv->urbs);
if (tpriv->reap_action == CANCELLED)
usbi_handle_transfer_cancellation(itransfer);
else
usbi_handle_transfer_completion(itransfer,
LIBUSB_TRANSFER_ERROR);
}
return 0;
}
if (urb->status == -EPIPE) {
usbi_dbg("detected endpoint stall");
usbi_handle_transfer_completion(itransfer, LIBUSB_TRANSFER_STALL);
return 0;
} else if (urb->status != 0) {
usbi_warn("unrecognised urb status %d", urb->status);
}
/* if we're the last urb or we got less data than requested then we're
* done */
if (urb_idx == num_urbs - 1)
usbi_dbg("last URB in transfer --> complete!");
else if (urb->actual_length < urb->buffer_length)
usbi_dbg("short transfer %d/%d --> complete!",
urb->actual_length, urb->buffer_length);
else
return 0;
free(tpriv->urbs);
usbi_handle_transfer_completion(itransfer, LIBUSB_TRANSFER_COMPLETED);
return 0;
}
static int handle_iso_completion(struct usbi_transfer *itransfer,
struct usbfs_urb *urb)
{
struct libusb_transfer *transfer =
__USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
struct linux_transfer_priv *tpriv = usbi_transfer_get_os_priv(itransfer);
int num_urbs = tpriv->num_urbs;
int urb_idx = 0;
int i;
for (i = 0; i < num_urbs; i++) {
if (urb == tpriv->iso_urbs[i]) {
urb_idx = i + 1;
break;
}
}
if (urb_idx == 0) {
usbi_err("could not locate urb!");
return LIBUSB_ERROR_NOT_FOUND;
}
usbi_dbg("handling completion status %d of iso urb %d/%d", urb->status,
urb_idx, num_urbs);
if (urb->status == 0) {
/* copy isochronous results back in */
for (i = 0; i < urb->number_of_packets; i++) {
struct usbfs_iso_packet_desc *urb_desc = &urb->iso_frame_desc[i];
struct libusb_iso_packet_descriptor *lib_desc =
&transfer->iso_packet_desc[tpriv->iso_packet_offset++];
lib_desc->status = urb_desc->status;
lib_desc->actual_length = urb_desc->actual_length;
}
}
if (tpriv->reap_action != NORMAL) { /* cancelled or submit_fail */
if (urb->status == -ENOENT) {
usbi_dbg("CANCEL: detected a cancelled URB");
if (tpriv->awaiting_discard == 0)
usbi_err("CANCEL: cancelled URB but not awaiting discards?");
else
tpriv->awaiting_discard--;
} else if (urb->status == 0) {
usbi_dbg("CANCEL: detected a completed URB");
if (tpriv->awaiting_reap == 0)
usbi_err("CANCEL: completed URB not awaiting reap?");
else
tpriv->awaiting_reap--;
} else {
usbi_warn("unhandled CANCEL urb status %d", urb->status);
}
if (tpriv->awaiting_reap == 0 && tpriv->awaiting_discard == 0) {
usbi_dbg("CANCEL: last URB handled, reporting");
free_iso_urbs(tpriv);
if (tpriv->reap_action == CANCELLED)
usbi_handle_transfer_cancellation(itransfer);
else
usbi_handle_transfer_completion(itransfer,
LIBUSB_TRANSFER_ERROR);
}
return 0;
}
if (urb->status != 0)
usbi_warn("unrecognised urb status %d", urb->status);
/* if we're the last urb or we got less data than requested then we're
* done */
if (urb_idx == num_urbs) {
usbi_dbg("last URB in transfer --> complete!");
free_iso_urbs(tpriv);
usbi_handle_transfer_completion(itransfer, LIBUSB_TRANSFER_COMPLETED);
}
return 0;
}
static int handle_control_completion(struct usbi_transfer *itransfer,
struct usbfs_urb *urb)
{
struct linux_transfer_priv *tpriv = usbi_transfer_get_os_priv(itransfer);
int status;
usbi_dbg("handling completion status %d", urb->status);
if (urb->status == 0)
itransfer->transferred += urb->actual_length;
if (tpriv->reap_action == CANCELLED) {
if (urb->status != 0 && urb->status != -ENOENT)
usbi_warn("cancel: unrecognised urb status %d", urb->status);
free(tpriv->urbs);
usbi_handle_transfer_cancellation(itransfer);
return 0;
}
if (urb->status == -EPIPE) {
usbi_dbg("unsupported control request");
status = LIBUSB_TRANSFER_STALL;
goto out;
} else if (urb->status != 0) {
usbi_warn("unrecognised urb status %d", urb->status);
status = LIBUSB_TRANSFER_ERROR;
goto out;
}
itransfer->transferred = urb->actual_length;
status = LIBUSB_TRANSFER_COMPLETED;
out:
free(tpriv->urbs);
usbi_handle_transfer_completion(itransfer, status);
return 0;
}
static int reap_for_handle(struct libusb_device_handle *handle)
{
struct linux_device_handle_priv *hpriv = __device_handle_priv(handle);
int r;
struct usbfs_urb *urb;
struct usbi_transfer *itransfer;
struct libusb_transfer *transfer;
r = ioctl(hpriv->fd, IOCTL_USBFS_REAPURBNDELAY, &urb);
if (r == -1 && errno == EAGAIN)
return r;
if (r < 0) {
usbi_err("reap failed error %d errno=%d", r, errno);
return r;
}
itransfer = urb->usercontext;
transfer = __USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
usbi_dbg("urb type=%d status=%d transferred=%d", urb->type, urb->status,
urb->actual_length);
switch (transfer->type) {
case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
return handle_iso_completion(itransfer, urb);
case LIBUSB_TRANSFER_TYPE_BULK:
case LIBUSB_TRANSFER_TYPE_INTERRUPT:
return handle_bulk_completion(itransfer, urb);
case LIBUSB_TRANSFER_TYPE_CONTROL:
return handle_control_completion(itransfer, urb);
default:
usbi_err("unrecognised endpoint type %x", transfer->type);
return LIBUSB_ERROR_OTHER;
}
}
static int op_handle_events(fd_set *readfds, fd_set *writefds)
{
struct libusb_device_handle *handle;
int ret = 0;
pthread_mutex_lock(&usbi_open_devs_lock);
list_for_each_entry(handle, &usbi_open_devs, list) {
struct linux_device_handle_priv *hpriv = __device_handle_priv(handle);
int r;
if (!FD_ISSET(hpriv->fd, writefds))
continue;
r = reap_for_handle(handle);
if (r == -1 && errno == EAGAIN)
continue;
if (r < 0) {
ret = LIBUSB_ERROR_IO;
goto out;
}
}
out:
pthread_mutex_unlock(&usbi_open_devs_lock);
return ret;
}
const struct usbi_os_backend linux_usbfs_backend = {
.name = "Linux usbfs",
.init = op_init,
.exit = NULL,
.get_device_list = op_get_device_list,
.get_device_descriptor = op_get_device_descriptor,
.get_active_config_descriptor = op_get_active_config_descriptor,
.get_config_descriptor = op_get_config_descriptor,
.open = op_open,
.close = op_close,
.set_configuration = op_set_configuration,
.claim_interface = op_claim_interface,
.release_interface = op_release_interface,
.set_interface_altsetting = op_set_interface,
.clear_halt = op_clear_halt,
.reset_device = op_reset_device,
.kernel_driver_active = op_kernel_driver_active,
.detach_kernel_driver = op_detach_kernel_driver,
.destroy_device = op_destroy_device,
.submit_transfer = op_submit_transfer,
.cancel_transfer = op_cancel_transfer,
.handle_events = op_handle_events,
.device_priv_size = sizeof(struct linux_device_priv),
.device_handle_priv_size = sizeof(struct linux_device_handle_priv),
.transfer_priv_size = sizeof(struct linux_transfer_priv),
.add_iso_packet_size = 0,
};
|