mcu/protocol/interface/general/mrs_utility.h

/******************************************************************************
*  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) 2007
*
*  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:
 * --------------------------------------------------------
 *   mrs_utility.h
 *
 * Project:
 * --------------------------------------------------------
 *   Multimode
 *
 * Description:
 * --------------------------------------------------------
 *   Declaration of funcitons of the utilities in MRS.
 *
 * Author:
 * --------------------------------------------------------
 * -------
 *
 * --------------------------------------------------------
 * $Log$
 *
 * 11 03 2022 yanfeng.xu
 * [MOLY00729994] [KPI: EPSFB AFR Lattency][RDIT][ZTE ngRAN][Gemini Benchmark][Case NR_GEMINI_14222_EPSFB_Call_MO_Ping_Idle][Good_Point] Check larger EPSFB AFR Latency
 *
 * 09 22 2022 ot_kiran.gunturu
 * [MOLY00855742] [Moto][Tesla][GCF/PTCRB][ 31.121] [TC10.1.5]
 *
 * 01 28 2022 ot_krishna.charan
 * [MOLY00685488] cloned from ALPS05677217  [B210622-876][?????]UE CSFB CALL MT???RR???????????????????????????
 *
 * 01 18 2022 tom.wu
 * [MOLY00735828] SBP_MRS_AFR_TO_5G_CONTROL return error
 * 	
 * 	.
 *
 * 10 07 2020 tero.miettinen
 * [MOLY00570382] [Gen97]Apply BW customization setting from NVRAM to report capability
 * [MRS] Update in BW setting list handling.
 *
 * 10 07 2020 bo-yao.tsai
 * [MOLY00565738] [MODEM][Assert] Assert fail: errc_cel_cscom.c 6572 - ERRC
 * 	- Channel protection fixing
 *
 * 10 01 2020 tero.miettinen
 * [MOLY00560032] ????SA???
 * MRS - PLMN based 5G band disabling.
 *
 * 09 22 2020 vend_mtb_aritha031
 * [MOLY00561862] [Gen97][MP7][VzW][AFR] feature check-in,  (check-in approved: item_344)
 *
 * 09 22 2020 vend_mtb_aritha031
 * [MOLY00561862] [Gen97][MP7][VzW][AFR] feature check-in,  (check-in approved: item_344)
 *
 * 09 18 2020 vend_mtb_aritha031
 * [MOLY00561862] [Gen97][MP7][VzW][AFR] feature check-in,  (check-in approved: item_344)
 *
 * 09 18 2020 tom.wu
 * [MOLY00554348] [Colgin] cell measure and white cell lock feature development
 * 	
 * 	.
 *
 * 06 29 2020 vend_mtb_aritha002
 * [MOLY00536615] [MCF] user flow enhancement
 * 	
 * 	.
 *
 * 06 12 2020 vend_mtb_mobiveil015
 * [MOLY00528344] [URGENT][SSI][MT6885][Petrus][Q0][MP2][AT&T][10776v20_1][R3MP][PTN][simulation][inhouse][RnS][ATTACH/RESTART][LTE-BTR-1-8220]Test case failed due to ## LTE ## RRCConnectionRequest TimeOut
 * 	
 * 	[MOLY00535086] ?DM?34G??
 * 	
 * 	.
 *
 * 04 04 2020 farming.tseng
 * [MOLY00509534] [MT6875][Margaux][Q0][MP3][SQC]][Internal][China][Shenzhen][MDST][SWIFT][CU+CT][ErrorTimes:1][ASSERT] file:mcu/l1/nl1/internal/md97/src/rx/nr_rx_scheduler_rtb.c line:6045
 * 	
 * 	.
 *
 * 03 24 2020 farming.tseng
 * [MOLY00506815] [MT6875][Margaux][Q0][SQC][MP3][Gemini][N+L][NTC_SA_Gemini_0022]Margaux doesn't support SA+L DSDA.
 *
 * 01 06 2020 harish.reddy
 * [MOLY00469528] [Gen97][VMOLY][SA][hVolte] hVolte revise for SA
 *
 * 12 09 2019 kun-lin.wu
 * [MOLY00464345] [Gen97] Gemini MP2/MP3 features phase-in
 *
 * 12 09 2019 jutta.liuska
 * [MOLY00448654] [6297][NRRC] Implementation for VoNR capabilities and enhancements
 * [MRS] VoNR enhancements
 *
 * 12 09 2019 elle.sun
 * [MOLY00464443] [ERRC][MRS][NL1MOB] move operator table to mrs
 * 	
 * 	[ERRC/MRS] move oprator table.
 *
 * 12 09 2019 vend_mtb_aritha002
 * [MOLY00458503] [CODE SYNC][MH4P-POS] patch request about ALPS04309026
 * 	
 * 	Band Configuration to VMOLY
 *
 * 12 02 2019 vinayak.bandagi
 * [MOLY00459945] [Gen97][AFR][RDIT] NAS-SV reset MRS AFR CNTX
 *
 * 10 14 2019 prime.xiao
 * [MOLY00447831] [Rose][Petrus]BSP+][Q0]The ECC call calling 3 mintues and not connected.
 * 	
 * 	.
 *
 * 09 26 2019 kun-lin.wu
 * [MOLY00443062] [Gemini] SA+L DR-DSDS/DSDA
 *
 * 07 18 2019 emily.lu
 * [MOLY00422928] [Gen97 Patch back][ERRC_CEL] Code Sync to VMOLY
 * 	
 * 	.merge CL#7709556 (MRS)
 *
 * 07 01 2019 jiawei.he
 * [MOLY00415509] [CODE SYNC][VMOLY][MOLY00370411][MOLY00377605][MOLY00394234][MOLY00397043][MOLY00398281]eCSFB related patch-back from Gen93
 * 	
 * 	.
 *
 * 05 30 2019 kun-lin.wu
 * [MOLY00402003] [VMOLY] GEMINI N+L DSDS
 *
 * 04 30 2019 muneeswaraiah.dama
 * [MOLY00402590] [Gen97] reset AFR target rat and ongoing status  by service
 * .
 *
 * 04 17 2019 puneet.t
 * [MOLY00399390] [CODE SYNC] [VMOLY][Eiger RD IT][GEMINI & AFR]LAU request has been rejected with cause AS_IN_SUSPEND_MODE and it never camped on 2G.
 * 	
 * 	GEMINI RDIT code changes in VMOLY TRUNK
 *
 * 04 16 2019 otto.liu
 * [MOLY00399190] [GEN97] GEN95 to GEN97 sync patch
 * 	
 * 	.
 *
 * 02 18 2019 muneeswaraiah.dama
 * [MOLY00384995] [VMOLY] GEMINI 3.0, AFR, Unify Frequency scan, BGSEARCH
 * .
 *
 * 10 03 2018 muneeswaraiah.dama
 * [MOLY00356286] [Gen97] background search feature
 * .
 *
 * 05 25 2018 otto.liu
 * [MOLY00325228] [UMOLYE] Remove NVRAM group header file
 * 	
 * 	.
 *
 * 05 09 2018 amit.sharma
 * [MOLY00325096] [Gen95][GAS]FAST_IRCR and LG+WG CMCC feature change for I-RAT RESEL to be merged and replaced by STORED SI.
 * .
 *
 * 04 18 2018 morton.lin
 * [MOLY00320662] [Gen93][P40][UMOLYE] Gionee blacklist feature - MRS
 * [MRS] Gionee Blacklist feature phase-in
 *
 * 01 23 2018 muneeswaraiah.dama
 * [MOLY00302582] [Gen93][Huawei][CHR] Index 8, Index 9 - header/ interface files
 * .
 *
 * 10 31 2017 amit.sharma
 * [MOLY00285547] [P170518-04585]airplane mode search network times fail
 * .
 *
 * 07 06 2017 morton.lin
 * [MOLY00261305] [Gen93] B71 development
 * MRS and NVRAM phase in
 *
 * 04 26 2017 rujing.zhao
 * [MOLY00243767] [TDD GAS]RACH fail bar cell feature patch back UMOLYA
 * .
 *
 * 04 25 2017 mu.ding
 * [MOLY00244356] [6293][Gemini][T+W] Phase 2: T+W Changes Check in
 * 	
 * 	.
 *
 * 11 10 2016 vend_mtb_aricent_05
 * [MOLY00212319] [MT6293] Channel Lock feature porting and enhancement -MRS
 * 	
 * 	.
 *
 * 10 24 2016 menghau.wu
 * [MOLY00208768] [MT6293] [B66] Band66 porting (ERRC part)
 * complement of CL 3008555
 *
 * 06 24 2016 cookie.chen
 * [MOLY00185901] UMOLYA errc relevant latest code sync from UMOLY
 * .
 *
 * 12 10 2015 tim.huang
 * [MOLY00150157] VZ_REQ_LTEDATA_38498 (MT6291 Verizon Jun-2015 baseline)
 * .
 *
 * 10 07 2015 titi.wu
 * [MOLY00141786] [MT6755][SRLTE][L+C] Support connectivity of C2K on dual SIM
 * .
 *
 * 09 18 2015 ming.lee
 * [MOLY00140707] [GAS][PLMN search enhancement II] Search info reuse
 * .
 *
 * 08 06 2015 claud.li
 * [MOLY00125612] [PS1][91plus] core change modification
 * 	1. from l1core_is_test_sim to is_test_sim.
 * 	2. from l1core_query_ps_sim_type to sim_query_type
 * 	3. remove shared variable "l1core_sim_type_info" and  "l1core_is_test_sim_info_ready"
 * 	4. remove mrs_update_l1core_SIM_type
 * 	5. from l1core_is_ps_conf_xta_mode() to is_ps_conf_test_xta_mode()
 * 	6. from l1core_query_ps_conf_test_mode() to query_ps_conf_test_mode()
 * 	7. from l1core_query_ps_conf_test_profile_setting() to query_ps_conf_test_profile_setting()
 * 	8. remove shared variable: "l1core_ps_conf_test_xta_mode", "l1core_is_test_mode_info_ready", "l1core_ps_conf_test_profile_setting", "l1core_ps_conf_test_mode"
 * 	9. remove mrs_update_l1core_test_mode()
 * 	10. remove l1core_is_mmdc_mode()
 *
 * 08 06 2015 claud.li
 * [MOLY00125612] [PS1][91plus] core change modification
 * 	1. remove l1core_is_vsim() : could use L4/sim's API: is_vsim_on()
 * 	2. remove l1core_test_mode_consider_sim() : could use L4/sim's API: test_mode_consider_sim()
 *
 * 07 14 2015 bruce.li
 * [MOLY00128246] [eCSFB]LU Reduction Enhancement
 * Implemented 2 enhancements:
 * 1. If there is successful call on the black cell, add it to bleach list;
 *    the priority order is: white list > bleach list > gray list > black list;
 * 2. If the decoded BSIC of white cell or bleach cell does not match the stored,
 *    add it to retry list; the retry list would be tried after white list and
 *     bleach list have been done.
 *
 * 06 21 2015 alan.peng
 * [MOLY00122048] [6795] Request new feature to improve registration time of roaming case
 * _MRS part.
 *
 * 05 29 2015 shin.chen
 * [MOLY00115617] [6291] Dynamic SIM switch without modem reset
 * 	.
 *
 * 05 14 2015 henry.lai
 * [MOLY00113630] [MT6291] Add IS_TEST_SIM and IS_VSIM for l1core
 * .
 *
 * 04 20 2015 shin.chen
 * [MOLY00087882] [Universal Bin] MRS general developement
 * .Remove tabs
 *
 * 02 16 2015 doug.shih
 * [MOLY00091463] [MT6291] ERRC RCM/MRS development
 * MOLY CR Code Sync to UMOLY (OA domain):
 * [MOLY00079131] AT&T requirement connection reject
 * [MOLY00083427] [ERRC][MOB] UMTS proximity indication
 * [MOLY00084324] [ROHC] Modem load with configurable compile options: profile support and context number
 * [MOLY00084416] [eCSFB]LU Reduction feature
 * [MOLY00091967] Merge C2K IRAT code (CT specific UE cap SBP setting).
 *
 * 01 20 2015 henry.lai
 * [MOLY00087668] [MT6291][UBIN] Check in ERRC/CEL modifications
 * 	.
 *
 * 12 15 2014 henry.lai
 * [MOLY00087668] [MT6291][UBIN] Check in ERRC/CEL modifications
 * .
 *
 * 11 17 2014 shin.chen
 * [MOLY00081154] [ATT_TMO_DEV] AT&T requirement merge back
 * .
 *
 * 11 14 2014 henry.lai
 * [MOLY00079072] [MT6291] Change EARFCN from kal_uint16 to kal_uint32 for CEL part
 * 	.
 *
 * 11 12 2014 cooper.lin
 * [MOLY00068710] [MT6291_DEV] Sync MOLY to MT6291_DEV
 * Merge MT6291_DEV code to UMOLY trunk.
 *
 * 11 12 2014 henry.lai
 * [MOLY00079071] [MT6291][U4G] Low Power Modification for CEL Paging
 * .
 *
 * 05 23 2014 adeline.chang
 * [MOLY00066214] [SBP] 4G background search
 * .
 *
 * 10 29 2013 adeline.chang
 * [MOLY00042471] [MT6290] CSFB_enhancements inject message extension
 * .
 *
 * 10 21 2013 adeline.chang
 * [MOLY00042471] [MT6290] CSFB_enhancements inject message extension
 * .
 *
 * 10 18 2013 peng.pan
 * [MOLY00041595] [MT6290E1][MMDS_DC] MMDC feature patch back to MOLY trunk
 * MRS support MMDC.
 *
 * 08 30 2013 adeline.chang
 * [MOLY00030187] [MT6290] CSFB Enhancement Implementation for Autonomous Fast Return
 * [MT6290] CSFB Enhancement Implementation for Autonomous Fast Return - add new MRS API.
 *
 * 08 26 2013 adeline.chang
 * [MOLY00030187] [MT6290] CSFB Enhancement Implementation for Autonomous Fast Return
 * [MT6290] CSFB Enhancement Implementation for Autonomous Fast Return - add SIM index.
 *
 * 07 17 2013 adeline.chang
 * [MOLY00030187] [MT6290] CSFB Enhancement Implementation for Autonomous Fast Return
 * .
 *
 * 07 17 2013 adeline.chang
 * [MOLY00030187] [MT6290] CSFB Enhancement Implementation for Autonomous Fast Return
 * .
 *
 * 03 18 2013 justin.li
 * [MOLY00009222] [GAS][Multi-Mode Development] Merge GAS multi-mode development to MOLY
 * .
 *
 * 02 05 2013 yenchih.yang
 * [MOLY00009186] [SIBE/USIME/DBME] Multi-Mode CBr merge to MOLY
 * .
 *
 * 01 22 2013 david.niu
 * [MOLY00009205] [MRS] Code checked-in for MOLY branch
 * .
 *
 *****************************************************************************/

