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