-
Notifications
You must be signed in to change notification settings - Fork 34
/
libusb.rb
1548 lines (1380 loc) · 54.5 KB
/
libusb.rb
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 Libusb for Ruby.
#
# Libusb for Ruby 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 3 of the License, or
# (at your option) any later version.
#
# Libusb for Ruby 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 Libusb for Ruby. If not, see <http://www.gnu.org/licenses/>.
require 'rubygems'
require 'ffi'
module LIBUSB
VERSION = "0.1.1"
module Call
extend FFI::Library
if RUBY_PLATFORM=~/mingw|mswin/i
bundled_dll = File.join(File.dirname(__FILE__), 'libusb-1.0.dll')
ffi_lib(['libusb-1.0', bundled_dll])
else
ffi_lib 'libusb-1.0'
end
ClassCodes = enum :libusb_class_code, [
:CLASS_PER_INTERFACE, 0,
:CLASS_AUDIO, 1,
:CLASS_COMM, 2,
:CLASS_HID, 3,
:CLASS_PRINTER, 7,
:CLASS_PTP, 6,
:CLASS_MASS_STORAGE, 8,
:CLASS_HUB, 9,
:CLASS_DATA, 10,
:CLASS_WIRELESS, 0xe0,
:CLASS_APPLICATION, 0xfe,
:CLASS_VENDOR_SPEC, 0xff
]
Errors = enum :libusb_error, [
:SUCCESS, 0,
:ERROR_IO, -1,
:ERROR_INVALID_PARAM, -2,
:ERROR_ACCESS, -3,
:ERROR_NO_DEVICE, -4,
:ERROR_NOT_FOUND, -5,
:ERROR_BUSY, -6,
:ERROR_TIMEOUT, -7,
:ERROR_OVERFLOW, -8,
:ERROR_PIPE, -9,
:ERROR_INTERRUPTED, -10,
:ERROR_NO_MEM, -11,
:ERROR_NOT_SUPPORTED, -12,
:ERROR_OTHER, -99,
]
# Transfer status codes
TransferStatus = enum :libusb_transfer_status, [
:TRANSFER_COMPLETED,
:TRANSFER_ERROR,
:TRANSFER_TIMED_OUT,
:TRANSFER_CANCELLED,
:TRANSFER_STALL,
:TRANSFER_NO_DEVICE,
:TRANSFER_OVERFLOW,
]
# libusb_transfer.flags values
TransferFlags = enum :libusb_transfer_flags, [
:TRANSFER_SHORT_NOT_OK, 1 << 0,
:TRANSFER_FREE_BUFFER, 1 << 1,
:TRANSFER_FREE_TRANSFER, 1 << 2,
]
TransferTypes = enum :libusb_transfer_type, [
:TRANSFER_TYPE_CONTROL, 0,
:TRANSFER_TYPE_ISOCHRONOUS, 1,
:TRANSFER_TYPE_BULK, 2,
:TRANSFER_TYPE_INTERRUPT, 3,
]
StandardRequests = enum :libusb_standard_request, [
:REQUEST_GET_STATUS, 0x00,
:REQUEST_CLEAR_FEATURE, 0x01,
:REQUEST_SET_FEATURE, 0x03,
:REQUEST_SET_ADDRESS, 0x05,
:REQUEST_GET_DESCRIPTOR, 0x06,
:REQUEST_SET_DESCRIPTOR, 0x07,
:REQUEST_GET_CONFIGURATION, 0x08,
:REQUEST_SET_CONFIGURATION, 0x09,
:REQUEST_GET_INTERFACE, 0x0A,
:REQUEST_SET_INTERFACE, 0x0B,
:REQUEST_SYNCH_FRAME, 0x0C,
]
EndpointDirections = enum :libusb_endpoint_direction, [
:ENDPOINT_IN, 0x80,
:ENDPOINT_OUT, 0x00,
]
DescriptorTypes = enum :libusb_descriptor_type, [
:DT_DEVICE, 0x01,
:DT_CONFIG, 0x02,
:DT_STRING, 0x03,
:DT_INTERFACE, 0x04,
:DT_ENDPOINT, 0x05,
:DT_HID, 0x21,
:DT_REPORT, 0x22,
:DT_PHYSICAL, 0x23,
:DT_HUB, 0x29,
]
RequestTypes = enum :libusb_request_type, [
:REQUEST_TYPE_STANDARD, (0x00 << 5),
:REQUEST_TYPE_CLASS, (0x01 << 5),
:REQUEST_TYPE_VENDOR, (0x02 << 5),
:REQUEST_TYPE_RESERVED, (0x03 << 5),
]
RequestRecipients = enum :libusb_request_recipient, [
:RECIPIENT_DEVICE, 0x00,
:RECIPIENT_INTERFACE, 0x01,
:RECIPIENT_ENDPOINT, 0x02,
:RECIPIENT_OTHER, 0x03,
]
IsoSyncTypes = enum :libusb_iso_sync_type, [
:ISO_SYNC_TYPE_NONE, 0,
:ISO_SYNC_TYPE_ASYNC, 1,
:ISO_SYNC_TYPE_ADAPTIVE, 2,
:ISO_SYNC_TYPE_SYNC, 3,
]
typedef :pointer, :libusb_context
typedef :pointer, :libusb_device_handle
attach_function 'libusb_init', [ :pointer ], :int
attach_function 'libusb_exit', [ :pointer ], :void
attach_function 'libusb_set_debug', [:pointer, :int], :void
attach_function 'libusb_get_device_list', [:pointer, :pointer], :size_t
attach_function 'libusb_free_device_list', [:pointer, :int], :void
attach_function 'libusb_ref_device', [:pointer], :pointer
attach_function 'libusb_unref_device', [:pointer], :void
attach_function 'libusb_get_device_descriptor', [:pointer, :pointer], :int
attach_function 'libusb_get_active_config_descriptor', [:pointer, :pointer], :int
attach_function 'libusb_get_config_descriptor', [:pointer, :uint8, :pointer], :int
attach_function 'libusb_get_config_descriptor_by_value', [:pointer, :uint8, :pointer], :int
attach_function 'libusb_free_config_descriptor', [:pointer], :void
attach_function 'libusb_get_bus_number', [:pointer], :uint8
attach_function 'libusb_get_device_address', [:pointer], :uint8
attach_function 'libusb_get_max_packet_size', [:pointer, :uint8], :int
attach_function 'libusb_get_max_iso_packet_size', [:pointer, :uint8], :int
attach_function 'libusb_open', [:pointer, :pointer], :int
attach_function 'libusb_close', [:pointer], :void
attach_function 'libusb_get_device', [:libusb_device_handle], :pointer
attach_function 'libusb_set_configuration', [:libusb_device_handle, :int], :int, :blocking=>true
attach_function 'libusb_claim_interface', [:libusb_device_handle, :int], :int
attach_function 'libusb_release_interface', [:libusb_device_handle, :int], :int, :blocking=>true
attach_function 'libusb_open_device_with_vid_pid', [:pointer, :int, :int], :pointer
attach_function 'libusb_set_interface_alt_setting', [:libusb_device_handle, :int, :int], :int, :blocking=>true
attach_function 'libusb_clear_halt', [:libusb_device_handle, :int], :int, :blocking=>true
attach_function 'libusb_reset_device', [:libusb_device_handle], :int, :blocking=>true
attach_function 'libusb_kernel_driver_active', [:libusb_device_handle, :int], :int
attach_function 'libusb_detach_kernel_driver', [:libusb_device_handle, :int], :int
attach_function 'libusb_attach_kernel_driver', [:libusb_device_handle, :int], :int
attach_function 'libusb_get_string_descriptor_ascii', [:pointer, :uint8, :pointer, :int], :int
attach_function 'libusb_alloc_transfer', [:int], :pointer
attach_function 'libusb_submit_transfer', [:pointer], :int
attach_function 'libusb_cancel_transfer', [:pointer], :int
attach_function 'libusb_free_transfer', [:pointer], :void
attach_function 'libusb_handle_events', [:libusb_context], :int, :blocking=>true
callback :libusb_transfer_cb_fn, [:pointer], :void
class IsoPacketDescriptor < FFI::Struct
layout :length, :uint,
:actual_length, :uint,
:status, :libusb_transfer_status
end
# Setup packet for control transfers.
class ControlSetup < FFI::Struct
layout :bmRequestType, :uint8,
:bRequest, :uint8,
:wValue, :uint16,
:wIndex, :uint16,
:wLength, :uint16
end
class Transfer < FFI::ManagedStruct
layout :dev_handle, :libusb_device_handle,
:flags, :uint8,
:endpoint, :uchar,
:type, :uchar,
:timeout, :uint,
:status, :libusb_transfer_status,
:length, :int,
:actual_length, :int,
:callback, :libusb_transfer_cb_fn,
:user_data, :pointer,
:buffer, :pointer,
:num_iso_packets, :int
def self.release(ptr)
Call.libusb_free_transfer(ptr)
end
end
end
Call::ClassCodes.to_h.each{|k,v| const_set(k,v) }
Call::TransferTypes.to_h.each{|k,v| const_set(k,v) }
Call::StandardRequests.to_h.each{|k,v| const_set(k,v) }
Call::RequestTypes.to_h.each{|k,v| const_set(k,v) }
Call::DescriptorTypes.to_h.each{|k,v| const_set(k,v) }
Call::EndpointDirections.to_h.each{|k,v| const_set(k,v) }
Call::RequestRecipients.to_h.each{|k,v| const_set(k,v) }
Call::IsoSyncTypes.to_h.each{|k,v| const_set(k,v) }
class Error < RuntimeError
end
ErrorClassForResult = {}
# define an exception class for each error code
Call::Errors.to_h.each do |k,v|
klass = Class.new(Error)
klass.send(:define_method, :code){ v }
const_set(k, klass)
ErrorClassForResult[v] = klass
end
def self.raise_error(res, text)
klass = ErrorClassForResult[res]
raise klass, "#{klass} #{text}"
end
CONTROL_SETUP_SIZE = 8
DT_DEVICE_SIZE = 18
DT_CONFIG_SIZE = 9
DT_INTERFACE_SIZE = 9
DT_ENDPOINT_SIZE = 7
DT_ENDPOINT_AUDIO_SIZE = 9 # Audio extension
DT_HUB_NONVAR_SIZE = 7
ENDPOINT_ADDRESS_MASK = 0x0f # in bEndpointAddress
ENDPOINT_DIR_MASK = 0x80
TRANSFER_TYPE_MASK = 0x03 # in bmAttributes
ISO_SYNC_TYPE_MASK = 0x0C
ISO_USAGE_TYPE_MASK = 0x30
# :stopdoc:
# http://www.usb.org/developers/defined_class
CLASS_CODES = [
[0x01, nil, nil, "Audio"],
[0x02, nil, nil, "Comm"],
[0x03, nil, nil, "HID"],
[0x05, nil, nil, "Physical"],
[0x06, 0x01, 0x01, "StillImaging"],
[0x06, nil, nil, "Image"],
[0x07, nil, nil, "Printer"],
[0x08, 0x01, nil, "MassStorage RBC Bluk-Only"],
[0x08, 0x02, 0x50, "MassStorage ATAPI Bluk-Only"],
[0x08, 0x03, 0x50, "MassStorage QIC-157 Bluk-Only"],
[0x08, 0x04, nil, "MassStorage UFI"],
[0x08, 0x05, 0x50, "MassStorage SFF-8070i Bluk-Only"],
[0x08, 0x06, 0x50, "MassStorage SCSI Bluk-Only"],
[0x08, nil, nil, "MassStorage"],
[0x09, 0x00, 0x00, "Full speed Hub"],
[0x09, 0x00, 0x01, "Hi-speed Hub with single TT"],
[0x09, 0x00, 0x02, "Hi-speed Hub with multiple TTs"],
[0x09, nil, nil, "Hub"],
[0x0a, nil, nil, "CDC"],
[0x0b, nil, nil, "SmartCard"],
[0x0d, 0x00, 0x00, "ContentSecurity"],
[0x0e, nil, nil, "Video"],
[0xdc, 0x01, 0x01, "Diagnostic USB2"],
[0xdc, nil, nil, "Diagnostic"],
[0xe0, 0x01, 0x01, "Bluetooth"],
[0xe0, 0x01, 0x02, "UWB"],
[0xe0, 0x01, 0x03, "RemoteNDIS"],
[0xe0, 0x02, 0x01, "Host Wire Adapter Control/Data"],
[0xe0, 0x02, 0x02, "Device Wire Adapter Control/Data"],
[0xe0, 0x02, 0x03, "Device Wire Adapter Isochronous"],
[0xe0, nil, nil, "Wireless Controller"],
[0xef, 0x01, 0x01, "Active Sync"],
[0xef, 0x01, 0x02, "Palm Sync"],
[0xef, 0x02, 0x01, "Interface Association Descriptor"],
[0xef, 0x02, 0x02, "Wire Adapter Multifunction Peripheral"],
[0xef, 0x03, 0x01, "Cable Based Association Framework"],
[0xef, nil, nil, "Miscellaneous"],
[0xfe, 0x01, 0x01, "Device Firmware Upgrade"],
[0xfe, 0x02, 0x00, "IRDA Bridge"],
[0xfe, 0x03, 0x00, "USB Test and Measurement"],
[0xfe, 0x03, 0x01, "USB Test and Measurement (USBTMC USB488)"],
[0xfe, nil, nil, "Application Specific"],
[0xff, nil, nil, "Vendor specific"],
]
CLASS_CODES_HASH1 = {}
CLASS_CODES_HASH2 = {}
CLASS_CODES_HASH3 = {}
CLASS_CODES.each {|base_class, sub_class, protocol, desc|
if protocol
CLASS_CODES_HASH3[[base_class, sub_class, protocol]] = desc
elsif sub_class
CLASS_CODES_HASH2[[base_class, sub_class]] = desc
else
CLASS_CODES_HASH1[base_class] = desc
end
}
def self.dev_string(base_class, sub_class, protocol)
if desc = CLASS_CODES_HASH3[[base_class, sub_class, protocol]]
desc
elsif desc = CLASS_CODES_HASH2[[base_class, sub_class]]
desc + " (%02x)" % [protocol]
elsif desc = CLASS_CODES_HASH1[base_class]
desc + " (%02x,%02x)" % [sub_class, protocol]
else
"Unkonwn(%02x,%02x,%02x)" % [base_class, sub_class, protocol]
end
end
# :startdoc:
# Abstract base class for USB transfers. Use
# {ControlTransfer}, {BulkTransfer}, {InterruptTransfer}, {IsochronousTransfer}
# to do transfers.
class Transfer
def initialize(args={})
args.each{|k,v| send("#{k}=", v) }
@buffer = nil
end
private :initialize
# Set the handle for the device to communicate with.
def dev_handle=(dev)
@dev_handle = dev
@transfer[:dev_handle] = @dev_handle.pHandle
end
# Timeout for this transfer in millseconds.
#
# A value of 0 indicates no timeout.
def timeout=(value)
@transfer[:timeout] = value
end
# Set the address of a valid endpoint to communicate with.
def endpoint=(endpoint)
endpoint = endpoint.bEndpointAddress if endpoint.respond_to? :bEndpointAddress
@transfer[:endpoint] = endpoint
end
# Set output data that should be sent.
def buffer=(data)
if !@buffer || data.bytesize>@buffer.size
free_buffer
@buffer = FFI::MemoryPointer.new(data.bytesize, 1, false)
end
@buffer.put_bytes(0, data)
@transfer[:buffer] = @buffer
@transfer[:length] = data.bytesize
end
# Retrieve the current data buffer.
def buffer
@transfer[:buffer].read_string(@transfer[:length])
end
# Clear the current data buffer.
def free_buffer
if @buffer
@buffer.free
@buffer = nil
@transfer[:buffer] = nil
@transfer[:length] = 0
end
end
# Allocate +len+ bytes of data buffer for input transfer.
#
# @param [Fixnum] len Number of bytes to allocate
# @param [String, nil] data some data to initialize the buffer with
def alloc_buffer(len, data=nil)
if !@buffer || len>@buffer.size
free_buffer
@buffer = FFI::MemoryPointer.new(len, 1, false)
end
@buffer.put_bytes(0, data) if data
@transfer[:buffer] = @buffer
@transfer[:length] = len
end
# The number of bytes actually transferred.
def actual_length
@transfer[:actual_length]
end
# Retrieve the data actually transferred.
#
# @param [Fixnum] offset optional offset of the retrieved data in the buffer.
def actual_buffer(offset=0)
@transfer[:buffer].get_bytes(offset, @transfer[:actual_length])
end
# Set the block that will be invoked when the transfer completes,
# fails, or is cancelled.
#
# @param [Proc] proc The block that should be called
def callback=(proc)
# Save proc to instance variable so that GC doesn't free
# the proc object before the transfer.
@callback_proc = proc do |pTrans|
proc.call(self)
end
@transfer[:callback] = @callback_proc
end
# The status of the transfer.
#
# Only for use within transfer callback function or after the callback was called.
#
# If this is an isochronous transfer, this field may read :TRANSFER_COMPLETED even if there
# were errors in the frames. Use the status field in each packet to determine if
# errors occurred.
def status
@transfer[:status]
end
# Submit a transfer.
#
# This function will fire off the USB transfer and then return immediately.
# This method can be called with block. It is called when the transfer completes,
# fails, or is cancelled.
def submit!(&block)
self.callback = block if block_given?
# puts "submit transfer #{@transfer.inspect} buffer: #{@transfer[:buffer].inspect} length: #{@transfer[:length].inspect} status: #{@transfer[:status].inspect} callback: #{@transfer[:callback].inspect} dev_handle: #{@transfer[:dev_handle].inspect}"
res = Call.libusb_submit_transfer( @transfer )
LIBUSB.raise_error res, "in libusb_submit_transfer" if res!=0
end
# Asynchronously cancel a previously submitted transfer.
#
# This function returns immediately, but this does not indicate cancellation is
# complete. Your callback function will be invoked at some later time with a
# transfer status of :TRANSFER_CANCELLED.
def cancel!
res = Call.libusb_cancel_transfer( @transfer )
LIBUSB.raise_error res, "in libusb_cancel_transfer" if res!=0
end
TransferStatusToError = {
:TRANSFER_ERROR => LIBUSB::ERROR_IO,
:TRANSFER_TIMED_OUT => LIBUSB::ERROR_TIMEOUT,
:TRANSFER_CANCELLED => LIBUSB::ERROR_INTERRUPTED,
:TRANSFER_STALL => LIBUSB::ERROR_PIPE,
:TRANSFER_NO_DEVICE => LIBUSB::ERROR_NO_DEVICE,
:TRANSFER_OVERFLOW => LIBUSB::ERROR_OVERFLOW,
}
# Submit the transfer and wait until the transfer completes or fails.
#
# A proper {LIBUSB::Error} is raised, in case the transfer did not complete.
def submit_and_wait!
completed = false
submit! do |tr2|
completed = true
end
until completed
begin
@dev_handle.device.context.handle_events
rescue ERROR_INTERRUPTED
next
rescue LIBUSB::Error
cancel!
until completed
@dev_handle.device.context.handle_events
end
raise
end
end
raise( TransferStatusToError[status] || ERROR_OTHER, "error #{status}") unless status==:TRANSFER_COMPLETED
end
end
class BulkTransfer < Transfer
def initialize(args={})
@transfer = Call::Transfer.new Call.libusb_alloc_transfer(0)
@transfer[:type] = TRANSFER_TYPE_BULK
@transfer[:timeout] = 1000
super
end
end
class ControlTransfer < Transfer
def initialize(args={})
@transfer = Call::Transfer.new Call.libusb_alloc_transfer(0)
@transfer[:type] = TRANSFER_TYPE_CONTROL
@transfer[:timeout] = 1000
super
end
end
class InterruptTransfer < Transfer
def initialize(args={})
@transfer = Call::Transfer.new Call.libusb_alloc_transfer(0)
@transfer[:type] = TRANSFER_TYPE_INTERRUPT
@transfer[:timeout] = 1000
super
end
end
class IsoPacket
def initialize(ptr, pkg_nr)
@packet = Call::IsoPacketDescriptor.new ptr
@pkg_nr = pkg_nr
end
def status
@packet[:status]
end
def length
@packet[:length]
end
def length=(len)
@packet[:length] = len
end
def actual_length
@packet[:actual_length]
end
end
class IsochronousTransfer < Transfer
def initialize(num_packets, args={})
@ptr = Call.libusb_alloc_transfer(num_packets)
@transfer = Call::Transfer.new @ptr
@transfer[:type] = TRANSFER_TYPE_ISOCHRONOUS
@transfer[:timeout] = 1000
@transfer[:num_iso_packets] = num_packets
super(args)
end
def num_packets
@transfer[:num_iso_packets]
end
def num_packets=(number)
@transfer[:num_iso_packets] = number
end
def [](nr)
IsoPacket.new( @ptr + Call::Transfer.size + nr*Call::IsoPacketDescriptor.size, nr)
end
# Convenience function to set the length of all packets in an
# isochronous transfer, based on {IsochronousTransfer#num_packets}.
def packet_lengths=(len)
ptr = @ptr + Call::Transfer.size
num_packets.times do
ptr.write_uint(len)
ptr += Call::IsoPacketDescriptor.size
end
end
# The actual_length field of the transfer is meaningless and should not
# be examined; instead you must refer to the actual_length field of
# each individual packet.
private :actual_length, :actual_buffer
end
class DeviceDescriptor < FFI::Struct
include Comparable
layout :bLength, :uint8,
:bDescriptorType, :uint8,
:bcdUSB, :uint16,
:bDeviceClass, :uint8,
:bDeviceSubClass, :uint8,
:bDeviceProtocol, :uint8,
:bMaxPacketSize0, :uint8,
:idVendor, :uint16,
:idProduct, :uint16,
:bcdDevice, :uint16,
:iManufacturer, :uint8,
:iProduct, :uint8,
:iSerialNumber, :uint8,
:bNumConfigurations, :uint8
end
class Configuration < FFI::ManagedStruct
include Comparable
layout :bLength, :uint8,
:bDescriptorType, :uint8,
:wTotalLength, :uint16,
:bNumInterfaces, :uint8,
:bConfigurationValue, :uint8,
:iConfiguration, :uint8,
:bmAttributes, :uint8,
:maxPower, :uint8,
:interface, :pointer,
:extra, :pointer,
:extra_length, :int
members.each do |member|
define_method(member) do
self[member]
end
end
def initialize(device, *args)
@device = device
super(*args)
end
def self.release(ptr)
Call.libusb_free_config_descriptor(ptr)
end
# @return [Device] the device this configuration belongs to.
attr_reader :device
def interfaces
ifs = []
self[:bNumInterfaces].times do |i|
ifs << Interface.new(self, self[:interface] + i*Interface.size)
end
return ifs
end
def inspect
attrs = []
attrs << self.bConfigurationValue.to_s
bits = self.bmAttributes
attrs << "SelfPowered" if (bits & 0b1000000) != 0
attrs << "RemoteWakeup" if (bits & 0b100000) != 0
desc = self.description
attrs << desc if desc != '?'
"\#<#{self.class} #{attrs.join(' ')}>"
end
# Return name of the configuration as String.
def description
return @description if defined? @description
@description = device.try_string_descriptor_ascii(self.iConfiguration)
end
# Return all interface decriptions of the configuration as Array of InterfaceDescriptor s.
def settings() self.interfaces.map {|d| d.settings }.flatten end
# Return all endpoints of all interfaces of the configuration as Array of EndpointDescriptor s.
def endpoints() self.settings.map {|d| d.endpoints }.flatten end
def <=>(o)
t = device<=>o.device
t = bConfigurationValue<=>o.bConfigurationValue if t==0
t
end
end
class Interface < FFI::Struct
include Comparable
layout :altsetting, :pointer,
:num_altsetting, :int
def initialize(configuration, *args)
@configuration = configuration
super(*args)
end
# @return [Configuration] the configuration this interface belongs to.
attr_reader :configuration
def alt_settings
ifs = []
self[:num_altsetting].times do |i|
ifs << Setting.new(self, self[:altsetting] + i*Setting.size)
end
return ifs
end
alias settings alt_settings
# The Device the Interface belongs to.
def device() self.configuration.device end
# Return all endpoints of all alternative settings as Array of EndpointDescriptor s.
def endpoints() self.alt_settings.map {|d| d.endpoints }.flatten end
def <=>(o)
configuration<=>o.configuration
end
end
class Setting < FFI::Struct
include Comparable
layout :bLength, :uint8,
:bDescriptorType, :uint8,
:bInterfaceNumber, :uint8,
:bAlternateSetting, :uint8,
:bNumEndpoints, :uint8,
:bInterfaceClass, :uint8,
:bInterfaceSubClass, :uint8,
:bInterfaceProtocol, :uint8,
:iInterface, :uint8,
:endpoint, :pointer,
:extra, :pointer,
:extra_length, :int
members.each do |member|
define_method(member) do
self[member]
end
end
def initialize(interface, *args)
@interface = interface
super(*args)
end
# @return [Interface] the interface this setting belongs to.
attr_reader :interface
def endpoints
ifs = []
self[:bNumEndpoints].times do |i|
ifs << Endpoint.new(self, self[:endpoint] + i*Endpoint.size)
end
return ifs
end
def inspect
attrs = []
attrs << self.bAlternateSetting.to_s
devclass = LIBUSB.dev_string(self.bInterfaceClass, self.bInterfaceSubClass, self.bInterfaceProtocol)
attrs << devclass
desc = self.description
attrs << desc if desc != '?'
"\#<#{self.class} #{attrs.join(' ')}>"
end
# Return name of the Interface as String.
def description
return @description if defined? @description
@description = device.try_string_descriptor_ascii(self.iInterface)
end
# The Device the InterfaceDescriptor belongs to.
def device() self.interface.configuration.device end
# The ConfigDescriptor the InterfaceDescriptor belongs to.
def configuration() self.interface.configuration end
def <=>(o)
t = interface<=>o.interface
t = bInterfaceNumber<=>o.bInterfaceNumber if t==0
t = bAlternateSetting<=>o.bAlternateSetting if t==0
t
end
end
class Endpoint < FFI::Struct
include Comparable
layout :bLength, :uint8,
:bDescriptorType, :uint8,
:bEndpointAddress, :uint8,
:bmAttributes, :uint8,
:wMaxPacketSize, :uint16,
:bInterval, :uint8,
:bRefresh, :uint8,
:bSynchAddress, :uint8,
:extra, :pointer,
:extra_length, :int
members.each do |member|
define_method(member) do
self[member]
end
end
def initialize(setting, *args)
@setting = setting
super(*args)
end
# @return [Setting] the setting this endpoint belongs to.
attr_reader :setting
def inspect
endpoint_address = self.bEndpointAddress
num = endpoint_address & 0b00001111
inout = (endpoint_address & 0b10000000) == 0 ? "OUT" : "IN "
bits = self.bmAttributes
transfer_type = %w[Control Isochronous Bulk Interrupt][0b11 & bits]
type = [transfer_type]
if transfer_type == 'Isochronous'
synchronization_type = %w[NoSynchronization Asynchronous Adaptive Synchronous][(0b1100 & bits) >> 2]
usage_type = %w[Data Feedback ImplicitFeedback ?][(0b110000 & bits) >> 4]
type << synchronization_type << usage_type
end
"\#<#{self.class} #{num} #{inout} #{type.join(" ")}>"
end
# The Device the EndpointDescriptor belongs to.
def device() self.setting.interface.configuration.device end
# The ConfigDescriptor the EndpointDescriptor belongs to.
def configuration() self.setting.interface.configuration end
# The Interface the EndpointDescriptor belongs to.
def interface() self.setting.interface end
def <=>(o)
t = setting<=>o.setting
t = bEndpointAddress<=>o.bEndpointAddress if t==0
t
end
end
# Class representing a libusb session.
class Context
# Initialize libusb context.
def initialize
m = FFI::MemoryPointer.new :pointer
Call.libusb_init(m)
@ctx = m.read_pointer
end
# Deinitialize libusb.
#
# Should be called after closing all open devices and before your application terminates.
def exit
Call.libusb_exit(@ctx)
end
# Set message verbosity.
#
# * Level 0: no messages ever printed by the library (default)
# * Level 1: error messages are printed to stderr
# * Level 2: warning and error messages are printed to stderr
# * Level 3: informational messages are printed to stdout, warning and
# error messages are printed to stderr
#
# The default level is 0, which means no messages are ever printed. If you
# choose to increase the message verbosity level, ensure that your
# application does not close the stdout/stderr file descriptors.
#
# You are advised to set level 3. libusb is conservative with its message
# logging and most of the time, will only log messages that explain error
# conditions and other oddities. This will help you debug your software.
#
# If the LIBUSB_DEBUG environment variable was set when libusb was
# initialized, this method does nothing: the message verbosity is
# fixed to the value in the environment variable.
#
# If libusb was compiled without any message logging, this method
# does nothing: you'll never get any messages.
#
# If libusb was compiled with verbose debug message logging, this
# method does nothing: you'll always get messages from all levels.
#
# @param [Fixnum] level debug level to set
def debug=(level)
Call.libusb_set_debug(@ctx, level)
end
def device_list
pppDevs = FFI::MemoryPointer.new :pointer
size = Call.libusb_get_device_list(@ctx, pppDevs)
ppDevs = pppDevs.read_pointer
pDevs = []
size.times do |devi|
pDev = ppDevs.get_pointer(devi*FFI.type_size(:pointer))
pDevs << Device.new(self, pDev)
end
Call.libusb_free_device_list(ppDevs, 1)
pDevs
end
private :device_list
# Handle any pending events in blocking mode.
#
# This method must be called when libusb is running asynchronous transfers.
# This gives libusb the opportunity to reap pending transfers,
# invoke callbacks, etc.
def handle_events
res = Call.libusb_handle_events(@ctx)
LIBUSB.raise_error res, "in libusb_handle_events" if res<0
end
# Obtain a list of devices currently attached to the USB system, optionally matching certain criteria.
#
# @param [Hash] filter_hash A number of criteria can be defined in key-value pairs.
# Only devices that equal all given criterions will be returned. If a criterion is
# not specified or its value is +nil+, any device will match that criterion.
# The following criteria can be filtered:
# * <tt>:idVendor</tt>, <tt>:idProduct</tt> (+FixNum+) for matching vendor/product ID,
# * <tt>:bClass</tt>, <tt>:bSubClass</tt>, <tt>:bProtocol</tt> (+FixNum+) for the device type -
# Devices using CLASS_PER_INTERFACE will match, if any of the interfaces match.
# * <tt>:bcdUSB</tt>, <tt>:bcdDevice</tt>, <tt>:bMaxPacketSize0</tt> (+FixNum+) for the
# USB and device release numbers.
# Criteria can also specified as Array of several alternative values.
#
# @example
# # Return all devices of vendor 0x0ab1 where idProduct is 3 or 4:
# context.device :idVendor=>0x0ab1, :idProduct=>[0x0003, 0x0004]
#
# @return [Array<LIBUSB::Device>]
def devices(filter_hash={})
device_list.select do |dev|
( !filter_hash[:bClass] || (dev.bDeviceClass==CLASS_PER_INTERFACE ?
dev.settings.map(&:bInterfaceClass).&([filter_hash[:bClass]].flatten).any? :
[filter_hash[:bClass]].flatten.include?(dev.bDeviceClass))) &&
( !filter_hash[:bSubClass] || (dev.bDeviceClass==CLASS_PER_INTERFACE ?
dev.settings.map(&:bInterfaceSubClass).&([filter_hash[:bSubClass]].flatten).any? :
[filter_hash[:bSubClass]].flatten.include?(dev.bDeviceSubClass))) &&
( !filter_hash[:bProtocol] || (dev.bDeviceClass==CLASS_PER_INTERFACE ?
dev.settings.map(&:bInterfaceProtocol).&([filter_hash[:bProtocol]].flatten).any? :
[filter_hash[:bProtocol]].flatten.include?(dev.bDeviceProtocol))) &&
( !filter_hash[:bMaxPacketSize0] || [filter_hash[:bMaxPacketSize0]].flatten.include?(dev.bMaxPacketSize0) ) &&
( !filter_hash[:idVendor] || [filter_hash[:idVendor]].flatten.include?(dev.idVendor) ) &&
( !filter_hash[:idProduct] || [filter_hash[:idProduct]].flatten.include?(dev.idProduct) ) &&
( !filter_hash[:bcdUSB] || [filter_hash[:bcdUSB]].flatten.include?(dev.bcdUSB) ) &&
( !filter_hash[:bcdDevice] || [filter_hash[:bcdDevice]].flatten.include?(dev.bcdDevice) )
end
end
end
# Class representing a USB device detected on the system.
#
# Devices of the system can be obtained with {Context#devices} .
class Device
include Comparable
# @return [Context] the context this device belongs to.
attr_reader :context
def initialize context, pDev
@context = context
def pDev.unref_device(id)
Call.libusb_unref_device(self)
end
ObjectSpace.define_finalizer(self, pDev.method(:unref_device))
Call.libusb_ref_device(pDev)
@pDev = pDev
@pDevDesc = DeviceDescriptor.new
res = Call.libusb_get_device_descriptor(@pDev, @pDevDesc)
LIBUSB.raise_error res, "in libusb_get_device_descriptor" if res!=0
end
# Open the device and obtain a device handle.
#
# A handle allows you to perform I/O on the device in question.
# This is a non-blocking function; no requests are sent over the bus.
#
# If called with a block, the handle is passed to the block
# and is closed when the block has finished.
#
# You need proper access permissions on:
# * Linux: <tt>/dev/bus/usb/<bus>/<dev></tt>
#
# @return [DevHandle] Handle to the device.
def open
ppHandle = FFI::MemoryPointer.new :pointer
res = Call.libusb_open(@pDev, ppHandle)
LIBUSB.raise_error res, "in libusb_open" if res!=0
handle = DevHandle.new self, ppHandle.read_pointer
return handle unless block_given?
begin
yield handle
ensure
handle.close
end
end
# Open the device and claim an interface.
#