xref: /xnu-12377.41.6/iokit/Kernel/IOInterruptController.cpp (revision bbb1b6f9e71b8cdde6e5cd6f4841f207dee3d828)
1*bbb1b6f9SApple OSS Distributions /*
2*bbb1b6f9SApple OSS Distributions  * Copyright (c) 2007-2012 Apple Inc. All rights reserved.
3*bbb1b6f9SApple OSS Distributions  * Copyright (c) 1998-2006 Apple Computer, Inc. All rights reserved.
4*bbb1b6f9SApple OSS Distributions  *
5*bbb1b6f9SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
6*bbb1b6f9SApple OSS Distributions  *
7*bbb1b6f9SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
8*bbb1b6f9SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
9*bbb1b6f9SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
10*bbb1b6f9SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
11*bbb1b6f9SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
12*bbb1b6f9SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
13*bbb1b6f9SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
14*bbb1b6f9SApple OSS Distributions  * terms of an Apple operating system software license agreement.
15*bbb1b6f9SApple OSS Distributions  *
16*bbb1b6f9SApple OSS Distributions  * Please obtain a copy of the License at
17*bbb1b6f9SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
18*bbb1b6f9SApple OSS Distributions  *
19*bbb1b6f9SApple OSS Distributions  * The Original Code and all software distributed under the License are
20*bbb1b6f9SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
21*bbb1b6f9SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
22*bbb1b6f9SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
23*bbb1b6f9SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
24*bbb1b6f9SApple OSS Distributions  * Please see the License for the specific language governing rights and
25*bbb1b6f9SApple OSS Distributions  * limitations under the License.
26*bbb1b6f9SApple OSS Distributions  *
27*bbb1b6f9SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
28*bbb1b6f9SApple OSS Distributions  */
29*bbb1b6f9SApple OSS Distributions 
30*bbb1b6f9SApple OSS Distributions #include <IOKit/IOLib.h>
31*bbb1b6f9SApple OSS Distributions #include <IOKit/IOService.h>
32*bbb1b6f9SApple OSS Distributions #include <IOKit/IOPlatformExpert.h>
33*bbb1b6f9SApple OSS Distributions #include <IOKit/IODeviceTreeSupport.h>
34*bbb1b6f9SApple OSS Distributions #include <IOKit/IOInterrupts.h>
35*bbb1b6f9SApple OSS Distributions #include <IOKit/IOInterruptController.h>
36*bbb1b6f9SApple OSS Distributions #include <IOKit/IOKitDebug.h>
37*bbb1b6f9SApple OSS Distributions #include <IOKit/IOTimeStamp.h>
38*bbb1b6f9SApple OSS Distributions 
39*bbb1b6f9SApple OSS Distributions 
40*bbb1b6f9SApple OSS Distributions /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
41*bbb1b6f9SApple OSS Distributions 
42*bbb1b6f9SApple OSS Distributions #define super IOService
43*bbb1b6f9SApple OSS Distributions 
44*bbb1b6f9SApple OSS Distributions OSDefineMetaClassAndAbstractStructors(IOInterruptController, IOService);
45*bbb1b6f9SApple OSS Distributions 
46*bbb1b6f9SApple OSS Distributions OSMetaClassDefineReservedUsedX86(IOInterruptController, 0);
47*bbb1b6f9SApple OSS Distributions OSMetaClassDefineReservedUsedX86(IOInterruptController, 1);
48*bbb1b6f9SApple OSS Distributions OSMetaClassDefineReservedUsedX86(IOInterruptController, 2);
49*bbb1b6f9SApple OSS Distributions OSMetaClassDefineReservedUnused(IOInterruptController, 3);
50*bbb1b6f9SApple OSS Distributions OSMetaClassDefineReservedUnused(IOInterruptController, 4);
51*bbb1b6f9SApple OSS Distributions OSMetaClassDefineReservedUnused(IOInterruptController, 5);
52*bbb1b6f9SApple OSS Distributions 
53*bbb1b6f9SApple OSS Distributions /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
54*bbb1b6f9SApple OSS Distributions 
55*bbb1b6f9SApple OSS Distributions IOReturn
registerInterrupt(IOService * nub,int source,void * target,IOInterruptHandler handler,void * refCon)56*bbb1b6f9SApple OSS Distributions IOInterruptController::registerInterrupt(IOService *nub, int source,
57*bbb1b6f9SApple OSS Distributions     void *target,
58*bbb1b6f9SApple OSS Distributions     IOInterruptHandler handler,
59*bbb1b6f9SApple OSS Distributions     void *refCon)
60*bbb1b6f9SApple OSS Distributions {
61*bbb1b6f9SApple OSS Distributions 	IOInterruptSource *interruptSources;
62*bbb1b6f9SApple OSS Distributions 	IOInterruptVectorNumber vectorNumber;
63*bbb1b6f9SApple OSS Distributions 	IOInterruptVector *vector;
64*bbb1b6f9SApple OSS Distributions 	int               wasDisabledSoft;
65*bbb1b6f9SApple OSS Distributions 	IOReturn          error;
66*bbb1b6f9SApple OSS Distributions 	OSData            *vectorData;
67*bbb1b6f9SApple OSS Distributions 	IOOptionBits      options;
68*bbb1b6f9SApple OSS Distributions 	bool              canBeShared, shouldBeShared, wasAlreadyRegisterd;
69*bbb1b6f9SApple OSS Distributions 
70*bbb1b6f9SApple OSS Distributions 	IOService         *originalNub = NULL;// Protected by wasAlreadyRegisterd
71*bbb1b6f9SApple OSS Distributions 	int               originalSource = 0;// Protected by wasAlreadyRegisterd
72*bbb1b6f9SApple OSS Distributions 
73*bbb1b6f9SApple OSS Distributions 
74*bbb1b6f9SApple OSS Distributions 	interruptSources = nub->_interruptSources;
75*bbb1b6f9SApple OSS Distributions 	vectorData = interruptSources[source].vectorData;
76*bbb1b6f9SApple OSS Distributions 	vectorNumber = *(IOInterruptVectorNumber *)vectorData->getBytesNoCopy();
77*bbb1b6f9SApple OSS Distributions 	vector = &vectors[vectorNumber];
78*bbb1b6f9SApple OSS Distributions 
79*bbb1b6f9SApple OSS Distributions 	// Get the lock for this vector.
80*bbb1b6f9SApple OSS Distributions 	IOLockLock(vector->interruptLock);
81*bbb1b6f9SApple OSS Distributions 
82*bbb1b6f9SApple OSS Distributions 	// Check if the interrupt source can/should be shared.
83*bbb1b6f9SApple OSS Distributions 	canBeShared = vectorCanBeShared(vectorNumber, vector);
84*bbb1b6f9SApple OSS Distributions 	IODTGetInterruptOptions(nub, source, &options);
85*bbb1b6f9SApple OSS Distributions #if defined(__i386__) || defined(__x86_64__)
86*bbb1b6f9SApple OSS Distributions 	int   interruptType;
87*bbb1b6f9SApple OSS Distributions 	if (OSDynamicCast(IOPlatformDevice, getProvider()) &&
88*bbb1b6f9SApple OSS Distributions 	    (getInterruptType(nub, source, &interruptType) == kIOReturnSuccess) &&
89*bbb1b6f9SApple OSS Distributions 	    (kIOInterruptTypeLevel & interruptType)) {
90*bbb1b6f9SApple OSS Distributions 		options |= kIODTInterruptShared;
91*bbb1b6f9SApple OSS Distributions 	}
92*bbb1b6f9SApple OSS Distributions #endif
93*bbb1b6f9SApple OSS Distributions 	shouldBeShared = canBeShared && (options & kIODTInterruptShared);
94*bbb1b6f9SApple OSS Distributions 	wasAlreadyRegisterd = vector->interruptRegistered;
95*bbb1b6f9SApple OSS Distributions 
96*bbb1b6f9SApple OSS Distributions 	// If the vector is registered and can not be shared return error.
97*bbb1b6f9SApple OSS Distributions 	if (wasAlreadyRegisterd && !canBeShared) {
98*bbb1b6f9SApple OSS Distributions 		IOLockUnlock(vector->interruptLock);
99*bbb1b6f9SApple OSS Distributions 		return kIOReturnNoResources;
100*bbb1b6f9SApple OSS Distributions 	}
101*bbb1b6f9SApple OSS Distributions 
102*bbb1b6f9SApple OSS Distributions 	// If this vector is already in use, and can be shared (implied),
103*bbb1b6f9SApple OSS Distributions 	// or it is not registered and should be shared,
104*bbb1b6f9SApple OSS Distributions 	// register as a shared interrupt.
105*bbb1b6f9SApple OSS Distributions 	if (wasAlreadyRegisterd || shouldBeShared) {
106*bbb1b6f9SApple OSS Distributions 		// If this vector is not already shared, break it out.
107*bbb1b6f9SApple OSS Distributions 		if (vector->sharedController == NULL) {
108*bbb1b6f9SApple OSS Distributions 			// Make the IOShareInterruptController instance
109*bbb1b6f9SApple OSS Distributions 			vector->sharedController = new IOSharedInterruptController;
110*bbb1b6f9SApple OSS Distributions 			if (vector->sharedController == NULL) {
111*bbb1b6f9SApple OSS Distributions 				IOLockUnlock(vector->interruptLock);
112*bbb1b6f9SApple OSS Distributions 				return kIOReturnNoMemory;
113*bbb1b6f9SApple OSS Distributions 			}
114*bbb1b6f9SApple OSS Distributions 
115*bbb1b6f9SApple OSS Distributions 			if (wasAlreadyRegisterd) {
116*bbb1b6f9SApple OSS Distributions 				// Save the nub and source for the original consumer.
117*bbb1b6f9SApple OSS Distributions 				originalNub = vector->nub;
118*bbb1b6f9SApple OSS Distributions 				originalSource = vector->source;
119*bbb1b6f9SApple OSS Distributions 
120*bbb1b6f9SApple OSS Distributions 				// Physically disable the interrupt, but mark it as being enabled in the hardware.
121*bbb1b6f9SApple OSS Distributions 				// The interruptDisabledSoft now indicates the driver's request for enablement.
122*bbb1b6f9SApple OSS Distributions 				disableVectorHard(vectorNumber, vector);
123*bbb1b6f9SApple OSS Distributions 				vector->interruptDisabledHard = 0;
124*bbb1b6f9SApple OSS Distributions 			}
125*bbb1b6f9SApple OSS Distributions 
126*bbb1b6f9SApple OSS Distributions 			// Initialize the new shared interrupt controller.
127*bbb1b6f9SApple OSS Distributions 			error = vector->sharedController->initInterruptController(this, vectorData);
128*bbb1b6f9SApple OSS Distributions 			// If the IOSharedInterruptController could not be initalized,
129*bbb1b6f9SApple OSS Distributions 			// if needed, put the original consumer's interrupt back to normal and
130*bbb1b6f9SApple OSS Distributions 			// get rid of whats left of the shared controller.
131*bbb1b6f9SApple OSS Distributions 			if (error != kIOReturnSuccess) {
132*bbb1b6f9SApple OSS Distributions 				if (wasAlreadyRegisterd) {
133*bbb1b6f9SApple OSS Distributions 					enableInterrupt(originalNub, originalSource);
134*bbb1b6f9SApple OSS Distributions 				}
135*bbb1b6f9SApple OSS Distributions 				vector->sharedController->release();
136*bbb1b6f9SApple OSS Distributions 				vector->sharedController = NULL;
137*bbb1b6f9SApple OSS Distributions 				IOLockUnlock(vector->interruptLock);
138*bbb1b6f9SApple OSS Distributions 				return error;
139*bbb1b6f9SApple OSS Distributions 			}
140*bbb1b6f9SApple OSS Distributions 
141*bbb1b6f9SApple OSS Distributions 			// If there was an original consumer try to register it on the shared controller.
142*bbb1b6f9SApple OSS Distributions 			if (wasAlreadyRegisterd) {
143*bbb1b6f9SApple OSS Distributions 				error = vector->sharedController->registerInterrupt(originalNub,
144*bbb1b6f9SApple OSS Distributions 				    originalSource,
145*bbb1b6f9SApple OSS Distributions 				    vector->target,
146*bbb1b6f9SApple OSS Distributions 				    vector->handler,
147*bbb1b6f9SApple OSS Distributions 				    vector->refCon);
148*bbb1b6f9SApple OSS Distributions 				// If the original consumer could not be moved to the shared controller,
149*bbb1b6f9SApple OSS Distributions 				// put the original consumor's interrupt back to normal and
150*bbb1b6f9SApple OSS Distributions 				// get rid of whats left of the shared controller.
151*bbb1b6f9SApple OSS Distributions 				if (error != kIOReturnSuccess) {
152*bbb1b6f9SApple OSS Distributions 					// Save the driver's interrupt enablement state.
153*bbb1b6f9SApple OSS Distributions 					wasDisabledSoft = vector->interruptDisabledSoft;
154*bbb1b6f9SApple OSS Distributions 
155*bbb1b6f9SApple OSS Distributions 					// Make the interrupt really hard disabled.
156*bbb1b6f9SApple OSS Distributions 					vector->interruptDisabledSoft = 1;
157*bbb1b6f9SApple OSS Distributions 					vector->interruptDisabledHard = 1;
158*bbb1b6f9SApple OSS Distributions 
159*bbb1b6f9SApple OSS Distributions 					// Enable the original consumer's interrupt if needed.
160*bbb1b6f9SApple OSS Distributions 					if (!wasDisabledSoft) {
161*bbb1b6f9SApple OSS Distributions 						originalNub->enableInterrupt(originalSource);
162*bbb1b6f9SApple OSS Distributions 					}
163*bbb1b6f9SApple OSS Distributions 					enableInterrupt(originalNub, originalSource);
164*bbb1b6f9SApple OSS Distributions 
165*bbb1b6f9SApple OSS Distributions 					vector->sharedController->release();
166*bbb1b6f9SApple OSS Distributions 					vector->sharedController = NULL;
167*bbb1b6f9SApple OSS Distributions 					IOLockUnlock(vector->interruptLock);
168*bbb1b6f9SApple OSS Distributions 					return error;
169*bbb1b6f9SApple OSS Distributions 				}
170*bbb1b6f9SApple OSS Distributions 			}
171*bbb1b6f9SApple OSS Distributions 
172*bbb1b6f9SApple OSS Distributions 			// Fill in vector with the shared controller's info.
173*bbb1b6f9SApple OSS Distributions 			vector->handler = (IOInterruptHandler)vector->sharedController->getInterruptHandlerAddress();
174*bbb1b6f9SApple OSS Distributions 			vector->nub     = vector->sharedController;
175*bbb1b6f9SApple OSS Distributions 			vector->source  = 0;
176*bbb1b6f9SApple OSS Distributions 			vector->target  = vector->sharedController;
177*bbb1b6f9SApple OSS Distributions 			vector->refCon  = NULL;
178*bbb1b6f9SApple OSS Distributions 
179*bbb1b6f9SApple OSS Distributions 			// If the interrupt was already registered,
180*bbb1b6f9SApple OSS Distributions 			// save the driver's interrupt enablement state.
181*bbb1b6f9SApple OSS Distributions 			if (wasAlreadyRegisterd) {
182*bbb1b6f9SApple OSS Distributions 				wasDisabledSoft = vector->interruptDisabledSoft;
183*bbb1b6f9SApple OSS Distributions 			} else {
184*bbb1b6f9SApple OSS Distributions 				wasDisabledSoft = true;
185*bbb1b6f9SApple OSS Distributions 			}
186*bbb1b6f9SApple OSS Distributions 
187*bbb1b6f9SApple OSS Distributions 			// Do any specific initalization for this vector if it has not yet been used.
188*bbb1b6f9SApple OSS Distributions 			if (!wasAlreadyRegisterd) {
189*bbb1b6f9SApple OSS Distributions 				initVector(vectorNumber, vector);
190*bbb1b6f9SApple OSS Distributions 			}
191*bbb1b6f9SApple OSS Distributions 
192*bbb1b6f9SApple OSS Distributions 			// Make the interrupt really hard disabled.
193*bbb1b6f9SApple OSS Distributions 			vector->interruptDisabledSoft = 1;
194*bbb1b6f9SApple OSS Distributions 			vector->interruptDisabledHard = 1;
195*bbb1b6f9SApple OSS Distributions 			vector->interruptRegistered   = 1;
196*bbb1b6f9SApple OSS Distributions 
197*bbb1b6f9SApple OSS Distributions 			// Enable the original consumer's interrupt if needed.
198*bbb1b6f9SApple OSS Distributions 			// originalNub is protected by wasAlreadyRegisterd here (see line 184).
199*bbb1b6f9SApple OSS Distributions 			if (!wasDisabledSoft) {
200*bbb1b6f9SApple OSS Distributions 				originalNub->enableInterrupt(originalSource);
201*bbb1b6f9SApple OSS Distributions 			}
202*bbb1b6f9SApple OSS Distributions 		}
203*bbb1b6f9SApple OSS Distributions 
204*bbb1b6f9SApple OSS Distributions 		error = vector->sharedController->registerInterrupt(nub, source, target,
205*bbb1b6f9SApple OSS Distributions 		    handler, refCon);
206*bbb1b6f9SApple OSS Distributions 		IOLockUnlock(vector->interruptLock);
207*bbb1b6f9SApple OSS Distributions 		return error;
208*bbb1b6f9SApple OSS Distributions 	}
209*bbb1b6f9SApple OSS Distributions 
210*bbb1b6f9SApple OSS Distributions 	// Fill in vector with the client's info.
211*bbb1b6f9SApple OSS Distributions 	vector->handler = handler;
212*bbb1b6f9SApple OSS Distributions 	vector->nub     = nub;
213*bbb1b6f9SApple OSS Distributions 	vector->source  = source;
214*bbb1b6f9SApple OSS Distributions 	vector->target  = target;
215*bbb1b6f9SApple OSS Distributions 	vector->refCon  = refCon;
216*bbb1b6f9SApple OSS Distributions 
217*bbb1b6f9SApple OSS Distributions 	// Do any specific initalization for this vector.
218*bbb1b6f9SApple OSS Distributions 	initVector(vectorNumber, vector);
219*bbb1b6f9SApple OSS Distributions 
220*bbb1b6f9SApple OSS Distributions 	// Get the vector ready.  It starts hard disabled.
221*bbb1b6f9SApple OSS Distributions 	vector->interruptDisabledHard = 1;
222*bbb1b6f9SApple OSS Distributions 	vector->interruptDisabledSoft = 1;
223*bbb1b6f9SApple OSS Distributions 	vector->interruptRegistered   = 1;
224*bbb1b6f9SApple OSS Distributions 
225*bbb1b6f9SApple OSS Distributions 	IOLockUnlock(vector->interruptLock);
226*bbb1b6f9SApple OSS Distributions 	return kIOReturnSuccess;
227*bbb1b6f9SApple OSS Distributions }
228*bbb1b6f9SApple OSS Distributions 
229*bbb1b6f9SApple OSS Distributions IOReturn
unregisterInterrupt(IOService * nub,int source)230*bbb1b6f9SApple OSS Distributions IOInterruptController::unregisterInterrupt(IOService *nub, int source)
231*bbb1b6f9SApple OSS Distributions {
232*bbb1b6f9SApple OSS Distributions 	IOInterruptSource *interruptSources;
233*bbb1b6f9SApple OSS Distributions 	IOInterruptVectorNumber vectorNumber;
234*bbb1b6f9SApple OSS Distributions 	IOInterruptVector *vector;
235*bbb1b6f9SApple OSS Distributions 	OSData            *vectorData;
236*bbb1b6f9SApple OSS Distributions 
237*bbb1b6f9SApple OSS Distributions 	interruptSources = nub->_interruptSources;
238*bbb1b6f9SApple OSS Distributions 	vectorData = interruptSources[source].vectorData;
239*bbb1b6f9SApple OSS Distributions 	vectorNumber = *(IOInterruptVectorNumber *)vectorData->getBytesNoCopy();
240*bbb1b6f9SApple OSS Distributions 	vector = &vectors[vectorNumber];
241*bbb1b6f9SApple OSS Distributions 
242*bbb1b6f9SApple OSS Distributions 	// Get the lock for this vector.
243*bbb1b6f9SApple OSS Distributions 	IOLockLock(vector->interruptLock);
244*bbb1b6f9SApple OSS Distributions 
245*bbb1b6f9SApple OSS Distributions 	// Return success if it is not already registered
246*bbb1b6f9SApple OSS Distributions 	if (!vector->interruptRegistered) {
247*bbb1b6f9SApple OSS Distributions 		IOLockUnlock(vector->interruptLock);
248*bbb1b6f9SApple OSS Distributions 		return kIOReturnSuccess;
249*bbb1b6f9SApple OSS Distributions 	}
250*bbb1b6f9SApple OSS Distributions 
251*bbb1b6f9SApple OSS Distributions 	// Soft disable the source.
252*bbb1b6f9SApple OSS Distributions 	disableInterrupt(nub, source);
253*bbb1b6f9SApple OSS Distributions 
254*bbb1b6f9SApple OSS Distributions 	// Turn the source off at hardware.
255*bbb1b6f9SApple OSS Distributions 	disableVectorHard(vectorNumber, vector);
256*bbb1b6f9SApple OSS Distributions 
257*bbb1b6f9SApple OSS Distributions 	// Clear all the storage for the vector except for interruptLock.
258*bbb1b6f9SApple OSS Distributions 	vector->interruptActive = 0;
259*bbb1b6f9SApple OSS Distributions 	vector->interruptDisabledSoft = 0;
260*bbb1b6f9SApple OSS Distributions 	vector->interruptDisabledHard = 0;
261*bbb1b6f9SApple OSS Distributions 	vector->interruptRegistered = 0;
262*bbb1b6f9SApple OSS Distributions 	vector->nub = NULL;
263*bbb1b6f9SApple OSS Distributions 	vector->source = 0;
264*bbb1b6f9SApple OSS Distributions 	vector->handler = NULL;
265*bbb1b6f9SApple OSS Distributions 	vector->target = NULL;
266*bbb1b6f9SApple OSS Distributions 	vector->refCon = NULL;
267*bbb1b6f9SApple OSS Distributions 
268*bbb1b6f9SApple OSS Distributions 	IOLockUnlock(vector->interruptLock);
269*bbb1b6f9SApple OSS Distributions 	return kIOReturnSuccess;
270*bbb1b6f9SApple OSS Distributions }
271*bbb1b6f9SApple OSS Distributions 
272*bbb1b6f9SApple OSS Distributions IOReturn
getInterruptType(IOService * nub,int source,int * interruptType)273*bbb1b6f9SApple OSS Distributions IOInterruptController::getInterruptType(IOService *nub, int source,
274*bbb1b6f9SApple OSS Distributions     int *interruptType)
275*bbb1b6f9SApple OSS Distributions {
276*bbb1b6f9SApple OSS Distributions 	IOInterruptSource *interruptSources;
277*bbb1b6f9SApple OSS Distributions 	IOInterruptVectorNumber vectorNumber;
278*bbb1b6f9SApple OSS Distributions 	IOInterruptVector *vector;
279*bbb1b6f9SApple OSS Distributions 	OSData            *vectorData;
280*bbb1b6f9SApple OSS Distributions 
281*bbb1b6f9SApple OSS Distributions 	if (interruptType == NULL) {
282*bbb1b6f9SApple OSS Distributions 		return kIOReturnBadArgument;
283*bbb1b6f9SApple OSS Distributions 	}
284*bbb1b6f9SApple OSS Distributions 
285*bbb1b6f9SApple OSS Distributions 	interruptSources = nub->_interruptSources;
286*bbb1b6f9SApple OSS Distributions 	vectorData = interruptSources[source].vectorData;
287*bbb1b6f9SApple OSS Distributions 	vectorNumber = *(IOInterruptVectorNumber *)vectorData->getBytesNoCopy();
288*bbb1b6f9SApple OSS Distributions 	vector = &vectors[vectorNumber];
289*bbb1b6f9SApple OSS Distributions 
290*bbb1b6f9SApple OSS Distributions 	*interruptType = getVectorType(vectorNumber, vector);
291*bbb1b6f9SApple OSS Distributions 
292*bbb1b6f9SApple OSS Distributions 	return kIOReturnSuccess;
293*bbb1b6f9SApple OSS Distributions }
294*bbb1b6f9SApple OSS Distributions 
295*bbb1b6f9SApple OSS Distributions IOReturn
enableInterrupt(IOService * nub,int source)296*bbb1b6f9SApple OSS Distributions IOInterruptController::enableInterrupt(IOService *nub, int source)
297*bbb1b6f9SApple OSS Distributions {
298*bbb1b6f9SApple OSS Distributions 	IOInterruptSource *interruptSources;
299*bbb1b6f9SApple OSS Distributions 	IOInterruptVectorNumber vectorNumber;
300*bbb1b6f9SApple OSS Distributions 	IOInterruptVector *vector;
301*bbb1b6f9SApple OSS Distributions 	OSData            *vectorData;
302*bbb1b6f9SApple OSS Distributions 
303*bbb1b6f9SApple OSS Distributions 	interruptSources = nub->_interruptSources;
304*bbb1b6f9SApple OSS Distributions 	vectorData = interruptSources[source].vectorData;
305*bbb1b6f9SApple OSS Distributions 	vectorNumber = *(IOInterruptVectorNumber *)vectorData->getBytesNoCopy();
306*bbb1b6f9SApple OSS Distributions 	vector = &vectors[vectorNumber];
307*bbb1b6f9SApple OSS Distributions 
308*bbb1b6f9SApple OSS Distributions 	if (vector->interruptDisabledSoft) {
309*bbb1b6f9SApple OSS Distributions 		vector->interruptDisabledSoft = 0;
310*bbb1b6f9SApple OSS Distributions #if !defined(__i386__) && !defined(__x86_64__)
311*bbb1b6f9SApple OSS Distributions 		OSMemoryBarrier();
312*bbb1b6f9SApple OSS Distributions #endif
313*bbb1b6f9SApple OSS Distributions 
314*bbb1b6f9SApple OSS Distributions 		if (!getPlatform()->atInterruptLevel()) {
315*bbb1b6f9SApple OSS Distributions 			while (vector->interruptActive) {
316*bbb1b6f9SApple OSS Distributions 			}
317*bbb1b6f9SApple OSS Distributions 		}
318*bbb1b6f9SApple OSS Distributions 		if (vector->interruptDisabledHard) {
319*bbb1b6f9SApple OSS Distributions 			vector->interruptDisabledHard = 0;
320*bbb1b6f9SApple OSS Distributions 
321*bbb1b6f9SApple OSS Distributions 			// A DSB ISH on ARM is needed to make sure the vector data are
322*bbb1b6f9SApple OSS Distributions 			// properly initialized before the MMIO enabling the interrupts
323*bbb1b6f9SApple OSS Distributions 			// in hardware. OSMemoryBarrier(), which maps to DMB, is not
324*bbb1b6f9SApple OSS Distributions 			// sufficient here as the CPUs are not consumers of the device
325*bbb1b6f9SApple OSS Distributions 			// write. Hence, the DMB does not guarantee the CPUs won't see an
326*bbb1b6f9SApple OSS Distributions 			// interrupt before it initalizes the vector data properly.
327*bbb1b6f9SApple OSS Distributions 			OSSynchronizeIO();
328*bbb1b6f9SApple OSS Distributions 
329*bbb1b6f9SApple OSS Distributions 			enableVector(vectorNumber, vector);
330*bbb1b6f9SApple OSS Distributions 		}
331*bbb1b6f9SApple OSS Distributions 	}
332*bbb1b6f9SApple OSS Distributions 
333*bbb1b6f9SApple OSS Distributions 	return kIOReturnSuccess;
334*bbb1b6f9SApple OSS Distributions }
335*bbb1b6f9SApple OSS Distributions 
336*bbb1b6f9SApple OSS Distributions IOReturn
disableInterrupt(IOService * nub,int source)337*bbb1b6f9SApple OSS Distributions IOInterruptController::disableInterrupt(IOService *nub, int source)
338*bbb1b6f9SApple OSS Distributions {
339*bbb1b6f9SApple OSS Distributions 	IOInterruptSource *interruptSources;
340*bbb1b6f9SApple OSS Distributions 	IOInterruptVectorNumber vectorNumber;
341*bbb1b6f9SApple OSS Distributions 	IOInterruptVector *vector;
342*bbb1b6f9SApple OSS Distributions 	OSData            *vectorData;
343*bbb1b6f9SApple OSS Distributions 
344*bbb1b6f9SApple OSS Distributions 	interruptSources = nub->_interruptSources;
345*bbb1b6f9SApple OSS Distributions 	vectorData = interruptSources[source].vectorData;
346*bbb1b6f9SApple OSS Distributions 	vectorNumber = *(IOInterruptVectorNumber *)vectorData->getBytesNoCopy();
347*bbb1b6f9SApple OSS Distributions 	vector = &vectors[vectorNumber];
348*bbb1b6f9SApple OSS Distributions 
349*bbb1b6f9SApple OSS Distributions 	vector->interruptDisabledSoft = 1;
350*bbb1b6f9SApple OSS Distributions #if !defined(__i386__) && !defined(__x86_64__)
351*bbb1b6f9SApple OSS Distributions 	OSMemoryBarrier();
352*bbb1b6f9SApple OSS Distributions #endif
353*bbb1b6f9SApple OSS Distributions 
354*bbb1b6f9SApple OSS Distributions 	if (!getPlatform()->atInterruptLevel()) {
355*bbb1b6f9SApple OSS Distributions 		while (vector->interruptActive) {
356*bbb1b6f9SApple OSS Distributions 		}
357*bbb1b6f9SApple OSS Distributions 	}
358*bbb1b6f9SApple OSS Distributions 
359*bbb1b6f9SApple OSS Distributions 	return kIOReturnSuccess;
360*bbb1b6f9SApple OSS Distributions }
361*bbb1b6f9SApple OSS Distributions 
362*bbb1b6f9SApple OSS Distributions IOReturn
causeInterrupt(IOService * nub,int source)363*bbb1b6f9SApple OSS Distributions IOInterruptController::causeInterrupt(IOService *nub, int source)
364*bbb1b6f9SApple OSS Distributions {
365*bbb1b6f9SApple OSS Distributions 	IOInterruptSource *interruptSources;
366*bbb1b6f9SApple OSS Distributions 	IOInterruptVectorNumber vectorNumber;
367*bbb1b6f9SApple OSS Distributions 	IOInterruptVector *vector;
368*bbb1b6f9SApple OSS Distributions 	OSData            *vectorData;
369*bbb1b6f9SApple OSS Distributions 
370*bbb1b6f9SApple OSS Distributions 	interruptSources = nub->_interruptSources;
371*bbb1b6f9SApple OSS Distributions 	vectorData = interruptSources[source].vectorData;
372*bbb1b6f9SApple OSS Distributions 	vectorNumber = *(IOInterruptVectorNumber *)vectorData->getBytesNoCopy();
373*bbb1b6f9SApple OSS Distributions 	vector = &vectors[vectorNumber];
374*bbb1b6f9SApple OSS Distributions 
375*bbb1b6f9SApple OSS Distributions 	causeVector(vectorNumber, vector);
376*bbb1b6f9SApple OSS Distributions 
377*bbb1b6f9SApple OSS Distributions 	return kIOReturnSuccess;
378*bbb1b6f9SApple OSS Distributions }
379*bbb1b6f9SApple OSS Distributions 
380*bbb1b6f9SApple OSS Distributions IOInterruptAction
getInterruptHandlerAddress(void)381*bbb1b6f9SApple OSS Distributions IOInterruptController::getInterruptHandlerAddress(void)
382*bbb1b6f9SApple OSS Distributions {
383*bbb1b6f9SApple OSS Distributions 	return NULL;
384*bbb1b6f9SApple OSS Distributions }
385*bbb1b6f9SApple OSS Distributions 
386*bbb1b6f9SApple OSS Distributions IOReturn
handleInterrupt(void * refCon,IOService * nub,int source)387*bbb1b6f9SApple OSS Distributions IOInterruptController::handleInterrupt(void *refCon, IOService *nub,
388*bbb1b6f9SApple OSS Distributions     int source)
389*bbb1b6f9SApple OSS Distributions {
390*bbb1b6f9SApple OSS Distributions 	return kIOReturnInvalid;
391*bbb1b6f9SApple OSS Distributions }
392*bbb1b6f9SApple OSS Distributions 
393*bbb1b6f9SApple OSS Distributions 
394*bbb1b6f9SApple OSS Distributions // Methods to be overridden for simplifed interrupt controller subclasses.
395*bbb1b6f9SApple OSS Distributions 
396*bbb1b6f9SApple OSS Distributions bool
vectorCanBeShared(IOInterruptVectorNumber,IOInterruptVector *)397*bbb1b6f9SApple OSS Distributions IOInterruptController::vectorCanBeShared(IOInterruptVectorNumber /*vectorNumber*/,
398*bbb1b6f9SApple OSS Distributions     IOInterruptVector */*vector*/)
399*bbb1b6f9SApple OSS Distributions {
400*bbb1b6f9SApple OSS Distributions 	return false;
401*bbb1b6f9SApple OSS Distributions }
402*bbb1b6f9SApple OSS Distributions 
403*bbb1b6f9SApple OSS Distributions void
initVector(IOInterruptVectorNumber,IOInterruptVector *)404*bbb1b6f9SApple OSS Distributions IOInterruptController::initVector(IOInterruptVectorNumber /*vectorNumber*/,
405*bbb1b6f9SApple OSS Distributions     IOInterruptVector */*vector*/)
406*bbb1b6f9SApple OSS Distributions {
407*bbb1b6f9SApple OSS Distributions }
408*bbb1b6f9SApple OSS Distributions 
409*bbb1b6f9SApple OSS Distributions int
getVectorType(IOInterruptVectorNumber,IOInterruptVector *)410*bbb1b6f9SApple OSS Distributions IOInterruptController::getVectorType(IOInterruptVectorNumber /*vectorNumber*/,
411*bbb1b6f9SApple OSS Distributions     IOInterruptVector */*vector*/)
412*bbb1b6f9SApple OSS Distributions {
413*bbb1b6f9SApple OSS Distributions 	return kIOInterruptTypeEdge;
414*bbb1b6f9SApple OSS Distributions }
415*bbb1b6f9SApple OSS Distributions 
416*bbb1b6f9SApple OSS Distributions void
disableVectorHard(IOInterruptVectorNumber,IOInterruptVector *)417*bbb1b6f9SApple OSS Distributions IOInterruptController::disableVectorHard(IOInterruptVectorNumber /*vectorNumber*/,
418*bbb1b6f9SApple OSS Distributions     IOInterruptVector */*vector*/)
419*bbb1b6f9SApple OSS Distributions {
420*bbb1b6f9SApple OSS Distributions }
421*bbb1b6f9SApple OSS Distributions 
422*bbb1b6f9SApple OSS Distributions void
enableVector(IOInterruptVectorNumber,IOInterruptVector *)423*bbb1b6f9SApple OSS Distributions IOInterruptController::enableVector(IOInterruptVectorNumber /*vectorNumber*/,
424*bbb1b6f9SApple OSS Distributions     IOInterruptVector */*vector*/)
425*bbb1b6f9SApple OSS Distributions {
426*bbb1b6f9SApple OSS Distributions }
427*bbb1b6f9SApple OSS Distributions 
428*bbb1b6f9SApple OSS Distributions void
causeVector(IOInterruptVectorNumber,IOInterruptVector *)429*bbb1b6f9SApple OSS Distributions IOInterruptController::causeVector(IOInterruptVectorNumber /*vectorNumber*/,
430*bbb1b6f9SApple OSS Distributions     IOInterruptVector */*vector*/)
431*bbb1b6f9SApple OSS Distributions {
432*bbb1b6f9SApple OSS Distributions }
433*bbb1b6f9SApple OSS Distributions 
434*bbb1b6f9SApple OSS Distributions void
setCPUInterruptProperties(IOService *)435*bbb1b6f9SApple OSS Distributions IOInterruptController::setCPUInterruptProperties(IOService */*service*/)
436*bbb1b6f9SApple OSS Distributions {
437*bbb1b6f9SApple OSS Distributions }
438*bbb1b6f9SApple OSS Distributions 
439*bbb1b6f9SApple OSS Distributions void
sendIPI(unsigned int,bool)440*bbb1b6f9SApple OSS Distributions IOInterruptController::sendIPI(unsigned int /*cpu_id*/, bool /*deferred*/)
441*bbb1b6f9SApple OSS Distributions {
442*bbb1b6f9SApple OSS Distributions }
443*bbb1b6f9SApple OSS Distributions 
444*bbb1b6f9SApple OSS Distributions void
cancelDeferredIPI(unsigned int)445*bbb1b6f9SApple OSS Distributions IOInterruptController::cancelDeferredIPI(unsigned int /*cpu_id*/)
446*bbb1b6f9SApple OSS Distributions {
447*bbb1b6f9SApple OSS Distributions }
448*bbb1b6f9SApple OSS Distributions 
449*bbb1b6f9SApple OSS Distributions void
timeStampSpuriousInterrupt(void)450*bbb1b6f9SApple OSS Distributions IOInterruptController::timeStampSpuriousInterrupt(void)
451*bbb1b6f9SApple OSS Distributions {
452*bbb1b6f9SApple OSS Distributions 	uint64_t providerID = 0;
453*bbb1b6f9SApple OSS Distributions 	IOService * provider = getProvider();
454*bbb1b6f9SApple OSS Distributions 
455*bbb1b6f9SApple OSS Distributions 	if (provider) {
456*bbb1b6f9SApple OSS Distributions 		providerID = provider->getRegistryEntryID();
457*bbb1b6f9SApple OSS Distributions 	}
458*bbb1b6f9SApple OSS Distributions 
459*bbb1b6f9SApple OSS Distributions 	IOTimeStampConstant(IODBG_INTC(IOINTC_SPURIOUS), providerID);
460*bbb1b6f9SApple OSS Distributions }
461*bbb1b6f9SApple OSS Distributions 
462*bbb1b6f9SApple OSS Distributions void
timeStampInterruptHandlerInternal(bool isStart,IOInterruptVectorNumber vectorNumber,IOInterruptVector * vector)463*bbb1b6f9SApple OSS Distributions IOInterruptController::timeStampInterruptHandlerInternal(bool isStart, IOInterruptVectorNumber vectorNumber, IOInterruptVector *vector)
464*bbb1b6f9SApple OSS Distributions {
465*bbb1b6f9SApple OSS Distributions 	uint64_t providerID = 0;
466*bbb1b6f9SApple OSS Distributions 	vm_offset_t unslidHandler = 0;
467*bbb1b6f9SApple OSS Distributions 	vm_offset_t unslidTarget = 0;
468*bbb1b6f9SApple OSS Distributions 
469*bbb1b6f9SApple OSS Distributions 	IOService * provider = getProvider();
470*bbb1b6f9SApple OSS Distributions 
471*bbb1b6f9SApple OSS Distributions 	if (provider) {
472*bbb1b6f9SApple OSS Distributions 		providerID = provider->getRegistryEntryID();
473*bbb1b6f9SApple OSS Distributions 	}
474*bbb1b6f9SApple OSS Distributions 
475*bbb1b6f9SApple OSS Distributions 	if (vector) {
476*bbb1b6f9SApple OSS Distributions 		unslidHandler = VM_KERNEL_UNSLIDE((vm_offset_t)vector->handler);
477*bbb1b6f9SApple OSS Distributions 		unslidTarget = VM_KERNEL_UNSLIDE_OR_PERM((vm_offset_t)vector->target);
478*bbb1b6f9SApple OSS Distributions 	}
479*bbb1b6f9SApple OSS Distributions 
480*bbb1b6f9SApple OSS Distributions 
481*bbb1b6f9SApple OSS Distributions 	if (isStart) {
482*bbb1b6f9SApple OSS Distributions #if SCHED_HYGIENE_DEBUG
483*bbb1b6f9SApple OSS Distributions 		ml_irq_debug_start((uintptr_t)vector->handler, (uintptr_t)vector);
484*bbb1b6f9SApple OSS Distributions #endif
485*bbb1b6f9SApple OSS Distributions 		IOTimeStampStartConstant(IODBG_INTC(IOINTC_HANDLER), (uintptr_t)vectorNumber, (uintptr_t)unslidHandler,
486*bbb1b6f9SApple OSS Distributions 		    (uintptr_t)unslidTarget, (uintptr_t)providerID);
487*bbb1b6f9SApple OSS Distributions 	} else {
488*bbb1b6f9SApple OSS Distributions 		IOTimeStampEndConstant(IODBG_INTC(IOINTC_HANDLER), (uintptr_t)vectorNumber, (uintptr_t)unslidHandler,
489*bbb1b6f9SApple OSS Distributions 		    (uintptr_t)unslidTarget, (uintptr_t)providerID);
490*bbb1b6f9SApple OSS Distributions #if SCHED_HYGIENE_DEBUG
491*bbb1b6f9SApple OSS Distributions 		ml_irq_debug_end();
492*bbb1b6f9SApple OSS Distributions #endif
493*bbb1b6f9SApple OSS Distributions 	}
494*bbb1b6f9SApple OSS Distributions }
495*bbb1b6f9SApple OSS Distributions 
496*bbb1b6f9SApple OSS Distributions void
timeStampInterruptHandlerStart(IOInterruptVectorNumber vectorNumber,IOInterruptVector * vector)497*bbb1b6f9SApple OSS Distributions IOInterruptController::timeStampInterruptHandlerStart(IOInterruptVectorNumber vectorNumber, IOInterruptVector *vector)
498*bbb1b6f9SApple OSS Distributions {
499*bbb1b6f9SApple OSS Distributions 	timeStampInterruptHandlerInternal(true, vectorNumber, vector);
500*bbb1b6f9SApple OSS Distributions }
501*bbb1b6f9SApple OSS Distributions 
502*bbb1b6f9SApple OSS Distributions void
timeStampInterruptHandlerEnd(IOInterruptVectorNumber vectorNumber,IOInterruptVector * vector)503*bbb1b6f9SApple OSS Distributions IOInterruptController::timeStampInterruptHandlerEnd(IOInterruptVectorNumber vectorNumber, IOInterruptVector *vector)
504*bbb1b6f9SApple OSS Distributions {
505*bbb1b6f9SApple OSS Distributions 	timeStampInterruptHandlerInternal(false, vectorNumber, vector);
506*bbb1b6f9SApple OSS Distributions }
507*bbb1b6f9SApple OSS Distributions 
508*bbb1b6f9SApple OSS Distributions /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
509*bbb1b6f9SApple OSS Distributions 
510*bbb1b6f9SApple OSS Distributions #undef  super
511*bbb1b6f9SApple OSS Distributions #define super IOInterruptController
512*bbb1b6f9SApple OSS Distributions 
513*bbb1b6f9SApple OSS Distributions OSDefineMetaClassAndStructors(IOSharedInterruptController, IOInterruptController);
514*bbb1b6f9SApple OSS Distributions 
515*bbb1b6f9SApple OSS Distributions OSMetaClassDefineReservedUnused(IOSharedInterruptController, 0);
516*bbb1b6f9SApple OSS Distributions OSMetaClassDefineReservedUnused(IOSharedInterruptController, 1);
517*bbb1b6f9SApple OSS Distributions OSMetaClassDefineReservedUnused(IOSharedInterruptController, 2);
518*bbb1b6f9SApple OSS Distributions OSMetaClassDefineReservedUnused(IOSharedInterruptController, 3);
519*bbb1b6f9SApple OSS Distributions 
520*bbb1b6f9SApple OSS Distributions /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
521*bbb1b6f9SApple OSS Distributions 
522*bbb1b6f9SApple OSS Distributions #define kIOSharedInterruptControllerDefaultVectors (128)
523*bbb1b6f9SApple OSS Distributions 
524*bbb1b6f9SApple OSS Distributions IOReturn
initInterruptController(IOInterruptController * parentController,OSData * parentSource)525*bbb1b6f9SApple OSS Distributions IOSharedInterruptController::initInterruptController(IOInterruptController *parentController, OSData *parentSource)
526*bbb1b6f9SApple OSS Distributions {
527*bbb1b6f9SApple OSS Distributions 	int      cnt, interruptType;
528*bbb1b6f9SApple OSS Distributions 	IOReturn error;
529*bbb1b6f9SApple OSS Distributions 
530*bbb1b6f9SApple OSS Distributions 	if (!super::init()) {
531*bbb1b6f9SApple OSS Distributions 		return kIOReturnNoResources;
532*bbb1b6f9SApple OSS Distributions 	}
533*bbb1b6f9SApple OSS Distributions 
534*bbb1b6f9SApple OSS Distributions 	// Set provider to this so enable/disable nub stuff works.
535*bbb1b6f9SApple OSS Distributions 	provider = this;
536*bbb1b6f9SApple OSS Distributions 
537*bbb1b6f9SApple OSS Distributions 	// Allocate the IOInterruptSource so this can act like a nub.
538*bbb1b6f9SApple OSS Distributions 	_interruptSources = IONew(IOInterruptSource, 1);
539*bbb1b6f9SApple OSS Distributions 	if (_interruptSources == NULL) {
540*bbb1b6f9SApple OSS Distributions 		return kIOReturnNoMemory;
541*bbb1b6f9SApple OSS Distributions 	}
542*bbb1b6f9SApple OSS Distributions 	_numInterruptSources = 1;
543*bbb1b6f9SApple OSS Distributions 
544*bbb1b6f9SApple OSS Distributions 	// Set up the IOInterruptSource to point at this.
545*bbb1b6f9SApple OSS Distributions 	parentController->retain();
546*bbb1b6f9SApple OSS Distributions 	parentSource->retain();
547*bbb1b6f9SApple OSS Distributions 	_interruptSources[0].interruptController = parentController;
548*bbb1b6f9SApple OSS Distributions 	_interruptSources[0].vectorData = parentSource;
549*bbb1b6f9SApple OSS Distributions 
550*bbb1b6f9SApple OSS Distributions 	sourceIsLevel = false;
551*bbb1b6f9SApple OSS Distributions 	error = provider->getInterruptType(0, &interruptType);
552*bbb1b6f9SApple OSS Distributions 	if (error == kIOReturnSuccess) {
553*bbb1b6f9SApple OSS Distributions 		if (interruptType & kIOInterruptTypeLevel) {
554*bbb1b6f9SApple OSS Distributions 			sourceIsLevel = true;
555*bbb1b6f9SApple OSS Distributions 		}
556*bbb1b6f9SApple OSS Distributions 	}
557*bbb1b6f9SApple OSS Distributions 
558*bbb1b6f9SApple OSS Distributions 	// Allocate the memory for the vectors
559*bbb1b6f9SApple OSS Distributions 	numVectors = kIOSharedInterruptControllerDefaultVectors; // For now a constant number.
560*bbb1b6f9SApple OSS Distributions 	vectors = IONewZero(IOInterruptVector, numVectors);
561*bbb1b6f9SApple OSS Distributions 	if (vectors == NULL) {
562*bbb1b6f9SApple OSS Distributions 		IODelete(_interruptSources, IOInterruptSource, 1);
563*bbb1b6f9SApple OSS Distributions 		return kIOReturnNoMemory;
564*bbb1b6f9SApple OSS Distributions 	}
565*bbb1b6f9SApple OSS Distributions 
566*bbb1b6f9SApple OSS Distributions 	// Allocate the lock for the controller.
567*bbb1b6f9SApple OSS Distributions 	controllerLock = IOSimpleLockAlloc();
568*bbb1b6f9SApple OSS Distributions 	if (controllerLock == NULL) {
569*bbb1b6f9SApple OSS Distributions 		return kIOReturnNoResources;
570*bbb1b6f9SApple OSS Distributions 	}
571*bbb1b6f9SApple OSS Distributions 
572*bbb1b6f9SApple OSS Distributions 	// Allocate locks for the vectors.
573*bbb1b6f9SApple OSS Distributions 	for (cnt = 0; cnt < numVectors; cnt++) {
574*bbb1b6f9SApple OSS Distributions 		vectors[cnt].interruptLock = IOLockAlloc();
575*bbb1b6f9SApple OSS Distributions 		if (vectors[cnt].interruptLock == NULL) {
576*bbb1b6f9SApple OSS Distributions 			for (cnt = 0; cnt < numVectors; cnt++) {
577*bbb1b6f9SApple OSS Distributions 				if (vectors[cnt].interruptLock != NULL) {
578*bbb1b6f9SApple OSS Distributions 					IOLockFree(vectors[cnt].interruptLock);
579*bbb1b6f9SApple OSS Distributions 				}
580*bbb1b6f9SApple OSS Distributions 			}
581*bbb1b6f9SApple OSS Distributions 			return kIOReturnNoResources;
582*bbb1b6f9SApple OSS Distributions 		}
583*bbb1b6f9SApple OSS Distributions 	}
584*bbb1b6f9SApple OSS Distributions 
585*bbb1b6f9SApple OSS Distributions 	numVectors = 0; // reset the high water mark for used vectors
586*bbb1b6f9SApple OSS Distributions 	vectorsRegistered = 0;
587*bbb1b6f9SApple OSS Distributions 	vectorsEnabled = 0;
588*bbb1b6f9SApple OSS Distributions 	controllerDisabled = 1;
589*bbb1b6f9SApple OSS Distributions 
590*bbb1b6f9SApple OSS Distributions 	return kIOReturnSuccess;
591*bbb1b6f9SApple OSS Distributions }
592*bbb1b6f9SApple OSS Distributions 
593*bbb1b6f9SApple OSS Distributions IOReturn
registerInterrupt(IOService * nub,int source,void * target,IOInterruptHandler handler,void * refCon)594*bbb1b6f9SApple OSS Distributions IOSharedInterruptController::registerInterrupt(IOService *nub,
595*bbb1b6f9SApple OSS Distributions     int source,
596*bbb1b6f9SApple OSS Distributions     void *target,
597*bbb1b6f9SApple OSS Distributions     IOInterruptHandler handler,
598*bbb1b6f9SApple OSS Distributions     void *refCon)
599*bbb1b6f9SApple OSS Distributions {
600*bbb1b6f9SApple OSS Distributions 	IOInterruptSource *interruptSources;
601*bbb1b6f9SApple OSS Distributions 	IOInterruptVectorNumber vectorNumber;
602*bbb1b6f9SApple OSS Distributions 	IOInterruptVector *vector = NULL;
603*bbb1b6f9SApple OSS Distributions 	OSData            *vectorData;
604*bbb1b6f9SApple OSS Distributions 	IOInterruptState  interruptState;
605*bbb1b6f9SApple OSS Distributions 
606*bbb1b6f9SApple OSS Distributions 	interruptSources = nub->_interruptSources;
607*bbb1b6f9SApple OSS Distributions 
608*bbb1b6f9SApple OSS Distributions 	// Find a free vector.
609*bbb1b6f9SApple OSS Distributions 	vectorNumber = kIOSharedInterruptControllerDefaultVectors;
610*bbb1b6f9SApple OSS Distributions 	while (vectorsRegistered != kIOSharedInterruptControllerDefaultVectors) {
611*bbb1b6f9SApple OSS Distributions 		for (vectorNumber = 0; vectorNumber < kIOSharedInterruptControllerDefaultVectors; vectorNumber++) {
612*bbb1b6f9SApple OSS Distributions 			vector = &vectors[vectorNumber];
613*bbb1b6f9SApple OSS Distributions 
614*bbb1b6f9SApple OSS Distributions 			// Get the lock for this vector.
615*bbb1b6f9SApple OSS Distributions 			IOLockLock(vector->interruptLock);
616*bbb1b6f9SApple OSS Distributions 
617*bbb1b6f9SApple OSS Distributions 			// Is it unregistered?
618*bbb1b6f9SApple OSS Distributions 			if (!vector->interruptRegistered) {
619*bbb1b6f9SApple OSS Distributions 				break;
620*bbb1b6f9SApple OSS Distributions 			}
621*bbb1b6f9SApple OSS Distributions 
622*bbb1b6f9SApple OSS Distributions 			// Move along to the next one.
623*bbb1b6f9SApple OSS Distributions 			IOLockUnlock(vector->interruptLock);
624*bbb1b6f9SApple OSS Distributions 		}
625*bbb1b6f9SApple OSS Distributions 
626*bbb1b6f9SApple OSS Distributions 		if (vectorNumber != kIOSharedInterruptControllerDefaultVectors) {
627*bbb1b6f9SApple OSS Distributions 			break;
628*bbb1b6f9SApple OSS Distributions 		}
629*bbb1b6f9SApple OSS Distributions 	}
630*bbb1b6f9SApple OSS Distributions 
631*bbb1b6f9SApple OSS Distributions 	// Could not find a free one, so give up.
632*bbb1b6f9SApple OSS Distributions 	if (vectorNumber == kIOSharedInterruptControllerDefaultVectors) {
633*bbb1b6f9SApple OSS Distributions 		return kIOReturnNoResources;
634*bbb1b6f9SApple OSS Distributions 	}
635*bbb1b6f9SApple OSS Distributions 
636*bbb1b6f9SApple OSS Distributions 	// Create the vectorData for the IOInterruptSource.
637*bbb1b6f9SApple OSS Distributions 	vectorData = OSData::withValue(vectorNumber);
638*bbb1b6f9SApple OSS Distributions 	if (vectorData == NULL) {
639*bbb1b6f9SApple OSS Distributions 		IOLockUnlock(vector->interruptLock);
640*bbb1b6f9SApple OSS Distributions 		return kIOReturnNoMemory;
641*bbb1b6f9SApple OSS Distributions 	}
642*bbb1b6f9SApple OSS Distributions 
643*bbb1b6f9SApple OSS Distributions 	// Fill in the IOInterruptSource with the controller's info.
644*bbb1b6f9SApple OSS Distributions 	interruptSources[source].interruptController = this;
645*bbb1b6f9SApple OSS Distributions 	interruptSources[source].vectorData = vectorData;
646*bbb1b6f9SApple OSS Distributions 
647*bbb1b6f9SApple OSS Distributions 	// Fill in vector with the client's info.
648*bbb1b6f9SApple OSS Distributions 	vector->handler = handler;
649*bbb1b6f9SApple OSS Distributions 	vector->nub     = nub;
650*bbb1b6f9SApple OSS Distributions 	vector->source  = source;
651*bbb1b6f9SApple OSS Distributions 	vector->target  = target;
652*bbb1b6f9SApple OSS Distributions 	vector->refCon  = refCon;
653*bbb1b6f9SApple OSS Distributions 
654*bbb1b6f9SApple OSS Distributions 	// Get the vector ready.  It starts off soft disabled.
655*bbb1b6f9SApple OSS Distributions 	vector->interruptDisabledSoft = 1;
656*bbb1b6f9SApple OSS Distributions 	vector->interruptRegistered   = 1;
657*bbb1b6f9SApple OSS Distributions 
658*bbb1b6f9SApple OSS Distributions 	interruptState = IOSimpleLockLockDisableInterrupt(controllerLock);
659*bbb1b6f9SApple OSS Distributions 	// Move the high water mark if needed
660*bbb1b6f9SApple OSS Distributions 	if (++vectorsRegistered > numVectors) {
661*bbb1b6f9SApple OSS Distributions 		numVectors = vectorsRegistered;
662*bbb1b6f9SApple OSS Distributions 	}
663*bbb1b6f9SApple OSS Distributions 	IOSimpleLockUnlockEnableInterrupt(controllerLock, interruptState);
664*bbb1b6f9SApple OSS Distributions 
665*bbb1b6f9SApple OSS Distributions 	IOLockUnlock(vector->interruptLock);
666*bbb1b6f9SApple OSS Distributions 	return kIOReturnSuccess;
667*bbb1b6f9SApple OSS Distributions }
668*bbb1b6f9SApple OSS Distributions 
669*bbb1b6f9SApple OSS Distributions IOReturn
unregisterInterrupt(IOService * nub,int source)670*bbb1b6f9SApple OSS Distributions IOSharedInterruptController::unregisterInterrupt(IOService *nub,
671*bbb1b6f9SApple OSS Distributions     int source)
672*bbb1b6f9SApple OSS Distributions {
673*bbb1b6f9SApple OSS Distributions 	IOInterruptVectorNumber vectorNumber;
674*bbb1b6f9SApple OSS Distributions 	IOInterruptVector *vector;
675*bbb1b6f9SApple OSS Distributions 	IOInterruptState  interruptState;
676*bbb1b6f9SApple OSS Distributions 
677*bbb1b6f9SApple OSS Distributions 	for (vectorNumber = 0; vectorNumber < kIOSharedInterruptControllerDefaultVectors; vectorNumber++) {
678*bbb1b6f9SApple OSS Distributions 		vector = &vectors[vectorNumber];
679*bbb1b6f9SApple OSS Distributions 
680*bbb1b6f9SApple OSS Distributions 		// Get the lock for this vector.
681*bbb1b6f9SApple OSS Distributions 		IOLockLock(vector->interruptLock);
682*bbb1b6f9SApple OSS Distributions 
683*bbb1b6f9SApple OSS Distributions 		// Return success if it is not already registered
684*bbb1b6f9SApple OSS Distributions 		if (!vector->interruptRegistered
685*bbb1b6f9SApple OSS Distributions 		    || (vector->nub != nub) || (vector->source != source)) {
686*bbb1b6f9SApple OSS Distributions 			IOLockUnlock(vector->interruptLock);
687*bbb1b6f9SApple OSS Distributions 			continue;
688*bbb1b6f9SApple OSS Distributions 		}
689*bbb1b6f9SApple OSS Distributions 
690*bbb1b6f9SApple OSS Distributions 		// Soft disable the source and the controller too.
691*bbb1b6f9SApple OSS Distributions 		disableInterrupt(nub, source);
692*bbb1b6f9SApple OSS Distributions 
693*bbb1b6f9SApple OSS Distributions 		// Free vectorData
694*bbb1b6f9SApple OSS Distributions 		IOInterruptSource *interruptSources = nub->_interruptSources;
695*bbb1b6f9SApple OSS Distributions 		OSSafeReleaseNULL(interruptSources[source].vectorData);
696*bbb1b6f9SApple OSS Distributions 
697*bbb1b6f9SApple OSS Distributions 		// Clear all the storage for the vector except for interruptLock.
698*bbb1b6f9SApple OSS Distributions 		vector->interruptActive = 0;
699*bbb1b6f9SApple OSS Distributions 		vector->interruptDisabledSoft = 0;
700*bbb1b6f9SApple OSS Distributions 		vector->interruptDisabledHard = 0;
701*bbb1b6f9SApple OSS Distributions 		vector->interruptRegistered = 0;
702*bbb1b6f9SApple OSS Distributions 		vector->nub = NULL;
703*bbb1b6f9SApple OSS Distributions 		vector->source = 0;
704*bbb1b6f9SApple OSS Distributions 		vector->handler = NULL;
705*bbb1b6f9SApple OSS Distributions 		vector->target = NULL;
706*bbb1b6f9SApple OSS Distributions 		vector->refCon = NULL;
707*bbb1b6f9SApple OSS Distributions 
708*bbb1b6f9SApple OSS Distributions 		interruptState = IOSimpleLockLockDisableInterrupt(controllerLock);
709*bbb1b6f9SApple OSS Distributions 		vectorsRegistered--;
710*bbb1b6f9SApple OSS Distributions 		IOSimpleLockUnlockEnableInterrupt(controllerLock, interruptState);
711*bbb1b6f9SApple OSS Distributions 
712*bbb1b6f9SApple OSS Distributions 		// Move along to the next one.
713*bbb1b6f9SApple OSS Distributions 		IOLockUnlock(vector->interruptLock);
714*bbb1b6f9SApple OSS Distributions 	}
715*bbb1b6f9SApple OSS Distributions 
716*bbb1b6f9SApple OSS Distributions 	// Re-enable the controller if all vectors are enabled.
717*bbb1b6f9SApple OSS Distributions 	if (vectorsEnabled == vectorsRegistered) {
718*bbb1b6f9SApple OSS Distributions 		controllerDisabled = 0;
719*bbb1b6f9SApple OSS Distributions 		provider->enableInterrupt(0);
720*bbb1b6f9SApple OSS Distributions 	}
721*bbb1b6f9SApple OSS Distributions 
722*bbb1b6f9SApple OSS Distributions 	return kIOReturnSuccess;
723*bbb1b6f9SApple OSS Distributions }
724*bbb1b6f9SApple OSS Distributions 
725*bbb1b6f9SApple OSS Distributions IOReturn
getInterruptType(IOService *,int,int * interruptType)726*bbb1b6f9SApple OSS Distributions IOSharedInterruptController::getInterruptType(IOService */*nub*/,
727*bbb1b6f9SApple OSS Distributions     int /*source*/,
728*bbb1b6f9SApple OSS Distributions     int *interruptType)
729*bbb1b6f9SApple OSS Distributions {
730*bbb1b6f9SApple OSS Distributions 	return provider->getInterruptType(0, interruptType);
731*bbb1b6f9SApple OSS Distributions }
732*bbb1b6f9SApple OSS Distributions 
733*bbb1b6f9SApple OSS Distributions IOReturn
enableInterrupt(IOService * nub,int source)734*bbb1b6f9SApple OSS Distributions IOSharedInterruptController::enableInterrupt(IOService *nub,
735*bbb1b6f9SApple OSS Distributions     int source)
736*bbb1b6f9SApple OSS Distributions {
737*bbb1b6f9SApple OSS Distributions 	IOInterruptSource *interruptSources;
738*bbb1b6f9SApple OSS Distributions 	IOInterruptVectorNumber vectorNumber;
739*bbb1b6f9SApple OSS Distributions 	IOInterruptVector *vector;
740*bbb1b6f9SApple OSS Distributions 	OSData            *vectorData;
741*bbb1b6f9SApple OSS Distributions 	IOInterruptState  interruptState;
742*bbb1b6f9SApple OSS Distributions 
743*bbb1b6f9SApple OSS Distributions 	interruptSources = nub->_interruptSources;
744*bbb1b6f9SApple OSS Distributions 	vectorData = interruptSources[source].vectorData;
745*bbb1b6f9SApple OSS Distributions 	vectorNumber = *(IOInterruptVectorNumber *)vectorData->getBytesNoCopy();
746*bbb1b6f9SApple OSS Distributions 	vector = &vectors[vectorNumber];
747*bbb1b6f9SApple OSS Distributions 
748*bbb1b6f9SApple OSS Distributions 	interruptState = IOSimpleLockLockDisableInterrupt(controllerLock);
749*bbb1b6f9SApple OSS Distributions 	if (!vector->interruptDisabledSoft) {
750*bbb1b6f9SApple OSS Distributions 		IOSimpleLockUnlockEnableInterrupt(controllerLock, interruptState);
751*bbb1b6f9SApple OSS Distributions 		return kIOReturnSuccess;
752*bbb1b6f9SApple OSS Distributions 	}
753*bbb1b6f9SApple OSS Distributions 
754*bbb1b6f9SApple OSS Distributions 	vector->interruptDisabledSoft = 0;
755*bbb1b6f9SApple OSS Distributions 	vectorsEnabled++;
756*bbb1b6f9SApple OSS Distributions 	IOSimpleLockUnlockEnableInterrupt(controllerLock, interruptState);
757*bbb1b6f9SApple OSS Distributions 
758*bbb1b6f9SApple OSS Distributions 	if (controllerDisabled && (vectorsEnabled == vectorsRegistered)) {
759*bbb1b6f9SApple OSS Distributions 		controllerDisabled = 0;
760*bbb1b6f9SApple OSS Distributions 		provider->enableInterrupt(0);
761*bbb1b6f9SApple OSS Distributions 	}
762*bbb1b6f9SApple OSS Distributions 
763*bbb1b6f9SApple OSS Distributions 	return kIOReturnSuccess;
764*bbb1b6f9SApple OSS Distributions }
765*bbb1b6f9SApple OSS Distributions 
766*bbb1b6f9SApple OSS Distributions IOReturn
disableInterrupt(IOService * nub,int source)767*bbb1b6f9SApple OSS Distributions IOSharedInterruptController::disableInterrupt(IOService *nub,
768*bbb1b6f9SApple OSS Distributions     int source)
769*bbb1b6f9SApple OSS Distributions {
770*bbb1b6f9SApple OSS Distributions 	IOInterruptSource *interruptSources;
771*bbb1b6f9SApple OSS Distributions 	IOInterruptVectorNumber vectorNumber;
772*bbb1b6f9SApple OSS Distributions 	IOInterruptVector *vector;
773*bbb1b6f9SApple OSS Distributions 	OSData            *vectorData;
774*bbb1b6f9SApple OSS Distributions 	IOInterruptState  interruptState;
775*bbb1b6f9SApple OSS Distributions 
776*bbb1b6f9SApple OSS Distributions 	interruptSources = nub->_interruptSources;
777*bbb1b6f9SApple OSS Distributions 	vectorData = interruptSources[source].vectorData;
778*bbb1b6f9SApple OSS Distributions 	vectorNumber = *(IOInterruptVectorNumber *)vectorData->getBytesNoCopy();
779*bbb1b6f9SApple OSS Distributions 	vector = &vectors[vectorNumber];
780*bbb1b6f9SApple OSS Distributions 
781*bbb1b6f9SApple OSS Distributions 	interruptState = IOSimpleLockLockDisableInterrupt(controllerLock);
782*bbb1b6f9SApple OSS Distributions 	if (!vector->interruptDisabledSoft) {
783*bbb1b6f9SApple OSS Distributions 		vector->interruptDisabledSoft = 1;
784*bbb1b6f9SApple OSS Distributions #if !defined(__i386__) && !defined(__x86_64__)
785*bbb1b6f9SApple OSS Distributions 		OSMemoryBarrier();
786*bbb1b6f9SApple OSS Distributions #endif
787*bbb1b6f9SApple OSS Distributions 
788*bbb1b6f9SApple OSS Distributions 		vectorsEnabled--;
789*bbb1b6f9SApple OSS Distributions 	}
790*bbb1b6f9SApple OSS Distributions 	IOSimpleLockUnlockEnableInterrupt(controllerLock, interruptState);
791*bbb1b6f9SApple OSS Distributions 
792*bbb1b6f9SApple OSS Distributions 	if (!getPlatform()->atInterruptLevel()) {
793*bbb1b6f9SApple OSS Distributions 		while (vector->interruptActive) {
794*bbb1b6f9SApple OSS Distributions 		}
795*bbb1b6f9SApple OSS Distributions 	}
796*bbb1b6f9SApple OSS Distributions 
797*bbb1b6f9SApple OSS Distributions 	return kIOReturnSuccess;
798*bbb1b6f9SApple OSS Distributions }
799*bbb1b6f9SApple OSS Distributions 
800*bbb1b6f9SApple OSS Distributions IOInterruptAction
getInterruptHandlerAddress(void)801*bbb1b6f9SApple OSS Distributions IOSharedInterruptController::getInterruptHandlerAddress(void)
802*bbb1b6f9SApple OSS Distributions {
803*bbb1b6f9SApple OSS Distributions 	return OSMemberFunctionCast(IOInterruptAction,
804*bbb1b6f9SApple OSS Distributions 	           this, &IOSharedInterruptController::handleInterrupt);
805*bbb1b6f9SApple OSS Distributions }
806*bbb1b6f9SApple OSS Distributions 
807*bbb1b6f9SApple OSS Distributions IOReturn
handleInterrupt(void *,IOService * nub,int)808*bbb1b6f9SApple OSS Distributions IOSharedInterruptController::handleInterrupt(void * /*refCon*/,
809*bbb1b6f9SApple OSS Distributions     IOService * nub,
810*bbb1b6f9SApple OSS Distributions     int /*source*/)
811*bbb1b6f9SApple OSS Distributions {
812*bbb1b6f9SApple OSS Distributions 	IOInterruptVectorNumber vectorNumber;
813*bbb1b6f9SApple OSS Distributions 	IOInterruptVector *vector;
814*bbb1b6f9SApple OSS Distributions 
815*bbb1b6f9SApple OSS Distributions 	for (vectorNumber = 0; vectorNumber < numVectors; vectorNumber++) {
816*bbb1b6f9SApple OSS Distributions 		vector = &vectors[vectorNumber];
817*bbb1b6f9SApple OSS Distributions 
818*bbb1b6f9SApple OSS Distributions 		vector->interruptActive = 1;
819*bbb1b6f9SApple OSS Distributions #if !defined(__i386__) && !defined(__x86_64__)
820*bbb1b6f9SApple OSS Distributions 		OSMemoryBarrier();
821*bbb1b6f9SApple OSS Distributions #endif
822*bbb1b6f9SApple OSS Distributions 
823*bbb1b6f9SApple OSS Distributions 		if (!vector->interruptDisabledSoft) {
824*bbb1b6f9SApple OSS Distributions 			// Call the handler if it exists.
825*bbb1b6f9SApple OSS Distributions 			if (vector->interruptRegistered) {
826*bbb1b6f9SApple OSS Distributions 				bool trace = (gIOKitTrace & kIOTraceInterrupts) ? true : false;
827*bbb1b6f9SApple OSS Distributions 
828*bbb1b6f9SApple OSS Distributions 				if (trace) {
829*bbb1b6f9SApple OSS Distributions 					timeStampInterruptHandlerStart(vectorNumber, vector);
830*bbb1b6f9SApple OSS Distributions 				}
831*bbb1b6f9SApple OSS Distributions 
832*bbb1b6f9SApple OSS Distributions 				// Call handler.
833*bbb1b6f9SApple OSS Distributions 				vector->handler(vector->target, vector->refCon, vector->nub, vector->source);
834*bbb1b6f9SApple OSS Distributions 
835*bbb1b6f9SApple OSS Distributions 				if (trace) {
836*bbb1b6f9SApple OSS Distributions 					timeStampInterruptHandlerEnd(vectorNumber, vector);
837*bbb1b6f9SApple OSS Distributions 				}
838*bbb1b6f9SApple OSS Distributions 			}
839*bbb1b6f9SApple OSS Distributions 		}
840*bbb1b6f9SApple OSS Distributions 
841*bbb1b6f9SApple OSS Distributions 		vector->interruptActive = 0;
842*bbb1b6f9SApple OSS Distributions 	}
843*bbb1b6f9SApple OSS Distributions 
844*bbb1b6f9SApple OSS Distributions 	// if any of the vectors are dissabled, then dissable this controller.
845*bbb1b6f9SApple OSS Distributions 	IOSimpleLockLock(controllerLock);
846*bbb1b6f9SApple OSS Distributions 	if (vectorsEnabled != vectorsRegistered) {
847*bbb1b6f9SApple OSS Distributions 		nub->disableInterrupt(0);
848*bbb1b6f9SApple OSS Distributions 		controllerDisabled = 1;
849*bbb1b6f9SApple OSS Distributions 	}
850*bbb1b6f9SApple OSS Distributions 	IOSimpleLockUnlock(controllerLock);
851*bbb1b6f9SApple OSS Distributions 
852*bbb1b6f9SApple OSS Distributions 	return kIOReturnSuccess;
853*bbb1b6f9SApple OSS Distributions }
854