blob: 343ae02528cbdf1b5fa167a9b51721b83d7d9cee [file] [log] [blame]
/*****************************************************************************
* 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).
*
*****************************************************************************/
/*******************************************************************************
*==============================================================================
* 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!
*------------------------------------------------------------------------------
* Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
*==============================================================================
*******************************************************************************/
#ifndef _IMCSMS_IMSUA_STRUCT_H
#define _IMCSMS_IMSUA_STRUCT_H
#include "kal_public_defs.h"
#include "kal_general_types.h"
#include "ims_common_def.h"
/*****imcsms_imsua_struct.h START*****/
typedef enum {
IMCSMS_DATA_TYPE_3GPP = 0,
IMCSMS_DATA_TYPE_MS_NW_RP_DATA = IMCSMS_DATA_TYPE_3GPP,
IMCSMS_DATA_TYPE_NW_MS_RP_DATA,
IMCSMS_DATA_TYPE_MS_NW_RP_ACK,
IMCSMS_DATA_TYPE_NW_MS_RP_ACK,
IMCSMS_DATA_TYPE_MS_NW_RP_ERROR,
IMCSMS_DATA_TYPE_NW_MS_RP_ERROR,
IMCSMS_DATA_TYPE_MS_NW_RP_SMMA,
IMCSMS_DATA_TYPE_3GPP2,
IMCSMS_DATA_TYPE_C2K_SUBMIT = IMCSMS_DATA_TYPE_3GPP2, // C2K SMS triggered by AP (AT+C2KCMGS)
IMCSMS_DATA_TYPE_C2K_ACKNOWLEDGE,
IMCSMS_DATA_TYPE_CDMA_SUBMIT // C2K SMS triggered by MD3 (SDM_VAL_C2K_IND)
}imcsms_sms_data_type_enum;
typedef enum {
IMCSMS_SMS_3GPP = 0,
IMCSMS_SMS_3GPP2,
IMCSMS_SMS_Text,
}imcsms_sms_content_type_enum;
typedef enum {
IMCSMS_SMS_CATEGORY_NORMAL = 0,
IMCSMS_SMS_CATEGORY_EMERGENCY,
}imcsms_sms_category_enum;
/*
* Description
* - the primitive is used to send SMS RPDU(RP-DATA/RP-ACK/RP-ERROR) to network through IMS domain
* Direction
* - SMS sub-module(IMCSMS) --> IMSUA
*/
typedef struct {
LOCAL_PARA_HDR
kal_uint8 account_id; // normal SMS or emergency SMS
kal_uint16 request_id;
kal_uint8 cb_id;
imcsms_sms_content_type_enum sms_type; // 3GPP_SMS or 3GPP2_SMS
imcsms_sms_data_type_enum data_type;
kal_bool is_da_valid; /*To specify that the TP-DA has valid content*/
kal_bool is_international;/* to specify the type of number is International or Not*/
/* spec 23.040 9.1.2.5 mentions the MAX size of TP-DA(Address length(1) + Type-of-address(1) +
Address Value(max 10 bytes)) can be 12 bytes, and hence the actual address when converted to
string will take 21 bytes including '\0'*/
kal_uint8 da[21];
kal_uint8 psi[128];
imcsms_sms_category_enum sms_category;
} imcsms_imsua_send_sms_req_struct;
/*
* Description
* - the primitive is used report SMS RPDU sending status
* Direction
* - SMS sub-module(IMCSMS) <-- IMSUA
*/
typedef struct {
LOCAL_PARA_HDR
kal_uint8 account_id;
kal_uint16 request_id;
imcsms_sms_content_type_enum sms_type; // 3GPP_SMS or 3GPP2_SMS
imcsms_sms_data_type_enum data_type;
kal_bool result;
kal_uint8 cause; // mapping to response code
} imcsms_imsua_send_sms_cnf_struct;
/*
* Description
* - the primitive is used notify IMCSMS the received RPDU(RP-DATA/RP-ACK/RP-ERROR)
* Direction
* - SMS sub-module(IMCSMS) <-- IMSUA
*/
typedef struct {
LOCAL_PARA_HDR
kal_uint8 account_id;
kal_uint16 request_id;
kal_uint8 cb_id;
imcsms_sms_content_type_enum sms_type; // 3GPP_SMS or 3GPP2_SMS
kal_uint8 psi[128];
} imcsms_imsua_recv_sms_ind_struct;
/*
* Description
* - the primitive is used to notify UA the received RPDU type and status
* Direction
* - SMS sub-module(IMCSMS) --> IMSUA
*/
typedef struct {
LOCAL_PARA_HDR
kal_uint8 account_id;
kal_uint16 request_id;
kal_uint8 cb_id;
kal_uint8 result;
} imcsms_imsua_recv_sms_rsp_struct;
/*
* Description
* - the primitive is used to notify UA the SMS FSM is complete and UA is able to clean related callback data
* Direction
* - SMS sub-module(IMCSMS) --> IMSUA
*/
typedef struct {
LOCAL_PARA_HDR
kal_uint8 account_id;
kal_uint16 request_id;
kal_uint8 cb_id;
} imcsms_imsua_rel_sms_req_struct;
/*
* Description
* - the primitive is used report SMS sub-module the error of IMS domain
* Direction
* - SMS sub-module(IMCSMS) <-- IMSUA
*/
typedef struct {
LOCAL_PARA_HDR
kal_uint8 account_id;
kal_uint16 request_id;
kal_uint8 cause;
kal_bool result;
} imcsms_imsua_recv_sms_error_ind_struct;
/*
* Description
* - the primitive is used to query CS availability
* Direction
* - SMS sub-module(IMCSMS) <-- IMSUA
*/
typedef struct {
LOCAL_PARA_HDR
kal_uint8 account_id;
kal_uint16 request_id;
} imcsms_imsua_cs_availability_ind_struct;
/*
* Description
* - the primitive is used to notify UA the CS availability query result
* Direction
* - SMS sub-module(IMCSMS) --> IMSUA
*/
typedef struct {
LOCAL_PARA_HDR
kal_uint8 account_id;
kal_uint16 request_id;
kal_bool result;
} imcsms_imsua_cs_availability_cnf_struct;
/*****imcsms_ua_struct.h END*****/
#endif /* _IMCSMS_IMSUA_STRUCT_H */