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