iokit/IOKit/pwr_mgt/IOPMPowerSource.h

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