powerlib.h

Go to the documentation of this file.

/***************************************************************************
 *                                                                         *
 *                         Powersave Daemon                                *
 *                                                                         *
 *          Copyright (C) 2004,2005 SUSE Linux Products GmbH               *
 *                                                                         *
 *               Author(s): Holger Macht <hmacht@suse.de>                  *
 *                                                                         *
 * This program is free software; you can redistribute it and/or modify it *
 * under the terms of the GNU General Public License as published by the   *
 * Free Software Foundation; either version 2 of the License, or (at you   *
 * option) any later version.                                              *
 *                                                                         *
 * This program is distributed in the hope that it will be useful, but     *
 * WITHOUT ANY WARRANTY; without even the implied warranty of              *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU       *
 * General Public License for more details.                                *
 *                                                                         *
 * You should have received a copy of the GNU General Public License along *
 * with this program; if not, write to the Free Software Foundation, Inc., *
 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA                  *
 *                                                                         *
 ***************************************************************************/

#ifndef POWERSAVE_POWERLIB_H
#define POWERSAVE_POWERLIB_H

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#include <stdio.h>
#include <syslog.h>
#include <stdint.h>

#define MAX_FILE_PATH 512

#define MAX_LINE_SIZE 1024

#define MAX_BATTERIES 4

#define MAX_BAT_CHAR_LEN 200

#define MAX_THERMAL_ACTIVE 10

#define NO_ACPI_ERROR -20

#define NO_MODULE_ERROR -10

#define NO_DEVICE_ERROR -5

#define MAX_SUPPORTED_CPUS 32

#define UNKNOWN -1

#define CHARG_STATE_UNKNOWN     0
/* @brief battery is currently charging */
#define CHARG_STATE_CHARGING    1

#define CHARG_STATE_DISCHARGING 2

#define CHARG_STATE_CHARG_DISCHARG (CHARG_STATE_CHARGING | CHARG_STATE_DISCHARGING)

#define ACPI_S1 1

#define ACPI_S2 2

#define ACPI_S3 4

#define ACPI_S3_BIOS 8

#define ACPI_S4 16

#define ACPI_S4_BIOS 32

#define APM_STANDBY 64

#define APM_SUSPEND 128

/* debugging macros and defines */
#ifdef POWERSAVE_DEBUG
#define DBG_ERR 1
#define DBG_WARN 2
#define DBG_DIAG 4
#define DBG_INFO 8
#define DBG_DEBUG 16

        extern int DEBUG_LEVEL;
#ifdef USE_SYSLOG
        static int syslog_open = 0;
