]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * Copyright (c) 1998-2019 Apple Inc. All rights reserved. | |
3 | * | |
4 | * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ | |
5 | * | |
6 | * This file contains Original Code and/or Modifications of Original Code | |
7 | * as defined in and that are subject to the Apple Public Source License | |
8 | * Version 2.0 (the 'License'). You may not use this file except in | |
9 | * compliance with the License. The rights granted to you under the License | |
10 | * may not be used to create, or enable the creation or redistribution of, | |
11 | * unlawful or unlicensed copies of an Apple operating system, or to | |
12 | * circumvent, violate, or enable the circumvention or violation of, any | |
13 | * terms of an Apple operating system software license agreement. | |
14 | * | |
15 | * Please obtain a copy of the License at | |
16 | * http://www.opensource.apple.com/apsl/ and read it before using this file. | |
17 | * | |
18 | * The Original Code and all software distributed under the License are | |
19 | * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER | |
20 | * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, | |
21 | * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, | |
22 | * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. | |
23 | * Please see the License for the specific language governing rights and | |
24 | * limitations under the License. | |
25 | * | |
26 | * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ | |
27 | */ | |
28 | ||
29 | #ifndef _IOKIT_IOSERVICEPM_H | |
30 | #define _IOKIT_IOSERVICEPM_H | |
31 | ||
32 | #include <IOKit/pwr_mgt/IOPM.h> | |
33 | ||
34 | class IOService; | |
35 | class IOServicePM; | |
36 | class IOPowerConnection; | |
37 | class IOWorkLoop; | |
38 | class IOCommandGate; | |
39 | class IOTimerEventSource; | |
40 | class IOPlatformExpert; | |
41 | ||
42 | #ifdef XNU_KERNEL_PRIVATE | |
43 | class IOPMinformee; | |
44 | class IOPMinformeeList; | |
45 | class IOPMWorkQueue; | |
46 | class IOPMRequest; | |
47 | class IOPMRequestQueue; | |
48 | class IOPMCompletionQueue; | |
49 | ||
50 | typedef void (*IOPMCompletionAction)(void * target, void * param); | |
51 | ||
52 | // PM channels for IOReporting | |
53 | #ifndef kPMPowerStatesChID | |
54 | #define kPMPowerStatesChID IOREPORT_MAKEID('P','M','S','t','H','i','s','t') | |
55 | #endif | |
56 | ||
57 | #ifndef kPMCurrStateChID | |
58 | #define kPMCurrStateChID IOREPORT_MAKEID( 'P','M','C','u','r','S','t','\0' ) | |
59 | #endif | |
60 | ||
61 | // state_id details in PM channels | |
62 | #define kPMReportPowerOn 0x01 | |
63 | #define kPMReportDeviceUsable 0x02 | |
64 | #define kPMReportLowPower 0x04 | |
65 | ||
66 | ||
67 | typedef unsigned long IOPMPowerStateIndex; | |
68 | typedef uint32_t IOPMPowerChangeFlags; | |
69 | typedef uint32_t IOPMRequestTag; | |
70 | ||
71 | struct IOPMDriverCallEntry { | |
72 | queue_chain_t link; | |
73 | thread_t thread; | |
74 | IOService * target; | |
75 | const void *callMethod; | |
76 | }; | |
77 | ||
78 | // Power clients (desires) | |
79 | extern const OSSymbol * gIOPMPowerClientDevice; | |
80 | extern const OSSymbol * gIOPMPowerClientDriver; | |
81 | extern const OSSymbol * gIOPMPowerClientChildProxy; | |
82 | extern const OSSymbol * gIOPMPowerClientChildren; | |
83 | extern const OSSymbol * gIOPMPowerClientRootDomain; | |
84 | ||
85 | /* Binary compatibility with drivers that access pm_vars */ | |
86 | #ifdef __LP64__ | |
87 | #define PM_VARS_SUPPORT 0 | |
88 | #else | |
89 | #define PM_VARS_SUPPORT 1 | |
90 | #endif | |
91 | ||
92 | #if PM_VARS_SUPPORT | |
93 | /* Deprecated in version 10.5 */ | |
94 | class IOPMprot : public OSObject | |
95 | { | |
96 | friend class IOService; | |
97 | ||
98 | OSDeclareDefaultStructors(IOPMprot); | |
99 | ||
100 | public: | |
101 | const char * ourName; | |
102 | IOPlatformExpert * thePlatform; | |
103 | unsigned long theNumberOfPowerStates; | |
104 | IOPMPowerState thePowerStates[IOPMMaxPowerStates]; | |
105 | IOService * theControllingDriver; | |
106 | unsigned long aggressiveness; | |
107 | unsigned long current_aggressiveness_values[kMaxType + 1]; | |
108 | bool current_aggressiveness_valid[kMaxType + 1]; | |
109 | unsigned long myCurrentState; | |
110 | }; | |
111 | #endif /* PM_VARS_SUPPORT */ | |
112 | #endif /* XNU_KERNEL_PRIVATE */ | |
113 | #endif /* !_IOKIT_IOSERVICEPM_H */ |