iokit/Kernel/RootDomainUserClient.h

   1 /*
   2  * Copyright (c) 1998-2000 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  * Copyright (c) 1999 Apple Computer, Inc.  All rights reserved.
  30  *
  31  * HISTORY
  32  *
  33  */
  34
  35
  36 #ifndef _IOKIT_ROOTDOMAINUSERCLIENT_H
  37 #define _IOKIT_ROOTDOMAINUSERCLIENT_H
  38
  39 #include <IOKit/IOUserClient.h>
  40 #include <IOKit/pwr_mgt/IOPM.h>
  41 #include <IOKit/pwr_mgt/RootDomain.h>
  42 #include <IOKit/pwr_mgt/IOPMLibDefs.h>
  43
  44
  45 class RootDomainUserClient : public IOUserClient
  46 {
  47     OSDeclareDefaultStructors(RootDomainUserClient)
  48
  49     friend class IOPMrootDomain;
  50 private:
  51     IOPMrootDomain *    fOwner;
  52     task_t              fOwningTask;
  53
  54     IOReturn            secureSleepSystem( uint32_t *return_code );
  55
  56     IOReturn            secureSleepSystemOptions( const void  *inOptions,
  57                                                   IOByteCount  inOptionsSize,
  58                                                   uint32_t  *returnCode);
  59
  60     IOReturn            secureSetAggressiveness( unsigned long type,
  61                                                  unsigned long newLevel,
  62                                                  int *return_code );
  63
  64     IOReturn            secureSetMaintenanceWakeCalendar(
  65                                                 IOPMCalendarStruct  *inCalendar,
  66                                                 uint32_t            *returnCode);
  67
  68     IOReturn            secureSetUserAssertionLevels(uint32_t    assertionBitfield);
  69
  70     IOReturn            secureGetSystemSleepType( uint32_t *sleepType );
  71
  72 public:
  73
  74     virtual IOReturn clientClose( void );
  75
  76     virtual IOReturn clientMemoryForType( UInt32 type, IOOptionBits *options, IOMemoryDescriptor **memory);
  77
  78     virtual IOReturn externalMethod( uint32_t selector,
  79                     IOExternalMethodArguments * arguments,
  80                                         IOExternalMethodDispatch * dispatch,
  81                                         OSObject * target,
  82                                         void * reference );
  83
  84     virtual bool start( IOService * provider );
  85
  86     virtual bool initWithTask(task_t owningTask, void *security_id,
  87                                         UInt32 type, OSDictionary * properties);
  88
  89     // Unused - retained for symbol compatibility
  90     void setPreventative(UInt32 on_off, UInt32 types_of_sleep);
  91
  92     // Unused - retained for symbol compatibility
  93     virtual IOExternalMethod * getTargetAndMethodForIndex( IOService ** targetP, UInt32 index );
  94
  95 };
  96
  97 #endif /* ! _IOKIT_ROOTDOMAINUSERCLIENT_H */
  98