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