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