firmware/export/power.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 by Linus Nielsen Feltzing
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21 #ifndef _POWER_H_
  22 #define _POWER_H_
  23
  24 #include "config.h"
  25
  26 #if CONFIG_CHARGING
  27 enum power_input_flags {
  28     /* No external power source? Default. */
  29     POWER_INPUT_NONE = 0x00,
  30
  31     /* Main power source is available (AC?), the default other than
  32      * battery if for instance USB and others cannot be distinguished or
  33      * USB is the only possibility. */
  34     POWER_INPUT_MAIN = 0x01,
  35
  36     /* USB power source is available (and is discernable from MAIN). */
  37     POWER_INPUT_USB  = 0x02,
  38
  39     /* Something is plugged. */
  40     POWER_INPUT = 0x0f,
  41
  42     /* POWER_INPUT_*_CHARGER of course implies presence of the respective
  43      * power source. */
  44
  45     /* Battery not included in CHARGER (it can't charge itself) */
  46
  47     /* Charging is possible on main. */
  48     POWER_INPUT_MAIN_CHARGER = 0x10 | POWER_INPUT_MAIN,
  49
  50     /* Charging is possible on USB. */
  51     POWER_INPUT_USB_CHARGER = 0x20 | POWER_INPUT_USB,
  52
  53     /* Charging is possible from something. */
  54     POWER_INPUT_CHARGER = 0xf0,
  55
  56 #ifdef HAVE_BATTERY_SWITCH
  57     /* Battery is powering device or is available to power device. It
  58      * could also be used if the battery is hot-swappable to indicate if
  59      * it is present ("switch" as verb vs. noun). */
  60     POWER_INPUT_BATTERY = 0x100,
  61 #endif
  62 };
  63
  64 /* Returns detailed power input status information from device. */
  65 unsigned int power_input_status(void);
  66
  67 /* Shortcuts */
  68 /* Returns true if any power source that is connected is capable of
  69  * charging the batteries.
  70  * > (power_input_status() & POWER_INPUT_CHARGER) != 0 */
  71 bool charger_inserted(void);
  72
  73 /* Returns true if any power input is connected - charging-capable
  74  * or not.
  75  * > (power_input_status() & POWER_INPUT) != 0 */
  76 bool power_input_present(void);
  77 #endif /* CONFIG_CHARGING */
  78
  79 void power_off(void);
  80 void ide_power_enable(bool on);
  81
  82 #if CONFIG_CHARGING >= CHARGING_MONITOR
  83 bool charging_state(void);
  84 #endif
  85
  86 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
  87
  88 void power_init(void) INIT_ATTR;
  89
  90 bool ide_powered(void);
  91 #endif
  92
  93 #ifdef HAVE_SPDIF_POWER
  94 void spdif_power_enable(bool on);
  95 bool spdif_powered(void);
  96 #endif
  97
  98 #if CONFIG_TUNER
  99 bool tuner_power(bool status);
 100 bool tuner_powered(void);
 101 #endif
 102
 103 #endif /* _POWER_H_ */