/***************************************************************************
 *     Copyright (c) 2003-2008, Broadcom Corporation
 *     All Rights Reserved
 *     Confidential Property of Broadcom Corporation
 *
 *  THIS SOFTWARE MAY ONLY BE USED SUBJECT TO AN EXECUTED SOFTWARE LICENSE
 *  AGREEMENT  BETWEEN THE USER AND BROADCOM.  YOU HAVE NO RIGHT TO USE OR
 *  EXPLOIT THIS MATERIAL EXCEPT SUBJECT TO THE TERMS OF SUCH AN AGREEMENT.
 *
 * $brcm_Workfile: $
 * $brcm_Revision: $
 * $brcm_Date: $
 *
 * Module Description:
 *
 * Revision History:
 *
 * $brcm_Log: $
 * 
 *
 ***************************************************************************/
#ifndef LED_H__
#define LED_H__

enum led_mode_t {
    led_off_mode,
    led_hunt_mode,
    led_pending_init_mode,
    led_download_mode,
    led_trouble_mode,
    led_on_mode,
    led_authorization_mode,
    led_max
};

/***************************************************************************
Summary: 
    Set led mode to given mode
Description:
    Set led mode to given mode, turning led on of off accordint to the first
    state of led in this mode
Input:
    mode - desired led mode
Output:
    None
Returns:
    time delay in ms until next led_update call.
SeeAlso:
    None
***************************************************************************/
unsigned led_set_mode(enum led_mode_t mode);

/***************************************************************************
Summary:
    Update led to the be on or off.
Description:
    Update led to the be on or off according to current state. Application
    should call led_update no later than interval in ms returned by previous
    led_update call.
Input:
    elapsed_time - time elasped since last call to update in ms
Output:
    None
Returns:
    time delay in ms to until next led_update call.
SeeAlso:
None
***************************************************************************/
unsigned led_update(unsigned elapsed_time);

#endif /* LED_H__ */