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