#ifndef _MRS_UTILITY_H
#define _MRS_UTILITY_H

#include "mrs_as_enums.h"
#include "mrs_as_struct.h"
#include "nvram_editor_data_item.h"
#include "kal_general_types.h"
#include "ps_em_enum.h"
#include "sim_common_enums.h"
#include "global_type.h"
#include "bitstream.h"
#include "mrs_as_inter_core_struct.h"
#include "errc_nvram_editor.h"
#include "asband_nvram_editor.h"
#include "ps_inter_core_public.h"

#ifdef __CHR_AB_INFO__
#include "nbr_public_struct.h"
#endif /* __CHR_AB_INFO__ */


/* GLOBAL VARIABLE DECLARATIONS *********************************************/
#ifdef UNIT_TEST
extern kal_bool modis_IT_mode;
#endif

/*  Type Definitions */

#define MD3_INVALID    0x00
#define SIM1_MD3_VALID 0x01
#define SIM2_MD3_VALID 0x02
#define SIM3_MD3_VALID 0x04
#define SIM4_MD3_VALID 0x08
#define INVALID_PS_IDX 0xFF

#define SBP_DATA_AFR_TO_4G_FOLLOW_NVRAM 0x01
#define SBP_DATA_AFR_TO_4G_ENFORCE_ON   0x02
#define SBP_DATA_AFR_TO_4G_ENFORCE_OFF  0x04

