Leaked source code of windows server 2003
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

255 lines
10 KiB

  1. /*****************************************************************************\
  2. * *
  3. * powrprof.h - - Interface for powrprof.dll, the power policy applicator *
  4. * *
  5. * Version 1.0 *
  6. * *
  7. * Copyright (c) Microsoft Corporation. All rights reserved. *
  8. * *
  9. \*****************************************************************************/
  10. // Registry storage structures for the GLOBAL_POWER_POLICY data. There are two
  11. // structures, GLOBAL_MACHINE_POWER_POLICY and GLOBAL_USER_POWER_POLICY. the
  12. // GLOBAL_MACHINE_POWER_POLICY stores per machine data for which there is no UI.
  13. // GLOBAL_USER_POWER_POLICY stores the per user data.
  14. typedef struct _GLOBAL_MACHINE_POWER_POLICY{
  15. ULONG Revision;
  16. SYSTEM_POWER_STATE LidOpenWakeAc;
  17. SYSTEM_POWER_STATE LidOpenWakeDc;
  18. ULONG BroadcastCapacityResolution;
  19. } GLOBAL_MACHINE_POWER_POLICY, *PGLOBAL_MACHINE_POWER_POLICY;
  20. typedef struct _GLOBAL_USER_POWER_POLICY{
  21. ULONG Revision;
  22. POWER_ACTION_POLICY PowerButtonAc;
  23. POWER_ACTION_POLICY PowerButtonDc;
  24. POWER_ACTION_POLICY SleepButtonAc;
  25. POWER_ACTION_POLICY SleepButtonDc;
  26. POWER_ACTION_POLICY LidCloseAc;
  27. POWER_ACTION_POLICY LidCloseDc;
  28. SYSTEM_POWER_LEVEL DischargePolicy[NUM_DISCHARGE_POLICIES];
  29. ULONG GlobalFlags;
  30. } GLOBAL_USER_POWER_POLICY, *PGLOBAL_USER_POWER_POLICY;
  31. // Structure to manage global power policies at the user level. This structure
  32. // contains data which is common across all power policy profiles.
  33. typedef struct _GLOBAL_POWER_POLICY{
  34. GLOBAL_USER_POWER_POLICY user;
  35. GLOBAL_MACHINE_POWER_POLICY mach;
  36. } GLOBAL_POWER_POLICY, *PGLOBAL_POWER_POLICY;
  37. // Registry storage structures for the POWER_POLICY data. There are three
  38. // structures, MACHINE_POWER_POLICY, MACHINE_PROCESSOR_POWER_POLICY and USER_POWER_POLICY. the
  39. // MACHINE_POWER_POLICY stores per machine data for which there is no UI.
  40. // USER_POWER_POLICY stores the per user data.
  41. typedef struct _MACHINE_POWER_POLICY{
  42. ULONG Revision; // 1
  43. // meaning of power action "sleep"
  44. SYSTEM_POWER_STATE MinSleepAc;
  45. SYSTEM_POWER_STATE MinSleepDc;
  46. SYSTEM_POWER_STATE ReducedLatencySleepAc;
  47. SYSTEM_POWER_STATE ReducedLatencySleepDc;
  48. // parameters for dozing
  49. ULONG DozeTimeoutAc;
  50. ULONG DozeTimeoutDc;
  51. ULONG DozeS4TimeoutAc;
  52. ULONG DozeS4TimeoutDc;
  53. // processor policies
  54. UCHAR MinThrottleAc;
  55. UCHAR MinThrottleDc;
  56. UCHAR pad1[2];
  57. POWER_ACTION_POLICY OverThrottledAc;
  58. POWER_ACTION_POLICY OverThrottledDc;
  59. } MACHINE_POWER_POLICY, *PMACHINE_POWER_POLICY;
  60. typedef struct _MACHINE_PROCESSOR_POWER_POLICY {
  61. ULONG Revision; // 1
  62. PROCESSOR_POWER_POLICY ProcessorPolicyAc;
  63. PROCESSOR_POWER_POLICY ProcessorPolicyDc;
  64. } MACHINE_PROCESSOR_POWER_POLICY, *PMACHINE_PROCESSOR_POWER_POLICY;
  65. typedef struct _USER_POWER_POLICY{
  66. ULONG Revision; // 1
  67. // "system idle" detection
  68. POWER_ACTION_POLICY IdleAc;
  69. POWER_ACTION_POLICY IdleDc;
  70. ULONG IdleTimeoutAc;
  71. ULONG IdleTimeoutDc;
  72. UCHAR IdleSensitivityAc;
  73. UCHAR IdleSensitivityDc;
  74. // Throttling Policy
  75. UCHAR ThrottlePolicyAc;
  76. UCHAR ThrottlePolicyDc;
  77. // meaning of power action "sleep"
  78. SYSTEM_POWER_STATE MaxSleepAc;
  79. SYSTEM_POWER_STATE MaxSleepDc;
  80. // For future use
  81. ULONG Reserved[2];
  82. // video policies
  83. ULONG VideoTimeoutAc;
  84. ULONG VideoTimeoutDc;
  85. // hard disk policies
  86. ULONG SpindownTimeoutAc;
  87. ULONG SpindownTimeoutDc;
  88. // processor policies
  89. BOOLEAN OptimizeForPowerAc;
  90. BOOLEAN OptimizeForPowerDc;
  91. UCHAR FanThrottleToleranceAc;
  92. UCHAR FanThrottleToleranceDc;
  93. UCHAR ForcedThrottleAc;
  94. UCHAR ForcedThrottleDc;
  95. } USER_POWER_POLICY, *PUSER_POWER_POLICY;
  96. // Structure to manage power policies at the user level. This structure
  97. // contains data which is unique across power policy profiles.
  98. typedef struct _POWER_POLICY{
  99. USER_POWER_POLICY user;
  100. MACHINE_POWER_POLICY mach;
  101. } POWER_POLICY, *PPOWER_POLICY;
  102. // Constants for GlobalFlags
  103. #define EnableSysTrayBatteryMeter 0x01
  104. #define EnableMultiBatteryDisplay 0x02
  105. #define EnablePasswordLogon 0x04
  106. #define EnableWakeOnRing 0x08
  107. #define EnableVideoDimDisplay 0x10
  108. // This constant is passed as a uiID to WritePwrScheme.
  109. #define NEWSCHEME (UINT)-1
  110. // Prototype for EnumPwrSchemes callback proceedures.
  111. typedef BOOLEAN (CALLBACK* PWRSCHEMESENUMPROC)(UINT, DWORD, LPTSTR, DWORD, LPTSTR, PPOWER_POLICY, LPARAM);
  112. typedef BOOLEAN (CALLBACK* PFNNTINITIATEPWRACTION)(POWER_ACTION, SYSTEM_POWER_STATE, ULONG, BOOLEAN);
  113. // Public function prototypes
  114. BOOLEAN WINAPI GetPwrDiskSpindownRange(PUINT, PUINT);
  115. BOOLEAN WINAPI EnumPwrSchemes(PWRSCHEMESENUMPROC, LPARAM);
  116. BOOLEAN WINAPI ReadGlobalPwrPolicy(PGLOBAL_POWER_POLICY);
  117. BOOLEAN WINAPI ReadPwrScheme(UINT, PPOWER_POLICY);
  118. BOOLEAN WINAPI WritePwrScheme(PUINT, LPTSTR, LPTSTR, PPOWER_POLICY);
  119. BOOLEAN WINAPI WriteGlobalPwrPolicy(PGLOBAL_POWER_POLICY);
  120. BOOLEAN WINAPI DeletePwrScheme(UINT);
  121. BOOLEAN WINAPI GetActivePwrScheme(PUINT);
  122. BOOLEAN WINAPI SetActivePwrScheme(UINT, PGLOBAL_POWER_POLICY, PPOWER_POLICY);
  123. BOOLEAN WINAPI GetPwrCapabilities(PSYSTEM_POWER_CAPABILITIES);
  124. BOOLEAN WINAPI IsPwrSuspendAllowed(VOID);
  125. BOOLEAN WINAPI IsPwrHibernateAllowed(VOID);
  126. BOOLEAN WINAPI IsPwrShutdownAllowed(VOID);
  127. BOOLEAN WINAPI IsAdminOverrideActive(PADMINISTRATOR_POWER_POLICY);
  128. BOOLEAN WINAPI SetSuspendState(BOOLEAN, BOOLEAN, BOOLEAN);
  129. BOOLEAN WINAPI GetCurrentPowerPolicies(PGLOBAL_POWER_POLICY, PPOWER_POLICY);
  130. BOOLEAN WINAPI CanUserWritePwrScheme(VOID);
  131. BOOLEAN WINAPI ReadProcessorPwrScheme(UINT, PMACHINE_PROCESSOR_POWER_POLICY);
  132. BOOLEAN WINAPI WriteProcessorPwrScheme(UINT, PMACHINE_PROCESSOR_POWER_POLICY);
  133. BOOLEAN WINAPI ValidatePowerPolicies(PGLOBAL_POWER_POLICY, PPOWER_POLICY);
  134. #ifndef NT_SUCCESS
  135. #define NTSTATUS LONG
  136. #define _OVERRIDE_NTSTATUS_
  137. #endif
  138. NTSTATUS WINAPI CallNtPowerInformation(POWER_INFORMATION_LEVEL, PVOID, ULONG, PVOID, ULONG);
  139. #ifdef _OVERRIDE_NTSTATUS_
  140. #undef NTSTATUS
  141. #endif
  142. void WINAPI LoadCurrentPwrScheme(HWND hwnd, HINSTANCE hAppInstance, LPSTR lpszCmdLine, int nCmdShow);
  143. void WINAPI MergeLegacyPwrScheme(HWND hwnd, HINSTANCE hAppInstance, LPSTR lpszCmdLine, int nCmdShow);
  144. // Define the following to debug batmeter on machines with no battery support.
  145. //#define SIM_BATTERY 1
  146. #define CURRENT_REVISION 1
  147. #define STRSIZE(psz) ((lstrlen(psz) + 1) * sizeof(TCHAR))
  148. #define MAX_NAME_LEN (64) // Max length of name in characters.
  149. #define MAX_NAME_SIZE (MAX_NAME_LEN +1) * sizeof(TCHAR)
  150. #define MAX_DESC_LEN 512 // Max length of description in characters.
  151. #define MAX_DESC_SIZE (MAX_DESC_LEN +1) * sizeof(TCHAR)
  152. #define SEMAPHORE_TIMEOUT 10000
  153. #define NUM_DEC_DIGITS 10+1+1 // 10 digits + NUll and sign.
  154. #define SIZE_DEC_DIGITS (10+1+1) * sizeof(TCHAR)
  155. // Private function prototypes implemented in powrprof.c
  156. BOOLEAN ValidateSystemPolicies(PSYSTEM_POWER_POLICY, PSYSTEM_POWER_POLICY);
  157. BOOLEAN GetCurrentSystemPowerPolicies(PSYSTEM_POWER_POLICY, PSYSTEM_POWER_POLICY);
  158. BOOLEAN MyStrToInt(LPCTSTR, PINT);
  159. BOOLEAN RegistryInit(PUINT);
  160. HANDLE MyCreateSemaphore(LPCTSTR);
  161. NTSTATUS CallNtSetValidateAcDc(BOOLEAN, BOOLEAN, PVOID, PVOID, PVOID, PVOID);
  162. DWORD SetPrivilegeAttribute(LPCTSTR, DWORD, LPDWORD);
  163. VOID InitAdmin(PADMINISTRATOR_POWER_POLICY papp);
  164. #if DBG
  165. VOID ReadOptionalDebugSettings(VOID);
  166. #define MYDBGPRINT(_X) DbgPrint _X
  167. #else
  168. #define MYDBGPRINT(_X)
  169. #endif
  170. // Private function prototypes implemented in reghelp.c:
  171. BOOLEAN OpenCurrentUser(PHKEY phKey);
  172. BOOLEAN CloseCurrentUser(HKEY hKey);
  173. //BOOLEAN OpenMachineUserKeys(LPTSTR, LPTSTR, PHKEY, PHKEY);
  174. BOOLEAN TakeRegSemaphore(VOID);
  175. BOOLEAN WritePwrPolicyEx(LPTSTR, LPTSTR, PUINT, LPTSTR, LPTSTR, LPVOID, DWORD, LPVOID, DWORD);
  176. BOOLEAN ReadPwrPolicyEx(LPTSTR, LPTSTR, LPTSTR, LPTSTR, LPDWORD, LPVOID, DWORD, LPVOID, DWORD);
  177. BOOLEAN ReadWritePowerValue(HKEY, LPTSTR, LPTSTR, LPTSTR, LPDWORD, BOOLEAN, BOOLEAN);
  178. BOOLEAN ReadPowerValueOptional(HKEY, LPTSTR, LPTSTR, LPTSTR, LPDWORD);
  179. BOOLEAN ReadPowerIntOptional(HKEY, LPTSTR, LPTSTR, PINT);
  180. BOOLEAN CreatePowerValue(HKEY, LPCTSTR, LPCTSTR, LPCTSTR);
  181. // Private function prototypes implemented in merge.c
  182. BOOLEAN MergePolicies(PUSER_POWER_POLICY, PMACHINE_POWER_POLICY, PPOWER_POLICY);
  183. BOOLEAN SplitPolicies(PPOWER_POLICY, PUSER_POWER_POLICY, PMACHINE_POWER_POLICY);
  184. BOOLEAN MergeGlobalPolicies(PGLOBAL_USER_POWER_POLICY, PGLOBAL_MACHINE_POWER_POLICY, PGLOBAL_POWER_POLICY);
  185. BOOLEAN SplitGlobalPolicies(PGLOBAL_POWER_POLICY, PGLOBAL_USER_POWER_POLICY, PGLOBAL_MACHINE_POWER_POLICY);
  186. BOOLEAN MergeToSystemPowerPolicies(PGLOBAL_POWER_POLICY, PPOWER_POLICY, PSYSTEM_POWER_POLICY, PSYSTEM_POWER_POLICY);
  187. BOOLEAN SplitFromSystemPowerPolicies(PSYSTEM_POWER_POLICY, PSYSTEM_POWER_POLICY, PGLOBAL_POWER_POLICY, PPOWER_POLICY);
  188. // Private function prototypes implemented in debug.c
  189. #ifdef DEBUG
  190. void DumpPowerActionPolicy(LPSTR, PPOWER_ACTION_POLICY);
  191. void DumpSystemPowerLevel(LPSTR, PSYSTEM_POWER_LEVEL);
  192. void DumpSystemPowerPolicy(LPSTR, PSYSTEM_POWER_POLICY);
  193. void DumpSystemPowerCapabilities(LPSTR, PSYSTEM_POWER_CAPABILITIES);
  194. void DifSystemPowerPolicies(LPSTR, PSYSTEM_POWER_POLICY, PSYSTEM_POWER_POLICY);
  195. #endif