Gitiles
Code Review Sign In
192.168.1.100 / T800_MD / 6c1fd8fba87d5723e0e5614ae30b4258b603cb70 / . / mcu / protocol / interface / ims / imcsms_imsua_struct.h
blob: d955f2d77c0d028dceec6a2f7e78d33942acbb7d [file] [log] [blame]
rjw6c1fd8f2022-11-30 14:33:01 +0800[diff] [blame^]1/*****************************************************************************
2* Copyright Statement:
3* --------------------
4* This software is protected by Copyright and the information contained
5* herein is confidential. The software may not be copied and the information
6* contained herein may not be used or disclosed except with the written
7* permission of MediaTek Inc. (C) 2005
8*
9* BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
10* THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
11* RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
12* AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
13* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
14* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
15* NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
16* SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
17* SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
18* THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
19* NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
20* SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
21*
22* BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
23* LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
24* AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
25* OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
26* MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
27*
28* THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
29* WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
30* LAWS PRINCIPLES. ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
31* RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
32* THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
33*
34*****************************************************************************/
35/*******************************************************************************
36*==============================================================================
37* HISTORY
38* Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
39*------------------------------------------------------------------------------
40 * removed!
41*
42 * removed!
43 * removed!
44 * removed!
45*
46 * removed!
47 * removed!
48 * removed!
49*
50 * removed!
51 * removed!
52 * removed!
53*
54 * removed!
55 * removed!
56 * removed!
57*
58 * removed!
59 * removed!
60 * removed!
61*
62 * removed!
63 * removed!
64 * removed!
65 * removed!
66*
67 * removed!
68 * removed!
69 * removed!
70
71*------------------------------------------------------------------------------
72* Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
73*==============================================================================
74*******************************************************************************/
75#ifndef _IMCSMS_IMSUA_STRUCT_H
76#define _IMCSMS_IMSUA_STRUCT_H
77
78#include "kal_public_defs.h"
79#include "kal_general_types.h"
80#include "ims_common_def.h"
81
82/*****imcsms_imsua_struct.h START*****/
83typedef enum {
84 IMCSMS_DATA_TYPE_3GPP = 0,
85 IMCSMS_DATA_TYPE_MS_NW_RP_DATA = IMCSMS_DATA_TYPE_3GPP,
86 IMCSMS_DATA_TYPE_NW_MS_RP_DATA,
87 IMCSMS_DATA_TYPE_MS_NW_RP_ACK,
88 IMCSMS_DATA_TYPE_NW_MS_RP_ACK,
89 IMCSMS_DATA_TYPE_MS_NW_RP_ERROR,
90 IMCSMS_DATA_TYPE_NW_MS_RP_ERROR,
91 IMCSMS_DATA_TYPE_MS_NW_RP_SMMA,
92 IMCSMS_DATA_TYPE_3GPP2,
93 IMCSMS_DATA_TYPE_C2K_SUBMIT = IMCSMS_DATA_TYPE_3GPP2, // C2K SMS triggered by AP (AT+C2KCMGS)
94 IMCSMS_DATA_TYPE_C2K_ACKNOWLEDGE,
95 IMCSMS_DATA_TYPE_CDMA_SUBMIT // C2K SMS triggered by MD3 (SDM_VAL_C2K_IND)
96}imcsms_sms_data_type_enum;
97
98typedef enum {
99 IMCSMS_SMS_3GPP = 0,
100 IMCSMS_SMS_3GPP2,
101 IMCSMS_SMS_Text,
102}imcsms_sms_content_type_enum;
103
104typedef enum {
105 IMCSMS_SMS_CATEGORY_NORMAL = 0,
106 IMCSMS_SMS_CATEGORY_EMERGENCY,
107}imcsms_sms_category_enum;
108
109/*
110 * Description
111 * - the primitive is used to send SMS RPDU(RP-DATA/RP-ACK/RP-ERROR) to network through IMS domain
112 * Direction
113 * - SMS sub-module(IMCSMS) --> IMSUA
114 */
115typedef struct {
116 LOCAL_PARA_HDR
117 kal_uint8 account_id; // normal SMS or emergency SMS
118 kal_uint8 request_id;
119 kal_uint8 cb_id;
120 imcsms_sms_content_type_enum sms_type; // 3GPP_SMS or 3GPP2_SMS
121 imcsms_sms_data_type_enum data_type;
122 kal_bool is_da_valid; /*To specify that the TP-DA has valid content*/
123 kal_bool is_international;/* to specify the type of number is International or Not*/
124 /* spec 23.040 9.1.2.5 mentions the MAX size of TP-DA(Address length(1) + Type-of-address(1) +
125 Address Value(max 10 bytes)) can be 12 bytes, and hence the actual address when converted to
126 string will take 21 bytes including '\0'*/
127 kal_uint8 da[21];
128 kal_uint8 psi[128];
129 imcsms_sms_category_enum sms_category;
130} imcsms_imsua_send_sms_req_struct;
131
132/*
133 * Description
134 * - the primitive is used report SMS RPDU sending status
135 * Direction
136 * - SMS sub-module(IMCSMS) <-- IMSUA
137 */
138typedef struct {
139 LOCAL_PARA_HDR
140 kal_uint8 account_id;
141 kal_uint8 request_id;
142 imcsms_sms_content_type_enum sms_type; // 3GPP_SMS or 3GPP2_SMS
143 imcsms_sms_data_type_enum data_type;
144 kal_bool result;
145 kal_uint8 cause; // mapping to response code
146} imcsms_imsua_send_sms_cnf_struct;
147
148/*
149 * Description
150 * - the primitive is used notify IMCSMS the received RPDU(RP-DATA/RP-ACK/RP-ERROR)
151 * Direction
152 * - SMS sub-module(IMCSMS) <-- IMSUA
153 */
154typedef struct {
155 LOCAL_PARA_HDR
156 kal_uint8 account_id;
157 kal_uint8 request_id;
158 kal_uint8 cb_id;
159 imcsms_sms_content_type_enum sms_type; // 3GPP_SMS or 3GPP2_SMS
160 kal_uint8 psi[128];
161} imcsms_imsua_recv_sms_ind_struct;
162
163/*
164 * Description
165 * - the primitive is used to notify UA the received RPDU type and status
166 * Direction
167 * - SMS sub-module(IMCSMS) --> IMSUA
168 */
169typedef struct {
170 LOCAL_PARA_HDR
171 kal_uint8 account_id;
172 kal_uint8 request_id;
173 kal_uint8 cb_id;
174 kal_uint8 result;
175} imcsms_imsua_recv_sms_rsp_struct;
176
177/*
178 * Description
179 * - the primitive is used to notify UA the SMS FSM is complete and UA is able to clean related callback data
180 * Direction
181 * - SMS sub-module(IMCSMS) --> IMSUA
182 */
183typedef struct {
184 LOCAL_PARA_HDR
185 kal_uint8 account_id;
186 kal_uint8 request_id;
187 kal_uint8 cb_id;
188} imcsms_imsua_rel_sms_req_struct;
189
190
191/*
192 * Description
193 * - the primitive is used report SMS sub-module the error of IMS domain
194 * Direction
195 * - SMS sub-module(IMCSMS) <-- IMSUA
196 */
197typedef struct {
198 LOCAL_PARA_HDR
199 kal_uint8 account_id;
200 kal_uint8 request_id;
201 kal_uint8 cause;
202 kal_bool result;
203} imcsms_imsua_recv_sms_error_ind_struct;
204
205/*
206 * Description
207 * - the primitive is used to query CS availability
208 * Direction
209 * - SMS sub-module(IMCSMS) <-- IMSUA
210 */
211typedef struct {
212 LOCAL_PARA_HDR
213 kal_uint8 account_id;
214 kal_uint8 request_id;
215} imcsms_imsua_cs_availability_ind_struct;
216
217/*
218 * Description
219 * - the primitive is used to notify UA the CS availability query result
220 * Direction
221 * - SMS sub-module(IMCSMS) --> IMSUA
222 */
223typedef struct {
224 LOCAL_PARA_HDR
225 kal_uint8 account_id;
226 kal_uint8 request_id;
227 kal_bool result;
228} imcsms_imsua_cs_availability_cnf_struct;
229
230/*****imcsms_ua_struct.h END*****/
231
232
233#endif /* _IMCSMS_IMSUA_STRUCT_H */
234
235