ril.h revision d86799a04478e46b49cdf1f82f98b2279be1645c
1/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 /* ISSUES:
18 * - SMS retransmit (specifying TP-Message-ID)
19 *
20 */
21
22/**
23 * TODO
24 *
25 * Supp Service Notification (+CSSN)
26 * GPRS PDP context deactivate notification
27 *
28 */
29
30
31#ifndef ANDROID_RIL_H
32#define ANDROID_RIL_H 1
33
34#include <stdlib.h>
35#ifndef FEATURE_UNIT_TEST
36#include <sys/time.h>
37#endif /* !FEATURE_UNIT_TEST */
38
39#ifdef __cplusplus
40extern "C" {
41#endif
42
43#define RIL_VERSION 4
44
45#define CDMA_ALPHA_INFO_BUFFER_LENGTH 64
46#define CDMA_NUMBER_INFO_BUFFER_LENGTH 81
47
48typedef void * RIL_Token;
49
50typedef enum {
51    RIL_E_SUCCESS = 0,
52    RIL_E_RADIO_NOT_AVAILABLE = 1,     /* If radio did not start or is resetting */
53    RIL_E_GENERIC_FAILURE = 2,
54    RIL_E_PASSWORD_INCORRECT = 3,      /* for PIN/PIN2 methods only! */
55    RIL_E_SIM_PIN2 = 4,                /* Operation requires SIM PIN2 to be entered */
56    RIL_E_SIM_PUK2 = 5,                /* Operation requires SIM PIN2 to be entered */
57    RIL_E_REQUEST_NOT_SUPPORTED = 6,
58    RIL_E_CANCELLED = 7,
59    RIL_E_OP_NOT_ALLOWED_DURING_VOICE_CALL = 8, /* data ops are not allowed during voice
60                                                   call on a Class C GPRS device */
61    RIL_E_OP_NOT_ALLOWED_BEFORE_REG_TO_NW = 9,  /* data ops are not allowed before device
62                                                   registers in network */
63    RIL_E_SMS_SEND_FAIL_RETRY = 10,             /* fail to send sms and need retry */
64    RIL_E_SIM_ABSENT = 11,                      /* fail to set the location where CDMA subscription
65                                                   shall be retrieved because of SIM or RUIM
66                                                   card absent */
67    RIL_E_SUBSCRIPTION_NOT_AVAILABLE = 12,      /* fail to find CDMA subscription from specified
68                                                   location */
69    RIL_E_MODE_NOT_SUPPORTED = 13,              /* HW does not support preferred network type */
70    RIL_E_FDN_CHECK_FAILURE = 14,               /* command failed because recipient is not on FDN list */
71    RIL_E_ILLEGAL_SIM_OR_ME = 15                /* network selection failed due to
72                                                   illegal SIM or ME */
73} RIL_Errno;
74
75typedef enum {
76    RIL_CALL_ACTIVE = 0,
77    RIL_CALL_HOLDING = 1,
78    RIL_CALL_DIALING = 2,    /* MO call only */
79    RIL_CALL_ALERTING = 3,   /* MO call only */
80    RIL_CALL_INCOMING = 4,   /* MT call only */
81    RIL_CALL_WAITING = 5     /* MT call only */
82} RIL_CallState;
83
84typedef enum {
85    RADIO_STATE_OFF = 0,                   /* Radio explictly powered off (eg CFUN=0) */
86    RADIO_STATE_UNAVAILABLE = 1,           /* Radio unavailable (eg, resetting or not booted) */
87    RADIO_STATE_SIM_NOT_READY = 2,         /* Radio is on, but the SIM interface is not ready */
88    RADIO_STATE_SIM_LOCKED_OR_ABSENT = 3,  /* SIM PIN locked, PUK required, network
89                                              personalization locked, or SIM absent */
90    RADIO_STATE_SIM_READY = 4,             /* Radio is on and SIM interface is available */
91    RADIO_STATE_RUIM_NOT_READY = 5,        /* Radio is on, but the RUIM interface is not ready */
92    RADIO_STATE_RUIM_READY = 6,            /* Radio is on and the RUIM interface is available */
93    RADIO_STATE_RUIM_LOCKED_OR_ABSENT = 7, /* RUIM PIN locked, PUK required, network
94                                              personalization locked, or RUIM absent */
95    RADIO_STATE_NV_NOT_READY = 8,          /* Radio is on, but the NV interface is not available */
96    RADIO_STATE_NV_READY = 9               /* Radio is on and the NV interface is available */
97} RIL_RadioState;
98
99/* User-to-User signaling Info activation types derived from 3GPP 23.087 v8.0 */
100typedef enum {
101    RIL_UUS_TYPE1_IMPLICIT = 0,
102    RIL_UUS_TYPE1_REQUIRED = 1,
103    RIL_UUS_TYPE1_NOT_REQUIRED = 2,
104    RIL_UUS_TYPE2_REQUIRED = 3,
105    RIL_UUS_TYPE2_NOT_REQUIRED = 4,
106    RIL_UUS_TYPE3_REQUIRED = 5,
107    RIL_UUS_TYPE3_NOT_REQUIRED = 6
108} RIL_UUS_Type;
109
110/* User-to-User Signaling Information data coding schemes. Possible values for
111 * Octet 3 (Protocol Discriminator field) in the UUIE. The values have been
112 * specified in section 10.5.4.25 of 3GPP TS 24.008 */
113typedef enum {
114    RIL_UUS_DCS_USP = 0,          /* User specified protocol */
115    RIL_UUS_DCS_OSIHLP = 1,       /* OSI higher layer protocol */
116    RIL_UUS_DCS_X244 = 2,         /* X.244 */
117    RIL_UUS_DCS_RMCF = 3,         /* Reserved for system mangement
118                                     convergence function */
119    RIL_UUS_DCS_IA5c = 4          /* IA5 characters */
120} RIL_UUS_DCS;
121
122/* User-to-User Signaling Information defined in 3GPP 23.087 v8.0
123 * This data is passed in RIL_ExtensionRecord and rec contains this
124 * structure when type is RIL_UUS_INFO_EXT_REC */
125typedef struct {
126  RIL_UUS_Type    uusType;    /* UUS Type */
127  RIL_UUS_DCS     uusDcs;     /* UUS Data Coding Scheme */
128  int             uusLength;  /* Length of UUS Data */
129  char *          uusData;    /* UUS Data */
130} RIL_UUS_Info;
131
132/* CDMA Signal Information Record as defined in C.S0005 section 3.7.5.5 */
133typedef struct {
134  char isPresent;    /* non-zero if signal information record is present */
135  char signalType;   /* as defined 3.7.5.5-1 */
136  char alertPitch;   /* as defined 3.7.5.5-2 */
137  char signal;       /* as defined 3.7.5.5-3, 3.7.5.5-4 or 3.7.5.5-5 */
138} RIL_CDMA_SignalInfoRecord;
139
140typedef struct {
141    RIL_CallState   state;
142    int             index;      /* Connection Index for use with, eg, AT+CHLD */
143    int             toa;        /* type of address, eg 145 = intl */
144    char            isMpty;     /* nonzero if is mpty call */
145    char            isMT;       /* nonzero if call is mobile terminated */
146    char            als;        /* ALS line indicator if available
147                                   (0 = line 1) */
148    char            isVoice;    /* nonzero if this is is a voice call */
149    char            isVoicePrivacy;     /* nonzero if CDMA voice privacy mode is active */
150    char *          number;     /* Remote party number */
151    int             numberPresentation; /* 0=Allowed, 1=Restricted, 2=Not Specified/Unknown 3=Payphone */
152    char *          name;       /* Remote party name */
153    int             namePresentation; /* 0=Allowed, 1=Restricted, 2=Not Specified/Unknown 3=Payphone */
154    RIL_UUS_Info *  uusInfo;    /* NULL or Pointer to User-User Signaling Information */
155} RIL_Call;
156
157typedef struct {
158    int             cid;        /* Context ID */
159    int             active;     /* 0=inactive, 1=active/physical link down, 2=active/physical link up */
160    char *          type;       /* One of the PDP_type values in TS 27.007 section 10.1.1.
161                                   For example, "IP", "IPV6", "IPV4V6", or "PPP". */
162    char *          apn;
163    char *          address;    /* A space-delimited list of addresses, e.g., "192.0.1.3" or
164                                   "192.0.1.11 2001:db8::1". */
165} RIL_Data_Call_Response;
166
167typedef struct {
168    int messageRef;   /* TP-Message-Reference for GSM,
169                         and BearerData MessageId for CDMA
170                         (See 3GPP2 C.S0015-B, v2.0, table 4.5-1). */
171    char *ackPDU;     /* or NULL if n/a */
172    int errorCode;    /* See 3GPP 27.005, 3.2.5 for GSM/UMTS,
173                         3GPP2 N.S0005 (IS-41C) Table 171 for CDMA,
174                         -1 if unknown or not applicable*/
175} RIL_SMS_Response;
176
177/** Used by RIL_REQUEST_WRITE_SMS_TO_SIM */
178typedef struct {
179    int status;     /* Status of message.  See TS 27.005 3.1, "<stat>": */
180                    /*      0 = "REC UNREAD"    */
181                    /*      1 = "REC READ"      */
182                    /*      2 = "STO UNSENT"    */
183                    /*      3 = "STO SENT"      */
184    char * pdu;     /* PDU of message to write, as an ASCII hex string less the SMSC address,
185                       the TP-layer length is "strlen(pdu)/2". */
186    char * smsc;    /* SMSC address in GSM BCD format prefixed by a length byte
187                       (as expected by TS 27.005) or NULL for default SMSC */
188} RIL_SMS_WriteArgs;
189
190/** Used by RIL_REQUEST_DIAL */
191typedef struct {
192    char * address;
193    int clir;
194            /* (same as 'n' paremeter in TS 27.007 7.7 "+CLIR"
195             * clir == 0 on "use subscription default value"
196             * clir == 1 on "CLIR invocation" (restrict CLI presentation)
197             * clir == 2 on "CLIR suppression" (allow CLI presentation)
198             */
199    RIL_UUS_Info *  uusInfo;    /* NULL or Pointer to User-User Signaling Information */
200} RIL_Dial;
201
202typedef struct {
203    int command;    /* one of the commands listed for TS 27.007 +CRSM*/
204    int fileid;     /* EF id */
205    char *path;     /* "pathid" from TS 27.007 +CRSM command.
206                       Path is in hex asciii format eg "7f205f70"
207                       Path must always be provided.
208                     */
209    int p1;
210    int p2;
211    int p3;
212    char *data;     /* May be NULL*/
213    char *pin2;     /* May be NULL*/
214} RIL_SIM_IO;
215
216typedef struct {
217    int sw1;
218    int sw2;
219    char *simResponse;  /* In hex string format ([a-fA-F0-9]*). */
220} RIL_SIM_IO_Response;
221
222/* See also com.android.internal.telephony.gsm.CallForwardInfo */
223
224typedef struct {
225    int             status;     /*
226                                 * For RIL_REQUEST_QUERY_CALL_FORWARD_STATUS
227                                 * status 1 = active, 0 = not active
228                                 *
229                                 * For RIL_REQUEST_SET_CALL_FORWARD:
230                                 * status is:
231                                 * 0 = disable
232                                 * 1 = enable
233                                 * 2 = interrogate
234                                 * 3 = registeration
235                                 * 4 = erasure
236                                 */
237
238    int             reason;      /* from TS 27.007 7.11 "reason" */
239    int             serviceClass;/* From 27.007 +CCFC/+CLCK "class"
240                                    See table for Android mapping from
241                                    MMI service code
242                                    0 means user doesn't input class */
243    int             toa;         /* "type" from TS 27.007 7.11 */
244    char *          number;      /* "number" from TS 27.007 7.11. May be NULL */
245    int             timeSeconds; /* for CF no reply only */
246}RIL_CallForwardInfo;
247
248typedef struct {
249   char * cid;         /* Combination of LAC and Cell Id in 32 bits in GSM.
250                        * Upper 16 bits is LAC and lower 16 bits
251                        * is CID (as described in TS 27.005)
252                        * Primary Scrambling Code (as described in TS 25.331)
253                        *         in 9 bits in UMTS
254                        * Valid values are hexadecimal 0x0000 - 0xffffffff.
255                        */
256   int    rssi;        /* Received RSSI in GSM,
257                        * Level index of CPICH Received Signal Code Power in UMTS
258                        */
259} RIL_NeighboringCell;
260
261/* See RIL_REQUEST_LAST_CALL_FAIL_CAUSE */
262typedef enum {
263    CALL_FAIL_UNOBTAINABLE_NUMBER = 1,
264    CALL_FAIL_NORMAL = 16,
265    CALL_FAIL_BUSY = 17,
266    CALL_FAIL_CONGESTION = 34,
267    CALL_FAIL_ACM_LIMIT_EXCEEDED = 68,
268    CALL_FAIL_CALL_BARRED = 240,
269    CALL_FAIL_FDN_BLOCKED = 241,
270    CALL_FAIL_IMSI_UNKNOWN_IN_VLR = 242,
271    CALL_FAIL_IMEI_NOT_ACCEPTED = 243,
272    CALL_FAIL_CDMA_LOCKED_UNTIL_POWER_CYCLE = 1000,
273    CALL_FAIL_CDMA_DROP = 1001,
274    CALL_FAIL_CDMA_INTERCEPT = 1002,
275    CALL_FAIL_CDMA_REORDER = 1003,
276    CALL_FAIL_CDMA_SO_REJECT = 1004,
277    CALL_FAIL_CDMA_RETRY_ORDER = 1005,
278    CALL_FAIL_CDMA_ACCESS_FAILURE = 1006,
279    CALL_FAIL_CDMA_PREEMPTED = 1007,
280    CALL_FAIL_CDMA_NOT_EMERGENCY = 1008, /* For non-emergency number dialed
281                                            during emergency callback mode */
282    CALL_FAIL_CDMA_ACCESS_BLOCKED = 1009, /* CDMA network access probes blocked */
283    CALL_FAIL_ERROR_UNSPECIFIED = 0xffff
284} RIL_LastCallFailCause;
285
286/* See RIL_REQUEST_LAST_DATA_CALL_FAIL_CAUSE */
287typedef enum {
288    PDP_FAIL_OPERATOR_BARRED = 0x08,               /* no retry */
289    PDP_FAIL_INSUFFICIENT_RESOURCES = 0x1A,
290    PDP_FAIL_MISSING_UKNOWN_APN = 0x1B,            /* no retry */
291    PDP_FAIL_UNKNOWN_PDP_ADDRESS_TYPE = 0x1C,      /* no retry */
292    PDP_FAIL_USER_AUTHENTICATION = 0x1D,           /* no retry */
293    PDP_FAIL_ACTIVATION_REJECT_GGSN = 0x1E,        /* no retry */
294    PDP_FAIL_ACTIVATION_REJECT_UNSPECIFIED = 0x1F,
295    PDP_FAIL_SERVICE_OPTION_NOT_SUPPORTED = 0x20,  /* no retry */
296    PDP_FAIL_SERVICE_OPTION_NOT_SUBSCRIBED = 0x21, /* no retry */
297    PDP_FAIL_SERVICE_OPTION_OUT_OF_ORDER = 0x22,
298    PDP_FAIL_NSAPI_IN_USE      = 0x23,             /* no retry */
299    PDP_FAIL_PROTOCOL_ERRORS   = 0x6F,             /* no retry */
300    PDP_FAIL_ERROR_UNSPECIFIED = 0xffff,  /* This and all other cases: retry silently */
301    /* Not mentioned in the specification */
302    PDP_FAIL_REGISTRATION_FAIL = -1,
303    PDP_FAIL_GPRS_REGISTRATION_FAIL = -2,
304} RIL_LastDataCallActivateFailCause;
305
306/* See RIL_REQUEST_SETUP_DATA_CALL */
307typedef enum {
308    RIL_DATA_PROFILE_DEFAULT    = 0,
309    RIL_DATA_PROFILE_TETHERED   = 1,
310    RIL_DATA_PROFILE_OEM_BASE   = 1000    /* Start of OEM-specific profiles */
311} RIL_DataProfile;
312
313/* Used by RIL_UNSOL_SUPP_SVC_NOTIFICATION */
314typedef struct {
315    int     notificationType;   /*
316                                 * 0 = MO intermediate result code
317                                 * 1 = MT unsolicited result code
318                                 */
319    int     code;               /* See 27.007 7.17
320                                   "code1" for MO
321                                   "code2" for MT. */
322    int     index;              /* CUG index. See 27.007 7.17. */
323    int     type;               /* "type" from 27.007 7.17 (MT only). */
324    char *  number;             /* "number" from 27.007 7.17
325                                   (MT only, may be NULL). */
326} RIL_SuppSvcNotification;
327
328#define RIL_CARD_MAX_APPS     8
329
330typedef enum {
331    RIL_CARDSTATE_ABSENT   = 0,
332    RIL_CARDSTATE_PRESENT  = 1,
333    RIL_CARDSTATE_ERROR    = 2
334} RIL_CardState;
335
336typedef enum {
337    RIL_PERSOSUBSTATE_UNKNOWN                   = 0, /* initial state */
338    RIL_PERSOSUBSTATE_IN_PROGRESS               = 1, /* in between each lock transition */
339    RIL_PERSOSUBSTATE_READY                     = 2, /* when either SIM or RUIM Perso is finished
340                                                        since each app can only have 1 active perso
341                                                        involved */
342    RIL_PERSOSUBSTATE_SIM_NETWORK               = 3,
343    RIL_PERSOSUBSTATE_SIM_NETWORK_SUBSET        = 4,
344    RIL_PERSOSUBSTATE_SIM_CORPORATE             = 5,
345    RIL_PERSOSUBSTATE_SIM_SERVICE_PROVIDER      = 6,
346    RIL_PERSOSUBSTATE_SIM_SIM                   = 7,
347    RIL_PERSOSUBSTATE_SIM_NETWORK_PUK           = 8, /* The corresponding perso lock is blocked */
348    RIL_PERSOSUBSTATE_SIM_NETWORK_SUBSET_PUK    = 9,
349    RIL_PERSOSUBSTATE_SIM_CORPORATE_PUK         = 10,
350    RIL_PERSOSUBSTATE_SIM_SERVICE_PROVIDER_PUK  = 11,
351    RIL_PERSOSUBSTATE_SIM_SIM_PUK               = 12,
352    RIL_PERSOSUBSTATE_RUIM_NETWORK1             = 13,
353    RIL_PERSOSUBSTATE_RUIM_NETWORK2             = 14,
354    RIL_PERSOSUBSTATE_RUIM_HRPD                 = 15,
355    RIL_PERSOSUBSTATE_RUIM_CORPORATE            = 16,
356    RIL_PERSOSUBSTATE_RUIM_SERVICE_PROVIDER     = 17,
357    RIL_PERSOSUBSTATE_RUIM_RUIM                 = 18,
358    RIL_PERSOSUBSTATE_RUIM_NETWORK1_PUK         = 19, /* The corresponding perso lock is blocked */
359    RIL_PERSOSUBSTATE_RUIM_NETWORK2_PUK         = 20,
360    RIL_PERSOSUBSTATE_RUIM_HRPD_PUK             = 21,
361    RIL_PERSOSUBSTATE_RUIM_CORPORATE_PUK        = 22,
362    RIL_PERSOSUBSTATE_RUIM_SERVICE_PROVIDER_PUK = 23,
363    RIL_PERSOSUBSTATE_RUIM_RUIM_PUK             = 24
364} RIL_PersoSubstate;
365
366typedef enum {
367    RIL_APPSTATE_UNKNOWN               = 0,
368    RIL_APPSTATE_DETECTED              = 1,
369    RIL_APPSTATE_PIN                   = 2, /* If PIN1 or UPin is required */
370    RIL_APPSTATE_PUK                   = 3, /* If PUK1 or Puk for UPin is required */
371    RIL_APPSTATE_SUBSCRIPTION_PERSO    = 4, /* perso_substate should be look at
372                                               when app_state is assigned to this value */
373    RIL_APPSTATE_READY                 = 5
374} RIL_AppState;
375
376typedef enum {
377    RIL_PINSTATE_UNKNOWN              = 0,
378    RIL_PINSTATE_ENABLED_NOT_VERIFIED = 1,
379    RIL_PINSTATE_ENABLED_VERIFIED     = 2,
380    RIL_PINSTATE_DISABLED             = 3,
381    RIL_PINSTATE_ENABLED_BLOCKED      = 4,
382    RIL_PINSTATE_ENABLED_PERM_BLOCKED = 5
383} RIL_PinState;
384
385typedef enum {
386  RIL_APPTYPE_UNKNOWN = 0,
387  RIL_APPTYPE_SIM     = 1,
388  RIL_APPTYPE_USIM    = 2,
389  RIL_APPTYPE_RUIM    = 3,
390  RIL_APPTYPE_CSIM    = 4
391} RIL_AppType;
392
393typedef struct
394{
395  RIL_AppType      app_type;
396  RIL_AppState     app_state;
397  RIL_PersoSubstate perso_substate; /* applicable only if app_state ==
398                                       RIL_APPSTATE_SUBSCRIPTION_PERSO */
399  char             *aid_ptr;        /* null terminated string, e.g., from 0xA0, 0x00 -> 0x41,
400                                       0x30, 0x30, 0x30 */
401  char             *app_label_ptr;  /* null terminated string */
402  int              pin1_replaced;   /* applicable to USIM and CSIM */
403  RIL_PinState     pin1;
404  RIL_PinState     pin2;
405} RIL_AppStatus;
406
407typedef struct
408{
409  RIL_CardState card_state;
410  RIL_PinState  universal_pin_state;             /* applicable to USIM and CSIM: RIL_PINSTATE_xxx */
411  int           gsm_umts_subscription_app_index; /* value < RIL_CARD_MAX_APPS */
412  int           cdma_subscription_app_index;     /* value < RIL_CARD_MAX_APPS */
413  int           num_applications;                /* value <= RIL_CARD_MAX_APPS */
414  RIL_AppStatus applications[RIL_CARD_MAX_APPS];
415} RIL_CardStatus;
416
417/* The result of a SIM refresh, returned in data[0] of RIL_UNSOL_SIM_REFRESH */
418typedef enum {
419    /* A file on SIM has been updated.  data[1] contains the EFID. */
420    SIM_FILE_UPDATE = 0,
421    /* SIM initialized.  All files should be re-read. */
422    SIM_INIT = 1,
423    /* SIM reset.  SIM power required, SIM may be locked and all files should be re-read. */
424    SIM_RESET = 2
425} RIL_SimRefreshResult;
426
427typedef struct {
428    char *          number;             /* Remote party number */
429    int             numberPresentation; /* 0=Allowed, 1=Restricted, 2=Not Specified/Unknown */
430    char *          name;               /* Remote party name */
431    RIL_CDMA_SignalInfoRecord signalInfoRecord;
432} RIL_CDMA_CallWaiting;
433
434/**
435 * Which types of Cell Broadcast Message (CBM) are to be received by the ME
436 *
437 * uFromServiceID - uToServiceID defines a range of CBM message identifiers
438 * whose value is 0x0000 - 0xFFFF as defined in TS 23.041 9.4.1.2.2 for GMS
439 * and 9.4.4.2.2 for UMTS. All other values can be treated as empty
440 * CBM message ID.
441 *
442 * uFromCodeScheme - uToCodeScheme defines a range of CBM data coding schemes
443 * whose value is 0x00 - 0xFF as defined in TS 23.041 9.4.1.2.3 for GMS
444 * and 9.4.4.2.3 for UMTS.
445 * All other values can be treated as empty CBM data coding scheme.
446 *
447 * selected 0 means message types specified in <fromServiceId, toServiceId>
448 * and <fromCodeScheme, toCodeScheme>are not accepted, while 1 means accepted.
449 *
450 * Used by RIL_REQUEST_GSM_GET_BROADCAST_CONFIG and
451 * RIL_REQUEST_GSM_SET_BROADCAST_CONFIG.
452 */
453typedef struct {
454    int fromServiceId;
455    int toServiceId;
456    int fromCodeScheme;
457    int toCodeScheme;
458    unsigned char selected;
459} RIL_GSM_BroadcastSmsConfigInfo;
460
461/* No restriction at all including voice/SMS/USSD/SS/AV64 and packet data. */
462#define RIL_RESTRICTED_STATE_NONE           0x00
463/* Block emergency call due to restriction. But allow all normal voice/SMS/USSD/SS/AV64. */
464#define RIL_RESTRICTED_STATE_CS_EMERGENCY   0x01
465/* Block all normal voice/SMS/USSD/SS/AV64 due to restriction. Only Emergency call allowed. */
466#define RIL_RESTRICTED_STATE_CS_NORMAL      0x02
467/* Block all voice/SMS/USSD/SS/AV64 including emergency call due to restriction.*/
468#define RIL_RESTRICTED_STATE_CS_ALL         0x04
469/* Block packet data access due to restriction. */
470#define RIL_RESTRICTED_STATE_PS_ALL         0x10
471
472/* The status for an OTASP/OTAPA session */
473typedef enum {
474    CDMA_OTA_PROVISION_STATUS_SPL_UNLOCKED,
475    CDMA_OTA_PROVISION_STATUS_SPC_RETRIES_EXCEEDED,
476    CDMA_OTA_PROVISION_STATUS_A_KEY_EXCHANGED,
477    CDMA_OTA_PROVISION_STATUS_SSD_UPDATED,
478    CDMA_OTA_PROVISION_STATUS_NAM_DOWNLOADED,
479    CDMA_OTA_PROVISION_STATUS_MDN_DOWNLOADED,
480    CDMA_OTA_PROVISION_STATUS_IMSI_DOWNLOADED,
481    CDMA_OTA_PROVISION_STATUS_PRL_DOWNLOADED,
482    CDMA_OTA_PROVISION_STATUS_COMMITTED,
483    CDMA_OTA_PROVISION_STATUS_OTAPA_STARTED,
484    CDMA_OTA_PROVISION_STATUS_OTAPA_STOPPED,
485    CDMA_OTA_PROVISION_STATUS_OTAPA_ABORTED
486} RIL_CDMA_OTA_ProvisionStatus;
487
488typedef struct {
489    int signalStrength;  /* Valid values are (0-31, 99) as defined in TS 27.007 8.5 */
490    int bitErrorRate;    /* bit error rate (0-7, 99) as defined in TS 27.007 8.5 */
491} RIL_GW_SignalStrength;
492
493
494typedef struct {
495    int dbm;  /* Valid values are positive integers.  This value is the actual RSSI value
496               * multiplied by -1.  Example: If the actual RSSI is -75, then this response
497               * value will be 75.
498               */
499    int ecio; /* Valid values are positive integers.  This value is the actual Ec/Io multiplied
500               * by -10.  Example: If the actual Ec/Io is -12.5 dB, then this response value
501               * will be 125.
502               */
503} RIL_CDMA_SignalStrength;
504
505
506typedef struct {
507    int dbm;  /* Valid values are positive integers.  This value is the actual RSSI value
508               * multiplied by -1.  Example: If the actual RSSI is -75, then this response
509               * value will be 75.
510               */
511    int ecio; /* Valid values are positive integers.  This value is the actual Ec/Io multiplied
512               * by -10.  Example: If the actual Ec/Io is -12.5 dB, then this response value
513               * will be 125.
514               */
515    int signalNoiseRatio; /* Valid values are 0-8.  8 is the highest signal to noise ratio. */
516} RIL_EVDO_SignalStrength;
517
518
519typedef struct {
520    RIL_GW_SignalStrength   GW_SignalStrength;
521    RIL_CDMA_SignalStrength CDMA_SignalStrength;
522    RIL_EVDO_SignalStrength EVDO_SignalStrength;
523} RIL_SignalStrength;
524
525/* Names of the CDMA info records (C.S0005 section 3.7.5) */
526typedef enum {
527  RIL_CDMA_DISPLAY_INFO_REC,
528  RIL_CDMA_CALLED_PARTY_NUMBER_INFO_REC,
529  RIL_CDMA_CALLING_PARTY_NUMBER_INFO_REC,
530  RIL_CDMA_CONNECTED_NUMBER_INFO_REC,
531  RIL_CDMA_SIGNAL_INFO_REC,
532  RIL_CDMA_REDIRECTING_NUMBER_INFO_REC,
533  RIL_CDMA_LINE_CONTROL_INFO_REC,
534  RIL_CDMA_EXTENDED_DISPLAY_INFO_REC,
535  RIL_CDMA_T53_CLIR_INFO_REC,
536  RIL_CDMA_T53_RELEASE_INFO_REC,
537  RIL_CDMA_T53_AUDIO_CONTROL_INFO_REC
538} RIL_CDMA_InfoRecName;
539
540/* Display Info Rec as defined in C.S0005 section 3.7.5.1
541   Extended Display Info Rec as defined in C.S0005 section 3.7.5.16
542   Note: the Extended Display info rec contains multiple records of the
543   form: display_tag, display_len, and display_len occurrences of the
544   chari field if the display_tag is not 10000000 or 10000001.
545   To save space, the records are stored consecutively in a byte buffer.
546   The display_tag, display_len and chari fields are all 1 byte.
547*/
548
549typedef struct {
550  char alpha_len;
551  char alpha_buf[CDMA_ALPHA_INFO_BUFFER_LENGTH];
552} RIL_CDMA_DisplayInfoRecord;
553
554/* Called Party Number Info Rec as defined in C.S0005 section 3.7.5.2
555   Calling Party Number Info Rec as defined in C.S0005 section 3.7.5.3
556   Connected Number Info Rec as defined in C.S0005 section 3.7.5.4
557*/
558
559typedef struct {
560  char len;
561  char buf[CDMA_NUMBER_INFO_BUFFER_LENGTH];
562  char number_type;
563  char number_plan;
564  char pi;
565  char si;
566} RIL_CDMA_NumberInfoRecord;
567
568/* Redirecting Number Information Record as defined in C.S0005 section 3.7.5.11 */
569typedef enum {
570  RIL_REDIRECTING_REASON_UNKNOWN = 0,
571  RIL_REDIRECTING_REASON_CALL_FORWARDING_BUSY = 1,
572  RIL_REDIRECTING_REASON_CALL_FORWARDING_NO_REPLY = 2,
573  RIL_REDIRECTING_REASON_CALLED_DTE_OUT_OF_ORDER = 9,
574  RIL_REDIRECTING_REASON_CALL_FORWARDING_BY_THE_CALLED_DTE = 10,
575  RIL_REDIRECTING_REASON_CALL_FORWARDING_UNCONDITIONAL = 15,
576  RIL_REDIRECTING_REASON_RESERVED
577} RIL_CDMA_RedirectingReason;
578
579typedef struct {
580  RIL_CDMA_NumberInfoRecord redirectingNumber;
581  /* redirectingReason is set to RIL_REDIRECTING_REASON_UNKNOWN if not included */
582  RIL_CDMA_RedirectingReason redirectingReason;
583} RIL_CDMA_RedirectingNumberInfoRecord;
584
585/* Line Control Information Record as defined in C.S0005 section 3.7.5.15 */
586typedef struct {
587  char lineCtrlPolarityIncluded;
588  char lineCtrlToggle;
589  char lineCtrlReverse;
590  char lineCtrlPowerDenial;
591} RIL_CDMA_LineControlInfoRecord;
592
593/* T53 CLIR Information Record */
594typedef struct {
595  char cause;
596} RIL_CDMA_T53_CLIRInfoRecord;
597
598/* T53 Audio Control Information Record */
599typedef struct {
600  char upLink;
601  char downLink;
602} RIL_CDMA_T53_AudioControlInfoRecord;
603
604typedef struct {
605
606  RIL_CDMA_InfoRecName name;
607
608  union {
609    /* Display and Extended Display Info Rec */
610    RIL_CDMA_DisplayInfoRecord           display;
611
612    /* Called Party Number, Calling Party Number, Connected Number Info Rec */
613    RIL_CDMA_NumberInfoRecord            number;
614
615    /* Signal Info Rec */
616    RIL_CDMA_SignalInfoRecord            signal;
617
618    /* Redirecting Number Info Rec */
619    RIL_CDMA_RedirectingNumberInfoRecord redir;
620
621    /* Line Control Info Rec */
622    RIL_CDMA_LineControlInfoRecord       lineCtrl;
623
624    /* T53 CLIR Info Rec */
625    RIL_CDMA_T53_CLIRInfoRecord          clir;
626
627    /* T53 Audio Control Info Rec */
628    RIL_CDMA_T53_AudioControlInfoRecord  audioCtrl;
629  } rec;
630} RIL_CDMA_InformationRecord;
631
632#define RIL_CDMA_MAX_NUMBER_OF_INFO_RECS 10
633
634typedef struct {
635  char numberOfInfoRecs;
636  RIL_CDMA_InformationRecord infoRec[RIL_CDMA_MAX_NUMBER_OF_INFO_RECS];
637} RIL_CDMA_InformationRecords;
638
639/**
640 * RIL_REQUEST_GET_SIM_STATUS
641 *
642 * Requests status of the SIM interface and the SIM card
643 *
644 * "data" is NULL
645 *
646 * "response" is const RIL_CardStatus *
647 *
648 * Valid errors:
649 *  Must never fail
650 */
651#define RIL_REQUEST_GET_SIM_STATUS 1
652
653/**
654 * RIL_REQUEST_ENTER_SIM_PIN
655 *
656 * Supplies SIM PIN. Only called if RIL_CardStatus has RIL_APPSTATE_PIN state
657 *
658 * "data" is const char **
659 * ((const char **)data)[0] is PIN value
660 *
661 * "response" is int *
662 * ((int *)response)[0] is the number of retries remaining, or -1 if unknown
663 *
664 * Valid errors:
665 *
666 * SUCCESS
667 * RADIO_NOT_AVAILABLE (radio resetting)
668 * GENERIC_FAILURE
669 * PASSWORD_INCORRECT
670 */
671
672#define RIL_REQUEST_ENTER_SIM_PIN 2
673
674
675/**
676 * RIL_REQUEST_ENTER_SIM_PUK
677 *
678 * Supplies SIM PUK and new PIN.
679 *
680 * "data" is const char **
681 * ((const char **)data)[0] is PUK value
682 * ((const char **)data)[1] is new PIN value
683 *
684 * "response" is int *
685 * ((int *)response)[0] is the number of retries remaining, or -1 if unknown
686 *
687 * Valid errors:
688 *
689 *  SUCCESS
690 *  RADIO_NOT_AVAILABLE (radio resetting)
691 *  GENERIC_FAILURE
692 *  PASSWORD_INCORRECT
693 *     (PUK is invalid)
694 */
695
696#define RIL_REQUEST_ENTER_SIM_PUK 3
697
698/**
699 * RIL_REQUEST_ENTER_SIM_PIN2
700 *
701 * Supplies SIM PIN2. Only called following operation where SIM_PIN2 was
702 * returned as a a failure from a previous operation.
703 *
704 * "data" is const char **
705 * ((const char **)data)[0] is PIN2 value
706 *
707 * "response" is int *
708 * ((int *)response)[0] is the number of retries remaining, or -1 if unknown
709 *
710 * Valid errors:
711 *
712 *  SUCCESS
713 *  RADIO_NOT_AVAILABLE (radio resetting)
714 *  GENERIC_FAILURE
715 *  PASSWORD_INCORRECT
716 */
717
718#define RIL_REQUEST_ENTER_SIM_PIN2 4
719
720/**
721 * RIL_REQUEST_ENTER_SIM_PUK2
722 *
723 * Supplies SIM PUK2 and new PIN2.
724 *
725 * "data" is const char **
726 * ((const char **)data)[0] is PUK2 value
727 * ((const char **)data)[1] is new PIN2 value
728 *
729 * "response" is int *
730 * ((int *)response)[0] is the number of retries remaining, or -1 if unknown
731 *
732 * Valid errors:
733 *
734 *  SUCCESS
735 *  RADIO_NOT_AVAILABLE (radio resetting)
736 *  GENERIC_FAILURE
737 *  PASSWORD_INCORRECT
738 *     (PUK2 is invalid)
739 */
740
741#define RIL_REQUEST_ENTER_SIM_PUK2 5
742
743/**
744 * RIL_REQUEST_CHANGE_SIM_PIN
745 *
746 * Supplies old SIM PIN and new PIN.
747 *
748 * "data" is const char **
749 * ((const char **)data)[0] is old PIN value
750 * ((const char **)data)[1] is new PIN value
751 *
752 * "response" is int *
753 * ((int *)response)[0] is the number of retries remaining, or -1 if unknown
754 *
755 * Valid errors:
756 *
757 *  SUCCESS
758 *  RADIO_NOT_AVAILABLE (radio resetting)
759 *  GENERIC_FAILURE
760 *  PASSWORD_INCORRECT
761 *     (old PIN is invalid)
762 *
763 */
764
765#define RIL_REQUEST_CHANGE_SIM_PIN 6
766
767
768/**
769 * RIL_REQUEST_CHANGE_SIM_PIN2
770 *
771 * Supplies old SIM PIN2 and new PIN2.
772 *
773 * "data" is const char **
774 * ((const char **)data)[0] is old PIN2 value
775 * ((const char **)data)[1] is new PIN2 value
776 *
777 * "response" is int *
778 * ((int *)response)[0] is the number of retries remaining, or -1 if unknown
779 *
780 * Valid errors:
781 *
782 *  SUCCESS
783 *  RADIO_NOT_AVAILABLE (radio resetting)
784 *  GENERIC_FAILURE
785 *  PASSWORD_INCORRECT
786 *     (old PIN2 is invalid)
787 *
788 */
789
790#define RIL_REQUEST_CHANGE_SIM_PIN2 7
791
792/**
793 * RIL_REQUEST_ENTER_NETWORK_DEPERSONALIZATION
794 *
795 * Requests that network personlization be deactivated
796 *
797 * "data" is const char **
798 * ((const char **)(data))[0]] is network depersonlization code
799 *
800 * "response" is int *
801 * ((int *)response)[0] is the number of retries remaining, or -1 if unknown
802 *
803 * Valid errors:
804 *
805 *  SUCCESS
806 *  RADIO_NOT_AVAILABLE (radio resetting)
807 *  GENERIC_FAILURE
808 *  PASSWORD_INCORRECT
809 *     (code is invalid)
810 */
811
812#define RIL_REQUEST_ENTER_NETWORK_DEPERSONALIZATION 8
813
814/**
815 * RIL_REQUEST_GET_CURRENT_CALLS
816 *
817 * Requests current call list
818 *
819 * "data" is NULL
820 *
821 * "response" must be a "const RIL_Call **"
822 *
823 * Valid errors:
824 *
825 *  SUCCESS
826 *  RADIO_NOT_AVAILABLE (radio resetting)
827 *  GENERIC_FAILURE
828 *      (request will be made again in a few hundred msec)
829 */
830
831#define RIL_REQUEST_GET_CURRENT_CALLS 9
832
833
834/**
835 * RIL_REQUEST_DIAL
836 *
837 * Initiate voice call
838 *
839 * "data" is const RIL_Dial *
840 * "response" is NULL
841 *
842 * This method is never used for supplementary service codes
843 *
844 * Valid errors:
845 *  SUCCESS
846 *  RADIO_NOT_AVAILABLE (radio resetting)
847 *  GENERIC_FAILURE
848 */
849#define RIL_REQUEST_DIAL 10
850
851/**
852 * RIL_REQUEST_GET_IMSI
853 *
854 * Get the SIM IMSI
855 *
856 * Only valid when radio state is "RADIO_STATE_SIM_READY"
857 *
858 * "data" is NULL
859 * "response" is a const char * containing the IMSI
860 *
861 * Valid errors:
862 *  SUCCESS
863 *  RADIO_NOT_AVAILABLE (radio resetting)
864 *  GENERIC_FAILURE
865 */
866
867#define RIL_REQUEST_GET_IMSI 11
868
869/**
870 * RIL_REQUEST_HANGUP
871 *
872 * Hang up a specific line (like AT+CHLD=1x)
873 *
874 * After this HANGUP request returns, RIL should show the connection is NOT
875 * active anymore in next RIL_REQUEST_GET_CURRENT_CALLS query.
876 *
877 * "data" is an int *
878 * (int *)data)[0] contains Connection index (value of 'x' in CHLD above)
879 *
880 * "response" is NULL
881 *
882 * Valid errors:
883 *  SUCCESS
884 *  RADIO_NOT_AVAILABLE (radio resetting)
885 *  GENERIC_FAILURE
886 */
887
888#define RIL_REQUEST_HANGUP 12
889
890/**
891 * RIL_REQUEST_HANGUP_WAITING_OR_BACKGROUND
892 *
893 * Hang up waiting or held (like AT+CHLD=0)
894 *
895 * After this HANGUP request returns, RIL should show the connection is NOT
896 * active anymore in next RIL_REQUEST_GET_CURRENT_CALLS query.
897 *
898 * "data" is NULL
899 * "response" is NULL
900 *
901 * Valid errors:
902 *  SUCCESS
903 *  RADIO_NOT_AVAILABLE (radio resetting)
904 *  GENERIC_FAILURE
905 */
906
907#define RIL_REQUEST_HANGUP_WAITING_OR_BACKGROUND 13
908
909/**
910 * RIL_REQUEST_HANGUP_FOREGROUND_RESUME_BACKGROUND
911 *
912 * Hang up waiting or held (like AT+CHLD=1)
913 *
914 * After this HANGUP request returns, RIL should show the connection is NOT
915 * active anymore in next RIL_REQUEST_GET_CURRENT_CALLS query.
916 *
917 * "data" is NULL
918 * "response" is NULL
919 *
920 * Valid errors:
921 *  SUCCESS
922 *  RADIO_NOT_AVAILABLE (radio resetting)
923 *  GENERIC_FAILURE
924 */
925
926#define RIL_REQUEST_HANGUP_FOREGROUND_RESUME_BACKGROUND 14
927
928/**
929 * RIL_REQUEST_SWITCH_WAITING_OR_HOLDING_AND_ACTIVE
930 *
931 * Switch waiting or holding call and active call (like AT+CHLD=2)
932 *
933 * State transitions should be is follows:
934 *
935 * If call 1 is waiting and call 2 is active, then if this re
936 *
937 *   BEFORE                               AFTER
938 * Call 1   Call 2                 Call 1       Call 2
939 * ACTIVE   HOLDING                HOLDING     ACTIVE
940 * ACTIVE   WAITING                HOLDING     ACTIVE
941 * HOLDING  WAITING                HOLDING     ACTIVE
942 * ACTIVE   IDLE                   HOLDING     IDLE
943 * IDLE     IDLE                   IDLE        IDLE
944 *
945 * "data" is NULL
946 * "response" is NULL
947 *
948 * Valid errors:
949 *  SUCCESS
950 *  RADIO_NOT_AVAILABLE (radio resetting)
951 *  GENERIC_FAILURE
952 */
953
954#define RIL_REQUEST_SWITCH_WAITING_OR_HOLDING_AND_ACTIVE 15
955#define RIL_REQUEST_SWITCH_HOLDING_AND_ACTIVE 15
956
957/**
958 * RIL_REQUEST_CONFERENCE
959 *
960 * Conference holding and active (like AT+CHLD=3)
961
962 * "data" is NULL
963 * "response" is NULL
964 *
965 * Valid errors:
966 *  SUCCESS
967 *  RADIO_NOT_AVAILABLE (radio resetting)
968 *  GENERIC_FAILURE
969 */
970#define RIL_REQUEST_CONFERENCE 16
971
972/**
973 * RIL_REQUEST_UDUB
974 *
975 * Send UDUB (user determined used busy) to ringing or
976 * waiting call answer)(RIL_BasicRequest r);
977 *
978 * "data" is NULL
979 * "response" is NULL
980 *
981 * Valid errors:
982 *  SUCCESS
983 *  RADIO_NOT_AVAILABLE (radio resetting)
984 *  GENERIC_FAILURE
985 */
986#define RIL_REQUEST_UDUB 17
987
988/**
989 * RIL_REQUEST_LAST_CALL_FAIL_CAUSE
990 *
991 * Requests the failure cause code for the most recently terminated call
992 *
993 * "data" is NULL
994 * "response" is a "int *"
995 * ((int *)response)[0] is RIL_LastCallFailCause.  GSM failure reasons are
996 * mapped to cause codes defined in TS 24.008 Annex H where possible. CDMA
997 * failure reasons are derived from the possible call failure scenarios
998 * described in the "CDMA IS-2000 Release A (C.S0005-A v6.0)" standard.
999 *
1000 * The implementation should return CALL_FAIL_ERROR_UNSPECIFIED for blocked
1001 * MO calls by restricted state (See RIL_UNSOL_RESTRICTED_STATE_CHANGED)
1002 *
1003 * If the implementation does not have access to the exact cause codes,
1004 * then it should return one of the values listed in RIL_LastCallFailCause,
1005 * as the UI layer needs to distinguish these cases for tone generation or
1006 * error notification.
1007 *
1008 * Valid errors:
1009 *  SUCCESS
1010 *  RADIO_NOT_AVAILABLE
1011 *  GENERIC_FAILURE
1012 *
1013 * See also: RIL_REQUEST_LAST_DATA_CALL_FAIL_CAUSE
1014 */
1015#define RIL_REQUEST_LAST_CALL_FAIL_CAUSE 18
1016
1017/**
1018 * RIL_REQUEST_SIGNAL_STRENGTH
1019 *
1020 * Requests current signal strength and associated information
1021 *
1022 * Must succeed if radio is on.
1023 *
1024 * "data" is NULL
1025 *
1026 * "response" is a const RIL_SignalStrength *
1027 *
1028 * Valid errors:
1029 *  SUCCESS
1030 *  RADIO_NOT_AVAILABLE
1031 */
1032#define RIL_REQUEST_SIGNAL_STRENGTH 19
1033
1034/**
1035 * RIL_REQUEST_REGISTRATION_STATE
1036 *
1037 * Request current registration state
1038 *
1039 * "data" is NULL
1040 * "response" is a "char **"
1041 * ((const char **)response)[0] is registration state 0-6,
1042 *              0 - Not registered, MT is not currently searching
1043 *                  a new operator to register
1044 *              1 - Registered, home network
1045 *              2 - Not registered, but MT is currently searching
1046 *                  a new operator to register
1047 *              3 - Registration denied
1048 *              4 - Unknown
1049 *              5 - Registered, roaming
1050 *             10 - Same as 0, but indicates that emergency calls
1051 *                  are enabled.
1052 *             12 - Same as 2, but indicates that emergency calls
1053 *                  are enabled.
1054 *             13 - Same as 3, but indicates that emergency calls
1055 *                  are enabled.
1056 *             14 - Same as 4, but indicates that emergency calls
1057 *                  are enabled.
1058 *
1059 * ((const char **)response)[1] is LAC if registered on a GSM/WCDMA system or
1060 *                              NULL if not.Valid LAC are 0x0000 - 0xffff
1061 * ((const char **)response)[2] is CID if registered on a * GSM/WCDMA or
1062 *                              NULL if not.
1063 *                                 Valid CID are 0x00000000 - 0xffffffff
1064 *                                    In GSM, CID is Cell ID (see TS 27.007)
1065 *                                            in 16 bits
1066 *                                    In UMTS, CID is UMTS Cell Identity
1067 *                                             (see TS 25.331) in 28 bits
1068 * ((const char **)response)[3] indicates the available radio technology 0-7,
1069 *                                  0 - Unknown, 1 - GPRS, 2 - EDGE, 3 - UMTS,
1070 *                                  4 - IS95A, 5 - IS95B, 6 - 1xRTT,
1071 *                                  7 - EvDo Rev. 0, 8 - EvDo Rev. A,
1072 *                                  9 - HSDPA, 10 - HSUPA, 11 - HSPA,
1073 *                                  12 - EVDO Rev B
1074 * ((const char **)response)[4] is Base Station ID if registered on a CDMA
1075 *                              system or NULL if not.  Base Station ID in
1076 *                              decimal format
1077 * ((const char **)response)[5] is Base Station latitude if registered on a
1078 *                              CDMA system or NULL if not. Base Station
1079 *                              latitude is a decimal number as specified in
1080 *                              3GPP2 C.S0005-A v6.0. It is represented in
1081 *                              units of 0.25 seconds and ranges from -1296000
1082 *                              to 1296000, both values inclusive (corresponding
1083 *                              to a range of -90� to +90�).
1084 * ((const char **)response)[6] is Base Station longitude if registered on a
1085 *                              CDMA system or NULL if not. Base Station
1086 *                              longitude is a decimal number as specified in
1087 *                              3GPP2 C.S0005-A v6.0. It is represented in
1088 *                              units of 0.25 seconds and ranges from -2592000
1089 *                              to 2592000, both values inclusive (corresponding
1090 *                              to a range of -180� to +180�).
1091 * ((const char **)response)[7] is concurrent services support indicator if
1092 *                              registered on a CDMA system 0-1.
1093 *                                   0 - Concurrent services not supported,
1094 *                                   1 - Concurrent services supported
1095 * ((const char **)response)[8] is System ID if registered on a CDMA system or
1096 *                              NULL if not. Valid System ID are 0 - 32767
1097 * ((const char **)response)[9] is Network ID if registered on a CDMA system or
1098 *                              NULL if not. Valid System ID are 0 - 65535
1099 * ((const char **)response)[10] is the TSB-58 Roaming Indicator if registered
1100 *                               on a CDMA or EVDO system or NULL if not. Valid values
1101 *                               are 0-255.
1102 * ((const char **)response)[11] indicates whether the current system is in the
1103 *                               PRL if registered on a CDMA or EVDO system or NULL if
1104 *                               not. 0=not in the PRL, 1=in the PRL
1105 * ((const char **)response)[12] is the default Roaming Indicator from the PRL,
1106 *                               if registered on a CDMA or EVDO system or NULL if not.
1107 *                               Valid values are 0-255.
1108 * ((const char **)response)[13] if registration state is 3 (Registration
1109 *                               denied) this is an enumerated reason why
1110 *                               registration was denied.  See 3GPP TS 24.008,
1111 *                               10.5.3.6 and Annex G.
1112 *                                 0 - General
1113 *                                 1 - Authentication Failure
1114 *                                 2 - IMSI unknown in HLR
1115 *                                 3 - Illegal MS
1116 *                                 4 - Illegal ME
1117 *                                 5 - PLMN not allowed
1118 *                                 6 - Location area not allowed
1119 *                                 7 - Roaming not allowed
1120 *                                 8 - No Suitable Cells in this Location Area
1121 *                                 9 - Network failure
1122 *                                10 - Persistent location update reject
1123 * ((const char **)response)[14] is the Primary Scrambling Code of the current
1124 *                               cell as described in TS 25.331, in hexadecimal
1125 *                               format, or NULL if unknown or not registered
1126 *                               to a UMTS network.
1127 *
1128 * Please note that registration state 4 ("unknown") is treated
1129 * as "out of service" in the Android telephony system
1130 *
1131 * Registration state 3 can be returned if Location Update Reject
1132 * (with cause 17 - Network Failure) is received repeatedly from the network,
1133 * to facilitate "managed roaming"
1134 *
1135 * Valid errors:
1136 *  SUCCESS
1137 *  RADIO_NOT_AVAILABLE
1138 *  GENERIC_FAILURE
1139 */
1140#define RIL_REQUEST_REGISTRATION_STATE 20
1141
1142/**
1143 * RIL_REQUEST_GPRS_REGISTRATION_STATE
1144 *
1145 * Request current GPRS registration state
1146 *
1147 * "data" is NULL
1148 * "response" is a "char **"
1149 * ((const char **)response)[0] is registration state 0-5 from TS 27.007 10.1.20 AT+CGREG
1150 * ((const char **)response)[1] is LAC if registered or NULL if not
1151 * ((const char **)response)[2] is CID if registered or NULL if not
1152 * ((const char **)response)[3] indicates the available radio technology, where:
1153 *      0 == unknown
1154 *      1 == GPRS only
1155 *      2 == EDGE
1156 *      3 == UMTS
1157 *      9 == HSDPA
1158 *      10 == HSUPA
1159 *      11 == HSPA
1160 *
1161 * LAC and CID are in hexadecimal format.
1162 * valid LAC are 0x0000 - 0xffff
1163 * valid CID are 0x00000000 - 0x0fffffff
1164 *
1165 * Please note that registration state 4 ("unknown") is treated
1166 * as "out of service" in the Android telephony system
1167 *
1168 * Valid errors:
1169 *  SUCCESS
1170 *  RADIO_NOT_AVAILABLE
1171 *  GENERIC_FAILURE
1172 */
1173#define RIL_REQUEST_GPRS_REGISTRATION_STATE 21
1174
1175/**
1176 * RIL_REQUEST_OPERATOR
1177 *
1178 * Request current operator ONS or EONS
1179 *
1180 * "data" is NULL
1181 * "response" is a "const char **"
1182 * ((const char **)response)[0] is long alpha ONS or EONS
1183 *                                  or NULL if unregistered
1184 *
1185 * ((const char **)response)[1] is short alpha ONS or EONS
1186 *                                  or NULL if unregistered
1187 * ((const char **)response)[2] is 5 or 6 digit numeric code (MCC + MNC)
1188 *                                  or NULL if unregistered
1189 *
1190 * Valid errors:
1191 *  SUCCESS
1192 *  RADIO_NOT_AVAILABLE
1193 *  GENERIC_FAILURE
1194 */
1195#define RIL_REQUEST_OPERATOR 22
1196
1197/**
1198 * RIL_REQUEST_RADIO_POWER
1199 *
1200 * Toggle radio on and off (for "airplane" mode)
1201 * "data" is int *
1202 * ((int *)data)[0] is > 0 for "Radio On"
1203 * ((int *)data)[0] is == 0 for "Radio Off"
1204 *
1205 * "response" is NULL
1206 *
1207 * Turn radio on if "on" > 0
1208 * Turn radio off if "on" == 0
1209 *
1210 * Valid errors:
1211 *  SUCCESS
1212 *  RADIO_NOT_AVAILABLE
1213 *  GENERIC_FAILURE
1214 */
1215#define RIL_REQUEST_RADIO_POWER 23
1216
1217/**
1218 * RIL_REQUEST_DTMF
1219 *
1220 * Send a DTMF tone
1221 *
1222 * If the implementation is currently playing a tone requested via
1223 * RIL_REQUEST_DTMF_START, that tone should be cancelled and the new tone
1224 * should be played instead
1225 *
1226 * "data" is a char * containing a single character with one of 12 values: 0-9,*,#
1227 * "response" is NULL
1228 *
1229 * FIXME should this block/mute microphone?
1230 * How does this interact with local DTMF feedback?
1231 *
1232 * Valid errors:
1233 *  SUCCESS
1234 *  RADIO_NOT_AVAILABLE
1235 *  GENERIC_FAILURE
1236 *
1237 * See also: RIL_REQUEST_DTMF_STOP, RIL_REQUEST_DTMF_START
1238 *
1239 */
1240#define RIL_REQUEST_DTMF 24
1241
1242/**
1243 * RIL_REQUEST_SEND_SMS
1244 *
1245 * Send an SMS message
1246 *
1247 * "data" is const char **
1248 * ((const char **)data)[0] is SMSC address in GSM BCD format prefixed
1249 *      by a length byte (as expected by TS 27.005) or NULL for default SMSC
1250 * ((const char **)data)[1] is SMS in PDU format as an ASCII hex string
1251 *      less the SMSC address
1252 *      TP-Layer-Length is be "strlen(((const char **)data)[1])/2"
1253 *
1254 * "response" is a const RIL_SMS_Response *
1255 *
1256 * Based on the return error, caller decides to resend if sending sms
1257 * fails. SMS_SEND_FAIL_RETRY means retry (i.e. error cause is 332)
1258 * and GENERIC_FAILURE means no retry (i.e. error cause is 500)
1259 *
1260 * Valid errors:
1261 *  SUCCESS
1262 *  RADIO_NOT_AVAILABLE
1263 *  SMS_SEND_FAIL_RETRY
1264 *  FDN_CHECK_FAILURE
1265 *  GENERIC_FAILURE
1266 *
1267 * FIXME how do we specify TP-Message-Reference if we need to resend?
1268 */
1269#define RIL_REQUEST_SEND_SMS 25
1270
1271
1272/**
1273 * RIL_REQUEST_SEND_SMS_EXPECT_MORE
1274 *
1275 * Send an SMS message. Identical to RIL_REQUEST_SEND_SMS,
1276 * except that more messages are expected to be sent soon. If possible,
1277 * keep SMS relay protocol link open (eg TS 27.005 AT+CMMS command)
1278 *
1279 * "data" is const char **
1280 * ((const char **)data)[0] is SMSC address in GSM BCD format prefixed
1281 *      by a length byte (as expected by TS 27.005) or NULL for default SMSC
1282 * ((const char **)data)[1] is SMS in PDU format as an ASCII hex string
1283 *      less the SMSC address
1284 *      TP-Layer-Length is be "strlen(((const char **)data)[1])/2"
1285 *
1286 * "response" is a const RIL_SMS_Response *
1287 *
1288 * Based on the return error, caller decides to resend if sending sms
1289 * fails. SMS_SEND_FAIL_RETRY means retry (i.e. error cause is 332)
1290 * and GENERIC_FAILURE means no retry (i.e. error cause is 500)
1291 *
1292 * Valid errors:
1293 *  SUCCESS
1294 *  RADIO_NOT_AVAILABLE
1295 *  SMS_SEND_FAIL_RETRY
1296 *  GENERIC_FAILURE
1297 *
1298 */
1299#define RIL_REQUEST_SEND_SMS_EXPECT_MORE 26
1300
1301
1302/**
1303 * RIL_REQUEST_SETUP_DATA_CALL
1304 *
1305 * Setup a packet data connection
1306 *
1307 * "data" is a const char **
1308 * ((const char **)data)[0] indicates whether to setup connection on radio technology CDMA
1309 *                              or GSM/UMTS, 0-1. 0 - CDMA, 1-GSM/UMTS
1310 *
1311 * ((const char **)data)[1] is a RIL_DataProfile (support is optional)
1312 * ((const char **)data)[2] is the APN to connect to if radio technology is GSM/UMTS. This APN will
1313 *                          override the one in the profile. NULL indicates no APN overrride.
1314 * ((const char **)data)[3] is the username for APN, or NULL
1315 * ((const char **)data)[4] is the password for APN, or NULL
1316 * ((const char **)data)[5] is the PAP / CHAP auth type. Values:
1317 *                          0 => PAP and CHAP is never performed.
1318 *                          1 => PAP may be performed; CHAP is never performed.
1319 *                          2 => CHAP may be performed; PAP is never performed.
1320 *                          3 => PAP / CHAP may be performed - baseband dependent.
1321 * ((const char **)data)[6] is the PDP type to request if the radio technology is GSM/UMTS.
1322 *                          Must be one of the PDP_type values in TS 27.007 section 10.1.1.
1323 *                          For example, "IP", "IPV6", "IPV4V6", or "PPP".
1324 *
1325 * "response" is a char **
1326 * ((char **)response)[0] indicating PDP CID, which is generated by RIL. This Connection ID is
1327 *                          used in GSM/UMTS and CDMA
1328 * ((char **)response)[1] indicating the network interface name for GSM/UMTS or CDMA
1329 * ((char **)response)[2] a space-separated list of IP addresses for this interface for GSM/UMTS
1330 *                          and NULL for CDMA
1331 *
1332 * FIXME may need way to configure QoS settings
1333 *
1334 * replaces  RIL_REQUEST_SETUP_DEFAULT_PDP
1335 *
1336 * Valid errors:
1337 *  SUCCESS
1338 *  RADIO_NOT_AVAILABLE
1339 *  GENERIC_FAILURE
1340 *
1341 * See also: RIL_REQUEST_DEACTIVATE_DATA_CALL
1342 */
1343#define RIL_REQUEST_SETUP_DATA_CALL 27
1344
1345
1346
1347/**
1348 * RIL_REQUEST_SIM_IO
1349 *
1350 * Request SIM I/O operation.
1351 * This is similar to the TS 27.007 "restricted SIM" operation
1352 * where it assumes all of the EF selection will be done by the
1353 * callee.
1354 *
1355 * "data" is a const RIL_SIM_IO *
1356 * Please note that RIL_SIM_IO has a "PIN2" field which may be NULL,
1357 * or may specify a PIN2 for operations that require a PIN2 (eg
1358 * updating FDN records)
1359 *
1360 * "response" is a const RIL_SIM_IO_Response *
1361 *
1362 * Arguments and responses that are unused for certain
1363 * values of "command" should be ignored or set to NULL
1364 *
1365 * Valid errors:
1366 *  SUCCESS
1367 *  RADIO_NOT_AVAILABLE
1368 *  GENERIC_FAILURE
1369 *  SIM_PIN2
1370 *  SIM_PUK2
1371 */
1372#define RIL_REQUEST_SIM_IO 28
1373
1374/**
1375 * RIL_REQUEST_SEND_USSD
1376 *
1377 * Send a USSD message
1378 *
1379 * If a USSD session already exists, the message should be sent in the
1380 * context of that session. Otherwise, a new session should be created.
1381 *
1382 * The network reply should be reported via RIL_UNSOL_ON_USSD
1383 *
1384 * Only one USSD session may exist at a time, and the session is assumed
1385 * to exist until:
1386 *   a) The android system invokes RIL_REQUEST_CANCEL_USSD
1387 *   b) The implementation sends a RIL_UNSOL_ON_USSD with a type code
1388 *      of "0" (USSD-Notify/no further action) or "2" (session terminated)
1389 *
1390 * "data" is a const char * containing the USSD request in UTF-8 format
1391 * "response" is NULL
1392 *
1393 * Valid errors:
1394 *  SUCCESS
1395 *  RADIO_NOT_AVAILABLE
1396 *  FDN_CHECK_FAILURE
1397 *  GENERIC_FAILURE
1398 *
1399 * See also: RIL_REQUEST_CANCEL_USSD, RIL_UNSOL_ON_USSD
1400 */
1401
1402#define RIL_REQUEST_SEND_USSD 29
1403
1404/**
1405 * RIL_REQUEST_CANCEL_USSD
1406 *
1407 * Cancel the current USSD session if one exists
1408 *
1409 * "data" is null
1410 * "response" is NULL
1411 *
1412 * Valid errors:
1413 *  SUCCESS
1414 *  RADIO_NOT_AVAILABLE
1415 *  GENERIC_FAILURE
1416 */
1417
1418#define RIL_REQUEST_CANCEL_USSD 30
1419
1420/**
1421 * RIL_REQUEST_GET_CLIR
1422 *
1423 * Gets current CLIR status
1424 * "data" is NULL
1425 * "response" is int *
1426 * ((int *)data)[0] is "n" parameter from TS 27.007 7.7
1427 * ((int *)data)[1] is "m" parameter from TS 27.007 7.7
1428 *
1429 * Valid errors:
1430 *  SUCCESS
1431 *  RADIO_NOT_AVAILABLE
1432 *  GENERIC_FAILURE
1433 */
1434#define RIL_REQUEST_GET_CLIR 31
1435
1436/**
1437 * RIL_REQUEST_SET_CLIR
1438 *
1439 * "data" is int *
1440 * ((int *)data)[0] is "n" parameter from TS 27.007 7.7
1441 *
1442 * "response" is NULL
1443 *
1444 * Valid errors:
1445 *  SUCCESS
1446 *  RADIO_NOT_AVAILABLE
1447 *  GENERIC_FAILURE
1448 */
1449#define RIL_REQUEST_SET_CLIR 32
1450
1451/**
1452 * RIL_REQUEST_QUERY_CALL_FORWARD_STATUS
1453 *
1454 * "data" is const RIL_CallForwardInfo *
1455 *
1456 * "response" is const RIL_CallForwardInfo **
1457 * "response" points to an array of RIL_CallForwardInfo *'s, one for
1458 * each distinct registered phone number.
1459 *
1460 * For example, if data is forwarded to +18005551212 and voice is forwarded
1461 * to +18005559999, then two separate RIL_CallForwardInfo's should be returned
1462 *
1463 * If, however, both data and voice are forwarded to +18005551212, then
1464 * a single RIL_CallForwardInfo can be returned with the service class
1465 * set to "data + voice = 3")
1466 *
1467 * Valid errors:
1468 *  SUCCESS
1469 *  RADIO_NOT_AVAILABLE
1470 *  GENERIC_FAILURE
1471 */
1472#define RIL_REQUEST_QUERY_CALL_FORWARD_STATUS 33
1473
1474
1475/**
1476 * RIL_REQUEST_SET_CALL_FORWARD
1477 *
1478 * Configure call forward rule
1479 *
1480 * "data" is const RIL_CallForwardInfo *
1481 * "response" is NULL
1482 *
1483 * Valid errors:
1484 *  SUCCESS
1485 *  RADIO_NOT_AVAILABLE
1486 *  GENERIC_FAILURE
1487 */
1488#define RIL_REQUEST_SET_CALL_FORWARD 34
1489
1490
1491/**
1492 * RIL_REQUEST_QUERY_CALL_WAITING
1493 *
1494 * Query current call waiting state
1495 *
1496 * "data" is const int *
1497 * ((const int *)data)[0] is the TS 27.007 service class to query.
1498 * "response" is a const int *
1499 * ((const int *)response)[0] is 0 for "disabled" and 1 for "enabled"
1500 *
1501 * If ((const int *)response)[0] is = 1, then ((const int *)response)[1]
1502 * must follow, with the TS 27.007 service class bit vector of services
1503 * for which call waiting is enabled.
1504 *
1505 * For example, if ((const int *)response)[0]  is 1 and
1506 * ((const int *)response)[1] is 3, then call waiting is enabled for data
1507 * and voice and disabled for everything else
1508 *
1509 * Valid errors:
1510 *  SUCCESS
1511 *  RADIO_NOT_AVAILABLE
1512 *  GENERIC_FAILURE
1513 */
1514#define RIL_REQUEST_QUERY_CALL_WAITING 35
1515
1516
1517/**
1518 * RIL_REQUEST_SET_CALL_WAITING
1519 *
1520 * Configure current call waiting state
1521 *
1522 * "data" is const int *
1523 * ((const int *)data)[0] is 0 for "disabled" and 1 for "enabled"
1524 * ((const int *)data)[1] is the TS 27.007 service class bit vector of
1525 *                           services to modify
1526 * "response" is NULL
1527 *
1528 * Valid errors:
1529 *  SUCCESS
1530 *  RADIO_NOT_AVAILABLE
1531 *  GENERIC_FAILURE
1532 */
1533#define RIL_REQUEST_SET_CALL_WAITING 36
1534
1535/**
1536 * RIL_REQUEST_SMS_ACKNOWLEDGE
1537 *
1538 * Acknowledge successful or failed receipt of SMS previously indicated
1539 * via RIL_UNSOL_RESPONSE_NEW_SMS
1540 *
1541 * "data" is int *
1542 * ((int *)data)[0] is 1 on successful receipt
1543 *                  (basically, AT+CNMA=1 from TS 27.005
1544 *                  is 0 on failed receipt
1545 *                  (basically, AT+CNMA=2 from TS 27.005)
1546 * ((int *)data)[1] if data[0] is 0, this contains the failure cause as defined
1547 *                  in TS 23.040, 9.2.3.22. Currently only 0xD3 (memory
1548 *                  capacity exceeded) and 0xFF (unspecified error) are
1549 *                  reported.
1550 *
1551 * "response" is NULL
1552 *
1553 * FIXME would like request that specified RP-ACK/RP-ERROR PDU
1554 *
1555 * Valid errors:
1556 *  SUCCESS
1557 *  RADIO_NOT_AVAILABLE
1558 *  GENERIC_FAILURE
1559 */
1560#define RIL_REQUEST_SMS_ACKNOWLEDGE  37
1561
1562/**
1563 * RIL_REQUEST_GET_IMEI - DEPRECATED
1564 *
1565 * Get the device IMEI, including check digit
1566 *
1567 * The request is DEPRECATED, use RIL_REQUEST_DEVICE_IDENTITY
1568 * Valid when RadioState is not RADIO_STATE_UNAVAILABLE
1569 *
1570 * "data" is NULL
1571 * "response" is a const char * containing the IMEI
1572 *
1573 * Valid errors:
1574 *  SUCCESS
1575 *  RADIO_NOT_AVAILABLE (radio resetting)
1576 *  GENERIC_FAILURE
1577 */
1578
1579#define RIL_REQUEST_GET_IMEI 38
1580
1581/**
1582 * RIL_REQUEST_GET_IMEISV - DEPRECATED
1583 *
1584 * Get the device IMEISV, which should be two decimal digits
1585 *
1586 * The request is DEPRECATED, use RIL_REQUEST_DEVICE_IDENTITY
1587 * Valid when RadioState is not RADIO_STATE_UNAVAILABLE
1588 *
1589 * "data" is NULL
1590 * "response" is a const char * containing the IMEISV
1591 *
1592 * Valid errors:
1593 *  SUCCESS
1594 *  RADIO_NOT_AVAILABLE (radio resetting)
1595 *  GENERIC_FAILURE
1596 */
1597
1598#define RIL_REQUEST_GET_IMEISV 39
1599
1600
1601/**
1602 * RIL_REQUEST_ANSWER
1603 *
1604 * Answer incoming call
1605 *
1606 * Will not be called for WAITING calls.
1607 * RIL_REQUEST_SWITCH_WAITING_OR_HOLDING_AND_ACTIVE will be used in this case
1608 * instead
1609 *
1610 * "data" is NULL
1611 * "response" is NULL
1612 *
1613 * Valid errors:
1614 *  SUCCESS
1615 *  RADIO_NOT_AVAILABLE (radio resetting)
1616 *  GENERIC_FAILURE
1617 */
1618
1619#define RIL_REQUEST_ANSWER 40
1620
1621/**
1622 * RIL_REQUEST_DEACTIVATE_DATA_CALL
1623 *
1624 * Deactivate packet data connection
1625 * replaces RIL_REQUEST_DEACTIVATE_DEFAULT_PDP
1626 *
1627 * "data" is const char **
1628 * ((char**)data)[0] indicating CID
1629 * ((char**)data)[1] indicating Disconnect Reason
1630 *                   0 => No specific reason specified
1631 *                   1 => Radio shutdown requested
1632 *
1633 * "response" is NULL
1634 *
1635 * Valid errors:
1636 *  SUCCESS
1637 *  RADIO_NOT_AVAILABLE
1638 *  GENERIC_FAILURE
1639 *
1640 * See also: RIL_REQUEST_SETUP_DATA_CALL
1641 */
1642#define RIL_REQUEST_DEACTIVATE_DATA_CALL 41
1643
1644/**
1645 * RIL_REQUEST_QUERY_FACILITY_LOCK
1646 *
1647 * Query the status of a facility lock state
1648 *
1649 * "data" is const char **
1650 * ((const char **)data)[0] is the facility string code from TS 27.007 7.4
1651 *                      (eg "AO" for BAOC, "SC" for SIM lock)
1652 * ((const char **)data)[1] is the password, or "" if not required
1653 * ((const char **)data)[2] is the TS 27.007 service class bit vector of
1654 *                           services to query
1655 *
1656 * "response" is an int *
1657 * ((const int *)response) 0 is the TS 27.007 service class bit vector of
1658 *                           services for which the specified barring facility
1659 *                           is active. "0" means "disabled for all"
1660 *
1661 *
1662 * Valid errors:
1663 *  SUCCESS
1664 *  RADIO_NOT_AVAILABLE
1665 *  GENERIC_FAILURE
1666 *
1667 */
1668#define RIL_REQUEST_QUERY_FACILITY_LOCK 42
1669
1670/**
1671 * RIL_REQUEST_SET_FACILITY_LOCK
1672 *
1673 * Enable/disable one facility lock
1674 *
1675 * "data" is const char **
1676 *
1677 * ((const char **)data)[0] = facility string code from TS 27.007 7.4
1678 * (eg "AO" for BAOC)
1679 * ((const char **)data)[1] = "0" for "unlock" and "1" for "lock"
1680 * ((const char **)data)[2] = password
1681 * ((const char **)data)[3] = string representation of decimal TS 27.007
1682 *                            service class bit vector. Eg, the string
1683 *                            "1" means "set this facility for voice services"
1684 *
1685 * "response" is int *
1686 * ((int *)response)[0] is the number of retries remaining, or -1 if unknown
1687 *
1688 * Valid errors:
1689 *  SUCCESS
1690 *  RADIO_NOT_AVAILABLE
1691 *  GENERIC_FAILURE
1692 *
1693 */
1694#define RIL_REQUEST_SET_FACILITY_LOCK 43
1695
1696/**
1697 * RIL_REQUEST_CHANGE_BARRING_PASSWORD
1698 *
1699 * Change call barring facility password
1700 *
1701 * "data" is const char **
1702 *
1703 * ((const char **)data)[0] = facility string code from TS 27.007 7.4
1704 * (eg "AO" for BAOC)
1705 * ((const char **)data)[1] = old password
1706 * ((const char **)data)[2] = new password
1707 *
1708 * "response" is NULL
1709 *
1710 * Valid errors:
1711 *  SUCCESS
1712 *  RADIO_NOT_AVAILABLE
1713 *  GENERIC_FAILURE
1714 *
1715 */
1716#define RIL_REQUEST_CHANGE_BARRING_PASSWORD 44
1717
1718/**
1719 * RIL_REQUEST_QUERY_NETWORK_SELECTION_MODE
1720 *
1721 * Query current network selectin mode
1722 *
1723 * "data" is NULL
1724 *
1725 * "response" is int *
1726 * ((const int *)response)[0] is
1727 *     0 for automatic selection
1728 *     1 for manual selection
1729 *
1730 * Valid errors:
1731 *  SUCCESS
1732 *  RADIO_NOT_AVAILABLE
1733 *  GENERIC_FAILURE
1734 *
1735 */
1736#define RIL_REQUEST_QUERY_NETWORK_SELECTION_MODE 45
1737
1738/**
1739 * RIL_REQUEST_SET_NETWORK_SELECTION_AUTOMATIC
1740 *
1741 * Specify that the network should be selected automatically
1742 *
1743 * "data" is NULL
1744 * "response" is NULL
1745 *
1746 * This request must not respond until the new operator is selected
1747 * and registered
1748 *
1749 * Valid errors:
1750 *  SUCCESS
1751 *  RADIO_NOT_AVAILABLE
1752 *  ILLEGAL_SIM_OR_ME
1753 *  GENERIC_FAILURE
1754 *
1755 * Note: Returns ILLEGAL_SIM_OR_ME when the failure is permanent and
1756 *       no retries needed, such as illegal SIM or ME.
1757 *       Returns GENERIC_FAILURE for all other causes that might be
1758 *       fixed by retries.
1759 *
1760 */
1761#define RIL_REQUEST_SET_NETWORK_SELECTION_AUTOMATIC 46
1762
1763/**
1764 * RIL_REQUEST_SET_NETWORK_SELECTION_MANUAL
1765 *
1766 * Manually select a specified network.
1767 *
1768 * "data" is const char * specifying MCCMNC of network to select (eg "310170")
1769 * "response" is NULL
1770 *
1771 * This request must not respond until the new operator is selected
1772 * and registered
1773 *
1774 * Valid errors:
1775 *  SUCCESS
1776 *  RADIO_NOT_AVAILABLE
1777 *  ILLEGAL_SIM_OR_ME
1778 *  GENERIC_FAILURE
1779 *
1780 * Note: Returns ILLEGAL_SIM_OR_ME when the failure is permanent and
1781 *       no retries needed, such as illegal SIM or ME.
1782 *       Returns GENERIC_FAILURE for all other causes that might be
1783 *       fixed by retries.
1784 *
1785 */
1786#define RIL_REQUEST_SET_NETWORK_SELECTION_MANUAL 47
1787
1788/**
1789 * RIL_REQUEST_QUERY_AVAILABLE_NETWORKS
1790 *
1791 * Scans for available networks
1792 *
1793 * "data" is NULL
1794 * "response" is const char ** that should be an array of n*4 strings, where
1795 *    n is the number of available networks
1796 * For each available network:
1797 *
1798 * ((const char **)response)[n+0] is long alpha ONS or EONS
1799 * ((const char **)response)[n+1] is short alpha ONS or EONS
1800 * ((const char **)response)[n+2] is 5 or 6 digit numeric code (MCC + MNC)
1801 * ((const char **)response)[n+3] is a string value of the status:
1802 *           "unknown"
1803 *           "available"
1804 *           "current"
1805 *           "forbidden"
1806 *
1807 * This request must not respond until the new operator is selected
1808 * and registered
1809 *
1810 * Valid errors:
1811 *  SUCCESS
1812 *  RADIO_NOT_AVAILABLE
1813 *  GENERIC_FAILURE
1814 *
1815 */
1816#define RIL_REQUEST_QUERY_AVAILABLE_NETWORKS 48
1817
1818/**
1819 * RIL_REQUEST_DTMF_START
1820 *
1821 * Start playing a DTMF tone. Continue playing DTMF tone until
1822 * RIL_REQUEST_DTMF_STOP is received
1823 *
1824 * If a RIL_REQUEST_DTMF_START is received while a tone is currently playing,
1825 * it should cancel the previous tone and play the new one.
1826 *
1827 * "data" is a char *
1828 * ((char *)data)[0] is a single character with one of 12 values: 0-9,*,#
1829 * "response" is NULL
1830 *
1831 * Valid errors:
1832 *  SUCCESS
1833 *  RADIO_NOT_AVAILABLE
1834 *  GENERIC_FAILURE
1835 *
1836 * See also: RIL_REQUEST_DTMF, RIL_REQUEST_DTMF_STOP
1837 */
1838#define RIL_REQUEST_DTMF_START 49
1839
1840/**
1841 * RIL_REQUEST_DTMF_STOP
1842 *
1843 * Stop playing a currently playing DTMF tone.
1844 *
1845 * "data" is NULL
1846 * "response" is NULL
1847 *
1848 * Valid errors:
1849 *  SUCCESS
1850 *  RADIO_NOT_AVAILABLE
1851 *  GENERIC_FAILURE
1852 *
1853 * See also: RIL_REQUEST_DTMF, RIL_REQUEST_DTMF_START
1854 */
1855#define RIL_REQUEST_DTMF_STOP 50
1856
1857/**
1858 * RIL_REQUEST_BASEBAND_VERSION
1859 *
1860 * Return string value indicating baseband version, eg
1861 * response from AT+CGMR
1862 *
1863 * "data" is NULL
1864 * "response" is const char * containing version string for log reporting
1865 *
1866 * Valid errors:
1867 *  SUCCESS
1868 *  RADIO_NOT_AVAILABLE
1869 *  GENERIC_FAILURE
1870 *
1871 */
1872#define RIL_REQUEST_BASEBAND_VERSION 51
1873
1874/**
1875 * RIL_REQUEST_SEPARATE_CONNECTION
1876 *
1877 * Separate a party from a multiparty call placing the multiparty call
1878 * (less the specified party) on hold and leaving the specified party
1879 * as the only other member of the current (active) call
1880 *
1881 * Like AT+CHLD=2x
1882 *
1883 * See TS 22.084 1.3.8.2 (iii)
1884 * TS 22.030 6.5.5 "Entering "2X followed by send"
1885 * TS 27.007 "AT+CHLD=2x"
1886 *
1887 * "data" is an int *
1888 * (int *)data)[0] contains Connection index (value of 'x' in CHLD above) "response" is NULL
1889 *
1890 * "response" is NULL
1891 *
1892 * Valid errors:
1893 *  SUCCESS
1894 *  RADIO_NOT_AVAILABLE (radio resetting)
1895 *  GENERIC_FAILURE
1896 */
1897#define RIL_REQUEST_SEPARATE_CONNECTION 52
1898
1899
1900/**
1901 * RIL_REQUEST_SET_MUTE
1902 *
1903 * Turn on or off uplink (microphone) mute.
1904 *
1905 * Will only be sent while voice call is active.
1906 * Will always be reset to "disable mute" when a new voice call is initiated
1907 *
1908 * "data" is an int *
1909 * (int *)data)[0] is 1 for "enable mute" and 0 for "disable mute"
1910 *
1911 * "response" is NULL
1912 *
1913 * Valid errors:
1914 *  SUCCESS
1915 *  RADIO_NOT_AVAILABLE (radio resetting)
1916 *  GENERIC_FAILURE
1917 */
1918
1919#define RIL_REQUEST_SET_MUTE 53
1920
1921/**
1922 * RIL_REQUEST_GET_MUTE
1923 *
1924 * Queries the current state of the uplink mute setting
1925 *
1926 * "data" is NULL
1927 * "response" is an int *
1928 * (int *)response)[0] is 1 for "mute enabled" and 0 for "mute disabled"
1929 *
1930 * Valid errors:
1931 *  SUCCESS
1932 *  RADIO_NOT_AVAILABLE (radio resetting)
1933 *  GENERIC_FAILURE
1934 */
1935
1936#define RIL_REQUEST_GET_MUTE 54
1937
1938/**
1939 * RIL_REQUEST_QUERY_CLIP
1940 *
1941 * Queries the status of the CLIP supplementary service
1942 *
1943 * (for MMI code "*#30#")
1944 *
1945 * "data" is NULL
1946 * "response" is an int *
1947 * (int *)response)[0] is 1 for "CLIP provisioned"
1948 *                           and 0 for "CLIP not provisioned"
1949 *                           and 2 for "unknown, e.g. no network etc"
1950 *
1951 * Valid errors:
1952 *  SUCCESS
1953 *  RADIO_NOT_AVAILABLE (radio resetting)
1954 *  GENERIC_FAILURE
1955 */
1956
1957#define RIL_REQUEST_QUERY_CLIP 55
1958
1959/**
1960 * RIL_REQUEST_LAST_DATA_CALL_FAIL_CAUSE
1961 *
1962 * Requests the failure cause code for the most recently failed PDP
1963 * context or CDMA data connection active
1964 * replaces RIL_REQUEST_LAST_PDP_FAIL_CAUSE
1965 *
1966 * "data" is NULL
1967 *
1968 * "response" is a "int *"
1969 * ((int *)response)[0] is an integer cause code defined in TS 24.008
1970 *   section 6.1.3.1.3 or close approximation
1971 *
1972 * If the implementation does not have access to the exact cause codes,
1973 * then it should return one of the values listed in
1974 * RIL_LastDataCallActivateFailCause, as the UI layer needs to distinguish these
1975 * cases for error notification
1976 * and potential retries.
1977 *
1978 * Valid errors:
1979 *  SUCCESS
1980 *  RADIO_NOT_AVAILABLE
1981 *  GENERIC_FAILURE
1982 *
1983 * See also: RIL_REQUEST_LAST_CALL_FAIL_CAUSE
1984 *
1985 */
1986
1987#define RIL_REQUEST_LAST_DATA_CALL_FAIL_CAUSE 56
1988
1989/**
1990 * RIL_REQUEST_DATA_CALL_LIST
1991 *
1992 * Queries the status of PDP contexts, returning for each
1993 * its CID, whether or not it is active, and its PDP type,
1994 * APN, and PDP adddress.
1995 * replaces RIL_REQUEST_PDP_CONTEXT_LIST
1996 *
1997 * "data" is NULL
1998 * "response" is an array of RIL_Data_Call_Response
1999 *
2000 * Valid errors:
2001 *  SUCCESS
2002 *  RADIO_NOT_AVAILABLE (radio resetting)
2003 *  GENERIC_FAILURE
2004 */
2005
2006#define RIL_REQUEST_DATA_CALL_LIST 57
2007
2008/**
2009 * RIL_REQUEST_RESET_RADIO - DEPRECATED
2010 *
2011 * Request a radio reset. The RIL implementation may postpone
2012 * the reset until after this request is responded to if the baseband
2013 * is presently busy.
2014 *
2015 * The request is DEPRECATED, use RIL_REQUEST_RADIO_POWER
2016 *
2017 * "data" is NULL
2018 * "response" is NULL
2019 *
2020 * Valid errors:
2021 *  SUCCESS
2022 *  RADIO_NOT_AVAILABLE (radio resetting)
2023 *  GENERIC_FAILURE
2024 *  REQUEST_NOT_SUPPORTED
2025 */
2026
2027#define RIL_REQUEST_RESET_RADIO 58
2028
2029/**
2030 * RIL_REQUEST_OEM_HOOK_RAW
2031 *
2032 * This request reserved for OEM-specific uses. It passes raw byte arrays
2033 * back and forth.
2034 *
2035 * It can be invoked on the Java side from
2036 * com.android.internal.telephony.Phone.invokeOemRilRequestRaw()
2037 *
2038 * "data" is a char * of bytes copied from the byte[] data argument in java
2039 * "response" is a char * of bytes that will returned via the
2040 * caller's "response" Message here:
2041 * (byte[])(((AsyncResult)response.obj).result)
2042 *
2043 * An error response here will result in
2044 * (((AsyncResult)response.obj).result) == null and
2045 * (((AsyncResult)response.obj).exception) being an instance of
2046 * com.android.internal.telephony.gsm.CommandException
2047 *
2048 * Valid errors:
2049 *  All
2050 */
2051
2052#define RIL_REQUEST_OEM_HOOK_RAW 59
2053
2054/**
2055 * RIL_REQUEST_OEM_HOOK_STRINGS
2056 *
2057 * This request reserved for OEM-specific uses. It passes strings
2058 * back and forth.
2059 *
2060 * It can be invoked on the Java side from
2061 * com.android.internal.telephony.Phone.invokeOemRilRequestStrings()
2062 *
2063 * "data" is a const char **, representing an array of null-terminated UTF-8
2064 * strings copied from the "String[] strings" argument to
2065 * invokeOemRilRequestStrings()
2066 *
2067 * "response" is a const char **, representing an array of null-terminated UTF-8
2068 * stings that will be returned via the caller's response message here:
2069 *
2070 * (String[])(((AsyncResult)response.obj).result)
2071 *
2072 * An error response here will result in
2073 * (((AsyncResult)response.obj).result) == null and
2074 * (((AsyncResult)response.obj).exception) being an instance of
2075 * com.android.internal.telephony.gsm.CommandException
2076 *
2077 * Valid errors:
2078 *  All
2079 */
2080
2081#define RIL_REQUEST_OEM_HOOK_STRINGS 60
2082
2083/**
2084 * RIL_REQUEST_SCREEN_STATE
2085 *
2086 * Indicates the current state of the screen.  When the screen is off, the
2087 * RIL should notify the baseband to suppress certain notifications (eg,
2088 * signal strength and changes in LAC/CID or BID/SID/NID/latitude/longitude)
2089 * in an effort to conserve power.  These notifications should resume when the
2090 * screen is on.
2091 *
2092 * "data" is int *
2093 * ((int *)data)[0] is == 1 for "Screen On"
2094 * ((int *)data)[0] is == 0 for "Screen Off"
2095 *
2096 * "response" is NULL
2097 *
2098 * Valid errors:
2099 *  SUCCESS
2100 *  GENERIC_FAILURE
2101 */
2102#define RIL_REQUEST_SCREEN_STATE 61
2103
2104
2105/**
2106 * RIL_REQUEST_SET_SUPP_SVC_NOTIFICATION
2107 *
2108 * Enables/disables supplementary service related notifications
2109 * from the network.
2110 *
2111 * Notifications are reported via RIL_UNSOL_SUPP_SVC_NOTIFICATION.
2112 *
2113 * "data" is int *
2114 * ((int *)data)[0] is == 1 for notifications enabled
2115 * ((int *)data)[0] is == 0 for notifications disabled
2116 *
2117 * "response" is NULL
2118 *
2119 * Valid errors:
2120 *  SUCCESS
2121 *  RADIO_NOT_AVAILABLE
2122 *  GENERIC_FAILURE
2123 *
2124 * See also: RIL_UNSOL_SUPP_SVC_NOTIFICATION.
2125 */
2126#define RIL_REQUEST_SET_SUPP_SVC_NOTIFICATION 62
2127
2128/**
2129 * RIL_REQUEST_WRITE_SMS_TO_SIM
2130 *
2131 * Stores a SMS message to SIM memory.
2132 *
2133 * "data" is RIL_SMS_WriteArgs *
2134 *
2135 * "response" is int *
2136 * ((const int *)response)[0] is the record index where the message is stored.
2137 *
2138 * Valid errors:
2139 *  SUCCESS
2140 *  GENERIC_FAILURE
2141 *
2142 */
2143#define RIL_REQUEST_WRITE_SMS_TO_SIM 63
2144
2145/**
2146 * RIL_REQUEST_DELETE_SMS_ON_SIM
2147 *
2148 * Deletes a SMS message from SIM memory.
2149 *
2150 * "data" is int  *
2151 * ((int *)data)[0] is the record index of the message to delete.
2152 *
2153 * "response" is NULL
2154 *
2155 * Valid errors:
2156 *  SUCCESS
2157 *  GENERIC_FAILURE
2158 *
2159 */
2160#define RIL_REQUEST_DELETE_SMS_ON_SIM 64
2161
2162/**
2163 * RIL_REQUEST_SET_BAND_MODE
2164 *
2165 * Assign a specified band for RF configuration.
2166 *
2167 * "data" is int *
2168 * ((int *)data)[0] is == 0 for "unspecified" (selected by baseband automatically)
2169 * ((int *)data)[0] is == 1 for "EURO band" (GSM-900 / DCS-1800 / WCDMA-IMT-2000)
2170 * ((int *)data)[0] is == 2 for "US band" (GSM-850 / PCS-1900 / WCDMA-850 / WCDMA-PCS-1900)
2171 * ((int *)data)[0] is == 3 for "JPN band" (WCDMA-800 / WCDMA-IMT-2000)
2172 * ((int *)data)[0] is == 4 for "AUS band" (GSM-900 / DCS-1800 / WCDMA-850 / WCDMA-IMT-2000)
2173 * ((int *)data)[0] is == 5 for "AUS band 2" (GSM-900 / DCS-1800 / WCDMA-850)
2174 * ((int *)data)[0] is == 6 for "Cellular (800-MHz Band)"
2175 * ((int *)data)[0] is == 7 for "PCS (1900-MHz Band)"
2176 * ((int *)data)[0] is == 8 for "Band Class 3 (JTACS Band)"
2177 * ((int *)data)[0] is == 9 for "Band Class 4 (Korean PCS Band)"
2178 * ((int *)data)[0] is == 10 for "Band Class 5 (450-MHz Band)"
2179 * ((int *)data)[0] is == 11 for "Band Class 6 (2-GMHz IMT2000 Band)"
2180 * ((int *)data)[0] is == 12 for "Band Class 7 (Upper 700-MHz Band)"
2181 * ((int *)data)[0] is == 13 for "Band Class 8 (1800-MHz Band)"
2182 * ((int *)data)[0] is == 14 for "Band Class 9 (900-MHz Band)"
2183 * ((int *)data)[0] is == 15 for "Band Class 10 (Secondary 800-MHz Band)"
2184 * ((int *)data)[0] is == 16 for "Band Class 11 (400-MHz European PAMR Band)"
2185 * ((int *)data)[0] is == 17 for "Band Class 15 (AWS Band)"
2186 * ((int *)data)[0] is == 18 for "Band Class 16 (US 2.5-GHz Band)"
2187 *
2188 * "response" is NULL
2189 *
2190 * Valid errors:
2191 *  SUCCESS
2192 *  RADIO_NOT_AVAILABLE
2193 *  GENERIC_FAILURE
2194 */
2195#define RIL_REQUEST_SET_BAND_MODE 65
2196
2197/**
2198 * RIL_REQUEST_QUERY_AVAILABLE_BAND_MODE
2199 *
2200 * Query the list of band mode supported by RF.
2201 *
2202 * "data" is NULL
2203 *
2204 * "response" is int *
2205 * "response" points to an array of int's, the int[0] is the size of array, reset is one for
2206 * each available band mode.
2207 *
2208 *  0 for "unspecified" (selected by baseband automatically)
2209 *  1 for "EURO band" (GSM-900 / DCS-1800 / WCDMA-IMT-2000)
2210 *  2 for "US band" (GSM-850 / PCS-1900 / WCDMA-850 / WCDMA-PCS-1900)
2211 *  3 for "JPN band" (WCDMA-800 / WCDMA-IMT-2000)
2212 *  4 for "AUS band" (GSM-900 / DCS-1800 / WCDMA-850 / WCDMA-IMT-2000)
2213 *  5 for "AUS band 2" (GSM-900 / DCS-1800 / WCDMA-850)
2214 *  6 for "Cellular (800-MHz Band)"
2215 *  7 for "PCS (1900-MHz Band)"
2216 *  8 for "Band Class 3 (JTACS Band)"
2217 *  9 for "Band Class 4 (Korean PCS Band)"
2218 *  10 for "Band Class 5 (450-MHz Band)"
2219 *  11 for "Band Class 6 (2-GMHz IMT2000 Band)"
2220 *  12 for "Band Class 7 (Upper 700-MHz Band)"
2221 *  13 for "Band Class 8 (1800-MHz Band)"
2222 *  14 for "Band Class 9 (900-MHz Band)"
2223 *  15 for "Band Class 10 (Secondary 800-MHz Band)"
2224 *  16 for "Band Class 11 (400-MHz European PAMR Band)"
2225 *  17 for "Band Class 15 (AWS Band)"
2226 *  18 for "Band Class 16 (US 2.5-GHz Band)"
2227 *
2228 * Valid errors:
2229 *  SUCCESS
2230 *  RADIO_NOT_AVAILABLE
2231 *  GENERIC_FAILURE
2232 *
2233 * See also: RIL_REQUEST_SET_BAND_MODE
2234 */
2235#define RIL_REQUEST_QUERY_AVAILABLE_BAND_MODE 66
2236
2237/**
2238 * RIL_REQUEST_STK_GET_PROFILE
2239 *
2240 * Requests the profile of SIM tool kit.
2241 * The profile indicates the SAT/USAT features supported by ME.
2242 * The SAT/USAT features refer to 3GPP TS 11.14 and 3GPP TS 31.111
2243 *
2244 * "data" is NULL
2245 *
2246 * "response" is a const char * containing SAT/USAT profile
2247 * in hexadecimal format string starting with first byte of terminal profile
2248 *
2249 * Valid errors:
2250 *  RIL_E_SUCCESS
2251 *  RIL_E_RADIO_NOT_AVAILABLE (radio resetting)
2252 *  RIL_E_GENERIC_FAILURE
2253 */
2254#define RIL_REQUEST_STK_GET_PROFILE 67
2255
2256/**
2257 * RIL_REQUEST_STK_SET_PROFILE
2258 *
2259 * Download the STK terminal profile as part of SIM initialization
2260 * procedure
2261 *
2262 * "data" is a const char * containing SAT/USAT profile
2263 * in hexadecimal format string starting with first byte of terminal profile
2264 *
2265 * "response" is NULL
2266 *
2267 * Valid errors:
2268 *  RIL_E_SUCCESS
2269 *  RIL_E_RADIO_NOT_AVAILABLE (radio resetting)
2270 *  RIL_E_GENERIC_FAILURE
2271 */
2272#define RIL_REQUEST_STK_SET_PROFILE 68
2273
2274/**
2275 * RIL_REQUEST_STK_SEND_ENVELOPE_COMMAND
2276 *
2277 * Requests to send a SAT/USAT envelope command to SIM.
2278 * The SAT/USAT envelope command refers to 3GPP TS 11.14 and 3GPP TS 31.111
2279 *
2280 * "data" is a const char * containing SAT/USAT command
2281 * in hexadecimal format string starting with command tag
2282 *
2283 * "response" is a const char * containing SAT/USAT response
2284 * in hexadecimal format string starting with first byte of response
2285 * (May be NULL)
2286 *
2287 * Valid errors:
2288 *  RIL_E_SUCCESS
2289 *  RIL_E_RADIO_NOT_AVAILABLE (radio resetting)
2290 *  RIL_E_GENERIC_FAILURE
2291 */
2292#define RIL_REQUEST_STK_SEND_ENVELOPE_COMMAND 69
2293
2294/**
2295 * RIL_REQUEST_STK_SEND_TERMINAL_RESPONSE
2296 *
2297 * Requests to send a terminal response to SIM for a received
2298 * proactive command
2299 *
2300 * "data" is a const char * containing SAT/USAT response
2301 * in hexadecimal format string starting with first byte of response data
2302 *
2303 * "response" is NULL
2304 *
2305 * Valid errors:
2306 *  RIL_E_SUCCESS
2307 *  RIL_E_RADIO_NOT_AVAILABLE (radio resetting)
2308 *  RIL_E_GENERIC_FAILURE
2309 */
2310#define RIL_REQUEST_STK_SEND_TERMINAL_RESPONSE 70
2311
2312/**
2313 * RIL_REQUEST_STK_HANDLE_CALL_SETUP_REQUESTED_FROM_SIM
2314 *
2315 * When STK application gets RIL_UNSOL_STK_CALL_SETUP, the call actually has
2316 * been initialized by ME already. (We could see the call has been in the 'call
2317 * list') So, STK application needs to accept/reject the call according as user
2318 * operations.
2319 *
2320 * "data" is int *
2321 * ((int *)data)[0] is > 0 for "accept" the call setup
2322 * ((int *)data)[0] is == 0 for "reject" the call setup
2323 *
2324 * "response" is NULL
2325 *
2326 * Valid errors:
2327 *  RIL_E_SUCCESS
2328 *  RIL_E_RADIO_NOT_AVAILABLE (radio resetting)
2329 *  RIL_E_GENERIC_FAILURE
2330 */
2331#define RIL_REQUEST_STK_HANDLE_CALL_SETUP_REQUESTED_FROM_SIM 71
2332
2333/**
2334 * RIL_REQUEST_EXPLICIT_CALL_TRANSFER
2335 *
2336 * Connects the two calls and disconnects the subscriber from both calls.
2337 *
2338 * "data" is NULL
2339 * "response" is NULL
2340 *
2341 * Valid errors:
2342 *  SUCCESS
2343 *  RADIO_NOT_AVAILABLE (radio resetting)
2344 *  GENERIC_FAILURE
2345 */
2346#define RIL_REQUEST_EXPLICIT_CALL_TRANSFER 72
2347
2348/**
2349 * RIL_REQUEST_SET_PREFERRED_NETWORK_TYPE
2350 *
2351 * Requests to set the preferred network type for searching and registering
2352 * (CS/PS domain, RAT, and operation mode)
2353 *
2354 * "data" is int *
2355 *
2356 * ((int *)data)[0] is == 0 for GSM/WCDMA (WCDMA preferred)
2357 * ((int *)data)[0] is == 1 for GSM only
2358 * ((int *)data)[0] is == 2 for WCDMA only
2359 * ((int *)data)[0] is == 3 for GSM/WCDMA (auto mode, according to PRL)
2360 * ((int *)data)[0] is == 4 for CDMA and EvDo (auto mode, according to PRL)
2361 * ((int *)data)[0] is == 5 for CDMA only
2362 * ((int *)data)[0] is == 6 for EvDo only
2363 * ((int *)data)[0] is == 7 for GSM/WCDMA, CDMA, and EvDo (auto mode, according to PRL)
2364 *
2365 * "response" is NULL
2366 *
2367 * Valid errors:
2368 *  SUCCESS
2369 *  RADIO_NOT_AVAILABLE (radio resetting)
2370 *  GENERIC_FAILURE
2371 *  MODE_NOT_SUPPORTED
2372 */
2373#define RIL_REQUEST_SET_PREFERRED_NETWORK_TYPE 73
2374
2375/**
2376 * RIL_REQUEST_GET_PREFERRED_NETWORK_TYPE
2377 *
2378 * Query the preferred network type (CS/PS domain, RAT, and operation mode)
2379 * for searching and registering
2380 *
2381 * "data" is NULL
2382 *
2383 * "response" is int *
2384 * ((int *)response)[0] is == 0 for GSM/WCDMA (WCDMA preferred)
2385 * ((int *)response)[0] is == 1 for GSM only
2386 * ((int *)response)[0] is == 2 for WCDMA only
2387 * ((int *)response)[0] is == 3 for GSM/WCDMA (auto mode, according to PRL)
2388 * ((int *)response)[0] is == 4 for CDMA and EvDo (auto mode, according to PRL)
2389 * ((int *)response)[0] is == 5 for CDMA only
2390 * ((int *)response)[0] is == 6 for EvDo only
2391 * ((int *)response)[0] is == 7 for GSM/WCDMA, CDMA, and EvDo (auto mode, according to PRL)
2392 *
2393 * Valid errors:
2394 *  SUCCESS
2395 *  RADIO_NOT_AVAILABLE
2396 *  GENERIC_FAILURE
2397 *
2398 * See also: RIL_REQUEST_SET_PREFERRED_NETWORK_TYPE
2399 */
2400#define RIL_REQUEST_GET_PREFERRED_NETWORK_TYPE 74
2401
2402/**
2403 * RIL_REQUEST_NEIGHBORING_CELL_IDS
2404 *
2405 * Request neighboring cell id in GSM network
2406 *
2407 * "data" is NULL
2408 * "response" must be a " const RIL_NeighboringCell** "
2409 *
2410 * Valid errors:
2411 *  SUCCESS
2412 *  RADIO_NOT_AVAILABLE
2413 *  GENERIC_FAILURE
2414 */
2415#define RIL_REQUEST_GET_NEIGHBORING_CELL_IDS 75
2416
2417/**
2418 * RIL_REQUEST_SET_LOCATION_UPDATES
2419 *
2420 * Enables/disables network state change notifications due to changes in
2421 * LAC and/or CID (for GSM) or BID/SID/NID/latitude/longitude (for CDMA).
2422 * Basically +CREG=2 vs. +CREG=1 (TS 27.007).
2423 *
2424 * Note:  The RIL implementation should default to "updates enabled"
2425 * when the screen is on and "updates disabled" when the screen is off.
2426 *
2427 * "data" is int *
2428 * ((int *)data)[0] is == 1 for updates enabled (+CREG=2)
2429 * ((int *)data)[0] is == 0 for updates disabled (+CREG=1)
2430 *
2431 * "response" is NULL
2432 *
2433 * Valid errors:
2434 *  SUCCESS
2435 *  RADIO_NOT_AVAILABLE
2436 *  GENERIC_FAILURE
2437 *
2438 * See also: RIL_REQUEST_SCREEN_STATE, RIL_UNSOL_RESPONSE_NETWORK_STATE_CHANGED
2439 */
2440#define RIL_REQUEST_SET_LOCATION_UPDATES 76
2441
2442/**
2443 * RIL_REQUEST_CDMA_SET_SUBSCRIPTION
2444 *
2445 * Request to set the location where the CDMA subscription shall
2446 * be retrieved
2447 *
2448 * "data" is int *
2449 * ((int *)data)[0] is == 0 from RUIM/SIM (default)
2450 * ((int *)data)[0] is == 1 from NV
2451 *
2452 * "response" is NULL
2453 *
2454 * Valid errors:
2455 *  SUCCESS
2456 *  RADIO_NOT_AVAILABLE
2457 *  GENERIC_FAILURE
2458 *  SIM_ABSENT
2459 *  SUBSCRIPTION_NOT_AVAILABLE
2460 */
2461#define RIL_REQUEST_CDMA_SET_SUBSCRIPTION 77
2462
2463/**
2464 * RIL_REQUEST_CDMA_SET_ROAMING_PREFERENCE
2465 *
2466 * Request to set the roaming preferences in CDMA
2467 *
2468 * "data" is int *
2469 * ((int *)data)[0] is == 0 for Home Networks only, as defined in PRL
2470 * ((int *)data)[0] is == 1 for Roaming on Affiliated networks, as defined in PRL
2471 * ((int *)data)[0] is == 2 for Roaming on Any Network, as defined in the PRL
2472 *
2473 * "response" is NULL
2474 *
2475 * Valid errors:
2476 *  SUCCESS
2477 *  RADIO_NOT_AVAILABLE
2478 *  GENERIC_FAILURE
2479 */
2480#define RIL_REQUEST_CDMA_SET_ROAMING_PREFERENCE 78
2481
2482/**
2483 * RIL_REQUEST_CDMA_QUERY_ROAMING_PREFERENCE
2484 *
2485 * Request the actual setting of the roaming preferences in CDMA in the modem
2486 *
2487 * "data" is NULL
2488 *
2489 * "response" is int *
2490 * ((int *)response)[0] is == 0 for Home Networks only, as defined in PRL
2491 * ((int *)response)[0] is == 1 for Roaming on Affiliated networks, as defined in PRL
2492 * ((int *)response)[0] is == 2 for Roaming on Any Network, as defined in the PRL
2493 *
2494 * "response" is NULL
2495 *
2496 * Valid errors:
2497 *  SUCCESS
2498 *  RADIO_NOT_AVAILABLE
2499 *  GENERIC_FAILURE
2500 */
2501#define RIL_REQUEST_CDMA_QUERY_ROAMING_PREFERENCE 79
2502
2503/**
2504 * RIL_REQUEST_SET_TTY_MODE
2505 *
2506 * Request to set the TTY mode
2507 *
2508 * "data" is int *
2509 * ((int *)data)[0] is == 0 for TTY off
2510 * ((int *)data)[0] is == 1 for TTY Full
2511 * ((int *)data)[0] is == 2 for TTY HCO (hearing carryover)
2512 * ((int *)data)[0] is == 3 for TTY VCO (voice carryover)
2513 *
2514 * "response" is NULL
2515 *
2516 * Valid errors:
2517 *  SUCCESS
2518 *  RADIO_NOT_AVAILABLE
2519 *  GENERIC_FAILURE
2520 */
2521#define RIL_REQUEST_SET_TTY_MODE 80
2522
2523/**
2524 * RIL_REQUEST_QUERY_TTY_MODE
2525 *
2526 * Request the setting of TTY mode
2527 *
2528 * "data" is NULL
2529 *
2530 * "response" is int *
2531 * ((int *)response)[0] is == 0 for TTY off
2532 * ((int *)response)[0] is == 1 for TTY Full
2533 * ((int *)response)[0] is == 2 for TTY HCO (hearing carryover)
2534 * ((int *)response)[0] is == 3 for TTY VCO (voice carryover)
2535 *
2536 * "response" is NULL
2537 *
2538 * Valid errors:
2539 *  SUCCESS
2540 *  RADIO_NOT_AVAILABLE
2541 *  GENERIC_FAILURE
2542 */
2543#define RIL_REQUEST_QUERY_TTY_MODE 81
2544
2545/**
2546 * RIL_REQUEST_CDMA_SET_PREFERRED_VOICE_PRIVACY_MODE
2547 *
2548 * Request to set the preferred voice privacy mode used in voice
2549 * scrambling
2550 *
2551 * "data" is int *
2552 * ((int *)data)[0] is == 0 for Standard Privacy Mode (Public Long Code Mask)
2553 * ((int *)data)[0] is == 1 for Enhanced Privacy Mode (Private Long Code Mask)
2554 *
2555 * "response" is NULL
2556 *
2557 * Valid errors:
2558 *  SUCCESS
2559 *  RADIO_NOT_AVAILABLE
2560 *  GENERIC_FAILURE
2561 */
2562#define RIL_REQUEST_CDMA_SET_PREFERRED_VOICE_PRIVACY_MODE 82
2563
2564/**
2565 * RIL_REQUEST_CDMA_QUERY_PREFERRED_VOICE_PRIVACY_MODE
2566 *
2567 * Request the setting of preferred voice privacy mode
2568 *
2569 * "data" is NULL
2570 *
2571 * "response" is int *
2572 * ((int *)response)[0] is == 0 for Standard Privacy Mode (Public Long Code Mask)
2573 * ((int *)response)[0] is == 1 for Enhanced Privacy Mode (Private Long Code Mask)
2574 *
2575 * "response" is NULL
2576 *
2577 * Valid errors:
2578 *  SUCCESS
2579 *  RADIO_NOT_AVAILABLE
2580 *  GENERIC_FAILURE
2581 */
2582#define RIL_REQUEST_CDMA_QUERY_PREFERRED_VOICE_PRIVACY_MODE 83
2583
2584/**
2585 * RIL_REQUEST_CDMA_FLASH
2586 *
2587 * Send FLASH
2588 *
2589 * "data" is const char *
2590 * ((const char *)data)[0] is a FLASH string
2591 *
2592 * "response" is NULL
2593 *
2594 * Valid errors:
2595 *  SUCCESS
2596 *  RADIO_NOT_AVAILABLE
2597 *  GENERIC_FAILURE
2598 *
2599 */
2600#define RIL_REQUEST_CDMA_FLASH 84
2601
2602/**
2603 * RIL_REQUEST_CDMA_BURST_DTMF
2604 *
2605 * Send DTMF string
2606 *
2607 * "data" is const char **
2608 * ((const char **)data)[0] is a DTMF string
2609 * ((const char **)data)[1] is the DTMF ON length in milliseconds, or 0 to use
2610 *                          default
2611 * ((const char **)data)[2] is the DTMF OFF length in milliseconds, or 0 to use
2612 *                          default
2613 *
2614 * "response" is NULL
2615 *
2616 * Valid errors:
2617 *  SUCCESS
2618 *  RADIO_NOT_AVAILABLE
2619 *  GENERIC_FAILURE
2620 *
2621 */
2622#define RIL_REQUEST_CDMA_BURST_DTMF 85
2623
2624/**
2625 * RIL_REQUEST_CDMA_VALIDATE_AND_WRITE_AKEY
2626 *
2627 * Takes a 26 digit string (20 digit AKEY + 6 digit checksum).
2628 * If the checksum is valid the 20 digit AKEY is written to NV,
2629 * replacing the existing AKEY no matter what it was before.
2630 *
2631 * "data" is const char *
2632 * ((const char *)data)[0] is a 26 digit string (ASCII digits '0'-'9')
2633 *                         where the last 6 digits are a checksum of the
2634 *                         first 20, as specified in TR45.AHAG
2635 *                         "Common Cryptographic Algorithms, Revision D.1
2636 *                         Section 2.2"
2637 *
2638 * "response" is NULL
2639 *
2640 * Valid errors:
2641 *  SUCCESS
2642 *  RADIO_NOT_AVAILABLE
2643 *  GENERIC_FAILURE
2644 *
2645 */
2646#define RIL_REQUEST_CDMA_VALIDATE_AND_WRITE_AKEY 86
2647
2648/**
2649 * RIL_REQUEST_CDMA_SEND_SMS
2650 *
2651 * Send a CDMA SMS message
2652 *
2653 * "data" is const RIL_CDMA_SMS_Message *
2654 *
2655 * "response" is a const RIL_SMS_Response *
2656 *
2657 * Based on the return error, caller decides to resend if sending sms
2658 * fails. The CDMA error class is derived as follows,
2659 * SUCCESS is error class 0 (no error)
2660 * SMS_SEND_FAIL_RETRY is error class 2 (temporary failure)
2661 * and GENERIC_FAILURE is error class 3 (permanent and no retry)
2662 *
2663 * Valid errors:
2664 *  SUCCESS
2665 *  RADIO_NOT_AVAILABLE
2666 *  SMS_SEND_FAIL_RETRY
2667 *  GENERIC_FAILURE
2668 *
2669 */
2670#define RIL_REQUEST_CDMA_SEND_SMS 87
2671
2672/**
2673 * RIL_REQUEST_CDMA_SMS_ACKNOWLEDGE
2674 *
2675 * Acknowledge the success or failure in the receipt of SMS
2676 * previously indicated via RIL_UNSOL_RESPONSE_CDMA_NEW_SMS
2677 *
2678 * "data" is const RIL_CDMA_SMS_Ack *
2679 *
2680 * "response" is NULL
2681 *
2682 * Valid errors:
2683 *  SUCCESS
2684 *  RADIO_NOT_AVAILABLE
2685 *  GENERIC_FAILURE
2686 *
2687 */
2688#define RIL_REQUEST_CDMA_SMS_ACKNOWLEDGE 88
2689
2690/**
2691 * RIL_REQUEST_GSM_GET_BROADCAST_SMS_CONFIG
2692 *
2693 * Request the setting of GSM/WCDMA Cell Broadcast SMS config.
2694 *
2695 * "data" is NULL
2696 *
2697 * "response" is a const RIL_GSM_BroadcastSmsConfigInfo **
2698 * "responselen" is count * sizeof (RIL_GSM_BroadcastSmsConfigInfo *)
2699 *
2700 * Valid errors:
2701 *  SUCCESS
2702 *  RADIO_NOT_AVAILABLE
2703 *  GENERIC_FAILURE
2704 *
2705 */
2706#define RIL_REQUEST_GSM_GET_BROADCAST_SMS_CONFIG 89
2707
2708/**
2709 * RIL_REQUEST_GSM_SET_BROADCAST_SMS_CONFIG
2710 *
2711 * Set GSM/WCDMA Cell Broadcast SMS config
2712 *
2713 * "data" is a const RIL_GSM_BroadcastSmsConfigInfo **
2714 * "datalen" is count * sizeof(RIL_GSM_BroadcastSmsConfigInfo *)
2715 *
2716 * "response" is NULL
2717 *
2718 * Valid errors:
2719 *  SUCCESS
2720 *  RADIO_NOT_AVAILABLE
2721 *  GENERIC_FAILURE
2722 *
2723 */
2724#define RIL_REQUEST_GSM_SET_BROADCAST_SMS_CONFIG 90
2725
2726/**
2727 * RIL_REQUEST_GSM_SMS_BROADCAST_ACTIVATION
2728 *
2729* Enable or disable the reception of GSM/WCDMA Cell Broadcast SMS
2730 *
2731 * "data" is const int *
2732 * (const int *)data[0] indicates to activate or turn off the
2733 * reception of GSM/WCDMA Cell Broadcast SMS, 0-1,
2734 *                       0 - Activate, 1 - Turn off
2735 *
2736 * "response" is NULL
2737 *
2738 * Valid errors:
2739 *  SUCCESS
2740 *  RADIO_NOT_AVAILABLE
2741 *  GENERIC_FAILURE
2742 *
2743 */
2744#define RIL_REQUEST_GSM_SMS_BROADCAST_ACTIVATION 91
2745
2746/**
2747 * RIL_REQUEST_CDMA_GET_BROADCAST_SMS_CONFIG
2748 *
2749 * Request the setting of CDMA Broadcast SMS config
2750 *
2751 * "data" is NULL
2752 *
2753 * "response" is a const RIL_CDMA_BroadcastSmsConfigInfo **
2754 * "responselen" is count * sizeof (RIL_CDMA_BroadcastSmsConfigInfo *)
2755 *
2756 * Valid errors:
2757 *  SUCCESS
2758 *  RADIO_NOT_AVAILABLE
2759 *  GENERIC_FAILURE
2760 *
2761 */
2762#define RIL_REQUEST_CDMA_GET_BROADCAST_SMS_CONFIG 92
2763
2764/**
2765 * RIL_REQUEST_CDMA_SET_BROADCAST_SMS_CONFIG
2766 *
2767 * Set CDMA Broadcast SMS config
2768 *
2769 * "data" is an const RIL_CDMA_BroadcastSmsConfigInfo **
2770 * "datalen" is count * sizeof(const RIL_CDMA_BroadcastSmsConfigInfo *)
2771 *
2772 * "response" is NULL
2773 *
2774 * Valid errors:
2775 *  SUCCESS
2776 *  RADIO_NOT_AVAILABLE
2777 *  GENERIC_FAILURE
2778 *
2779 */
2780#define RIL_REQUEST_CDMA_SET_BROADCAST_SMS_CONFIG 93
2781
2782/**
2783 * RIL_REQUEST_CDMA_SMS_BROADCAST_ACTIVATION
2784 *
2785 * Enable or disable the reception of CDMA Broadcast SMS
2786 *
2787 * "data" is const int *
2788 * (const int *)data[0] indicates to activate or turn off the
2789 * reception of CDMA Broadcast SMS, 0-1,
2790 *                       0 - Activate, 1 - Turn off
2791 *
2792 * "response" is NULL
2793 *
2794 * Valid errors:
2795 *  SUCCESS
2796 *  RADIO_NOT_AVAILABLE
2797 *  GENERIC_FAILURE
2798 *
2799 */
2800#define RIL_REQUEST_CDMA_SMS_BROADCAST_ACTIVATION 94
2801
2802/**
2803 * RIL_REQUEST_CDMA_SUBSCRIPTION
2804 *
2805 * Request the device MDN / H_SID / H_NID.
2806 *
2807 * The request is only allowed when CDMA subscription is available.  When CDMA
2808 * subscription is changed, application layer should re-issue the request to
2809 * update the subscription information.
2810 *
2811 * If a NULL value is returned for any of the device id, it means that error
2812 * accessing the device.
2813 *
2814 * "response" is const char **
2815 * ((const char **)response)[0] is MDN if CDMA subscription is available
2816 * ((const char **)response)[1] is a comma separated list of H_SID (Home SID) if
2817 *                              CDMA subscription is available, in decimal format
2818 * ((const char **)response)[2] is a comma separated list of H_NID (Home NID) if
2819 *                              CDMA subscription is available, in decimal format
2820 * ((const char **)response)[3] is MIN (10 digits, MIN2+MIN1) if CDMA subscription is available
2821 * ((const char **)response)[4] is PRL version if CDMA subscription is available
2822 *
2823 * Valid errors:
2824 *  SUCCESS
2825 *  RIL_E_SUBSCRIPTION_NOT_AVAILABLE
2826 */
2827
2828#define RIL_REQUEST_CDMA_SUBSCRIPTION 95
2829
2830/**
2831 * RIL_REQUEST_CDMA_WRITE_SMS_TO_RUIM
2832 *
2833 * Stores a CDMA SMS message to RUIM memory.
2834 *
2835 * "data" is RIL_CDMA_SMS_WriteArgs *
2836 *
2837 * "response" is int *
2838 * ((const int *)response)[0] is the record index where the message is stored.
2839 *
2840 * Valid errors:
2841 *  SUCCESS
2842 *  RADIO_NOT_AVAILABLE
2843 *  GENERIC_FAILURE
2844 *
2845 */
2846#define RIL_REQUEST_CDMA_WRITE_SMS_TO_RUIM 96
2847
2848/**
2849 * RIL_REQUEST_CDMA_DELETE_SMS_ON_RUIM
2850 *
2851 * Deletes a CDMA SMS message from RUIM memory.
2852 *
2853 * "data" is int  *
2854 * ((int *)data)[0] is the record index of the message to delete.
2855 *
2856 * "response" is NULL
2857 *
2858 * Valid errors:
2859 *  SUCCESS
2860 *  RADIO_NOT_AVAILABLE
2861 *  GENERIC_FAILURE
2862 *
2863 */
2864#define RIL_REQUEST_CDMA_DELETE_SMS_ON_RUIM 97
2865
2866/**
2867 * RIL_REQUEST_DEVICE_IDENTITY
2868 *
2869 * Request the device ESN / MEID / IMEI / IMEISV.
2870 *
2871 * The request is always allowed and contains GSM and CDMA device identity;
2872 * it substitutes the deprecated requests RIL_REQUEST_GET_IMEI and
2873 * RIL_REQUEST_GET_IMEISV.
2874 *
2875 * If a NULL value is returned for any of the device id, it means that error
2876 * accessing the device.
2877 *
2878 * When CDMA subscription is changed the ESN/MEID may change.  The application
2879 * layer should re-issue the request to update the device identity in this case.
2880 *
2881 * "response" is const char **
2882 * ((const char **)response)[0] is IMEI if GSM subscription is available
2883 * ((const char **)response)[1] is IMEISV if GSM subscription is available
2884 * ((const char **)response)[2] is ESN if CDMA subscription is available
2885 * ((const char **)response)[3] is MEID if CDMA subscription is available
2886 *
2887 * Valid errors:
2888 *  SUCCESS
2889 *  RADIO_NOT_AVAILABLE
2890 *  GENERIC_FAILURE
2891 */
2892#define RIL_REQUEST_DEVICE_IDENTITY 98
2893
2894/**
2895 * RIL_REQUEST_EXIT_EMERGENCY_CALLBACK_MODE
2896 *
2897 * Request the radio's system selection module to exit emergency
2898 * callback mode.  RIL will not respond with SUCCESS until the modem has
2899 * completely exited from Emergency Callback Mode.
2900 *
2901 * "data" is NULL
2902 *
2903 * "response" is NULL
2904 *
2905 * Valid errors:
2906 *  SUCCESS
2907 *  RADIO_NOT_AVAILABLE
2908 *  GENERIC_FAILURE
2909 *
2910 */
2911#define RIL_REQUEST_EXIT_EMERGENCY_CALLBACK_MODE 99
2912
2913/**
2914 * RIL_REQUEST_GET_SMSC_ADDRESS
2915 *
2916 * Queries the default Short Message Service Center address on the device.
2917 *
2918 * "data" is NULL
2919 *
2920 * "response" is const char * containing the SMSC address.
2921 *
2922 * Valid errors:
2923 *  SUCCESS
2924 *  RADIO_NOT_AVAILABLE
2925 *  GENERIC_FAILURE
2926 *
2927 */
2928#define RIL_REQUEST_GET_SMSC_ADDRESS 100
2929
2930/**
2931 * RIL_REQUEST_SET_SMSC_ADDRESS
2932 *
2933 * Sets the default Short Message Service Center address on the device.
2934 *
2935 * "data" is const char * containing the SMSC address.
2936 *
2937 * "response" is NULL
2938 *
2939 * Valid errors:
2940 *  SUCCESS
2941 *  RADIO_NOT_AVAILABLE
2942 *  GENERIC_FAILURE
2943 *
2944 */
2945#define RIL_REQUEST_SET_SMSC_ADDRESS 101
2946
2947/**
2948 * RIL_REQUEST_REPORT_SMS_MEMORY_STATUS
2949 *
2950 * Indicates whether there is storage available for new SMS messages.
2951 *
2952 * "data" is int *
2953 * ((int *)data)[0] is 1 if memory is available for storing new messages
2954 *                  is 0 if memory capacity is exceeded
2955 *
2956 * "response" is NULL
2957 *
2958 * Valid errors:
2959 *  SUCCESS
2960 *  RADIO_NOT_AVAILABLE
2961 *  GENERIC_FAILURE
2962 *
2963 */
2964#define RIL_REQUEST_REPORT_SMS_MEMORY_STATUS 102
2965
2966/**
2967 * RIL_REQUEST_REPORT_STK_SERVICE_IS_RUNNING
2968 *
2969 * Indicates that the StkSerivce is running and is
2970 * ready to receive RIL_UNSOL_STK_XXXXX commands.
2971 *
2972 * "data" is NULL
2973 * "response" is NULL
2974 *
2975 * Valid errors:
2976 *  SUCCESS
2977 *  RADIO_NOT_AVAILABLE
2978 *  GENERIC_FAILURE
2979 *
2980 */
2981#define RIL_REQUEST_REPORT_STK_SERVICE_IS_RUNNING 103
2982
2983/***********************************************************************/
2984
2985
2986#define RIL_UNSOL_RESPONSE_BASE 1000
2987
2988/**
2989 * RIL_UNSOL_RESPONSE_RADIO_STATE_CHANGED
2990 *
2991 * Indicate when value of RIL_RadioState has changed.
2992 *
2993 * Callee will invoke RIL_RadioStateRequest method on main thread
2994 *
2995 * "data" is NULL
2996 */
2997
2998#define RIL_UNSOL_RESPONSE_RADIO_STATE_CHANGED 1000
2999
3000
3001/**
3002 * RIL_UNSOL_RESPONSE_CALL_STATE_CHANGED
3003 *
3004 * Indicate when call state has changed
3005 *
3006 * Callee will invoke RIL_REQUEST_GET_CURRENT_CALLS on main thread
3007 *
3008 * "data" is NULL
3009 *
3010 * Response should be invoked on, for example,
3011 * "RING", "BUSY", "NO CARRIER", and also call state
3012 * transitions (DIALING->ALERTING ALERTING->ACTIVE)
3013 *
3014 * Redundent or extraneous invocations are tolerated
3015 */
3016#define RIL_UNSOL_RESPONSE_CALL_STATE_CHANGED 1001
3017
3018
3019/**
3020 * RIL_UNSOL_RESPONSE_NETWORK_STATE_CHANGED
3021 *
3022 * Called when network state, operator name, or GPRS state has changed
3023 * Basically on, +CREG and +CGREG
3024 *
3025 * Callee will invoke the following requests on main thread:
3026 *
3027 * RIL_REQUEST_REGISTRATION_STATE
3028 * RIL_REQUEST_GPRS_REGISTRATION_STATE
3029 * RIL_REQUEST_OPERATOR
3030 *
3031 * "data" is NULL
3032 *
3033 * FIXME should this happen when SIM records are loaded? (eg, for
3034 * EONS)
3035 */
3036#define RIL_UNSOL_RESPONSE_NETWORK_STATE_CHANGED 1002
3037
3038/**
3039 * RIL_UNSOL_RESPONSE_NEW_SMS
3040 *
3041 * Called when new SMS is received.
3042 *
3043 * "data" is const char *
3044 * This is a pointer to a string containing the PDU of an SMS-DELIVER
3045 * as an ascii string of hex digits. The PDU starts with the SMSC address
3046 * per TS 27.005 (+CMT:)
3047 *
3048 * Callee will subsequently confirm the receipt of thei SMS with a
3049 * RIL_REQUEST_SMS_ACKNOWLEDGE
3050 *
3051 * No new RIL_UNSOL_RESPONSE_NEW_SMS
3052 * or RIL_UNSOL_RESPONSE_NEW_SMS_STATUS_REPORT messages should be sent until a
3053 * RIL_REQUEST_SMS_ACKNOWLEDGE has been received
3054 */
3055
3056#define RIL_UNSOL_RESPONSE_NEW_SMS 1003
3057
3058/**
3059 * RIL_UNSOL_RESPONSE_NEW_SMS_STATUS_REPORT
3060 *
3061 * Called when new SMS Status Report is received.
3062 *
3063 * "data" is const char *
3064 * This is a pointer to a string containing the PDU of an SMS-STATUS-REPORT
3065 * as an ascii string of hex digits. The PDU starts with the SMSC address
3066 * per TS 27.005 (+CDS:).
3067 *
3068 * Callee will subsequently confirm the receipt of the SMS with a
3069 * RIL_REQUEST_SMS_ACKNOWLEDGE
3070 *
3071 * No new RIL_UNSOL_RESPONSE_NEW_SMS
3072 * or RIL_UNSOL_RESPONSE_NEW_SMS_STATUS_REPORT messages should be sent until a
3073 * RIL_REQUEST_SMS_ACKNOWLEDGE has been received
3074 */
3075
3076#define RIL_UNSOL_RESPONSE_NEW_SMS_STATUS_REPORT 1004
3077
3078/**
3079 * RIL_UNSOL_RESPONSE_NEW_SMS_ON_SIM
3080 *
3081 * Called when new SMS has been stored on SIM card
3082 *
3083 * "data" is const int *
3084 * ((const int *)data)[0] contains the slot index on the SIM that contains
3085 * the new message
3086 */
3087
3088#define RIL_UNSOL_RESPONSE_NEW_SMS_ON_SIM 1005
3089
3090/**
3091 * RIL_UNSOL_ON_USSD
3092 *
3093 * Called when a new USSD message is received.
3094 *
3095 * "data" is const char **
3096 * ((const char **)data)[0] points to a type code, which is
3097 *  one of these string values:
3098 *      "0"   USSD-Notify -- text in ((const char **)data)[1]
3099 *      "1"   USSD-Request -- text in ((const char **)data)[1]
3100 *      "2"   Session terminated by network
3101 *      "3"   other local client (eg, SIM Toolkit) has responded
3102 *      "4"   Operation not supported
3103 *      "5"   Network timeout
3104 *
3105 * The USSD session is assumed to persist if the type code is "1", otherwise
3106 * the current session (if any) is assumed to have terminated.
3107 *
3108 * ((const char **)data)[1] points to a message string if applicable, which
3109 * should always be in UTF-8.
3110 */
3111#define RIL_UNSOL_ON_USSD 1006
3112/* Previously #define RIL_UNSOL_ON_USSD_NOTIFY 1006   */
3113
3114/**
3115 * RIL_UNSOL_ON_USSD_REQUEST
3116 *
3117 * Obsolete. Send via RIL_UNSOL_ON_USSD
3118 */
3119#define RIL_UNSOL_ON_USSD_REQUEST 1007
3120
3121
3122/**
3123 * RIL_UNSOL_NITZ_TIME_RECEIVED
3124 *
3125 * Called when radio has received a NITZ time message
3126 *
3127 * "data" is const char * pointing to NITZ time string
3128 * in the form "yy/mm/dd,hh:mm:ss(+/-)tz,dt"
3129 */
3130#define RIL_UNSOL_NITZ_TIME_RECEIVED  1008
3131
3132/**
3133 * RIL_UNSOL_SIGNAL_STRENGTH
3134 *
3135 * Radio may report signal strength rather han have it polled.
3136 *
3137 * "data" is a const RIL_SignalStrength *
3138 */
3139#define RIL_UNSOL_SIGNAL_STRENGTH  1009
3140
3141
3142/**
3143 * RIL_UNSOL_DATA_CALL_LIST_CHANGED
3144 *
3145 * Indicate a PDP context state has changed, or a new context
3146 * has been activated or deactivated
3147 * replaces RIL_UNSOL_PDP_CONTEXT_LIST_CHANGED
3148 *
3149 * "data" is an array of RIL_Data_Call_Response identical to that
3150 * returned by RIL_REQUEST_DATA_CALL_LIST
3151 *
3152 * See also: RIL_REQUEST_DATA_CALL_LIST
3153 */
3154
3155#define RIL_UNSOL_DATA_CALL_LIST_CHANGED 1010
3156
3157/**
3158 * RIL_UNSOL_SUPP_SVC_NOTIFICATION
3159 *
3160 * Reports supplementary service related notification from the network.
3161 *
3162 * "data" is a const RIL_SuppSvcNotification *
3163 *
3164 */
3165
3166#define RIL_UNSOL_SUPP_SVC_NOTIFICATION 1011
3167
3168/**
3169 * RIL_UNSOL_STK_SESSION_END
3170 *
3171 * Indicate when STK session is terminated by SIM.
3172 *
3173 * "data" is NULL
3174 */
3175#define RIL_UNSOL_STK_SESSION_END 1012
3176
3177/**
3178 * RIL_UNSOL_STK_PROACTIVE_COMMAND
3179 *
3180 * Indicate when SIM issue a STK proactive command to applications
3181 *
3182 * "data" is a const char * containing SAT/USAT proactive command
3183 * in hexadecimal format string starting with command tag
3184 *
3185 */
3186#define RIL_UNSOL_STK_PROACTIVE_COMMAND 1013
3187
3188/**
3189 * RIL_UNSOL_STK_EVENT_NOTIFY
3190 *
3191 * Indicate when SIM notifies applcations some event happens.
3192 * Generally, application does not need to have any feedback to
3193 * SIM but shall be able to indicate appropriate messages to users.
3194 *
3195 * "data" is a const char * containing SAT/USAT commands or responses
3196 * sent by ME to SIM or commands handled by ME, in hexadecimal format string
3197 * starting with first byte of response data or command tag
3198 *
3199 */
3200#define RIL_UNSOL_STK_EVENT_NOTIFY 1014
3201
3202/**
3203 * RIL_UNSOL_STK_CALL_SETUP
3204 *
3205 * Indicate when SIM wants application to setup a voice call.
3206 *
3207 * "data" is const int *
3208 * ((const int *)data)[0] contains timeout value (in milliseconds)
3209 */
3210#define RIL_UNSOL_STK_CALL_SETUP 1015
3211
3212/**
3213 * RIL_UNSOL_SIM_SMS_STORAGE_FULL
3214 *
3215 * Indicates that SMS storage on the SIM is full.  Sent when the network
3216 * attempts to deliver a new SMS message.  Messages cannot be saved on the
3217 * SIM until space is freed.  In particular, incoming Class 2 messages
3218 * cannot be stored.
3219 *
3220 * "data" is null
3221 *
3222 */
3223#define RIL_UNSOL_SIM_SMS_STORAGE_FULL 1016
3224
3225/**
3226 * RIL_UNSOL_SIM_REFRESH
3227 *
3228 * Indicates that file(s) on the SIM have been updated, or the SIM
3229 * has been reinitialized.
3230 *
3231 * "data" is an int *
3232 * ((int *)data)[0] is a RIL_SimRefreshResult.
3233 * ((int *)data)[1] is the EFID of the updated file if the result is
3234 * SIM_FILE_UPDATE or NULL for any other result.
3235 *
3236 * Note: If the radio state changes as a result of the SIM refresh (eg,
3237 * SIM_READY -> SIM_LOCKED_OR_ABSENT), RIL_UNSOL_RESPONSE_RADIO_STATE_CHANGED
3238 * should be sent.
3239 */
3240#define RIL_UNSOL_SIM_REFRESH 1017
3241
3242/**
3243 * RIL_UNSOL_CALL_RING
3244 *
3245 * Ring indication for an incoming call (eg, RING or CRING event).
3246 * There must be at least one RIL_UNSOL_CALL_RING at the beginning
3247 * of a call and sending multiple is optional. If the system property
3248 * ro.telephony.call_ring.multiple is false then the upper layers
3249 * will generate the multiple events internally. Otherwise the vendor
3250 * ril must generate multiple RIL_UNSOL_CALL_RING if
3251 * ro.telephony.call_ring.multiple is true or if it is absent.
3252 *
3253 * The rate of these events is controlled by ro.telephony.call_ring.delay
3254 * and has a default value of 3000 (3 seconds) if absent.
3255 *
3256 * "data" is null for GSM
3257 * "data" is const RIL_CDMA_SignalInfoRecord * if CDMA
3258 */
3259#define RIL_UNSOL_CALL_RING 1018
3260
3261/**
3262 * RIL_UNSOL_RESPONSE_SIM_STATUS_CHANGED
3263 *
3264 * Indicates that SIM state changes.
3265 *
3266 * Callee will invoke RIL_REQUEST_GET_SIM_STATUS on main thread
3267
3268 * "data" is null
3269 */
3270#define RIL_UNSOL_RESPONSE_SIM_STATUS_CHANGED 1019
3271
3272/**
3273 * RIL_UNSOL_RESPONSE_CDMA_NEW_SMS
3274 *
3275 * Called when new CDMA SMS is received
3276 *
3277 * "data" is const RIL_CDMA_SMS_Message *
3278 *
3279 * Callee will subsequently confirm the receipt of the SMS with
3280 * a RIL_REQUEST_CDMA_SMS_ACKNOWLEDGE
3281 *
3282 * No new RIL_UNSOL_RESPONSE_CDMA_NEW_SMS should be sent until
3283 * RIL_REQUEST_CDMA_SMS_ACKNOWLEDGE has been received
3284 *
3285 */
3286#define RIL_UNSOL_RESPONSE_CDMA_NEW_SMS 1020
3287
3288/**
3289 * RIL_UNSOL_RESPONSE_NEW_BROADCAST_SMS
3290 *
3291 * Called when new Broadcast SMS is received
3292 *
3293 * "data" is const char * of 88 bytes which indicates each page
3294 * of a CBS Message sent to the MS by the BTS as coded in 3GPP
3295 * 23.041 Section 9.4.1.1
3296 *
3297 */
3298#define RIL_UNSOL_RESPONSE_NEW_BROADCAST_SMS 1021
3299
3300/**
3301 * RIL_UNSOL_CDMA_RUIM_SMS_STORAGE_FULL
3302 *
3303 * Indicates that SMS storage on the RUIM is full.  Messages
3304 * cannot be saved on the RUIM until space is freed.
3305 *
3306 * "data" is null
3307 *
3308 */
3309#define RIL_UNSOL_CDMA_RUIM_SMS_STORAGE_FULL 1022
3310
3311/**
3312 * RIL_UNSOL_RESTRICTED_STATE_CHANGED
3313 *
3314 * Indicates a restricted state change (eg, for Domain Specific Access Control).
3315 *
3316 * Radio need send this msg after radio off/on cycle no matter it is changed or not.
3317 *
3318 * "data" is an int *
3319 * ((int *)data)[0] contains a bitmask of RIL_RESTRICTED_STATE_* values.
3320 */
3321#define RIL_UNSOL_RESTRICTED_STATE_CHANGED 1023
3322
3323/**
3324 * RIL_UNSOL_ENTER_EMERGENCY_CALLBACK_MODE
3325 *
3326 * Indicates that the radio system selection module has
3327 * autonomously entered emergency callback mode.
3328 *
3329 * "data" is null
3330 *
3331 */
3332#define RIL_UNSOL_ENTER_EMERGENCY_CALLBACK_MODE 1024
3333
3334/**
3335 * RIL_UNSOL_CDMA_CALL_WAITING
3336 *
3337 * Called when CDMA radio receives a call waiting indication.
3338 *
3339 * "data" is const RIL_CDMA_CallWaiting *
3340 *
3341 */
3342#define RIL_UNSOL_CDMA_CALL_WAITING 1025
3343
3344/**
3345 * RIL_UNSOL_CDMA_OTA_PROVISION_STATUS
3346 *
3347 * Called when CDMA radio receives an update of the progress of an
3348 * OTASP/OTAPA call.
3349 *
3350 * "data" is const int *
3351 *  For CDMA this is an integer OTASP/OTAPA status listed in
3352 *  RIL_CDMA_OTA_ProvisionStatus.
3353 *
3354 */
3355#define RIL_UNSOL_CDMA_OTA_PROVISION_STATUS 1026
3356
3357/**
3358 * RIL_UNSOL_CDMA_INFO_REC
3359 *
3360 * Called when CDMA radio receives one or more info recs.
3361 *
3362 * "data" is const RIL_CDMA_InformationRecords *
3363 *
3364 */
3365#define RIL_UNSOL_CDMA_INFO_REC 1027
3366
3367/**
3368 * RIL_UNSOL_OEM_HOOK_RAW
3369 *
3370 * This is for OEM specific use.
3371 *
3372 * "data" is a byte[]
3373 */
3374#define RIL_UNSOL_OEM_HOOK_RAW 1028
3375
3376/**
3377 * RIL_UNSOL_RINGBACK_TONE
3378 *
3379 * Indicates that nework doesn't have in-band information,  need to
3380 * play out-band tone.
3381 *
3382 * "data" is an int *
3383 * ((int *)data)[0] == 0 for stop play ringback tone.
3384 * ((int *)data)[0] == 1 for start play ringback tone.
3385 */
3386#define RIL_UNSOL_RINGBACK_TONE 1029
3387
3388/**
3389 * RIL_UNSOL_RESEND_INCALL_MUTE
3390 *
3391 * Indicates that framework/application need reset the uplink mute state.
3392 *
3393 * There may be situations where the mute state becomes out of sync
3394 * between the application and device in some GSM infrastructures.
3395 *
3396 * "data" is null
3397 */
3398#define RIL_UNSOL_RESEND_INCALL_MUTE 1030
3399/***********************************************************************/
3400
3401
3402/**
3403 * RIL_Request Function pointer
3404 *
3405 * @param request is one of RIL_REQUEST_*
3406 * @param data is pointer to data defined for that RIL_REQUEST_*
3407 *        data is owned by caller, and should not be modified or freed by callee
3408 * @param t should be used in subsequent call to RIL_onResponse
3409 * @param datalen the length of data
3410 *
3411 */
3412typedef void (*RIL_RequestFunc) (int request, void *data,
3413                                    size_t datalen, RIL_Token t);
3414
3415/**
3416 * This function should return the current radio state synchronously
3417 */
3418typedef RIL_RadioState (*RIL_RadioStateRequest)();
3419
3420/**
3421 * This function returns "1" if the specified RIL_REQUEST code is
3422 * supported and 0 if it is not
3423 *
3424 * @param requestCode is one of RIL_REQUEST codes
3425 */
3426
3427typedef int (*RIL_Supports)(int requestCode);
3428
3429/**
3430 * This function is called from a separate thread--not the
3431 * thread that calls RIL_RequestFunc--and indicates that a pending
3432 * request should be cancelled.
3433 *
3434 * On cancel, the callee should do its best to abandon the request and
3435 * call RIL_onRequestComplete with RIL_Errno CANCELLED at some later point.
3436 *
3437 * Subsequent calls to  RIL_onRequestComplete for this request with
3438 * other results will be tolerated but ignored. (That is, it is valid
3439 * to ignore the cancellation request)
3440 *
3441 * RIL_Cancel calls should return immediately, and not wait for cancellation
3442 *
3443 * Please see ITU v.250 5.6.1 for how one might implement this on a TS 27.007
3444 * interface
3445 *
3446 * @param t token wants to be canceled
3447 */
3448
3449typedef void (*RIL_Cancel)(RIL_Token t);
3450
3451typedef void (*RIL_TimedCallback) (void *param);
3452
3453/**
3454 * Return a version string for your RIL implementation
3455 */
3456typedef const char * (*RIL_GetVersion) (void);
3457
3458typedef struct {
3459    int version;        /* set to RIL_VERSION */
3460    RIL_RequestFunc onRequest;
3461    RIL_RadioStateRequest onStateRequest;
3462    RIL_Supports supports;
3463    RIL_Cancel onCancel;
3464    RIL_GetVersion getVersion;
3465} RIL_RadioFunctions;
3466
3467#ifdef RIL_SHLIB
3468struct RIL_Env {
3469    /**
3470     * "t" is parameter passed in on previous call to RIL_Notification
3471     * routine.
3472     *
3473     * If "e" != SUCCESS, then response can be null/is ignored
3474     *
3475     * "response" is owned by caller, and should not be modified or
3476     * freed by callee
3477     *
3478     * RIL_onRequestComplete will return as soon as possible
3479     */
3480    void (*OnRequestComplete)(RIL_Token t, RIL_Errno e,
3481                           void *response, size_t responselen);
3482
3483    /**
3484     * "unsolResponse" is one of RIL_UNSOL_RESPONSE_*
3485     * "data" is pointer to data defined for that RIL_UNSOL_RESPONSE_*
3486     *
3487     * "data" is owned by caller, and should not be modified or freed by callee
3488     */
3489
3490    void (*OnUnsolicitedResponse)(int unsolResponse, const void *data,
3491                                    size_t datalen);
3492
3493    /**
3494     * Call user-specifed "callback" function on on the same thread that
3495     * RIL_RequestFunc is called. If "relativeTime" is specified, then it specifies
3496     * a relative time value at which the callback is invoked. If relativeTime is
3497     * NULL or points to a 0-filled structure, the callback will be invoked as
3498     * soon as possible
3499     */
3500
3501    void (*RequestTimedCallback) (RIL_TimedCallback callback,
3502                                   void *param, const struct timeval *relativeTime);
3503};
3504
3505
3506/**
3507 *  RIL implementations must defined RIL_Init
3508 *  argc and argv will be command line arguments intended for the RIL implementation
3509 *  Return NULL on error
3510 *
3511 * @param env is environment point defined as RIL_Env
3512 * @param argc number of arguments
3513 * @param argv list fo arguments
3514 *
3515 */
3516const RIL_RadioFunctions *RIL_Init(const struct RIL_Env *env, int argc, char **argv);
3517
3518#else /* RIL_SHLIB */
3519
3520/**
3521 * Call this once at startup to register notification routine
3522 *
3523 * @param callbacks user-specifed callback function
3524 */
3525void RIL_register (const RIL_RadioFunctions *callbacks);
3526
3527
3528/**
3529 *
3530 * RIL_onRequestComplete will return as soon as possible
3531 *
3532 * @param t is parameter passed in on previous call to RIL_Notification
3533 *          routine.
3534 * @param e error code
3535 *          if "e" != SUCCESS, then response can be null/is ignored
3536 * @param response is owned by caller, and should not be modified or
3537 *                 freed by callee
3538 * @param responselen the length of response in byte
3539 */
3540void RIL_onRequestComplete(RIL_Token t, RIL_Errno e,
3541                           void *response, size_t responselen);
3542
3543/**
3544 * @param unsolResponse is one of RIL_UNSOL_RESPONSE_*
3545 * @param data is pointer to data defined for that RIL_UNSOL_RESPONSE_*
3546 *     "data" is owned by caller, and should not be modified or freed by callee
3547 * @param datalen the length of data in byte
3548 */
3549
3550void RIL_onUnsolicitedResponse(int unsolResponse, const void *data,
3551                                size_t datalen);
3552
3553
3554/**
3555 * Call user-specifed "callback" function on on the same thread that
3556 * RIL_RequestFunc is called. If "relativeTime" is specified, then it specifies
3557 * a relative time value at which the callback is invoked. If relativeTime is
3558 * NULL or points to a 0-filled structure, the callback will be invoked as
3559 * soon as possible
3560 *
3561 * @param callback user-specifed callback function
3562 * @param param parameter list
3563 * @param relativeTime a relative time value at which the callback is invoked
3564 */
3565
3566void RIL_requestTimedCallback (RIL_TimedCallback callback,
3567                               void *param, const struct timeval *relativeTime);
3568
3569
3570#endif /* RIL_SHLIB */
3571
3572#ifdef __cplusplus
3573}
3574#endif
3575
3576#endif /*ANDROID_RIL_H*/
3577