iokit/IOKit/pwr_mgt/RootDomain.h

   1 /*
   2  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 #ifndef _IOKIT_ROOTDOMAIN_H
  23 #define _IOKIT_ROOTDOMAIN_H
  24
  25 #include <IOKit/IOService.h>
  26 #include <IOKit/pwr_mgt/IOPM.h>
  27
  28 class RootDomainUserClient;
  29
  30 enum {
  31     kRootDomainSleepNotSupported        = 0x00000000,
  32     kRootDomainSleepSupported           = 0x00000001,
  33     kFrameBufferDeepSleepSupported      = 0x00000002
  34 };
  35
  36 extern "C"
  37 {
  38         IONotifier * registerSleepWakeInterest(IOServiceInterestHandler, void *, void * = 0);
  39         IOReturn acknowledgeSleepWakeNotification(void * );
  40 }
  41
  42
  43 class IOPMrootDomain: public IOService
  44 {
  45 OSDeclareDefaultStructors(IOPMrootDomain)
  46
  47 public:
  48
  49     virtual  bool start( IOService * provider );
  50     virtual IOReturn newUserClient ( task_t,  void *, UInt32, IOUserClient ** );
  51     virtual IOReturn setAggressiveness ( unsigned long, unsigned long );
  52     virtual IOReturn youAreRoot ( void );
  53     virtual IOReturn sleepSystem ( void );
  54     virtual IOReturn receivePowerNotification (UInt32 msg);
  55     virtual void setSleepSupported( IOOptionBits flags );
  56     virtual IOOptionBits getSleepSupported();
  57     virtual bool activityTickle ( unsigned long, unsigned long x=0 );
  58
  59 private:
  60
  61     class IORootParent *        patriarch;                      // points to our parent
  62     unsigned long               idlePeriod;                     // idle timer period
  63
  64     virtual void powerChangeDone ( unsigned long );
  65     virtual void command_received ( void *, void * , void * , void *);
  66     virtual bool tellChangeDown ( unsigned long stateNum);
  67     virtual bool askChangeDown ( unsigned long stateNum);
  68     virtual void tellChangeUp ( unsigned long );
  69     virtual void tellNoChangeDown ( unsigned long );
  70
  71     bool systemBooting;
  72     bool ignoringClamshell;
  73     bool allowSleep;
  74     bool sleepIsSupported;
  75     IOOptionBits platformSleepSupport;
  76 };
  77
  78 class IORootParent: public IOService
  79 {
  80 OSDeclareDefaultStructors(IORootParent)
  81
  82 public:
  83
  84     bool start ( IOService * nub );
  85     void shutDownSystem ( void );
  86     void sleepSystem ( void );
  87     void wakeSystem ( void );
  88 };
  89
  90
  91 #endif /*  _IOKIT_ROOTDOMAIN_H */