#define pDebug(level, string, args...) \
do{\
        if (!syslog_open){ \
                openlog("[powersave]",0 , LOG_DAEMON); \
                syslog_open = 1; \
        } \
        if (DEBUG_LEVEL & DBG_ERR & level){ \
              syslog(LOG_ERR,     "ERROR (%s:%d) "string, __FUNCTION__, __LINE__, ## args); \
        }else if (DEBUG_LEVEL & DBG_WARN & level) { \
              syslog(LOG_WARNING, "WARNING (%s:%d) "string, __FUNCTION__, __LINE__, ## args); \
        }else if (DEBUG_LEVEL & DBG_DIAG & level) { \
              syslog(LOG_NOTICE,  "DIAG (%s:%d) "string, __FUNCTION__, __LINE__, ## args); \
        }else if (DEBUG_LEVEL & DBG_INFO & level) {\
              syslog(LOG_INFO,    "Info (%s:%d) "string, __FUNCTION__, __LINE__, ## args); \
        }else if (DEBUG_LEVEL & DBG_DEBUG & level) {\
              syslog(LOG_INFO,    "Debug (%s:%d) "string, __FUNCTION__, __LINE__, ## args); \
        } \
}while(0);
#else /* USE_SYSLOG */
#define pDebug(level, string, args...) \
do{\
        if (DEBUG_LEVEL & DBG_ERR & level){ \
              fprintf(stderr, "ERROR (%s:%d) "string"\n", __FUNCTION__, __LINE__, ## args); \
        }else if (DEBUG_LEVEL & DBG_WARN & level) { \
              fprintf(stderr, "WARNING (%s:%d) "string"\n", __FUNCTION__, __LINE__, ## args); \
        }else if (DEBUG_LEVEL & DBG_DIAG & level) { \
              printf("DIAG (%s:%d) "string"\n", __FUNCTION__, __LINE__, ## args); \
        }else if (DEBUG_LEVEL & DBG_INFO & level) {\
              printf("Info "string"\n", ## args); \
        }else {\
              printf("Debug "string"\n", ## args); \
        } \
}while(0);
/*              printf("[POWERSAVE] INFO in Function %s, line %d: "string, __FUNCTION__, __LINE__, ## args); \*/
#endif /* USE_SYSLOG */
#else /* POWERSAVE_DEBUG */
#define pDebug(level, string, args...) do {} while (0);
#endif /* POWERSAVE_DEBUG */
        
        enum BATTERY_PRESENT { PRESENT_YES = 0, PRESENT_NO };
        
        enum CAPACITY_UNIT { WATT_H = 0, AMP };
        
        enum BATTERY_TECH { TECH_NON_RECHARGEABLE = 0, TECH_RECHARGEABLE };
        
        enum CAPACITY_STATE { STATE_OK, STATE_CRIT, STATE_LOW, STATE_WARN };

        enum AC_ADAPTER_STATE { AC_UNKNOWN, AC_ONLINE, AC_OFFLINE };
        
        enum DISK_MODE { DISK_FULL_ON, DISK_STANDBY, DISK_SLEEP };

        enum LID_STATE { LID_OPEN, LID_CLOSED };

        enum ISACPI { NOT_SUPPORTED = -1, APM, ACPI };

        enum THERM_MODE { OK, ACTIVE, PASSIVE, HOT, CRITICAL };

        enum _COOLING_POLICY { COOLING_MODE_ACTIVE = 0, COOLING_MODE_PASSIVE };
        
        typedef struct BatteryGeneral {
                int remaining_percent;
                
                int remaining_minutes;
                
                int charging_state;
        } BatteryGeneral;
        
        typedef struct BatteryDetailed {
                int present;
                
                /* from /proc/acpi/battery/ /info */
                int design_capacity;
                int last_full_capacity;
                int battery_technology;
                int design_voltage;
                int design_capacity_warning;
                int design_capacity_low;
                int capacity_granularity_1;
                int capacity_granularity_2;
                char model_number[MAX_BAT_CHAR_LEN + 1];
                char serial_number[MAX_BAT_CHAR_LEN + 1];
                char battery_type[MAX_BAT_CHAR_LEN + 1];
                char OEM_info[MAX_BAT_CHAR_LEN + 1];
                
                /* from /proc/acpi/battery/ /status */
                int power_unit;
                int capacity_state;
                int charging_state;
                int present_rate;
                int remaining_capacity;
                int present_voltage;
                
                /* from /proc/acpi/battery/ /alarm */
                int alarm_limit;
        } BatteryDetailed;

        typedef struct ThermalDev {
                int present;
                int temperature;
                
                int cooling_mode;
                int polling_frequency;
                int critical;
                int hot;
                int passive;
                int active[MAX_THERMAL_ACTIVE];
                
                int state;
                int tc1;
                int tc2;
                int tsp;
        } ThermalDev;
        
        int getBatteriesInfo(BatteryGeneral * bat);

        int getBatteryInfo(const int no, BatteryGeneral *battery_info);

        int numBatteries(void);

        int getBatteryDetailedInfo(const int no, BatteryDetailed * bd);

        int setBatteryAlarm(const int percent);

        int getLidState(void);

        int getThrottlingInfo(int *num_states, int *current_state);

        int setThrottlingPercent(const int percent);

        int getThrottlingInfoCPU(const int cpu, int *num_states, int *current_state);

        int setThrottlingStateCPU(const int cpu, const int state);

        int setThrottlingPercentCPU(const int cpu, const int percent);

        int getThermalZonesNum(void);

        int getThermalZoneTemp(const int zone);

        int getThermalZoneState(int zone);

        int getThermalZone(const int zone, ThermalDev * td);

        int setThermalTrippoints(const int zone, const ThermalDev td);

        int setCoolingMode(const int device_num, const int mode);

        int getFanNum(void);

        int getFanStatus(const int device_num);

        int getACAdapterStatus(void);

        float getRealProcessorSpeed(void);

        int calcCPULoad(const int consider_nice);

        int getCPULoad(const int cpu);

        void freeCPULoadData(void);

        int getCPUCount(void);

        int64_t getSupportedSleepStates(void);

        int checkACPI(void);

        void setDebugLevel(const int dbg);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* POWERSAVE_POWERLIB_H */
// end of libpower_information group

---