/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2005
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE. 
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/

/*******************************************************************************
 * Filename:
 * ---------
 * l4c_utility.h
 *
 * Project:
 * --------
 *   MT6208
 *
 * Description:
 * ------------
 *   This file is intends for ...
 *
 * Author:
 * -------
 * -------
 *
 *==============================================================================
 *             HISTORY
 * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *------------------------------------------------------------------------------
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 *------------------------------------------------------------------------------
 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *==============================================================================
 *******************************************************************************/

/********************************************************************************
*  Copyright Statement:
*  --------------------
*
*  This product has been developed using a protocol stack
*  developed by Sasken Communication Technologies Limited.
*
********************************************************************************/

#ifndef _L4C_UTILITY_H
#define _L4C_UTILITY_H

//#include "kal_non_specific_general_types.h"
#include "mcd_l3_inc_struct.h"
#include "stack_config.h"
#include "kal_general_types.h"
#include "ps_public_enum.h"
#include "nvram_enums.h"
#include "l4c_common_enum.h"

typedef enum
{
    L4C_BASEBAND_CODE,
    L4C_DSP_CODE,
    L4C_DSP_PATCH,
    L4C_SW_CODE,
    L4C_HW_CODE
} l4c_ms_revision_enum;

typedef enum
{
    CONVERT_TO_BCD_NORMAL,
    CONVERT_TO_BCD_WILD,
    CONVERT_TO_BCD_IGNORE_PLUS
}convert_to_bcd_enum;

typedef enum
{
    CONVERT_TO_DIGIT_NORMAL,
    CONVERT_TO_DIGIT_WILD,
    CONVERT_TO_DIGIT_EXT,
    CONVERT_TO_DIGIT_24008
}convert_to_digit_enum;

typedef enum
{
    L4C_REFRESH_CSP = 0x01,
    L4C_REFRESH_RAT = 0x02
}l4c_sim_refresh_file_enum;

typedef enum
{
    L4_SMU = 0x01,
    L4_RAC = (0x01 << 1),
    L4_PHB = (0x01 << 2),
    L4_SMSAL = (0x01 << 3),
    L4_UEM = (0x01 << 4),
    L4_TCM = (0x01 << 5),
    L4_CSMCC = (0x01 << 6),
    L4_CSMSS = (0x01 << 7)
}l4c_sub_module_enum;

typedef struct _CREE_MAP_ENTRY
{
    unsigned int index;
    unsigned char *cree_str;
} CREE_MAP_ENTRY;

extern kal_bool is_proper_owner(kal_uint8 src_id);
// mtk02514_phb
#define convert_to_bcd(source, dest, max_dest_len) convert_to_general_bcd(source, dest, max_dest_len, CONVERT_TO_BCD_NORMAL)
#define convert_to_bcd_wild(source, dest, max_dest_len) convert_to_general_bcd(source, dest, max_dest_len, CONVERT_TO_BCD_WILD)
extern kal_uint8 convert_to_general_bcd(kal_uint8 *source, kal_uint8 *dest, kal_uint8 max_dest_len, kal_uint8 type);


#define convert_to_digit(source, dest) convert_to_general_digit(source, dest, CONVERT_TO_DIGIT_NORMAL)
#define convert_to_digit_wild(source, dest) convert_to_general_digit(source, dest, CONVERT_TO_DIGIT_WILD)
#define convert_to_digit_ext(source, dest) convert_to_general_digit(source, dest, CONVERT_TO_DIGIT_EXT)
#define convert_to_digit_24008(source, dest) convert_to_general_digit(source, dest, CONVERT_TO_DIGIT_24008)

#define L4C_DECLARE_AND_CONSTRUCT_LOCAL_PARAM(struct_type, var, init_type) \
    struct_type* var = (struct_type*)construct_local_para(sizeof(struct_type),init_type) //MAUI_02900475

extern kal_uint8 convert_to_general_digit(kal_uint8 *source, kal_uint8 *dest, kal_uint8 type);

extern kal_uint8 plmn_convert_to_bcd(kal_uint8 *source, kal_uint8 *dest);

extern kal_uint8 plmn_convert_to_struct(kal_uint8 *source, plmn_id_rat_struct *dest);

extern kal_uint8 plmn_convert_to_digit(plmn_id_struct *source, kal_uint8 *dest);

//MAUI_02884093 extern kal_bool ss_string_skip_plus(kal_uint8 *source, kal_uint8 *dest);

extern kal_bool l4c_construct_phb_approve_str(kal_uint8 *source, kal_uint8 length); //MAUI_02884093

extern kal_uint8 get_bcd_byte(kal_uint8 digit, kal_uint8 type);

extern kal_uint8 get_ch_byte(kal_uint8 bcd, kal_uint8 type);

extern kal_uint8 get_ch_byte_raw(kal_uint8 bcd, kal_uint8 type);

extern kal_uint8 get_ch_byte_24008(kal_uint8 bcd);

extern kal_bool is_cmd_conflict(kal_uint8 src_id, kal_uint8 action);

extern kal_bool is_eq_cmd_conflict(kal_uint8 src_id, kal_uint8 action);

