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