forked from JohnDMcMaster/usbrply
-
Notifications
You must be signed in to change notification settings - Fork 0
/
main.py
executable file
·1008 lines (840 loc) · 33.6 KB
/
main.py
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
#!/usr/bin/env python
'''
uvusbreplay-py 01_prog2.cap
sudo pip install pycap
'''
import pcap
import argparse
import sys
import binascii
import struct
from collections import namedtuple
import json
# Linux kernel
OUTPUT_LINUX = 'LINUX'
# libusb
OUTPUT_LIBUSB = 'LIBUSB'
OUTPUT_LIBUSBPY = 'LIBUSBPY'
# output_target_t
#args.ofmt = 'OUTPUT_LINUX'
g_min_packet = 0
g_max_packet = float('inf')
g_error = False
g_halt_error = True
g_allow_short = False
g_custom_call = False
g_use_defines = False
g_packet_numbers = True
VERSION_STR = "0.1"
indent = ""
'''
pcap/usb.h compat
'''
'''
possible transfer mode
'''
URB_TRANSFER_IN = 0x80
URB_ISOCHRONOUS = 0x0
URB_INTERRUPT = 0x1
URB_CONTROL = 0x2
URB_BULK = 0x3
'''
possible event type
'''
URB_SUBMIT = ord('S')
URB_COMPLETE = ord('C')
URB_ERROR = ord('E')
'''
JSON format:
{
'packets':[
{
'urb_id':"2312...",
'dev': 20,
'urb_bus_id': 2,
urb_trans_type: 'URB_CONTROL',
endp_dir: 'OUT',
endp: 0,
//Submit and complete keys
'S':{
//Unprocessed USB bytes: host to device (h2d) and device to host (d2h)
"raw":"12FAB...",
'urb_type': 'URB_SUBMIT',
urb_sec: 123,
urb_usec: 456,
urb_stat: -EINPROGRESS,
urb_len: 0
data_len: 0
urb_setup{
bmRequestType: 0x40
bRequest: 176,
wValue: 0x0018,
wIndex: 0
wLength: 0
}
data: "123456AF..."
}
'C':{
"raw":"12421FBCA13..."
...
}
}
]
}
'''
def dbg(s):
if args.verbose:
print s
def comment(s):
if args.ofmt == 'LIBUSBPY':
print '%s# %s' % (indent, s)
elif args.ofmt == 'JSON':
i = 1
while True:
k = '!%d' % i
if not k in jact:
jact[k] = s
return
i += 1
else:
print '%s//%s' % (indent, s)
# When we get an IN request we may process packets in between
class PendingRX:
def __init__(self):
# Unprocessed packet bytes
self.raw = None
#usb_urb_t m_urb
self.m_urb = None
#usb_ctrlrequest m_ctrl
# Only applies to control requests
self.m_ctrl = None
self.packet_number = 0
# uint8_t *m_data_out
self.m_data_out = None
# Pending requests
# Typically size 0-1 but sometimes more pile up
g_pending = {}
def keep_packet( _in ):
# grr forgot I had this on
# return (in.m_urb.transfer_type & URB_CONTROL) and (in.m_ctrl.bRequestType & URB_TRANSFER_IN)
return True
class payload_bytes_type_t:
def __init__(self):
self.req_in = 0
self.req_in_last = None
self.in_ = 0
self.in_last = None
self.req_out = 0
self.req_out_last = None
self.out = 0
self.out_last = None
class payload_bytes_t:
def __init__(self):
self.ctrl = payload_bytes_type_t()
self.bulk = payload_bytes_type_t()
g_payload_bytes = payload_bytes_t()
def update_delta( pb ):
pb.req_in_last = pb.req_in
pb.in_last = pb.in_
pb.req_out_last = pb.req_out
pb.out_last = pb.out
'''
struct usb_ctrlrequest {
__u8 bRequestType;
__u8 bRequest;
__le16 wValue;
__le16 wIndex;
__le16 wLength;
} __attribute__ ((packed));
'''
usb_ctrlrequest_nt = namedtuple('usb_ctrlrequest', ('bRequestType',
'bRequest',
'wValue',
'wIndex',
'wLength',
# FIXME: what exactly are these?
'res'))
usb_ctrlrequest_fmt = '<BBHHHH'
usb_ctrlrequest_sz = struct.calcsize(usb_ctrlrequest_fmt)
def usb_ctrlrequest(s):
return usb_ctrlrequest_nt(*struct.unpack(usb_ctrlrequest_fmt, str(s)))
'''
//TODO; figure out what this actually is
typedef struct {
uint8_t raw[24];
} __attribute__((packed)) control_rx_t;
'''
control_rx_sz = 3
def control_rx(s):
return s
def printControlRequest(submit, data_str, data_size, pipe_str):
'''
unsigned int dev_control_message(int requesttype, int request,
int value, int index, char *bytes, int size):
WARNING: request / request type parameters are swapped between kernel and libusb
request type is clearly listed first in USB spec and seems more logically first so I'm going to blame kernel on this
although maybe libusb came after and was trying for multi OS comatibility right off the bat
Anyway, use dev_control_message for finer grained (eg macro) support
libusb
int usb_control_msg(usb_dev_handle *dev, int requesttype, int request, int value, int index, char *bytes, int size, int timeout)
kernel
extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
__u8 request, __u8 requesttype, __u16 value, __u16 index,
def *data, __u16 size, int timeout)
Example output:
n_rw = dev_ctrl_msg(0x0B, URB_TRANSFER_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE, 0xAD16, 0xAD15, buff, 1, 500)
def controlWrite(self, request_type, request, value, index, data, timeout=0):
def controlRead(self, request_type, request, value, index, length, timeout=0):
self.dev.controlWrite(0x40, 0x00, 0x0001, 0x0001, '')
'''
if args.ofmt == OUTPUT_LIBUSBPY:
#std::string bRequestStr = get_request_str( submit.m_ctrl.bRequestType, submit.m_ctrl.bRequest )
#std::string bRequestTypeStr = get_request_type_str(submit.m_ctrl.bRequestType)
if (submit.m_ctrl.bRequestType & URB_TRANSFER_IN):
print "%sbuff = dev.controlRead(0x%02X, 0x%02X, 0x%04X, 0x%04X, %u)" % (indent, submit.m_ctrl.bRequestType, submit.m_ctrl.bRequest,
submit.m_ctrl.wValue, submit.m_ctrl.wIndex, data_size)
else:
print "%sdev.controlWrite(0x%02X, 0x%02X, 0x%04X, 0x%04X, %s)" % (indent, submit.m_ctrl.bRequestType, submit.m_ctrl.bRequest,
submit.m_ctrl.wValue, submit.m_ctrl.wIndex, data_str)
elif args.ofmt == 'JSON':
# FIXME
pass
else:
timeout = ''
out = ''
out += "n_rw = "
if (g_custom_call):
out += "dev_ctrl_msg("
else:
device_str = "g_dev"
out += "usb_control_msg(%s, ", device_str
if args.ofmt == OUTPUT_LINUX:
out += "%s", pipe_str
bRequestStr = request_type2str[ self.submit.m_ctrl.bRequestType, self.submit.m_ctrl.bRequest ]
bRequestTypeStr = ""
if args.ofmt == OUTPUT_LIBUSB and not g_use_defines:
bRequestTypeStr = "0x%02X" % self.submit.m_ctrl.bRequestType
else:
bRequestTypeStr = request_type2str[self.submit.m_ctrl.bRequestType]
if args.ofmt == OUTPUT_LIBUSB:
out += "%s, %s, " % (bRequestTypeStr, bRequestStr)
else:
out += "%s, %s, " % (bRequestStr, bRequestTypeStr)
if (g_custom_call):
timeout = ""
else:
timeout = ", 500"
out += "0x%04X, 0x%04X, %s, %u%s);" % (
submit.m_ctrl.wValue, submit.m_ctrl.wIndex,
data_str, data_size,
timeout )
print out
def bytes2AnonArray(bytes, byte_type = "uint8_t"):
if args.ofmt == OUTPUT_LIBUSBPY:
byte_str = "\""
for i in xrange(len(bytes)):
if i and i % 16 == 0:
byte_str += '\"\n \"'
byte_str += "\\x%02X" % (ord(bytes[i]),)
return byte_str + "\""
else:
byte_str = "(%s[]){" % (byte_type,)
pad = ""
bytes = bytearray(bytes)
for i in xrange(len(bytes)):
if i % 16 == 0:
pad = ""
if i != 0:
byte_str += ",\n "
byte_str += pad
byte_str += "0x%02X" % bytes[i]
pad = ", "
return byte_str + "}"
def deviceStr():
# return "dev.udev"
return "udev"
urb_type2str = {
URB_SUBMIT: 'URB_SUBMIT',
URB_COMPLETE: 'URB_COMPLETE',
URB_ERROR: 'URB_ERROR',
}
transfer2str = {
URB_ISOCHRONOUS: "URB_ISOCHRONOUS",
URB_INTERRUPT: "URB_INTERRUPT",
URB_CONTROL: "URB_CONTROL",
URB_BULK: "URB_BULK",
}
USB_REQ_GET_STATUS = 0x00
USB_REQ_CLEAR_FEATURE = 0x01
# 0x02 is reserved
USB_REQ_SET_FEATURE = 0x03
# 0x04 is reserved
USB_REQ_SET_ADDRESS = 0x05
USB_REQ_GET_DESCRIPTOR = 0x06
USB_REQ_SET_DESCRIPTOR = 0x07
USB_REQ_GET_CONFIGURATION = 0x08
USB_REQ_SET_CONFIGURATION = 0x09
USB_REQ_GET_INTERFACE = 0x0A
USB_REQ_SET_INTERFACE = 0x0B
USB_REQ_SYNCH_FRAME = 0x0C
USB_DIR_OUT = 0 # to device
USB_DIR_IN = 0x80 # to host
USB_TYPE_MASK = (0x03 << 5)
USB_TYPE_STANDARD = (0x00 << 5)
USB_TYPE_CLASS = (0x01 << 5)
USB_TYPE_VENDOR = (0x02 << 5)
USB_TYPE_RESERVED = (0x03 << 5)
USB_RECIP_MASK = 0x1f
USB_RECIP_DEVICE = 0x00
USB_RECIP_INTERFACE = 0x01
USB_RECIP_ENDPOINT = 0x02
USB_RECIP_OTHER = 0x03
# From Wireless USB 1.0
USB_RECIP_PORT = 0x04
USB_RECIP_RPIPE = 0x05
def request2str(bRequestType, bRequest):
bRequestType = bRequestType & USB_TYPE_MASK
m = {
USB_TYPE_STANDARD: {
USB_REQ_GET_STATUS: "USB_REQ_GET_STATUS",
USB_REQ_CLEAR_FEATURE: "USB_REQ_CLEAR_FEATURE",
USB_REQ_SET_FEATURE: "USB_REQ_SET_FEATURE",
USB_REQ_SET_ADDRESS: "USB_REQ_SET_ADDRESS",
USB_REQ_GET_DESCRIPTOR: "USB_REQ_GET_DESCRIPTOR",
USB_REQ_SET_DESCRIPTOR: "USB_REQ_SET_DESCRIPTOR",
USB_REQ_GET_CONFIGURATION: "USB_REQ_GET_CONFIGURATION",
USB_REQ_SET_CONFIGURATION: "USB_REQ_SET_CONFIGURATION",
USB_REQ_GET_INTERFACE: "USB_REQ_GET_INTERFACE",
USB_REQ_SET_INTERFACE: "USB_REQ_SET_INTERFACE",
USB_REQ_SYNCH_FRAME: "USB_REQ_SYNCH_FRAME",
}
}
n = m.get(bRequestType, None)
if n is None:
return "0x%02X" % bRequest
return n[bRequest]
def request_type2str(bRequestType):
ret = "";
if (bRequestType & USB_DIR_IN) == USB_DIR_IN:
ret += "USB_DIR_IN"
else:
ret += "USB_DIR_OUT"
m = {
USB_TYPE_STANDARD: " | USB_TYPE_STANDARD" ,
USB_TYPE_CLASS: " | USB_TYPE_CLASS" ,
USB_TYPE_VENDOR: " | USB_TYPE_VENDOR",
USB_TYPE_RESERVED: " | USB_TYPE_RESERVED",
}
ret += m[bRequestType & USB_TYPE_MASK]
m = {
USB_RECIP_DEVICE: " | USB_RECIP_DEVICE",
USB_RECIP_INTERFACE: " | USB_RECIP_INTERFACE",
USB_RECIP_ENDPOINT: " | USB_RECIP_ENDPOINT",
USB_RECIP_OTHER: " | USB_RECIP_OTHER",
USB_RECIP_PORT: " | USB_RECIP_PORT",
USB_RECIP_RPIPE: " | USB_RECIP_RPIPE",
}
ret += m[bRequestType & USB_RECIP_MASK]
return ret;
def print_urb(urb):
print "URB id: 0x%016lX" % (urb.id)
print " type: %s (%c / 0x%02X)" % (urb_type2str[urb.type], urb.type, urb.type)
#print " dir: %s" % ('IN' if urb.type & URB_TRANSFER_IN else 'OUT',)
print " transfer_type: %s (0x%02X)" % (transfer2str[urb.transfer_type], urb.transfer_type )
print " endpoint: 0x%02X" % (urb.endpoint)
print " device: 0x%02X" % (urb.device)
print " bus_id: 0x%04X" % (urb.bus_id)
print " setup_request: 0x%02X" % (urb.setup_request)
print " data: 0x%02X" % (urb.data)
#print " sec: 0x%016llX" % (urb.sec)
print " usec: 0x%08X" % (urb.usec)
print " status: 0x%08X" % (urb.status)
print " length: 0x%08X" % (urb.length)
print " data_length: 0x%08X" % (urb.data_length)
def UVDHexdumpCore(*args):
comment('hexdump broken')
class Gen:
def __init__(self):
self.g_cur_packet = 0
'''
Seems to give unexpected input vs the C API
a1=64,
a2=407b162b0288ffff530280020200003cec54025300000000e91003008dffffff2800000000000000800600010000280000000000000000000002000000000000,
a3=1392661740.2
although I could unpack the data, def not how this was intended to be used and will be a lot more work. Gah!
maybe simple C program should dump to JSON instead and leave heavy lifting to python
'''
def loop_cb(self, caplen, packet, ts):
self.g_cur_packet += 1
if self.g_cur_packet < g_min_packet or self.g_cur_packet > g_max_packet:
# print "# Skipping packet %d" % (self.g_cur_packet)
return
if args.verbose:
print
print
print
print 'PACKET %s' % (self.g_cur_packet,)
'''
struct pcap_pkthdr {
struct timeval ts; /* time stamp */
bpf_u_int32 caplen; /* length of portion present */
bpf_u_int32 len; /* length this packet (off wire) */
}
'''
'''
pcap_pkthdr_nt = namedtuple('pcap_pkthdr', ('ts', 'caplen', 'len'))
def pcap_pkthdr(s):
return pcap_pkthdr_nt(*struct.unpack('<III', s))
header = pcap_pkthdr(header)
'''
if caplen != len(packet):
print "packet %d: malformed, caplen %d != len %d", self.g_cur_packet, caplen, len(packet)
g_error = True
return
if args.verbose:
print 'Len: %d' % len(packet)
dbg("Length %u" % (len(packet),))
if 0:
print "PACKET %u: length %u" % (self.g_cur_packet, len(packet))
UVDHexdumpCore(packet, " ")
'''
typedef struct {
uint64_t id
uint8_t type
uint8_t transfer_type
uint8_t endpoint
uint8_t device
uint16_t bus_id
uint8_t setup_request
uint8_t data
uint64_t sec
uint32_t usec
uint32_t status
uint32_t length
uint32_t data_length
//These form the URB setup for control transfers and are techincally part of the URB
//uint8_t pad[24]
} __attribute__((packed)) usb_urb_t
'''
usb_urb_nt = namedtuple('usb_urb', ('id',
'type',
'transfer_type',
'endpoint',
'device',
'bus_id',
'setup_request',
'data',
'sec',
'usec',
'status',
# Control: requested data length
# Complete: identical to data_length?
'length',
# How much data is attached to this message
'data_length',
# Main use is URB setup for control requests, not sure if thats universal?
# TODO: check how these are used in bulk requests
# If it is the same, they should be merged into this structure
'ctrlrequest',))
usb_urb_fmt = '<QBBBBHBBQIIII24s'
usb_urb_sz = struct.calcsize(usb_urb_fmt)
def usb_urb(s):
return usb_urb_nt(*struct.unpack(usb_urb_fmt, str(s)))
# caplen is actual length, len is reported
self.urb_raw = packet
self.urb = usb_urb(packet[0:usb_urb_sz])
dat_cur = packet[usb_urb_sz:]
if args.verbose:
print "Header size: %lu" % (usb_urb_sz,)
print_urb(urb)
if 0:
print "URB" % (self.g_cur_packet)
UVDHexdumpCore(urb, " ")
if self.urb.type == URB_ERROR:
print "oh noes!"
if (g_halt_error):
sys.exit(1)
if self.urb.type == URB_COMPLETE:
if args.verbose:
print 'Pending (%d):' % (len(g_pending),)
for k in g_pending:
print ' %s' % (k,)
if not self.urb.id in g_pending:
raise Exception("Packet %d missing control submit. URB ID: 0x%016lX" % (self.g_cur_packet, self.urb.id))
self.submit = g_pending[self.urb.id]
# Done with it, get rid of it
del g_pending[self.urb.id]
if not keep_packet(self.submit):
return
if args.ofmt == 'JSON':
self.json_complete()
# Find the matching submit request
if self.urb.transfer_type == URB_CONTROL:
{URB_SUBMIT: self.processControlSubmit, URB_COMPLETE: self.processControlComplete}[self.urb.type](dat_cur)
elif self.urb.transfer_type == URB_BULK:
{URB_SUBMIT: self.processBulkSubmit, URB_COMPLETE: self.processBulkComplete}[self.urb.type](dat_cur)
if self.urb.type == URB_COMPLETE and args.ofmt == 'JSON':
jact['packnum'] = self.submit.packet_number
self.submit = None
self.urb = None
def json_complete(self):
global jact
# Active JSON node
jact = {'urb_id':self.urb.id,
'dev': self.urb.device,
'urb_bus_id': self.urb.bus_id,
'urb_trans_type': transfer2str[self.urb.transfer_type].replace('URB_', ''),
#'endp_dir': bool(self.urb.m_ctrl.bRequestType & URB_TRANSFER_IN),
'endp': self.urb.endpoint,
}
jroot['packets'].append(jact)
def processControlSubmit(self, dat_cur):
pending = PendingRX()
pending.raw = self.urb_raw
pending.m_urb = self.urb
if args.verbose:
print 'Remaining data: %d' % (len(dat_cur))
print 'ctrlrequest: %d' % (len(urb.ctrlrequest))
ctrl = usb_ctrlrequest(self.urb.ctrlrequest[0:usb_ctrlrequest_sz])
if args.verbose:
print "Packet %d control submit (control info size %lu)" % (self.g_cur_packet, 666)
print " bRequestType: %s (0x%02X)" % (request_type2str(ctrl.bRequestType), ctrl.bRequestType)
print " bRequest: %s (0x%02X)" % (request2str(ctrl.bRequestType, ctrl.bRequest ), ctrl.bRequest)
print " wValue: 0x%04X" % (ctrl.wValue)
print " wIndex: 0x%04X" % (ctrl.wIndex)
print " wLength: 0x%04X" % (ctrl.wLength)
if (ctrl.bRequestType & URB_TRANSFER_IN) == URB_TRANSFER_IN:
dbg("%d: IN" % (self.g_cur_packet))
else:
dbg("%d: OUT" % (self.g_cur_packet))
if (len(dat_cur) != self.urb.data_length):
comment("WARNING: remaining bytes %d != expected payload out bytes %d" % (len(dat_cur), self.urb.data_length))
UVDHexdumpCore(dat_cur, " ")
#raise Exception('See above')
pending.m_data_out = str(dat_cur)
pending.m_ctrl = ctrl
pending.packet_number = self.g_cur_packet
if args.verbose:
print 'Added pending control URB %s' % self.urb.id
g_pending[self.urb.id] = pending
def processControlCompleteIn(self, dat_cur):
packet_numbering = ''
data_size = 0
data_str = "None"
max_payload_sz = self.submit.m_ctrl.wLength
# Is it legal to have a 0 length control in?
if (self.submit.m_ctrl.wLength):
data_str = "buff"
data_size = self.submit.m_ctrl.wLength
elif args.ofmt == OUTPUT_LIBUSBPY:
data_str = "\"\""
printControlRequest(self.submit, data_str, data_size, "usb_rcvctrlpipe(%s, 0), " % (deviceStr(),) )
# Verify we actually have enough / expected
# If exact match don't care
if (len(dat_cur) != max_payload_sz):
if len(dat_cur) < max_payload_sz:
comment("NOTE:: req max %u but got %u" % (max_payload_sz, len(dat_cur)))
else:
raise Exception('invalid response')
if (self.submit.m_ctrl.wLength):
if g_packet_numbers:
packet_numbering = "packet %u/%u" % (self.submit.packet_number, self.g_cur_packet)
else:
# TODO: consider counting instead of by captured index
packet_numbering = "packet"
if args.ofmt == OUTPUT_LIBUSBPY:
print "%svalidate_read(%s, buff, \"%s\")" % (indent, bytes2AnonArray(dat_cur, "char"), packet_numbering )
elif args.ofmt in ('LINUX', 'LIBUSB'):
print "%svalidate_read(%s, %u, buff, n_rw, \"%s\");" % (indent, bytes2AnonArray(dat_cur, "char"), packet_numbering )
elif args.ofmt == 'JSON':
pass
def processControlCompleteOut(self, dat_cur):
data_size = 0
data_str = "None"
#print 'Control out w/ len %d' % len(submit.m_data_out)
# print "Data out size: %u vs urb size %u" % (submit.m_data_out_size, submit.m_urb.data_length )
if (len(self.submit.m_data_out)):
# Note that its the submit from earlier, not the ack that we care about
data_str = bytes2AnonArray(self.submit.m_data_out)
data_size = len(self.submit.m_data_out)
elif args.ofmt == OUTPUT_LIBUSBPY:
data_str = "\"\""
printControlRequest(self.submit, data_str, data_size, "usb_sndctrlpipe(%s, 0), " % (deviceStr()) )
def processControlComplete(self, dat_cur):
# self.print_stat()
if args.ofmt in ('LINUX', 'LIBUSB'):
print
if g_packet_numbers:
self.packnum()
if (self.submit.m_ctrl.bRequestType & URB_TRANSFER_IN):
self.processControlCompleteIn(dat_cur)
else:
self.processControlCompleteOut(dat_cur)
def print_stat(self):
bulk = g_payload_bytes.bulk
# payload_bytes_type_t *ctrl = &g_payload_bytes.ctrl
print "Transer statistics"
print " Bulk"
print " In: %u (delta %u), req: %u (delta %u)" % (
bulk.in_, bulk.in_ - bulk.in_last,
bulk.req_in, bulk.req_in - bulk.req_in_last
)
update_delta( bulk )
print " Out: %u, req: %u" % (g_payload_bytes.bulk.out, g_payload_bytes.bulk.req_out)
print " Control"
print " In: %u, req: %u" % (g_payload_bytes.ctrl.in_, g_payload_bytes.ctrl.req_in)
print " Out: %u, req: %u" % (g_payload_bytes.ctrl.out, g_payload_bytes.ctrl.req_out)
def packnum(self):
if args.ofmt == OUTPUT_LIBUSBPY:
print "%s# Generated from packet %u/%u" % (indent, self.submit.packet_number, self.g_cur_packet)
elif args.ofmt in ('LINUX', 'LIBUSB'):
print "%s//Generated from packet %u/%u" % (indent, self.submit.packet_number, self.g_cur_packet)
# JSON: node is not generated yet, defer
def processBulkSubmit(self, dat_cur):
if self.urb.type & USB_DIR_IN:
g_payload_bytes.bulk.req_in += self.urb.length
else:
g_payload_bytes.bulk.req_out += self.urb.length
pending = PendingRX()
pending.raw = self.urb_raw
pending.m_urb = self.urb
if args.verbose:
print 'Remaining data: %d' % (len(dat_cur))
if args.verbose:
print "Packet %d bulk submit (control info size %lu)" % (self.g_cur_packet, 666)
if self.urb.endpoint & URB_TRANSFER_IN:
dbg("%d: IN" % (self.g_cur_packet))
else:
dbg("%d: OUT" % (self.g_cur_packet))
if (len(dat_cur) != self.urb.data_length):
comment("WARNING: remaining bytes %d != expected payload out bytes %d" % (len(dat_cur), self.urb.data_length))
UVDHexdumpCore(dat_cur, " ")
#raise Exception('See above')
pending.m_data_out = str(dat_cur)
pending.packet_number = self.g_cur_packet
if args.verbose:
print 'Added pending bulk URB %s' % self.urb.id
g_pending[self.urb.id] = pending
def processBulkCompleteIn(self, dat_cur):
packet_numbering = ''
data_size = 0
data_str = "None"
max_payload_sz = self.submit.m_urb.length
# FIXME: this is a messy conversion artfact from the C code
# Is it legal to have a 0 length bulk in?
if args.ofmt == 'JSON':
pass
elif max_payload_sz:
data_str = "buff"
data_size = max_payload_sz
elif args.ofmt == OUTPUT_LIBUSBPY:
data_str = "\"\""
if args.ofmt == OUTPUT_LIBUSBPY:
# def bulkRead(self, endpoint, length, timeout=0):
print "%sbuff = dev.bulkRead(0x%02X, 0x%04X)" % (indent, self.submit.m_urb.endpoint, data_size)
elif args.ofmt == 'JSON':
jact['S'] = {
"raw":binascii.hexlify(self.submit.raw),
'urb_type': 'S',
'urb_sec': self.submit.m_urb.sec,
'urb_usec': self.submit.m_urb.usec,
#'urb_stat': -EINPROGRESS,
'urb_len': self.submit.m_urb.length,
'data_len': self.submit.m_urb.data_length,
#'urb_setup': {
# bmRequestType: 0x40,
# bRequest: 176,
# wValue: 0x0018,
# wIndex: 0,
# wLength: 0
#},
'data': None
}
jact['C'] = {
"raw":binascii.hexlify(self.urb_raw),
'urb_type': 'C',
'urb_sec': self.urb.sec,
'urb_usec': self.urb.usec,
#'urb_stat': -EINPROGRESS,
'urb_len': self.urb.length,
'data_len': self.urb.data_length,
#'urb_setup': {
# bmRequestType: 0x40,
# bRequest: 176,
# wValue: 0x0018,
# wIndex: 0,
# wLength: 0
#},
'data': binascii.hexlify(dat_cur)
}
else:
'''
int LIBUSB_CALL libusb_bulk_transfer(libusb_device_handle *dev_handle,
unsigned char endpoint, unsigned char *data, int length,
int *actual_length, unsigned int timeout);
'''
raise Exception('FIXME')
'''
# Take off the unknown struct
if len(dat_cur) < control_rx_sz:
print "not enough data"
if (g_halt_error):
sys.exit(1)
return
dat_cur = dat_cur[control_rx_sz:]
# Now dat_cur/len(dat_cur) is the control in data payload
'''
# Verify we actually have enough / expected
# If exact match don't care
if (len(dat_cur) != max_payload_sz):
if len(dat_cur) < max_payload_sz:
comment("NOTE:: req max %u but got %u" % (max_payload_sz, len(dat_cur)))
else:
raise Exception('invalid response')
if (max_payload_sz):
if g_packet_numbers:
packet_numbering = "packet %u/%u" % (self.submit.packet_number, self.g_cur_packet)
else:
# TODO: consider counting instead of by captured index
packet_numbering = "packet"
if args.ofmt == OUTPUT_LIBUSBPY:
print "%svalidate_read(%s, buff, \"%s\")" % (indent, bytes2AnonArray(dat_cur, "char"), packet_numbering )
elif args.ofmt in ('LINUX', 'LIBUSB'):
print "%svalidate_read(%s, %u, buff, n_rw, \"%s\");" % (indent, bytes2AnonArray(dat_cur, "char"), packet_numbering )
def processBulkCompleteOut(self, dat_cur):
data_size = 0
# print "Data out size: %u vs urb size %u" % (submit.m_data_out_size, self.submit.m_urb.data_length )
if args.ofmt == OUTPUT_LIBUSBPY:
# Note that its the submit from earlier, not the ack that we care about
data_str = bytes2AnonArray(self.submit.m_data_out)
# def bulkWrite(self, endpoint, data, timeout=0):
print "%sdev.bulkWrite(0x%02X, %s)" % (indent, self.submit.m_urb.endpoint, data_str)
elif args.ofmt == 'JSON':
jact['S'] = {
"raw":binascii.hexlify(self.submit.raw),
'urb_type': 'S',
'urb_sec': self.submit.m_urb.sec,
'urb_usec': self.submit.m_urb.usec,
#'urb_stat': -EINPROGRESS,
'urb_len': self.submit.m_urb.length,
'data_len': self.submit.m_urb.data_length,
#'urb_setup': {
# bmRequestType: 0x40,
# bRequest: 176,
# wValue: 0x0018,
# wIndex: 0,
# wLength: 0
#},
'data': binascii.hexlify(self.submit.m_data_out)
}
jact['C'] = {
"raw":binascii.hexlify(self.urb_raw),
'urb_type': 'C',
'urb_sec': self.urb.sec,
'urb_usec': self.urb.usec,
#'urb_stat': -EINPROGRESS,
'urb_len': self.urb.length,
'data_len': self.urb.data_length,
#'urb_setup': {
# bmRequestType: 0x40,
# bRequest: 176,
# wValue: 0x0018,
# wIndex: 0,
# wLength: 0
#},
'data': None
}
else:
'''
int LIBUSB_CALL libusb_bulk_transfer(libusb_device_handle *dev_handle,
unsigned char endpoint, unsigned char *data, int length,
int *actual_length, unsigned int timeout);
'''
raise Exception('FIXME')
def processBulkComplete(self, dat_cur):
# self.print_stat()
if args.ofmt in ('LINUX', 'LIBUSB'):
print
if g_packet_numbers:
self.packnum()
if self.urb.endpoint & USB_DIR_IN:
g_payload_bytes.bulk.in_ += self.urb.data_length
self.processBulkCompleteIn(dat_cur)
else:
g_payload_bytes.bulk.out += self.urb.data_length
self.processBulkCompleteOut(dat_cur)
if __name__ == "__main__":
parser = argparse.ArgumentParser(description='Replay captured USB packets')
parser.add_argument('--range', '-r', help='inclusive range like 123:456')
parser.add_argument('-k', dest='ofmt', default='LIBUSBPY', action='store_const', const='LINUX', help='output linux kenrel')
parser.add_argument('-l', dest='ofmt', action='store_const', const='LIBUSB', help='output libusb')
parser.add_argument('-p', dest='ofmt', action='store_const', const='LIBUSBPY', help='output libusb python')
parser.add_argument('-j', dest='ofmt', action='store_const', const='JSON', help='output data as JSON')
parser.add_argument('-s', help='allow short')
parser.add_argument('-f', help='custom call')
parser.add_argument('-n', help='packet numbers')
parser.add_argument('--verbose', '-v', action='store_true', help='verbose')
parser.add_argument('fin', help='File name in')
args = parser.parse_args()
if args.range:
(g_min_packet, g_max_packet) = args.range.split(':')
if len(g_min_packet) == 0:
g_min_packet = 0
else:
g_min_packet = int(g_min_packet, 0)
if len(g_max_packet) == 0:
g_max_packet = float('inf')
else:
g_max_packet = int(g_max_packet, 0)
if args.ofmt == 'JSON':
jroot = {'packets':[]}
# Active JSON node
jact = jroot
comment("Generated by uvusbreplay %s" % (VERSION_STR,))
comment("uvusbreplay copyright 2011 John McMaster <[email protected]>")
# comment("Date: %s" % (UVDCurDateTime()))
comment("Source data: %s" % (args.fin,))
comment("Source range: %s - %s" % (g_min_packet, g_max_packet))
if args.ofmt == OUTPUT_LIBUSBPY:
print '''
import binascii
def validate_read(expected, actual, msg):
if expected != actual:
print 'Failed %s' % msg
print ' Expected; %s' % binascii.hexlify(expected,)
print ' Actual: %s' % binascii.hexlify(actual,)
#raise Exception('failed validate: %s' % msg)
'''
if args.ofmt == 'LIBUSBPY':
print 'def main(dev):'
indent = " "
if args.ofmt in ('LINUX', 'LIBUSB'):
print "int n_rw = 0;"
print "uint8_t buff[4096];"
if args.ofmt == 'LIBUSB' and g_use_defines:
# Libusb expects users to hard code these into address I guess
print "# Directions"
print "# to device"
print "const int USB_DIR_OUT = 0;"
print "# to host"
print "const int URB_TRANSFER_IN = 0x80;"
print "const int USB_TYPE_MASK = (0x03 << 5);"
print "const int USB_TYPE_STANDARD = (0x00 << 5);"
print "const int USB_TYPE_CLASS = (0x01 << 5);"
print "const int USB_TYPE_VENDOR = (0x02 << 5);"
print "const int USB_TYPE_RESERVED = (0x03 << 5);"
if args.ofmt != 'JSON':
print ""
dbg("parsing from range %s to %s" % (g_min_packet, g_max_packet))
p = pcap.pcapObject()
p.open_offline(args.fin)
gen = Gen()
p.loop(-1, gen.loop_cb)
if len(g_pending) != 0:
comment("WARNING: %lu pending requests" % (len(g_pending)))
# Makes copy/pasting easier in some editors...