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