iokit/IOKit/pwr_mgt/IOPMPowerSource.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License.  The rights granted to you under the
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 #include <libkern/c++/OSObject.h>
  31 #include <IOKit/IOTypes.h>
  32 #include <IOKit/IOReturn.h>
  33 #include "IOPM.h"
  34
  35 class ApplePMU;
  36
  37 const unsigned long kSecondsPerHour = (60*60);
  38 const unsigned long kTenMinutesInSeconds = (10 * 60);
  39
  40 // our battery (power source) object
  41
  42 class IOPMPowerSource : public OSObject
  43 {
  44     OSDeclareDefaultStructors(IOPMPowerSource)
  45
  46  protected:
  47
  48     UInt32             bFlags;
  49     UInt32             bTimeRemaining;
  50     UInt16             bCurCapacity;
  51     UInt16             bMaxCapacity;
  52     SInt16             bCurrent;
  53     UInt16             bVoltage;
  54     UInt16             bBatteryIndex;
  55
  56  public:
  57
  58     IOPMPowerSource * nextInList;
  59
  60     bool               init (unsigned short whichBatteryIndex);
  61     unsigned long      capacityPercentRemaining (void);
  62     bool               atWarnLevel (void);
  63     bool               depleted (void);
  64
  65     // accessors
  66
  67     bool               isInstalled (void);
  68     bool               isCharging (void);
  69     bool               acConnected (void);
  70     unsigned long      timeRemaining (void);
  71     unsigned long      maxCapacity (void);
  72     unsigned long      curCapacity (void);
  73     long               currentDrawn (void);
  74     unsigned long      voltage (void);
  75
  76     // calculations
  77
  78     // function updateStatus is called whenever the system needs
  79     // to obtain the latest power source state...must be overridden
  80     // by subclasses.
  81     virtual void updateStatus (void);
  82 };
  83
  84
  85