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