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