mcu/protocol/interface/l4/mm2mmi_struct.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) 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:
 * ---------
 *	mm2mmi_struct.h
 *
 * Project:
 * --------
 *   MAUI
 *
 * Description:
 * ------------
 *   This file is intends for structure definition between MM and MMI.
 *
 * 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!
 *
 *
 *------------------------------------------------------------------------------
 * 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.
*
********************************************************************************/


/*******************************************************************************
*  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) 2002
*
*******************************************************************************
 *  FILENAME : mm2mmi_struct.h
 *  SYNOPSIS : Functions for encoding/decoding.
 *
 *                      R E V I S I O N    H I S T O R Y
 *
 */
#ifndef _MM2MMI_STRUCT_H
#define _MM2MMI_STRUCT_H

#include "kal_general_types.h"
#include "ps_public_enum.h"
#include "l3_inc_enums.h"
#include "mcd_l3_inc_struct.h"
#include "l3_inc_local.h"
#include "mm_mmi_enums.h"
#include "kal_public_defs.h"
#include "sim_public_enum.h"
#include "mm_emm_struct.h"
#include "mmi2mm_struct.h"

typedef struct {
    LOCAL_PARA_HDR
    kal_bool full_nw_nameP;
    kal_uint8 full_nw_name_len;
    kal_uint8 full_nw_name[MAX_NW_NAME_LENGTH];
    kal_bool short_nw_nameP;
    kal_uint8 short_nw_name_len;
    kal_uint8 short_nw_name[MAX_NW_NAME_LENGTH];
    kal_bool nw_time_zoneP;
    kal_uint8 nw_time_zone;
    kal_bool nw_time_zone_timeP;
    nw_time_zone_time_struct nw_time_zone_time;
    kal_bool lsa_idP;
    kal_uint8 lsa_id_len;
    kal_uint8 lsa_id[3];
    kal_bool nw_day_light_saving_timeP;
    kal_uint8 nw_day_light_saving_time;
    /* MAUI_01664028, mtk02118: added for MMI to exactly know which PLMN the NITZ comes from  */
    plmn_id_struct plmn_id;
} gmmreg_nw_info_struct; /* This struct shall be the same with l4crac_nw_info_ind_struct. */

typedef struct {
    LOCAL_PARA_HDR
    data_speed_support_enum cell_data_speed_support; /* mtk02475: for edge and hspa status */
    cell_info_and_rat_struct cell_info;
    kal_bool is_ra_code_valid;
    kal_bool is_from_cgi_ind;
} gmmreg_cell_info_update_ind_struct;

/* For GPRS MMI. */
typedef struct {
    LOCAL_PARA_HDR
    gmmreg_ps_service_info_enum current_status; /* gmmreg_ps_service_info_enum */
} gmmreg_ps_service_info_ind_struct;

typedef struct {
    LOCAL_PARA_HDR
    kal_uint8 is_gsm_conn_exist;
    gmmreg_cipher_ind_enum gsm_cipher_cond;
    gmmreg_cipher_ind_enum gprs_cipher_cond;
} gmmreg_cipher_ind_struct; /* must same as l4crac_cipher_ind_struct */

typedef struct {
    LOCAL_PARA_HDR
    kal_bool is_dedicated_mode;
} gmmreg_dedicated_mode_ind_struct; /* must same as l4crac_hz_dedicated_mode_ind_struct */


typedef struct {
    LOCAL_PARA_HDR
    proc_status_enum status;         /* proc_status_enum */
    mm_cause_enum  cause;          /* mm_cause_enum */
    kal_uint8 num_of_hplmn;
    rac_plmn_list_struct plmn_list;
} gmmreg_plmn_list_cnf_struct;

typedef struct {
    LOCAL_PARA_HDR
    proc_status_enum status;
    mm_cause_enum cause;
    rac_csg_list_struct csg_list;
} gmmreg_csg_list_cnf_struct;

typedef gmmreg_nw_info_struct gmmreg_nw_info_ind_struct;

#ifdef __GEMINI__
typedef struct {
    LOCAL_PARA_HDR
    rr_suspend_mode_reason_enum rr_service_status;
}gmmreg_rr_service_status_ind_struct; //20080217
#endif

typedef struct {
    LOCAL_PARA_HDR
    kal_uint8 no_ecc; //number of ECC list
    ecc_number_struct ecc_list[MAX_NW_ECC_NUM]; //ECC list
} gmmreg_nw_ecc_ind_struct;
//~ __REL5__

