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