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