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