-
Notifications
You must be signed in to change notification settings - Fork 24
/
Copy pathIOUSBInterfaceClass.cpp
3054 lines (2452 loc) · 94.1 KB
/
IOUSBInterfaceClass.cpp
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
/*
* Copyright (c) 1998-2003 Apple Computer, Inc. All rights reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
#define CFRUNLOOP_NEW_API 1
#include <TargetConditionals.h>
#include <CoreFoundation/CFNumber.h>
#include <CoreFoundation/CoreFoundation.h>
#include "IOUSBInterfaceClass.h"
#include <IOKit/usb/USB.h>
#include <IOKit/usb/IOUSBUserClient.h>
#if !TARGET_OS_EMBEDDED
#endif
#include <stdio.h>
__BEGIN_DECLS
#include <mach/mach.h>
#include <IOKit/iokitmig.h>
__END_DECLS
#if IOUSBLIBDEBUG
#define __STDC_FORMAT_MACROS 1
#include <inttypes.h>
#define DEBUGPRINT(x,...) asl_log(fASLClient, NULL, ASL_LEVEL_NOTICE, x, ##__VA_ARGS__);
#else
#define DEBUGPRINT(x,...)
#endif
#define ATTACHEDCHECK() do { \
if (!fInterfaceIsAttached) \
{ \
DEBUGPRINT("IOUSBInterfaceClass[%p]::attached check failed\n", this); \
return kIOReturnNoDevice; \
} \
} while (0)
#define OPENCHECK() do { \
if (!fIsOpen) \
{ \
DEBUGPRINT("IOUSBInterfaceClass[%p]::open check failed\n", this);\
return kIOReturnNotOpen; \
} \
} while (0)
#define ALLCHECKS() do { \
ATTACHEDCHECK(); \
OPENCHECK(); \
} while (0)
IOCFPlugInInterface ** IOUSBInterfaceClass::alloc()
{
IOUSBInterfaceClass *me;
me = new IOUSBInterfaceClass;
if (me)
return (IOCFPlugInInterface **) &me->iunknown.pseudoVTable;
else
return 0;
}
IOUSBInterfaceClass::IOUSBInterfaceClass()
: IOUSBIUnknown(&sIOCFPlugInInterfaceV1),
fService(IO_OBJECT_NULL),
fDevice(IO_OBJECT_NULL),
fConnection(IO_OBJECT_NULL),
fAsyncPort(MACH_PORT_NULL),
fCFSource(0),
fIsOpen(false),
fClass(0),
fSubClass(0),
fProtocol(0),
fConfigValue(0),
fInterfaceNumber(0),
fAlternateSetting(0),
fNumEndpoints(0),
fStringIndex(0),
fVendor(0),
fProduct(0),
fDeviceReleaseNumber(0),
fLocationID(0),
fNumConfigurations(0),
fNextCookie(0),
fUserBufferInfoListHead(NULL),
fConfigLength(0),
fInterfaceDescriptor(NULL),
fConfigurations(NULL),
fConfigDescCacheValid(false),
fCurrentConfigIndex(0),
fNeedContiguousMemoryForLowLatencyIsoch(0),
fNeedsToReleasefDevice(false),
fASLClient(NULL),
fInterfaceIsAttached(false)
{
#if IOUSBLIBDEBUG
fASLClient = asl_open(NULL, "com.apple.iousblib", 0);
#endif
DEBUGPRINT("IOUSBInterfaceClass[%p]::IOUSBInterfaceClass\n", this);
#ifdef SUPPORTS_SS_USB
fUSBInterface.pseudoVTable = (IUnknownVTbl *) &sUSBInterfaceInterfaceV500;
#else
fUSBInterface.pseudoVTable = (IUnknownVTbl *) &sUSBInterfaceInterfaceV300;
#endif
fUSBInterface.obj = this;
}
IOUSBInterfaceClass::~IOUSBInterfaceClass()
{
DEBUGPRINT("+IOUSBInterfaceClass[%p]::~IOUSBInterfaceClass\n", this);
if (fConfigurations)
{
// release the config descriptor data
int i;
for (i=0; i< fNumConfigurations; i++)
if (fConfigurations[i])
free(fConfigurations[i]);
free(fConfigurations);
fConfigurations = NULL;
fConfigDescCacheValid = false;
}
if (fConnection)
{
IOServiceClose(fConnection);
fConnection = MACH_PORT_NULL;
fInterfaceIsAttached = false;
}
if (fService)
{
IOObjectRelease(fService);
fService = MACH_PORT_NULL;
}
if (fDevice)
{
if ( fNeedsToReleasefDevice )
IOObjectRelease(fDevice);
fDevice = MACH_PORT_NULL;
}
if (fAsyncPort)
{
IONotificationPortDestroy(fAsyncPort);
fAsyncPort = NULL;
}
if (fASLClient)
asl_close(fASLClient);
}
#pragma mark -
HRESULT
IOUSBInterfaceClass::queryInterface(REFIID iid, void **ppv)
{
DEBUGPRINT("IOUSBInterfaceClass[%p]::queryInterface\n", this);
CFUUIDRef uuid = CFUUIDCreateFromUUIDBytes(NULL, iid);
HRESULT res = S_OK;
if (CFEqual(uuid, IUnknownUUID) || CFEqual(uuid, kIOCFPlugInInterfaceID))
{
*ppv = &iunknown;
addRef();
}
else if ( CFEqual(uuid, kIOUSBInterfaceInterfaceID182)
|| CFEqual(uuid, kIOUSBInterfaceInterfaceID183)
|| CFEqual(uuid, kIOUSBInterfaceInterfaceID190)
|| CFEqual(uuid, kIOUSBInterfaceInterfaceID192)
|| CFEqual(uuid, kIOUSBInterfaceInterfaceID197)
|| CFEqual(uuid, kIOUSBInterfaceInterfaceID220)
|| CFEqual(uuid, kIOUSBInterfaceInterfaceID245)
|| CFEqual(uuid, kIOUSBInterfaceInterfaceID300)
|| CFEqual(uuid, kIOUSBInterfaceInterfaceID)
#ifdef SUPPORTS_SS_USB
|| CFEqual(uuid, kIOUSBInterfaceInterfaceID500)
#endif
)
{
*ppv = &fUSBInterface;
addRef();
if ( CFEqual(uuid, kIOUSBInterfaceInterfaceID182)
|| CFEqual(uuid, kIOUSBInterfaceInterfaceID183)
|| CFEqual(uuid, kIOUSBInterfaceInterfaceID190)
|| CFEqual(uuid, kIOUSBInterfaceInterfaceID192)
|| CFEqual(uuid, kIOUSBInterfaceInterfaceID197)
|| CFEqual(uuid, kIOUSBInterfaceInterfaceID220)
|| CFEqual(uuid, kIOUSBInterfaceInterfaceID) )
{
fNeedsToReleasefDevice = false;
}
else
{
// Version 245 fixes rdar://4418782, by releaseing our fDevice. We need to make sure that
// we only do that fix for 245 and above
DEBUGPRINT("IOUSBInterfaceClass[%p]::queryInterface fixing rdar://4418782 by releasing fDevice in destructor\n", this);
fNeedsToReleasefDevice = true;
}
}
else
*ppv = 0;
if (!*ppv)
res = E_NOINTERFACE;
CFRelease(uuid);
if ( res )
{
DEBUGPRINT("-IOUSBInterfaceClass[%p]::queryInterface %" PRId32 "\n", this, (int32_t)res);
}
return res;
}
IOReturn
IOUSBInterfaceClass::probe(CFDictionaryRef propertyTable, io_service_t inService, SInt32 *order)
{
#pragma unused (propertyTable, order)
DEBUGPRINT("IOUSBInterfaceClass[%p]::probe\n", this);
if (!inService || !IOObjectConformsTo(inService, "IOUSBInterface"))
return kIOReturnBadArgument;
return kIOReturnSuccess;
}
#pragma mark -
IOReturn
IOUSBInterfaceClass::start(CFDictionaryRef propertyTable, io_service_t inService)
{
#pragma unused (propertyTable)
IOReturn res;
uint64_t output[1];
uint32_t len = 1;
UInt32 type = 0;
fNextCookie = 0;
fConfigDescCacheValid = false;
fInterfaceDescriptor = NULL;
fConfigLength = 0;
fUserBufferInfoListHead = NULL;
res = IOServiceOpen(inService, mach_task_self(), type, &fConnection);
if (res != kIOReturnSuccess)
return res;
if ( fConnection == MACH_PORT_NULL )
return kIOReturnNoDevice;
fInterfaceIsAttached = true;
// Make sure that we retain our service so that we can use it later on
//
res = IOObjectRetain(inService);
if (res)
{
DEBUGPRINT("-IOUSBInterfaceClass::start IOObjectRetain returned 0x%x\n", res);
return res;
}
fService = inService;
output[0] = 0;
res = IOConnectCallScalarMethod(fConnection, kUSBInterfaceUserClientGetDevice, 0, 0, output, &len);
if (res)
fDevice = IO_OBJECT_NULL;
else
fDevice = (io_service_t) output[0];
DEBUGPRINT("-IOUSBInterfaceClass::start kUSBInterfaceUserClientGetDevice res = 0x%x, output[0] = 0x%qx, fDevice 0x%x", res, output[0], fDevice);
res = GetPropertyInfo();
DEBUGPRINT("-IOUSBInterfaceClass::start 0x%x, fDevice = 0x%x\n", res, fDevice);
return res;
}
IOReturn
IOUSBInterfaceClass::stop()
{
IOReturn ret = kIOReturnSuccess;
DEBUGPRINT("IOUSBInterfaceClass[%p]::stop\n", this);
ATTACHEDCHECK();
if (fIsOpen)
ret = USBInterfaceClose();
return ret;
}
IOReturn
IOUSBInterfaceClass::GetPropertyInfo(void)
{
IOReturn kr;
CFMutableDictionaryRef entryProperties = NULL;
CFTypeRef val;
SInt64 tempValue;
DEBUGPRINT("+IOUSBInterfaceClass[%p]::GetPropertyInfo (fService: 0x%x, fDevice: 0x%x)", this, fService, fDevice);
kr = IORegistryEntryCreateCFProperties(fService, &entryProperties, NULL, 0);
if (kr)
{
DEBUGPRINT("+IOUSBInterfaceClass[%p]::GetPropertyInfo IORegistryEntryCreateCFProperties returned 0x%x", this, kr);
return kr;
}
if (entryProperties && (CFGetTypeID(entryProperties) == CFDictionaryGetTypeID()))
{
// The dictionary contains values that are signed 32 or 64 bit. To avoid CF sign extensions issues read the values into a temp
// SInt64 and then assign to the local ivar
// (rdar://4951538 & rdar://5081728)
val = CFDictionaryGetValue(entryProperties, CFSTR(kUSBInterfaceClass));
if (val && (CFGetTypeID(val) == CFNumberGetTypeID()))
{
CFNumberGetValue((CFNumberRef)val, kCFNumberLongLongType, &tempValue);
fClass = tempValue;
}
val = CFDictionaryGetValue(entryProperties, CFSTR(kUSBInterfaceSubClass));
if (val && (CFGetTypeID(val) == CFNumberGetTypeID()))
{
CFNumberGetValue((CFNumberRef)val, kCFNumberLongLongType, &tempValue);
fSubClass = tempValue;
}
val = CFDictionaryGetValue(entryProperties, CFSTR(kUSBInterfaceProtocol));
if (val && (CFGetTypeID(val) == CFNumberGetTypeID()))
{
CFNumberGetValue((CFNumberRef)val, kCFNumberLongLongType, &tempValue);
fProtocol = tempValue;
}
val = CFDictionaryGetValue(entryProperties, CFSTR(kUSBVendorID));
if (val && (CFGetTypeID(val) == CFNumberGetTypeID()))
{
CFNumberGetValue((CFNumberRef)val, kCFNumberLongLongType, &tempValue);
fVendor = tempValue;
}
val = CFDictionaryGetValue(entryProperties, CFSTR(kUSBProductID));
if (val && (CFGetTypeID(val) == CFNumberGetTypeID()))
{
CFNumberGetValue((CFNumberRef)val, kCFNumberLongLongType, &tempValue);
fProduct = tempValue;
}
val = CFDictionaryGetValue(entryProperties, CFSTR(kUSBDeviceReleaseNumber));
if (val && (CFGetTypeID(val) == CFNumberGetTypeID()))
{
CFNumberGetValue((CFNumberRef)val, kCFNumberLongLongType, &tempValue);
fDeviceReleaseNumber = tempValue;
}
val = CFDictionaryGetValue(entryProperties, CFSTR(kUSBConfigurationValue));
if (val && (CFGetTypeID(val) == CFNumberGetTypeID()))
{
CFNumberGetValue((CFNumberRef)val, kCFNumberLongLongType, &tempValue);
fConfigValue = tempValue;
}
val = CFDictionaryGetValue(entryProperties, CFSTR(kUSBInterfaceNumber));
if (val && (CFGetTypeID(val) == CFNumberGetTypeID()))
{
CFNumberGetValue((CFNumberRef)val, kCFNumberLongLongType, &tempValue);
fInterfaceNumber = tempValue;
}
val = CFDictionaryGetValue(entryProperties, CFSTR(kUSBAlternateSetting));
if (val && (CFGetTypeID(val) == CFNumberGetTypeID()))
{
CFNumberGetValue((CFNumberRef)val, kCFNumberLongLongType, &tempValue);
fAlternateSetting = tempValue;
}
val = CFDictionaryGetValue(entryProperties, CFSTR(kUSBNumEndpoints));
if (val && (CFGetTypeID(val) == CFNumberGetTypeID()))
{
CFNumberGetValue((CFNumberRef)val, kCFNumberLongLongType, &tempValue);
fNumEndpoints = tempValue;
}
val = CFDictionaryGetValue(entryProperties, CFSTR(kUSBInterfaceStringIndex));
if (val && (CFGetTypeID(val) == CFNumberGetTypeID()))
{
CFNumberGetValue((CFNumberRef)val, kCFNumberLongLongType, &tempValue);
fStringIndex = tempValue;
}
val = CFDictionaryGetValue(entryProperties, CFSTR(kUSBDevicePropertyLocationID));
if (val && (CFGetTypeID(val) == CFNumberGetTypeID()))
{
CFNumberGetValue((CFNumberRef)val, kCFNumberLongLongType, &tempValue);
fLocationID = tempValue;
}
CFDataRef data = (CFDataRef) CFDictionaryGetValue(entryProperties, CFSTR("InterfaceDescriptor"));
if (data && (CFGetTypeID(data) == CFDataGetTypeID()))
{
fInterfaceDescriptor = (IOUSBInterfaceDescriptor *) CFDataGetBytePtr( data );
}
CFRelease(entryProperties);
entryProperties = NULL;
}
// Look at the device's properties
//
kr = IORegistryEntryCreateCFProperties(fDevice, &entryProperties, NULL, 0);
if (kr)
{
DEBUGPRINT("+IOUSBInterfaceClass[%p]::GetPropertyInfo IORegistryEntryCreateCFProperties#2 returned 0x%x", this, kr);
return kr;
}
if (entryProperties && (CFGetTypeID(entryProperties) == CFDictionaryGetTypeID()))
{
// We only need to do the following once per instantiation
if ( fConfigurations == NULL)
{
val = CFDictionaryGetValue(entryProperties, CFSTR(kUSBDeviceNumConfigs));
if (val && (CFGetTypeID(val) == CFNumberGetTypeID()))
{
CFNumberGetValue((CFNumberRef)val, kCFNumberLongLongType, &tempValue);
fNumConfigurations = tempValue;
}
else
fNumConfigurations = 0;
if (fNumConfigurations)
{
fConfigurations = (IOUSBConfigurationDescriptorPtr*) malloc(fNumConfigurations * sizeof(IOUSBConfigurationDescriptorPtr));
bzero(fConfigurations, fNumConfigurations * sizeof(IOUSBConfigurationDescriptorPtr));
}
val = CFDictionaryGetValue(entryProperties, CFSTR(kUSBControllerNeedsContiguousMemoryForIsoch));
if (val && (CFGetTypeID(val) == CFBooleanGetTypeID()))
{
fNeedContiguousMemoryForLowLatencyIsoch = CFBooleanGetValue((CFBooleanRef) val);
}
else
fNeedContiguousMemoryForLowLatencyIsoch = false;
DEBUGPRINT("IOUSBInterfaceClass[%p]::GetPropertyInfo NeedContiguousMemoryForIsoch = %d\n", this, fNeedContiguousMemoryForLowLatencyIsoch);
}
CFRelease(entryProperties);
entryProperties = NULL;
}
DEBUGPRINT("-IOUSBInterfaceClass[%p]::GetPropertyInfo", this);
return kIOReturnSuccess;
}
IOReturn
IOUSBInterfaceClass::GetIOUSBLibVersion(NumVersion *ioUSBLibVersion, NumVersion *usbFamilyVersion)
{
CFURLRef bundleURL;
CFBundleRef myBundle;
UInt32 usbFamilyBundleVersion;
UInt32 usbLibBundleVersion;
UInt32 * tmp;
ATTACHEDCHECK();
// Make a CFURLRef from the CFString representation of the
// bundle's path. See the Core Foundation URL Services chapter
// for details.
bundleURL = CFURLCreateWithFileSystemPath(
kCFAllocatorDefault,
CFSTR("/System/Library/Extensions/IOUSBFamily.kext"),
kCFURLPOSIXPathStyle,
true );
// Make a bundle instance using the URLRef.
myBundle = CFBundleCreate( kCFAllocatorDefault, bundleURL );
// Look for the bundle's version number.
usbFamilyBundleVersion = CFBundleGetVersionNumber( myBundle );
// Any CF objects returned from functions with "create" or
// "copy" in their names must be released by us!
CFRelease( bundleURL );
CFRelease( myBundle );
// Make a CFURLRef from the CFString representation of the
// bundle's path. See the Core Foundation URL Services chapter
// for details.
bundleURL = CFURLCreateWithFileSystemPath(
kCFAllocatorDefault,
CFSTR("/System/Library/Extensions/IOUSBFamily.kext/Contents/PlugIns/IOUSBLib.bundle"),
kCFURLPOSIXPathStyle,
true );
// Make a bundle instance using the URLRef.
myBundle = CFBundleCreate( kCFAllocatorDefault, bundleURL );
// Look for the bundle's version number.
usbLibBundleVersion = CFBundleGetVersionNumber( myBundle );
// Any CF objects returned from functions with "create" or
// "copy" in their names must be released by us!
CFRelease( bundleURL );
CFRelease( myBundle );
// Cast the NumVersion to a UInt32 so we can just copy the data directly in.
//
if ( ioUSBLibVersion )
{
tmp = (UInt32 *) ioUSBLibVersion;
*tmp = usbLibBundleVersion;
}
if ( usbFamilyVersion )
{
tmp = (UInt32 *) usbFamilyVersion;
*tmp = usbFamilyBundleVersion;
}
DEBUGPRINT("IOUSBInterfaceClass[%p]::GetIOUSBLibVersion = %" PRIx32 ", %" PRIx32 "\n", this, *(uint32_t *) ioUSBLibVersion, *(uint32_t *) usbFamilyVersion);
return kIOReturnSuccess;
}
#pragma mark IORegistry Getters
IOReturn
IOUSBInterfaceClass::GetInterfaceClass(UInt8 *intfClass)
{
ATTACHEDCHECK();
*intfClass = fClass;
DEBUGPRINT("IOUSBInterfaceClass[%p]::GetInterfaceClass = %d\n", this, *intfClass);
return kIOReturnSuccess;
}
IOReturn
IOUSBInterfaceClass::GetInterfaceSubClass(UInt8 *intfSubClass)
{
ATTACHEDCHECK();
*intfSubClass = fSubClass;
DEBUGPRINT("IOUSBInterfaceClass[%p]::GetInterfaceSubClass = %d\n", this, *intfSubClass);
return kIOReturnSuccess;
}
IOReturn
IOUSBInterfaceClass::GetInterfaceProtocol(UInt8 *intfProtocol)
{
ATTACHEDCHECK();
*intfProtocol = fProtocol;
DEBUGPRINT("IOUSBInterfaceClass[%p]::GetInterfaceProtocol = %d\n", this, *intfProtocol);
return kIOReturnSuccess;
}
IOReturn
IOUSBInterfaceClass::GetInterfaceStringIndex(UInt8 *intfSI)
{
ATTACHEDCHECK();
*intfSI = fStringIndex;
DEBUGPRINT("IOUSBInterfaceClass[%p]::GetInterfaceStringIndex = %d\n", this, *intfSI);
return kIOReturnSuccess;
}
IOReturn
IOUSBInterfaceClass::GetDeviceVendor(UInt16 *devVendor)
{
ATTACHEDCHECK();
*devVendor = fVendor;
DEBUGPRINT("IOUSBInterfaceClass[%p]::GetDeviceVendor = %d\n", this,*devVendor);
return kIOReturnSuccess;
}
IOReturn
IOUSBInterfaceClass::GetDeviceProduct(UInt16 *devProduct)
{
ATTACHEDCHECK();
*devProduct = fProduct;
DEBUGPRINT("IOUSBInterfaceClass[%p]::GetDeviceProduct = %d\n", this, *devProduct);
return kIOReturnSuccess;
}
IOReturn
IOUSBInterfaceClass::GetDeviceReleaseNumber(UInt16 *devRelNum)
{
ATTACHEDCHECK();
*devRelNum = fDeviceReleaseNumber;
DEBUGPRINT("IOUSBInterfaceClass[%p]::GetDeviceReleaseNumber = %d\n", this, *devRelNum);
return kIOReturnSuccess;
}
IOReturn
IOUSBInterfaceClass::GetConfigurationValue(UInt8 *configVal)
{
ATTACHEDCHECK();
*configVal = fConfigValue;
DEBUGPRINT("IOUSBInterfaceClass[%p]::GetConfigurationValue = %d\n", this, *configVal);
return kIOReturnSuccess;
}
IOReturn
IOUSBInterfaceClass::GetInterfaceNumber(UInt8 *intfNumber)
{
ATTACHEDCHECK();
*intfNumber = fInterfaceNumber;
DEBUGPRINT("IOUSBInterfaceClass[%p]::GetInterfaceNumber = %d\n", this, *intfNumber);
return kIOReturnSuccess;
}
IOReturn
IOUSBInterfaceClass::GetAlternateSetting(UInt8 *intfAlternateSetting)
{
ATTACHEDCHECK();
*intfAlternateSetting = fAlternateSetting;
DEBUGPRINT("IOUSBInterfaceClass[%p]::GetAlternateSetting = %d\n", this, *intfAlternateSetting);
return kIOReturnSuccess;
}
IOReturn
IOUSBInterfaceClass::GetNumEndpoints(UInt8 *intfNumEndpoints)
{
ATTACHEDCHECK();
*intfNumEndpoints = fNumEndpoints;
DEBUGPRINT("IOUSBInterfaceClass[%p]::GetNumEndpoints = %d\n", this, *intfNumEndpoints);
return kIOReturnSuccess;
}
IOReturn
IOUSBInterfaceClass::GetLocationID(UInt32 *locationID)
{
ATTACHEDCHECK();
*locationID = fLocationID;
DEBUGPRINT("IOUSBInterfaceClass[%p]::GetLocationID\n = 0x%" PRIx32 "", this, (uint32_t) *locationID);
return kIOReturnSuccess;
}
IOReturn
IOUSBInterfaceClass::GetDevice(io_service_t *device)
{
ATTACHEDCHECK();
*device = fDevice;
DEBUGPRINT("IOUSBInterfaceClass[%p]::GetDevice = 0x%x\n", this, *device);
return kIOReturnSuccess;
}
#pragma mark IOUSBInterface
IOReturn
IOUSBInterfaceClass::CreateInterfaceAsyncEventSource(CFRunLoopSourceRef *source)
{
IOReturn ret;
CFMachPortContext context;
CFMachPortRef cfPort;
Boolean shouldFreeInfo;
DEBUGPRINT("IOUSBInterfaceClass[%p]::CreateInterfaceAsyncEventSource\n", this);
if ( fCFSource )
{
DEBUGPRINT("IOUSBInterfaceClass[%p]::CreateInterfaceAsyncEventSource already had a CFSource!", this);
// Since we are returning our fCFSource and this is a Create call, be sure to retain it
CFRetain(fCFSource);
*source = fCFSource;
return kIOReturnSuccess;
}
if (!fAsyncPort)
{
// This CreateDeviceAsyncPort() will create the fCFSource
ret = CreateInterfaceAsyncPort(0);
if (kIOReturnSuccess != ret)
return ret;
}
if (!fCFSource)
return kIOReturnNoMemory;
if (source)
{
// We retain the fCFSource because our API is a "Create" API, which the callers will assume that they
// have to release it. Since we now get it via IONotificationPortGetRunLoopSource(), the IONotificationPortDestroy()
// will release it -- if we don't retain it here, we would do a double relese
CFRetain(fCFSource);
*source = fCFSource;
}
return kIOReturnSuccess;
}
CFRunLoopSourceRef
IOUSBInterfaceClass::GetInterfaceAsyncEventSource()
{
return fCFSource;
}
IOReturn
IOUSBInterfaceClass::CreateInterfaceAsyncPort(mach_port_t *port)
{
IOReturn kr = kIOReturnSuccess;
mach_port_t masterPort;
ATTACHEDCHECK();
// If we already have a port, don't create a new one.
if (fAsyncPort)
{
if (port)
*port = IONotificationPortGetMachPort(fAsyncPort);
return kIOReturnSuccess;
}
fAsyncPort = IONotificationPortCreate(kIOMasterPortDefault);
if (fAsyncPort)
{
// Get the runloop source from our notification port
fCFSource = IONotificationPortGetRunLoopSource(fAsyncPort);
if (port)
*port = IONotificationPortGetMachPort(fAsyncPort);
if (fIsOpen)
{
io_async_ref64_t asyncRef;
uint32_t len = 0;
kr = IOConnectCallAsyncScalarMethod(fConnection, kUSBInterfaceUserClientSetAsyncPort, IONotificationPortGetMachPort(fAsyncPort), asyncRef, 1, 0, 0, 0, &len);
if (kr == MACH_SEND_INVALID_DEST)
{
fIsOpen = false;
fInterfaceIsAttached = false;
kr = kIOReturnNoDevice;
}
}
}
return kr;
}
mach_port_t
IOUSBInterfaceClass::GetInterfaceAsyncPort()
{
if ( fAsyncPort == MACH_PORT_NULL )
return MACH_SEND_INVALID_DEST;
else
return IONotificationPortGetMachPort(fAsyncPort);
}
IOReturn
IOUSBInterfaceClass::USBInterfaceOpen(bool seize)
{
IOReturn ret = kIOReturnSuccess;
DEBUGPRINT("+IOUSBInterfaceClass[%p]::USBInterfaceOpen\n", this);
ATTACHEDCHECK();
if (fIsOpen)
return kIOReturnSuccess;
uint32_t len = 0;
uint64_t input = (uint64_t) seize;
ret = IOConnectCallScalarMethod(fConnection, kUSBInterfaceUserClientOpen, &input, 1, 0, &len);
if (ret == kIOReturnSuccess)
{
fIsOpen = true;
if (fAsyncPort)
{
io_async_ref64_t asyncRef;
ret = IOConnectCallAsyncScalarMethod(fConnection, kUSBInterfaceUserClientSetAsyncPort, IONotificationPortGetMachPort(fAsyncPort), asyncRef, 1, 0, 0, 0, &len);
if ( (ret != kIOReturnSuccess) and (ret != MACH_SEND_INVALID_DEST ))
{
USBInterfaceClose();
}
}
}
if (ret == MACH_SEND_INVALID_DEST)
{
fIsOpen = false;
fInterfaceIsAttached = false;
ret = kIOReturnNoDevice;
}
if ( ret != kIOReturnSuccess )
{
DEBUGPRINT("+IOUSBInterfaceClass[%p]::USBInterfaceOpen returns 0x%x\n", this, ret);
}
return ret;
}
IOReturn
IOUSBInterfaceClass::USBInterfaceClose()
{
IOReturn ret = kIOReturnSuccess;
LowLatencyUserBufferInfoV3 * buffer;
LowLatencyUserBufferInfoV3 * nextBuffer;
DEBUGPRINT("+IOUSBInterfaceClass::USBInterfaceClose\n");
mach_msg_type_number_t len = 0;
fIsOpen = false;
if ( fInterfaceIsAttached )
{
ret = IOConnectCallScalarMethod(fConnection, kUSBInterfaceUserClientClose,0, 0, 0, 0);
if (ret == MACH_SEND_INVALID_DEST)
{
fIsOpen = false;
fInterfaceIsAttached = false;
ret = kIOReturnNoDevice;
}
}
// Need to free any buffers that has been allocated by the low latency stuff that has not been
// released!
//
if (fUserBufferInfoListHead != NULL)
{
nextBuffer = fUserBufferInfoListHead;
buffer = fUserBufferInfoListHead;
DEBUGPRINT("fUserBufferInfoListHead != NULL: %p, next: %p\n", fUserBufferInfoListHead, buffer->nextBuffer);
// Traverse the list and release memory
//
while ( nextBuffer != NULL )
{
nextBuffer = (LowLatencyUserBufferInfoV3*) buffer->nextBuffer;
DEBUGPRINT("Releasing 0x%qx, %p\n", buffer->bufferAddress, buffer );
free ( (void *) buffer->bufferAddress );
free ( buffer );
buffer = nextBuffer;
}
fUserBufferInfoListHead = NULL;
}
return ret;
}
#pragma mark -
IOReturn
IOUSBInterfaceClass::SetAlternateInterface(UInt8 alternateSetting)
{
uint64_t in[1];
size_t len = 1;
IOReturn kr = kIOReturnSuccess;
DEBUGPRINT("IOUSBInterfaceClass::SetAlternateInterface to %d\n", alternateSetting);
ALLCHECKS();
in[0] = (uint64_t) alternateSetting;
kr = IOConnectCallScalarMethod(fConnection, kUSBInterfaceUserClientSetAlternateInterface, in, 1, NULL, NULL);
if (kr == kIOReturnSuccess)
kr = GetPropertyInfo();
if (kr == MACH_SEND_INVALID_DEST)
{
fIsOpen = false;
fInterfaceIsAttached = false;
kr = kIOReturnNoDevice;
}
if ( kr != kIOReturnSuccess )
{
DEBUGPRINT("IOUSBInterfaceClass::SetConfiguration returning 0x%x\n", kr);
}
return kr;
}
IOReturn
IOUSBInterfaceClass::GetBusMicroFrameNumber(UInt64 *microFrame, AbsoluteTime *atTime)
{
IOUSBGetFrameStruct frameInfo;
IOReturn ret;
size_t len;
DEBUGPRINT("IOUSBInterfaceClass[%p]::GetBusMicroFrameNumber\n", this);
ATTACHEDCHECK();
len = sizeof(IOUSBGetFrameStruct);
ret = IOConnectCallStructMethod(fConnection, kUSBInterfaceUserClientGetMicroFrameNumber, 0, 0, &frameInfo, &len);
if (kIOReturnSuccess == ret)
{
#if !TARGET_OS_EMBEDDED
#endif
{
*microFrame = frameInfo.frame;
*atTime = frameInfo.timeStamp;
}
}
if (ret == MACH_SEND_INVALID_DEST)
{
fIsOpen = false;
fInterfaceIsAttached = false;
ret = kIOReturnNoDevice;
}
return ret;
}
IOReturn
IOUSBInterfaceClass::GetBusFrameNumber(UInt64 *frame, AbsoluteTime *atTime)
{
IOUSBGetFrameStruct frameInfo;
IOReturn ret;
size_t len;
DEBUGPRINT("IOUSBInterfaceClass[%p]::GetBusFrameNumber\n", this);
ATTACHEDCHECK();
len = sizeof(IOUSBGetFrameStruct);
ret = IOConnectCallStructMethod(fConnection, kUSBInterfaceUserClientGetFrameNumber, 0, 0, &frameInfo, &len);
if (kIOReturnSuccess == ret)
{
#if !TARGET_OS_EMBEDDED
#endif
{
*frame = frameInfo.frame;
*atTime = frameInfo.timeStamp;
}
}
if (ret == MACH_SEND_INVALID_DEST)
{
fIsOpen = false;
fInterfaceIsAttached = false;
ret = kIOReturnNoDevice;