#define SBP_DATA_AFR_TO_5G_FOLLOW_NVRAM 0x01
#define SBP_DATA_AFR_TO_5G_ENFORCE_ON   0x02
#define SBP_DATA_AFR_TO_5G_ENFORCE_OFF  0x04

/* PUBLIC FUNCTION PROTOTYPES ***********************************************/
extern void mrs_send_msg(kal_uint32 dest_mod_id, sap_type sap_id, msg_type msg_id, local_para_struct *local_para_ptr, peer_buff_struct *peer_buff_ptr);

#if defined(__3G_CSG_SUPPORT__) || defined(__LTE_RAT__)
extern void NPSI_newAcsglFromUSIM(MRS_SIM_INDEX sim_index, kal_uint8 acsglRecNum, kal_uint16 acsglSizePerRec
                             , kal_uint8* acsglData, csg_white_list_update_cause update_cause, kal_bool is_valid, mrs_csg_imsi_info csg_imsi_info);

extern void NPSI_newOcsglFromUSIM(MRS_SIM_INDEX sim_index, kal_uint8 ocsglRecNum, kal_uint16 ocsgalSizePerRec
                             , kal_uint8*   ocsglData, csg_white_list_update_cause update_cause, kal_bool is_valid);

extern white_list_update_type NPSI_updateCsgWhiteList(MRS_SIM_INDEX sim_index,
                                               MRS_RAT_MODE_TYPE    rat,
                                               csg_update_type_enum csg_update_type,
                                               mrs_plmn_id*         plmn_id,
                                               kal_uint32           csg_id);

