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