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