iokit/IOKit/PassthruInterruptController.h

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