forked from RehabMan/OS-X-Generic-USB3
/
GenericUSBXHCI.cpp
294 lines (268 loc) · 8.79 KB
/
GenericUSBXHCI.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
/*
* GenericUSBXHCI.cpp
* GenericUSBXHCI
*
* Created by Zenith432 on December 5th 2012.
* Copyright 2012-2014 Zenith432. All rights reserved.
*
*/
#include "GenericUSBXHCI.h"
#include "GenericUSBXHCIUserClient.h"
#include <IOKit/IOTimerEventSource.h>
#include <libkern/version.h>
//REVIEW: avoids problem with Xcode 5.1.0 where -dead_strip eliminates these required symbols
#include <libkern/OSKextLib.h>
void* _org_rehabman_dontstrip_[] =
{
(void*)&OSKextGetCurrentIdentifier,
(void*)&OSKextGetCurrentLoadTag,
(void*)&OSKextGetCurrentVersionString,
};
#define CLASS GenericUSBXHCI
#define super IOUSBControllerV3
OSDefineMetaClassAndFinalStructors(GenericUSBXHCI, IOUSBControllerV3);
#ifndef kIOUSBMessageMuxFromEHCIToXHCI
#define kIOUSBMessageMuxFromEHCIToXHCI iokit_usb_msg(0xe1) // 0xe00040e1 Message from the EHCI HC for ports mux transition from EHCI to XHCI
#define kIOUSBMessageMuxFromXHCIToEHCI iokit_usb_msg(0xe2) // 0xe00040e2 Message from the EHCI HC for ports mux transition from XHCI to EHCI
#endif
static __used char const copyright[] = "Copyright 2012-2014 Zenith432";
#pragma mark -
#pragma mark IOService
#pragma mark -
bool CLASS::willTerminate(IOService* provider, IOOptionBits options)
{
if (_expansionData && _watchdogTimerActive && _watchdogUSBTimer)
_watchdogUSBTimer->setTimeoutUS(1U);
return super::willTerminate(provider, options);
}
bool CLASS::terminate(IOOptionBits options)
{
m_invalid_regspace = true;
return super::terminate(options);
}
IOReturn CLASS::message(UInt32 type, IOService* provider, void* argument)
{
IOReturn rc;
uint8_t controller;
rc = super::message(type, provider, argument);
switch (type) {
case kIOUSBMessageHubPortDeviceDisconnected:
if (m_invalid_regspace ||
(gUSBStackDebugFlags & kUSBDisableMuxedPortsMask) ||
!_device ||
isInactive() ||
!(_errataBits & kErrataIntelPortMuxing))
return rc;
HCSelectWithMethod(static_cast<char const*>(argument));
return rc;
case kIOUSBMessageMuxFromEHCIToXHCI:
controller = 1U;
break;
case kIOUSBMessageMuxFromXHCIToEHCI:
controller = 0U;
break;
default:
return kIOReturnUnsupported;
}
if (m_invalid_regspace ||
(gUSBStackDebugFlags & kUSBDisableMuxedPortsMask) ||
!_device ||
isInactive() ||
!(_errataBits & kErrataIntelPortMuxing))
return rc;
HCSelect(static_cast<uint8_t>(reinterpret_cast<size_t>(argument)), controller);
return rc;
}
unsigned long CLASS::maxCapabilityForDomainState(IOPMPowerFlags domainState)
{
#if __MAC_OS_X_VERSION_MAX_ALLOWED >= 1090 || defined(REHABMAN_UNIVERSAL_BUILD)
uint8_t port, portLimit;
uint32_t portSC;
#endif
unsigned long state = super::maxCapabilityForDomainState(domainState);
if (!CHECK_FOR_MAVERICKS)
return state;
#if __MAC_OS_X_VERSION_MAX_ALLOWED >= 1090 || defined(REHABMAN_UNIVERSAL_BUILD)
if (_wakingFromHibernation)
return state;
if (!(_errataBits & kErrataIntelLynxPoint))
return state;
if (_myPowerState != kUSBPowerStateSleep)
return state;
if (state < kUSBPowerStateLowPower)
return state;
/*
* Note: This check neutralizes the code below because PM backbone calls this method *before*
* powering the parent IOPCIDevice on when coming back from Sleep to On.
*/
if (!_v3ExpansionData || !READ_V3EXPANSION(_parentDeviceON))
return state;
port = READ_V3EXPANSION(_rootHubPortsSSStartRange) - 1U;
portLimit = port + READ_V3EXPANSION(_rootHubNumPortsSS);
for (; port < portLimit; ++port) {
portSC = Read32Reg(&_pXHCIOperationalRegisters->prs[port].PortSC);
if (m_invalid_regspace)
return state;
if (!(portSC & XHCI_PS_WRC))
return state;
}
IOLog("XHCI: All ports have WRC bit set - reseting all of USB\n");
/*
* Note: Tested and this code causes ejection messages on connected drives.
*/
ResetControllerState();
EnableAllEndpoints(true);
state = kUSBPowerStateOff;
_wakingFromHibernation = true;
#endif
return state;
}
IOReturn CLASS::newUserClient(task_t owningTask, void* securityID, UInt32 type, IOUserClient ** handler)
{
IOUserClient *client;
if (type != kGUXUCType)
return kIOReturnUnsupported;
if (!handler)
return kIOReturnBadArgument;
client = OSTypeAlloc(GenericUSBXHCIUserClient);
if (!client)
return kIOReturnNoMemory;
if (!client->initWithTask(owningTask, securityID, type)) {
client->release();
return kIOReturnInternalError;
}
if (!client->attach(this)) {
client->release();
return kIOReturnInternalError;
}
if (!client->start(this)) {
client->detach(this);
client->release();
return kIOReturnInternalError;
}
*handler = client;
return kIOReturnSuccess;
}
#pragma mark -
#pragma mark IORegistryEntry
#pragma mark -
bool CLASS::init(OSDictionary* dictionary)
{
/*
* (64-bit/32-bit)
* sizeof(USBXHCI) = 0x23B80/0x1A640
* sizeof(IOUSBControllerV3) = 680/492
* sizeof(IOUSBControllerV2) = 440/360
* sizeof(IOUSBController) = 176/100
* sizeof(IOUSBBus) = 136/80
*
* Inheritance
* XHCIIsochEndpoint: public IOUSBControllerIsochEndpoint
* XHCIIsochTransferDescriptor: public IOUSBControllerIsochListElement
* XHCIAsyncEndpoint: public OSObject
* XHCIAsyncTransferDescriptor: public OSObject
* RootHubPortTable: public OSObject
* TTBandwidthTable: public OSObject
*
* Compiler symbol options
* LONG_RESET - enable complex reset sequence related to Intel Series 7 muxed ports
* DEBOUNCING - enable port debounce code
*/
if (!super::init(dictionary)) {
IOLog("%s: super::init failed\n", __FUNCTION__);
return false;
}
_controllerSpeed = kUSBDeviceSpeedSuper;
_isochScheduleLock = IOSimpleLockAlloc();
if (!_isochScheduleLock) {
IOLog("%s: Unable to allocate SimpleLock\n", __FUNCTION__);
return false;
}
_uimInitialized = false;
_myBusState = kUSBBusStateReset;
return true;
}
void CLASS::free(void)
{
/*
* Note: _wdhLock is not freed in original code
*/
if (_isochScheduleLock) {
IOSimpleLockFree(_isochScheduleLock);
_isochScheduleLock = 0;
}
super::free();
}
#pragma mark -
#pragma mark Module Init
#pragma mark -
extern "C"
{
__attribute__((visibility("hidden")))
int gux_log_level = 1;
__attribute__((visibility("hidden")))
int gux_options = 0;
/*
* Courtesy RehabMan
*/
#define MakeKernelVersion(maj,min,rev) (static_cast<uint32_t>((maj)<<16)|static_cast<uint16_t>((min)<<8)|static_cast<uint8_t>(rev))
__attribute__((visibility("hidden")))
kern_return_t Startup(kmod_info_t* ki, void * d)
{
uint32_t v, thisKernelVersion;
thisKernelVersion = MakeKernelVersion(version_major, version_minor, version_revision);
if (thisKernelVersion < MakeKernelVersion(11, 4, 2)) {
IOLog("OS 10.7.5 or later required for GenericUSBXHCI\n");
return KERN_FAILURE;
}
#ifndef REHABMAN_UNIVERSAL_BUILD
#if __MAC_OS_X_VERSION_MAX_ALLOWED >= 101000
if (thisKernelVersion < MakeKernelVersion(14, 0, 0)) {
IOLog("OS 10.10.0 or later required for this build of GenericUSBXHCI\n");
return KERN_FAILURE;
}
if (thisKernelVersion >= MakeKernelVersion(15, 0, 0)) {
IOLog("GenericUSBXHCI does not work on OS 10.11 or later\n");
return KERN_FAILURE;
}
#else
if (thisKernelVersion >= MakeKernelVersion(14, 0, 0)) {
IOLog("This build of GenericUSBXHCI is not compatible with OS 10.10\n");
return KERN_FAILURE;
}
#endif
#endif
#ifdef __LP64__
if (thisKernelVersion >= MakeKernelVersion(12, 5, 0))
gux_options |= GUX_OPTION_MAVERICKS;
if (thisKernelVersion >= MakeKernelVersion(14, 0, 0))
gux_options |= GUX_OPTION_YOSEMITE;
#endif
if (PE_parse_boot_argn("-gux_nosleep", &v, sizeof v))
gux_options |= GUX_OPTION_NO_SLEEP;
if (PE_parse_boot_argn("-gux_defer_usb2", &v, sizeof v))
gux_options |= GUX_OPTION_DEFER_INTEL_EHC_PORTS;
if (PE_parse_boot_argn("-gux_nomsi", &v, sizeof v))
gux_options |= GUX_OPTION_NO_MSI;
if (PE_parse_boot_argn("gux_log", &v, sizeof v))
gux_log_level = static_cast<int>(v);
return KERN_SUCCESS;
}
__attribute__((visibility("hidden")))
void ListOptions(PrintSink* pSink)
{
/*
* Note: Keep this in sync with Startup
*/
pSink->print("Kernel Flags\n");
pSink->print(" -gux_nosleep: Disable XHCI suspend/resume method, and use reset-on-resume (forces USB Bus re-enumeration)\n");
pSink->print(" -gux_nomsi: Disable MSI and use pin interrupt (if available)\n");
pSink->print(" -gux_defer_usb2: For Intel Series 7/C210 or Intel Series 8/C220 - Switch USB 2.0 protocol ports from xHC to EHC\n");
pSink->print(" gux_log=n: Set logging level to n. Available levels 1 - normal, 2 - higher\n\n");
pSink->print("Properties in Info.plist personality\n");
pSink->print(" DisableUAS (boolean) - disables USB Attached SCSI\n");
pSink->print(" ASMediaEDLTAFix (boolean) - enables workaround for ASM 1042 EDTLA bug\n");
pSink->print(" UseLegacyInt (boolean) - override selection of pin interrupt or MSI\n");
pSink->print(" IntelDoze (boolean) - For Intel Series 7/C210 only - enables use of Doze mode\n");
}
}