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