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