extern kal_uint8* NPSI_getEncodedAllowedCsgList(MRS_SIM_INDEX   sim_index,
                                         kal_uint8* recNum,
                                         kal_uint16 *sizePerRec);

extern void NPSI_deleteCSGList(MRS_SIM_INDEX sim_index);

extern kal_uint8 NPSI_getValidCsgPlmn(MRS_SIM_INDEX     sim_index,
                               mrs_plmn_id**    plmns);

extern csg_type_enum NPSI_checkCsgType(MRS_SIM_INDEX    sim_index,
                                mrs_plmn_id *plmn_id,
                                kal_uint32  csg_id);

kal_bool NPSI_isCsgListEmpty(MRS_SIM_INDEX sim_index);

kal_uint16 NPSI_checkCsgNumberPerPlmn(MRS_SIM_INDEX sim_index, mrs_plmn_id *plmn_id);

extern kal_bool mrs_write_next_csg_record_to_USIM(MRS_SIM_INDEX sim_index);

extern void mrs_write_ue_based_csg_to_nvram(MRS_SIM_INDEX sim_index);


extern kal_bool mrs_write_csg_to_USIM(MRS_SIM_INDEX sim_index);

extern void mrs_read_ue_based_nv(MRS_SIM_INDEX sim_index);

extern void mrs_csg_read_nvram_cnf_handler(kal_uint8* data, kal_uint16 len);


#endif /* #if defined(__CSG_SUPPORT__) || defined(__LTE_RAT__) */

extern kal_bool MRS_occupy_lla(MRS_SIM_INDEX    sim_index,
                               MRS_RAT_MODE_TYPE    rat,
                               MRS_OCCUPY_PROCEDURE procedure);

extern void MRS_release_lla(MRS_SIM_INDEX   sim_index,
                     MRS_RAT_MODE_TYPE  rat);

extern kal_bool MRS_test_occupy_lla(MRS_SIM_INDEX sim_index,
                                    MRS_OCCUPY_PROCEDURE procedure);

extern MRS_RAT_MODE_TYPE MRS_get_lla_occupy_rat(MRS_SIM_INDEX sim_index);

extern MRS_SIM_INDEX mrs_get_current_sim_index(void);

extern void mrs_afr_reset_afr_list(MRS_SIM_INDEX sim_index);

extern void mrs_afr_insert_freq(MRS_SIM_INDEX sim_index, EARFCN earfcn);

extern void mrs_afr_get_afr_list(MRS_SIM_INDEX sim_index, mrs_afr_main_struct *afr_list_ptr);

void mrs_set_csfb_enhancement_status(MRS_SIM_INDEX sim_index, csfb_enhancement_enum enhancement_item, kal_bool activate);

void mrs_set_csfb_enhancement_status_in_test_mode(MRS_SIM_INDEX sim_index, csfb_enhancement_enum enhancement_item, kal_bool activate);

kal_bool mrs_get_csfb_enhancement_status(MRS_SIM_INDEX sim_index, csfb_enhancement_enum enhancement_item);

extern void mrs_afr_set_csfb_status(MRS_SIM_INDEX sim_index, kal_bool csfb_ongoing);

extern kal_bool mrs_afr_get_csfb_status(MRS_SIM_INDEX sim_index);

extern void mrs_set_background_search_status_in_test_mode(MRS_SIM_INDEX sim_index, background_search_enum background_search_type, kal_bool activate);

extern void mrs_set_latest_camp_on_rat(MRS_SIM_INDEX sim_index, MRS_RAT_MODE_TYPE rat);

extern void mrs_clear_latest_camp_on_rat(MRS_SIM_INDEX sim_index, kal_uint32 rat_bmp);

extern MRS_RAT_MODE_TYPE mrs_get_latest_camp_on_rat(MRS_SIM_INDEX sim_index, kal_uint32 rat_type_bitmask);

extern kal_bool mrs_get_background_search_status(MRS_SIM_INDEX sim_index, background_search_enum background_search_type);

extern void mrs_ecsfb_add_2g_association(MRS_SIM_INDEX sim_index, kal_uint32 eas_cell_id, mrs_gas_cell_inf_struct *p_gas_cell_inf);

extern void mrs_ecsfb_set_2g_association_call_flag(MRS_SIM_INDEX sim_index, kal_uint32 eas_cell_id, mrs_gas_cell_inf_struct *p_gas_cell_inf);

