mcu/protocol/interface/l4/ssds_l4c_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) 2013
*
*  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:
* ------------
*   ssds_l4c_struct.h
*
* Project:
* ------------
*   MOLY
*
* Description:
* ------------
*   This file is intends for L4C/SSDS interface
*
* Author:
* -----------
 * -------
*****************************************************************************/
#ifndef _SSDS_L4C_STRUCT_H
#define _SSDS_L4C_STRUCT_H

#include "kal_public_defs.h"
#include "kal_general_types.h"
#include "l3_inc_enums_public.h"
#include "ps_public_enum.h"
#include "rmmi_common_enum.h"
#include "l4_vdm_enum.h"
#include "sim_public_enum.h"
#include "l4b_vdm_struct.h"
#include "ims_common_def.h"
#include "ims_interface_md.h"
#include "l3_inc_enums.h"
#include "c2k_irat_msg_struct.h"
#include "l4c_eval_struct.h"

#define SSDS_L4C_NEED_SIP_MSG_DATA 0


/* MSG_ID_SSDS_L4C_FDN_CHECK_REQ */
typedef struct
{
    LOCAL_PARA_HDR
    kal_uint8     dial_num[MAX_CC_ADDR_LEN];
} ssds_l4c_fdn_check_req_struct;

/* MSG_ID_SSDS_L4C_FDN_CHECK_CNF */
typedef struct
{
    LOCAL_PARA_HDR
    kal_bool            is_allowed;
	phb_errno_enum      result; /* phb_errno_enum; Operation result*/
    kal_uint16          cause;
} ssds_l4c_fdn_check_cnf_struct;

typedef struct
{
    LOCAL_PARA_HDR
    kal_bool                        is_imsvops_support;
} ssds_l4c_nw_feature_ind_struct;


/*--------------------------------------------------------
 * STKUSSD
 *--------------------------------------------------------*/
// As CSM defined, USSD string max length before unpacking = 160
// Consider 7-bit coding => ASCII: 182
#define STK_IMS_USSD_MAX_LEN (182)   // Maximum USSI string/response in ASCII

typedef enum
{
    SIP_MSG_TYPE_NONE,
	SIP_MSG_TYPE_INFO,
	SIP_MSG_TYPE_BYE
	
}ssds_l4c_sip_msg_type;

/* MSG_ID_SSDS_L4C_STK_IMS_USSD_CONFIG_REQ */
typedef struct
{
    LOCAL_PARA_HDR
    kal_bool is_icon_display;  // inform L4 if AP shows icon or not (AT+STKUSSD=0 or 4)
} ssds_l4c_stk_ims_ussd_config_req_struct;

/* MSG_ID_SSDS_L4C_STK_IMS_USSD_CONFIG_CNF */
typedef struct
{
    LOCAL_PARA_HDR
    kal_bool need_inform_user;  // inform SSDS if URC report is needed

    // Peer Buffer: ussd string, ASCII string (no '\0')
} ssds_l4c_stk_ims_ussd_config_cnf_struct;

/* MSG_ID_SSDS_L4C_STK_IMS_USSD_RES */
typedef struct
{
    LOCAL_PARA_HDR
    kal_bool is_successful;
    kal_bool need_retry_cs;
	#if SSDS_L4C_NEED_SIP_MSG_DATA
	ssds_l4c_sip_msg_type 	sip_msg;
	#endif
    sat_terminal_res_enum   tr_cause;
    sat_additional_info_for_res_enum  additional_cause;

    // Peer Buffer: response string, hex string of ASCII string (with '\0')
} ssds_l4c_stk_ims_ussd_res_struct;

/* MSG_ID_SSDS_L4C_STK_CS_USSD_REQ */
typedef struct
{
    LOCAL_PARA_HDR
    kal_bool is_icon_display;  // inform L4 if AP shows icon or not (AT+STKUSSD=0 or 4)
} ssds_l4c_stk_cs_ussd_req_struct;


/*--------------------------------------------------------
 * STKSS
 *--------------------------------------------------------*/
/* MSG_ID_SSDS_L4C_STKSS_CONFIG_REQ */
typedef struct
{
    LOCAL_PARA_HDR
    kal_bool is_icon_display;  // inform L4 if AP shows icon or not (AT+STKSS=0 or 4)
} ssds_l4c_stkss_config_req_struct;

/* MSG_ID_SSDS_L4C_STKSS_CONFIG_CNF */
typedef struct
{
    LOCAL_PARA_HDR

    // Peer Buffer: ss number, raw data in binary
} ssds_l4c_stkss_config_cnf_struct;

/* MSG_ID_SSDS_L4C_STKSS_RES */
typedef struct
{
    LOCAL_PARA_HDR
    kal_bool is_successful;
    kal_bool need_retry_cs;
    sat_terminal_res_enum      tr_cause;
    sat_additional_info_for_res_enum  additional_cause;

    // Peer Buffer: response data, raw data in binary(not valid now)
} ssds_l4c_stkss_res_struct;

/* MSG_ID_SSDS_L4C_STKSS_CS_REQ */
typedef struct
{
    LOCAL_PARA_HDR
} ssds_l4c_stkss_cs_req_struct;

#endif