mcu/protocol/interface/l4/l4b_vdm_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:
 * ---------
 *	l4b_vdm_struct.h
 *
 * Description:
 * ------------
 *   This file is intends for L4B/VDM interface
 *
 * 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!
 *
 *------------------------------------------------------------------------------
 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *==============================================================================
 *******************************************************************************/

#ifndef _L4B_VDM_STRUCT_H
#define _L4B_VDM_STRUCT_H

#include "kal_public_defs.h"
#include "ps_public_enum.h"
#include "l4_vdm_enum.h"
#include "sim_public_enum.h"


#if defined(__ECALL_SUPPORT__) || defined(__NG_ECALL_SUPPORT__)
/***********************************/
/*      VDM -> L4B (REQ)           */
/***********************************/
typedef struct
{
    LOCAL_PARA_HDR
    ecall_type_enum         ecall_type;
    ecall_format_enum       ecall_format;
    kal_uint8               msd_data_len;
    kal_uint8               msd_data[MAX_MSD_LENGTH]; 
} vdm_l4b_cs_cc_ecall_req_struct;
#endif

typedef struct
{
    LOCAL_PARA_HDR
    kal_uint8               dial_num[MAX_CC_ADDR_LEN];
    kal_bool                is_video_call;
    kal_bool                is_redial_from_volte;
    kal_uint8               call_id;
    kal_uint8               so;
} vdm_l4b_c2k_cc_mo_call_req_struct;


typedef struct
{
    LOCAL_PARA_HDR
    kal_uint8               dial_num[MAX_CC_ADDR_LEN];
    kal_uint8               call_id;
} vdm_l4b_c2k_cc_emerg_call_req_struct;


typedef struct
{
    LOCAL_PARA_HDR
    sat_terminal_res_enum   tr; // o or 4
    kal_uint8               call_id;
} vdm_l4b_c2k_cc_stk_call_req_struct;


typedef struct
{
    LOCAL_PARA_HDR
    kal_uint8                      call_id;
    l4_call_related_ss_type_enum   opcode;
} vdm_l4b_c2k_cc_call_related_ss_req_struct;


typedef struct 
{  
    LOCAL_PARA_HDR
    kal_uint8                       call_id;
    kal_uint8                       seq_no;
    l4_cc_eaic_result_enum          eaic_result;
} vdm_l4b_c2k_cc_mt_call_present_rsp_struct;


typedef struct 
{  
    LOCAL_PARA_HDR
} vdm_l4b_c2k_cc_mt_call_accept_req_struct;


typedef struct 
{  
    LOCAL_PARA_HDR
}vdm_l4b_c2k_cc_list_current_calls_req_struct;


typedef struct 
{  
    LOCAL_PARA_HDR 
    kal_uint8   digit;
} vdm_l4b_c2k_cc_send_digit_req_struct;


typedef struct 
{  
    LOCAL_PARA_HDR 
    kal_uint8   digit;
} vdm_l4b_c2k_cc_start_send_digit_req_struct;


typedef struct
{
    LOCAL_PARA_HDR
} vdm_l4b_c2k_cc_stop_send_digit_req_struct;


/***********************************/
/*      L4B -> VDM (CNF)           */
/***********************************/


/* Common response from L4B to VDM */
typedef struct
{
    LOCAL_PARA_HDR
    l4_result_code_enum    result;
    l4_err_id_enum         error_cause;
} vdm_l4b_common_response_struct;

#if defined(__ECALL_SUPPORT__) || defined(__NG_ECALL_SUPPORT__)
/* MSG_ID_VDM_L4B_CS_CC_ECALL_CNF */
typedef vdm_l4b_common_response_struct vdm_l4b_cs_cc_ecall_cnf_struct;
#endif

typedef vdm_l4b_common_response_struct vdm_l4b_c2k_cc_mo_call_cnf_struct;

typedef vdm_l4b_common_response_struct vdm_l4b_c2k_cc_emerg_call_cnf_struct;

typedef vdm_l4b_common_response_struct vdm_l4b_c2k_cc_stk_call_cnf_struct;

typedef vdm_l4b_common_response_struct vdm_l4b_c2k_cc_hangup_all_cnf_struct;

typedef vdm_l4b_common_response_struct vdm_l4b_c2k_cc_call_related_ss_cnf_struct;


typedef struct 
{
    LOCAL_PARA_HDR
    l4_ext_error_report_enum       ceer_cause;
    l4_result_code_enum            result;
    l4_err_id_enum                 err_id;
    kal_uint16                     ecc_category;
} vdm_l4b_c2k_cc_ext_error_report_cnf_struct;


typedef struct {
    kal_uint8              call_id;
    l4_call_dir_enum       dir;
    l4_call_state_enum     call_state;
    l4_call_mode_enum      call_mode;
    kal_bool               mpty;  // FALSE: is NOT conference call, TRUE: is conference call
    l4_call_type_enum      call_type;
    kal_uint8              number[MAX_CC_ADDR_LEN];
    kal_uint8              cli_validity;
} vdm_l4b_call_list_struct;


