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