extern kal_bool is_phb_cmd_conflict(kal_uint8 src_id, kal_uint8 action);

extern kal_bool is_sms_cmd_conflict(kal_uint8 src_id, kal_uint8 action);

extern kal_bool is_ss_cmd_conflict(kal_uint8 src_id, kal_uint8 action);

extern kal_bool is_rac_cmd_conflict(kal_uint8 src_id, kal_uint8 action);

extern kal_bool is_smu_cmd_conflict(kal_uint8 src_id, kal_uint8 action);

extern kal_bool is_tcm_cmd_conflict(kal_uint8 src_id, kal_uint8 action);

extern kal_bool is_tcm_cmd_conflict_basic(kal_uint8 src_id, kal_uint8 action); //maui_01895693, mtk02285

#if 0 //def __CTM_SUPPORT__
/* under construction !*/
#endif 

extern kal_bool l4c_search_all_src(module_type which_sim, kal_uint8 action);

extern kal_bool l4c_search_all_src_ext(module_type which_sim, kal_uint8 action, kal_uint8 *src_id); //MAUI_02554068

extern kal_bool l4c_search_other_src(kal_uint8 src_id, kal_uint8 action); 

extern kal_uint8 l4c_conflict_search(kal_uint16 val);

extern void l4c_cmux_startup_req(kal_uint8 port);

extern void l4c_cmux_closedown_req(void);

extern void l4c_start_retry_timer_hdlr(kal_uint8 src_id);

//mtk01616_070515 : start 1 sec retry timer fro ss change phase request
extern void l4c_start_change_phase_retry_timer_hdlr(kal_uint8 src_id);

extern void l4c_start_sat_redial_duration_timer_hdlr(void);

extern void l4c_clear_sat_redial_duration_timer_hdlr(void);

extern void l4c_sat_redial_duration_expiry_hdlr(void);

extern void l4c_sat_file_change_hdlr(kal_uint8 src_id);

extern kal_bool l4c_cc_retry_allow(kal_uint8 src_id);

extern kal_bool l4c_need_retry(kal_uint16 cause);

#ifdef __ECC_RETRY_ENHANCEMENT__
extern kal_bool l4c_need_retry_other_rat(kal_uint8 src_id, kal_uint16 cause); //MAUI_02554068
extern kal_uint8 l4c_get_ecc_retry_new_rat(void); //MAUI_02320299
#endif

extern void l4c_retry_hdlr(void);

extern void l4c_send_msg_hdlr(kal_uint8 src_id, kal_uint8 operation);

extern void fill_data(kal_uint8 *buff_ptr, kal_uint16 length);

extern kal_bool check_multi_command(kal_uint8 result);

extern void l4c_gprs_send_data_timer_hdlr(void);

extern void l4c_gprs_data_timeout_hdlr(void);

extern void l4c_gprs_connection_timer_hdlr(void);

extern void l4c_gprs_connection_timerout_hdlr(void);

extern kal_bool l4c_sim_poweroff_done(void);

extern void l4c_sim_poweroff_timer_hdlr(void);
extern void l4c_sim_poweroff_timerout_hdlr(void);

//extern kal_bool check_pdp_context_exist_func(void);

extern kal_bool get_ms_revision(kal_uint8 equip_type, kal_uint8 *equip_id);

extern void l4c_convert_result(kal_uint8 l4c_result, kal_uint16 l4c_cause, kal_bool *result, kal_uint16 *cause);

extern kal_uint8 l4c_check_port_owner_source(kal_uint8 port);

extern void l4c_set_user_action(kal_uint8 mod, kal_uint8 user, kal_uint16 action);

extern kal_bool l4c_check_user_action(kal_uint8 mod, kal_uint8 user, kal_uint16 action);

#ifdef __APP_SECONDARY_PDP_SUPPORT__
extern kal_bool l4c_find_free_pdp_context(kal_uint8 *cid, kal_uint8 pid, kal_uint8 qos_id);
extern void l4c_find_pdp_pid2cid(kal_uint8 *cid, kal_uint8 pid, kal_uint8 qos_id);
extern void l4c_free_pdp_context(kal_uint8 cid, kal_uint8 *pid, kal_uint8 *qos_id);
#else /* __APP_SECONDARY_PDP_SUPPORT__ */ 
extern kal_bool l4c_find_free_pdp_context(kal_uint8 *cid, kal_uint8 pid);

extern void l4c_find_pdp_pid2cid(kal_uint8 *cid, kal_uint8 pid);

extern void l4c_free_pdp_context(kal_uint8 cid, kal_uint8 *pid);
#endif /* __APP_SECONDARY_PDP_SUPPORT__ */ 

extern kal_uint8 l4c_find_pdp_cid2pid(kal_uint8 cid); //__GPRS_BEARER_REPORT_NEGOTIATED_QOS__

extern void l4c_ConvertGSM7BitDefaultEncodingToAscii(
                kal_uint8 *message,
                kal_uint8 *msg,
                kal_uint16 length,
                kal_uint16 *outLen);

extern void l4c_set_download_path(kal_wchar *downlaod_path);

