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