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