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