xref: /xnu-10002.81.5/iokit/IOKit/PassthruInterruptController.h (revision 5e3eaea39dcf651e66cb99ba7d70e32cc4a99587)
1*5e3eaea3SApple OSS Distributions /*
2*5e3eaea3SApple OSS Distributions  * Copyright (c) 2019 Apple Computer, Inc. All rights reserved.
3*5e3eaea3SApple OSS Distributions  *
4*5e3eaea3SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*5e3eaea3SApple OSS Distributions  *
6*5e3eaea3SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*5e3eaea3SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*5e3eaea3SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*5e3eaea3SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*5e3eaea3SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*5e3eaea3SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*5e3eaea3SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*5e3eaea3SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*5e3eaea3SApple OSS Distributions  *
15*5e3eaea3SApple OSS Distributions  * Please obtain a copy of the License at
16*5e3eaea3SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*5e3eaea3SApple OSS Distributions  *
18*5e3eaea3SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*5e3eaea3SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*5e3eaea3SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*5e3eaea3SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*5e3eaea3SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*5e3eaea3SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*5e3eaea3SApple OSS Distributions  * limitations under the License.
25*5e3eaea3SApple OSS Distributions  *
26*5e3eaea3SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*5e3eaea3SApple OSS Distributions  */
28*5e3eaea3SApple OSS Distributions 
29*5e3eaea3SApple OSS Distributions #pragma once
30*5e3eaea3SApple OSS Distributions 
31*5e3eaea3SApple OSS Distributions extern "C" {
32*5e3eaea3SApple OSS Distributions #include <mach/semaphore.h>
33*5e3eaea3SApple OSS Distributions };
34*5e3eaea3SApple OSS Distributions 
35*5e3eaea3SApple OSS Distributions #include <IOKit/IOInterruptController.h>
36*5e3eaea3SApple OSS Distributions 
37*5e3eaea3SApple OSS Distributions /*!
38*5e3eaea3SApple OSS Distributions  * @class       PassthruInterruptController
39*5e3eaea3SApple OSS Distributions  * @abstract    Trivial IOInterruptController class that passes all IRQs through to a
40*5e3eaea3SApple OSS Distributions  *              "child" driver.
41*5e3eaea3SApple OSS Distributions  * @discussion  Waits for a "child" driver (typically loaded in a kext) to register itself,
42*5e3eaea3SApple OSS Distributions  *              then passes the child driver's IOService pointer back via
43*5e3eaea3SApple OSS Distributions  *              waitForChildController() so that XNU can operate on it directly.
44*5e3eaea3SApple OSS Distributions  */
45*5e3eaea3SApple OSS Distributions class PassthruInterruptController : public IOInterruptController
46*5e3eaea3SApple OSS Distributions {
47*5e3eaea3SApple OSS Distributions 	OSDeclareDefaultStructors(PassthruInterruptController);
48*5e3eaea3SApple OSS Distributions 
49*5e3eaea3SApple OSS Distributions public:
50*5e3eaea3SApple OSS Distributions 	virtual bool     init(void) APPLE_KEXT_OVERRIDE;
51*5e3eaea3SApple OSS Distributions 
52*5e3eaea3SApple OSS Distributions 	virtual void     *waitForChildController(void);
53*5e3eaea3SApple OSS Distributions 
54*5e3eaea3SApple OSS Distributions 	virtual void     setCPUInterruptProperties(IOService *service) APPLE_KEXT_OVERRIDE;
55*5e3eaea3SApple OSS Distributions 
56*5e3eaea3SApple OSS Distributions 	virtual IOReturn registerInterrupt(IOService *nub, int source,
57*5e3eaea3SApple OSS Distributions 	    void *target,
58*5e3eaea3SApple OSS Distributions 	    IOInterruptHandler handler,
59*5e3eaea3SApple OSS Distributions 	    void *refCon) APPLE_KEXT_OVERRIDE;
60*5e3eaea3SApple OSS Distributions 
61*5e3eaea3SApple OSS Distributions 	virtual IOReturn getInterruptType(IOService *nub, int source,
62*5e3eaea3SApple OSS Distributions 	    int *interruptType) APPLE_KEXT_OVERRIDE;
63*5e3eaea3SApple OSS Distributions 
64*5e3eaea3SApple OSS Distributions 	virtual IOReturn enableInterrupt(IOService *nub, int source) APPLE_KEXT_OVERRIDE;
65*5e3eaea3SApple OSS Distributions 	virtual IOReturn disableInterrupt(IOService *nub, int source) APPLE_KEXT_OVERRIDE;
66*5e3eaea3SApple OSS Distributions 	virtual IOReturn causeInterrupt(IOService *nub, int source) APPLE_KEXT_OVERRIDE;
67*5e3eaea3SApple OSS Distributions 
68*5e3eaea3SApple OSS Distributions 	virtual IOReturn handleInterrupt(void *refCon, IOService *nub,
69*5e3eaea3SApple OSS Distributions 	    int source) APPLE_KEXT_OVERRIDE;
70*5e3eaea3SApple OSS Distributions 
71*5e3eaea3SApple OSS Distributions 	virtual void externalInterrupt(void);
72*5e3eaea3SApple OSS Distributions 
73*5e3eaea3SApple OSS Distributions protected:
74*5e3eaea3SApple OSS Distributions 	IOInterruptHandler child_handler;
75*5e3eaea3SApple OSS Distributions 	void               *child_target;
76*5e3eaea3SApple OSS Distributions 	void               *child_refCon;
77*5e3eaea3SApple OSS Distributions 	IOService          *child_nub;
78*5e3eaea3SApple OSS Distributions 	semaphore_t        child_sentinel;
79*5e3eaea3SApple OSS Distributions };
80