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