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