mirror of
https://github.com/reactos/reactos.git
synced 2025-03-01 03:45:16 +00:00
a8da29e888
Move these out of ACPI in preparation for ACPI_NEW so they keep their juicy commit history. Also both ACPIs can coexist for awhile as I don't see the old driver getting removed anytime soon.
329 lines
9 KiB
C
329 lines
9 KiB
C
/*
|
|
* PROJECT: ReactOS Composite Battery Driver
|
|
* LICENSE: MIT (https://spdx.org/licenses/MIT)
|
|
* PURPOSE: Composite battery main header file
|
|
* COPYRIGHT: Copyright 2010 ReactOS Portable Systems Group <ros.arm@reactos.org>
|
|
* Copyright 2024 George Bișoc <george.bisoc@reactos.org>
|
|
*/
|
|
|
|
/* INCLUDES *******************************************************************/
|
|
|
|
#ifndef _COMPBATT_PCH_
|
|
#define _COMPBATT_PCH_
|
|
|
|
#include <wdm.h>
|
|
#include <batclass.h>
|
|
|
|
/* DEFINES ********************************************************************/
|
|
|
|
//
|
|
// I/O remove lock allocate tag
|
|
//
|
|
#define COMPBATT_TAG 'aBoC'
|
|
|
|
//
|
|
// Composite battery flags
|
|
//
|
|
#define COMPBATT_BATTERY_INFORMATION_PRESENT 0x04
|
|
#define COMPBATT_STATUS_NOTIFY_SET 0x10
|
|
#define COMPBATT_TAG_ASSIGNED 0x80
|
|
|
|
//
|
|
// IRP complete worker mode states
|
|
//
|
|
#define COMPBATT_QUERY_TAG 1
|
|
#define COMPBATT_READ_STATUS 2
|
|
|
|
//
|
|
// Low/High capacity wait constants
|
|
//
|
|
#define COMPBATT_WAIT_MIN_LOW_CAPACITY 0
|
|
#define COMPBATT_WAIT_MAX_HIGH_CAPACITY 0x7FFFFFFF
|
|
|
|
//
|
|
// One hour in seconds, used to calculate the total rate of each battery for time estimation
|
|
//
|
|
#define COMPBATT_ATRATE_HOUR_IN_SECS 3600
|
|
|
|
//
|
|
// Time constant of which the battery status data is considered fresh (50000000 * 100ns == 5s)
|
|
//
|
|
#define COMPBATT_FRESH_STATUS_TIME 50000000
|
|
|
|
//
|
|
// Macro that calculates the delta of a battery's capacity
|
|
//
|
|
#define COMPUTE_BATT_CAP_DELTA(LowDiff, Batt, TotalRate) \
|
|
((ULONG)(((LONGLONG)LowDiff * (Batt)->BatteryStatus.Rate) / TotalRate))
|
|
|
|
//
|
|
// Macro that calculates the "At Rate" time drain of the battery
|
|
//
|
|
#define COMPUTE_ATRATE_DRAIN(Batt, Time) \
|
|
((LONG)((Batt)->BatteryStatus.Capacity) * COMPBATT_ATRATE_HOUR_IN_SECS / Time)
|
|
|
|
//
|
|
// Composite battery debug levels
|
|
//
|
|
#define COMPBATT_DEBUG_INFO 0x1
|
|
#define COMPBATT_DEBUG_TRACE 0x2
|
|
#define COMPBATT_DEBUG_WARN 0x4
|
|
#define COMPBATT_DEBUG_ERR 0x10
|
|
#define COMPBATT_DEBUG_ALL_LEVELS (COMPBATT_DEBUG_INFO | COMPBATT_DEBUG_TRACE | COMPBATT_DEBUG_WARN | COMPBATT_DEBUG_ERR)
|
|
|
|
/* STRUCTURES *****************************************************************/
|
|
|
|
//
|
|
// Individual ACPI battery data
|
|
//
|
|
typedef struct _COMPBATT_BATTERY_DATA
|
|
{
|
|
/* The linked battery with the Composite Battery */
|
|
LIST_ENTRY BatteryLink;
|
|
|
|
/* I/O remove lock which protects the battery from being removed */
|
|
IO_REMOVE_LOCK RemoveLock;
|
|
|
|
/*
|
|
* The associated device object (usually CMBATT) and the I/O battery packet
|
|
* which is used to transport and gather battery data.
|
|
*/
|
|
PDEVICE_OBJECT DeviceObject;
|
|
PIRP Irp;
|
|
|
|
/*
|
|
* The Executive work item, which serves as a worker item for the
|
|
* IRP battery monitor worker.
|
|
*/
|
|
WORK_QUEUE_ITEM WorkItem;
|
|
|
|
/*
|
|
* Execution state mode of the individual battery. Only two modes are valid:
|
|
*
|
|
* COMPBATT_QUERY_TAG - The battery is currently waiting for a tag to get assigned;
|
|
* COMPBATT_READ_STATUS - The battery is querying battery status.
|
|
*/
|
|
UCHAR Mode;
|
|
|
|
/*
|
|
* The battery wait configuration settings, set up by the SetStatusNotify method.
|
|
* These values are used to instruct CMBATT when the battery status should be retrieved.
|
|
*/
|
|
BATTERY_WAIT_STATUS WaitStatus;
|
|
|
|
/*
|
|
* A union that serves as the buffer which holds battery monitor IRP data, specifically
|
|
* managed by CompBattMonitorIrpCompleteWorker, to avoid allocating separate memory pools.
|
|
*/
|
|
union
|
|
{
|
|
BATTERY_WAIT_STATUS WorkerWaitStatus;
|
|
BATTERY_STATUS WorkerStatus;
|
|
ULONG WorkerTag;
|
|
} WorkerBuffer;
|
|
|
|
/* The ID of the battery that associates the identification of this battery */
|
|
ULONG Tag;
|
|
|
|
/*
|
|
* The battery flags that govern the behavior of the battery. The valid flags are:
|
|
*
|
|
* COMPBATT_BATTERY_INFORMATION_PRESENT - The static battery information ha been
|
|
* queried. Re-querying such information is not needed.
|
|
*
|
|
* COMPBATT_STATUS_NOTIFY_SET - The current notification wait settings are valid.
|
|
*
|
|
* COMPBATT_TAG_ASSIGNED - The battery has a tag assigned and it can be read.
|
|
*/
|
|
ULONG Flags;
|
|
|
|
/* The static battery information and battery status */
|
|
BATTERY_INFORMATION BatteryInformation;
|
|
BATTERY_STATUS BatteryStatus;
|
|
|
|
/* The interrupt time of which the battery status was last read */
|
|
ULONGLONG InterruptTime;
|
|
|
|
/* A uniquely given name of the battery that associates it */
|
|
UNICODE_STRING BatteryName;
|
|
} COMPBATT_BATTERY_DATA, *PCOMPBATT_BATTERY_DATA;
|
|
|
|
//
|
|
// Composite battery device extension data
|
|
//
|
|
typedef struct _COMPBATT_DEVICE_EXTENSION
|
|
{
|
|
/*
|
|
* The class data initialized and used by Battery Class. It contains information
|
|
* such as miniport data used for registration and communication between the
|
|
* Composite Battery and Battery Class, wait and context events, etc.
|
|
*/
|
|
PVOID ClassData;
|
|
|
|
/*
|
|
* The successor computed tag. This field is used when there are more upcoming
|
|
* batteries to be connected with the Composite Battery, of which the tag is
|
|
* incremented by 1 by each new battery that is connected.
|
|
*/
|
|
ULONG NextTag;
|
|
|
|
/* A list of linked batteries connected with the Composite Battery */
|
|
LIST_ENTRY BatteryList;
|
|
|
|
/* A mutex lock which ensures proper synchronization of Composite Battery operations */
|
|
FAST_MUTEX Lock;
|
|
|
|
/* The ID of the Composite Battery */
|
|
ULONG Tag;
|
|
|
|
/*
|
|
* The battery flags that govern the behavior of the battery. The valid flags are:
|
|
*
|
|
* COMPBATT_BATTERY_INFORMATION_PRESENT - The static battery information has been
|
|
* queried. Re-querying such information is not needed.
|
|
*
|
|
* COMPBATT_STATUS_NOTIFY_SET - The current notification wait settings are valid.
|
|
*
|
|
* COMPBATT_TAG_ASSIGNED - The battery has a tag assigned and it can be read.
|
|
*/
|
|
ULONG Flags;
|
|
|
|
/*
|
|
* The Composite Battery static information, status and wait status settings.
|
|
* Note that both the battery information and status are combined, based upon
|
|
* the individual information and status of each linked battery.
|
|
*/
|
|
BATTERY_INFORMATION BatteryInformation;
|
|
BATTERY_STATUS BatteryStatus;
|
|
BATTERY_WAIT_STATUS WaitNotifyStatus;
|
|
|
|
/* The interrupt time of which the battery status was last read */
|
|
ULONGLONG InterruptTime;
|
|
|
|
/*
|
|
* The physical device object that associates the Composite Battery and
|
|
* the attached device, typically the ACPI driver.
|
|
*/
|
|
PDEVICE_OBJECT AttachedDevice;
|
|
PDEVICE_OBJECT DeviceObject;
|
|
|
|
/* The notification entry that identifies the registered I/O PnP notification */
|
|
PVOID NotificationEntry;
|
|
} COMPBATT_DEVICE_EXTENSION, *PCOMPBATT_DEVICE_EXTENSION;
|
|
|
|
/* PROTOTYPES *****************************************************************/
|
|
|
|
NTSTATUS
|
|
NTAPI
|
|
CompBattAddDevice(
|
|
_In_ PDRIVER_OBJECT DriverObject,
|
|
_In_ PDEVICE_OBJECT PdoDeviceObject
|
|
);
|
|
|
|
NTSTATUS
|
|
NTAPI
|
|
CompBattPowerDispatch(
|
|
_In_ PDEVICE_OBJECT DeviceObject,
|
|
_In_ PIRP Irp
|
|
);
|
|
|
|
NTSTATUS
|
|
NTAPI
|
|
CompBattPnpDispatch(
|
|
_In_ PDEVICE_OBJECT DeviceObject,
|
|
_In_ PIRP Irp
|
|
);
|
|
|
|
NTSTATUS
|
|
NTAPI
|
|
CompBattQueryInformation(
|
|
_In_ PCOMPBATT_DEVICE_EXTENSION FdoExtension,
|
|
_In_ ULONG Tag,
|
|
_In_ BATTERY_QUERY_INFORMATION_LEVEL InfoLevel,
|
|
_In_opt_ LONG AtRate,
|
|
_In_ PVOID Buffer,
|
|
_In_ ULONG BufferLength,
|
|
_Out_ PULONG ReturnedLength
|
|
);
|
|
|
|
NTSTATUS
|
|
NTAPI
|
|
CompBattQueryStatus(
|
|
_In_ PCOMPBATT_DEVICE_EXTENSION DeviceExtension,
|
|
_In_ ULONG Tag,
|
|
_Out_ PBATTERY_STATUS BatteryStatus
|
|
);
|
|
|
|
NTSTATUS
|
|
NTAPI
|
|
CompBattGetEstimatedTime(
|
|
_Out_ PULONG Time,
|
|
_In_ PCOMPBATT_DEVICE_EXTENSION DeviceExtension
|
|
);
|
|
|
|
NTSTATUS
|
|
NTAPI
|
|
CompBattSetStatusNotify(
|
|
_In_ PCOMPBATT_DEVICE_EXTENSION DeviceExtension,
|
|
_In_ ULONG BatteryTag,
|
|
_In_ PBATTERY_NOTIFY BatteryNotify
|
|
);
|
|
|
|
NTSTATUS
|
|
NTAPI
|
|
CompBattDisableStatusNotify(
|
|
_In_ PCOMPBATT_DEVICE_EXTENSION DeviceExtension
|
|
);
|
|
|
|
NTSTATUS
|
|
NTAPI
|
|
CompBattQueryTag(
|
|
_In_ PCOMPBATT_DEVICE_EXTENSION DeviceExtension,
|
|
_Out_ PULONG Tag
|
|
);
|
|
|
|
NTSTATUS
|
|
NTAPI
|
|
CompBattMonitorIrpComplete(
|
|
_In_ PDEVICE_OBJECT DeviceObject,
|
|
_In_ PIRP Irp,
|
|
_In_ PVOID Context
|
|
);
|
|
|
|
VOID
|
|
NTAPI
|
|
CompBattMonitorIrpCompleteWorker(
|
|
_In_ PCOMPBATT_BATTERY_DATA BatteryData
|
|
);
|
|
|
|
NTSTATUS
|
|
NTAPI
|
|
CompBattGetDeviceObjectPointer(
|
|
_In_ PUNICODE_STRING DeviceName,
|
|
_In_ ACCESS_MASK DesiredAccess,
|
|
_Out_ PFILE_OBJECT *FileObject,
|
|
_Out_ PDEVICE_OBJECT *DeviceObject
|
|
);
|
|
|
|
NTSTATUS
|
|
NTAPI
|
|
BatteryIoctl(
|
|
_In_ ULONG IoControlCode,
|
|
_In_ PDEVICE_OBJECT DeviceObject,
|
|
_In_ PVOID InputBuffer,
|
|
_In_ ULONG InputBufferLength,
|
|
_Out_ PVOID OutputBuffer,
|
|
_Inout_ ULONG OutputBufferLength,
|
|
_In_ BOOLEAN InternalDeviceIoControl
|
|
);
|
|
|
|
NTSTATUS
|
|
NTAPI
|
|
CompBattRemoveBattery(
|
|
_In_ PUNICODE_STRING BatteryName,
|
|
_In_ PCOMPBATT_DEVICE_EXTENSION DeviceExtension
|
|
);
|
|
|
|
extern ULONG CompBattDebug;
|
|
|
|
#endif /* _COMPBATT_PCH_ */
|