xpal_power.h

Go to the documentation of this file.

/* Power Control and Management Functions */
/* Copyright (C) 2009,2010 Thomas Klosa
 *
 *   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 your option) version 3.
 *
 *   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, see <http://www.gnu.org/licenses/>.
 */

#ifndef POWER_H
#define POWER_H

#include <avr/io.h>
#include "cb_list.h"


#define HL_PWR_ON       1     //!< Parameter to switch things on
#define HL_PWR_OFF      0     //!< Parameter to switch things off
#define HL_PWR_FAIL -1    //!< Return value to indicate error conditions

/*  @brief Power Information variable */
typedef int8_t  hl_pwr_state_t;

#define HL_PWR_USB_ACTIVE       0x01    //!< Power from USB is available
#define HL_PWR_3V3_ACTIVE       0x02    //!< 3.3V is active
#define HL_PWR_5V_ACTIVE        0x04    //!< 5V regulator is active
#define HL_PWR_LCD_ACTIVE       0x08    //!< LCD High Voltage is active

#define HL_PWR_ST_RUNNING       0x00

#define HL_PWR_ST_IDLE          0x10

#define HL_PWR_ST_33SLEEP       0x20

#define HL_PWR_ST_SLEEP 0x40

#define HL_PWR_ST_OFF   0x80

/*
        The following bits are used with hl_pwr_CtrlAutoSave
        When set, the pwr Management can enter the related power state
*/
#define HL_PWR_ALLOW_NOSAVE     0x0000  
#define HL_PWR_ALLOW_IDLE               0x0010  
#define HL_PWR_ALLOW_33SLEEP    0x0020  
#define HL_PWR_ALLOW_SLEEP              0x0040  
#define HL_PWR_ALLOW_OFF                0x0080  
typedef int8_t  pwr_info_t;   // 

#define HL_PWR_OFF_TIME         600             //!< inactivity seconds until power off

/*
        Definition of WakeUp sources
*/
#define HL_PWR_WAKE_BY_KEY              0x01    //!< Key in COL0..2
#define HL_PWR_WAKE_BY_PWR_KEY  0x02    //!< Key in COL3
#define HL_PWR_WAKE_BY_SYS_TMR  0x04    //!< Timer2 COMPA
#define HL_PWR_WAKE_BY_1S_TMR   0x08    //!< Timer2 OV
#define HL_PWR_WAKE_BY_EX232    0x10    //!< USART 3
#define HL_PWR_WAKE_BY_MOD232   0x20    //!< USART 2
#define HL_PWR_WAKE_BY_ADC              0x40    //!< ADC
#define HL_PWR_WAKE_NO_SOURCE   0x00    //!< Unknown Source or system was not in sleep (_NOSAVE)


extern volatile uint8_t WakeUpSource;

extern volatile uint16_t PowerOffTimer;

extern volatile hl_pwr_state_t hl_pwr_state;    

extern volatile hl_pwr_state_t hl_pwr_info;             


/*
        Functions for external use
*/

void hl_pwr_InitBoard(void);

void hl_pwr_InitPwrMan(void);

 uint8_t hl_pwr_EnterSleep(void);


inline void hl_pwr_SetWakeSource(uint8_t ws){

        WakeUpSource |= ws;
}

inline uint8_t hl_pwr_GetWakeSource(void){
        return WakeUpSource;
}

inline void hl_pwr_AppBusy(void){
        PowerOffTimer = HL_PWR_OFF_TIME;
}


inline void hl_pwr_OffNow(void){
        PowerOffTimer = 0;
}


inline uint16_t hl_pwr_GetOffTime(void){
        return PowerOffTimer;
}


uint16_t hl_pwr_fast(void*); 
uint16_t hl_pwr_slow(void*);  

void hl_pwr_3V3reg(hl_pwr_state_t state);

void hl_pwr_5Vreg(hl_pwr_state_t state);

void hl_pwr_LCDreg(hl_pwr_state_t state);

inline hl_pwr_state_t hl_pwr_GetState(void){ 
        return hl_pwr_state;
};

extern void hl_RegisterPwrCb(cb_function_t fkt2call, void *PwrStAllowed);


#endif