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