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