reactos/w32api/include/ddk/batclass.h

   1 /*
   2  * batclass.h
   3  *
   4  * Battery class driver interface
   5  *
   6  * This file is part of the w32api package.
   7  *
   8  * Contributors:
   9  *   Created by Casper S. Hornstrup <chorns@users.sourceforge.net>
  10  *
  11  * THIS SOFTWARE IS NOT COPYRIGHTED
  12  *
  13  * This source code is offered for use in the public domain. You may
  14  * use, modify or distribute it freely.
  15  *
  16  * This code is distributed in the hope that it will be useful but
  17  * WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY
  18  * DISCLAIMED. This includes but is not limited to warranties of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  20  *
  21  */
  22
  23 #ifndef __BATCLASS_H
  24 #define __BATCLASS_H
  25
  26 #if __GNUC__ >=3
  27 #pragma GCC system_header
  28 #endif
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 #if defined(_BATTERYCLASS_)
  35   #define BCLASSAPI DECLSPEC_EXPORT
  36 #else
  37   #define BCLASSAPI DECLSPEC_IMPORT
  38 #endif
  39
  40
  41 /* Battery device GUIDs */
  42
  43 DEFINE_GUID(GUID_DEVICE_BATTERY,
  44   0x72631e54L, 0x78A4, 0x11d0, 0xbc, 0xf7, 0x00, 0xaa, 0x00, 0xb7, 0xb3, 0x2a);
  45
  46 DEFINE_GUID(BATTERY_STATUS_WMI_GUID,
  47   0xfc4670d1, 0xebbf, 0x416e, 0x87, 0xce, 0x37, 0x4a, 0x4e, 0xbc, 0x11, 0x1a);
  48
  49 DEFINE_GUID(BATTERY_RUNTIME_WMI_GUID,
  50   0x535a3767, 0x1ac2, 0x49bc, 0xa0, 0x77, 0x3f, 0x7a, 0x02, 0xe4, 0x0a, 0xec);
  51
  52 DEFINE_GUID(BATTERY_TEMPERATURE_WMI_GUID,
  53   0x1a52a14d, 0xadce, 0x4a44, 0x9a, 0x3e, 0xc8, 0xd8, 0xf1, 0x5f, 0xf2, 0xc2);
  54
  55 DEFINE_GUID(BATTERY_FULL_CHARGED_CAPACITY_WMI_GUID,
  56   0x40b40565, 0x96f7, 0x4435, 0x86, 0x94, 0x97, 0xe0, 0xe4, 0x39, 0x59, 0x05);
  57
  58 DEFINE_GUID(BATTERY_CYCLE_COUNT_WMI_GUID,
  59   0xef98db24, 0x0014, 0x4c25, 0xa5, 0x0b, 0xc7, 0x24, 0xae, 0x5c, 0xd3, 0x71);
  60
  61 DEFINE_GUID(BATTERY_STATIC_DATA_WMI_GUID,
  62   0x05e1e463, 0xe4e2, 0x4ea9, 0x80, 0xcb, 0x9b, 0xd4, 0xb3, 0xca, 0x06, 0x55);
  63
  64 DEFINE_GUID(BATTERY_STATUS_CHANGE_WMI_GUID,
  65   0xcddfa0c3, 0x7c5b, 0x4e43, 0xa0, 0x34, 0x05, 0x9f, 0xa5, 0xb8, 0x43, 0x64);
  66
  67 DEFINE_GUID(BATTERY_TAG_CHANGE_WMI_GUID,
  68   0x5e1f6e19, 0x8786, 0x4d23, 0x94, 0xfc, 0x9e, 0x74, 0x6b, 0xd5, 0xd8, 0x88);
  69
  70
  71 /* BATTERY_INFORMATION.Capabilities constants */
  72 #define BATTERY_SET_CHARGE_SUPPORTED      0x00000001
  73 #define BATTERY_SET_DISCHARGE_SUPPORTED   0x00000002
  74 #define BATTERY_SET_RESUME_SUPPORTED      0x00000004
  75 #define BATTERY_IS_SHORT_TERM             0x20000000
  76 #define BATTERY_CAPACITY_RELATIVE         0x40000000
  77 #define BATTERY_SYSTEM_BATTERY            0x80000000
  78
  79 typedef struct _BATTERY_INFORMATION {
  80   ULONG  Capabilities;
  81   UCHAR  Technology;
  82   UCHAR  Reserved[3];
  83   UCHAR  Chemistry[4];
  84   ULONG  DesignedCapacity;
  85   ULONG  FullChargedCapacity;
  86   ULONG  DefaultAlert1;
  87   ULONG  DefaultAlert2;
  88   ULONG  CriticalBias;
  89   ULONG  CycleCount;
  90 } BATTERY_INFORMATION, *PBATTERY_INFORMATION;
  91
  92 typedef struct _BATTERY_MANUFACTURE_DATE {
  93   UCHAR  Day;
  94   UCHAR  Month;
  95   USHORT  Year;
  96 } BATTERY_MANUFACTURE_DATE, *PBATTERY_MANUFACTURE_DATE;
  97
  98 typedef struct _BATTERY_NOTIFY {
  99         ULONG  PowerState;
 100         ULONG  LowCapacity;
 101         ULONG  HighCapacity;
 102 } BATTERY_NOTIFY, *PBATTERY_NOTIFY;
 103
 104 /* BATTERY_STATUS.PowerState flags */
 105 #define BATTERY_POWER_ON_LINE             0x00000001
 106 #define BATTERY_DISCHARGING               0x00000002
 107 #define BATTERY_CHARGING                  0x00000004
 108 #define BATTERY_CRITICAL                  0x00000008
 109
 110 /* BATTERY_STATUS.Voltage constant */
 111 #define BATTERY_UNKNOWN_VOLTAGE           0xFFFFFFFF
 112
 113 /* BATTERY_STATUS.Rate constant */
 114 #define BATTERY_UNKNOWN_RATE              0x80000000
 115
 116 typedef struct _BATTERY_STATUS {
 117   ULONG  PowerState;
 118   ULONG  Capacity;
 119   ULONG  Voltage;
 120   LONG  Rate;
 121 } BATTERY_STATUS, *PBATTERY_STATUS;
 122
 123 /* BATTERY_INFORMATION.Capacity constants */
 124 #define BATTERY_UNKNOWN_CAPACITY          0xFFFFFFFF
 125
 126 typedef enum _BATTERY_QUERY_INFORMATION_LEVEL {
 127   BatteryInformation = 0,
 128   BatteryGranularityInformation,
 129   BatteryTemperature,
 130   BatteryEstimatedTime,
 131   BatteryDeviceName,
 132   BatteryManufactureDate,
 133   BatteryManufactureName,
 134   BatteryUniqueID,
 135   BatterySerialNumber
 136 } BATTERY_QUERY_INFORMATION_LEVEL;
 137
 138 /* BatteryEstimatedTime constant */
 139 #define BATTERY_UNKNOWN_TIME              0x80000000
 140
 141 /* NTSTATUS possibly returned by BCLASS_QUERY_STATUS */
 142 #define BATTERY_TAG_INVALID 0
 143
 144 typedef struct _BATTERY_QUERY_INFORMATION {
 145   ULONG  BatteryTag;
 146   BATTERY_QUERY_INFORMATION_LEVEL  InformationLevel;
 147   LONG  AtRate;
 148 } BATTERY_QUERY_INFORMATION, *PBATTERY_QUERY_INFORMATION;
 149
 150 typedef enum _BATTERY_SET_INFORMATION_LEVEL {
 151   BatteryCriticalBias = 0,
 152   BatteryCharge,
 153   BatteryDischarge
 154 } BATTERY_SET_INFORMATION_LEVEL;
 155
 156 #define MAX_BATTERY_STRING_SIZE           128
 157
 158 typedef struct _BATTERY_SET_INFORMATION {
 159         ULONG  BatteryTag;
 160         BATTERY_SET_INFORMATION_LEVEL  InformationLevel;
 161         UCHAR  Buffer[1];
 162 } BATTERY_SET_INFORMATION, *PBATTERY_SET_INFORMATION;
 163
 164 typedef struct _BATTERY_WAIT_STATUS {
 165         ULONG  BatteryTag;
 166         ULONG  Timeout;
 167         ULONG  PowerState;
 168         ULONG  LowCapacity;
 169         ULONG  HighCapacity;
 170 } BATTERY_WAIT_STATUS, *PBATTERY_WAIT_STATUS;
 171
 172
 173 #define IOCTL_BATTERY_QUERY_TAG \
 174   CTL_CODE(FILE_DEVICE_BATTERY, 0x10, METHOD_BUFFERED, FILE_READ_ACCESS)
 175
 176 #define IOCTL_BATTERY_QUERY_INFORMATION \
 177   CTL_CODE(FILE_DEVICE_BATTERY, 0x11, METHOD_BUFFERED, FILE_READ_ACCESS)
 178
 179 #define IOCTL_BATTERY_SET_INFORMATION \
 180   CTL_CODE(FILE_DEVICE_BATTERY, 0x12, METHOD_BUFFERED, FILE_WRITE_ACCESS)
 181
 182 #define IOCTL_BATTERY_QUERY_STATUS \
 183   CTL_CODE(FILE_DEVICE_BATTERY, 0x13, METHOD_BUFFERED, FILE_READ_ACCESS)
 184
 185
 186 typedef NTSTATUS
 187 (DDKAPI*BCLASS_DISABLE_STATUS_NOTIFY)(
 188   IN PVOID  Context);
 189
 190 typedef NTSTATUS
 191 (DDKAPI*BCLASS_QUERY_INFORMATION)(
 192   IN PVOID  Context,
 193   IN ULONG  BatteryTag,
 194   IN BATTERY_QUERY_INFORMATION_LEVEL  Level,
 195   IN LONG  AtRate  OPTIONAL,
 196   OUT PVOID  Buffer,
 197   IN ULONG  BufferLength,
 198   OUT PULONG  ReturnedLength);
 199
 200 typedef NTSTATUS
 201 (DDKAPI*BCLASS_QUERY_STATUS)(
 202   IN PVOID  Context,
 203   IN ULONG  BatteryTag,
 204   OUT PBATTERY_STATUS  BatteryStatus);
 205
 206 typedef NTSTATUS
 207 (DDKAPI*BCLASS_QUERY_TAG)(
 208   IN PVOID  Context,
 209   OUT PULONG  BatteryTag);
 210
 211 typedef NTSTATUS
 212 (DDKAPI*BCLASS_SET_INFORMATION)(
 213   IN PVOID  Context,
 214   IN ULONG  BatteryTag,
 215   IN BATTERY_SET_INFORMATION_LEVEL  Level,
 216   IN PVOID  Buffer  OPTIONAL);
 217
 218 typedef NTSTATUS
 219 (DDKAPI*BCLASS_SET_STATUS_NOTIFY)(
 220   IN PVOID  Context,
 221   IN ULONG  BatteryTag,
 222   IN PBATTERY_NOTIFY  BatteryNotify);
 223
 224
 225 typedef struct _BATTERY_MINIPORT_INFO {
 226   USHORT  MajorVersion;
 227   USHORT  MinorVersion;
 228   PVOID  Context;
 229   BCLASS_QUERY_TAG  QueryTag;
 230   BCLASS_QUERY_INFORMATION  QueryInformation;
 231   BCLASS_SET_INFORMATION  SetInformation;
 232   BCLASS_QUERY_STATUS  QueryStatus;
 233   BCLASS_SET_STATUS_NOTIFY  SetStatusNotify;
 234   BCLASS_DISABLE_STATUS_NOTIFY  DisableStatusNotify;
 235   PDEVICE_OBJECT  Pdo;
 236   PUNICODE_STRING  DeviceName;
 237 } BATTERY_MINIPORT_INFO, *PBATTERY_MINIPORT_INFO;
 238
 239 /* BATTERY_MINIPORT_INFO.XxxVersion */
 240 #define BATTERY_CLASS_MAJOR_VERSION       0x0001
 241 #define BATTERY_CLASS_MINOR_VERSION       0x0000
 242
 243
 244 BCLASSAPI
 245 NTSTATUS
 246 DDKAPI
 247 BatteryClassInitializeDevice(
 248   IN PBATTERY_MINIPORT_INFO  MiniportInfo,
 249   IN PVOID  *ClassData);
 250
 251 BCLASSAPI
 252 NTSTATUS
 253 DDKAPI
 254 BatteryClassIoctl(
 255   IN PVOID  ClassData,
 256   IN PIRP  Irp);
 257
 258 BCLASSAPI
 259 NTSTATUS
 260 DDKAPI
 261 BatteryClassQueryWmiDataBlock(
 262   IN PVOID  ClassData,
 263   IN PDEVICE_OBJECT  DeviceObject,
 264   IN PIRP  Irp,
 265   IN ULONG  GuidIndex,
 266   IN OUT PULONG  InstanceLengthArray,
 267   IN ULONG  OutBufferSize,
 268   OUT PUCHAR  Buffer);
 269
 270 BCLASSAPI
 271 NTSTATUS
 272 DDKAPI
 273 BatteryClassStatusNotify(
 274   IN PVOID  ClassData);
 275
 276 BCLASSAPI
 277 NTSTATUS
 278 DDKAPI
 279 BatteryClassSystemControl(
 280   IN  PVOID  ClassData,
 281   IN  PWMILIB_CONTEXT  WmiLibContext,
 282   IN  PDEVICE_OBJECT  DeviceObject,
 283   IN  PIRP  Irp,
 284   OUT PSYSCTL_IRP_DISPOSITION  Disposition);
 285
 286 BCLASSAPI
 287 NTSTATUS
 288 DDKAPI
 289 BatteryClassUnload(
 290   IN PVOID  ClassData);
 291
 292 #ifdef __cplusplus
 293 }
 294 #endif
 295
 296 #endif /* __BATCLASS_H */