/
libusb.c
1035 lines (859 loc) · 32.6 KB
/
libusb.c
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
/*
* This file is part of the bladeRF project:
* http://www.github.com/nuand/bladeRF
*
* Copyright (C) 2013 Nuand LLC
*
* 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 <stdlib.h>
#include <pthread.h>
#include <errno.h>
#include <libusb.h>
#include "bladeRF.h" /* Firmware interface */
#include "backend/backend.h"
#include "backend/usb/usb.h"
#include "async.h"
#include "log.h"
#ifndef LIBUSB_HANDLE_EVENTS_TIMEOUT_NSEC
# define LIBUSB_HANDLE_EVENTS_TIMEOUT_NSEC (15 * 1000)
#endif
struct bladerf_lusb {
libusb_device *dev;
libusb_device_handle *handle;
libusb_context *context;
};
typedef enum {
TRANSFER_UNINITIALIZED = 0,
TRANSFER_AVAIL,
TRANSFER_IN_FLIGHT,
TRANSFER_CANCEL_PENDING
} transfer_status;
struct lusb_stream_data {
size_t num_transfers; /**< Total number of allocated transfers */
size_t num_avail_transfers;
size_t i; /**< Index to next transfer */
struct libusb_transfer **transfers;
transfer_status *transfer_status; /**< Status of each transfer */
};
static inline struct bladerf_lusb * lusb_backend(struct bladerf *dev)
{
struct bladerf_usb *usb;
assert(dev && dev->backend);
usb = (struct bladerf_usb *) dev->backend;
assert(usb->driver);
return (struct bladerf_lusb *) usb->driver;
}
/* Convert libusb error codes to libbladeRF error codes */
static int error_conv(int error)
{
int ret;
switch (error) {
case 0:
ret = 0;
break;
case LIBUSB_ERROR_IO:
ret = BLADERF_ERR_IO;
break;
case LIBUSB_ERROR_INVALID_PARAM:
ret = BLADERF_ERR_INVAL;
break;
case LIBUSB_ERROR_BUSY:
case LIBUSB_ERROR_NO_DEVICE:
ret = BLADERF_ERR_NODEV;
break;
case LIBUSB_ERROR_TIMEOUT:
ret = BLADERF_ERR_TIMEOUT;
break;
case LIBUSB_ERROR_NO_MEM:
ret = BLADERF_ERR_MEM;
break;
case LIBUSB_ERROR_NOT_SUPPORTED:
ret = BLADERF_ERR_UNSUPPORTED;
break;
case LIBUSB_ERROR_OVERFLOW:
case LIBUSB_ERROR_PIPE:
case LIBUSB_ERROR_INTERRUPTED:
case LIBUSB_ERROR_ACCESS:
case LIBUSB_ERROR_NOT_FOUND:
default:
ret = BLADERF_ERR_UNEXPECTED;
}
return ret;
}
/* Returns libusb error codes */
static int get_devinfo(libusb_device *dev, struct bladerf_devinfo *info)
{
int status = 0;
libusb_device_handle *handle;
struct libusb_device_descriptor desc;
status = libusb_open(dev, &handle);
if( status ) {
log_debug("Couldn't populate devinfo - %s\n",
libusb_error_name(status));
} else {
/* Populate device info */
info->backend = BLADERF_BACKEND_LIBUSB;
info->usb_bus = libusb_get_bus_number(dev);
info->usb_addr = libusb_get_device_address(dev);
status = libusb_get_device_descriptor(dev, &desc);
if (status != 0) {
memset(info->serial, 0, BLADERF_SERIAL_LENGTH);
} else {
status = libusb_get_string_descriptor_ascii(
handle, desc.iSerialNumber,
(unsigned char *)&info->serial,
BLADERF_SERIAL_LENGTH);
/* Consider this to be non-fatal, otherwise firmware <= 1.1
* wouldn't be able to get far enough to upgrade */
if (status < 0) {
log_debug("Failed to retrieve serial number\n");
memset(info->serial, 0, BLADERF_SERIAL_LENGTH);
} else {
/* Adjust for > 0 return code */
status = 0;
}
}
libusb_close(handle);
}
return status;
}
static bool device_has_vid_pid(libusb_device *dev, uint16_t vid, uint16_t pid)
{
int status;
struct libusb_device_descriptor desc;
bool match = false;
status = libusb_get_device_descriptor(dev, &desc);
if (status != 0) {
log_debug("Couldn't get device descriptor: %s\n",
libusb_error_name(status));
} else {
match = (desc.idVendor == vid) && (desc.idProduct == pid);
}
return match;
}
static inline bool device_is_fx3_bootloader(libusb_device *dev)
{
return device_has_vid_pid(dev, USB_CYPRESS_VENDOR_ID, USB_FX3_PRODUCT_ID) ||
device_has_vid_pid(dev, USB_NUAND_VENDOR_ID,
USB_NUAND_BLADERF_BOOT_PRODUCT_ID);
}
static inline bool device_is_bladerf(libusb_device *dev)
{
struct libusb_config_descriptor *cfg;
int status;
bool ret;
if(!device_has_vid_pid(dev, USB_NUAND_VENDOR_ID,
USB_NUAND_BLADERF_PRODUCT_ID)) {
return false;
}
status = libusb_get_config_descriptor(dev, 0, &cfg);
if (status != 0) {
log_debug("Failed to get configuration descriptor: %s\n",
libusb_error_name(status));
return false;
}
/* As of firmware v0.4, we expect there to be 4 altsettings on the
* first interface. */
if (cfg->interface->num_altsetting != 4) {
const uint8_t bus = libusb_get_bus_number(dev);
const uint8_t addr = libusb_get_device_address(dev);
log_warning("A bladeRF running incompatible firmware appears to be "
"present on bus=%u, addr=%u. If this is true, a firmware "
"update via the device's bootloader is required.\n\n",
bus, addr);
ret = false;
} else {
ret = true;
}
libusb_free_config_descriptor(cfg);
return ret;
}
static int lusb_probe(struct bladerf_devinfo_list *info_list)
{
int status, i, n;
ssize_t count;
libusb_device **list;
struct bladerf_devinfo info;
libusb_context *context;
/* Initialize libusb for device tree walking */
status = libusb_init(&context);
if (status) {
log_error("Could not initialize libusb: %s\n",
libusb_error_name(status));
goto lusb_probe_done;
}
count = libusb_get_device_list(context, &list);
/* Iterate through all the USB devices */
for (i = 0, n = 0; i < count && status == 0; i++) {
if (device_is_bladerf(list[i])) {
log_verbose("Found bladeRF (based upon VID/PID)\n");
/* Open the USB device and get some information */
status = get_devinfo(list[i], &info);
if (status) {
log_error("Could not open bladeRF device: %s\n",
libusb_error_name(status) );
} else {
info.instance = n++;
status = bladerf_devinfo_list_add(info_list, &info);
if( status ) {
log_error("Could not add device to list: %s\n",
bladerf_strerror(status) );
} else {
log_verbose("Added instance %d to device list\n",
info.instance);
}
}
}
if (device_is_fx3_bootloader(list[i])) {
status = get_devinfo(list[i], &info);
if (status) {
log_error("Could not open bladeRF device: %s\n",
libusb_error_name(status) );
continue;
}
log_info("Found FX3 bootloader device on bus=%d addr=%d. This may "
"be a bladeRF.\nUse the bladeRF-cli command \"recover"
" %d %d <FX3 firmware>\" to boot the bladeRF firmware.\n",
info.usb_bus, info.usb_addr, info.usb_bus, info.usb_addr);
}
}
libusb_free_device_list(list, 1);
libusb_exit(context);
lusb_probe_done:
return status;
}
#ifdef HAVE_LIBUSB_GET_VERSION
static inline void get_libusb_version(char *buf, size_t buf_len)
{
const struct libusb_version *version;
version = libusb_get_version();
snprintf(buf, buf_len, "%d.%d.%d.%d%s", version->major, version->minor,
version->micro, version->nano, version->rc);
}
#else
static void get_libusb_version(char *buf, size_t buf_len)
{
snprintf(buf, buf_len, "<= 1.0.9");
}
#endif
static int lusb_open(void **driver,
struct bladerf_devinfo *info_in,
struct bladerf_devinfo *info_out)
{
int status, i, n;
int fx3_status;
ssize_t count;
struct bladerf_lusb *lusb = NULL;
libusb_device **list = NULL;
struct bladerf_devinfo thisinfo;
libusb_context *context;
/* Initialize libusb for device tree walking */
status = libusb_init(&context);
if (status) {
log_error("Could not initialize libusb: %s\n",
libusb_error_name(status));
status = error_conv(status);
goto error;
}
/* We can only print this out when log output is enabled, or else we'll
* get snagged by -Werror=unused-but-set-variable */
# ifdef LOGGING_ENABLED
{
char buf[64];
get_libusb_version(buf, sizeof(buf));
log_verbose("Using libusb version: %s\n", buf);
}
# endif
/* Iterate through all the USB devices */
count = libusb_get_device_list(context, &list);
for (i = 0, n = 0; i < count; i++) {
if (device_is_bladerf(list[i])) {
log_verbose("Found a bladeRF (based upon VID/PID)\n");
/* Open the USB device and get some information */
status = get_devinfo(list[i], &thisinfo);
if(status < 0) {
log_debug("Could not open bladeRF device: %s\n",
libusb_error_name(status) );
status = error_conv(status);
goto error;
}
thisinfo.instance = n++;
/* Check to see if this matches the info struct */
if (bladerf_devinfo_matches(&thisinfo, info_in)) {
lusb = (struct bladerf_lusb *)malloc(sizeof(struct bladerf_lusb));
if (lusb == NULL) {
log_debug("Skipping instance %d due to failed allocation\n",
thisinfo.instance);
lusb = NULL;
continue;
}
lusb->context = context;
lusb->dev = list[i];
status = libusb_open(list[i], &lusb->handle);
if (status < 0) {
status = error_conv(status);
goto error;
}
status = libusb_claim_interface(lusb->handle, 0);
if(status < 0) {
log_debug("Could not claim interface: %s\n",
libusb_error_name(status));
status = error_conv(status);
goto error;
}
memcpy(info_out, &thisinfo, sizeof(struct bladerf_devinfo));
*driver = lusb;
break;
} else {
log_verbose("Devinfo doesn't match - skipping"
"(instance=%d, serial=%d, bus/addr=%d\n",
bladerf_instance_matches(&thisinfo, info_in),
bladerf_serial_matches(&thisinfo, info_in),
bladerf_bus_addr_matches(&thisinfo, info_in));
}
}
if (device_is_fx3_bootloader(list[i])) {
fx3_status = get_devinfo(list[i], &thisinfo);
if (fx3_status != 0) {
log_debug("Could not open FX3 bootloader device: %s\n",
libusb_error_name(fx3_status));
continue;
}
log_info("Found FX3 bootloader device on bus=%d addr=%d. "
"This may be a bladeRF.\n",
thisinfo.usb_bus, thisinfo.usb_addr);
log_info("Use bladeRF-cli command \"recover %d %d "
"<FX3 firmware>\" to boot the bladeRF firmware.\n",
thisinfo.usb_bus, thisinfo.usb_addr);
}
}
error:
if (list) {
libusb_free_device_list(list, 1);
}
if (lusb == NULL) {
log_debug("No devices available on the libusb backend.\n");
status = BLADERF_ERR_NODEV;
}
if (status != 0) {
if (lusb != NULL) {
if (lusb->handle) {
libusb_close(lusb->handle);
}
free(lusb);
}
libusb_exit(context);
}
return status;
}
static int lusb_change_setting(void *driver, uint8_t setting)
{
struct bladerf_lusb *lusb = (struct bladerf_lusb *) driver;
int status = libusb_set_interface_alt_setting(lusb->handle, 0, setting);
return error_conv(status);
}
static void lusb_close(void *driver)
{
int status;
struct bladerf_lusb *lusb = (struct bladerf_lusb *) driver;
status = libusb_release_interface(lusb->handle, 0);
if (status < 0) {
log_error("Failed to release interface: %s\n",
libusb_error_name(status));
}
libusb_close(lusb->handle);
libusb_exit(lusb->context);
free(lusb);
}
static int lusb_get_speed(void *driver,
bladerf_dev_speed *device_speed)
{
int speed;
int status = 0;
struct bladerf_lusb *lusb = (struct bladerf_lusb *) driver;
speed = libusb_get_device_speed(lusb->dev);
if (speed == LIBUSB_SPEED_SUPER) {
*device_speed = BLADERF_DEVICE_SPEED_SUPER;
} else if (speed == LIBUSB_SPEED_HIGH) {
*device_speed = BLADERF_DEVICE_SPEED_HIGH;
} else {
*device_speed = BLADERF_DEVICE_SPEED_UNKNOWN;
if (speed == LIBUSB_SPEED_FULL) {
log_debug("Full speed connection is not suppored.\n");
status = BLADERF_ERR_UNSUPPORTED;
} else if (speed == LIBUSB_SPEED_LOW) {
log_debug("Low speed connection is not supported.\n");
status = BLADERF_ERR_UNSUPPORTED;
} else {
log_debug("Unknown/unexpected device speed (%d)\n", speed);
status = BLADERF_ERR_UNEXPECTED;
}
}
return status;
}
static inline uint8_t bm_request_type(usb_target target_type,
usb_request req_type,
usb_direction direction)
{
uint8_t ret = 0;
switch (target_type) {
case USB_TARGET_DEVICE:
ret |= LIBUSB_RECIPIENT_DEVICE;
break;
case USB_TARGET_INTERFACE:
ret |= LIBUSB_RECIPIENT_INTERFACE;
break;
case USB_TARGET_ENDPOINT:
ret |= LIBUSB_RECIPIENT_ENDPOINT;
break;
default:
ret |= LIBUSB_RECIPIENT_OTHER;
}
switch (req_type) {
case USB_REQUEST_STANDARD:
ret |= LIBUSB_REQUEST_TYPE_STANDARD;
break;
case USB_REQUEST_CLASS:
ret |= LIBUSB_REQUEST_TYPE_CLASS;
break;
case USB_REQUEST_VENDOR:
ret |= LIBUSB_REQUEST_TYPE_VENDOR;
break;
}
switch (direction) {
case USB_DIR_HOST_TO_DEVICE:
ret |= LIBUSB_ENDPOINT_OUT;
break;
case USB_DIR_DEVICE_TO_HOST:
ret |= LIBUSB_ENDPOINT_IN;
break;
}
return ret;
}
static int lusb_control_transfer(void *driver,
usb_target target_type, usb_request req_type,
usb_direction dir, uint8_t request,
uint16_t wvalue, uint16_t windex,
void *buffer, uint32_t buffer_len,
uint32_t timeout_ms)
{
int status;
struct bladerf_lusb *lusb = (struct bladerf_lusb *) driver;
const uint8_t bm_req_type = bm_request_type(target_type, req_type, dir);
status = libusb_control_transfer(lusb->handle,
bm_req_type, request,
wvalue, windex,
buffer, buffer_len,
timeout_ms);
if (status >= 0 && (uint32_t)status == buffer_len) {
status = 0;
} else {
log_debug("%s failed: status = %d\n", __FUNCTION__, status);
}
return error_conv(status);
}
static int lusb_bulk_transfer(void *driver, uint8_t endpoint, void *buffer,
uint32_t buffer_len, uint32_t timeout_ms)
{
int status;
int n_transferred;
struct bladerf_lusb *lusb = (struct bladerf_lusb *) driver;
status = libusb_bulk_transfer(lusb->handle, endpoint, buffer, buffer_len,
&n_transferred, timeout_ms);
status = error_conv(status);
if (status == 0 && ((uint32_t)n_transferred != buffer_len)) {
log_debug("Short bulk transfer: requeted=%u, transferred=%u\n",
buffer_len, n_transferred);
status = BLADERF_ERR_IO;
}
return status;
}
static int lusb_get_string_descriptor(void *driver, uint8_t index,
void *buffer, uint32_t buffer_len)
{
int status;
struct bladerf_lusb *lusb = (struct bladerf_lusb *) driver;
status = libusb_get_string_descriptor_ascii(lusb->handle, index,
(unsigned char*)buffer,
buffer_len);
if (status > 0 && (uint32_t)status < buffer_len) {
status = 0;
} else {
status = BLADERF_ERR_UNEXPECTED;
}
return status;
}
/* At the risk of being a little inefficient, just keep attempting to cancel
* everything. If a transfer's no longer active, we'll just get a NOT_FOUND
* error -- no big deal. Just accepting that alleviates the need to track
* the status of each transfer...
*/
static inline void cancel_all_transfers(struct bladerf_stream *stream)
{
size_t i;
int status;
struct lusb_stream_data *stream_data = stream->backend_data;
for (i = 0; i < stream_data->num_transfers; i++) {
if (stream_data->transfer_status[i] == TRANSFER_IN_FLIGHT) {
status = libusb_cancel_transfer(stream_data->transfers[i]);
if (status < 0 && status != LIBUSB_ERROR_NOT_FOUND) {
log_error("Error canceling transfer (%d): %s\r\n",
status, libusb_error_name(status));
} else {
stream_data->transfer_status[i] = TRANSFER_CANCEL_PENDING;
}
}
}
}
static inline size_t transfer_idx(struct lusb_stream_data *stream_data,
struct libusb_transfer *transfer)
{
size_t i;
for (i = 0; i < stream_data->num_transfers; i++) {
if (stream_data->transfers[i] == transfer) {
return i;
}
}
return UINT_MAX;
}
static int submit_transfer(struct bladerf_stream *stream, void *buffer);
static void LIBUSB_CALL lusb_stream_cb(struct libusb_transfer *transfer)
{
struct bladerf_stream *stream = transfer->user_data;
void *next_buffer = NULL;
struct bladerf_metadata metadata;
struct lusb_stream_data *stream_data = stream->backend_data;
size_t transfer_i;
/* Currently unused - zero out for out own debugging sanity... */
memset(&metadata, 0, sizeof(metadata));
MUTEX_LOCK(&stream->lock);
transfer_i = transfer_idx(stream_data, transfer);
assert(stream_data->transfer_status[transfer_i] == TRANSFER_IN_FLIGHT ||
stream_data->transfer_status[transfer_i] == TRANSFER_CANCEL_PENDING);
if (transfer_i >= stream_data->num_transfers) {
log_error("Unable to find transfer");
stream->state = STREAM_SHUTTING_DOWN;
} else {
stream_data->transfer_status[transfer_i] = TRANSFER_AVAIL;
stream_data->num_avail_transfers++;
pthread_cond_signal(&stream->can_submit_buffer);
}
/* Check to see if the transfer has been cancelled or errored */
if (transfer->status != LIBUSB_TRANSFER_COMPLETED) {
/* Errored out for some reason .. */
stream->state = STREAM_SHUTTING_DOWN;
switch(transfer->status) {
case LIBUSB_TRANSFER_CANCELLED:
/* We expect this case when we begin tearing down the stream */
break;
case LIBUSB_TRANSFER_STALL:
log_error("Hit stall for buffer %p\n", transfer->buffer);
stream->error_code = BLADERF_ERR_IO;
break;
case LIBUSB_TRANSFER_ERROR:
log_error("Got transfer error for buffer %p\n",
transfer->buffer);
stream->error_code = BLADERF_ERR_IO;
break;
case LIBUSB_TRANSFER_OVERFLOW :
log_error("Got transfer over for buffer %p, "
"transfer \"actual_length\" = %d\n",
transfer->buffer, transfer->actual_length);
stream->error_code = BLADERF_ERR_IO;
break;
case LIBUSB_TRANSFER_TIMED_OUT:
stream->error_code = BLADERF_ERR_TIMEOUT;
break;
case LIBUSB_TRANSFER_NO_DEVICE:
stream->error_code = BLADERF_ERR_NODEV;
break;
default:
log_error( "Unexpected transfer status: %d\n", transfer->status );
break;
}
}
if (stream->state == STREAM_RUNNING) {
/* Sanity check for debugging purposes */
if (transfer->length != transfer->actual_length) {
log_warning( "Received short transfer\n" );
/* For the SC16Q11 format, we're 4 bytes per samples... */
if ((transfer->actual_length & 3) != 0) {
log_warning( "Fractional samples received - stream likely corrupt\n" );
}
}
/* Call user callback requesting more data to transmit */
next_buffer = stream->cb(
stream->dev,
stream,
&metadata,
transfer->buffer,
bytes_to_sc16q11(transfer->actual_length),
stream->user_data);
if (next_buffer == BLADERF_STREAM_SHUTDOWN) {
stream->state = STREAM_SHUTTING_DOWN;
} else if (next_buffer != BLADERF_STREAM_NO_DATA) {
int status = submit_transfer(stream, next_buffer);
if (status != 0) {
/* If this fails, we probably have a serious problem...so just
* shut it down. */
stream->state = STREAM_SHUTTING_DOWN;
}
}
}
/* Check to see if all the transfers have been cancelled,
* and if so, clean up the stream */
if (stream->state == STREAM_SHUTTING_DOWN) {
/* We know we're done when all of our transfers have returned to their
* "available" states */
if (stream_data->num_avail_transfers == stream_data->num_transfers) {
stream->state = STREAM_DONE;
} else {
cancel_all_transfers(stream);
}
}
MUTEX_UNLOCK(&stream->lock);
}
/* Precondition: A transfer is available. */
static int submit_transfer(struct bladerf_stream *stream, void *buffer)
{
int status;
struct bladerf_lusb *lusb = lusb_backend(stream->dev);
struct lusb_stream_data *stream_data = stream->backend_data;
struct libusb_transfer *transfer;
size_t bytes_per_buffer;
const unsigned char ep =
stream->module == BLADERF_MODULE_TX ? SAMPLE_EP_OUT : SAMPLE_EP_IN;
assert(stream_data->transfer_status[stream_data->i] == TRANSFER_AVAIL);
transfer = stream_data->transfers[stream_data->i];
switch (stream->format) {
case BLADERF_FORMAT_SC16_Q11:
bytes_per_buffer = sc16q11_to_bytes(stream->samples_per_buffer);
break;
default:
assert(!"Unexpected format");
return BLADERF_ERR_INVAL;
}
assert(bytes_per_buffer <= INT_MAX);
libusb_fill_bulk_transfer(transfer,
lusb->handle,
ep,
buffer,
(int)bytes_per_buffer,
lusb_stream_cb,
stream,
stream->dev->transfer_timeout[stream->module]);
status = libusb_submit_transfer(transfer);
if (status == 0) {
stream_data->transfer_status[stream_data->i] = TRANSFER_IN_FLIGHT;
stream_data->i = (stream_data->i + 1) % stream_data->num_transfers;
assert(stream_data->num_avail_transfers != 0);
stream_data->num_avail_transfers--;
} else {
log_error("Failed to submit transfer in %s: %s\n",
__FUNCTION__, libusb_error_name(status));
}
return error_conv(status);
}
static int lusb_init_stream(void *driver, struct bladerf_stream *stream,
size_t num_transfers)
{
int status = 0;
size_t i;
struct lusb_stream_data *stream_data;
/* Fill in backend stream information */
stream_data = malloc(sizeof(struct lusb_stream_data));
if (!stream_data) {
return BLADERF_ERR_MEM;
}
/* Backend stream information */
stream->backend_data = stream_data;
stream_data->transfers = NULL;
stream_data->transfer_status = NULL;
stream_data->num_transfers = num_transfers;
stream_data->num_avail_transfers = 0;
stream_data->i = 0;
stream_data->transfers = malloc(num_transfers * sizeof(struct libusb_transfer *));
if (stream_data->transfers == NULL) {
log_error("Failed to allocate libusb tranfers\n");
status = BLADERF_ERR_MEM;
goto error;
}
stream_data->transfer_status = calloc(num_transfers, sizeof(transfer_status));
if (stream_data->transfer_status == NULL) {
log_error("Failed to allocated libusb transfer status array\n");
status = BLADERF_ERR_MEM;
goto error;
}
/* Create the libusb transfers */
for (i = 0; i < stream_data->num_transfers; i++) {
stream_data->transfers[i] = libusb_alloc_transfer(0);
/* Upon error, start tearing down anything we've started allocating
* and report that the stream is in a bad state */
if (stream_data->transfers[i] == NULL) {
/* Note: <= 0 not appropriate as we're dealing
* with an unsigned index */
while (i > 0) {
if (--i) {
libusb_free_transfer(stream_data->transfers[i]);
stream_data->transfers[i] = NULL;
stream_data->transfer_status[i] = TRANSFER_UNINITIALIZED;
stream_data->num_avail_transfers--;
}
}
status = BLADERF_ERR_MEM;
break;
} else {
stream_data->transfer_status[i] = TRANSFER_AVAIL;
stream_data->num_avail_transfers++;
}
}
error:
if (status != 0) {
free(stream_data->transfer_status);
free(stream_data->transfers);
free(stream_data);
stream->backend_data = NULL;
}
return status;
}
static int lusb_stream(void *driver, struct bladerf_stream *stream,
bladerf_module module)
{
size_t i;
int status = 0;
void *buffer;
struct bladerf_metadata metadata;
struct bladerf *dev = stream->dev;
struct bladerf_lusb *lusb = (struct bladerf_lusb *) driver;
struct lusb_stream_data *stream_data = stream->backend_data;
struct timeval tv = { 0, LIBUSB_HANDLE_EVENTS_TIMEOUT_NSEC };
/* Currently unused, so zero it out for a sanity check when debugging */
memset(&metadata, 0, sizeof(metadata));
MUTEX_LOCK(&stream->lock);
/* Set up initial set of buffers */
for (i = 0; i < stream_data->num_transfers; i++) {
if (module == BLADERF_MODULE_TX) {
buffer = stream->cb(dev,
stream,
&metadata,
NULL,
stream->samples_per_buffer,
stream->user_data);
if (buffer == BLADERF_STREAM_SHUTDOWN) {
/* If we have transfers in flight and the user prematurely
* cancels the stream, we'll start shutting down */
if (stream_data->num_avail_transfers != stream_data->num_transfers) {
stream->state = STREAM_SHUTTING_DOWN;
} else {
/* No transfers have been shipped out yet so we can
* simply enter our "done" state */
stream->state = STREAM_DONE;
}
/* In either of the above we don't want to attempt to
* get any more buffers from the user */
break;
}
} else {
buffer = stream->buffers[i];
}
if (buffer != BLADERF_STREAM_NO_DATA) {
status = submit_transfer(stream, buffer);
/* If we failed to submit any transfers, cancel everything in
* flight. We'll leave the stream in the running state so we can
* have libusb fire off callbacks with the cancelled status*/
if (status < 0) {
stream->error_code = status;
cancel_all_transfers(stream);
}
}
}
MUTEX_UNLOCK(&stream->lock);
/* This loop is required so libusb can do callbacks and whatnot */
while (stream->state != STREAM_DONE) {
status = libusb_handle_events_timeout(lusb->context, &tv);
if (status < 0 && status != LIBUSB_ERROR_INTERRUPTED) {
log_warning("unexpected value from events processing: "
"%d: %s\n", status, libusb_error_name(status));
status = error_conv(status);
}
}
return status;
}
/* The top-level code will have aquired the stream->lock for us */
int lusb_submit_stream_buffer(void *driver, struct bladerf_stream *stream,
void *buffer, unsigned int timeout_ms)
{
int status;
struct lusb_stream_data *stream_data = stream->backend_data;
struct timespec timeout_abs;
if (buffer == BLADERF_STREAM_SHUTDOWN) {
if (stream_data->num_avail_transfers == stream_data->num_transfers) {
stream->state = STREAM_DONE;
} else {
stream->state = STREAM_SHUTTING_DOWN;
}
return 0;
}
status = populate_abs_timeout(&timeout_abs, timeout_ms);
if (status != 0) {
return BLADERF_ERR_UNEXPECTED;
}
while (stream_data->num_avail_transfers == 0 && status == 0) {
status = pthread_cond_timedwait(&stream->can_submit_buffer,
&stream->lock,
&timeout_abs);
}
if (status == ETIMEDOUT) {
return BLADERF_ERR_TIMEOUT;
} else if (status != 0) {
return BLADERF_ERR_UNEXPECTED;
} else {
return submit_transfer(stream, buffer);
}
}
static int lusb_deinit_stream(void *driver, struct bladerf_stream *stream)
{
size_t i;