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