EvmuBattery Struct Reference

#include <evmu_battery.h>

Inheritance diagram for EvmuBattery:

Data Fields
union {
EvmuBatteryClass *   pClass
EvmuPeripheral   base
};
Data Fields inherited from EvmuPeripheral
union {
EvmuPeripheralClass *   pClass
GblObject   base
};
GblFlags	logLevel

Related Symbols
(Note that these are not member symbols.)
Alarm
Methods for getting and setting the alarm state
GblBool	EvmuBattery_lowAlarm (const EvmuBattery *pSelf)
void	EvmuBattery_setLowAlarm (EvmuBattery *pSelf, GblBool enabled)
Monitor
Methods for getting and setting the monitor state
GblBool	EvmuBattery_monitorEnabled (const EvmuBattery *pSelf)
void	EvmuBattery_setMonitorEnabled (EvmuBattery *pSelf, GblBool enabled)
Related Symbols inherited from EvmuPeripheral
EvmuDevice *	EvmuPeripheral_device (const EvmuPeripheral *pSelf)

Detailed Description

GblInstance structure for the battery peripheral.

EvmuBattery represents an instantiable EvmuPeripheral encapsulating both the low battery alarm/pin as well as the BIOS logic which monitors it. There are no public members.

See also

EvmuBatteryClass

Definition at line 66 of file evmu_battery.h.

Friends And Related Symbol Documentation

EvmuBattery_lowAlarm()

GblBool EvmuBattery_lowAlarm ( const EvmuBattery * pSelf )

related

Returns GBL_TRUE if the low voltage battery detection signal is asserted.

EvmuBattery_monitorEnabled()

GblBool EvmuBattery_monitorEnabled ( const EvmuBattery * pSelf )

related

Returns GBL_TRUE if the system BIOS low battery monitor is enabled.

EvmuBattery_setLowAlarm()

void EvmuBattery_setLowAlarm ( EvmuBattery * pSelf, GblBool enabled )

related

Sets the low battery detection circuit alarm to the enabled value.

EvmuBattery_setMonitorEnabled()

void EvmuBattery_setMonitorEnabled ( EvmuBattery * pSelf, GblBool enabled )

related

Enables or disables the system BIOS low battery monitor, based on the enabled value.

Field Documentation

base

EvmuPeripheral EvmuBattery::base

Inherited base instance structure.

Definition at line 66 of file evmu_battery.h.

pClass

EvmuBatteryClass* EvmuBattery::pClass

Pointer to class/vtable structure.

Definition at line 66 of file evmu_battery.h.

---

The documentation for this struct was generated from the following file:

• evmu_battery.h