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