extern kal_uint8 mrs_ecsfb_get_2g_lai(MRS_SIM_INDEX sim_index, kal_uint32 eas_cell_id, mrs_gas_cell_inf_struct *p_gas_cell_inf);

extern kal_uint8 mrs_ecsfb_get_same_lai_2g(MRS_SIM_INDEX sim_index, mrs_lai_struct *lai, kal_uint32 valid_duration, mrs_gas_cell_inf_struct *p_gas_cell);

extern void mrs_ecsfb_reset_association_info(MRS_SIM_INDEX sim_index);

extern void mrs_fast_roaming_set_mcc(MRS_SIM_INDEX sim_index, mrs_nas_mcc_struct *mrs_nas_mcc);

extern void mrs_fast_roaming_get_mcc(MRS_SIM_INDEX sim_index, mrs_as_mcc_struct *mrs_as_mcc_ptr);
/* used for setting and getting 4G cell id when CSFB to 2G by PLMN search scenario */
extern void mrs_ecsfb_set_4g_cell_info(MRS_SIM_INDEX sim_index, kal_uint32 eas_cell_id);
extern kal_uint32 mrs_ecsfb_get_4g_cell_info(MRS_SIM_INDEX sim_index);

extern kal_uint8 mrs_ecsfb_get_cur_2g_cell_association(MRS_SIM_INDEX sim_index, kal_uint32 *eas_cell_id, mrs_gas_cell_inf_struct *gas_cell_inf); 
/* Fast mode switch. */
extern void mrs_gas_fast_mode_switch_set_status(MRS_SIM_INDEX sim_index, mrs_gas_fast_mode_switch_status_enum status);
extern kal_bool mrs_gas_fast_mode_switch_check_allowed(MRS_SIM_INDEX sim_index, const kal_uint32 num_plmn, plmn_id_struct* plmn_id_ptr);
extern void mrs_gas_fast_mode_switch_set_plmn_id(MRS_SIM_INDEX sim_index, plmn_id_struct* plmn);
extern void mrs_gas_fast_mode_switch_set_arfcn(MRS_SIM_INDEX sim_index, kal_uint16 arfcn);
extern void mrs_gas_fast_mode_switch_set_bsic(MRS_SIM_INDEX sim_index, kal_uint8 bsic);
extern kal_uint16 mrs_gas_fast_mode_switch_get_arfcn(MRS_SIM_INDEX sim_index);
extern kal_uint8 mrs_gas_fast_mode_switch_get_bsic(MRS_SIM_INDEX sim_index);
extern kal_uint8 mrs_gas_fast_mode_switch_get_si_bitmap(MRS_SIM_INDEX sim_index);
extern kal_uint8* mrs_gas_fast_mode_switch_get_si_raw_data(MRS_SIM_INDEX sim_index, kal_uint8 si_type);
extern void mrs_gas_fast_mode_switch_store_essential_si(MRS_SIM_INDEX sim_index, bit_stream* bit_stream_ptr, kal_uint8 si_bitmap_pos);
extern void mrs_gas_fast_mode_switch_clean_stored_essential_si(MRS_SIM_INDEX sim_index, kal_uint8 si_bitmap_pos);
/* Fast mode switch. */

/* Support VzW: VZ_REQ_LTEDATA_38498 (MT6291 Verizon Jun-2015 baseline). */
extern void mrs_nas_set_roaming_status(MRS_SIM_INDEX sim_index, kal_bool is_roaming);
extern kal_bool mrs_nas_get_roaming_status(MRS_SIM_INDEX sim_index);
/* Support VzW: VZ_REQ_LTEDATA_38498 (MT6291 Verizon Jun-2015 baseline). */

//#ifdef __LTE_R11__
void mrs_ltea_son_set_reest_proc_status(MRS_SIM_INDEX sim_index, kal_bool lte_reest_ir_search);
void mrs_ltea_son_set_selected_cell(MRS_SIM_INDEX sim_index, kal_uint32 selected_arfcn, kal_uint16 selected_pci);
void mrs_ltea_son_reset_selected_cell(MRS_SIM_INDEX sim_index);
kal_bool mrs_ltea_son_get_selected_cell(MRS_SIM_INDEX sim_index, kal_uint32 *selected_arfcn_p, kal_uint16 *selected_pci_p);
//#endif

//L1 call back function
extern kal_uint8 mrs_l1_query_ps_c2k_sim_config();

/* Common TFO API functions for all RATs */
void mrs_tfo_cell_list_clear(MRS_SIM_INDEX sim_index, MRS_RAT_MODE_TYPE rat_type);

/* EAS specific TFO API functions */
void mrs_tfo_cell_list_add_eas_cell(MRS_SIM_INDEX sim_index, EARFCN earfcn, kal_uint16 pci, kal_uint16 validity_time, kal_uint8 offset);
kal_uint8 mrs_tfo_cell_list_eas_cell_offset_get(MRS_SIM_INDEX sim_index, EARFCN earfcn, kal_uint16 pci);

#ifdef __CHANNEL_LOCK__
/*******************************************************************************
Description:
    This function is used to write channel lock information to MRS.
        
Parameters:
    ch_lock_info: Pointer to channel lock information to be stored
    
Return Value: None    
*******************************************************************************/
kal_bool mrs_ch_lock_info_set( MRS_SIM_INDEX sim_index, const mrs_ch_lock_info_struct* p_ch_lock_info);

/*******************************************************************************
Description:
    This function is used to read channel lock information from MRS.
        
Parameters:
    ch_lock_info: Pointer to where channel lock information shall be copied
    
Return Value: None    
*******************************************************************************/
void mrs_ch_lock_info_get( MRS_SIM_INDEX sim_index, mrs_ch_lock_info_struct* p_ch_lock_info );

