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