typedef struct {
    kal_uint8                  call_id;
    l4_call_dir_enum           dir;
    l4_clccs_call_mode_enum    clccs_cs_mode;
    l4_call_ccstatus_enum      ccstatus;
    kal_bool                   mpty;  // FALSE: is NOT conference call, TRUE: is conference call
    l4_call_number_type_enum   number_type;
    l4_call_type_enum          call_type;
    kal_uint8                  number[MAX_SIP_URI_LEN];
    kal_bool                   cli_present;
    kal_uint8                  cli_validity;
} vdm_l4b_call_list_ext_struct;

typedef struct {
    LOCAL_PARA_HDR
    sat_terminal_res_enum tr;
    kal_uint8 additional_info;
} vdm_l4b_snd_stk_call_tr_req_struct;

typedef struct 
{
    LOCAL_PARA_HDR
    l4_result_code_enum            result;
} vdm_l4b_snd_stk_call_tr_cnf_struct;

typedef struct
{
    LOCAL_PARA_HDR
    kal_uint8                   total_call;
    vdm_l4b_call_list_struct   call_list[L4CC_MAX_CALL_NUM];
} vdm_l4b_c2k_cc_list_current_calls_cnf_struct;


typedef vdm_l4b_common_response_struct                  vdm_l4b_c2k_cc_mt_call_accept_cnf_struct;

typedef vdm_l4b_common_response_struct                  vdm_l4b_c2k_cc_send_digit_cnf_struct;

typedef vdm_l4b_common_response_struct                  vdm_l4b_c2k_cc_start_send_digit_cnf_struct;

typedef vdm_l4b_common_response_struct                  vdm_l4b_c2k_cc_stop_send_digit_cnf_struct;
/***********************************/
/*      L4B -> VDM (URC)           */
/***********************************/

typedef struct
{
    /* +ECPI:<call_id>,<msg_type>,<is_ibt>,<is_tch>,<dir>,
     *       <call_mode>,[<number>,<type>],[<disc_cause>],[<pau>]
     */
    kal_bool               is_ibt;
    kal_bool               is_tch;
    l4_call_dir_enum       call_dir;
    l4_call_mode_enum      call_mode;
    kal_bool               is_number_call_type_present;
    kal_uint8              number[MAX_CC_ADDR_LEN];
    l4_call_type_enum      call_type;
    kal_bool               is_disc_cause_present;
    kal_uint16             disc_cause;
} l4b_ecpi_info_struct;


typedef struct {
    LOCAL_PARA_HDR
    kal_uint8               call_id;
    kal_uint8               ecpi_type;
    l4b_ecpi_info_struct    ecpi_info;
} vdm_l4b_common_cs_cc_ecpi_ind_struct;


typedef struct {
    kal_uint8              number[MAX_CC_ADDR_LEN];
    l4_call_type_enum      call_type;
    l4_call_mode_enum      call_mode;
    kal_uint8 redirect_num[MAX_CC_ADDR_LEN];
} l4b_cc_eaic_info_struct;


typedef struct 
{  
    /* +EAIC
     */

    LOCAL_PARA_HDR 
    kal_uint8                       call_id;
    l4b_cc_eaic_info_struct         eaic_info;
    kal_uint8                       seq_no;
} vdm_l4b_c2k_cc_mt_call_present_ind_struct;

/* MSG_ID_VDM_L4BNW_ATTACHED_RAT_IND */
typedef struct 
{
    LOCAL_PARA_HDR 
    rat_enum    currently_attached_rat;
    rat_enum    last_attached_rat;
} vdm_l4bnw_attached_rat_ind_struct;

/******************************************************************************
 * +ESTKCNUM: <call_number>, <call_type>, <domain>
 *****************************************************************************/
typedef struct
{
    LOCAL_PARA_HDR
    kal_uint8                   stk_call_num[MAX_CC_ADDR_LEN];
    l4_call_type_enum           stk_call_type;
    l4_stk_call_domain_enum     stk_call_domain;
	l4_stk_redial_setting_enum  stk_redial_setting;
	l4_stk_media_type_enum      stk_media_type;
} vdm_l4b_stk_call_num_ind_struct;

typedef vdm_l4b_common_cs_cc_ecpi_ind_struct vdm_l4b_c2k_cc_ecpi_translate_ind_struct;

typedef vdm_l4b_common_cs_cc_ecpi_ind_struct vdm_l4b_c2k_cc_mt_call_setup_ind_struct;

typedef vdm_l4b_common_cs_cc_ecpi_ind_struct vdm_l4b_c2k_cc_call_disconnect_ind_struct;

typedef vdm_l4b_common_cs_cc_ecpi_ind_struct vdm_l4b_c2k_cc_mo_call_id_ind_struct;

#endif /* _L4B_VDM_STRUCT_H */