include/alp/power.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright (c) 1999-2008 ACCESS CO., LTD. All rights reserved.
 * Copyright (c) 2006 PalmSource, Inc (an ACCESS company). All rights reserved.
 *****************************************************************************/
#ifndef ALP_POWER_H_
#define ALP_POWER_H_ 1

#ifdef __cplusplus
extern "C" {
#endif

#include <alp/sysclass.h>
#include <glib.h>
#include <time.h>

// declare this here, to prevent everyone who uses the file from needing GTK
struct _GtkWindow;


#define ALP_STATUS_POWER_INVALID_PARAM  (ALP_CLASS_POWER | 0x00010000)  
#define ALP_STATUS_POWER_NO_FREE_RAM    (ALP_CLASS_POWER | 0x00020000)  
#define ALP_STATUS_POWER_NO_MISER               (ALP_CLASS_POWER | 0x00030000)  
#define ALP_STATUS_POWER_NOT_ALLOWED    (ALP_CLASS_POWER | 0x00040000)  
#define ALP_STATUS_POWER_TIME_PASSED    (ALP_CLASS_POWER | 0x00050000)  
#define ALP_STATUS_POWER_NO_WAKEUP              (ALP_CLASS_POWER | 0x00060000)  
#define ALP_STATUS_POWER_NO_DEVICE              (ALP_CLASS_POWER | 0x00070000)  



#define ALP_POWER_PRIMARY_LCD           "_primary-lcd"  
#define ALP_POWER_PRIMARY_KEYBOARD      "_primary-key"  
#define ALP_POWER_ALL_PRIMARY           "_all-primary"  
#define ALP_POWER_AUTO_OFF                      "_auto-off"             
#define ALP_POWER_ALL_TIMEOUTS          "_all-timeouts" 




typedef enum {
        ALP_POWER_FULL_WAKE_STATE,      
        ALP_POWER_SEMI_WAKE_STATE,      
        ALP_POWER_SLEEP_STATE,          
} AlpPowerWakeState;



typedef enum {
        ALP_POWER_NORMAL_BATTERY_STATE,         
        ALP_POWER_LOW_BATTERY_STATE,            
        ALP_POWER_CRITICAL_BATTERY_STATE,       
} AlpPowerBatteryState;



#define ALP_POWER_PERF_LEVEL_MAX                5
#define ALP_POWER_PERF_LEVEL_DEFAULT    0
#define ALP_POWER_PERF_LEVEL_MIN                -5

#define ALP_POWER_PERF_LEVEL_LAUNCH             ALP_POWER_PERF_LEVEL_MAX        





alp_status_t alp_power_set_timeout(struct _GtkWindow *win, const char *name, uint32_t timeout);


alp_status_t alp_power_acquire_wake_ref(AlpPowerWakeState state);

alp_status_t alp_power_release_wake_ref(AlpPowerWakeState state);

alp_status_t alp_power_get_wake_state(AlpPowerWakeState *stateOut);

alp_status_t alp_power_force_full_wake();


typedef gboolean (*AlpPowerWakeupCallback)(gpointer data);

alp_status_t alp_power_request_wakeup(time_t when, AlpPowerWakeState state,
                                                                          AlpPowerWakeupCallback callback, gpointer data,
                                                                          guint *wakeupIDOut);

alp_status_t alp_power_cancel_wakeup(guint wakeupID);

alp_status_t alp_power_wakeup_handled();


alp_status_t alp_power_get_battery_state(guint *percentOut,
                                                                                 AlpPowerBatteryState *stateOut,
                                                                                 gboolean *chargingOut);

alp_status_t alp_power_get_battery_thresholds(guint *lowBatteryThresholdOut,
                                                                                          guint *criticalBatteryThresholdOut);


alp_status_t alp_power_set_performance_request(int level);

alp_status_t alp_power_clear_performance_request(void);



#define ALP_NOTIFY_EVENT_POWER_WAKE_STATE_CHANGE        "/alp/power/wake_state" 

#define ALP_NOTIFY_EVENT_POWER_SLEEP                            "/alp/power/wake_state/sleep"   

#define ALP_NOTIFY_EVENT_POWER_SLEEP_TO_SEMI_WAKE       "/alp/power/wake_state/sleep/semi_wake" 
#define ALP_NOTIFY_EVENT_POWER_SLEEP_TO_SLEEP           "/alp/power/wake_state/sleep/sleep"             

#define ALP_NOTIFY_EVENT_POWER_WAKE                                     "/alp/power/wake_state/wake"    

#define ALP_NOTIFY_EVENT_POWER_WAKE_TO_FULL_WAKE        "/alp/power/wake_state/wake/full_wake"  
#define ALP_NOTIFY_EVENT_POWER_WAKE_TO_SEMI_WAKE        "/alp/power/wake_state/wake/semi_wake"  

typedef struct _AlpPowerWakeStateEventDetails AlpPowerWakeStateEventDetails;
struct _AlpPowerWakeStateEventDetails {
        AlpPowerWakeState               lastState;      
        AlpPowerWakeState               newState;       
        guint32                                 flags;
};


#define ALP_NOTIFY_EVENT_POWER_BATT_CHANGE                      "/alp/power/batt"       

#define ALP_NOTIFY_EVENT_POWER_BATT_STATE_CHANGE        "/alp/power/batt/state" 

typedef struct _AlpPowerBattEventDetails AlpPowerBattEventDetails;
struct _AlpPowerBattEventDetails {
        AlpPowerBatteryState    lastState;              
        AlpPowerBatteryState    newState;               
        guint32                                 lastLevel;              
        guint32                                 newLevel;               
        gboolean                                lastCharging;   
        gboolean                                newCharging;    
};


#define ALP_NOTIFY_EVENT_POWER_OFF                                      "/alp/power/off"        

typedef struct _AlpPowerOffEventDetails AlpPowerOffEventDetails;
struct _AlpPowerOffEventDetails {
        guint32                                 flags;
};



#ifdef __cplusplus
}       // extern "C"
#endif 



#endif  /* ALP_POWER_H_ */

---

Generated on Wed Jul 30 07:06:39 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.