/*******************************************************************************
Description:
    This function is used to read channel lock state from MRS.
        
Parameters: None
    
Return Value: Channel lock state    
*******************************************************************************/
MRS_CH_LOCK_STATE mrs_ch_lock_state_get(MRS_SIM_INDEX sim_index);

/*******************************************************************************
Description:
    This function is used to read channel lock mode from MRS.
        
Parameters: None
    
Return Value: Channel lock mode    
*******************************************************************************/
kal_uint8 mrs_ch_lock_mode_get(MRS_SIM_INDEX sim_index);


#ifdef __WHITE_CELL_LOCK__
/*******************************************************************************
Description:
    This function is used to write white cell lock information to MRS.
        
Parameters:
    ch_lock_info: Pointer to channel lock information to be stored
    
Return Value: kal_bool    
*******************************************************************************/
kal_bool mrs_wh_cell_lock_info_set(MRS_SIM_INDEX sim_index, const mrs_ch_lock_info_struct* p_ch_lock_info);

/*******************************************************************************
Description:
    This function is used to read white cell lock state from MRS.
        
Parameters: None
    
Return Value: White cell lock state    
*******************************************************************************/
kal_uint8 mrs_wh_cell_lock_state_get(MRS_SIM_INDEX sim_index);
#endif /* __WHITE_CELL_LOCK__ */

/*******************************************************************************
Description:
    This function is used to set channel lock scenario in MRS context.
        
Parameters:
    ch_lock_scenario: Channel lock scenario to be set in MRS context
    
Return Value: None    
*******************************************************************************/
void mrs_ch_lock_set_scenario(MRS_SIM_INDEX sim_index, MRS_CH_LOCK_SCENARIO ch_lock_scenario);

/*******************************************************************************
Description:
    This function is used to get channel lock scenario in MRS context.
    
Return Value: MRS_CH_LOCK_SCENARIO to be returned from MRS context
*******************************************************************************/
MRS_CH_LOCK_SCENARIO mrs_ch_lock_get_scenario(MRS_SIM_INDEX sim_index);
#endif /* __CHANNEL_LOCK */

/*the following 2 mrs functions are provided for T + W feature*/
extern void mrs_update_gas_system_mode(MRS_SIM_INDEX sim_index,kal_uint8 system_mode);

#ifdef __GAS_STORED_SI_FEAT__
void mrs_gas_update_gsm_storedSI_list(MRS_SIM_INDEX sim_index, rrm_gsm_storedSI_struct *gas_candidate_list);
void mrs_gas_read_gsm_storedSI_list(MRS_SIM_INDEX sim_index, rrm_gsm_storedSI_struct *gas_candidate_list);
#endif 
extern kal_uint8 mrs_get_gas_system_mode(MRS_SIM_INDEX sim_index);

#ifdef __CHR_AB_INFO__
//Huawei Index8 requirement: Inidication of reason for Not moving to 4G.

/*******************************************************************************
Description:
    This function NAS is used to set nas reason for not moving to LTE.
        
Parameters: sim_index
    
Return Value: none
*******************************************************************************/
void mrs_set_nas_reason_not_moving_to_lte(MRS_SIM_INDEX sim_index, nas_reason_not_moving_to_lte_enum  nas_reason);

/*******************************************************************************
Description:
    This function AS is used to set as reason for not moving to LTE.
        
Parameters: sim_index
    
Return Value: none
*******************************************************************************/
void mrs_set_as_reason_not_moving_to_lte(MRS_SIM_INDEX sim_index, as_reason_not_moving_to_lte_enum  as_reason);


/*******************************************************************************
Description:
    This function L4C is used to get both nas and as reason for not moving to LTE.
        
Parameters: sim_index

Return Value: If returns KAL_TRUE mean as reason is valid and L4C has to indicate info to AP.
                     If return KAL_FALSE mean CSFB call is ongoing and L4C no need to idicate info to AP.
                     ps_reason: contains both NAS and AS reason for not moving LTE
*******************************************************************************/
kal_bool mrs_get_ps_reason_not_moving_to_lte(MRS_SIM_INDEX sim_index, ps_reason_not_moving_to_lte_struct  *ps_reason);
#endif /* __CHR_AB_INFO__ */

MRS_RAT_MODE_TYPE mrs_translate_nvram_rat_mode_to_mrs(const nvram_rat_enum nvm_rat);
nvram_rat_enum mrs_translate_mrs_rat_mode_to_nvram(const MRS_RAT_MODE_TYPE mrs_rat);

//--------------NR-AFR API's-------------------
void mrs_afr_nr_init(MRS_SIM_INDEX sim_index);

extern void mrs_afr_clear_all_afr_target_rat(MRS_SIM_INDEX sim_index);

#ifdef __NR_RAT__
extern void mrs_afr_reset_nr_priority_freq_list_from_lte(MRS_SIM_INDEX sim_index);

extern void mrs_afr_insert_nr_priority_freq_list_from_lte(MRS_SIM_INDEX sim_index, mrs_afr_nr_freq_list_struct *afr_nr_freq_list);

extern void mrs_afr_get_nr_priority_freq_list_from_lte(MRS_SIM_INDEX sim_index, mrs_afr_nr_freq_list_struct *afr_nr_freq_list);
#endif /* __NR_RAT__ */

extern void mrs_afr_reset_nr_freq_list(MRS_SIM_INDEX sim_index);

extern void mrs_afr_insert_nr_freq_list(MRS_SIM_INDEX sim_index, mrs_afr_nr_freq_list_struct *afr_nr_freq_list);