extern kal_bool has_any_current_action(kal_uint8 src_id);

extern kal_bool has_any_src_in_action(kal_uint8 mod, kal_uint16 action);

extern kal_bool l4c_check_online_state(kal_uint8 *online_src_id, kal_uint8 state);

extern kal_bool l4c_is_src_from_rmmi(kal_uint8 src_id);

extern kal_bool l4c_previous_rac_action_rsp(void);

//extern void l4c_clear_concat_sms_array (void);
extern kal_bool l4c_mmi_result(kal_uint8 result);

extern void l4c_set_mt_call_event(kal_bool mt_call_exist,kal_uint8 mt_call_id);

extern void l4c_update_retry_call_state_ind(kal_uint8 call_id,kal_uint8 src_id);

extern void l4c_send_callid_assign_fail_ind(kal_uint8 src_id,kal_uint16 cause);

extern void l4c_cc_exe_call_dial_lrsp(kal_uint8 src_id, 
                                      kal_uint8 response, 
                                      kal_uint16 cause, 
                                      kal_uint8 call_id, 
                                      kal_bool is_diag_present, 
                                      kal_uint8 diag); //MAUI_02526481

extern void l4c_ctrl_dcd_status(kal_uint8 src_id, module_type ownerid);

extern void l4c_check_cind_status(kal_uint8 *call, kal_uint8 *service, kal_uint8 *callsetup);

extern kal_bool l4c_check_dual_sim_state(module_type current_mod_id, kal_uint8 cfun_state);

extern void l4c_check_dual_sim_insert_status(module_type mod_id, kal_uint8 sim_inserted_status);

extern void l4c_send_dual_sim_power_on_ind(kal_uint8 src_id);

extern void l4c_context_selection(kal_uint8 sim_interface);
extern kal_uint8 l4c_get_bt_hf_atd_action(void);
extern void l4c_unified_ciev_staus(kal_uint8 *service, 
                                   kal_uint8 *signal, 
                                   kal_uint8 *roam, 
                                   kal_uint8 *call, 
                                   kal_uint8 *callsetup, 
                                   kal_uint8 *callheld);

extern kal_bool l4c_is_test_sim(void);
#ifdef __VSIM__
extern kal_bool l4c_is_sim_vsim_on(void);
#endif
extern kal_uint8 l4c_check_sim_status(void);
extern l4c_sim_status_enum l4c_get_sim_status(void);
extern kal_bool l4c_check_auto_dtmf_modifier(kal_uint8 ch);
extern kal_uint8 l4c_get_cfun_state(void);
extern kal_uint8 l4_custom_approval_type(kal_uint8 operation_type,kal_uint8 src_id);


extern void l4c_phb_format_alpha_id(void *alpha_id, kal_uint8 *rsp_string);
extern void l4c_phb_set_last_number_dialed(void *tel, kal_uint8 type, kal_uint8 address_type);
extern void l4c_phb_atd_mem_dial(kal_uint8 *tel_number, kal_uint8 ton);
extern void l4c_phb_set_result_code(kal_uint8 phb_result, kal_uint16 phb_cause, void *result, kal_uint8 other_cond);
extern void l4c_phb_set_tel_number(void *phb_tel, void *l4c_phb_tel, convert_to_bcd_enum convert_method);
extern phb_storage_enum l4c_phb_get_sim_storage_by_current_module(void);

extern void l4c_reset_sms_context();

extern void l4c_activate_sub_modules(kal_uint8 src_id); 

extern void l4c_reset_sub_modules(l4c_sub_module_enum sub_mod);

extern void l4c_clear_poweron_action(kal_uint8 src_id); 

extern void l4c_nw_sysconfig_update(kal_uint8 src_id);

#if defined(PLUTO_MMI)
extern void l4c_eq_screen_shot_output(void);
#endif

extern void* l4c_construct_nvram_write_local_para(kal_uint8 access_id, nvram_lid_enum file_idx, kal_uint16 para);
extern void* l4c_construct_nvram_read_local_para(kal_uint8 access_id, nvram_lid_enum file_idx, kal_uint16 para, kal_uint16 rec_amount);

extern void l4c_target_reset(kal_uint8 sec);

extern void l4c_cc_save_ceer_cause(l4c_result_enum response,kal_uint8 cause_present,kal_uint16 cause);

extern void l4c_clear_retry_call(void);

extern kal_bool l4c_wait_limited_service(void);
extern kal_bool l4c_wait_normal_service(void);
#ifdef __ECALL_SUPPORT__
extern kal_bool l4c_get_ecall_number(l4_addr_bcd_struct *called_number,kal_uint8 ecc_info);
#endif 

extern kal_bool l4c_gemini_need_switch(msg_type msg_id);

extern kal_bool l4c_phb_approve_fdn(kal_uint8 *tel_number, /* BCD coding, include TON/NPI in the first byte */
                                    kal_uint8 num_length,
                                    kal_uint8 sim_id,
                                    l4c_operation_type_enum oper,
                                    kal_uint16 *cause);

#endif /* _L4C_UTILITY_H */ /* l4c_utility.h */