iokit/IOKit/pwr_mgt/IOPMpowerState.h

   1 /*
   2  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 #include <IOKit/pwr_mgt/IOPM.h>
  26
  27 struct IOPMPowerState
  28 {
  29  unsigned long  version;                // version number of this struct
  30 IOPMPowerFlags  capabilityFlags;        // bits that describe (to interested drivers) the capability of the device in this state
  31 IOPMPowerFlags  outputPowerCharacter;   // description (to power domain children) of the power provided in this state
  32 IOPMPowerFlags  inputPowerRequirement;  // description (to power domain parent) of input power required in this state
  33 unsigned long   staticPower;    // average consumption in milliwatts
  34 unsigned long   unbudgetedPower;        // additional consumption from separate power supply (mw)
  35 unsigned long   powerToAttain;  // additional power to attain this state from next lower state (in mw)
  36 unsigned long   timeToAttain;   // time required to enter this state from next lower state (in microseconds)
  37 unsigned long   settleUpTime;   // settle time required after entering this state from next lower state (microseconds)
  38 unsigned long   timeToLower;    // time required to enter next lower state from this one (in microseconds)
  39 unsigned long   settleDownTime; // settle time required after entering next lower state from this state (microseconds)
  40 unsigned long   powerDomainBudget;      // power in mw a domain in this state can deliver to its children
  41 };
  42
  43 typedef struct IOPMPowerState IOPMPowerState;
  44
  45 enum {
  46     kIOPMPowerStateVersion1 = 1
  47 };