typedef struct {
    LOCAL_PARA_HDR
    end_session_result_enum result;
}gmmreg_end_ps_data_session_cnf_struct;

#if defined (__NO_PSDATA_SEND_SCRI__) || defined (__FAST_DORMANCY__)
typedef struct {
    LOCAL_PARA_HDR
    end_session_cause_enum cause;
}gmmreg_end_ps_data_session_ind_struct;
#endif

#ifdef __LTE_RAT__

typedef struct {
    LOCAL_PARA_HDR
    mm_emm_csfb_paging_id_enum csfb_paging_id; //Paging identity used in CS SERVICE NOTIFICATION
    kal_bool is_cli_present; //Whether CLI (Calling Line Identification) IE exists or not
    kal_uint8 cli_len;    //Length of CLI
    kal_uint8 cli[12];    //CLI value Refer to TS 24.008 subclause 10.5.4.9  Calling party BCD number for decoding.
    kal_bool is_ss_code_present; //Whether SS code IE exists or not
    kal_uint8 ss_code;    //SS code value Refer to TS 29.002 subclause 17.7.5 for decoding.
    kal_bool is_lcs_ind_present; //Whether LCS indicator IE exists or not
    kal_uint8 lcs_indicatior; //LCS indicator value; 0x01: MT-LR, Other values: Normal, unspecified in this version of the protocol
    kal_bool is_lcs_client_id_present;   //Whether LCS client identity IE exists or not
    kal_uint8 lcs_client_id_len;  //Length of LCS client identity
    kal_uint8 lcs_client_id[255]; //LCS client identity value, Refer to TS 29.002 subclause 17.7.13 for decoding.
}gmmreg_csfb_page_ind_struct;

typedef struct {
    LOCAL_PARA_HDR
    kal_bool is_accept_paging;   //Whether upper layer decides to answer the mobile terminating CS service
}gmmreg_csfb_page_rsp_struct;

#endif
typedef struct {
    LOCAL_PARA_HDR
    RATCM_RRC_ReleaseCause  cause;      
}gmmreg_rrc_conn_rel_cause_ind_struct;


typedef struct
{
    LOCAL_PARA_HDR
    gmm_nw_feature_support_struct   ug_nw_feature;
} gmmreg_nw_feature_ind_struct;

typedef struct {
    LOCAL_PARA_HDR
    sat_nw_rej_info_enum op;
    cell_info_and_rat_struct current_cell;
    sat_nw_rej_type_enum type;
    kal_uint8 rej_cause;
}gmmreg_nw_reject_ind_struct;

#ifdef __GEMINI__
typedef struct {
    LOCAL_PARA_HDR
    kal_bool is_virtual_connected;
}gmmreg_virtual_mode_ind_struct;

typedef struct {
    LOCAL_PARA_HDR
    rsim_auth_finish_result_enum result;
}gmmreg_auth_finish_ind_struct;

typedef struct {
    LOCAL_PARA_HDR
    rsim_auth_abort_result_enum result;
}gmmreg_rsim_auth_abort_cnf_struct;

#endif /* __GEMINI__ */

typedef struct {
    LOCAL_PARA_HDR
    kal_bool non_3gpp_emergency_number_indicator; // To indicate non-3gpp nw provided policies IEI information to Upper layers which is extracted from LU accept message, RAU accept message and Attach accept message.
}gmmreg_non_3gpp_nw_policies_ind_struct;

typedef mm_emm_csfb_result_ind_struct gmmreg_csfb_result_ind_struct;

typedef struct {
    LOCAL_PARA_HDR
    mm_cause_source_enum event;
    mm_cause_enum original_mm_cause;
    mm_cause_enum converted_mm_cause;
    kal_bool is_ps_sim_valid;
    kal_bool is_cs_sim_valid;
} gmmreg_cause_info_ind_struct;

#if defined(__ECALL_SUPPORT__) || defined(__NG_ECALL_SUPPORT__)
typedef struct
{
    LOCAL_PARA_HDR
    kal_bool result;  	/* 1 : success, 0: failure */
} gmmreg_set_ecall_registration_cnf_struct;

typedef gmmreg_set_ecall_registration_req_struct gmmreg_ecall_registration_state_ind_struct;
#endif

#endif