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