/***************************************************************************
 * This code and information is provided "as is" without warranty of any   *
 * kind, either expressed or implied, including but not limited to the     *
 * implied warranties of merchantability and/or fitness for a particular   *
 * purpose.                                                                *
 *                                                                         *
 * Copyright (C) 2005 Teridian SemiConductor, Corporation.                 *
 * All Rights Reserved.                                                    *
 ***************************************************************************/
//**************************************************************************
//  DESCRIPTION: 71M65xx POWER METER - Battery modes.  The actual
//  switching of modes is handled by the initialization in main ().  It's
//  there so that it is centralized, integrated with initialization, and 
//  automatically treats resets and non-reset start-ups in the same way.
// 
//  AUTHOR:  RGV
//
//  HISTORY: See end of file
//**************************************************************************
// File: BATMODES.H
//
#if BROWNOUT_BATMODE || LCD_BATMODE || SLEEP_BATMODE
#ifndef BATMODES_H
#define BATMODES_H 1

#if BROWNOUT_BATMODE
bool batmode_is_brownout (void) small reentrant;
#endif // brownout

// start a wake timer in seconds.
void batmode_wait_seconds (uint16_t cs);

// start a wake timer in minutes.
void batmode_wait_minutes (uint16_t cs);

#if LCD_BATMODE
// enter LCD_only mode, a power-down mode that continues to display
// the LCD
void batmode_lcd (void);
#endif // LCD batmode

#if SLEEP_BATMODE
// enter sleep mode, a power-down mode that does nothing.
// but can be exited by either a wake timer, or a pushbutton
void batmode_sleep (void);
#endif // sleep batmode

// update current battery mode state
void batmode_background (void) small reentrant;

// initialize the battery mode
void batmode_init (void);

// Show the LCD display for battery modes
void batmode_display (void);
#endif // BATMODES_H defined
#endif // battery modes are included
/***************************************************************************
 * $Log: batmodes.h,v $
 * Revision 1.9  2006/09/09 01:10:45  gmikef
 * *** empty log message ***
 *
 * Revision 1.8  2006/07/07 01:13:06  tvander
 * Fixed reentrancy errors, build errors.
 * Added  untested code to hang brownout when batttery is not present.
 *
 * Revision 1.7  2006/06/14 02:59:05  tvander
 * Simplifiedthe brownout, regressing to 17april06 version, but with hang
 * removed, and a brownout display that always executes before entering sleep mode.
 *
 * Reduced the MPU clock 8x from 4.9mHz to 614kHz
 *
 * Revision 1.6  2006/03/06 03:33:09  Michael T. Fischer
 * More 6530 prep.
 *
 * Revision 1.5  2006/01/10 03:59:47  gmikef
 * Added PDATA support for CE Outputs.
 *
 * Revision 1.3  2005/11/05 01:57:24  tvander
 * Added code to clear pushbutton and wake flags.
 *
 * Revision 1.2  2005/10/12 23:00:02  tvander
 * Includes demonstratable mission mode, brownout, LCD and sleep modes
 *
 * Revision 1.1  2005/10/06 20:55:02  tvander
 * Preliminary logic to manage the battery modes.
 *
 * Copyright (C) 2005 Teridian Semiconductor Corp. All Rights Reserved.    *
 * this program is fully protected by the United States copyright          *
 * laws and is the property of Teridian Semiconductor Corporation.         *
 ***************************************************************************/