xref: /xnu-8020.140.41/iokit/Kernel/RootDomainUserClient.h (revision 27b03b360a988dfd3dfdf34262bb0042026747cc)
1*27b03b36SApple OSS Distributions /*
2*27b03b36SApple OSS Distributions  * Copyright (c) 1998-2019 Apple Inc. All rights reserved.
3*27b03b36SApple OSS Distributions  *
4*27b03b36SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*27b03b36SApple OSS Distributions  *
6*27b03b36SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*27b03b36SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*27b03b36SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*27b03b36SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*27b03b36SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*27b03b36SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*27b03b36SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*27b03b36SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*27b03b36SApple OSS Distributions  *
15*27b03b36SApple OSS Distributions  * Please obtain a copy of the License at
16*27b03b36SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*27b03b36SApple OSS Distributions  *
18*27b03b36SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*27b03b36SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*27b03b36SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*27b03b36SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*27b03b36SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*27b03b36SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*27b03b36SApple OSS Distributions  * limitations under the License.
25*27b03b36SApple OSS Distributions  *
26*27b03b36SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*27b03b36SApple OSS Distributions  */
28*27b03b36SApple OSS Distributions /*
29*27b03b36SApple OSS Distributions  * Copyright (c) 1999 Apple Computer, Inc.  All rights reserved.
30*27b03b36SApple OSS Distributions  *
31*27b03b36SApple OSS Distributions  * HISTORY
32*27b03b36SApple OSS Distributions  *
33*27b03b36SApple OSS Distributions  */
34*27b03b36SApple OSS Distributions 
35*27b03b36SApple OSS Distributions 
36*27b03b36SApple OSS Distributions #ifndef _IOKIT_ROOTDOMAINUSERCLIENT_H
37*27b03b36SApple OSS Distributions #define _IOKIT_ROOTDOMAINUSERCLIENT_H
38*27b03b36SApple OSS Distributions 
39*27b03b36SApple OSS Distributions #include <IOKit/IOUserClient.h>
40*27b03b36SApple OSS Distributions #include <IOKit/pwr_mgt/IOPM.h>
41*27b03b36SApple OSS Distributions #include <IOKit/pwr_mgt/RootDomain.h>
42*27b03b36SApple OSS Distributions #include <IOKit/pwr_mgt/IOPMLibDefs.h>
43*27b03b36SApple OSS Distributions 
44*27b03b36SApple OSS Distributions 
45*27b03b36SApple OSS Distributions class RootDomainUserClient : public IOUserClient
46*27b03b36SApple OSS Distributions {
47*27b03b36SApple OSS Distributions 	OSDeclareDefaultStructors(RootDomainUserClient);
48*27b03b36SApple OSS Distributions 
49*27b03b36SApple OSS Distributions 	friend class IOPMrootDomain;
50*27b03b36SApple OSS Distributions private:
51*27b03b36SApple OSS Distributions 	IOPMrootDomain *    fOwner;
52*27b03b36SApple OSS Distributions 	task_t              fOwningTask;
53*27b03b36SApple OSS Distributions 
54*27b03b36SApple OSS Distributions 	IOReturn            secureSleepSystem( uint32_t *return_code );
55*27b03b36SApple OSS Distributions 
56*27b03b36SApple OSS Distributions 	IOReturn            secureSleepSystemOptions( const void  *inOptions,
57*27b03b36SApple OSS Distributions 	    IOByteCount  inOptionsSize,
58*27b03b36SApple OSS Distributions 	    uint32_t  *returnCode);
59*27b03b36SApple OSS Distributions 
60*27b03b36SApple OSS Distributions 	IOReturn            secureSetAggressiveness( unsigned long type,
61*27b03b36SApple OSS Distributions 	    unsigned long newLevel,
62*27b03b36SApple OSS Distributions 	    int *return_code );
63*27b03b36SApple OSS Distributions 
64*27b03b36SApple OSS Distributions 	IOReturn            secureSetMaintenanceWakeCalendar(
65*27b03b36SApple OSS Distributions 		IOPMCalendarStruct  *inCalendar,
66*27b03b36SApple OSS Distributions 		uint32_t            *returnCode);
67*27b03b36SApple OSS Distributions 
68*27b03b36SApple OSS Distributions 	IOReturn            secureSetUserAssertionLevels(uint32_t    assertionBitfield);
69*27b03b36SApple OSS Distributions 
70*27b03b36SApple OSS Distributions 	IOReturn            secureGetSystemSleepType( uint32_t *sleepType, uint32_t *sleepTimer);
71*27b03b36SApple OSS Distributions 
72*27b03b36SApple OSS Distributions public:
73*27b03b36SApple OSS Distributions 
74*27b03b36SApple OSS Distributions 	virtual IOReturn clientClose( void ) APPLE_KEXT_OVERRIDE;
75*27b03b36SApple OSS Distributions 
76*27b03b36SApple OSS Distributions 	virtual IOReturn externalMethod( uint32_t selector,
77*27b03b36SApple OSS Distributions 	    IOExternalMethodArguments * arguments,
78*27b03b36SApple OSS Distributions 	    IOExternalMethodDispatch * dispatch,
79*27b03b36SApple OSS Distributions 	    OSObject * target,
80*27b03b36SApple OSS Distributions 	    void * reference ) APPLE_KEXT_OVERRIDE;
81*27b03b36SApple OSS Distributions 
82*27b03b36SApple OSS Distributions 	virtual bool start( IOService * provider ) APPLE_KEXT_OVERRIDE;
83*27b03b36SApple OSS Distributions 
84*27b03b36SApple OSS Distributions 	virtual bool initWithTask(task_t owningTask, void *security_id,
85*27b03b36SApple OSS Distributions 	    UInt32 type, OSDictionary * properties) APPLE_KEXT_OVERRIDE;
86*27b03b36SApple OSS Distributions 
87*27b03b36SApple OSS Distributions // Unused - retained for symbol compatibility
88*27b03b36SApple OSS Distributions 	void setPreventative(UInt32 on_off, UInt32 types_of_sleep);
89*27b03b36SApple OSS Distributions 
90*27b03b36SApple OSS Distributions // Unused - retained for symbol compatibility
91*27b03b36SApple OSS Distributions 	virtual IOExternalMethod * getTargetAndMethodForIndex( IOService ** targetP, UInt32 index ) APPLE_KEXT_OVERRIDE;
92*27b03b36SApple OSS Distributions 	virtual void stop( IOService *provider) APPLE_KEXT_OVERRIDE;
93*27b03b36SApple OSS Distributions };
94*27b03b36SApple OSS Distributions 
95*27b03b36SApple OSS Distributions #endif /* ! _IOKIT_ROOTDOMAINUSERCLIENT_H */
96