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