/*
- * Copyright (c) 1998-2005 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 1998-2019 Apple Inc. All rights reserved.
*
- * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
- *
- * This file contains Original Code and/or Modifications of Original Code
- * as defined in and that are subject to the Apple Public Source License
- * Version 2.0 (the 'License'). You may not use this file except in
- * compliance with the License. The rights granted to you under the
- * License may not be used to create, or enable the creation or
- * redistribution of, unlawful or unlicensed copies of an Apple operating
- * system, or to circumvent, violate, or enable the circumvention or
- * violation of, any terms of an Apple operating system software license
- * agreement.
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
*
- * Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this
- * file.
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
*
- * The Original Code and all software distributed under the License are
- * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
- * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
- * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
- * Please see the License for the specific language governing rights and
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
* limitations under the License.
*
- * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
*/
-
+
#ifndef _IOPMPowerSource_h_
#define _IOPMPowerSource_h_
#include <IOKit/IOService.h>
enum {
- kSecondsPerHour = 3600,
- kTenMinutesInSeconds = 600
+ kSecondsPerHour = 3600,
+ kTenMinutesInSeconds = 600
};
-/* class IOPMPowerSource
+
+/*! @class IOPMPowerSource
*
* See IOKit/pwr_mgt/IOPM.h for power source keys relevant to this class. These
* report-type keys are required for calls to IOPMPowerSource::setReportables(),
*
* A subclassing driver that doesn't want to do anything fancy should:
* 1. Subclass IOPMPowerSource
- * 3. Install its own battery change notifications or polling routine that can
+ * 2. Install its own battery change notifications or polling routine that can
* converse with actual battery hardware.
- * 4. When battery state changes, change the relevant member variables
+ * 3. When battery state changes, change the relevant member variables
* through setCurrentCapacity() style accessors.
- * 5. Call updateStatus() on itself when all such settings have been updated.
- *
+ * 4. Call updateStatus() on itself when all such settings have been updated.
+ *
* The subclass driver should also initially populate its settings and call
* updateStatus() on launch.
*
*
- * Settings
+ * Settings:
*
+ * <pre>
* ExternalConnected
* Type: bool
* IORegistry Key: kIOPMPSExternalConnectedKey
- * True if computer is drawing external power
+ * True if computer is drawing external power
*
* ExternalChargeCapable
* Type: bool
* IORegistry Key: kIOPMPSManufacturerKey
* String describing battery manufacturer
*
+ * Manufactured Date
+ * Type: unsigned 16-bit bitfield
+ * IORegistry Key: kIOPMPSManufactureDateKey
+ * Date is published in a bitfield per the Smart Battery Data spec rev 1.1
+ * in section 5.1.26
+ * Bits 0...4 => day (value 1-31; 5 bits)
+ * Bits 5...8 => month (value 1-12; 4 bits)
+ * Bits 9...15 => years since 1980 (value 0-127; 7 bits)
+ *
* Model
* Type: OSSymbol
* IORegistry Key: kIOPMPSModelKey
* Serial
* Type: OSSymbol
* IORegistry Key: kIOPMPSSerialKey
- * String describing serial number or unique info
+ * String describing serial number or unique info
+ * The serial number published hear bears no correspondence to the Apple serial
+ * number printed on each battery. This is a manufacturer serial number with
+ * no correlation to the printed serial number.
*
* LegacyIOBatteryInfo
* Type: OSDictionary
* IORegistry Key: kIOPMPSLegacyBatteryInfoKey
- * Dictionary conforming to the OS X 10.0-10.4
+ * Dictionary conforming to the OS X 10.0-10.4
+ * </pre>
*/
class IOPMPowerSource : public IOService
{
- OSDeclareDefaultStructors(IOPMPowerSource)
+ OSDeclareDefaultStructors(IOPMPowerSource);
+
+ friend class IOPMPowerSourceList;
- friend class IOPMPowerSourceList;
+protected:
+
+/*! @var settingsChangedSinceLastUpdate
+ * Used by subclasses to determine if any settings have been modified via the
+ * accessors below since last call to update(). true is settings have changed;
+ * false otherwise.
+ */
+ bool settingsChangedSinceUpdate;
+
+/*! @var properties
+ * Stores power source state
+ */
+ OSDictionary *properties;
- protected:
- // Tracking for IOPMPowerSourceList
- IOPMPowerSource *nextInList;
-
- OSDictionary *properties;
+ const OSSymbol *externalConnectedKey;
+ const OSSymbol *externalChargeCapableKey;
+ const OSSymbol *batteryInstalledKey;
+ const OSSymbol *chargingKey;
+ const OSSymbol *warnLevelKey;
+ const OSSymbol *criticalLevelKey;
+ const OSSymbol *currentCapacityKey;
+ const OSSymbol *maxCapacityKey;
+ const OSSymbol *timeRemainingKey;
+ const OSSymbol *amperageKey;
+ const OSSymbol *voltageKey;
+ const OSSymbol *cycleCountKey;
+ const OSSymbol *adapterInfoKey;
+ const OSSymbol *locationKey;
+ const OSSymbol *errorConditionKey;
+ const OSSymbol *manufacturerKey;
+ const OSSymbol *modelKey;
+ const OSSymbol *serialKey;
+ const OSSymbol *batteryInfoKey;
- const OSSymbol *externalConnectedKey;
- const OSSymbol *externalChargeCapableKey;
- const OSSymbol *batteryInstalledKey;
- const OSSymbol *chargingKey;
- const OSSymbol *warnLevelKey;
- const OSSymbol *criticalLevelKey;
- const OSSymbol *currentCapacityKey;
- const OSSymbol *maxCapacityKey;
- const OSSymbol *timeRemainingKey;
- const OSSymbol *amperageKey;
- const OSSymbol *voltageKey;
- const OSSymbol *cycleCountKey;
- const OSSymbol *adapterInfoKey;
- const OSSymbol *locationKey;
- const OSSymbol *errorConditionKey;
- const OSSymbol *manufacturerKey;
- const OSSymbol *modelKey;
- const OSSymbol *serialKey;
- const OSSymbol *batteryInfoKey;
+// Tracking for IOPMPowerSourceList
+ IOPMPowerSource *nextInList;
- public:
+public:
/*! @function powerSource
- @abstract Creates a new IOPMPowerSource nub. Must be attached to IORegistry,
- and registered by provider.
-*/
- static IOPMPowerSource *powerSource(void);
+ * @abstract Creates a new IOPMPowerSource nub. Must be attached to IORegistry,
+ * and registered by provider.
+ */
+ static IOPMPowerSource *powerSource(void);
+
+ virtual bool init(void) APPLE_KEXT_OVERRIDE;
- virtual bool init(void);
-
- virtual void free(void);
+ virtual void free(void) APPLE_KEXT_OVERRIDE;
/*! @function updateStatus
- @abstract Must be called by physical battery controller when battery state
- has changed significantly.
- @discussion The system will not poll this object for battery updates. Rather \
- the battery's controller must call updateStatus() every time state changes \
- and the settings will be relayed to higher levels of power management. \
- The subclassing driver should override this only if the driver needs to add \
- new settings to the base class.
-*/
- virtual void updateStatus(void);
+ * @abstract Must be called by physical battery controller when battery state
+ * has changed significantly.
+ * @discussion The system will not poll this object for battery updates. Rather \
+ * the battery's controller must call updateStatus() every time state changes \
+ * and the settings will be relayed to higher levels of power management. \
+ * The subclassing driver should override this only if the driver needs to add \
+ * new settings to the base class.
+ */
+ virtual void updateStatus(void);
/* Public accessors for battery state
*/
- bool externalConnected(void);
- bool externalChargeCapable(void);
- bool batteryInstalled(void);
- bool isCharging(void);
- bool atWarnLevel(void);
- bool atCriticalLevel(void);
+ bool externalConnected(void);
+ bool externalChargeCapable(void);
+ bool batteryInstalled(void);
+ bool isCharging(void);
+ bool atWarnLevel(void);
+ bool atCriticalLevel(void);
+
+ unsigned int currentCapacity(void);
+ unsigned int maxCapacity(void);
+ unsigned int capacityPercentRemaining(void);
+ int timeRemaining(void);
+ int amperage(void);
+ unsigned int voltage(void);
+ unsigned int cycleCount(void);
+ int adapterInfo(void);
+ int location(void);
+
+ OSSymbol *errorCondition(void);
+ OSSymbol *manufacturer(void);
+ OSSymbol *model(void);
+ OSSymbol *serial(void);
+ OSDictionary *legacyIOBatteryInfo(void);
+
+ OSObject *getPSProperty(const OSSymbol *);
- unsigned int currentCapacity(void);
- unsigned int maxCapacity(void);
- unsigned int capacityPercentRemaining(void);
- int timeRemaining(void);
- int amperage(void);
- unsigned int voltage(void);
- unsigned int cycleCount(void);
- int adapterInfo(void);
- int location(void);
-
- OSSymbol *errorCondition(void);
- OSSymbol *manufacturer(void);
- OSSymbol *model(void);
- OSSymbol *serial(void);
- OSDictionary *legacyIOBatteryInfo(void);
-
protected:
+
/* Protected "setter" methods for subclasses
* Subclasses should use these setters to modify all battery properties.
- *
- * Subclasses must follow all property changes with a call to updateStatus()
+ *
+ * Subclasses must follow all property changes with a call to updateStatus()
* to flush settings changes to upper level battery API clients.
*
*/
- void setExternalConnected(bool);
- void setExternalChargeCapable(bool);
- void setBatteryInstalled(bool);
- void setIsCharging(bool);
- void setAtWarnLevel(bool);
- void setAtCriticalLevel(bool);
+ void setExternalConnected(bool);
+ void setExternalChargeCapable(bool);
+ void setBatteryInstalled(bool);
+ void setIsCharging(bool);
+ void setAtWarnLevel(bool);
+ void setAtCriticalLevel(bool);
- void setCurrentCapacity(unsigned int);
- void setMaxCapacity(unsigned int);
- void setTimeRemaining(int);
- void setAmperage(int);
- void setVoltage(unsigned int);
- void setCycleCount(unsigned int);
- void setAdapterInfo(int);
- void setLocation(int);
+ void setCurrentCapacity(unsigned int);
+ void setMaxCapacity(unsigned int);
+ void setTimeRemaining(int);
+ void setAmperage(int);
+ void setVoltage(unsigned int);
+ void setCycleCount(unsigned int);
+ void setAdapterInfo(int);
+ void setLocation(int);
- void setErrorCondition(OSSymbol *);
- void setManufacturer(OSSymbol *);
- void setModel(OSSymbol *);
- void setSerial(OSSymbol *);
- void setLegacyIOBatteryInfo(OSDictionary *);
-
+ void setErrorCondition(OSSymbol *);
+ void setManufacturer(OSSymbol *);
+ void setModel(OSSymbol *);
+ void setSerial(OSSymbol *);
+ void setLegacyIOBatteryInfo(OSDictionary *);
+
+/*! All of these methods funnel through the generic accessor method
+ * setPSProperty. Caller can pass in any arbitrary OSSymbol key, and
+ * that value will be stored in the PM settings dictionary, and relayed
+ * onto the IORegistry at update time.
+ */
+ void setPSProperty(const OSSymbol *, OSObject *);
};
#endif
projects / apple / xnu.git / blobdiff