extern void mrs_afr_get_nr_freq_list(MRS_SIM_INDEX sim_index, mrs_afr_nr_freq_list_struct *afr_nr_freq_list);

extern void mrs_afr_set_nr_serving_freq_info(MRS_SIM_INDEX sim_index, mrs_afr_nr_freq_info_struct nr_freq_info);

extern void mrs_afr_get_nr_serving_freq_info(MRS_SIM_INDEX sim_index, mrs_afr_nr_freq_info_struct *p_nr_freq_info);

void mrs_set_afr_enhancement_status(MRS_SIM_INDEX sim_index, afr_enhancement_enum enhancement_item, kal_bool activate);

void mrs_set_afr_enhancement_status_in_test_mode(MRS_SIM_INDEX sim_index, afr_enhancement_enum enhancement_item, kal_bool activate);

extern kal_bool mrs_get_afr_support_status(MRS_SIM_INDEX sim_index, kal_uint16 bitmask);

kal_bool mrs_get_afr_enhancement_status(MRS_SIM_INDEX sim_index, afr_enhancement_enum enhancement_item);

void mrs_afr_nas_update_service_table_start(MRS_SIM_INDEX sim_index, afr_service_enum service, MRS_RAT_MODE_TYPE target_rat);

void mrs_afr_nas_update_service_table_end(MRS_SIM_INDEX sim_index, afr_service_enum service);

void mrs_afr_reset_table_by_service(MRS_SIM_INDEX sim_index, afr_service_enum service);

void mrs_afr_rat_fallback_triggerred(MRS_SIM_INDEX sim_index, afr_pre_cond_proc_enum procedure);

void mrs_afr_update_by_high_rat(MRS_SIM_INDEX sim_index, MRS_RAT_MODE_TYPE rat);

void mrs_afr_fail_update_by_low_rat(MRS_SIM_INDEX sim_index, MRS_RAT_MODE_TYPE rat);

kal_uint32 mrs_fr_as_determine_fr_rat(MRS_SIM_INDEX sim_index, MRS_RAT_MODE_TYPE rat, kal_bool skip_voice_status);
kal_uint32 mrs_afr_as_determine_afr_rat(MRS_SIM_INDEX sim_index, MRS_RAT_MODE_TYPE rat, kal_bool skip_voice_status);

kal_uint32 mrs_afr_get_afr_to_4g_timer(MRS_SIM_INDEX sim_index);
void mrs_afr_set_afr_to_4g_timer(MRS_SIM_INDEX sim_index, kal_uint32 afr_to_4g_timer_val);

kal_uint32 mrs_afr_get_afr_to_5g_timer(MRS_SIM_INDEX sim_index);
void mrs_afr_set_afr_to_5g_timer(MRS_SIM_INDEX sim_index, kal_uint32 afr_to_5g_timer_val);

void mrs_afr_update_strict_constrain_triggered_by_high_rat(MRS_SIM_INDEX sim_index, MRS_RAT_MODE_TYPE high_rat);

kal_bool mrs_afr_get_4g_csfb_status(MRS_SIM_INDEX sim_index);
kal_bool mrs_afr_get_5g_epsfb_status(MRS_SIM_INDEX sim_index);
//--------------NR-AFR-------------------

/*******************************************************************************
Description:
    This function is used to count RAT change for IRAT PINGPONG detection.
        
Parameters: sim_index, irat_type

Return Value: none
*******************************************************************************/
extern void mrs_set_irat_pingpong_info(MRS_SIM_INDEX sim_index, mrs_irat_pingpong_type_enum irat_type);
/*******************************************************************************
Description:
    This function is used to judge IRAT PINGPONG by count RAT change times during given period.
        
Parameters: sim_index, irat_type, duration (unit: seconds), threshold (MAX: 8)

Return Value:
    TRUE: IRAT PINGPONG detected
    FALSE: there's no PINGPONG or the corresponding SBP is not ON
*******************************************************************************/
extern kal_bool mrs_query_irat_pingpong_status(MRS_SIM_INDEX sim_index, mrs_irat_pingpong_type_enum irat_type,kal_uint32 duration, kal_uint8 pingpong_thres);


// DR-DSDS/DSDA APIs
/**
* @brief This function is used by each RRC to check if the indicated frequency could be searched without gap with peer SIM connection ongoing.
* @param[in] sim_index
* @param[in] rat
* @param[in] band
* @param[in] arfcn: For RAT_NR, it means NRARFCN. For LTE, it means EARFCN
* @return KAL_TRUE: if search w/o GAP is supported. KAL_FALSE: if search w/o GAP is not supported
*/
kal_bool mrs_is_freq_search_allowed_with_peer_sim_connection (
    MRS_SIM_INDEX sim_index,
    MRS_RAT_MODE_TYPE rat,
    kal_uint16 band,
    kal_uint32 arfcn
);

/**
* @brief This function is if there are more than one SIM card are inserted.
* @param[in] none
* @return KAL_TRUE: if more than one SIM card are inserted. KAL_FALSE: if no or only one SIM card is inserted.
*/
kal_bool mrs_is_multi_sim_inserted(void);

/**
* @brief This function is to check whether DSDA is supported.
* @param[in] p_cell_cc_info: check DSDA support status by p_cell_cc_info and stored peer SIM cell cc info. If p_cell_cc_info is NULL, check DSDA status by all stored cell cc info.
* @param[in] is_test_rfdb_query: If current SIM need to check gemini_mode by using mrs_gemini_ie_check_cell_cc_config_db
* @param[in] ps_id: current sim_index. MRS only use this parameter when is_test_rfdb_query is TRUE.
* @return mrs_gemini_mode_enum: If DSDA support is returned, DR-DSDS is also supported. If DR-DSDS is returned, DSDA is not supported.
*/
mrs_gemini_mode_enum mrs_query_support_gemini_mode(mrs_cell_cc_info_struct *p_cell_cc_info, kal_bool is_test_rfdb_query, protocol_id_enum ps_id);

