xnu-1699.24.23.tar.gz

[apple/xnu.git] / iokit / IOKit / pwr_mgt / IOPMpowerState.h

diff --git a/iokit/IOKit/pwr_mgt/IOPMpowerState.h b/iokit/IOKit/pwr_mgt/IOPMpowerState.h
index 54d4e8f5a86a14086caf6a0c1be281ef19baed2d..f7f4c8a602769f6f6026bb4d19b136d5b5d5c8bf 100644 (file)
--- a/iokit/IOKit/pwr_mgt/IOPMpowerState.h
+++ b/iokit/IOKit/pwr_mgt/IOPMpowerState.h
@@ -27,20 +27,42 @@
  */
 #include <IOKit/pwr_mgt/IOPM.h>
 
+/*! @header IOPMpowerState.h
+    @abstract Defines the struct IOPMPowerState that power managed drivers should use to describe their power states.
+*/
+
+/*! @struct IOPMPowerState
+    @abstract Describes a device's power state.
+    @discussion To take part in system power management, drivers should define an array of 2 or more power states and pass it to kernel power management through IOService::registerPowerDriver.
+    @field version Defines version number of this struct. Just use the value "1" when defining an IOPMPowerState.
+    @field     capabilityFlags Describes the capability of the device in this state.
+    @field     outputPowerCharacter Describes the power provided in this state.
+    @field     inputPowerRequirement Describes the input power required in this state.
+    @field     staticPower Describes average consumption in milliwatts. Unused; drivers may specify 0.
+    @field     unbudgetedPower Describes additional consumption from separate power supply (milliWatts). Unused; drivers may specify 0.
+    @field     powerToAttain Describes dditional power to attain this state from next lower state (in milliWatts). Unused; drivers may specify 0.
+    @field     timeToAttain Describes time required to enter this state from next lower state (in microseconds). Unused; drivers may specify 0.
+    @field     settleUpTime Describes settle time required after entering this state from next lower state (microseconds). Unused; drivers may specify 0.
+    @field timeToLower Describes time required to enter next lower state from this one (microseconds). Unused; drivers may specify 0.
+    @field     settleDownTime Settle time required after entering next lower state from this state (microseconds). Unused; drivers may specify 0.
+    @field     powerDomainBudget Describes power in milliWatts a domain in this state can deliver to its children. Unused; drivers may specify 0.
+}
+*/
+
 struct IOPMPowerState
 {
- unsigned long version;                // version number of this struct
-IOPMPowerFlags capabilityFlags;        // bits that describe (to interested drivers) the capability of the device in this state 
-IOPMPowerFlags outputPowerCharacter;   // description (to power domain children) of the power provided in this state 
-IOPMPowerFlags inputPowerRequirement;  // description (to power domain parent) of input power required in this state
-unsigned long  staticPower;    // average consumption in milliwatts
-unsigned long  unbudgetedPower;        // additional consumption from separate power supply (mw)
-unsigned long  powerToAttain;  // additional power to attain this state from next lower state (in mw)
-unsigned long  timeToAttain;   // time required to enter this state from next lower state (in microseconds)
-unsigned long  settleUpTime;   // settle time required after entering this state from next lower state (microseconds)
-unsigned long  timeToLower;    // time required to enter next lower state from this one (in microseconds)
-unsigned long  settleDownTime; // settle time required after entering next lower state from this state (microseconds)
-unsigned long  powerDomainBudget;      // power in mw a domain in this state can deliver to its children
+    unsigned long      version;
+    IOPMPowerFlags     capabilityFlags;
+    IOPMPowerFlags     outputPowerCharacter;
+    IOPMPowerFlags     inputPowerRequirement;
+    unsigned long      staticPower;
+    unsigned long      unbudgetedPower;
+    unsigned long      powerToAttain;
+    unsigned long      timeToAttain;
+    unsigned long      settleUpTime;
+    unsigned long      timeToLower;
+    unsigned long      settleDownTime;
+    unsigned long      powerDomainBudget;
 };
 
 typedef struct IOPMPowerState IOPMPowerState;