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