void mrs_set_test_rfdb_to_config_rfdb(protocol_id_enum sim_index);

rat_enum mrs_get_active_rat_for_dr_dsds_dsda(protocol_id_enum ps_id);

protocol_id_enum mrs_get_peer_sim_index_for_dr_dsds_dsda(protocol_id_enum ps_id);

kal_bool mrs_take_channel_protect_sem(protocol_id_enum ps_id, rat_enum rat);

void mrs_give_channel_protect_sem(protocol_id_enum ps_id, rat_enum rat);

/*******************************************************************************
Description:
    This function is used to query if a specific feature is turned on.
    For inter-RAT or cross module features that needs to be triggered by the other modules, this API could be applied.
        
Parameters: 
    [sim_index] SIM index
    [feature_enum] The enum value of the querying feature
    
Return Value: 
    TRUE: feature ON
    FALSE: feature OFF
*******************************************************************************/
kal_bool mrs_get_feature_status_by_sim(MRS_SIM_INDEX sim_index, mrs_feature_enum feature_enum);

/*******************************************************************************
Description:
    This function is used to set if a specific feature is turned on.
    For inter-RAT or cross module features that needs to be executed by the other modules, this API could be applied.
        
Parameters: 
    [sim_index] SIM index
    [feature_enum] The enum value of the querying feature
    [value] The staus we're going to set for this feature (TRUE: ON / FALSE: OFF)
    
Return Value: void
*******************************************************************************/
void mrs_set_feature_status_by_sim(MRS_SIM_INDEX sim_index, mrs_feature_enum feature_enum, kal_bool status);

kal_bool mrs_check_disable_fast_plmn_list(MRS_SIM_INDEX sim_index);

void mrs_l4c_send_capability_update_ind(MRS_SIM_INDEX sim_index);
void mrs_save_previous_region_to_nvram(void);
kal_bool mrs_umts_update_detected_band_for_plmn_region(mrs_plmn_id  plmn_id, kal_uint32 bandIDBmp);
kal_bool mrs_gsm_update_detected_band_for_plmn_region(mrs_plmn_id  plmn_id, kal_uint8 bandIDBmp);
kal_bool mrs_lte_update_detected_band_for_plmn_region( mrs_plmn_id  plmn_id, kal_uint8 *bandID);
kal_bool mrs_get_all_the_lte_supported_bands_per_region(mrs_plmn_id  plmn_id, kal_uint8 *bandID);
void mrs_copy_mrs_context_to_nvram(nvram_ef_band_setting_per_region_info_record_struct *pnvram_band);
kal_bool mrs_get_mcc_region_umts_bands(mrs_plmn_id  plmn_id, kal_uint32 *UBandBitmask_FDD);
kal_bool mrs_get_mcc_region_gsm_bands(mrs_plmn_id  plmn_id, kal_uint8 *gsmBandBitmask);
void mrs_as_band_setting_update_by_plmn( MRS_SIM_INDEX sim_index, function_caller_id_enum caller_id, mrs_plmn_id* hplmn, mrs_plmn_id_list* cplmn);

/*******************************************************************************
Description:
    This function is used to get operator ID for the PLMN.

Parameters: 
    [operator_enum] operator id (input)
    [p_plmn] Pointer to PLMN code (input)

Return Value: 
    TRUE: plmn match operator id
    FALSE: plmn does not belong to this operator

*******************************************************************************/
kal_bool mrs_check_if_plmn_match_operator_id(operator_id_enum operator_enum, const plmn_id_struct *p_plmn);

/*******************************************************************************
Description:
    This function is used to get operator ID for the PLMN.

Parameters: 
    [p_plmn] Pointer to PLMN code

Return Value: Operator ID
*******************************************************************************/
operator_id_enum mrs_get_operator_id_of_plmn(const plmn_id_struct *p_plmn);

/*******************************************************************************
Description:
    This function is called during MRS task init, to check for OTA Update

Parameters: 
    None

Return Value: void
*******************************************************************************/
extern void mrs_set_ota_update_during_init();

/*******************************************************************************
Description:
    This function is used to reset the NVRAM values to through OTA during Init.

Parameters: 
     LID Name and SIZE

Return Value: void
*******************************************************************************/
void  mrs_update_nvram_with_ota_values(kal_uint16 nvram_id, kal_uint32 size);

/*******************************************************************************
Description:
    This function is used to check SBP bit state.

Parameters: 
    [feature] Feature whose SBP bit is checked
    [sim_index] MRS SIM index

Return Value:
    KAL_TRUE:  if feature is turned on
    KAL_FALSE: if feature is turned off
*******************************************************************************/
kal_bool mrs_sbp_query_md_feature_by_ps(sbp_md_feature_enum feature, MRS_SIM_INDEX sim_index);

/*******************************************************************************
Description:
    This function compares two PLMNs.

Parameters: 
    [ms_plmn_id] PLMN ID
    [bcch_plmn_id] PLMN ID

Return Value:
    KAL_TRUE:  PLMNs are the same
    KAL_FALSE: PLMNs are different
*******************************************************************************/
kal_bool mrs_is_plmn_id_match_with_bcch_plmn_id(const plmn_id_struct *ms_plmn_id, const plmn_id_struct *bcch_plmn_id);

#endif /* _MRS_UTILITY_H */