/******************************************************************************
 *    (c)2008-2009 Broadcom Corporation
 *
 * This program is the proprietary software of Broadcom Corporation and/or its licensors,
 * and may only be used, duplicated, modified or distributed pursuant to the terms and
 * conditions of a separate, written license agreement executed between you and Broadcom
 * (an "Authorized License").  Except as set forth in an Authorized License, Broadcom grants
 * no license (express or implied), right to use, or waiver of any kind with respect to the
 * Software, and Broadcom expressly reserves all rights in and to the Software and all
 * intellectual property rights therein.  IF YOU HAVE NO AUTHORIZED LICENSE, THEN YOU
 * HAVE NO RIGHT TO USE THIS SOFTWARE IN ANY WAY, AND SHOULD IMMEDIATELY
 * NOTIFY BROADCOM AND DISCONTINUE ALL USE OF THE SOFTWARE.
 *
 * Except as expressly set forth in the Authorized License,
 *
 * 1.     This program, including its structure, sequence and organization, constitutes the valuable trade
 * secrets of Broadcom, and you shall use all reasonable efforts to protect the confidentiality thereof,
 * and to use this information only in connection with your use of Broadcom integrated circuit products.
 *
 * 2.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
 * AND WITH ALL FAULTS AND BROADCOM MAKES NO PROMISES, REPRESENTATIONS OR
 * WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO
 * THE SOFTWARE.  BROADCOM SPECIFICALLY DISCLAIMS ANY AND ALL IMPLIED WARRANTIES
 * OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE,
 * LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION
 * OR CORRESPONDENCE TO DESCRIPTION. YOU ASSUME THE ENTIRE RISK ARISING OUT OF
 * USE OR PERFORMANCE OF THE SOFTWARE.
 *
 * 3.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, IN NO EVENT SHALL BROADCOM OR ITS
 * LICENSORS BE LIABLE FOR (i) CONSEQUENTIAL, INCIDENTAL, SPECIAL, INDIRECT, OR
 * EXEMPLARY DAMAGES WHATSOEVER ARISING OUT OF OR IN ANY WAY RELATING TO YOUR
 * USE OF OR INABILITY TO USE THE SOFTWARE EVEN IF BROADCOM HAS BEEN ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGES; OR (ii) ANY AMOUNT IN EXCESS OF THE AMOUNT
 * ACTUALLY PAID FOR THE SOFTWARE ITSELF OR U.S. $1, WHICHEVER IS GREATER. THESE
 * LIMITATIONS SHALL APPLY NOTWITHSTANDING ANY FAILURE OF ESSENTIAL PURPOSE OF
 * ANY LIMITED REMEDY.
 *
 * $brcm_Workfile:  $
 * $brcm_Revision:  $
 * $brcm_Date:  $
 *
 * Module Description:
 *
 * Manage application settings like volume, channel map, etc.
 *
 * Revision History:
 *
 * Created: 09/28/2009 by Jeff Fisher
 *
 * $brcm_Log:  $
 * 
 *
 *****************************************************************************/
#ifndef BAPP_SETTINGS_H__
#define BAPP_SETTINGS_H__

#include "bapp_types.h"
#include "ch_map.h"
/* 
 * State data structure, because this structure is saved to NVM
 * options should be combined to make best use of storage space
 */
#define MAX_PHONE_LEN	255
typedef struct bapp_settings_t
{
    unsigned int activated             : 1;
    unsigned int deactivated           : 1;
    unsigned int standby               : 1;
    unsigned int has_CAT               : 1;
    unsigned int av_mute               : 1;
	unsigned int psi_scan              : 1;
    unsigned int audio_vol             : 7;
    unsigned int state                 : 4;
	unsigned int dst_delta             : 8;
	unsigned int timeout_policy        : 8;
	unsigned int SCP_operating_mode    : 8;
    unsigned int CA_System_ID          : 16;
    unsigned int EMM_Provider_ID       : 16;
    unsigned int EMM_PID               : 16;
    unsigned int VCT_ID                : 16;
    unsigned int network_PID           : 16;
	unsigned int hunt_cnt              : 16;
	unsigned int download_failed_cnt   : 16;
	unsigned int download_invalid_cnt  : 16;
	unsigned int timeout               : 16;
    unsigned int max_location_errors   : 16;
    unsigned int location_errors       : 16;
	unsigned int message_time          : 32;
    unsigned int turn_on_freq_khz      : 32;
	unsigned int addressable_time      : 32;
	unsigned int timeout_cnt           : 32;
	unsigned int location              : 32;
	int utc_offset            		   : 32;
	unsigned int dst_entry             : 32;
	unsigned int dst_exit              : 32;
	unsigned int reserved_0            : 32;
	unsigned int reserved_1            : 32;
	unsigned int reserved_2            : 32;
	unsigned int reserved_3            : 32;
	unsigned char phonenumber[MAX_PHONE_LEN];
    ch_map_t	ch_map;
}bapp_settings_t;


#ifdef __cplusplus
extern "C" {
#endif

/**
Summary:
	Initialize settings to default values.
**/

bapp_result_t bapp_settings_init(bapp_settings_t *p_settings);


/**
Summary:
	Save the settings.
**/
bapp_result_t bapp_settings_save(bapp_settings_t *p_settings);

/**
Summary:
	Load the settings.
**/
bapp_result_t bapp_settings_load(bapp_settings_t *p_settings);

#ifdef __cplusplus
}
#endif

#endif /* BAPP_SETTINGS_H__ */