include/telephony/ril.h

   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 #ifndef ANDROID_RIL_H
  18 #define ANDROID_RIL_H 1
  19
  20 #include <stdlib.h>
  21 #include <stdint.h>
  22 #include <telephony/ril_cdma_sms.h>
  23 #include <telephony/ril_nv_items.h>
  24 #include <telephony/ril_msim.h>
  25
  26 #ifndef FEATURE_UNIT_TEST
  27 #include <sys/time.h>
  28 #endif /* !FEATURE_UNIT_TEST */
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34
  35 #if defined(ANDROID_SIM_COUNT_2)
  36 #define SIM_COUNT 2
  37 #elif defined(ANDROID_SIM_COUNT_3)
  38 #define SIM_COUNT 3
  39 #elif defined(ANDROID_SIM_COUNT_4)
  40 #define SIM_COUNT 4
  41 #else
  42 #define SIM_COUNT 1
  43 #endif
  44
  45 #ifndef ANDROID_MULTI_SIM
  46 #define SIM_COUNT 1
  47 #endif
  48
  49 #define RIL_VERSION 11     /* Current version */
  50 #define RIL_VERSION_MIN 6 /* Minimum RIL_VERSION supported */
  51
  52 #define CDMA_ALPHA_INFO_BUFFER_LENGTH 64
  53 #define CDMA_NUMBER_INFO_BUFFER_LENGTH 81
  54
  55 #define MAX_RILDS 3
  56 #define MAX_SOCKET_NAME_LENGTH 6
  57 #define MAX_CLIENT_ID_LENGTH 2
  58 #define MAX_DEBUG_SOCKET_NAME_LENGTH 12
  59 #define MAX_QEMU_PIPE_NAME_LENGTH  11
  60 #define MAX_UUID_LENGTH 64
  61
  62
  63 typedef void * RIL_Token;
  64
  65 typedef enum {
  66     RIL_SOCKET_1,
  67 #if (SIM_COUNT >= 2)
  68     RIL_SOCKET_2,
  69 #if (SIM_COUNT >= 3)
  70     RIL_SOCKET_3,
  71 #endif
  72 #if (SIM_COUNT >= 4)
  73     RIL_SOCKET_4,
  74 #endif
  75 #endif
  76     RIL_SOCKET_NUM
  77 } RIL_SOCKET_ID;
  78
  79
  80 typedef enum {
  81     RIL_E_SUCCESS = 0,
  82     RIL_E_RADIO_NOT_AVAILABLE = 1,     /* If radio did not start or is resetting */
  83     RIL_E_GENERIC_FAILURE = 2,
  84     RIL_E_PASSWORD_INCORRECT = 3,      /* for PIN/PIN2 methods only! */
  85     RIL_E_SIM_PIN2 = 4,                /* Operation requires SIM PIN2 to be entered */
  86     RIL_E_SIM_PUK2 = 5,                /* Operation requires SIM PIN2 to be entered */
  87     RIL_E_REQUEST_NOT_SUPPORTED = 6,
  88     RIL_E_CANCELLED = 7,
  89     RIL_E_OP_NOT_ALLOWED_DURING_VOICE_CALL = 8, /* data ops are not allowed during voice
  90                                                    call on a Class C GPRS device */
  91     RIL_E_OP_NOT_ALLOWED_BEFORE_REG_TO_NW = 9,  /* data ops are not allowed before device
  92                                                    registers in network */
  93     RIL_E_SMS_SEND_FAIL_RETRY = 10,             /* fail to send sms and need retry */
  94     RIL_E_SIM_ABSENT = 11,                      /* fail to set the location where CDMA subscription
  95                                                    shall be retrieved because of SIM or RUIM
  96                                                    card absent */
  97     RIL_E_SUBSCRIPTION_NOT_AVAILABLE = 12,      /* fail to find CDMA subscription from specified
  98                                                    location */
  99     RIL_E_MODE_NOT_SUPPORTED = 13,              /* HW does not support preferred network type */
 100     RIL_E_FDN_CHECK_FAILURE = 14,               /* command failed because recipient is not on FDN list */
 101     RIL_E_ILLEGAL_SIM_OR_ME = 15,               /* network selection failed due to
 102                                                    illegal SIM or ME */
 103     RIL_E_MISSING_RESOURCE = 16,                /* no logical channel available */
 104     RIL_E_NO_SUCH_ELEMENT = 17,                  /* application not found on SIM */
 105     RIL_E_DIAL_MODIFIED_TO_USSD = 18,           /* DIAL request modified to USSD */
 106     RIL_E_DIAL_MODIFIED_TO_SS = 19,             /* DIAL request modified to SS */
 107     RIL_E_DIAL_MODIFIED_TO_DIAL = 20,           /* DIAL request modified to DIAL with different
 108                                                    data */
 109     RIL_E_USSD_MODIFIED_TO_DIAL = 21,           /* USSD request modified to DIAL */
 110     RIL_E_USSD_MODIFIED_TO_SS = 22,             /* USSD request modified to SS */
 111     RIL_E_USSD_MODIFIED_TO_USSD = 23,           /* USSD request modified to different USSD
 112                                                    request */
 113     RIL_E_SS_MODIFIED_TO_DIAL = 24,             /* SS request modified to DIAL */
 114     RIL_E_SS_MODIFIED_TO_USSD = 25,             /* SS request modified to USSD */
 115     RIL_E_SUBSCRIPTION_NOT_SUPPORTED = 26,      /* Subscription not supported by RIL */
 116     RIL_E_SS_MODIFIED_TO_SS = 27,               /* SS request modified to different SS request */
 117     RIL_E_LCE_NOT_SUPPORTED = 36                /* LCE service not supported(36 in RILConstants.java) */
 118
 119
 120 } RIL_Errno;
 121
 122 typedef enum {
 123     RIL_CALL_ACTIVE = 0,
 124     RIL_CALL_HOLDING = 1,
 125     RIL_CALL_DIALING = 2,    /* MO call only */
 126     RIL_CALL_ALERTING = 3,   /* MO call only */
 127     RIL_CALL_INCOMING = 4,   /* MT call only */
 128     RIL_CALL_WAITING = 5     /* MT call only */
 129 } RIL_CallState;
 130
 131 typedef enum {
 132     RADIO_STATE_OFF = 0,                   /* Radio explictly powered off (eg CFUN=0) */
 133     RADIO_STATE_UNAVAILABLE = 1,           /* Radio unavailable (eg, resetting or not booted) */
 134     /* States 2-9 below are deprecated. Just leaving them here for backward compatibility. */
 135     RADIO_STATE_SIM_NOT_READY = 2,         /* Radio is on, but the SIM interface is not ready */
 136     RADIO_STATE_SIM_LOCKED_OR_ABSENT = 3,  /* SIM PIN locked, PUK required, network
 137                                               personalization locked, or SIM absent */
 138     RADIO_STATE_SIM_READY = 4,             /* Radio is on and SIM interface is available */
 139     RADIO_STATE_RUIM_NOT_READY = 5,        /* Radio is on, but the RUIM interface is not ready */
 140     RADIO_STATE_RUIM_READY = 6,            /* Radio is on and the RUIM interface is available */
 141     RADIO_STATE_RUIM_LOCKED_OR_ABSENT = 7, /* RUIM PIN locked, PUK required, network
 142                                               personalization locked, or RUIM absent */
 143     RADIO_STATE_NV_NOT_READY = 8,          /* Radio is on, but the NV interface is not available */
 144     RADIO_STATE_NV_READY = 9,              /* Radio is on and the NV interface is available */
 145     RADIO_STATE_ON = 10                    /* Radio is on */
 146 } RIL_RadioState;
 147
 148 typedef enum {
 149     RADIO_TECH_UNKNOWN = 0,
 150     RADIO_TECH_GPRS = 1,
 151     RADIO_TECH_EDGE = 2,
 152     RADIO_TECH_UMTS = 3,
 153     RADIO_TECH_IS95A = 4,
 154     RADIO_TECH_IS95B = 5,
 155     RADIO_TECH_1xRTT =  6,
 156     RADIO_TECH_EVDO_0 = 7,
 157     RADIO_TECH_EVDO_A = 8,
 158     RADIO_TECH_HSDPA = 9,
 159     RADIO_TECH_HSUPA = 10,
 160     RADIO_TECH_HSPA = 11,
 161     RADIO_TECH_EVDO_B = 12,
 162     RADIO_TECH_EHRPD = 13,
 163     RADIO_TECH_LTE = 14,
 164     RADIO_TECH_HSPAP = 15, // HSPA+
 165     RADIO_TECH_GSM = 16, // Only supports voice
 166     RADIO_TECH_TD_SCDMA = 17,
 167     RADIO_TECH_IWLAN = 18
 168 } RIL_RadioTechnology;
 169
 170 typedef enum {
 171     RAF_UNKNOWN =  (1 <<  RADIO_TECH_UNKNOWN),
 172     RAF_GPRS = (1 << RADIO_TECH_GPRS),
 173     RAF_EDGE = (1 << RADIO_TECH_EDGE),
 174     RAF_UMTS = (1 << RADIO_TECH_UMTS),
 175     RAF_IS95A = (1 << RADIO_TECH_IS95A),
 176     RAF_IS95B = (1 << RADIO_TECH_IS95B),
 177     RAF_1xRTT = (1 << RADIO_TECH_1xRTT),
 178     RAF_EVDO_0 = (1 << RADIO_TECH_EVDO_0),
 179     RAF_EVDO_A = (1 << RADIO_TECH_EVDO_A),
 180     RAF_HSDPA = (1 << RADIO_TECH_HSDPA),
 181     RAF_HSUPA = (1 << RADIO_TECH_HSUPA),
 182     RAF_HSPA = (1 << RADIO_TECH_HSPA),
 183     RAF_EVDO_B = (1 << RADIO_TECH_EVDO_B),
 184     RAF_EHRPD = (1 << RADIO_TECH_EHRPD),
 185     RAF_LTE = (1 << RADIO_TECH_LTE),
 186     RAF_HSPAP = (1 << RADIO_TECH_HSPAP),
 187     RAF_GSM = (1 << RADIO_TECH_GSM),
 188     RAF_TD_SCDMA = (1 << RADIO_TECH_TD_SCDMA),
 189 } RIL_RadioAccessFamily;
 190
 191 typedef enum {
 192     RC_PHASE_CONFIGURED = 0,  // LM is configured is initial value and value after FINISH completes
 193     RC_PHASE_START      = 1,  // START is sent before Apply and indicates that an APPLY will be
 194                               // forthcoming with these same parameters
 195     RC_PHASE_APPLY      = 2,  // APPLY is sent after all LM's receive START and returned
 196                               // RIL_RadioCapability.status = 0, if any START's fail no
 197                               // APPLY will be sent
 198     RC_PHASE_UNSOL_RSP  = 3,  // UNSOL_RSP is sent with RIL_UNSOL_RADIO_CAPABILITY
 199     RC_PHASE_FINISH     = 4   // FINISH is sent after all commands have completed. If an error
 200                               // occurs in any previous command the RIL_RadioAccessesFamily and
 201                               // logicalModemUuid fields will be the prior configuration thus
 202                               // restoring the configuration to the previous value. An error
 203                               // returned by this command will generally be ignored or may
 204                               // cause that logical modem to be removed from service.
 205 } RadioCapabilityPhase;
 206
 207 typedef enum {
 208     RC_STATUS_NONE       = 0, // This parameter has no meaning with RC_PHASE_START,
 209                               // RC_PHASE_APPLY
 210     RC_STATUS_SUCCESS    = 1, // Tell modem the action transaction of set radio
 211                               // capability was success with RC_PHASE_FINISH
 212     RC_STATUS_FAIL       = 2, // Tell modem the action transaction of set radio
 213                               // capability is fail with RC_PHASE_FINISH.
 214 } RadioCapabilityStatus;
 215
 216 #define RIL_RADIO_CAPABILITY_VERSION 1
 217 typedef struct {
 218     int version;            // Version of structure, RIL_RADIO_CAPABILITY_VERSION
 219     int session;            // Unique session value defined by framework returned in all "responses/unsol"
 220     int phase;              // CONFIGURED, START, APPLY, FINISH
 221     int rat;                // RIL_RadioAccessFamily for the radio
 222     char logicalModemUuid[MAX_UUID_LENGTH]; // A UUID typically "com.xxxx.lmX where X is the logical modem.
 223     int status;             // Return status and an input parameter for RC_PHASE_FINISH
 224 } RIL_RadioCapability;
 225
 226 // Do we want to split Data from Voice and the use
 227 // RIL_RadioTechnology for get/setPreferredVoice/Data ?
 228 typedef enum {
 229     PREF_NET_TYPE_GSM_WCDMA                = 0, /* GSM/WCDMA (WCDMA preferred) */
 230     PREF_NET_TYPE_GSM_ONLY                 = 1, /* GSM only */
 231     PREF_NET_TYPE_WCDMA                    = 2, /* WCDMA  */
 232     PREF_NET_TYPE_GSM_WCDMA_AUTO           = 3, /* GSM/WCDMA (auto mode, according to PRL) */
 233     PREF_NET_TYPE_CDMA_EVDO_AUTO           = 4, /* CDMA and EvDo (auto mode, according to PRL) */
 234     PREF_NET_TYPE_CDMA_ONLY                = 5, /* CDMA only */
 235     PREF_NET_TYPE_EVDO_ONLY                = 6, /* EvDo only */
 236     PREF_NET_TYPE_GSM_WCDMA_CDMA_EVDO_AUTO = 7, /* GSM/WCDMA, CDMA, and EvDo (auto mode, according to PRL) */
 237     PREF_NET_TYPE_LTE_CDMA_EVDO            = 8, /* LTE, CDMA and EvDo */
 238     PREF_NET_TYPE_LTE_GSM_WCDMA            = 9, /* LTE, GSM/WCDMA */
 239     PREF_NET_TYPE_LTE_CMDA_EVDO_GSM_WCDMA  = 10, /* LTE, CDMA, EvDo, GSM/WCDMA */
 240     PREF_NET_TYPE_LTE_ONLY                 = 11, /* LTE only */
 241     PREF_NET_TYPE_LTE_WCDMA                = 12  /* LTE/WCDMA */
 242 } RIL_PreferredNetworkType;
 243
 244 /* Source for cdma subscription */
 245 typedef enum {
 246    CDMA_SUBSCRIPTION_SOURCE_RUIM_SIM = 0,
 247    CDMA_SUBSCRIPTION_SOURCE_NV = 1
 248 } RIL_CdmaSubscriptionSource;
 249
 250 /* User-to-User signaling Info activation types derived from 3GPP 23.087 v8.0 */
 251 typedef enum {
 252     RIL_UUS_TYPE1_IMPLICIT = 0,
 253     RIL_UUS_TYPE1_REQUIRED = 1,
 254     RIL_UUS_TYPE1_NOT_REQUIRED = 2,
 255     RIL_UUS_TYPE2_REQUIRED = 3,
 256     RIL_UUS_TYPE2_NOT_REQUIRED = 4,
 257     RIL_UUS_TYPE3_REQUIRED = 5,
 258     RIL_UUS_TYPE3_NOT_REQUIRED = 6
 259 } RIL_UUS_Type;
 260
 261 /* User-to-User Signaling Information data coding schemes. Possible values for
 262  * Octet 3 (Protocol Discriminator field) in the UUIE. The values have been
 263  * specified in section 10.5.4.25 of 3GPP TS 24.008 */
 264 typedef enum {
 265     RIL_UUS_DCS_USP = 0,          /* User specified protocol */
 266     RIL_UUS_DCS_OSIHLP = 1,       /* OSI higher layer protocol */
 267     RIL_UUS_DCS_X244 = 2,         /* X.244 */
 268     RIL_UUS_DCS_RMCF = 3,         /* Reserved for system mangement
 269                                      convergence function */
 270     RIL_UUS_DCS_IA5c = 4          /* IA5 characters */
 271 } RIL_UUS_DCS;
 272
 273 /* User-to-User Signaling Information defined in 3GPP 23.087 v8.0
 274  * This data is passed in RIL_ExtensionRecord and rec contains this
 275  * structure when type is RIL_UUS_INFO_EXT_REC */
 276 typedef struct {
 277   RIL_UUS_Type    uusType;    /* UUS Type */
 278   RIL_UUS_DCS     uusDcs;     /* UUS Data Coding Scheme */
 279   int             uusLength;  /* Length of UUS Data */
 280   char *          uusData;    /* UUS Data */
 281 } RIL_UUS_Info;
 282
 283 /* CDMA Signal Information Record as defined in C.S0005 section 3.7.5.5 */
 284 typedef struct {
 285   char isPresent;    /* non-zero if signal information record is present */
 286   char signalType;   /* as defined 3.7.5.5-1 */
 287   char alertPitch;   /* as defined 3.7.5.5-2 */
 288   char signal;       /* as defined 3.7.5.5-3, 3.7.5.5-4 or 3.7.5.5-5 */
 289 } RIL_CDMA_SignalInfoRecord;
 290
 291 typedef struct {
 292     RIL_CallState   state;
 293     int             index;      /* Connection Index for use with, eg, AT+CHLD */
 294     int             toa;        /* type of address, eg 145 = intl */
 295     char            isMpty;     /* nonzero if is mpty call */
 296     char            isMT;       /* nonzero if call is mobile terminated */
 297     char            als;        /* ALS line indicator if available
 298                                    (0 = line 1) */
 299     char            isVoice;    /* nonzero if this is is a voice call */
 300     char            isVoicePrivacy;     /* nonzero if CDMA voice privacy mode is active */
 301     char *          number;     /* Remote party number */
 302     int             numberPresentation; /* 0=Allowed, 1=Restricted, 2=Not Specified/Unknown 3=Payphone */
 303     char *          name;       /* Remote party name */
 304     int             namePresentation; /* 0=Allowed, 1=Restricted, 2=Not Specified/Unknown 3=Payphone */
 305     RIL_UUS_Info *  uusInfo;    /* NULL or Pointer to User-User Signaling Information */
 306 } RIL_Call;
 307
 308 /* Deprecated, use RIL_Data_Call_Response_v6 */
 309 typedef struct {
 310     int             cid;        /* Context ID, uniquely identifies this call */
 311     int             active;     /* 0=inactive, 1=active/physical link down, 2=active/physical link up */
 312     char *          type;       /* One of the PDP_type values in TS 27.007 section 10.1.1.
 313                                    For example, "IP", "IPV6", "IPV4V6", or "PPP". */
 314     char *          apn;        /* ignored */
 315     char *          address;    /* An address, e.g., "192.0.1.3" or "2001:db8::1". */
 316 } RIL_Data_Call_Response_v4;
 317
 318 /*
 319  * Returned by RIL_REQUEST_SETUP_DATA_CALL, RIL_REQUEST_DATA_CALL_LIST
 320  * and RIL_UNSOL_DATA_CALL_LIST_CHANGED, on error status != 0.
 321  */
 322 typedef struct {
 323     int             status;     /* A RIL_DataCallFailCause, 0 which is PDP_FAIL_NONE if no error */
 324     int             suggestedRetryTime; /* If status != 0, this fields indicates the suggested retry
 325                                            back-off timer value RIL wants to override the one
 326                                            pre-configured in FW.
 327                                            The unit is miliseconds.
 328                                            The value < 0 means no value is suggested.
 329                                            The value 0 means retry should be done ASAP.
 330                                            The value of INT_MAX(0x7fffffff) means no retry. */
 331     int             cid;        /* Context ID, uniquely identifies this call */
 332     int             active;     /* 0=inactive, 1=active/physical link down, 2=active/physical link up */
 333     char *          type;       /* One of the PDP_type values in TS 27.007 section 10.1.1.
 334                                    For example, "IP", "IPV6", "IPV4V6", or "PPP". If status is
 335                                    PDP_FAIL_ONLY_SINGLE_BEARER_ALLOWED this is the type supported
 336                                    such as "IP" or "IPV6" */
 337     char *          ifname;     /* The network interface name */
 338     char *          addresses;  /* A space-delimited list of addresses with optional "/" prefix length,
 339                                    e.g., "192.0.1.3" or "192.0.1.11/16 2001:db8::1/64".
 340                                    May not be empty, typically 1 IPv4 or 1 IPv6 or
 341                                    one of each. If the prefix length is absent the addresses
 342                                    are assumed to be point to point with IPv4 having a prefix
 343                                    length of 32 and IPv6 128. */
 344     char *          dnses;      /* A space-delimited list of DNS server addresses,
 345                                    e.g., "192.0.1.3" or "192.0.1.11 2001:db8::1".
 346                                    May be empty. */
 347     char *          gateways;   /* A space-delimited list of default gateway addresses,
 348                                    e.g., "192.0.1.3" or "192.0.1.11 2001:db8::1".
 349                                    May be empty in which case the addresses represent point
 350                                    to point connections. */
 351 } RIL_Data_Call_Response_v6;
 352
 353 typedef struct {
 354     int             status;     /* A RIL_DataCallFailCause, 0 which is PDP_FAIL_NONE if no error */
 355     int             suggestedRetryTime; /* If status != 0, this fields indicates the suggested retry
 356                                            back-off timer value RIL wants to override the one
 357                                            pre-configured in FW.
 358                                            The unit is miliseconds.
 359                                            The value < 0 means no value is suggested.
 360                                            The value 0 means retry should be done ASAP.
 361                                            The value of INT_MAX(0x7fffffff) means no retry. */
 362     int             cid;        /* Context ID, uniquely identifies this call */
 363     int             active;     /* 0=inactive, 1=active/physical link down, 2=active/physical link up */
 364     char *          type;       /* One of the PDP_type values in TS 27.007 section 10.1.1.
 365                                    For example, "IP", "IPV6", "IPV4V6", or "PPP". If status is
 366                                    PDP_FAIL_ONLY_SINGLE_BEARER_ALLOWED this is the type supported
 367                                    such as "IP" or "IPV6" */
 368     char *          ifname;     /* The network interface name */
 369     char *          addresses;  /* A space-delimited list of addresses with optional "/" prefix length,
 370                                    e.g., "192.0.1.3" or "192.0.1.11/16 2001:db8::1/64".
 371                                    May not be empty, typically 1 IPv4 or 1 IPv6 or
 372                                    one of each. If the prefix length is absent the addresses
 373                                    are assumed to be point to point with IPv4 having a prefix
 374                                    length of 32 and IPv6 128. */
 375     char *          dnses;      /* A space-delimited list of DNS server addresses,
 376                                    e.g., "192.0.1.3" or "192.0.1.11 2001:db8::1".
 377                                    May be empty. */
 378     char *          gateways;   /* A space-delimited list of default gateway addresses,
 379                                    e.g., "192.0.1.3" or "192.0.1.11 2001:db8::1".
 380                                    May be empty in which case the addresses represent point
 381                                    to point connections. */
 382     char *          pcscf;    /* the Proxy Call State Control Function address
 383                                  via PCO(Protocol Configuration Option) for IMS client. */
 384 } RIL_Data_Call_Response_v9;
 385
 386 typedef struct {
 387     int             status;     /* A RIL_DataCallFailCause, 0 which is PDP_FAIL_NONE if no error */
 388     int             suggestedRetryTime; /* If status != 0, this fields indicates the suggested retry
 389                                            back-off timer value RIL wants to override the one
 390                                            pre-configured in FW.
 391                                            The unit is miliseconds.
 392                                            The value < 0 means no value is suggested.
 393                                            The value 0 means retry should be done ASAP.
 394                                            The value of INT_MAX(0x7fffffff) means no retry. */
 395     int             cid;        /* Context ID, uniquely identifies this call */
 396     int             active;     /* 0=inactive, 1=active/physical link down, 2=active/physical link up */
 397     char *          type;       /* One of the PDP_type values in TS 27.007 section 10.1.1.
 398                                    For example, "IP", "IPV6", "IPV4V6", or "PPP". If status is
 399                                    PDP_FAIL_ONLY_SINGLE_BEARER_ALLOWED this is the type supported
 400                                    such as "IP" or "IPV6" */
 401     char *          ifname;     /* The network interface name */
 402     char *          addresses;  /* A space-delimited list of addresses with optional "/" prefix length,
 403                                    e.g., "192.0.1.3" or "192.0.1.11/16 2001:db8::1/64".
 404                                    May not be empty, typically 1 IPv4 or 1 IPv6 or
 405                                    one of each. If the prefix length is absent the addresses
 406                                    are assumed to be point to point with IPv4 having a prefix
 407                                    length of 32 and IPv6 128. */
 408     char *          dnses;      /* A space-delimited list of DNS server addresses,
 409                                    e.g., "192.0.1.3" or "192.0.1.11 2001:db8::1".
 410                                    May be empty. */
 411     char *          gateways;   /* A space-delimited list of default gateway addresses,
 412                                    e.g., "192.0.1.3" or "192.0.1.11 2001:db8::1".
 413                                    May be empty in which case the addresses represent point
 414                                    to point connections. */
 415     char *          pcscf;    /* the Proxy Call State Control Function address
 416                                  via PCO(Protocol Configuration Option) for IMS client. */
 417     int             mtu;        /* MTU received from network
 418                                    Value <= 0 means network has either not sent a value or
 419                                    sent an invalid value */
 420 } RIL_Data_Call_Response_v11;
 421
 422 typedef enum {
 423     RADIO_TECH_3GPP = 1, /* 3GPP Technologies - GSM, WCDMA */
 424     RADIO_TECH_3GPP2 = 2 /* 3GPP2 Technologies - CDMA */
 425 } RIL_RadioTechnologyFamily;
 426
 427 typedef struct {
 428     RIL_RadioTechnologyFamily tech;
 429     unsigned char             retry;       /* 0 == not retry, nonzero == retry */
 430     int                       messageRef;  /* Valid field if retry is set to nonzero.
 431                                               Contains messageRef from RIL_SMS_Response
 432                                               corresponding to failed MO SMS.
 433                                             */
 434
 435     union {
 436         /* Valid field if tech is RADIO_TECH_3GPP2. See RIL_REQUEST_CDMA_SEND_SMS */
 437         RIL_CDMA_SMS_Message* cdmaMessage;
 438
 439         /* Valid field if tech is RADIO_TECH_3GPP. See RIL_REQUEST_SEND_SMS */
 440         char**                gsmMessage;
 441     } message;
 442 } RIL_IMS_SMS_Message;
 443
 444 typedef struct {
 445     int messageRef;   /* TP-Message-Reference for GSM,
 446                          and BearerData MessageId for CDMA
 447                          (See 3GPP2 C.S0015-B, v2.0, table 4.5-1). */
 448     char *ackPDU;     /* or NULL if n/a */
 449     int errorCode;    /* See 3GPP 27.005, 3.2.5 for GSM/UMTS,
 450                          3GPP2 N.S0005 (IS-41C) Table 171 for CDMA,
 451                          -1 if unknown or not applicable*/
 452 } RIL_SMS_Response;
 453
 454 /** Used by RIL_REQUEST_WRITE_SMS_TO_SIM */
 455 typedef struct {
 456     int status;     /* Status of message.  See TS 27.005 3.1, "<stat>": */
 457                     /*      0 = "REC UNREAD"    */
 458                     /*      1 = "REC READ"      */
 459                     /*      2 = "STO UNSENT"    */
 460                     /*      3 = "STO SENT"      */
 461     char * pdu;     /* PDU of message to write, as an ASCII hex string less the SMSC address,
 462                        the TP-layer length is "strlen(pdu)/2". */
 463     char * smsc;    /* SMSC address in GSM BCD format prefixed by a length byte
 464                        (as expected by TS 27.005) or NULL for default SMSC */
 465 } RIL_SMS_WriteArgs;
 466
 467 /** Used by RIL_REQUEST_DIAL */
 468 typedef struct {
 469     char * address;
 470     int clir;
 471             /* (same as 'n' paremeter in TS 27.007 7.7 "+CLIR"
 472              * clir == 0 on "use subscription default value"
 473              * clir == 1 on "CLIR invocation" (restrict CLI presentation)
 474              * clir == 2 on "CLIR suppression" (allow CLI presentation)
 475              */
 476     RIL_UUS_Info *  uusInfo;    /* NULL or Pointer to User-User Signaling Information */
 477 } RIL_Dial;
 478
 479 typedef struct {
 480     int command;    /* one of the commands listed for TS 27.007 +CRSM*/
 481     int fileid;     /* EF id */
 482     char *path;     /* "pathid" from TS 27.007 +CRSM command.
 483                        Path is in hex asciii format eg "7f205f70"
 484                        Path must always be provided.
 485                      */
 486     int p1;
 487     int p2;
 488     int p3;
 489     char *data;     /* May be NULL*/
 490     char *pin2;     /* May be NULL*/
 491 } RIL_SIM_IO_v5;
 492
 493 typedef struct {
 494     int command;    /* one of the commands listed for TS 27.007 +CRSM*/
 495     int fileid;     /* EF id */
 496     char *path;     /* "pathid" from TS 27.007 +CRSM command.
 497                        Path is in hex asciii format eg "7f205f70"
 498                        Path must always be provided.
 499                      */
 500     int p1;
 501     int p2;
 502     int p3;
 503     char *data;     /* May be NULL*/
 504     char *pin2;     /* May be NULL*/
 505     char *aidPtr;   /* AID value, See ETSI 102.221 8.1 and 101.220 4, NULL if no value. */
 506 } RIL_SIM_IO_v6;
 507
 508 /* Used by RIL_REQUEST_SIM_TRANSMIT_APDU_CHANNEL and
 509  * RIL_REQUEST_SIM_TRANSMIT_APDU_BASIC. */
 510 typedef struct {
 511     int sessionid;  /* "sessionid" from TS 27.007 +CGLA command. Should be
 512                        ignored for +CSIM command. */
 513
 514     /* Following fields are used to derive the APDU ("command" and "length"
 515        values in TS 27.007 +CSIM and +CGLA commands). */
 516     int cla;
 517     int instruction;
 518     int p1;
 519     int p2;
 520     int p3;         /* A negative P3 implies a 4 byte APDU. */
 521     char *data;     /* May be NULL. In hex string format. */
 522 } RIL_SIM_APDU;
 523
 524 typedef struct {
 525     int sw1;
 526     int sw2;
 527     char *simResponse;  /* In hex string format ([a-fA-F0-9]*), except for SIM_AUTHENTICATION
 528                            response for which it is in Base64 format, see 3GPP TS 31.102 7.1.2 */
 529 } RIL_SIM_IO_Response;
 530
 531 /* See also com.android.internal.telephony.gsm.CallForwardInfo */
 532
 533 typedef struct {
 534     int             status;     /*
 535                                  * For RIL_REQUEST_QUERY_CALL_FORWARD_STATUS
 536                                  * status 1 = active, 0 = not active
 537                                  *
 538                                  * For RIL_REQUEST_SET_CALL_FORWARD:
 539                                  * status is:
 540                                  * 0 = disable
 541                                  * 1 = enable
 542                                  * 2 = interrogate
 543                                  * 3 = registeration
 544                                  * 4 = erasure
 545                                  */
 546
 547     int             reason;      /* from TS 27.007 7.11 "reason" */
 548     int             serviceClass;/* From 27.007 +CCFC/+CLCK "class"
 549                                     See table for Android mapping from
 550                                     MMI service code
 551                                     0 means user doesn't input class */
 552     int             toa;         /* "type" from TS 27.007 7.11 */
 553     char *          number;      /* "number" from TS 27.007 7.11. May be NULL */
 554     int             timeSeconds; /* for CF no reply only */
 555 }RIL_CallForwardInfo;
 556
 557 typedef struct {
 558    char * cid;         /* Combination of LAC and Cell Id in 32 bits in GSM.
 559                         * Upper 16 bits is LAC and lower 16 bits
 560                         * is CID (as described in TS 27.005)
 561                         * Primary Scrambling Code (as described in TS 25.331)
 562                         *         in 9 bits in UMTS
 563                         * Valid values are hexadecimal 0x0000 - 0xffffffff.
 564                         */
 565    int    rssi;        /* Received RSSI in GSM,
 566                         * Level index of CPICH Received Signal Code Power in UMTS
 567                         */
 568 } RIL_NeighboringCell;
 569
 570 typedef struct {
 571   char lce_status;                 /* LCE service status:
 572                                     * -1 = not supported;
 573                                     * 0 = stopped;
 574                                     * 1 = active.
 575                                     */
 576   unsigned int actual_interval_ms; /* actual LCE reporting interval,
 577                                     * meaningful only if LCEStatus = 1.
 578                                     */
 579 } RIL_LceStatusInfo;
 580
 581 typedef struct {
 582   unsigned int last_hop_capacity_kbps; /* last-hop cellular capacity: bytes/second. */
 583   unsigned char confidence_level;      /* capacity estimate confidence: 0-100 */
 584   unsigned char lce_suspended;         /* LCE report going to be suspended? (e.g., radio
 585                                         * moves to inactive state or network type change)
 586                                         * 1 = suspended;
 587                                         * 0 = not suspended.
 588                                         */
 589 } RIL_LceDataInfo;
 590
 591 /* See RIL_REQUEST_LAST_CALL_FAIL_CAUSE */
 592 typedef enum {
 593     CALL_FAIL_UNOBTAINABLE_NUMBER = 1,
 594     CALL_FAIL_NORMAL = 16,
 595     CALL_FAIL_BUSY = 17,
 596     CALL_FAIL_CONGESTION = 34,
 597     CALL_FAIL_ACM_LIMIT_EXCEEDED = 68,
 598     CALL_FAIL_CALL_BARRED = 240,
 599     CALL_FAIL_FDN_BLOCKED = 241,
 600     CALL_FAIL_IMSI_UNKNOWN_IN_VLR = 242,
 601     CALL_FAIL_IMEI_NOT_ACCEPTED = 243,
 602     CALL_FAIL_DIAL_MODIFIED_TO_USSD = 244, /* STK Call Control */
 603     CALL_FAIL_DIAL_MODIFIED_TO_SS = 245,
 604     CALL_FAIL_DIAL_MODIFIED_TO_DIAL = 246,
 605     CALL_FAIL_CDMA_LOCKED_UNTIL_POWER_CYCLE = 1000,
 606     CALL_FAIL_CDMA_DROP = 1001,
 607     CALL_FAIL_CDMA_INTERCEPT = 1002,
 608     CALL_FAIL_CDMA_REORDER = 1003,
 609     CALL_FAIL_CDMA_SO_REJECT = 1004,
 610     CALL_FAIL_CDMA_RETRY_ORDER = 1005,
 611     CALL_FAIL_CDMA_ACCESS_FAILURE = 1006,
 612     CALL_FAIL_CDMA_PREEMPTED = 1007,
 613     CALL_FAIL_CDMA_NOT_EMERGENCY = 1008, /* For non-emergency number dialed
 614                                             during emergency callback mode */
 615     CALL_FAIL_CDMA_ACCESS_BLOCKED = 1009, /* CDMA network access probes blocked */
 616     CALL_FAIL_ERROR_UNSPECIFIED = 0xffff
 617 } RIL_LastCallFailCause;
 618
 619 /* See RIL_REQUEST_LAST_DATA_CALL_FAIL_CAUSE */
 620 typedef enum {
 621     PDP_FAIL_NONE = 0, /* No error, connection ok */
 622
 623     /* an integer cause code defined in TS 24.008
 624        section 6.1.3.1.3 or TS 24.301 Release 8+ Annex B.
 625        If the implementation does not have access to the exact cause codes,
 626        then it should return one of the following values,
 627        as the UI layer needs to distinguish these
 628        cases for error notification and potential retries. */
 629     PDP_FAIL_OPERATOR_BARRED = 0x08,               /* no retry */
 630     PDP_FAIL_INSUFFICIENT_RESOURCES = 0x1A,
 631     PDP_FAIL_MISSING_UKNOWN_APN = 0x1B,            /* no retry */
 632     PDP_FAIL_UNKNOWN_PDP_ADDRESS_TYPE = 0x1C,      /* no retry */
 633     PDP_FAIL_USER_AUTHENTICATION = 0x1D,           /* no retry */
 634     PDP_FAIL_ACTIVATION_REJECT_GGSN = 0x1E,        /* no retry */
 635     PDP_FAIL_ACTIVATION_REJECT_UNSPECIFIED = 0x1F,
 636     PDP_FAIL_SERVICE_OPTION_NOT_SUPPORTED = 0x20,  /* no retry */
 637     PDP_FAIL_SERVICE_OPTION_NOT_SUBSCRIBED = 0x21, /* no retry */
 638     PDP_FAIL_SERVICE_OPTION_OUT_OF_ORDER = 0x22,
 639     PDP_FAIL_NSAPI_IN_USE = 0x23,                  /* no retry */
 640     PDP_FAIL_REGULAR_DEACTIVATION = 0x24,          /* possibly restart radio,
 641                                                       based on framework config */
 642     PDP_FAIL_ONLY_IPV4_ALLOWED = 0x32,             /* no retry */
 643     PDP_FAIL_ONLY_IPV6_ALLOWED = 0x33,             /* no retry */
 644     PDP_FAIL_ONLY_SINGLE_BEARER_ALLOWED = 0x34,
 645     PDP_FAIL_PROTOCOL_ERRORS   = 0x6F,             /* no retry */
 646
 647     /* Not mentioned in the specification */
 648     PDP_FAIL_VOICE_REGISTRATION_FAIL = -1,
 649     PDP_FAIL_DATA_REGISTRATION_FAIL = -2,
 650
 651    /* reasons for data call drop - network/modem disconnect */
 652     PDP_FAIL_SIGNAL_LOST = -3,
 653     PDP_FAIL_PREF_RADIO_TECH_CHANGED = -4,/* preferred technology has changed, should retry
 654                                              with parameters appropriate for new technology */
 655     PDP_FAIL_RADIO_POWER_OFF = -5,        /* data call was disconnected because radio was resetting,
 656                                              powered off - no retry */
 657     PDP_FAIL_TETHERED_CALL_ACTIVE = -6,   /* data call was disconnected by modem because tethered
 658                                              mode was up on same APN/data profile - no retry until
 659                                              tethered call is off */
 660
 661     PDP_FAIL_ERROR_UNSPECIFIED = 0xffff,  /* retry silently */
 662 } RIL_DataCallFailCause;
 663
 664 /* See RIL_REQUEST_SETUP_DATA_CALL */
 665 typedef enum {
 666     RIL_DATA_PROFILE_DEFAULT    = 0,
 667     RIL_DATA_PROFILE_TETHERED   = 1,
 668     RIL_DATA_PROFILE_IMS        = 2,
 669     RIL_DATA_PROFILE_FOTA       = 3,
 670     RIL_DATA_PROFILE_CBS        = 4,
 671     RIL_DATA_PROFILE_OEM_BASE   = 1000,    /* Start of OEM-specific profiles */
 672     RIL_DATA_PROFILE_INVALID    = 0xFFFFFFFF
 673 } RIL_DataProfile;
 674
 675 /* Used by RIL_UNSOL_SUPP_SVC_NOTIFICATION */
 676 typedef struct {
 677     int     notificationType;   /*
 678                                  * 0 = MO intermediate result code
 679                                  * 1 = MT unsolicited result code
 680                                  */
 681     int     code;               /* See 27.007 7.17
 682                                    "code1" for MO
 683                                    "code2" for MT. */
 684     int     index;              /* CUG index. See 27.007 7.17. */
 685     int     type;               /* "type" from 27.007 7.17 (MT only). */
 686     char *  number;             /* "number" from 27.007 7.17
 687                                    (MT only, may be NULL). */
 688 } RIL_SuppSvcNotification;
 689
 690 #define RIL_CARD_MAX_APPS     8
 691
 692 typedef enum {
 693     RIL_CARDSTATE_ABSENT   = 0,
 694     RIL_CARDSTATE_PRESENT  = 1,
 695     RIL_CARDSTATE_ERROR    = 2
 696 } RIL_CardState;
 697
 698 typedef enum {
 699     RIL_PERSOSUBSTATE_UNKNOWN                   = 0, /* initial state */
 700     RIL_PERSOSUBSTATE_IN_PROGRESS               = 1, /* in between each lock transition */
 701     RIL_PERSOSUBSTATE_READY                     = 2, /* when either SIM or RUIM Perso is finished
 702                                                         since each app can only have 1 active perso
 703                                                         involved */
 704     RIL_PERSOSUBSTATE_SIM_NETWORK               = 3,
 705     RIL_PERSOSUBSTATE_SIM_NETWORK_SUBSET        = 4,
 706     RIL_PERSOSUBSTATE_SIM_CORPORATE             = 5,
 707     RIL_PERSOSUBSTATE_SIM_SERVICE_PROVIDER      = 6,
 708     RIL_PERSOSUBSTATE_SIM_SIM                   = 7,
 709     RIL_PERSOSUBSTATE_SIM_NETWORK_PUK           = 8, /* The corresponding perso lock is blocked */
 710     RIL_PERSOSUBSTATE_SIM_NETWORK_SUBSET_PUK    = 9,
 711     RIL_PERSOSUBSTATE_SIM_CORPORATE_PUK         = 10,
 712     RIL_PERSOSUBSTATE_SIM_SERVICE_PROVIDER_PUK  = 11,
 713     RIL_PERSOSUBSTATE_SIM_SIM_PUK               = 12,
 714     RIL_PERSOSUBSTATE_RUIM_NETWORK1             = 13,
 715     RIL_PERSOSUBSTATE_RUIM_NETWORK2             = 14,
 716     RIL_PERSOSUBSTATE_RUIM_HRPD                 = 15,
 717     RIL_PERSOSUBSTATE_RUIM_CORPORATE            = 16,
 718     RIL_PERSOSUBSTATE_RUIM_SERVICE_PROVIDER     = 17,
 719     RIL_PERSOSUBSTATE_RUIM_RUIM                 = 18,
 720     RIL_PERSOSUBSTATE_RUIM_NETWORK1_PUK         = 19, /* The corresponding perso lock is blocked */
 721     RIL_PERSOSUBSTATE_RUIM_NETWORK2_PUK         = 20,
 722     RIL_PERSOSUBSTATE_RUIM_HRPD_PUK             = 21,
 723     RIL_PERSOSUBSTATE_RUIM_CORPORATE_PUK        = 22,
 724     RIL_PERSOSUBSTATE_RUIM_SERVICE_PROVIDER_PUK = 23,
 725     RIL_PERSOSUBSTATE_RUIM_RUIM_PUK             = 24
 726 } RIL_PersoSubstate;
 727
 728 typedef enum {
 729     RIL_APPSTATE_UNKNOWN               = 0,
 730     RIL_APPSTATE_DETECTED              = 1,
 731     RIL_APPSTATE_PIN                   = 2, /* If PIN1 or UPin is required */
 732     RIL_APPSTATE_PUK                   = 3, /* If PUK1 or Puk for UPin is required */
 733     RIL_APPSTATE_SUBSCRIPTION_PERSO    = 4, /* perso_substate should be look at
 734                                                when app_state is assigned to this value */
 735     RIL_APPSTATE_READY                 = 5
 736 } RIL_AppState;
 737
 738 typedef enum {
 739     RIL_PINSTATE_UNKNOWN              = 0,
 740     RIL_PINSTATE_ENABLED_NOT_VERIFIED = 1,
 741     RIL_PINSTATE_ENABLED_VERIFIED     = 2,
 742     RIL_PINSTATE_DISABLED             = 3,
 743     RIL_PINSTATE_ENABLED_BLOCKED      = 4,
 744     RIL_PINSTATE_ENABLED_PERM_BLOCKED = 5
 745 } RIL_PinState;
 746
 747 typedef enum {
 748   RIL_APPTYPE_UNKNOWN = 0,
 749   RIL_APPTYPE_SIM     = 1,
 750   RIL_APPTYPE_USIM    = 2,
 751   RIL_APPTYPE_RUIM    = 3,
 752   RIL_APPTYPE_CSIM    = 4,
 753   RIL_APPTYPE_ISIM    = 5
 754 } RIL_AppType;
 755
 756 typedef struct
 757 {
 758   RIL_AppType      app_type;
 759   RIL_AppState     app_state;
 760   RIL_PersoSubstate perso_substate; /* applicable only if app_state ==
 761                                        RIL_APPSTATE_SUBSCRIPTION_PERSO */
 762   char             *aid_ptr;        /* null terminated string, e.g., from 0xA0, 0x00 -> 0x41,
 763                                        0x30, 0x30, 0x30 */
 764   char             *app_label_ptr;  /* null terminated string */
 765   int              pin1_replaced;   /* applicable to USIM, CSIM & ISIM */
 766   RIL_PinState     pin1;
 767   RIL_PinState     pin2;
 768 } RIL_AppStatus;
 769
 770 /* Deprecated, use RIL_CardStatus_v6 */
 771 typedef struct
 772 {
 773   RIL_CardState card_state;
 774   RIL_PinState  universal_pin_state;             /* applicable to USIM and CSIM: RIL_PINSTATE_xxx */
 775   int           gsm_umts_subscription_app_index; /* value < RIL_CARD_MAX_APPS, -1 if none */
 776   int           cdma_subscription_app_index;     /* value < RIL_CARD_MAX_APPS, -1 if none */
 777   int           num_applications;                /* value <= RIL_CARD_MAX_APPS */
 778   RIL_AppStatus applications[RIL_CARD_MAX_APPS];
 779 } RIL_CardStatus_v5;
 780
 781 typedef struct
 782 {
 783   RIL_CardState card_state;
 784   RIL_PinState  universal_pin_state;             /* applicable to USIM and CSIM: RIL_PINSTATE_xxx */
 785   int           gsm_umts_subscription_app_index; /* value < RIL_CARD_MAX_APPS, -1 if none */
 786   int           cdma_subscription_app_index;     /* value < RIL_CARD_MAX_APPS, -1 if none */
 787   int           ims_subscription_app_index;      /* value < RIL_CARD_MAX_APPS, -1 if none */
 788   int           num_applications;                /* value <= RIL_CARD_MAX_APPS */
 789   RIL_AppStatus applications[RIL_CARD_MAX_APPS];
 790 } RIL_CardStatus_v6;
 791
 792 /** The result of a SIM refresh, returned in data[0] of RIL_UNSOL_SIM_REFRESH
 793  *      or as part of RIL_SimRefreshResponse_v7
 794  */
 795 typedef enum {
 796     /* A file on SIM has been updated.  data[1] contains the EFID. */
 797     SIM_FILE_UPDATE = 0,
 798     /* SIM initialized.  All files should be re-read. */
 799     SIM_INIT = 1,
 800     /* SIM reset.  SIM power required, SIM may be locked and all files should be re-read. */
 801     SIM_RESET = 2
 802 } RIL_SimRefreshResult;
 803
 804 typedef struct {
 805     RIL_SimRefreshResult result;
 806     int                  ef_id; /* is the EFID of the updated file if the result is */
 807                                 /* SIM_FILE_UPDATE or 0 for any other result. */
 808     char *               aid;   /* is AID(application ID) of the card application */
 809                                 /* See ETSI 102.221 8.1 and 101.220 4 */
 810                                 /*     For SIM_FILE_UPDATE result it can be set to AID of */
 811                                 /*         application in which updated EF resides or it can be */
 812                                 /*         NULL if EF is outside of an application. */
 813                                 /*     For SIM_INIT result this field is set to AID of */
 814                                 /*         application that caused REFRESH */
 815                                 /*     For SIM_RESET result it is NULL. */
 816 } RIL_SimRefreshResponse_v7;
 817
 818 /* Deprecated, use RIL_CDMA_CallWaiting_v6 */
 819 typedef struct {
 820     char *          number;             /* Remote party number */
 821     int             numberPresentation; /* 0=Allowed, 1=Restricted, 2=Not Specified/Unknown */
 822     char *          name;               /* Remote party name */
 823     RIL_CDMA_SignalInfoRecord signalInfoRecord;
 824 } RIL_CDMA_CallWaiting_v5;
 825
 826 typedef struct {
 827     char *          number;             /* Remote party number */
 828     int             numberPresentation; /* 0=Allowed, 1=Restricted, 2=Not Specified/Unknown */
 829     char *          name;               /* Remote party name */
 830     RIL_CDMA_SignalInfoRecord signalInfoRecord;
 831     /* Number type/Number plan required to support International Call Waiting */
 832     int             number_type;        /* 0=Unknown, 1=International, 2=National,
 833                                            3=Network specific, 4=subscriber */
 834     int             number_plan;        /* 0=Unknown, 1=ISDN, 3=Data, 4=Telex, 8=Nat'l, 9=Private */
 835 } RIL_CDMA_CallWaiting_v6;
 836
 837 /**
 838  * Which types of Cell Broadcast Message (CBM) are to be received by the ME
 839  *
 840  * uFromServiceID - uToServiceID defines a range of CBM message identifiers
 841  * whose value is 0x0000 - 0xFFFF as defined in TS 23.041 9.4.1.2.2 for GMS
 842  * and 9.4.4.2.2 for UMTS. All other values can be treated as empty
 843  * CBM message ID.
 844  *
 845  * uFromCodeScheme - uToCodeScheme defines a range of CBM data coding schemes
 846  * whose value is 0x00 - 0xFF as defined in TS 23.041 9.4.1.2.3 for GMS
 847  * and 9.4.4.2.3 for UMTS.
 848  * All other values can be treated as empty CBM data coding scheme.
 849  *
 850  * selected 0 means message types specified in <fromServiceId, toServiceId>
 851  * and <fromCodeScheme, toCodeScheme>are not accepted, while 1 means accepted.
 852  *
 853  * Used by RIL_REQUEST_GSM_GET_BROADCAST_CONFIG and
 854  * RIL_REQUEST_GSM_SET_BROADCAST_CONFIG.
 855  */
 856 typedef struct {
 857     int fromServiceId;
 858     int toServiceId;
 859     int fromCodeScheme;
 860     int toCodeScheme;
 861     unsigned char selected;
 862 } RIL_GSM_BroadcastSmsConfigInfo;
 863
 864 /* No restriction at all including voice/SMS/USSD/SS/AV64 and packet data. */
 865 #define RIL_RESTRICTED_STATE_NONE           0x00
 866 /* Block emergency call due to restriction. But allow all normal voice/SMS/USSD/SS/AV64. */
 867 #define RIL_RESTRICTED_STATE_CS_EMERGENCY   0x01
 868 /* Block all normal voice/SMS/USSD/SS/AV64 due to restriction. Only Emergency call allowed. */
 869 #define RIL_RESTRICTED_STATE_CS_NORMAL      0x02
 870 /* Block all voice/SMS/USSD/SS/AV64 including emergency call due to restriction.*/
 871 #define RIL_RESTRICTED_STATE_CS_ALL         0x04
 872 /* Block packet data access due to restriction. */
 873 #define RIL_RESTRICTED_STATE_PS_ALL         0x10
 874
 875 /* The status for an OTASP/OTAPA session */
 876 typedef enum {
 877     CDMA_OTA_PROVISION_STATUS_SPL_UNLOCKED,
 878     CDMA_OTA_PROVISION_STATUS_SPC_RETRIES_EXCEEDED,
 879     CDMA_OTA_PROVISION_STATUS_A_KEY_EXCHANGED,
 880     CDMA_OTA_PROVISION_STATUS_SSD_UPDATED,
 881     CDMA_OTA_PROVISION_STATUS_NAM_DOWNLOADED,
 882     CDMA_OTA_PROVISION_STATUS_MDN_DOWNLOADED,
 883     CDMA_OTA_PROVISION_STATUS_IMSI_DOWNLOADED,
 884     CDMA_OTA_PROVISION_STATUS_PRL_DOWNLOADED,
 885     CDMA_OTA_PROVISION_STATUS_COMMITTED,
 886     CDMA_OTA_PROVISION_STATUS_OTAPA_STARTED,
 887     CDMA_OTA_PROVISION_STATUS_OTAPA_STOPPED,
 888     CDMA_OTA_PROVISION_STATUS_OTAPA_ABORTED
 889 } RIL_CDMA_OTA_ProvisionStatus;
 890
 891 typedef struct {
 892     int signalStrength;  /* Valid values are (0-31, 99) as defined in TS 27.007 8.5 */
 893     int bitErrorRate;    /* bit error rate (0-7, 99) as defined in TS 27.007 8.5 */
 894 } RIL_GW_SignalStrength;
 895
 896 typedef struct {
 897     int signalStrength;  /* Valid values are (0-31, 99) as defined in TS 27.007 8.5 */
 898     int bitErrorRate;    /* bit error rate (0-7, 99) as defined in TS 27.007 8.5 */
 899 } RIL_SignalStrengthWcdma;
 900
 901 typedef struct {
 902     int dbm;  /* Valid values are positive integers.  This value is the actual RSSI value
 903                * multiplied by -1.  Example: If the actual RSSI is -75, then this response
 904                * value will be 75.
 905                */
 906     int ecio; /* Valid values are positive integers.  This value is the actual Ec/Io multiplied
 907                * by -10.  Example: If the actual Ec/Io is -12.5 dB, then this response value
 908                * will be 125.
 909                */
 910 } RIL_CDMA_SignalStrength;
 911
 912
 913 typedef struct {
 914     int dbm;  /* Valid values are positive integers.  This value is the actual RSSI value
 915                * multiplied by -1.  Example: If the actual RSSI is -75, then this response
 916                * value will be 75.
 917                */
 918     int ecio; /* Valid values are positive integers.  This value is the actual Ec/Io multiplied
 919                * by -10.  Example: If the actual Ec/Io is -12.5 dB, then this response value
 920                * will be 125.
 921                */
 922     int signalNoiseRatio; /* Valid values are 0-8.  8 is the highest signal to noise ratio. */
 923 } RIL_EVDO_SignalStrength;
 924
 925 typedef struct {
 926     int signalStrength;  /* Valid values are (0-31, 99) as defined in TS 27.007 8.5 */
 927     int rsrp;            /* The current Reference Signal Receive Power in dBm multipled by -1.
 928                           * Range: 44 to 140 dBm
 929                           * INT_MAX: 0x7FFFFFFF denotes invalid value.
 930                           * Reference: 3GPP TS 36.133 9.1.4 */
 931     int rsrq;            /* The current Reference Signal Receive Quality in dB multiplied by -1.
 932                           * Range: 20 to 3 dB.
 933                           * INT_MAX: 0x7FFFFFFF denotes invalid value.
 934                           * Reference: 3GPP TS 36.133 9.1.7 */
 935     int rssnr;           /* The current reference signal signal-to-noise ratio in 0.1 dB units.
 936                           * Range: -200 to +300 (-200 = -20.0 dB, +300 = 30dB).
 937                           * INT_MAX : 0x7FFFFFFF denotes invalid value.
 938                           * Reference: 3GPP TS 36.101 8.1.1 */
 939     int cqi;             /* The current Channel Quality Indicator.
 940                           * Range: 0 to 15.
 941                           * INT_MAX : 0x7FFFFFFF denotes invalid value.
 942                           * Reference: 3GPP TS 36.101 9.2, 9.3, A.4 */
 943 } RIL_LTE_SignalStrength;
 944
 945 typedef struct {
 946     int signalStrength;  /* Valid values are (0-31, 99) as defined in TS 27.007 8.5 */
 947     int rsrp;            /* The current Reference Signal Receive Power in dBm multipled by -1.
 948                           * Range: 44 to 140 dBm
 949                           * INT_MAX: 0x7FFFFFFF denotes invalid value.
 950                           * Reference: 3GPP TS 36.133 9.1.4 */
 951     int rsrq;            /* The current Reference Signal Receive Quality in dB multiplied by -1.
 952                           * Range: 20 to 3 dB.
 953                           * INT_MAX: 0x7FFFFFFF denotes invalid value.
 954                           * Reference: 3GPP TS 36.133 9.1.7 */
 955     int rssnr;           /* The current reference signal signal-to-noise ratio in 0.1 dB units.
 956                           * Range: -200 to +300 (-200 = -20.0 dB, +300 = 30dB).
 957                           * INT_MAX : 0x7FFFFFFF denotes invalid value.
 958                           * Reference: 3GPP TS 36.101 8.1.1 */
 959     int cqi;             /* The current Channel Quality Indicator.
 960                           * Range: 0 to 15.
 961                           * INT_MAX : 0x7FFFFFFF denotes invalid value.
 962                           * Reference: 3GPP TS 36.101 9.2, 9.3, A.4 */
 963     int timingAdvance;   /* timing advance in micro seconds for a one way trip from cell to device.
 964                           * Approximate distance can be calculated using 300m/us * timingAdvance.
 965                           * Range: 0 to 0x7FFFFFFE
 966                           * INT_MAX : 0x7FFFFFFF denotes invalid value.
 967                           * Reference: 3GPP 36.321 section 6.1.3.5
 968                           * also: http://www.cellular-planningoptimization.com/2010/02/timing-advance-with-calculation.html */
 969 } RIL_LTE_SignalStrength_v8;
 970
 971 typedef struct {
 972     int rscp;    /* The Received Signal Code Power in dBm multipled by -1.
 973                   * Range : 25 to 120
 974                   * INT_MAX: 0x7FFFFFFF denotes invalid value.
 975                   * Reference: 3GPP TS 25.123, section 9.1.1.1 */
 976 } RIL_TD_SCDMA_SignalStrength;
 977
 978 /* Deprecated, use RIL_SignalStrength_v6 */
 979 typedef struct {
 980     RIL_GW_SignalStrength   GW_SignalStrength;
 981     RIL_CDMA_SignalStrength CDMA_SignalStrength;
 982     RIL_EVDO_SignalStrength EVDO_SignalStrength;
 983 } RIL_SignalStrength_v5;
 984
 985 typedef struct {
 986     RIL_GW_SignalStrength   GW_SignalStrength;
 987     RIL_CDMA_SignalStrength CDMA_SignalStrength;
 988     RIL_EVDO_SignalStrength EVDO_SignalStrength;
 989     RIL_LTE_SignalStrength  LTE_SignalStrength;
 990 } RIL_SignalStrength_v6;
 991
 992 typedef struct {
 993     RIL_GW_SignalStrength       GW_SignalStrength;
 994     RIL_CDMA_SignalStrength     CDMA_SignalStrength;
 995     RIL_EVDO_SignalStrength     EVDO_SignalStrength;
 996     RIL_LTE_SignalStrength_v8   LTE_SignalStrength;
 997 } RIL_SignalStrength_v8;
 998
 999 typedef struct {
1000     RIL_GW_SignalStrength       GW_SignalStrength;
1001     RIL_CDMA_SignalStrength     CDMA_SignalStrength;
1002     RIL_EVDO_SignalStrength     EVDO_SignalStrength;
1003     RIL_LTE_SignalStrength_v8   LTE_SignalStrength;
1004     RIL_TD_SCDMA_SignalStrength TD_SCDMA_SignalStrength;
1005 } RIL_SignalStrength_v10;
1006
1007 /** RIL_CellIdentityGsm */
1008 typedef struct {
1009     int mcc;    /* 3-digit Mobile Country Code, 0..999, INT_MAX if unknown */
1010     int mnc;    /* 2 or 3-digit Mobile Network Code, 0..999, INT_MAX if unknown */
1011     int lac;    /* 16-bit Location Area Code, 0..65535, INT_MAX if unknown  */
1012     int cid;    /* 16-bit GSM Cell Identity described in TS 27.007, 0..65535, INT_MAX if unknown  */
1013 } RIL_CellIdentityGsm;
1014
1015 /** RIL_CellIdentityWcdma */
1016 typedef struct {
1017     int mcc;    /* 3-digit Mobile Country Code, 0..999, INT_MAX if unknown  */
1018     int mnc;    /* 2 or 3-digit Mobile Network Code, 0..999, INT_MAX if unknown  */
1019     int lac;    /* 16-bit Location Area Code, 0..65535, INT_MAX if unknown  */
1020     int cid;    /* 28-bit UMTS Cell Identity described in TS 25.331, 0..268435455, INT_MAX if unknown  */
1021     int psc;    /* 9-bit UMTS Primary Scrambling Code described in TS 25.331, 0..511, INT_MAX if unknown */
1022 } RIL_CellIdentityWcdma;
1023
1024 /** RIL_CellIdentityCdma */
1025 typedef struct {
1026     int networkId;      /* Network Id 0..65535, INT_MAX if unknown */
1027     int systemId;       /* CDMA System Id 0..32767, INT_MAX if unknown  */
1028     int basestationId;  /* Base Station Id 0..65535, INT_MAX if unknown  */
1029     int longitude;      /* Longitude is a decimal number as specified in 3GPP2 C.S0005-A v6.0.
1030                          * It is represented in units of 0.25 seconds and ranges from -2592000
1031                          * to 2592000, both values inclusive (corresponding to a range of -180
1032                          * to +180 degrees). INT_MAX if unknown */
1033
1034     int latitude;       /* Latitude is a decimal number as specified in 3GPP2 C.S0005-A v6.0.
1035                          * It is represented in units of 0.25 seconds and ranges from -1296000
1036                          * to 1296000, both values inclusive (corresponding to a range of -90
1037                          * to +90 degrees). INT_MAX if unknown */
1038 } RIL_CellIdentityCdma;
1039
1040 /** RIL_CellIdentityLte */
1041 typedef struct {
1042     int mcc;    /* 3-digit Mobile Country Code, 0..999, INT_MAX if unknown  */
1043     int mnc;    /* 2 or 3-digit Mobile Network Code, 0..999, INT_MAX if unknown  */
1044     int ci;     /* 28-bit Cell Identity described in TS ???, INT_MAX if unknown */
1045     int pci;    /* physical cell id 0..503, INT_MAX if unknown  */
1046     int tac;    /* 16-bit tracking area code, INT_MAX if unknown  */
1047 } RIL_CellIdentityLte;
1048
1049 /** RIL_CellIdentityTdscdma */
1050 typedef struct {
1051     int mcc;    /* 3-digit Mobile Country Code, 0..999, INT_MAX if unknown  */
1052     int mnc;    /* 2 or 3-digit Mobile Network Code, 0..999, INT_MAX if unknown  */
1053     int lac;    /* 16-bit Location Area Code, 0..65535, INT_MAX if unknown  */
1054     int cid;    /* 28-bit UMTS Cell Identity described in TS 25.331, 0..268435455, INT_MAX if unknown  */
1055     int cpid;    /* 8-bit Cell Parameters ID described in TS 25.331, 0..127, INT_MAX if unknown */
1056 } RIL_CellIdentityTdscdma;
1057
1058 /** RIL_CellInfoGsm */
1059 typedef struct {
1060   RIL_CellIdentityGsm   cellIdentityGsm;
1061   RIL_GW_SignalStrength signalStrengthGsm;
1062 } RIL_CellInfoGsm;
1063
1064 /** RIL_CellInfoWcdma */
1065 typedef struct {
1066   RIL_CellIdentityWcdma cellIdentityWcdma;
1067   RIL_SignalStrengthWcdma signalStrengthWcdma;
1068 } RIL_CellInfoWcdma;
1069
1070 /** RIL_CellInfoCdma */
1071 typedef struct {
1072   RIL_CellIdentityCdma      cellIdentityCdma;
1073   RIL_CDMA_SignalStrength   signalStrengthCdma;
1074   RIL_EVDO_SignalStrength   signalStrengthEvdo;
1075 } RIL_CellInfoCdma;
1076
1077 /** RIL_CellInfoLte */
1078 typedef struct {
1079   RIL_CellIdentityLte        cellIdentityLte;
1080   RIL_LTE_SignalStrength_v8  signalStrengthLte;
1081 } RIL_CellInfoLte;
1082
1083 /** RIL_CellInfoTdscdma */
1084 typedef struct {
1085   RIL_CellIdentityTdscdma cellIdentityTdscdma;
1086   RIL_TD_SCDMA_SignalStrength signalStrengthTdscdma;
1087 } RIL_CellInfoTdscdma;
1088
1089 // Must be the same as CellInfo.TYPE_XXX
1090 typedef enum {
1091   RIL_CELL_INFO_TYPE_GSM    = 1,
1092   RIL_CELL_INFO_TYPE_CDMA   = 2,
1093   RIL_CELL_INFO_TYPE_LTE    = 3,
1094   RIL_CELL_INFO_TYPE_WCDMA  = 4,
1095   RIL_CELL_INFO_TYPE_TD_SCDMA  = 5
1096 } RIL_CellInfoType;
1097
1098 // Must be the same as CellInfo.TIMESTAMP_TYPE_XXX
1099 typedef enum {
1100     RIL_TIMESTAMP_TYPE_UNKNOWN = 0,
1101     RIL_TIMESTAMP_TYPE_ANTENNA = 1,
1102     RIL_TIMESTAMP_TYPE_MODEM = 2,
1103     RIL_TIMESTAMP_TYPE_OEM_RIL = 3,
1104     RIL_TIMESTAMP_TYPE_JAVA_RIL = 4,
1105 } RIL_TimeStampType;
1106
1107 typedef struct {
1108   RIL_CellInfoType  cellInfoType;   /* cell type for selecting from union CellInfo */
1109   int               registered;     /* !0 if this cell is registered 0 if not registered */
1110   RIL_TimeStampType timeStampType;  /* type of time stamp represented by timeStamp */
1111   uint64_t          timeStamp;      /* Time in nanos as returned by ril_nano_time */
1112   union {
1113     RIL_CellInfoGsm     gsm;
1114     RIL_CellInfoCdma    cdma;
1115     RIL_CellInfoLte     lte;
1116     RIL_CellInfoWcdma   wcdma;
1117     RIL_CellInfoTdscdma tdscdma;
1118   } CellInfo;
1119 } RIL_CellInfo;
1120
1121 /* Names of the CDMA info records (C.S0005 section 3.7.5) */
1122 typedef enum {
1123   RIL_CDMA_DISPLAY_INFO_REC,
1124   RIL_CDMA_CALLED_PARTY_NUMBER_INFO_REC,
1125   RIL_CDMA_CALLING_PARTY_NUMBER_INFO_REC,
1126   RIL_CDMA_CONNECTED_NUMBER_INFO_REC,
1127   RIL_CDMA_SIGNAL_INFO_REC,
1128   RIL_CDMA_REDIRECTING_NUMBER_INFO_REC,
1129   RIL_CDMA_LINE_CONTROL_INFO_REC,
1130   RIL_CDMA_EXTENDED_DISPLAY_INFO_REC,
1131   RIL_CDMA_T53_CLIR_INFO_REC,
1132   RIL_CDMA_T53_RELEASE_INFO_REC,
1133   RIL_CDMA_T53_AUDIO_CONTROL_INFO_REC
1134 } RIL_CDMA_InfoRecName;
1135
1136 /* Display Info Rec as defined in C.S0005 section 3.7.5.1
1137    Extended Display Info Rec as defined in C.S0005 section 3.7.5.16
1138    Note: the Extended Display info rec contains multiple records of the
1139    form: display_tag, display_len, and display_len occurrences of the
1140    chari field if the display_tag is not 10000000 or 10000001.
1141    To save space, the records are stored consecutively in a byte buffer.
1142    The display_tag, display_len and chari fields are all 1 byte.
1143 */
1144
1145 typedef struct {
1146   char alpha_len;
1147   char alpha_buf[CDMA_ALPHA_INFO_BUFFER_LENGTH];
1148 } RIL_CDMA_DisplayInfoRecord;
1149
1150 /* Called Party Number Info Rec as defined in C.S0005 section 3.7.5.2
1151    Calling Party Number Info Rec as defined in C.S0005 section 3.7.5.3
1152    Connected Number Info Rec as defined in C.S0005 section 3.7.5.4
1153 */
1154
1155 typedef struct {
1156   char len;
1157   char buf[CDMA_NUMBER_INFO_BUFFER_LENGTH];
1158   char number_type;
1159   char number_plan;
1160   char pi;
1161   char si;
1162 } RIL_CDMA_NumberInfoRecord;
1163
1164 /* Redirecting Number Information Record as defined in C.S0005 section 3.7.5.11 */
1165 typedef enum {
1166   RIL_REDIRECTING_REASON_UNKNOWN = 0,
1167   RIL_REDIRECTING_REASON_CALL_FORWARDING_BUSY = 1,
1168   RIL_REDIRECTING_REASON_CALL_FORWARDING_NO_REPLY = 2,
1169   RIL_REDIRECTING_REASON_CALLED_DTE_OUT_OF_ORDER = 9,
1170   RIL_REDIRECTING_REASON_CALL_FORWARDING_BY_THE_CALLED_DTE = 10,
1171   RIL_REDIRECTING_REASON_CALL_FORWARDING_UNCONDITIONAL = 15,
1172   RIL_REDIRECTING_REASON_RESERVED
1173 } RIL_CDMA_RedirectingReason;
1174
1175 typedef struct {
1176   RIL_CDMA_NumberInfoRecord redirectingNumber;
1177   /* redirectingReason is set to RIL_REDIRECTING_REASON_UNKNOWN if not included */
1178   RIL_CDMA_RedirectingReason redirectingReason;
1179 } RIL_CDMA_RedirectingNumberInfoRecord;
1180
1181 /* Line Control Information Record as defined in C.S0005 section 3.7.5.15 */
1182 typedef struct {
1183   char lineCtrlPolarityIncluded;
1184   char lineCtrlToggle;
1185   char lineCtrlReverse;
1186   char lineCtrlPowerDenial;
1187 } RIL_CDMA_LineControlInfoRecord;
1188
1189 /* T53 CLIR Information Record */
1190 typedef struct {
1191   char cause;
1192 } RIL_CDMA_T53_CLIRInfoRecord;
1193
1194 /* T53 Audio Control Information Record */
1195 typedef struct {
1196   char upLink;
1197   char downLink;
1198 } RIL_CDMA_T53_AudioControlInfoRecord;
1199
1200 typedef struct {
1201
1202   RIL_CDMA_InfoRecName name;
1203
1204   union {
1205     /* Display and Extended Display Info Rec */
1206     RIL_CDMA_DisplayInfoRecord           display;
1207
1208     /* Called Party Number, Calling Party Number, Connected Number Info Rec */
1209     RIL_CDMA_NumberInfoRecord            number;
1210
1211     /* Signal Info Rec */
1212     RIL_CDMA_SignalInfoRecord            signal;
1213
1214     /* Redirecting Number Info Rec */
1215     RIL_CDMA_RedirectingNumberInfoRecord redir;
1216
1217     /* Line Control Info Rec */
1218     RIL_CDMA_LineControlInfoRecord       lineCtrl;
1219
1220     /* T53 CLIR Info Rec */
1221     RIL_CDMA_T53_CLIRInfoRecord          clir;
1222
1223     /* T53 Audio Control Info Rec */
1224     RIL_CDMA_T53_AudioControlInfoRecord  audioCtrl;
1225   } rec;
1226 } RIL_CDMA_InformationRecord;
1227
1228 #define RIL_CDMA_MAX_NUMBER_OF_INFO_RECS 10
1229
1230 typedef struct {
1231   char numberOfInfoRecs;
1232   RIL_CDMA_InformationRecord infoRec[RIL_CDMA_MAX_NUMBER_OF_INFO_RECS];
1233 } RIL_CDMA_InformationRecords;
1234
1235 /* See RIL_REQUEST_NV_READ_ITEM */
1236 typedef struct {
1237   RIL_NV_Item itemID;
1238 } RIL_NV_ReadItem;
1239
1240 /* See RIL_REQUEST_NV_WRITE_ITEM */
1241 typedef struct {
1242   RIL_NV_Item   itemID;
1243   char *        value;
1244 } RIL_NV_WriteItem;
1245
1246 typedef enum {
1247     HANDOVER_STARTED = 0,
1248     HANDOVER_COMPLETED = 1,
1249     HANDOVER_FAILED = 2,
1250     HANDOVER_CANCELED = 3
1251 } RIL_SrvccState;
1252
1253 /* hardware configuration reported to RILJ. */
1254 typedef enum {
1255    RIL_HARDWARE_CONFIG_MODEM = 0,
1256    RIL_HARDWARE_CONFIG_SIM = 1,
1257 } RIL_HardwareConfig_Type;
1258
1259 typedef enum {
1260    RIL_HARDWARE_CONFIG_STATE_ENABLED = 0,
1261    RIL_HARDWARE_CONFIG_STATE_STANDBY = 1,
1262    RIL_HARDWARE_CONFIG_STATE_DISABLED = 2,
1263 } RIL_HardwareConfig_State;
1264
1265 typedef struct {
1266    int rilModel;
1267    uint32_t rat; /* bitset - ref. RIL_RadioTechnology. */
1268    int maxVoice;
1269    int maxData;
1270    int maxStandby;
1271 } RIL_HardwareConfig_Modem;
1272
1273 typedef struct {
1274    char modemUuid[MAX_UUID_LENGTH];
1275 } RIL_HardwareConfig_Sim;
1276
1277 typedef struct {
1278   RIL_HardwareConfig_Type type;
1279   char uuid[MAX_UUID_LENGTH];
1280   RIL_HardwareConfig_State state;
1281   union {
1282      RIL_HardwareConfig_Modem modem;
1283      RIL_HardwareConfig_Sim sim;
1284   } cfg;
1285 } RIL_HardwareConfig;
1286
1287 typedef enum {
1288   SS_CFU,
1289   SS_CF_BUSY,
1290   SS_CF_NO_REPLY,
1291   SS_CF_NOT_REACHABLE,
1292   SS_CF_ALL,
1293   SS_CF_ALL_CONDITIONAL,
1294   SS_CLIP,
1295   SS_CLIR,
1296   SS_COLP,
1297   SS_COLR,
1298   SS_WAIT,
1299   SS_BAOC,
1300   SS_BAOIC,
1301   SS_BAOIC_EXC_HOME,
1302   SS_BAIC,
1303   SS_BAIC_ROAMING,
1304   SS_ALL_BARRING,
1305   SS_OUTGOING_BARRING,
1306   SS_INCOMING_BARRING
1307 } RIL_SsServiceType;
1308
1309 typedef enum {
1310   SS_ACTIVATION,
1311   SS_DEACTIVATION,
1312   SS_INTERROGATION,
1313   SS_REGISTRATION,
1314   SS_ERASURE
1315 } RIL_SsRequestType;
1316
1317 typedef enum {
1318   SS_ALL_TELE_AND_BEARER_SERVICES,
1319   SS_ALL_TELESEVICES,
1320   SS_TELEPHONY,
1321   SS_ALL_DATA_TELESERVICES,
1322   SS_SMS_SERVICES,
1323   SS_ALL_TELESERVICES_EXCEPT_SMS
1324 } RIL_SsTeleserviceType;
1325
1326 #define SS_INFO_MAX 4
1327 #define NUM_SERVICE_CLASSES 7
1328
1329 typedef struct {
1330   int numValidIndexes; /* This gives the number of valid values in cfInfo.
1331                        For example if voice is forwarded to one number and data
1332                        is forwarded to a different one then numValidIndexes will be
1333                        2 indicating total number of valid values in cfInfo.
1334                        Similarly if all the services are forwarded to the same
1335                        number then the value of numValidIndexes will be 1. */
1336
1337   RIL_CallForwardInfo cfInfo[NUM_SERVICE_CLASSES]; /* This is the response data
1338                                                       for SS request to query call
1339                                                       forward status. see
1340                                                       RIL_REQUEST_QUERY_CALL_FORWARD_STATUS */
1341 } RIL_CfData;
1342
1343 typedef struct {
1344   RIL_SsServiceType serviceType;
1345   RIL_SsRequestType requestType;
1346   RIL_SsTeleserviceType teleserviceType;
1347   int serviceClass;
1348   RIL_Errno result;
1349
1350   union {
1351     int ssInfo[SS_INFO_MAX]; /* This is the response data for most of the SS GET/SET
1352                                 RIL requests. E.g. RIL_REQUSET_GET_CLIR returns
1353                                 two ints, so first two values of ssInfo[] will be
1354                                 used for response if serviceType is SS_CLIR and
1355                                 requestType is SS_INTERROGATION */
1356
1357     RIL_CfData cfData;
1358   };
1359 } RIL_StkCcUnsolSsResponse;
1360
1361 /**
1362  * Data connection power state
1363  */
1364 typedef enum {
1365     RIL_DC_POWER_STATE_LOW      = 1,        // Low power state
1366     RIL_DC_POWER_STATE_MEDIUM   = 2,        // Medium power state
1367     RIL_DC_POWER_STATE_HIGH     = 3,        // High power state
1368     RIL_DC_POWER_STATE_UNKNOWN  = INT32_MAX // Unknown state
1369 } RIL_DcPowerStates;
1370
1371 /**
1372  * Data connection real time info
1373  */
1374 typedef struct {
1375     uint64_t                    time;       // Time in nanos as returned by ril_nano_time
1376     RIL_DcPowerStates           powerState; // Current power state
1377 } RIL_DcRtInfo;
1378
1379 /**
1380  * Data profile to modem
1381  */
1382 typedef struct {
1383     /* id of the data profile */
1384     int profileId;
1385     /* the APN to connect to */
1386     char* apn;
1387     /** one of the PDP_type values in TS 27.007 section 10.1.1.
1388      * For example, "IP", "IPV6", "IPV4V6", or "PPP".
1389      */
1390     char* protocol;
1391     /** authentication protocol used for this PDP context
1392      * (None: 0, PAP: 1, CHAP: 2, PAP&CHAP: 3)
1393      */
1394     int authType;
1395     /* the username for APN, or NULL */
1396     char* user;
1397     /* the password for APN, or NULL */
1398     char* password;
1399     /* the profile type, TYPE_COMMON-0, TYPE_3GPP-1, TYPE_3GPP2-2 */
1400     int type;
1401     /* the period in seconds to limit the maximum connections */
1402     int maxConnsTime;
1403     /* the maximum connections during maxConnsTime */
1404     int maxConns;
1405     /** the required wait time in seconds after a successful UE initiated
1406      * disconnect of a given PDN connection before the device can send
1407      * a new PDN connection request for that given PDN
1408      */
1409     int waitTime;
1410     /* true to enable the profile, 0 to disable, 1 to enable */
1411     int enabled;
1412 } RIL_DataProfileInfo;
1413
1414 /**
1415  * RIL_REQUEST_GET_SIM_STATUS
1416  *
1417  * Requests status of the SIM interface and the SIM card
1418  *
1419  * "data" is NULL
1420  *
1421  * "response" is const RIL_CardStatus_v6 *
1422  *
1423  * Valid errors:
1424  *  Must never fail
1425  */
1426 #define RIL_REQUEST_GET_SIM_STATUS 1
1427
1428 /**
1429  * RIL_REQUEST_ENTER_SIM_PIN
1430  *
1431  * Supplies SIM PIN. Only called if RIL_CardStatus has RIL_APPSTATE_PIN state
1432  *
1433  * "data" is const char **
1434  * ((const char **)data)[0] is PIN value
1435  * ((const char **)data)[1] is AID value, See ETSI 102.221 8.1 and 101.220 4, NULL if no value.
1436  *
1437  * "response" is int *
1438  * ((int *)response)[0] is the number of retries remaining, or -1 if unknown
1439  *
1440  * Valid errors:
1441  *
1442  * SUCCESS
1443  * RADIO_NOT_AVAILABLE (radio resetting)
1444  * GENERIC_FAILURE
1445  * PASSWORD_INCORRECT
1446  */
1447
1448 #define RIL_REQUEST_ENTER_SIM_PIN 2
1449
1450 /**
1451  * RIL_REQUEST_ENTER_SIM_PUK
1452  *
1453  * Supplies SIM PUK and new PIN.
1454  *
1455  * "data" is const char **
1456  * ((const char **)data)[0] is PUK value
1457  * ((const char **)data)[1] is new PIN value
1458  * ((const char **)data)[2] is AID value, See ETSI 102.221 8.1 and 101.220 4, NULL if no value.
1459  *
1460  * "response" is int *
1461  * ((int *)response)[0] is the number of retries remaining, or -1 if unknown
1462  *
1463  * Valid errors:
1464  *
1465  *  SUCCESS
1466  *  RADIO_NOT_AVAILABLE (radio resetting)
1467  *  GENERIC_FAILURE
1468  *  PASSWORD_INCORRECT
1469  *     (PUK is invalid)
1470  */
1471
1472 #define RIL_REQUEST_ENTER_SIM_PUK 3
1473
1474 /**
1475  * RIL_REQUEST_ENTER_SIM_PIN2
1476  *
1477  * Supplies SIM PIN2. Only called following operation where SIM_PIN2 was
1478  * returned as a a failure from a previous operation.
1479  *
1480  * "data" is const char **
1481  * ((const char **)data)[0] is PIN2 value
1482  * ((const char **)data)[1] is AID value, See ETSI 102.221 8.1 and 101.220 4, NULL if no value.
1483  *
1484  * "response" is int *
1485  * ((int *)response)[0] is the number of retries remaining, or -1 if unknown
1486  *
1487  * Valid errors:
1488  *
1489  *  SUCCESS
1490  *  RADIO_NOT_AVAILABLE (radio resetting)
1491  *  GENERIC_FAILURE
1492  *  PASSWORD_INCORRECT
1493  */
1494
1495 #define RIL_REQUEST_ENTER_SIM_PIN2 4
1496
1497 /**
1498  * RIL_REQUEST_ENTER_SIM_PUK2
1499  *
1500  * Supplies SIM PUK2 and new PIN2.
1501  *
1502  * "data" is const char **
1503  * ((const char **)data)[0] is PUK2 value
1504  * ((const char **)data)[1] is new PIN2 value
1505  * ((const char **)data)[2] is AID value, See ETSI 102.221 8.1 and 101.220 4, NULL if no value.
1506  *
1507  * "response" is int *
1508  * ((int *)response)[0] is the number of retries remaining, or -1 if unknown
1509  *
1510  * Valid errors:
1511  *
1512  *  SUCCESS
1513  *  RADIO_NOT_AVAILABLE (radio resetting)
1514  *  GENERIC_FAILURE
1515  *  PASSWORD_INCORRECT
1516  *     (PUK2 is invalid)
1517  */
1518
1519 #define RIL_REQUEST_ENTER_SIM_PUK2 5
1520
1521 /**
1522  * RIL_REQUEST_CHANGE_SIM_PIN
1523  *
1524  * Supplies old SIM PIN and new PIN.
1525  *
1526  * "data" is const char **
1527  * ((const char **)data)[0] is old PIN value
1528  * ((const char **)data)[1] is new PIN value
1529  * ((const char **)data)[2] is AID value, See ETSI 102.221 8.1 and 101.220 4, NULL if no value.
1530  *
1531  * "response" is int *
1532  * ((int *)response)[0] is the number of retries remaining, or -1 if unknown
1533  *
1534  * Valid errors:
1535  *
1536  *  SUCCESS
1537  *  RADIO_NOT_AVAILABLE (radio resetting)
1538  *  GENERIC_FAILURE
1539  *  PASSWORD_INCORRECT
1540  *     (old PIN is invalid)
1541  *
1542  */
1543
1544 #define RIL_REQUEST_CHANGE_SIM_PIN 6
1545
1546
1547 /**
1548  * RIL_REQUEST_CHANGE_SIM_PIN2
1549  *
1550  * Supplies old SIM PIN2 and new PIN2.
1551  *
1552  * "data" is const char **
1553  * ((const char **)data)[0] is old PIN2 value
1554  * ((const char **)data)[1] is new PIN2 value
1555  * ((const char **)data)[2] is AID value, See ETSI 102.221 8.1 and 101.220 4, NULL if no value.
1556  *
1557  * "response" is int *
1558  * ((int *)response)[0] is the number of retries remaining, or -1 if unknown
1559  *
1560  * Valid errors:
1561  *
1562  *  SUCCESS
1563  *  RADIO_NOT_AVAILABLE (radio resetting)
1564  *  GENERIC_FAILURE
1565  *  PASSWORD_INCORRECT
1566  *     (old PIN2 is invalid)
1567  *
1568  */
1569
1570 #define RIL_REQUEST_CHANGE_SIM_PIN2 7
1571
1572 /**
1573  * RIL_REQUEST_ENTER_NETWORK_DEPERSONALIZATION
1574  *
1575  * Requests that network personlization be deactivated
1576  *
1577  * "data" is const char **
1578  * ((const char **)(data))[0]] is network depersonlization code
1579  *
1580  * "response" is int *
1581  * ((int *)response)[0] is the number of retries remaining, or -1 if unknown
1582  *
1583  * Valid errors:
1584  *
1585  *  SUCCESS
1586  *  RADIO_NOT_AVAILABLE (radio resetting)
1587  *  GENERIC_FAILURE
1588  *  PASSWORD_INCORRECT
1589  *     (code is invalid)
1590  */
1591
1592 #define RIL_REQUEST_ENTER_NETWORK_DEPERSONALIZATION 8
1593
1594 /**
1595  * RIL_REQUEST_GET_CURRENT_CALLS
1596  *
1597  * Requests current call list
1598  *
1599  * "data" is NULL
1600  *
1601  * "response" must be a "const RIL_Call **"
1602  *
1603  * Valid errors:
1604  *
1605  *  SUCCESS
1606  *  RADIO_NOT_AVAILABLE (radio resetting)
1607  *  GENERIC_FAILURE
1608  *      (request will be made again in a few hundred msec)
1609  */
1610
1611 #define RIL_REQUEST_GET_CURRENT_CALLS 9
1612
1613
1614 /**
1615  * RIL_REQUEST_DIAL
1616  *
1617  * Initiate voice call
1618  *
1619  * "data" is const RIL_Dial *
1620  * "response" is NULL
1621  *
1622  * This method is never used for supplementary service codes
1623  *
1624  * Valid errors:
1625  *  SUCCESS
1626  *  RADIO_NOT_AVAILABLE (radio resetting)
1627  *  DIAL_MODIFIED_TO_USSD
1628  *  DIAL_MODIFIED_TO_SS
1629  *  DIAL_MODIFIED_TO_DIAL
1630  *  GENERIC_FAILURE
1631  */
1632 #define RIL_REQUEST_DIAL 10
1633
1634 /**
1635  * RIL_REQUEST_GET_IMSI
1636  *
1637  * Get the SIM IMSI
1638  *
1639  * Only valid when radio state is "RADIO_STATE_ON"
1640  *
1641  * "data" is const char **
1642  * ((const char **)data)[0] is AID value, See ETSI 102.221 8.1 and 101.220 4, NULL if no value.
1643  * "response" is a const char * containing the IMSI
1644  *
1645  * Valid errors:
1646  *  SUCCESS
1647  *  RADIO_NOT_AVAILABLE (radio resetting)
1648  *  GENERIC_FAILURE
1649  */
1650
1651 #define RIL_REQUEST_GET_IMSI 11
1652
1653 /**
1654  * RIL_REQUEST_HANGUP
1655  *
1656  * Hang up a specific line (like AT+CHLD=1x)
1657  *
1658  * After this HANGUP request returns, RIL should show the connection is NOT
1659  * active anymore in next RIL_REQUEST_GET_CURRENT_CALLS query.
1660  *
1661  * "data" is an int *
1662  * (int *)data)[0] contains Connection index (value of 'x' in CHLD above)
1663  *
1664  * "response" is NULL
1665  *
1666  * Valid errors:
1667  *  SUCCESS
1668  *  RADIO_NOT_AVAILABLE (radio resetting)
1669  *  GENERIC_FAILURE
1670  */
1671
1672 #define RIL_REQUEST_HANGUP 12
1673
1674 /**
1675  * RIL_REQUEST_HANGUP_WAITING_OR_BACKGROUND
1676  *
1677  * Hang up waiting or held (like AT+CHLD=0)
1678  *
1679  * After this HANGUP request returns, RIL should show the connection is NOT
1680  * active anymore in next RIL_REQUEST_GET_CURRENT_CALLS query.
1681  *
1682  * "data" is NULL
1683  * "response" is NULL
1684  *
1685  * Valid errors:
1686  *  SUCCESS
1687  *  RADIO_NOT_AVAILABLE (radio resetting)
1688  *  GENERIC_FAILURE
1689  */
1690
1691 #define RIL_REQUEST_HANGUP_WAITING_OR_BACKGROUND 13
1692
1693 /**
1694  * RIL_REQUEST_HANGUP_FOREGROUND_RESUME_BACKGROUND
1695  *
1696  * Hang up waiting or held (like AT+CHLD=1)
1697  *
1698  * After this HANGUP request returns, RIL should show the connection is NOT
1699  * active anymore in next RIL_REQUEST_GET_CURRENT_CALLS query.
1700  *
1701  * "data" is NULL
1702  * "response" is NULL
1703  *
1704  * Valid errors:
1705  *  SUCCESS
1706  *  RADIO_NOT_AVAILABLE (radio resetting)
1707  *  GENERIC_FAILURE
1708  */
1709
1710 #define RIL_REQUEST_HANGUP_FOREGROUND_RESUME_BACKGROUND 14
1711
1712 /**
1713  * RIL_REQUEST_SWITCH_WAITING_OR_HOLDING_AND_ACTIVE
1714  *
1715  * Switch waiting or holding call and active call (like AT+CHLD=2)
1716  *
1717  * State transitions should be is follows:
1718  *
1719  * If call 1 is waiting and call 2 is active, then if this re
1720  *
1721  *   BEFORE                               AFTER
1722  * Call 1   Call 2                 Call 1       Call 2
1723  * ACTIVE   HOLDING                HOLDING     ACTIVE
1724  * ACTIVE   WAITING                HOLDING     ACTIVE
1725  * HOLDING  WAITING                HOLDING     ACTIVE
1726  * ACTIVE   IDLE                   HOLDING     IDLE
1727  * IDLE     IDLE                   IDLE        IDLE
1728  *
1729  * "data" is NULL
1730  * "response" is NULL
1731  *
1732  * Valid errors:
1733  *  SUCCESS
1734  *  RADIO_NOT_AVAILABLE (radio resetting)
1735  *  GENERIC_FAILURE
1736  */
1737
1738 #define RIL_REQUEST_SWITCH_WAITING_OR_HOLDING_AND_ACTIVE 15
1739 #define RIL_REQUEST_SWITCH_HOLDING_AND_ACTIVE 15
1740
1741 /**
1742  * RIL_REQUEST_CONFERENCE
1743  *
1744  * Conference holding and active (like AT+CHLD=3)
1745
1746  * "data" is NULL
1747  * "response" is NULL
1748  *
1749  * Valid errors:
1750  *  SUCCESS
1751  *  RADIO_NOT_AVAILABLE (radio resetting)
1752  *  GENERIC_FAILURE
1753  */
1754 #define RIL_REQUEST_CONFERENCE 16
1755
1756 /**
1757  * RIL_REQUEST_UDUB
1758  *
1759  * Send UDUB (user determined used busy) to ringing or
1760  * waiting call answer)(RIL_BasicRequest r);
1761  *
1762  * "data" is NULL
1763  * "response" is NULL
1764  *
1765  * Valid errors:
1766  *  SUCCESS
1767  *  RADIO_NOT_AVAILABLE (radio resetting)
1768  *  GENERIC_FAILURE
1769  */
1770 #define RIL_REQUEST_UDUB 17
1771
1772 /**
1773  * RIL_REQUEST_LAST_CALL_FAIL_CAUSE
1774  *
1775  * Requests the failure cause code for the most recently terminated call
1776  *
1777  * "data" is NULL
1778  * "response" is a "int *"
1779  * ((int *)response)[0] is RIL_LastCallFailCause.  GSM failure reasons are
1780  * mapped to cause codes defined in TS 24.008 Annex H where possible. CDMA
1781  * failure reasons are derived from the possible call failure scenarios
1782  * described in the "CDMA IS-2000 Release A (C.S0005-A v6.0)" standard.
1783  *
1784  * The implementation should return CALL_FAIL_ERROR_UNSPECIFIED for blocked
1785  * MO calls by restricted state (See RIL_UNSOL_RESTRICTED_STATE_CHANGED)
1786  *
1787  * If the implementation does not have access to the exact cause codes,
1788  * then it should return one of the values listed in RIL_LastCallFailCause,
1789  * as the UI layer needs to distinguish these cases for tone generation or
1790  * error notification.
1791  *
1792  * Valid errors:
1793  *  SUCCESS
1794  *  RADIO_NOT_AVAILABLE
1795  *  GENERIC_FAILURE
1796  *
1797  * See also: RIL_REQUEST_LAST_DATA_CALL_FAIL_CAUSE
1798  */
1799 #define RIL_REQUEST_LAST_CALL_FAIL_CAUSE 18
1800
1801 /**
1802  * RIL_REQUEST_SIGNAL_STRENGTH
1803  *
1804  * Requests current signal strength and associated information
1805  *
1806  * Must succeed if radio is on.
1807  *
1808  * "data" is NULL
1809  *
1810  * "response" is a const RIL_SignalStrength *
1811  *
1812  * Valid errors:
1813  *  SUCCESS
1814  *  RADIO_NOT_AVAILABLE
1815  */
1816 #define RIL_REQUEST_SIGNAL_STRENGTH 19
1817
1818 /**
1819  * RIL_REQUEST_VOICE_REGISTRATION_STATE
1820  *
1821  * Request current registration state
1822  *
1823  * "data" is NULL
1824  * "response" is a "char **"
1825  * ((const char **)response)[0] is registration state 0-6,
1826  *              0 - Not registered, MT is not currently searching
1827  *                  a new operator to register
1828  *              1 - Registered, home network
1829  *              2 - Not registered, but MT is currently searching
1830  *                  a new operator to register
1831  *              3 - Registration denied
1832  *              4 - Unknown
1833  *              5 - Registered, roaming
1834  *             10 - Same as 0, but indicates that emergency calls
1835  *                  are enabled.
1836  *             12 - Same as 2, but indicates that emergency calls
1837  *                  are enabled.
1838  *             13 - Same as 3, but indicates that emergency calls
1839  *                  are enabled.
1840  *             14 - Same as 4, but indicates that emergency calls
1841  *                  are enabled.
1842  *
1843  * ((const char **)response)[1] is LAC if registered on a GSM/WCDMA system or
1844  *                              NULL if not.Valid LAC are 0x0000 - 0xffff
1845  * ((const char **)response)[2] is CID if registered on a * GSM/WCDMA or
1846  *                              NULL if not.
1847  *                                 Valid CID are 0x00000000 - 0xffffffff
1848  *                                    In GSM, CID is Cell ID (see TS 27.007)
1849  *                                            in 16 bits
1850  *                                    In UMTS, CID is UMTS Cell Identity
1851  *                                             (see TS 25.331) in 28 bits
1852  * ((const char **)response)[3] indicates the available voice radio technology,
1853  *                              valid values as defined by RIL_RadioTechnology.
1854  * ((const char **)response)[4] is Base Station ID if registered on a CDMA
1855  *                              system or NULL if not.  Base Station ID in
1856  *                              decimal format
1857  * ((const char **)response)[5] is Base Station latitude if registered on a
1858  *                              CDMA system or NULL if not. Base Station
1859  *                              latitude is a decimal number as specified in
1860  *                              3GPP2 C.S0005-A v6.0. It is represented in
1861  *                              units of 0.25 seconds and ranges from -1296000
1862  *                              to 1296000, both values inclusive (corresponding
1863  *                              to a range of -90 to +90 degrees).
1864  * ((const char **)response)[6] is Base Station longitude if registered on a
1865  *                              CDMA system or NULL if not. Base Station
1866  *                              longitude is a decimal number as specified in
1867  *                              3GPP2 C.S0005-A v6.0. It is represented in
1868  *                              units of 0.25 seconds and ranges from -2592000
1869  *                              to 2592000, both values inclusive (corresponding
1870  *                              to a range of -180 to +180 degrees).
1871  * ((const char **)response)[7] is concurrent services support indicator if
1872  *                              registered on a CDMA system 0-1.
1873  *                                   0 - Concurrent services not supported,
1874  *                                   1 - Concurrent services supported
1875  * ((const char **)response)[8] is System ID if registered on a CDMA system or
1876  *                              NULL if not. Valid System ID are 0 - 32767
1877  * ((const char **)response)[9] is Network ID if registered on a CDMA system or
1878  *                              NULL if not. Valid System ID are 0 - 65535
1879  * ((const char **)response)[10] is the TSB-58 Roaming Indicator if registered
1880  *                               on a CDMA or EVDO system or NULL if not. Valid values
1881  *                               are 0-255.
1882  * ((const char **)response)[11] indicates whether the current system is in the
1883  *                               PRL if registered on a CDMA or EVDO system or NULL if
1884  *                               not. 0=not in the PRL, 1=in the PRL
1885  * ((const char **)response)[12] is the default Roaming Indicator from the PRL,
1886  *                               if registered on a CDMA or EVDO system or NULL if not.
1887  *                               Valid values are 0-255.
1888  * ((const char **)response)[13] if registration state is 3 (Registration
1889  *                               denied) this is an enumerated reason why
1890  *                               registration was denied.  See 3GPP TS 24.008,
1891  *                               10.5.3.6 and Annex G.
1892  *                                 0 - General
1893  *                                 1 - Authentication Failure
1894  *                                 2 - IMSI unknown in HLR
1895  *                                 3 - Illegal MS
1896  *                                 4 - Illegal ME
1897  *                                 5 - PLMN not allowed
1898  *                                 6 - Location area not allowed
1899  *                                 7 - Roaming not allowed
1900  *                                 8 - No Suitable Cells in this Location Area
1901  *                                 9 - Network failure
1902  *                                10 - Persistent location update reject
1903  *                                11 - PLMN not allowed
1904  *                                12 - Location area not allowed
1905  *                                13 - Roaming not allowed in this Location Area
1906  *                                15 - No Suitable Cells in this Location Area
1907  *                                17 - Network Failure
1908  *                                20 - MAC Failure
1909  *                                21 - Sync Failure
1910  *                                22 - Congestion
1911  *                                23 - GSM Authentication unacceptable
1912  *                                25 - Not Authorized for this CSG
1913  *                                32 - Service option not supported
1914  *                                33 - Requested service option not subscribed
1915  *                                34 - Service option temporarily out of order
1916  *                                38 - Call cannot be identified
1917  *                                48-63 - Retry upon entry into a new cell
1918  *                                95 - Semantically incorrect message
1919  *                                96 - Invalid mandatory information
1920  *                                97 - Message type non-existent or not implemented
1921  *                                98 - Message not compatible with protocol state
1922  *                                99 - Information element non-existent or not implemented
1923  *                               100 - Conditional IE error
1924  *                               101 - Message not compatible with protocol state
1925  *                               111 - Protocol error, unspecified
1926  * ((const char **)response)[14] is the Primary Scrambling Code of the current
1927  *                               cell as described in TS 25.331, in hexadecimal
1928  *                               format, or NULL if unknown or not registered
1929  *                               to a UMTS network.
1930  *
1931  * Please note that registration state 4 ("unknown") is treated
1932  * as "out of service" in the Android telephony system
1933  *
1934  * Registration state 3 can be returned if Location Update Reject
1935  * (with cause 17 - Network Failure) is received repeatedly from the network,
1936  * to facilitate "managed roaming"
1937  *
1938  * Valid errors:
1939  *  SUCCESS
1940  *  RADIO_NOT_AVAILABLE
1941  *  GENERIC_FAILURE
1942  */
1943 #define RIL_REQUEST_VOICE_REGISTRATION_STATE 20
1944
1945 /**
1946  * RIL_REQUEST_DATA_REGISTRATION_STATE
1947  *
1948  * Request current DATA registration state
1949  *
1950  * "data" is NULL
1951  * "response" is a "char **"
1952  * ((const char **)response)[0] is registration state 0-5 from TS 27.007 10.1.20 AT+CGREG
1953  * ((const char **)response)[1] is LAC if registered or NULL if not
1954  * ((const char **)response)[2] is CID if registered or NULL if not
1955  * ((const char **)response)[3] indicates the available data radio technology,
1956  *                              valid values as defined by RIL_RadioTechnology.
1957  * ((const char **)response)[4] if registration state is 3 (Registration
1958  *                               denied) this is an enumerated reason why
1959  *                               registration was denied.  See 3GPP TS 24.008,
1960  *                               Annex G.6 "Additonal cause codes for GMM".
1961  *      7 == GPRS services not allowed
1962  *      8 == GPRS services and non-GPRS services not allowed
1963  *      9 == MS identity cannot be derived by the network
1964  *      10 == Implicitly detached
1965  *      14 == GPRS services not allowed in this PLMN
1966  *      16 == MSC temporarily not reachable
1967  *      40 == No PDP context activated
1968  * ((const char **)response)[5] The maximum number of simultaneous Data Calls that can be
1969  *                              established using RIL_REQUEST_SETUP_DATA_CALL.
1970  *
1971  * The values at offsets 6..10 are optional LTE location information in decimal.
1972  * If a value is unknown that value may be NULL. If all values are NULL,
1973  * none need to be present.
1974  *  ((const char **)response)[6] is TAC, a 16-bit Tracking Area Code.
1975  *  ((const char **)response)[7] is CID, a 0-503 Physical Cell Identifier.
1976  *  ((const char **)response)[8] is ECI, a 28-bit E-UTRAN Cell Identifier.
1977  *  ((const char **)response)[9] is CSGID, a 27-bit Closed Subscriber Group Identity.
1978  *  ((const char **)response)[10] is TADV, a 6-bit timing advance value.
1979  *
1980  * LAC and CID are in hexadecimal format.
1981  * valid LAC are 0x0000 - 0xffff
1982  * valid CID are 0x00000000 - 0x0fffffff
1983  *
1984  * Please note that registration state 4 ("unknown") is treated
1985  * as "out of service" in the Android telephony system
1986  *
1987  * Valid errors:
1988  *  SUCCESS
1989  *  RADIO_NOT_AVAILABLE
1990  *  GENERIC_FAILURE
1991  */
1992 #define RIL_REQUEST_DATA_REGISTRATION_STATE 21
1993
1994 /**
1995  * RIL_REQUEST_OPERATOR
1996  *
1997  * Request current operator ONS or EONS
1998  *
1999  * "data" is NULL
2000  * "response" is a "const char **"
2001  * ((const char **)response)[0] is long alpha ONS or EONS
2002  *                                  or NULL if unregistered
2003  *
2004  * ((const char **)response)[1] is short alpha ONS or EONS
2005  *                                  or NULL if unregistered
2006  * ((const char **)response)[2] is 5 or 6 digit numeric code (MCC + MNC)
2007  *                                  or NULL if unregistered
2008  *
2009  * Valid errors:
2010  *  SUCCESS
2011  *  RADIO_NOT_AVAILABLE
2012  *  GENERIC_FAILURE
2013  */
2014 #define RIL_REQUEST_OPERATOR 22
2015
2016 /**
2017  * RIL_REQUEST_RADIO_POWER
2018  *
2019  * Toggle radio on and off (for "airplane" mode)
2020  * If the radio is is turned off/on the radio modem subsystem
2021  * is expected return to an initialized state. For instance,
2022  * any voice and data calls will be terminated and all associated
2023  * lists emptied.
2024  *
2025  * "data" is int *
2026  * ((int *)data)[0] is > 0 for "Radio On"
2027  * ((int *)data)[0] is == 0 for "Radio Off"
2028  *
2029  * "response" is NULL
2030  *
2031  * Turn radio on if "on" > 0
2032  * Turn radio off if "on" == 0
2033  *
2034  * Valid errors:
2035  *  SUCCESS
2036  *  RADIO_NOT_AVAILABLE
2037  *  GENERIC_FAILURE
2038  */
2039 #define RIL_REQUEST_RADIO_POWER 23
2040
2041 /**
2042  * RIL_REQUEST_DTMF
2043  *
2044  * Send a DTMF tone
2045  *
2046  * If the implementation is currently playing a tone requested via
2047  * RIL_REQUEST_DTMF_START, that tone should be cancelled and the new tone
2048  * should be played instead
2049  *
2050  * "data" is a char * containing a single character with one of 12 values: 0-9,*,#
2051  * "response" is NULL
2052  *
2053  * FIXME should this block/mute microphone?
2054  * How does this interact with local DTMF feedback?
2055  *
2056  * Valid errors:
2057  *  SUCCESS
2058  *  RADIO_NOT_AVAILABLE
2059  *  GENERIC_FAILURE
2060  *
2061  * See also: RIL_REQUEST_DTMF_STOP, RIL_REQUEST_DTMF_START
2062  *
2063  */
2064 #define RIL_REQUEST_DTMF 24
2065
2066 /**
2067  * RIL_REQUEST_SEND_SMS
2068  *
2069  * Send an SMS message
2070  *
2071  * "data" is const char **
2072  * ((const char **)data)[0] is SMSC address in GSM BCD format prefixed
2073  *      by a length byte (as expected by TS 27.005) or NULL for default SMSC
2074  * ((const char **)data)[1] is SMS in PDU format as an ASCII hex string
2075  *      less the SMSC address
2076  *      TP-Layer-Length is be "strlen(((const char **)data)[1])/2"
2077  *
2078  * "response" is a const RIL_SMS_Response *
2079  *
2080  * Based on the return error, caller decides to resend if sending sms
2081  * fails. SMS_SEND_FAIL_RETRY means retry (i.e. error cause is 332)
2082  * and GENERIC_FAILURE means no retry (i.e. error cause is 500)
2083  *
2084  * Valid errors:
2085  *  SUCCESS
2086  *  RADIO_NOT_AVAILABLE
2087  *  SMS_SEND_FAIL_RETRY
2088  *  FDN_CHECK_FAILURE
2089  *  GENERIC_FAILURE
2090  *
2091  * FIXME how do we specify TP-Message-Reference if we need to resend?
2092  */
2093 #define RIL_REQUEST_SEND_SMS 25
2094
2095
2096 /**
2097  * RIL_REQUEST_SEND_SMS_EXPECT_MORE
2098  *
2099  * Send an SMS message. Identical to RIL_REQUEST_SEND_SMS,
2100  * except that more messages are expected to be sent soon. If possible,
2101  * keep SMS relay protocol link open (eg TS 27.005 AT+CMMS command)
2102  *
2103  * "data" is const char **
2104  * ((const char **)data)[0] is SMSC address in GSM BCD format prefixed
2105  *      by a length byte (as expected by TS 27.005) or NULL for default SMSC
2106  * ((const char **)data)[1] is SMS in PDU format as an ASCII hex string
2107  *      less the SMSC address
2108  *      TP-Layer-Length is be "strlen(((const char **)data)[1])/2"
2109  *
2110  * "response" is a const RIL_SMS_Response *
2111  *
2112  * Based on the return error, caller decides to resend if sending sms
2113  * fails. SMS_SEND_FAIL_RETRY means retry (i.e. error cause is 332)
2114  * and GENERIC_FAILURE means no retry (i.e. error cause is 500)
2115  *
2116  * Valid errors:
2117  *  SUCCESS
2118  *  RADIO_NOT_AVAILABLE
2119  *  SMS_SEND_FAIL_RETRY
2120  *  GENERIC_FAILURE
2121  *
2122  */
2123 #define RIL_REQUEST_SEND_SMS_EXPECT_MORE 26
2124
2125
2126 /**
2127  * RIL_REQUEST_SETUP_DATA_CALL
2128  *
2129  * Setup a packet data connection. If RIL_Data_Call_Response_v6.status
2130  * return success it is added to the list of data calls and a
2131  * RIL_UNSOL_DATA_CALL_LIST_CHANGED is sent. The call remains in the
2132  * list until RIL_REQUEST_DEACTIVATE_DATA_CALL is issued or the
2133  * radio is powered off/on. This list is returned by RIL_REQUEST_DATA_CALL_LIST
2134  * and RIL_UNSOL_DATA_CALL_LIST_CHANGED.
2135  *
2136  * The RIL is expected to:
2137  *  - Create one data call context.
2138  *  - Create and configure a dedicated interface for the context
2139  *  - The interface must be point to point.
2140  *  - The interface is configured with one or more addresses and
2141  *    is capable of sending and receiving packets. The prefix length
2142  *    of the addresses must be /32 for IPv4 and /128 for IPv6.
2143  *  - Must NOT change the linux routing table.
2144  *  - Support up to RIL_REQUEST_DATA_REGISTRATION_STATE response[5]
2145  *    number of simultaneous data call contexts.
2146  *
2147  * "data" is a const char **
2148  * ((const char **)data)[0] Radio technology to use: 0-CDMA, 1-GSM/UMTS, 2...
2149  *                          for values above 2 this is RIL_RadioTechnology + 2.
2150  * ((const char **)data)[1] is a RIL_DataProfile (support is optional)
2151  * ((const char **)data)[2] is the APN to connect to if radio technology is GSM/UMTS. This APN will
2152  *                          override the one in the profile. NULL indicates no APN overrride.
2153  * ((const char **)data)[3] is the username for APN, or NULL
2154  * ((const char **)data)[4] is the password for APN, or NULL
2155  * ((const char **)data)[5] is the PAP / CHAP auth type. Values:
2156  *                          0 => PAP and CHAP is never performed.
2157  *                          1 => PAP may be performed; CHAP is never performed.
2158  *                          2 => CHAP may be performed; PAP is never performed.
2159  *                          3 => PAP / CHAP may be performed - baseband dependent.
2160  * ((const char **)data)[6] is the connection type to request must be one of the
2161  *                          PDP_type values in TS 27.007 section 10.1.1.
2162  *                          For example, "IP", "IPV6", "IPV4V6", or "PPP".
2163  * ((const char **)data)[7] Optional connection property parameters, format to be defined.
2164  *
2165  * "response" is a RIL_Data_Call_Response_v11
2166  *
2167  * FIXME may need way to configure QoS settings
2168  *
2169  * Valid errors:
2170  *  SUCCESS should be returned on both success and failure of setup with
2171  *  the RIL_Data_Call_Response_v6.status containing the actual status.
2172  *  For all other errors the RIL_Data_Call_Resonse_v6 is ignored.
2173  *
2174  *  Other errors could include:
2175  *    RADIO_NOT_AVAILABLE, GENERIC_FAILURE, OP_NOT_ALLOWED_BEFORE_REG_TO_NW,
2176  *    OP_NOT_ALLOWED_DURING_VOICE_CALL and REQUEST_NOT_SUPPORTED.
2177  *
2178  * See also: RIL_REQUEST_DEACTIVATE_DATA_CALL
2179  */
2180 #define RIL_REQUEST_SETUP_DATA_CALL 27
2181
2182
2183 /**
2184  * RIL_REQUEST_SIM_IO
2185  *
2186  * Request SIM I/O operation.
2187  * This is similar to the TS 27.007 "restricted SIM" operation
2188  * where it assumes all of the EF selection will be done by the
2189  * callee.
2190  *
2191  * "data" is a const RIL_SIM_IO_v6 *
2192  * Please note that RIL_SIM_IO has a "PIN2" field which may be NULL,
2193  * or may specify a PIN2 for operations that require a PIN2 (eg
2194  * updating FDN records)
2195  *
2196  * "response" is a const RIL_SIM_IO_Response *
2197  *
2198  * Arguments and responses that are unused for certain
2199  * values of "command" should be ignored or set to NULL
2200  *
2201  * Valid errors:
2202  *  SUCCESS
2203  *  RADIO_NOT_AVAILABLE
2204  *  GENERIC_FAILURE
2205  *  SIM_PIN2
2206  *  SIM_PUK2
2207  */
2208 #define RIL_REQUEST_SIM_IO 28
2209
2210 /**
2211  * RIL_REQUEST_SEND_USSD
2212  *
2213  * Send a USSD message
2214  *
2215  * If a USSD session already exists, the message should be sent in the
2216  * context of that session. Otherwise, a new session should be created.
2217  *
2218  * The network reply should be reported via RIL_UNSOL_ON_USSD
2219  *
2220  * Only one USSD session may exist at a time, and the session is assumed
2221  * to exist until:
2222  *   a) The android system invokes RIL_REQUEST_CANCEL_USSD
2223  *   b) The implementation sends a RIL_UNSOL_ON_USSD with a type code
2224  *      of "0" (USSD-Notify/no further action) or "2" (session terminated)
2225  *
2226  * "data" is a const char * containing the USSD request in UTF-8 format
2227  * "response" is NULL
2228  *
2229  * Valid errors:
2230  *  SUCCESS
2231  *  RADIO_NOT_AVAILABLE
2232  *  FDN_CHECK_FAILURE
2233  *  USSD_MODIFIED_TO_DIAL
2234  *  USSD_MODIFIED_TO_SS
2235  *  USSD_MODIFIED_TO_USSD
2236  *  GENERIC_FAILURE
2237  *
2238  * See also: RIL_REQUEST_CANCEL_USSD, RIL_UNSOL_ON_USSD
2239  */
2240
2241 #define RIL_REQUEST_SEND_USSD 29
2242
2243 /**
2244  * RIL_REQUEST_CANCEL_USSD
2245  *
2246  * Cancel the current USSD session if one exists
2247  *
2248  * "data" is null
2249  * "response" is NULL
2250  *
2251  * Valid errors:
2252  *  SUCCESS
2253  *  RADIO_NOT_AVAILABLE
2254  *  GENERIC_FAILURE
2255  */
2256
2257 #define RIL_REQUEST_CANCEL_USSD 30
2258
2259 /**
2260  * RIL_REQUEST_GET_CLIR
2261  *
2262  * Gets current CLIR status
2263  * "data" is NULL
2264  * "response" is int *
2265  * ((int *)data)[0] is "n" parameter from TS 27.007 7.7
2266  * ((int *)data)[1] is "m" parameter from TS 27.007 7.7
2267  *
2268  * Valid errors:
2269  *  SUCCESS
2270  *  RADIO_NOT_AVAILABLE
2271  *  SS_MODIFIED_TO_DIAL
2272  *  SS_MODIFIED_TO_USSD
2273  *  SS_MODIFIED_TO_SS
2274  *  GENERIC_FAILURE
2275  */
2276 #define RIL_REQUEST_GET_CLIR 31
2277
2278 /**
2279  * RIL_REQUEST_SET_CLIR
2280  *
2281  * "data" is int *
2282  * ((int *)data)[0] is "n" parameter from TS 27.007 7.7
2283  *
2284  * "response" is NULL
2285  *
2286  * Valid errors:
2287  *  SUCCESS
2288  *  RADIO_NOT_AVAILABLE
2289  *  SS_MODIFIED_TO_DIAL
2290  *  SS_MODIFIED_TO_USSD
2291  *  SS_MODIFIED_TO_SS
2292  *  GENERIC_FAILURE
2293  */
2294 #define RIL_REQUEST_SET_CLIR 32
2295
2296 /**
2297  * RIL_REQUEST_QUERY_CALL_FORWARD_STATUS
2298  *
2299  * "data" is const RIL_CallForwardInfo *
2300  *
2301  * "response" is const RIL_CallForwardInfo **
2302  * "response" points to an array of RIL_CallForwardInfo *'s, one for
2303  * each distinct registered phone number.
2304  *
2305  * For example, if data is forwarded to +18005551212 and voice is forwarded
2306  * to +18005559999, then two separate RIL_CallForwardInfo's should be returned
2307  *
2308  * If, however, both data and voice are forwarded to +18005551212, then
2309  * a single RIL_CallForwardInfo can be returned with the service class
2310  * set to "data + voice = 3")
2311  *
2312  * Valid errors:
2313  *  SUCCESS
2314  *  RADIO_NOT_AVAILABLE
2315  *  SS_MODIFIED_TO_DIAL
2316  *  SS_MODIFIED_TO_USSD
2317  *  SS_MODIFIED_TO_SS
2318  *  GENERIC_FAILURE
2319  */
2320 #define RIL_REQUEST_QUERY_CALL_FORWARD_STATUS 33
2321
2322
2323 /**
2324  * RIL_REQUEST_SET_CALL_FORWARD
2325  *
2326  * Configure call forward rule
2327  *
2328  * "data" is const RIL_CallForwardInfo *
2329  * "response" is NULL
2330  *
2331  * Valid errors:
2332  *  SUCCESS
2333  *  RADIO_NOT_AVAILABLE
2334  *  SS_MODIFIED_TO_DIAL
2335  *  SS_MODIFIED_TO_USSD
2336  *  SS_MODIFIED_TO_SS
2337  *  GENERIC_FAILURE
2338  */
2339 #define RIL_REQUEST_SET_CALL_FORWARD 34
2340
2341
2342 /**
2343  * RIL_REQUEST_QUERY_CALL_WAITING
2344  *
2345  * Query current call waiting state
2346  *
2347  * "data" is const int *
2348  * ((const int *)data)[0] is the TS 27.007 service class to query.
2349  * "response" is a const int *
2350  * ((const int *)response)[0] is 0 for "disabled" and 1 for "enabled"
2351  *
2352  * If ((const int *)response)[0] is = 1, then ((const int *)response)[1]
2353  * must follow, with the TS 27.007 service class bit vector of services
2354  * for which call waiting is enabled.
2355  *
2356  * For example, if ((const int *)response)[0]  is 1 and
2357  * ((const int *)response)[1] is 3, then call waiting is enabled for data
2358  * and voice and disabled for everything else
2359  *
2360  * Valid errors:
2361  *  SUCCESS
2362  *  RADIO_NOT_AVAILABLE
2363  *  SS_MODIFIED_TO_DIAL
2364  *  SS_MODIFIED_TO_USSD
2365  *  SS_MODIFIED_TO_SS
2366  *  GENERIC_FAILURE
2367  */
2368 #define RIL_REQUEST_QUERY_CALL_WAITING 35
2369
2370
2371 /**
2372  * RIL_REQUEST_SET_CALL_WAITING
2373  *
2374  * Configure current call waiting state
2375  *
2376  * "data" is const int *
2377  * ((const int *)data)[0] is 0 for "disabled" and 1 for "enabled"
2378  * ((const int *)data)[1] is the TS 27.007 service class bit vector of
2379  *                           services to modify
2380  * "response" is NULL
2381  *
2382  * Valid errors:
2383  *  SUCCESS
2384  *  RADIO_NOT_AVAILABLE
2385  *  SS_MODIFIED_TO_DIAL
2386  *  SS_MODIFIED_TO_USSD
2387  *  SS_MODIFIED_TO_SS
2388  *  GENERIC_FAILURE
2389  */
2390 #define RIL_REQUEST_SET_CALL_WAITING 36
2391
2392 /**
2393  * RIL_REQUEST_SMS_ACKNOWLEDGE
2394  *
2395  * Acknowledge successful or failed receipt of SMS previously indicated
2396  * via RIL_UNSOL_RESPONSE_NEW_SMS
2397  *
2398  * "data" is int *
2399  * ((int *)data)[0] is 1 on successful receipt
2400  *                  (basically, AT+CNMA=1 from TS 27.005
2401  *                  is 0 on failed receipt
2402  *                  (basically, AT+CNMA=2 from TS 27.005)
2403  * ((int *)data)[1] if data[0] is 0, this contains the failure cause as defined
2404  *                  in TS 23.040, 9.2.3.22. Currently only 0xD3 (memory
2405  *                  capacity exceeded) and 0xFF (unspecified error) are
2406  *                  reported.
2407  *
2408  * "response" is NULL
2409  *
2410  * FIXME would like request that specified RP-ACK/RP-ERROR PDU
2411  *
2412  * Valid errors:
2413  *  SUCCESS
2414  *  RADIO_NOT_AVAILABLE
2415  *  GENERIC_FAILURE
2416  */
2417 #define RIL_REQUEST_SMS_ACKNOWLEDGE  37
2418
2419 /**
2420  * RIL_REQUEST_GET_IMEI - DEPRECATED
2421  *
2422  * Get the device IMEI, including check digit
2423  *
2424  * The request is DEPRECATED, use RIL_REQUEST_DEVICE_IDENTITY
2425  * Valid when RadioState is not RADIO_STATE_UNAVAILABLE
2426  *
2427  * "data" is NULL
2428  * "response" is a const char * containing the IMEI
2429  *
2430  * Valid errors:
2431  *  SUCCESS
2432  *  RADIO_NOT_AVAILABLE (radio resetting)
2433  *  GENERIC_FAILURE
2434  */
2435
2436 #define RIL_REQUEST_GET_IMEI 38
2437
2438 /**
2439  * RIL_REQUEST_GET_IMEISV - DEPRECATED
2440  *
2441  * Get the device IMEISV, which should be two decimal digits
2442  *
2443  * The request is DEPRECATED, use RIL_REQUEST_DEVICE_IDENTITY
2444  * Valid when RadioState is not RADIO_STATE_UNAVAILABLE
2445  *
2446  * "data" is NULL
2447  * "response" is a const char * containing the IMEISV
2448  *
2449  * Valid errors:
2450  *  SUCCESS
2451  *  RADIO_NOT_AVAILABLE (radio resetting)
2452  *  GENERIC_FAILURE
2453  */
2454
2455 #define RIL_REQUEST_GET_IMEISV 39
2456
2457
2458 /**
2459  * RIL_REQUEST_ANSWER
2460  *
2461  * Answer incoming call
2462  *
2463  * Will not be called for WAITING calls.
2464  * RIL_REQUEST_SWITCH_WAITING_OR_HOLDING_AND_ACTIVE will be used in this case
2465  * instead
2466  *
2467  * "data" is NULL
2468  * "response" is NULL
2469  *
2470  * Valid errors:
2471  *  SUCCESS
2472  *  RADIO_NOT_AVAILABLE (radio resetting)
2473  *  GENERIC_FAILURE
2474  */
2475
2476 #define RIL_REQUEST_ANSWER 40
2477
2478 /**
2479  * RIL_REQUEST_DEACTIVATE_DATA_CALL
2480  *
2481  * Deactivate packet data connection and remove from the
2482  * data call list if SUCCESS is returned. Any other return
2483  * values should also try to remove the call from the list,
2484  * but that may not be possible. In any event a
2485  * RIL_REQUEST_RADIO_POWER off/on must clear the list. An
2486  * RIL_UNSOL_DATA_CALL_LIST_CHANGED is not expected to be
2487  * issued because of an RIL_REQUEST_DEACTIVATE_DATA_CALL.
2488  *
2489  * "data" is const char **
2490  * ((char**)data)[0] indicating CID
2491  * ((char**)data)[1] indicating Disconnect Reason
2492  *                   0 => No specific reason specified
2493  *                   1 => Radio shutdown requested
2494  *
2495  * "response" is NULL
2496  *
2497  * Valid errors:
2498  *  SUCCESS
2499  *  RADIO_NOT_AVAILABLE
2500  *  GENERIC_FAILURE
2501  *
2502  * See also: RIL_REQUEST_SETUP_DATA_CALL
2503  */
2504 #define RIL_REQUEST_DEACTIVATE_DATA_CALL 41
2505
2506 /**
2507  * RIL_REQUEST_QUERY_FACILITY_LOCK
2508  *
2509  * Query the status of a facility lock state
2510  *
2511  * "data" is const char **
2512  * ((const char **)data)[0] is the facility string code from TS 27.007 7.4
2513  *                      (eg "AO" for BAOC, "SC" for SIM lock)
2514  * ((const char **)data)[1] is the password, or "" if not required
2515  * ((const char **)data)[2] is the TS 27.007 service class bit vector of
2516  *                           services to query
2517  * ((const char **)data)[3] is AID value, See ETSI 102.221 8.1 and 101.220 4, NULL if no value.
2518  *                            This is only applicable in the case of Fixed Dialing Numbers
2519  *                            (FDN) requests.
2520  *
2521  * "response" is an int *
2522  * ((const int *)response) 0 is the TS 27.007 service class bit vector of
2523  *                           services for which the specified barring facility
2524  *                           is active. "0" means "disabled for all"
2525  *
2526  *
2527  * Valid errors:
2528  *  SUCCESS
2529  *  RADIO_NOT_AVAILABLE
2530  *  SS_MODIFIED_TO_DIAL
2531  *  SS_MODIFIED_TO_USSD
2532  *  SS_MODIFIED_TO_SS
2533  *  GENERIC_FAILURE
2534  *
2535  */
2536 #define RIL_REQUEST_QUERY_FACILITY_LOCK 42
2537
2538 /**
2539  * RIL_REQUEST_SET_FACILITY_LOCK
2540  *
2541  * Enable/disable one facility lock
2542  *
2543  * "data" is const char **
2544  *
2545  * ((const char **)data)[0] = facility string code from TS 27.007 7.4
2546  * (eg "AO" for BAOC)
2547  * ((const char **)data)[1] = "0" for "unlock" and "1" for "lock"
2548  * ((const char **)data)[2] = password
2549  * ((const char **)data)[3] = string representation of decimal TS 27.007
2550  *                            service class bit vector. Eg, the string
2551  *                            "1" means "set this facility for voice services"
2552  * ((const char **)data)[4] = AID value, See ETSI 102.221 8.1 and 101.220 4, NULL if no value.
2553  *                            This is only applicable in the case of Fixed Dialing Numbers
2554  *                            (FDN) requests.
2555  *
2556  * "response" is int *
2557  * ((int *)response)[0] is the number of retries remaining, or -1 if unknown
2558  *
2559  * Valid errors:
2560  *  SUCCESS
2561  *  RADIO_NOT_AVAILABLE
2562  *  SS_MODIFIED_TO_DIAL
2563  *  SS_MODIFIED_TO_USSD
2564  *  SS_MODIFIED_TO_SS
2565  *  GENERIC_FAILURE
2566  *
2567  */
2568 #define RIL_REQUEST_SET_FACILITY_LOCK 43
2569
2570 /**
2571  * RIL_REQUEST_CHANGE_BARRING_PASSWORD
2572  *
2573  * Change call barring facility password
2574  *
2575  * "data" is const char **
2576  *
2577  * ((const char **)data)[0] = facility string code from TS 27.007 7.4
2578  * (eg "AO" for BAOC)
2579  * ((const char **)data)[1] = old password
2580  * ((const char **)data)[2] = new password
2581  *
2582  * "response" is NULL
2583  *
2584  * Valid errors:
2585  *  SUCCESS
2586  *  RADIO_NOT_AVAILABLE
2587  *  SS_MODIFIED_TO_DIAL
2588  *  SS_MODIFIED_TO_USSD
2589  *  SS_MODIFIED_TO_SS
2590  *  GENERIC_FAILURE
2591  *
2592  */
2593 #define RIL_REQUEST_CHANGE_BARRING_PASSWORD 44
2594
2595 /**
2596  * RIL_REQUEST_QUERY_NETWORK_SELECTION_MODE
2597  *
2598  * Query current network selectin mode
2599  *
2600  * "data" is NULL
2601  *
2602  * "response" is int *
2603  * ((const int *)response)[0] is
2604  *     0 for automatic selection
2605  *     1 for manual selection
2606  *
2607  * Valid errors:
2608  *  SUCCESS
2609  *  RADIO_NOT_AVAILABLE
2610  *  GENERIC_FAILURE
2611  *
2612  */
2613 #define RIL_REQUEST_QUERY_NETWORK_SELECTION_MODE 45
2614
2615 /**
2616  * RIL_REQUEST_SET_NETWORK_SELECTION_AUTOMATIC
2617  *
2618  * Specify that the network should be selected automatically
2619  *
2620  * "data" is NULL
2621  * "response" is NULL
2622  *
2623  * This request must not respond until the new operator is selected
2624  * and registered
2625  *
2626  * Valid errors:
2627  *  SUCCESS
2628  *  RADIO_NOT_AVAILABLE
2629  *  ILLEGAL_SIM_OR_ME
2630  *  GENERIC_FAILURE
2631  *
2632  * Note: Returns ILLEGAL_SIM_OR_ME when the failure is permanent and
2633  *       no retries needed, such as illegal SIM or ME.
2634  *       Returns GENERIC_FAILURE for all other causes that might be
2635  *       fixed by retries.
2636  *
2637  */
2638 #define RIL_REQUEST_SET_NETWORK_SELECTION_AUTOMATIC 46
2639
2640 /**
2641  * RIL_REQUEST_SET_NETWORK_SELECTION_MANUAL
2642  *
2643  * Manually select a specified network.
2644  *
2645  * "data" is const char * specifying MCCMNC of network to select (eg "310170")
2646  * "response" is NULL
2647  *
2648  * This request must not respond until the new operator is selected
2649  * and registered
2650  *
2651  * Valid errors:
2652  *  SUCCESS
2653  *  RADIO_NOT_AVAILABLE
2654  *  ILLEGAL_SIM_OR_ME
2655  *  GENERIC_FAILURE
2656  *
2657  * Note: Returns ILLEGAL_SIM_OR_ME when the failure is permanent and
2658  *       no retries needed, such as illegal SIM or ME.
2659  *       Returns GENERIC_FAILURE for all other causes that might be
2660  *       fixed by retries.
2661  *
2662  */
2663 #define RIL_REQUEST_SET_NETWORK_SELECTION_MANUAL 47
2664
2665 /**
2666  * RIL_REQUEST_QUERY_AVAILABLE_NETWORKS
2667  *
2668  * Scans for available networks
2669  *
2670  * "data" is NULL
2671  * "response" is const char ** that should be an array of n*4 strings, where
2672  *    n is the number of available networks
2673  * For each available network:
2674  *
2675  * ((const char **)response)[n+0] is long alpha ONS or EONS
2676  * ((const char **)response)[n+1] is short alpha ONS or EONS
2677  * ((const char **)response)[n+2] is 5 or 6 digit numeric code (MCC + MNC)
2678  * ((const char **)response)[n+3] is a string value of the status:
2679  *           "unknown"
2680  *           "available"
2681  *           "current"
2682  *           "forbidden"
2683  *
2684  * This request must not respond until the new operator is selected
2685  * and registered
2686  *
2687  * Valid errors:
2688  *  SUCCESS
2689  *  RADIO_NOT_AVAILABLE
2690  *  GENERIC_FAILURE
2691  *
2692  */
2693 #define RIL_REQUEST_QUERY_AVAILABLE_NETWORKS 48
2694
2695 /**
2696  * RIL_REQUEST_DTMF_START
2697  *
2698  * Start playing a DTMF tone. Continue playing DTMF tone until
2699  * RIL_REQUEST_DTMF_STOP is received
2700  *
2701  * If a RIL_REQUEST_DTMF_START is received while a tone is currently playing,
2702  * it should cancel the previous tone and play the new one.
2703  *
2704  * "data" is a char *
2705  * ((char *)data)[0] is a single character with one of 12 values: 0-9,*,#
2706  * "response" is NULL
2707  *
2708  * Valid errors:
2709  *  SUCCESS
2710  *  RADIO_NOT_AVAILABLE
2711  *  GENERIC_FAILURE
2712  *
2713  * See also: RIL_REQUEST_DTMF, RIL_REQUEST_DTMF_STOP
2714  */
2715 #define RIL_REQUEST_DTMF_START 49
2716
2717 /**
2718  * RIL_REQUEST_DTMF_STOP
2719  *
2720  * Stop playing a currently playing DTMF tone.
2721  *
2722  * "data" is NULL
2723  * "response" is NULL
2724  *
2725  * Valid errors:
2726  *  SUCCESS
2727  *  RADIO_NOT_AVAILABLE
2728  *  GENERIC_FAILURE
2729  *
2730  * See also: RIL_REQUEST_DTMF, RIL_REQUEST_DTMF_START
2731  */
2732 #define RIL_REQUEST_DTMF_STOP 50
2733
2734 /**
2735  * RIL_REQUEST_BASEBAND_VERSION
2736  *
2737  * Return string value indicating baseband version, eg
2738  * response from AT+CGMR
2739  *
2740  * "data" is NULL
2741  * "response" is const char * containing version string for log reporting
2742  *
2743  * Valid errors:
2744  *  SUCCESS
2745  *  RADIO_NOT_AVAILABLE
2746  *  GENERIC_FAILURE
2747  *
2748  */
2749 #define RIL_REQUEST_BASEBAND_VERSION 51
2750
2751 /**
2752  * RIL_REQUEST_SEPARATE_CONNECTION
2753  *
2754  * Separate a party from a multiparty call placing the multiparty call
2755  * (less the specified party) on hold and leaving the specified party
2756  * as the only other member of the current (active) call
2757  *
2758  * Like AT+CHLD=2x
2759  *
2760  * See TS 22.084 1.3.8.2 (iii)
2761  * TS 22.030 6.5.5 "Entering "2X followed by send"
2762  * TS 27.007 "AT+CHLD=2x"
2763  *
2764  * "data" is an int *
2765  * (int *)data)[0] contains Connection index (value of 'x' in CHLD above) "response" is NULL
2766  *
2767  * "response" is NULL
2768  *
2769  * Valid errors:
2770  *  SUCCESS
2771  *  RADIO_NOT_AVAILABLE (radio resetting)
2772  *  GENERIC_FAILURE
2773  */
2774 #define RIL_REQUEST_SEPARATE_CONNECTION 52
2775
2776
2777 /**
2778  * RIL_REQUEST_SET_MUTE
2779  *
2780  * Turn on or off uplink (microphone) mute.
2781  *
2782  * Will only be sent while voice call is active.
2783  * Will always be reset to "disable mute" when a new voice call is initiated
2784  *
2785  * "data" is an int *
2786  * (int *)data)[0] is 1 for "enable mute" and 0 for "disable mute"
2787  *
2788  * "response" is NULL
2789  *
2790  * Valid errors:
2791  *  SUCCESS
2792  *  RADIO_NOT_AVAILABLE (radio resetting)
2793  *  GENERIC_FAILURE
2794  */
2795
2796 #define RIL_REQUEST_SET_MUTE 53
2797
2798 /**
2799  * RIL_REQUEST_GET_MUTE
2800  *
2801  * Queries the current state of the uplink mute setting
2802  *
2803  * "data" is NULL
2804  * "response" is an int *
2805  * (int *)response)[0] is 1 for "mute enabled" and 0 for "mute disabled"
2806  *
2807  * Valid errors:
2808  *  SUCCESS
2809  *  RADIO_NOT_AVAILABLE (radio resetting)
2810  *  SS_MODIFIED_TO_DIAL
2811  *  SS_MODIFIED_TO_USSD
2812  *  SS_MODIFIED_TO_SS
2813  *  GENERIC_FAILURE
2814  */
2815
2816 #define RIL_REQUEST_GET_MUTE 54
2817
2818 /**
2819  * RIL_REQUEST_QUERY_CLIP
2820  *
2821  * Queries the status of the CLIP supplementary service
2822  *
2823  * (for MMI code "*#30#")
2824  *
2825  * "data" is NULL
2826  * "response" is an int *
2827  * (int *)response)[0] is 1 for "CLIP provisioned"
2828  *                           and 0 for "CLIP not provisioned"
2829  *                           and 2 for "unknown, e.g. no network etc"
2830  *
2831  * Valid errors:
2832  *  SUCCESS
2833  *  RADIO_NOT_AVAILABLE (radio resetting)
2834  *  GENERIC_FAILURE
2835  */
2836
2837 #define RIL_REQUEST_QUERY_CLIP 55
2838
2839 /**
2840  * RIL_REQUEST_LAST_DATA_CALL_FAIL_CAUSE - Deprecated use the status
2841  * field in RIL_Data_Call_Response_v6.
2842  *
2843  * Requests the failure cause code for the most recently failed PDP
2844  * context or CDMA data connection active
2845  * replaces RIL_REQUEST_LAST_PDP_FAIL_CAUSE
2846  *
2847  * "data" is NULL
2848  *
2849  * "response" is a "int *"
2850  * ((int *)response)[0] is an integer cause code defined in TS 24.008
2851  *   section 6.1.3.1.3 or close approximation
2852  *
2853  * If the implementation does not have access to the exact cause codes,
2854  * then it should return one of the values listed in
2855  * RIL_DataCallFailCause, as the UI layer needs to distinguish these
2856  * cases for error notification
2857  * and potential retries.
2858  *
2859  * Valid errors:
2860  *  SUCCESS
2861  *  RADIO_NOT_AVAILABLE
2862  *  GENERIC_FAILURE
2863  *
2864  * See also: RIL_REQUEST_LAST_CALL_FAIL_CAUSE
2865  *
2866  * Deprecated use the status field in RIL_Data_Call_Response_v6.
2867  */
2868
2869 #define RIL_REQUEST_LAST_DATA_CALL_FAIL_CAUSE 56
2870
2871 /**
2872  * RIL_REQUEST_DATA_CALL_LIST
2873  *
2874  * Returns the data call list. An entry is added when a
2875  * RIL_REQUEST_SETUP_DATA_CALL is issued and removed on a
2876  * RIL_REQUEST_DEACTIVATE_DATA_CALL. The list is emptied
2877  * when RIL_REQUEST_RADIO_POWER off/on is issued.
2878  *
2879  * "data" is NULL
2880  * "response" is an array of RIL_Data_Call_Response_v6
2881  *
2882  * Valid errors:
2883  *  SUCCESS
2884  *  RADIO_NOT_AVAILABLE (radio resetting)
2885  *  GENERIC_FAILURE
2886  *
2887  * See also: RIL_UNSOL_DATA_CALL_LIST_CHANGED
2888  */
2889
2890 #define RIL_REQUEST_DATA_CALL_LIST 57
2891
2892 /**
2893  * RIL_REQUEST_RESET_RADIO - DEPRECATED
2894  *
2895  * Request a radio reset. The RIL implementation may postpone
2896  * the reset until after this request is responded to if the baseband
2897  * is presently busy.
2898  *
2899  * The request is DEPRECATED, use RIL_REQUEST_RADIO_POWER
2900  *
2901  * "data" is NULL
2902  * "response" is NULL
2903  *
2904  * Valid errors:
2905  *  SUCCESS
2906  *  RADIO_NOT_AVAILABLE (radio resetting)
2907  *  GENERIC_FAILURE
2908  *  REQUEST_NOT_SUPPORTED
2909  */
2910
2911 #define RIL_REQUEST_RESET_RADIO 58
2912
2913 /**
2914  * RIL_REQUEST_OEM_HOOK_RAW
2915  *
2916  * This request reserved for OEM-specific uses. It passes raw byte arrays
2917  * back and forth.
2918  *
2919  * It can be invoked on the Java side from
2920  * com.android.internal.telephony.Phone.invokeOemRilRequestRaw()
2921  *
2922  * "data" is a char * of bytes copied from the byte[] data argument in java
2923  * "response" is a char * of bytes that will returned via the
2924  * caller's "response" Message here:
2925  * (byte[])(((AsyncResult)response.obj).result)
2926  *
2927  * An error response here will result in
2928  * (((AsyncResult)response.obj).result) == null and
2929  * (((AsyncResult)response.obj).exception) being an instance of
2930  * com.android.internal.telephony.gsm.CommandException
2931  *
2932  * Valid errors:
2933  *  All
2934  */
2935
2936 #define RIL_REQUEST_OEM_HOOK_RAW 59
2937
2938 /**
2939  * RIL_REQUEST_OEM_HOOK_STRINGS
2940  *
2941  * This request reserved for OEM-specific uses. It passes strings
2942  * back and forth.
2943  *
2944  * It can be invoked on the Java side from
2945  * com.android.internal.telephony.Phone.invokeOemRilRequestStrings()
2946  *
2947  * "data" is a const char **, representing an array of null-terminated UTF-8
2948  * strings copied from the "String[] strings" argument to
2949  * invokeOemRilRequestStrings()
2950  *
2951  * "response" is a const char **, representing an array of null-terminated UTF-8
2952  * stings that will be returned via the caller's response message here:
2953  *
2954  * (String[])(((AsyncResult)response.obj).result)
2955  *
2956  * An error response here will result in
2957  * (((AsyncResult)response.obj).result) == null and
2958  * (((AsyncResult)response.obj).exception) being an instance of
2959  * com.android.internal.telephony.gsm.CommandException
2960  *
2961  * Valid errors:
2962  *  All
2963  */
2964
2965 #define RIL_REQUEST_OEM_HOOK_STRINGS 60
2966
2967 /**
2968  * RIL_REQUEST_SCREEN_STATE
2969  *
2970  * Indicates the current state of the screen.  When the screen is off, the
2971  * RIL should notify the baseband to suppress certain notifications (eg,
2972  * signal strength and changes in LAC/CID or BID/SID/NID/latitude/longitude)
2973  * in an effort to conserve power.  These notifications should resume when the
2974  * screen is on.
2975  *
2976  * "data" is int *
2977  * ((int *)data)[0] is == 1 for "Screen On"
2978  * ((int *)data)[0] is == 0 for "Screen Off"
2979  *
2980  * "response" is NULL
2981  *
2982  * Valid errors:
2983  *  SUCCESS
2984  *  GENERIC_FAILURE
2985  */
2986 #define RIL_REQUEST_SCREEN_STATE 61
2987
2988
2989 /**
2990  * RIL_REQUEST_SET_SUPP_SVC_NOTIFICATION
2991  *
2992  * Enables/disables supplementary service related notifications
2993  * from the network.
2994  *
2995  * Notifications are reported via RIL_UNSOL_SUPP_SVC_NOTIFICATION.
2996  *
2997  * "data" is int *
2998  * ((int *)data)[0] is == 1 for notifications enabled
2999  * ((int *)data)[0] is == 0 for notifications disabled
3000  *
3001  * "response" is NULL
3002  *
3003  * Valid errors:
3004  *  SUCCESS
3005  *  RADIO_NOT_AVAILABLE
3006  *  GENERIC_FAILURE
3007  *
3008  * See also: RIL_UNSOL_SUPP_SVC_NOTIFICATION.
3009  */
3010 #define RIL_REQUEST_SET_SUPP_SVC_NOTIFICATION 62
3011
3012 /**
3013  * RIL_REQUEST_WRITE_SMS_TO_SIM
3014  *
3015  * Stores a SMS message to SIM memory.
3016  *
3017  * "data" is RIL_SMS_WriteArgs *
3018  *
3019  * "response" is int *
3020  * ((const int *)response)[0] is the record index where the message is stored.
3021  *
3022  * Valid errors:
3023  *  SUCCESS
3024  *  GENERIC_FAILURE
3025  *
3026  */
3027 #define RIL_REQUEST_WRITE_SMS_TO_SIM 63
3028
3029 /**
3030  * RIL_REQUEST_DELETE_SMS_ON_SIM
3031  *
3032  * Deletes a SMS message from SIM memory.
3033  *
3034  * "data" is int  *
3035  * ((int *)data)[0] is the record index of the message to delete.
3036  *
3037  * "response" is NULL
3038  *
3039  * Valid errors:
3040  *  SUCCESS
3041  *  GENERIC_FAILURE
3042  *
3043  */
3044 #define RIL_REQUEST_DELETE_SMS_ON_SIM 64
3045
3046 /**
3047  * RIL_REQUEST_SET_BAND_MODE
3048  *
3049  * Assign a specified band for RF configuration.
3050  *
3051  * "data" is int *
3052  * ((int *)data)[0] is == 0 for "unspecified" (selected by baseband automatically)
3053  * ((int *)data)[0] is == 1 for "EURO band" (GSM-900 / DCS-1800 / WCDMA-IMT-2000)
3054  * ((int *)data)[0] is == 2 for "US band" (GSM-850 / PCS-1900 / WCDMA-850 / WCDMA-PCS-1900)
3055  * ((int *)data)[0] is == 3 for "JPN band" (WCDMA-800 / WCDMA-IMT-2000)
3056  * ((int *)data)[0] is == 4 for "AUS band" (GSM-900 / DCS-1800 / WCDMA-850 / WCDMA-IMT-2000)
3057  * ((int *)data)[0] is == 5 for "AUS band 2" (GSM-900 / DCS-1800 / WCDMA-850)
3058  * ((int *)data)[0] is == 6 for "Cellular (800-MHz Band)"
3059  * ((int *)data)[0] is == 7 for "PCS (1900-MHz Band)"
3060  * ((int *)data)[0] is == 8 for "Band Class 3 (JTACS Band)"
3061  * ((int *)data)[0] is == 9 for "Band Class 4 (Korean PCS Band)"
3062  * ((int *)data)[0] is == 10 for "Band Class 5 (450-MHz Band)"
3063  * ((int *)data)[0] is == 11 for "Band Class 6 (2-GMHz IMT2000 Band)"
3064  * ((int *)data)[0] is == 12 for "Band Class 7 (Upper 700-MHz Band)"
3065  * ((int *)data)[0] is == 13 for "Band Class 8 (1800-MHz Band)"
3066  * ((int *)data)[0] is == 14 for "Band Class 9 (900-MHz Band)"
3067  * ((int *)data)[0] is == 15 for "Band Class 10 (Secondary 800-MHz Band)"
3068  * ((int *)data)[0] is == 16 for "Band Class 11 (400-MHz European PAMR Band)"
3069  * ((int *)data)[0] is == 17 for "Band Class 15 (AWS Band)"
3070  * ((int *)data)[0] is == 18 for "Band Class 16 (US 2.5-GHz Band)"
3071  *
3072  * "response" is NULL
3073  *
3074  * Valid errors:
3075  *  SUCCESS
3076  *  RADIO_NOT_AVAILABLE
3077  *  GENERIC_FAILURE
3078  */
3079 #define RIL_REQUEST_SET_BAND_MODE 65
3080
3081 /**
3082  * RIL_REQUEST_QUERY_AVAILABLE_BAND_MODE
3083  *
3084  * Query the list of band mode supported by RF.
3085  *
3086  * "data" is NULL
3087  *
3088  * "response" is int *
3089  * "response" points to an array of int's, the int[0] is the size of array, reset is one for
3090  * each available band mode.
3091  *
3092  *  0 for "unspecified" (selected by baseband automatically)
3093  *  1 for "EURO band" (GSM-900 / DCS-1800 / WCDMA-IMT-2000)
3094  *  2 for "US band" (GSM-850 / PCS-1900 / WCDMA-850 / WCDMA-PCS-1900)
3095  *  3 for "JPN band" (WCDMA-800 / WCDMA-IMT-2000)
3096  *  4 for "AUS band" (GSM-900 / DCS-1800 / WCDMA-850 / WCDMA-IMT-2000)
3097  *  5 for "AUS band 2" (GSM-900 / DCS-1800 / WCDMA-850)
3098  *  6 for "Cellular (800-MHz Band)"
3099  *  7 for "PCS (1900-MHz Band)"
3100  *  8 for "Band Class 3 (JTACS Band)"
3101  *  9 for "Band Class 4 (Korean PCS Band)"
3102  *  10 for "Band Class 5 (450-MHz Band)"
3103  *  11 for "Band Class 6 (2-GMHz IMT2000 Band)"
3104  *  12 for "Band Class 7 (Upper 700-MHz Band)"
3105  *  13 for "Band Class 8 (1800-MHz Band)"
3106  *  14 for "Band Class 9 (900-MHz Band)"
3107  *  15 for "Band Class 10 (Secondary 800-MHz Band)"
3108  *  16 for "Band Class 11 (400-MHz European PAMR Band)"
3109  *  17 for "Band Class 15 (AWS Band)"
3110  *  18 for "Band Class 16 (US 2.5-GHz Band)"
3111  *
3112  * Valid errors:
3113  *  SUCCESS
3114  *  RADIO_NOT_AVAILABLE
3115  *  GENERIC_FAILURE
3116  *
3117  * See also: RIL_REQUEST_SET_BAND_MODE
3118  */
3119 #define RIL_REQUEST_QUERY_AVAILABLE_BAND_MODE 66
3120
3121 /**
3122  * RIL_REQUEST_STK_GET_PROFILE
3123  *
3124  * Requests the profile of SIM tool kit.
3125  * The profile indicates the SAT/USAT features supported by ME.
3126  * The SAT/USAT features refer to 3GPP TS 11.14 and 3GPP TS 31.111
3127  *
3128  * "data" is NULL
3129  *
3130  * "response" is a const char * containing SAT/USAT profile
3131  * in hexadecimal format string starting with first byte of terminal profile
3132  *
3133  * Valid errors:
3134  *  RIL_E_SUCCESS
3135  *  RIL_E_RADIO_NOT_AVAILABLE (radio resetting)
3136  *  RIL_E_GENERIC_FAILURE
3137  */
3138 #define RIL_REQUEST_STK_GET_PROFILE 67
3139
3140 /**
3141  * RIL_REQUEST_STK_SET_PROFILE
3142  *
3143  * Download the STK terminal profile as part of SIM initialization
3144  * procedure
3145  *
3146  * "data" is a const char * containing SAT/USAT profile
3147  * in hexadecimal format string starting with first byte of terminal profile
3148  *
3149  * "response" is NULL
3150  *
3151  * Valid errors:
3152  *  RIL_E_SUCCESS
3153  *  RIL_E_RADIO_NOT_AVAILABLE (radio resetting)
3154  *  RIL_E_GENERIC_FAILURE
3155  */
3156 #define RIL_REQUEST_STK_SET_PROFILE 68
3157
3158 /**
3159  * RIL_REQUEST_STK_SEND_ENVELOPE_COMMAND
3160  *
3161  * Requests to send a SAT/USAT envelope command to SIM.
3162  * The SAT/USAT envelope command refers to 3GPP TS 11.14 and 3GPP TS 31.111
3163  *
3164  * "data" is a const char * containing SAT/USAT command
3165  * in hexadecimal format string starting with command tag
3166  *
3167  * "response" is a const char * containing SAT/USAT response
3168  * in hexadecimal format string starting with first byte of response
3169  * (May be NULL)
3170  *
3171  * Valid errors:
3172  *  RIL_E_SUCCESS
3173  *  RIL_E_RADIO_NOT_AVAILABLE (radio resetting)
3174  *  RIL_E_GENERIC_FAILURE
3175  */
3176 #define RIL_REQUEST_STK_SEND_ENVELOPE_COMMAND 69
3177
3178 /**
3179  * RIL_REQUEST_STK_SEND_TERMINAL_RESPONSE
3180  *
3181  * Requests to send a terminal response to SIM for a received
3182  * proactive command
3183  *
3184  * "data" is a const char * containing SAT/USAT response
3185  * in hexadecimal format string starting with first byte of response data
3186  *
3187  * "response" is NULL
3188  *
3189  * Valid errors:
3190  *  RIL_E_SUCCESS
3191  *  RIL_E_RADIO_NOT_AVAILABLE (radio resetting)
3192  *  RIL_E_GENERIC_FAILURE
3193  */
3194 #define RIL_REQUEST_STK_SEND_TERMINAL_RESPONSE 70
3195
3196 /**
3197  * RIL_REQUEST_STK_HANDLE_CALL_SETUP_REQUESTED_FROM_SIM
3198  *
3199  * When STK application gets RIL_UNSOL_STK_CALL_SETUP, the call actually has
3200  * been initialized by ME already. (We could see the call has been in the 'call
3201  * list') So, STK application needs to accept/reject the call according as user
3202  * operations.
3203  *
3204  * "data" is int *
3205  * ((int *)data)[0] is > 0 for "accept" the call setup
3206  * ((int *)data)[0] is == 0 for "reject" the call setup
3207  *
3208  * "response" is NULL
3209  *
3210  * Valid errors:
3211  *  RIL_E_SUCCESS
3212  *  RIL_E_RADIO_NOT_AVAILABLE (radio resetting)
3213  *  RIL_E_GENERIC_FAILURE
3214  */
3215 #define RIL_REQUEST_STK_HANDLE_CALL_SETUP_REQUESTED_FROM_SIM 71
3216
3217 /**
3218  * RIL_REQUEST_EXPLICIT_CALL_TRANSFER
3219  *
3220  * Connects the two calls and disconnects the subscriber from both calls.
3221  *
3222  * "data" is NULL
3223  * "response" is NULL
3224  *
3225  * Valid errors:
3226  *  SUCCESS
3227  *  RADIO_NOT_AVAILABLE (radio resetting)
3228  *  GENERIC_FAILURE
3229  */
3230 #define RIL_REQUEST_EXPLICIT_CALL_TRANSFER 72
3231
3232 /**
3233  * RIL_REQUEST_SET_PREFERRED_NETWORK_TYPE
3234  *
3235  * Requests to set the preferred network type for searching and registering
3236  * (CS/PS domain, RAT, and operation mode)
3237  *
3238  * "data" is int * which is RIL_PreferredNetworkType
3239  *
3240  * "response" is NULL
3241  *
3242  * Valid errors:
3243  *  SUCCESS
3244  *  RADIO_NOT_AVAILABLE (radio resetting)
3245  *  GENERIC_FAILURE
3246  *  MODE_NOT_SUPPORTED
3247  */
3248 #define RIL_REQUEST_SET_PREFERRED_NETWORK_TYPE 73
3249
3250 /**
3251  * RIL_REQUEST_GET_PREFERRED_NETWORK_TYPE
3252  *
3253  * Query the preferred network type (CS/PS domain, RAT, and operation mode)
3254  * for searching and registering
3255  *
3256  * "data" is NULL
3257  *
3258  * "response" is int *
3259  * ((int *)reponse)[0] is == RIL_PreferredNetworkType
3260  *
3261  * Valid errors:
3262  *  SUCCESS
3263  *  RADIO_NOT_AVAILABLE
3264  *  GENERIC_FAILURE
3265  *
3266  * See also: RIL_REQUEST_SET_PREFERRED_NETWORK_TYPE
3267  */
3268 #define RIL_REQUEST_GET_PREFERRED_NETWORK_TYPE 74
3269
3270 /**
3271  * RIL_REQUEST_NEIGHBORING_CELL_IDS
3272  *
3273  * Request neighboring cell id in GSM network
3274  *
3275  * "data" is NULL
3276  * "response" must be a " const RIL_NeighboringCell** "
3277  *
3278  * Valid errors:
3279  *  SUCCESS
3280  *  RADIO_NOT_AVAILABLE
3281  *  GENERIC_FAILURE
3282  */
3283 #define RIL_REQUEST_GET_NEIGHBORING_CELL_IDS 75
3284
3285 /**
3286  * RIL_REQUEST_SET_LOCATION_UPDATES
3287  *
3288  * Enables/disables network state change notifications due to changes in
3289  * LAC and/or CID (for GSM) or BID/SID/NID/latitude/longitude (for CDMA).
3290  * Basically +CREG=2 vs. +CREG=1 (TS 27.007).
3291  *
3292  * Note:  The RIL implementation should default to "updates enabled"
3293  * when the screen is on and "updates disabled" when the screen is off.
3294  *
3295  * "data" is int *
3296  * ((int *)data)[0] is == 1 for updates enabled (+CREG=2)
3297  * ((int *)data)[0] is == 0 for updates disabled (+CREG=1)
3298  *
3299  * "response" is NULL
3300  *
3301  * Valid errors:
3302  *  SUCCESS
3303  *  RADIO_NOT_AVAILABLE
3304  *  GENERIC_FAILURE
3305  *
3306  * See also: RIL_REQUEST_SCREEN_STATE, RIL_UNSOL_RESPONSE_NETWORK_STATE_CHANGED
3307  */
3308 #define RIL_REQUEST_SET_LOCATION_UPDATES 76
3309
3310 /**
3311  * RIL_REQUEST_CDMA_SET_SUBSCRIPTION_SOURCE
3312  *
3313  * Request to set the location where the CDMA subscription shall
3314  * be retrieved
3315  *
3316  * "data" is int *
3317  * ((int *)data)[0] is == RIL_CdmaSubscriptionSource
3318  *
3319  * "response" is NULL
3320  *
3321  * Valid errors:
3322  *  SUCCESS
3323  *  RADIO_NOT_AVAILABLE
3324  *  GENERIC_FAILURE
3325  *  SIM_ABSENT
3326  *  SUBSCRIPTION_NOT_AVAILABLE
3327  *
3328  * See also: RIL_REQUEST_CDMA_GET_SUBSCRIPTION_SOURCE
3329  */
3330 #define RIL_REQUEST_CDMA_SET_SUBSCRIPTION_SOURCE 77
3331
3332 /**
3333  * RIL_REQUEST_CDMA_SET_ROAMING_PREFERENCE
3334  *
3335  * Request to set the roaming preferences in CDMA
3336  *
3337  * "data" is int *
3338  * ((int *)data)[0] is == 0 for Home Networks only, as defined in PRL
3339  * ((int *)data)[0] is == 1 for Roaming on Affiliated networks, as defined in PRL
3340  * ((int *)data)[0] is == 2 for Roaming on Any Network, as defined in the PRL
3341  *
3342  * "response" is NULL
3343  *
3344  * Valid errors:
3345  *  SUCCESS
3346  *  RADIO_NOT_AVAILABLE
3347  *  GENERIC_FAILURE
3348  */
3349 #define RIL_REQUEST_CDMA_SET_ROAMING_PREFERENCE 78
3350
3351 /**
3352  * RIL_REQUEST_CDMA_QUERY_ROAMING_PREFERENCE
3353  *
3354  * Request the actual setting of the roaming preferences in CDMA in the modem
3355  *
3356  * "data" is NULL
3357  *
3358  * "response" is int *
3359  * ((int *)response)[0] is == 0 for Home Networks only, as defined in PRL
3360  * ((int *)response)[0] is == 1 for Roaming on Affiliated networks, as defined in PRL
3361  * ((int *)response)[0] is == 2 for Roaming on Any Network, as defined in the PRL
3362  *
3363  * "response" is NULL
3364  *
3365  * Valid errors:
3366  *  SUCCESS
3367  *  RADIO_NOT_AVAILABLE
3368  *  GENERIC_FAILURE
3369  */
3370 #define RIL_REQUEST_CDMA_QUERY_ROAMING_PREFERENCE 79
3371
3372 /**
3373  * RIL_REQUEST_SET_TTY_MODE
3374  *
3375  * Request to set the TTY mode
3376  *
3377  * "data" is int *
3378  * ((int *)data)[0] is == 0 for TTY off
3379  * ((int *)data)[0] is == 1 for TTY Full
3380  * ((int *)data)[0] is == 2 for TTY HCO (hearing carryover)
3381  * ((int *)data)[0] is == 3 for TTY VCO (voice carryover)
3382  *
3383  * "response" is NULL
3384  *
3385  * Valid errors:
3386  *  SUCCESS
3387  *  RADIO_NOT_AVAILABLE
3388  *  GENERIC_FAILURE
3389  */
3390 #define RIL_REQUEST_SET_TTY_MODE 80
3391
3392 /**
3393  * RIL_REQUEST_QUERY_TTY_MODE
3394  *
3395  * Request the setting of TTY mode
3396  *
3397  * "data" is NULL
3398  *
3399  * "response" is int *
3400  * ((int *)response)[0] is == 0 for TTY off
3401  * ((int *)response)[0] is == 1 for TTY Full
3402  * ((int *)response)[0] is == 2 for TTY HCO (hearing carryover)
3403  * ((int *)response)[0] is == 3 for TTY VCO (voice carryover)
3404  *
3405  * "response" is NULL
3406  *
3407  * Valid errors:
3408  *  SUCCESS
3409  *  RADIO_NOT_AVAILABLE
3410  *  GENERIC_FAILURE
3411  */
3412 #define RIL_REQUEST_QUERY_TTY_MODE 81
3413
3414 /**
3415  * RIL_REQUEST_CDMA_SET_PREFERRED_VOICE_PRIVACY_MODE
3416  *
3417  * Request to set the preferred voice privacy mode used in voice
3418  * scrambling
3419  *
3420  * "data" is int *
3421  * ((int *)data)[0] is == 0 for Standard Privacy Mode (Public Long Code Mask)
3422  * ((int *)data)[0] is == 1 for Enhanced Privacy Mode (Private Long Code Mask)
3423  *
3424  * "response" is NULL
3425  *
3426  * Valid errors:
3427  *  SUCCESS
3428  *  RADIO_NOT_AVAILABLE
3429  *  GENERIC_FAILURE
3430  */
3431 #define RIL_REQUEST_CDMA_SET_PREFERRED_VOICE_PRIVACY_MODE 82
3432
3433 /**
3434  * RIL_REQUEST_CDMA_QUERY_PREFERRED_VOICE_PRIVACY_MODE
3435  *
3436  * Request the setting of preferred voice privacy mode
3437  *
3438  * "data" is NULL
3439  *
3440  * "response" is int *
3441  * ((int *)response)[0] is == 0 for Standard Privacy Mode (Public Long Code Mask)
3442  * ((int *)response)[0] is == 1 for Enhanced Privacy Mode (Private Long Code Mask)
3443  *
3444  * "response" is NULL
3445  *
3446  * Valid errors:
3447  *  SUCCESS
3448  *  RADIO_NOT_AVAILABLE
3449  *  GENERIC_FAILURE
3450  */
3451 #define RIL_REQUEST_CDMA_QUERY_PREFERRED_VOICE_PRIVACY_MODE 83
3452
3453 /**
3454  * RIL_REQUEST_CDMA_FLASH
3455  *
3456  * Send FLASH
3457  *
3458  * "data" is const char *
3459  * ((const char *)data)[0] is a FLASH string
3460  *
3461  * "response" is NULL
3462  *
3463  * Valid errors:
3464  *  SUCCESS
3465  *  RADIO_NOT_AVAILABLE
3466  *  GENERIC_FAILURE
3467  *
3468  */
3469 #define RIL_REQUEST_CDMA_FLASH 84
3470
3471 /**
3472  * RIL_REQUEST_CDMA_BURST_DTMF
3473  *
3474  * Send DTMF string
3475  *
3476  * "data" is const char **
3477  * ((const char **)data)[0] is a DTMF string
3478  * ((const char **)data)[1] is the DTMF ON length in milliseconds, or 0 to use
3479  *                          default
3480  * ((const char **)data)[2] is the DTMF OFF length in milliseconds, or 0 to use
3481  *                          default
3482  *
3483  * "response" is NULL
3484  *
3485  * Valid errors:
3486  *  SUCCESS
3487  *  RADIO_NOT_AVAILABLE
3488  *  GENERIC_FAILURE
3489  *
3490  */
3491 #define RIL_REQUEST_CDMA_BURST_DTMF 85
3492
3493 /**
3494  * RIL_REQUEST_CDMA_VALIDATE_AND_WRITE_AKEY
3495  *
3496  * Takes a 26 digit string (20 digit AKEY + 6 digit checksum).
3497  * If the checksum is valid the 20 digit AKEY is written to NV,
3498  * replacing the existing AKEY no matter what it was before.
3499  *
3500  * "data" is const char *
3501  * ((const char *)data)[0] is a 26 digit string (ASCII digits '0'-'9')
3502  *                         where the last 6 digits are a checksum of the
3503  *                         first 20, as specified in TR45.AHAG
3504  *                         "Common Cryptographic Algorithms, Revision D.1
3505  *                         Section 2.2"
3506  *
3507  * "response" is NULL
3508  *
3509  * Valid errors:
3510  *  SUCCESS
3511  *  RADIO_NOT_AVAILABLE
3512  *  GENERIC_FAILURE
3513  *
3514  */
3515 #define RIL_REQUEST_CDMA_VALIDATE_AND_WRITE_AKEY 86
3516
3517 /**
3518  * RIL_REQUEST_CDMA_SEND_SMS
3519  *
3520  * Send a CDMA SMS message
3521  *
3522  * "data" is const RIL_CDMA_SMS_Message *
3523  *
3524  * "response" is a const RIL_SMS_Response *
3525  *
3526  * Based on the return error, caller decides to resend if sending sms
3527  * fails. The CDMA error class is derived as follows,
3528  * SUCCESS is error class 0 (no error)
3529  * SMS_SEND_FAIL_RETRY is error class 2 (temporary failure)
3530  * and GENERIC_FAILURE is error class 3 (permanent and no retry)
3531  *
3532  * Valid errors:
3533  *  SUCCESS
3534  *  RADIO_NOT_AVAILABLE
3535  *  SMS_SEND_FAIL_RETRY
3536  *  GENERIC_FAILURE
3537  *
3538  */
3539 #define RIL_REQUEST_CDMA_SEND_SMS 87
3540
3541 /**
3542  * RIL_REQUEST_CDMA_SMS_ACKNOWLEDGE
3543  *
3544  * Acknowledge the success or failure in the receipt of SMS
3545  * previously indicated via RIL_UNSOL_RESPONSE_CDMA_NEW_SMS
3546  *
3547  * "data" is const RIL_CDMA_SMS_Ack *
3548  *
3549  * "response" is NULL
3550  *
3551  * Valid errors:
3552  *  SUCCESS
3553  *  RADIO_NOT_AVAILABLE
3554  *  GENERIC_FAILURE
3555  *
3556  */
3557 #define RIL_REQUEST_CDMA_SMS_ACKNOWLEDGE 88
3558
3559 /**
3560  * RIL_REQUEST_GSM_GET_BROADCAST_SMS_CONFIG
3561  *
3562  * Request the setting of GSM/WCDMA Cell Broadcast SMS config.
3563  *
3564  * "data" is NULL
3565  *
3566  * "response" is a const RIL_GSM_BroadcastSmsConfigInfo **
3567  * "responselen" is count * sizeof (RIL_GSM_BroadcastSmsConfigInfo *)
3568  *
3569  * Valid errors:
3570  *  SUCCESS
3571  *  RADIO_NOT_AVAILABLE
3572  *  GENERIC_FAILURE
3573  *
3574  */
3575 #define RIL_REQUEST_GSM_GET_BROADCAST_SMS_CONFIG 89
3576
3577 /**
3578  * RIL_REQUEST_GSM_SET_BROADCAST_SMS_CONFIG
3579  *
3580  * Set GSM/WCDMA Cell Broadcast SMS config
3581  *
3582  * "data" is a const RIL_GSM_BroadcastSmsConfigInfo **
3583  * "datalen" is count * sizeof(RIL_GSM_BroadcastSmsConfigInfo *)
3584  *
3585  * "response" is NULL
3586  *
3587  * Valid errors:
3588  *  SUCCESS
3589  *  RADIO_NOT_AVAILABLE
3590  *  GENERIC_FAILURE
3591  *
3592  */
3593 #define RIL_REQUEST_GSM_SET_BROADCAST_SMS_CONFIG 90
3594
3595 /**
3596  * RIL_REQUEST_GSM_SMS_BROADCAST_ACTIVATION
3597  *
3598 * Enable or disable the reception of GSM/WCDMA Cell Broadcast SMS
3599  *
3600  * "data" is const int *
3601  * (const int *)data[0] indicates to activate or turn off the
3602  * reception of GSM/WCDMA Cell Broadcast SMS, 0-1,
3603  *                       0 - Activate, 1 - Turn off
3604  *
3605  * "response" is NULL
3606  *
3607  * Valid errors:
3608  *  SUCCESS
3609  *  RADIO_NOT_AVAILABLE
3610  *  GENERIC_FAILURE
3611  *
3612  */
3613 #define RIL_REQUEST_GSM_SMS_BROADCAST_ACTIVATION 91
3614
3615 /**
3616  * RIL_REQUEST_CDMA_GET_BROADCAST_SMS_CONFIG
3617  *
3618  * Request the setting of CDMA Broadcast SMS config
3619  *
3620  * "data" is NULL
3621  *
3622  * "response" is a const RIL_CDMA_BroadcastSmsConfigInfo **
3623  * "responselen" is count * sizeof (RIL_CDMA_BroadcastSmsConfigInfo *)
3624  *
3625  * Valid errors:
3626  *  SUCCESS
3627  *  RADIO_NOT_AVAILABLE
3628  *  GENERIC_FAILURE
3629  *
3630  */
3631 #define RIL_REQUEST_CDMA_GET_BROADCAST_SMS_CONFIG 92
3632
3633 /**
3634  * RIL_REQUEST_CDMA_SET_BROADCAST_SMS_CONFIG
3635  *
3636  * Set CDMA Broadcast SMS config
3637  *
3638  * "data" is an const RIL_CDMA_BroadcastSmsConfigInfo **
3639  * "datalen" is count * sizeof(const RIL_CDMA_BroadcastSmsConfigInfo *)
3640  *
3641  * "response" is NULL
3642  *
3643  * Valid errors:
3644  *  SUCCESS
3645  *  RADIO_NOT_AVAILABLE
3646  *  GENERIC_FAILURE
3647  *
3648  */
3649 #define RIL_REQUEST_CDMA_SET_BROADCAST_SMS_CONFIG 93
3650
3651 /**
3652  * RIL_REQUEST_CDMA_SMS_BROADCAST_ACTIVATION
3653  *
3654  * Enable or disable the reception of CDMA Broadcast SMS
3655  *
3656  * "data" is const int *
3657  * (const int *)data[0] indicates to activate or turn off the
3658  * reception of CDMA Broadcast SMS, 0-1,
3659  *                       0 - Activate, 1 - Turn off
3660  *
3661  * "response" is NULL
3662  *
3663  * Valid errors:
3664  *  SUCCESS
3665  *  RADIO_NOT_AVAILABLE
3666  *  GENERIC_FAILURE
3667  *
3668  */
3669 #define RIL_REQUEST_CDMA_SMS_BROADCAST_ACTIVATION 94
3670
3671 /**
3672  * RIL_REQUEST_CDMA_SUBSCRIPTION
3673  *
3674  * Request the device MDN / H_SID / H_NID.
3675  *
3676  * The request is only allowed when CDMA subscription is available.  When CDMA
3677  * subscription is changed, application layer should re-issue the request to
3678  * update the subscription information.
3679  *
3680  * If a NULL value is returned for any of the device id, it means that error
3681  * accessing the device.
3682  *
3683  * "response" is const char **
3684  * ((const char **)response)[0] is MDN if CDMA subscription is available
3685  * ((const char **)response)[1] is a comma separated list of H_SID (Home SID) if
3686  *                              CDMA subscription is available, in decimal format
3687  * ((const char **)response)[2] is a comma separated list of H_NID (Home NID) if
3688  *                              CDMA subscription is available, in decimal format
3689  * ((const char **)response)[3] is MIN (10 digits, MIN2+MIN1) if CDMA subscription is available
3690  * ((const char **)response)[4] is PRL version if CDMA subscription is available
3691  *
3692  * Valid errors:
3693  *  SUCCESS
3694  *  RIL_E_SUBSCRIPTION_NOT_AVAILABLE
3695  */
3696
3697 #define RIL_REQUEST_CDMA_SUBSCRIPTION 95
3698
3699 /**
3700  * RIL_REQUEST_CDMA_WRITE_SMS_TO_RUIM
3701  *
3702  * Stores a CDMA SMS message to RUIM memory.
3703  *
3704  * "data" is RIL_CDMA_SMS_WriteArgs *
3705  *
3706  * "response" is int *
3707  * ((const int *)response)[0] is the record index where the message is stored.
3708  *
3709  * Valid errors:
3710  *  SUCCESS
3711  *  RADIO_NOT_AVAILABLE
3712  *  GENERIC_FAILURE
3713  *
3714  */
3715 #define RIL_REQUEST_CDMA_WRITE_SMS_TO_RUIM 96
3716
3717 /**
3718  * RIL_REQUEST_CDMA_DELETE_SMS_ON_RUIM
3719  *
3720  * Deletes a CDMA SMS message from RUIM memory.
3721  *
3722  * "data" is int  *
3723  * ((int *)data)[0] is the record index of the message to delete.
3724  *
3725  * "response" is NULL
3726  *
3727  * Valid errors:
3728  *  SUCCESS
3729  *  RADIO_NOT_AVAILABLE
3730  *  GENERIC_FAILURE
3731  *
3732  */
3733 #define RIL_REQUEST_CDMA_DELETE_SMS_ON_RUIM 97
3734
3735 /**
3736  * RIL_REQUEST_DEVICE_IDENTITY
3737  *
3738  * Request the device ESN / MEID / IMEI / IMEISV.
3739  *
3740  * The request is always allowed and contains GSM and CDMA device identity;
3741  * it substitutes the deprecated requests RIL_REQUEST_GET_IMEI and
3742  * RIL_REQUEST_GET_IMEISV.
3743  *
3744  * If a NULL value is returned for any of the device id, it means that error
3745  * accessing the device.
3746  *
3747  * When CDMA subscription is changed the ESN/MEID may change.  The application
3748  * layer should re-issue the request to update the device identity in this case.
3749  *
3750  * "response" is const char **
3751  * ((const char **)response)[0] is IMEI if GSM subscription is available
3752  * ((const char **)response)[1] is IMEISV if GSM subscription is available
3753  * ((const char **)response)[2] is ESN if CDMA subscription is available
3754  * ((const char **)response)[3] is MEID if CDMA subscription is available
3755  *
3756  * Valid errors:
3757  *  SUCCESS
3758  *  RADIO_NOT_AVAILABLE
3759  *  GENERIC_FAILURE
3760  */
3761 #define RIL_REQUEST_DEVICE_IDENTITY 98
3762
3763 /**
3764  * RIL_REQUEST_EXIT_EMERGENCY_CALLBACK_MODE
3765  *
3766  * Request the radio's system selection module to exit emergency
3767  * callback mode.  RIL will not respond with SUCCESS until the modem has
3768  * completely exited from Emergency Callback Mode.
3769  *
3770  * "data" is NULL
3771  *
3772  * "response" is NULL
3773  *
3774  * Valid errors:
3775  *  SUCCESS
3776  *  RADIO_NOT_AVAILABLE
3777  *  GENERIC_FAILURE
3778  *
3779  */
3780 #define RIL_REQUEST_EXIT_EMERGENCY_CALLBACK_MODE 99
3781
3782 /**
3783  * RIL_REQUEST_GET_SMSC_ADDRESS
3784  *
3785  * Queries the default Short Message Service Center address on the device.
3786  *
3787  * "data" is NULL
3788  *
3789  * "response" is const char * containing the SMSC address.
3790  *
3791  * Valid errors:
3792  *  SUCCESS
3793  *  RADIO_NOT_AVAILABLE
3794  *  GENERIC_FAILURE
3795  *
3796  */
3797 #define RIL_REQUEST_GET_SMSC_ADDRESS 100
3798
3799 /**
3800  * RIL_REQUEST_SET_SMSC_ADDRESS
3801  *
3802  * Sets the default Short Message Service Center address on the device.
3803  *
3804  * "data" is const char * containing the SMSC address.
3805  *
3806  * "response" is NULL
3807  *
3808  * Valid errors:
3809  *  SUCCESS
3810  *  RADIO_NOT_AVAILABLE
3811  *  GENERIC_FAILURE
3812  *
3813  */
3814 #define RIL_REQUEST_SET_SMSC_ADDRESS 101
3815
3816 /**
3817  * RIL_REQUEST_REPORT_SMS_MEMORY_STATUS
3818  *
3819  * Indicates whether there is storage available for new SMS messages.
3820  *
3821  * "data" is int *
3822  * ((int *)data)[0] is 1 if memory is available for storing new messages
3823  *                  is 0 if memory capacity is exceeded
3824  *
3825  * "response" is NULL
3826  *
3827  * Valid errors:
3828  *  SUCCESS
3829  *  RADIO_NOT_AVAILABLE
3830  *  GENERIC_FAILURE
3831  *
3832  */
3833 #define RIL_REQUEST_REPORT_SMS_MEMORY_STATUS 102
3834
3835 /**
3836  * RIL_REQUEST_REPORT_STK_SERVICE_IS_RUNNING
3837  *
3838  * Indicates that the StkSerivce is running and is
3839  * ready to receive RIL_UNSOL_STK_XXXXX commands.
3840  *
3841  * "data" is NULL
3842  * "response" is NULL
3843  *
3844  * Valid errors:
3845  *  SUCCESS
3846  *  RADIO_NOT_AVAILABLE
3847  *  GENERIC_FAILURE
3848  *
3849  */
3850 #define RIL_REQUEST_REPORT_STK_SERVICE_IS_RUNNING 103
3851
3852 /**
3853  * RIL_REQUEST_CDMA_GET_SUBSCRIPTION_SOURCE
3854  *
3855  * Request to query the location where the CDMA subscription shall
3856  * be retrieved
3857  *
3858  * "data" is NULL
3859  *
3860  * "response" is int *
3861  * ((int *)data)[0] is == RIL_CdmaSubscriptionSource
3862  *
3863  * Valid errors:
3864  *  SUCCESS
3865  *  RADIO_NOT_AVAILABLE
3866  *  GENERIC_FAILURE
3867  *  SUBSCRIPTION_NOT_AVAILABLE
3868  *
3869  * See also: RIL_REQUEST_CDMA_SET_SUBSCRIPTION_SOURCE
3870  */
3871 #define RIL_REQUEST_CDMA_GET_SUBSCRIPTION_SOURCE 104
3872
3873 /**
3874  * RIL_REQUEST_ISIM_AUTHENTICATION
3875  *
3876  * Request the ISIM application on the UICC to perform AKA
3877  * challenge/response algorithm for IMS authentication
3878  *
3879  * "data" is a const char * containing the challenge string in Base64 format
3880  * "response" is a const char * containing the response in Base64 format
3881  *
3882  * Valid errors:
3883  *  SUCCESS
3884  *  RADIO_NOT_AVAILABLE
3885  *  GENERIC_FAILURE
3886  */
3887 #define RIL_REQUEST_ISIM_AUTHENTICATION 105
3888
3889 /**
3890  * RIL_REQUEST_ACKNOWLEDGE_INCOMING_GSM_SMS_WITH_PDU
3891  *
3892  * Acknowledge successful or failed receipt of SMS previously indicated
3893  * via RIL_UNSOL_RESPONSE_NEW_SMS, including acknowledgement TPDU to send
3894  * as the RP-User-Data element of the RP-ACK or RP-ERROR PDU.
3895  *
3896  * "data" is const char **
3897  * ((const char **)data)[0] is "1" on successful receipt (send RP-ACK)
3898  *                          is "0" on failed receipt (send RP-ERROR)
3899  * ((const char **)data)[1] is the acknowledgement TPDU in hexadecimal format
3900  *
3901  * "response" is NULL
3902  *
3903  * Valid errors:
3904  *  SUCCESS
3905  *  RADIO_NOT_AVAILABLE
3906  *  GENERIC_FAILURE
3907  */
3908 #define RIL_REQUEST_ACKNOWLEDGE_INCOMING_GSM_SMS_WITH_PDU 106
3909
3910 /**
3911  * RIL_REQUEST_STK_SEND_ENVELOPE_WITH_STATUS
3912  *
3913  * Requests to send a SAT/USAT envelope command to SIM.
3914  * The SAT/USAT envelope command refers to 3GPP TS 11.14 and 3GPP TS 31.111.
3915  *
3916  * This request has one difference from RIL_REQUEST_STK_SEND_ENVELOPE_COMMAND:
3917  * the SW1 and SW2 status bytes from the UICC response are returned along with
3918  * the response data, using the same structure as RIL_REQUEST_SIM_IO.
3919  *
3920  * The RIL implementation shall perform the normal processing of a '91XX'
3921  * response in SW1/SW2 to retrieve the pending proactive command and send it
3922  * as an unsolicited response, as RIL_REQUEST_STK_SEND_ENVELOPE_COMMAND does.
3923  *
3924  * "data" is a const char * containing the SAT/USAT command
3925  * in hexadecimal format starting with command tag
3926  *
3927  * "response" is a const RIL_SIM_IO_Response *
3928  *
3929  * Valid errors:
3930  *  RIL_E_SUCCESS
3931  *  RIL_E_RADIO_NOT_AVAILABLE (radio resetting)
3932  *  RIL_E_GENERIC_FAILURE
3933  */
3934 #define RIL_REQUEST_STK_SEND_ENVELOPE_WITH_STATUS 107
3935
3936 /**
3937  * RIL_REQUEST_VOICE_RADIO_TECH
3938  *
3939  * Query the radio technology type (3GPP/3GPP2) used for voice. Query is valid only
3940  * when radio state is RADIO_STATE_ON
3941  *
3942  * "data" is NULL
3943  * "response" is int *
3944  * ((int *) response)[0] is of type const RIL_RadioTechnology
3945  *
3946  * Valid errors:
3947  *  SUCCESS
3948  *  RADIO_NOT_AVAILABLE
3949  *  GENERIC_FAILURE
3950  */
3951 #define RIL_REQUEST_VOICE_RADIO_TECH 108
3952
3953 /**
3954  * RIL_REQUEST_GET_CELL_INFO_LIST
3955  *
3956  * Request all of the current cell information known to the radio. The radio
3957  * must a list of all current cells, including the neighboring cells. If for a particular
3958  * cell information isn't known then the appropriate unknown value will be returned.
3959  * This does not cause or change the rate of RIL_UNSOL_CELL_INFO_LIST.
3960  *
3961  * "data" is NULL
3962  *
3963  * "response" is an array of  RIL_CellInfo.
3964  */
3965 #define RIL_REQUEST_GET_CELL_INFO_LIST 109
3966
3967 /**
3968  * RIL_REQUEST_SET_UNSOL_CELL_INFO_LIST_RATE
3969  *
3970  * Sets the minimum time between when RIL_UNSOL_CELL_INFO_LIST should be invoked.
3971  * A value of 0, means invoke RIL_UNSOL_CELL_INFO_LIST when any of the reported
3972  * information changes. Setting the value to INT_MAX(0x7fffffff) means never issue
3973  * a RIL_UNSOL_CELL_INFO_LIST.
3974  *
3975  * "data" is int *
3976  * ((int *)data)[0] is minimum time in milliseconds
3977  *
3978  * "response" is NULL
3979  *
3980  * Valid errors:
3981  *  SUCCESS
3982  *  RADIO_NOT_AVAILABLE
3983  *  GENERIC_FAILURE
3984  */
3985 #define RIL_REQUEST_SET_UNSOL_CELL_INFO_LIST_RATE 110
3986
3987 /**
3988  * RIL_REQUEST_SET_INITIAL_ATTACH_APN
3989  *
3990  * Set an apn to initial attach network
3991  * "response" is NULL
3992  *
3993  * Valid errors:
3994  *  SUCCESS
3995  *  RADIO_NOT_AVAILABLE (radio resetting)
3996  *  GENERIC_FAILURE
3997  *  SUBSCRIPTION_NOT_AVAILABLE
3998  */
3999 #define RIL_REQUEST_SET_INITIAL_ATTACH_APN 111
4000
4001 /**
4002  * RIL_REQUEST_IMS_REGISTRATION_STATE
4003  *
4004  * Request current IMS registration state
4005  *
4006  * "data" is NULL
4007  *
4008  * "response" is int *
4009  * ((int *)response)[0] is registration state:
4010  *              0 - Not registered
4011  *              1 - Registered
4012  *
4013  * If ((int*)response)[0] is = 1, then ((int *) response)[1]
4014  * must follow with IMS SMS format:
4015  *
4016  * ((int *) response)[1] is of type RIL_RadioTechnologyFamily
4017  *
4018  * Valid errors:
4019  *  SUCCESS
4020  *  RADIO_NOT_AVAILABLE
4021  *  GENERIC_FAILURE
4022  */
4023 #define RIL_REQUEST_IMS_REGISTRATION_STATE 112
4024
4025 /**
4026  * RIL_REQUEST_IMS_SEND_SMS
4027  *
4028  * Send a SMS message over IMS
4029  *
4030  * "data" is const RIL_IMS_SMS_Message *
4031  *
4032  * "response" is a const RIL_SMS_Response *
4033  *
4034  * Based on the return error, caller decides to resend if sending sms
4035  * fails. SMS_SEND_FAIL_RETRY means retry, and other errors means no retry.
4036  * In case of retry, data is encoded based on Voice Technology available.
4037  *
4038  * Valid errors:
4039  *  SUCCESS
4040  *  RADIO_NOT_AVAILABLE
4041  *  SMS_SEND_FAIL_RETRY
4042  *  FDN_CHECK_FAILURE
4043  *  GENERIC_FAILURE
4044  *
4045  */
4046 #define RIL_REQUEST_IMS_SEND_SMS 113
4047
4048 /**
4049  * RIL_REQUEST_SIM_TRANSMIT_APDU_BASIC
4050  *
4051  * Request APDU exchange on the basic channel. This command reflects TS 27.007
4052  * "generic SIM access" operation (+CSIM). The modem must ensure proper function
4053  * of GSM/CDMA, and filter commands appropriately. It should filter
4054  * channel management and SELECT by DF name commands.
4055  *
4056  * "data" is a const RIL_SIM_APDU *
4057  * "sessionid" field should be ignored.
4058  *
4059  * "response" is a const RIL_SIM_IO_Response *
4060  *
4061  * Valid errors:
4062  *  SUCCESS
4063  *  RADIO_NOT_AVAILABLE
4064  *  GENERIC_FAILURE
4065  */
4066 #define RIL_REQUEST_SIM_TRANSMIT_APDU_BASIC 114
4067
4068 /**
4069  * RIL_REQUEST_SIM_OPEN_CHANNEL
4070  *
4071  * Open a new logical channel and select the given application. This command
4072  * reflects TS 27.007 "open logical channel" operation (+CCHO).
4073  *
4074  * "data" is const char * and set to AID value, See ETSI 102.221 and 101.220.
4075  *
4076  * "response" is int *
4077  * ((int *)data)[0] contains the session id of the logical channel.
4078  * ((int *)data)[1] onwards may optionally contain the select response for the
4079  *     open channel command with one byte per integer.
4080  *
4081  * Valid errors:
4082  *  SUCCESS
4083  *  RADIO_NOT_AVAILABLE
4084  *  GENERIC_FAILURE
4085  *  MISSING_RESOURCE
4086  *  NO_SUCH_ELEMENT
4087  */
4088 #define RIL_REQUEST_SIM_OPEN_CHANNEL 115
4089
4090 /**
4091  * RIL_REQUEST_SIM_CLOSE_CHANNEL
4092  *
4093  * Close a previously opened logical channel. This command reflects TS 27.007
4094  * "close logical channel" operation (+CCHC).
4095  *
4096  * "data" is int *
4097  * ((int *)data)[0] is the session id of logical the channel to close.
4098  *
4099  * "response" is NULL
4100  *
4101  * Valid errors:
4102  *  SUCCESS
4103  *  RADIO_NOT_AVAILABLE
4104  *  GENERIC_FAILURE
4105  */
4106 #define RIL_REQUEST_SIM_CLOSE_CHANNEL 116
4107
4108 /**
4109  * RIL_REQUEST_SIM_TRANSMIT_APDU_CHANNEL
4110  *
4111  * Exchange APDUs with a UICC over a previously opened logical channel. This
4112  * command reflects TS 27.007 "generic logical channel access" operation
4113  * (+CGLA). The modem should filter channel management and SELECT by DF name
4114  * commands.
4115  *
4116  * "data" is a const RIL_SIM_APDU*
4117  *
4118  * "response" is a const RIL_SIM_IO_Response *
4119  *
4120  * Valid errors:
4121  *  SUCCESS
4122  *  RADIO_NOT_AVAILABLE
4123  *  GENERIC_FAILURE
4124  */
4125 #define RIL_REQUEST_SIM_TRANSMIT_APDU_CHANNEL 117
4126
4127 /**
4128  * RIL_REQUEST_NV_READ_ITEM
4129  *
4130  * Read one of the radio NV items defined in RadioNVItems.java / ril_nv_items.h.
4131  * This is used for device configuration by some CDMA operators.
4132  *
4133  * "data" is a const RIL_NV_ReadItem *
4134  *
4135  * "response" is const char * containing the contents of the NV item
4136  *
4137  * Valid errors:
4138  *  SUCCESS
4139  *  RADIO_NOT_AVAILABLE
4140  *  GENERIC_FAILURE
4141  */
4142 #define RIL_REQUEST_NV_READ_ITEM 118
4143
4144 /**
4145  * RIL_REQUEST_NV_WRITE_ITEM
4146  *
4147  * Write one of the radio NV items defined in RadioNVItems.java / ril_nv_items.h.
4148  * This is used for device configuration by some CDMA operators.
4149  *
4150  * "data" is a const RIL_NV_WriteItem *
4151  *
4152  * "response" is NULL
4153  *
4154  * Valid errors:
4155  *  SUCCESS
4156  *  RADIO_NOT_AVAILABLE
4157  *  GENERIC_FAILURE
4158  */
4159 #define RIL_REQUEST_NV_WRITE_ITEM 119
4160
4161 /**
4162  * RIL_REQUEST_NV_WRITE_CDMA_PRL
4163  *
4164  * Update the CDMA Preferred Roaming List (PRL) in the radio NV storage.
4165  * This is used for device configuration by some CDMA operators.
4166  *
4167  * "data" is a const char * containing the PRL as a byte array
4168  *
4169  * "response" is NULL
4170  *
4171  * Valid errors:
4172  *  SUCCESS
4173  *  RADIO_NOT_AVAILABLE
4174  *  GENERIC_FAILURE
4175  */
4176 #define RIL_REQUEST_NV_WRITE_CDMA_PRL 120
4177
4178 /**
4179  * RIL_REQUEST_NV_RESET_CONFIG
4180  *
4181  * Reset the radio NV configuration to the factory state.
4182  * This is used for device configuration by some CDMA operators.
4183  *
4184  * "data" is int *
4185  * ((int *)data)[0] is 1 to reload all NV items
4186  * ((int *)data)[0] is 2 for erase NV reset (SCRTN)
4187  * ((int *)data)[0] is 3 for factory reset (RTN)
4188  *
4189  * "response" is NULL
4190  *
4191  * Valid errors:
4192  *  SUCCESS
4193  *  RADIO_NOT_AVAILABLE
4194  *  GENERIC_FAILURE
4195  */
4196 #define RIL_REQUEST_NV_RESET_CONFIG 121
4197
4198  /** RIL_REQUEST_SET_UICC_SUBSCRIPTION
4199  * FIXME This API needs to have more documentation.
4200  *
4201  * Selection/de-selection of a subscription from a SIM card
4202  * "data" is const  RIL_SelectUiccSub*
4203
4204  *
4205  * "response" is NULL
4206  *
4207  *  Valid errors:
4208  *  SUCCESS
4209  *  RADIO_NOT_AVAILABLE (radio resetting)
4210  *  GENERIC_FAILURE
4211  *  SUBSCRIPTION_NOT_SUPPORTED
4212  *
4213  */
4214 #define RIL_REQUEST_SET_UICC_SUBSCRIPTION  122
4215
4216 /**
4217  *  RIL_REQUEST_ALLOW_DATA
4218  *
4219  *  Tells the modem whether data calls are allowed or not
4220  *
4221  * "data" is int *
4222  * FIXME slotId and aid will be added.
4223  * ((int *)data)[0] is == 0 to allow data calls
4224  * ((int *)data)[0] is == 1 to disallow data calls
4225  *
4226  * "response" is NULL
4227  *
4228  *  Valid errors:
4229  *
4230  *  SUCCESS
4231  *  RADIO_NOT_AVAILABLE (radio resetting)
4232  *  GENERIC_FAILURE
4233  *
4234  */
4235 #define RIL_REQUEST_ALLOW_DATA  123
4236
4237 /**
4238  * RIL_REQUEST_GET_HARDWARE_CONFIG
4239  *
4240  * Request all of the current hardware (modem and sim) associated
4241  * with the RIL.
4242  *
4243  * "data" is NULL
4244  *
4245  * "response" is an array of  RIL_HardwareConfig.
4246  */
4247 #define RIL_REQUEST_GET_HARDWARE_CONFIG 124
4248
4249 /**
4250  * RIL_REQUEST_SIM_AUTHENTICATION
4251  *
4252  * Returns the response of SIM Authentication through RIL to a
4253  * challenge request.
4254  *
4255  * "data" Base64 encoded string containing challenge:
4256  *      int   authContext;          P2 value of authentication command, see P2 parameter in
4257  *                                  3GPP TS 31.102 7.1.2
4258  *      char *authData;             the challenge string in Base64 format, see 3GPP
4259  *                                  TS 31.102 7.1.2
4260  *      char *aid;                  AID value, See ETSI 102.221 8.1 and 101.220 4,
4261  *                                  NULL if no value
4262  *
4263  * "response" Base64 encoded strings containing response:
4264  *      int   sw1;                  Status bytes per 3GPP TS 31.102 section 7.3
4265  *      int   sw2;
4266  *      char *simResponse;          Response in Base64 format, see 3GPP TS 31.102 7.1.2
4267  */
4268 #define RIL_REQUEST_SIM_AUTHENTICATION 125
4269
4270 /**
4271  * RIL_REQUEST_GET_DC_RT_INFO
4272  *
4273  * Requests the Data Connection Real Time Info
4274  *
4275  * "data" is NULL
4276  *
4277  * "response" is the most recent RIL_DcRtInfo
4278  *
4279  * Valid errors:
4280  *  SUCCESS
4281  *  RADIO_NOT_AVAILABLE
4282  *  GENERIC_FAILURE
4283  *
4284  * See also: RIL_UNSOL_DC_RT_INFO_CHANGED
4285  */
4286 #define RIL_REQUEST_GET_DC_RT_INFO 126
4287
4288 /**
4289  * RIL_REQUEST_SET_DC_RT_INFO_RATE
4290  *
4291  * This is the minimum number of milliseconds between successive
4292  * RIL_UNSOL_DC_RT_INFO_CHANGED messages and defines the highest rate
4293  * at which RIL_UNSOL_DC_RT_INFO_CHANGED's will be sent. A value of
4294  * 0 means send as fast as possible.
4295  *
4296  * "data" The number of milliseconds as an int
4297  *
4298  * "response" is null
4299  *
4300  * Valid errors:
4301  *  SUCCESS must not fail
4302  */
4303 #define RIL_REQUEST_SET_DC_RT_INFO_RATE 127
4304
4305 /**
4306  * RIL_REQUEST_SET_DATA_PROFILE
4307  *
4308  * Set data profile in modem
4309  * Modem should erase existed profiles from framework, and apply new profiles
4310  * "data" is an const RIL_DataProfileInfo **
4311  * "datalen" is count * sizeof(const RIL_DataProfileInfo *)
4312  * "response" is NULL
4313  *
4314  * Valid errors:
4315  *  SUCCESS
4316  *  RADIO_NOT_AVAILABLE (radio resetting)
4317  *  GENERIC_FAILURE
4318  *  SUBSCRIPTION_NOT_AVAILABLE
4319  */
4320 #define RIL_REQUEST_SET_DATA_PROFILE 128
4321
4322 /**
4323  * RIL_REQUEST_SHUTDOWN
4324  *
4325  * Device is shutting down. All further commands are ignored
4326  * and RADIO_NOT_AVAILABLE must be returned.
4327  *
4328  * "data" is null
4329  * "response" is NULL
4330  *
4331  * Valid errors:
4332  *  SUCCESS
4333  *  RADIO_NOT_AVAILABLE
4334  *  GENERIC_FAILURE
4335  */
4336 #define RIL_REQUEST_SHUTDOWN 129
4337
4338 /**
4339  * RIL_REQUEST_GET_RADIO_CAPABILITY
4340  *
4341  * Used to get phone radio capablility.
4342  *
4343  * "data" is the RIL_RadioCapability structure
4344  *
4345  * Valid errors:
4346  *  SUCCESS
4347  *  RADIO_NOT_AVAILABLE
4348  *  GENERIC_FAILURE
4349  */
4350 #define RIL_REQUEST_GET_RADIO_CAPABILITY 130
4351
4352 /**
4353  * RIL_REQUEST_SET_RADIO_CAPABILITY
4354  *
4355  * Used to set the phones radio capability. Be VERY careful
4356  * using this request as it may cause some vendor modems to reset. Because
4357  * of the possible modem reset any RIL commands after this one may not be
4358  * processed.
4359  *
4360  * "data" is the RIL_RadioCapability structure
4361  *
4362  * "response" is the RIL_RadioCapability structure, used to feedback return status
4363  *
4364  * Valid errors:
4365  *  SUCCESS means a RIL_UNSOL_RADIO_CAPABILITY will be sent within 30 seconds.
4366  *  RADIO_NOT_AVAILABLE
4367  *  GENERIC_FAILURE
4368  */
4369 #define RIL_REQUEST_SET_RADIO_CAPABILITY 131
4370
4371 /**
4372  * RIL_REQUEST_START_LCE
4373  *
4374  * Start Link Capacity Estimate (LCE) service if supported by the radio.
4375  *
4376  * "data" is const int *
4377  * ((const int*)data)[0] specifies the desired reporting interval (ms).
4378  *
4379  * "response" is the RIL_LCEStatusInfo.
4380  *
4381  * Valid errors:
4382  * SUCCESS
4383  * RADIO_NOT_AVAILABLE
4384  * LCE_NOT_SUPPORTED
4385  */
4386 #define RIL_REQUEST_START_LCE 132
4387
4388 /**
4389  * RIL_REQUEST_STOP_LCE
4390  *
4391  * Stop Link Capacity Estimate (LCE) service, the STOP operation should be
4392  * idempotent for the radio modem.
4393  *
4394  * "response" is the RIL_LCEStatusInfo.
4395  *
4396  * Valid errors:
4397  * SUCCESS
4398  * RADIO_NOT_AVAILABLE
4399  * LCE_NOT_SUPPORTED
4400  */
4401 #define RIL_REQUEST_STOP_LCE 133
4402
4403 /**
4404  * RIL_REQUEST_PULL_LCEDATA
4405  *
4406  * Pull LCE service for capacity information.
4407  *
4408  * "response" is the RIL_LCEDataInfo.
4409  *
4410  * Valid errors:
4411  * SUCCESS
4412  * RADIO_NOT_AVAILABLE
4413  * LCE_NOT_SUPPORTED
4414  */
4415 #define RIL_REQUEST_PULL_LCEDATA 134
4416
4417
4418 /***********************************************************************/
4419
4420
4421 #define RIL_UNSOL_RESPONSE_BASE 1000
4422
4423 /**
4424  * RIL_UNSOL_RESPONSE_RADIO_STATE_CHANGED
4425  *
4426  * Indicate when value of RIL_RadioState has changed.
4427  *
4428  * Callee will invoke RIL_RadioStateRequest method on main thread
4429  *
4430  * "data" is NULL
4431  */
4432
4433 #define RIL_UNSOL_RESPONSE_RADIO_STATE_CHANGED 1000
4434
4435
4436 /**
4437  * RIL_UNSOL_RESPONSE_CALL_STATE_CHANGED
4438  *
4439  * Indicate when call state has changed
4440  *
4441  * Callee will invoke RIL_REQUEST_GET_CURRENT_CALLS on main thread
4442  *
4443  * "data" is NULL
4444  *
4445  * Response should be invoked on, for example,
4446  * "RING", "BUSY", "NO CARRIER", and also call state
4447  * transitions (DIALING->ALERTING ALERTING->ACTIVE)
4448  *
4449  * Redundent or extraneous invocations are tolerated
4450  */
4451 #define RIL_UNSOL_RESPONSE_CALL_STATE_CHANGED 1001
4452
4453
4454 /**
4455  * RIL_UNSOL_RESPONSE_VOICE_NETWORK_STATE_CHANGED
4456  *
4457  * Called when the voice network state changed
4458  *
4459  * Callee will invoke the following requests on main thread:
4460  *
4461  * RIL_REQUEST_VOICE_REGISTRATION_STATE
4462  * RIL_REQUEST_OPERATOR
4463  *
4464  * "data" is NULL
4465  *
4466  * FIXME should this happen when SIM records are loaded? (eg, for
4467  * EONS)
4468  */
4469 #define RIL_UNSOL_RESPONSE_VOICE_NETWORK_STATE_CHANGED 1002
4470
4471 /**
4472  * RIL_UNSOL_RESPONSE_NEW_SMS
4473  *
4474  * Called when new SMS is received.
4475  *
4476  * "data" is const char *
4477  * This is a pointer to a string containing the PDU of an SMS-DELIVER
4478  * as an ascii string of hex digits. The PDU starts with the SMSC address
4479  * per TS 27.005 (+CMT:)
4480  *
4481  * Callee will subsequently confirm the receipt of thei SMS with a
4482  * RIL_REQUEST_SMS_ACKNOWLEDGE
4483  *
4484  * No new RIL_UNSOL_RESPONSE_NEW_SMS
4485  * or RIL_UNSOL_RESPONSE_NEW_SMS_STATUS_REPORT messages should be sent until a
4486  * RIL_REQUEST_SMS_ACKNOWLEDGE has been received
4487  */
4488
4489 #define RIL_UNSOL_RESPONSE_NEW_SMS 1003
4490
4491 /**
4492  * RIL_UNSOL_RESPONSE_NEW_SMS_STATUS_REPORT
4493  *
4494  * Called when new SMS Status Report is received.
4495  *
4496  * "data" is const char *
4497  * This is a pointer to a string containing the PDU of an SMS-STATUS-REPORT
4498  * as an ascii string of hex digits. The PDU starts with the SMSC address
4499  * per TS 27.005 (+CDS:).
4500  *
4501  * Callee will subsequently confirm the receipt of the SMS with a
4502  * RIL_REQUEST_SMS_ACKNOWLEDGE
4503  *
4504  * No new RIL_UNSOL_RESPONSE_NEW_SMS
4505  * or RIL_UNSOL_RESPONSE_NEW_SMS_STATUS_REPORT messages should be sent until a
4506  * RIL_REQUEST_SMS_ACKNOWLEDGE has been received
4507  */
4508
4509 #define RIL_UNSOL_RESPONSE_NEW_SMS_STATUS_REPORT 1004
4510
4511 /**
4512  * RIL_UNSOL_RESPONSE_NEW_SMS_ON_SIM
4513  *
4514  * Called when new SMS has been stored on SIM card
4515  *
4516  * "data" is const int *
4517  * ((const int *)data)[0] contains the slot index on the SIM that contains
4518  * the new message
4519  */
4520
4521 #define RIL_UNSOL_RESPONSE_NEW_SMS_ON_SIM 1005
4522
4523 /**
4524  * RIL_UNSOL_ON_USSD
4525  *
4526  * Called when a new USSD message is received.
4527  *
4528  * "data" is const char **
4529  * ((const char **)data)[0] points to a type code, which is
4530  *  one of these string values:
4531  *      "0"   USSD-Notify -- text in ((const char **)data)[1]
4532  *      "1"   USSD-Request -- text in ((const char **)data)[1]
4533  *      "2"   Session terminated by network
4534  *      "3"   other local client (eg, SIM Toolkit) has responded
4535  *      "4"   Operation not supported
4536  *      "5"   Network timeout
4537  *
4538  * The USSD session is assumed to persist if the type code is "1", otherwise
4539  * the current session (if any) is assumed to have terminated.
4540  *
4541  * ((const char **)data)[1] points to a message string if applicable, which
4542  * should always be in UTF-8.
4543  */
4544 #define RIL_UNSOL_ON_USSD 1006
4545 /* Previously #define RIL_UNSOL_ON_USSD_NOTIFY 1006   */
4546
4547 /**
4548  * RIL_UNSOL_ON_USSD_REQUEST
4549  *
4550  * Obsolete. Send via RIL_UNSOL_ON_USSD
4551  */
4552 #define RIL_UNSOL_ON_USSD_REQUEST 1007
4553
4554 /**
4555  * RIL_UNSOL_NITZ_TIME_RECEIVED
4556  *
4557  * Called when radio has received a NITZ time message
4558  *
4559  * "data" is const char * pointing to NITZ time string
4560  * in the form "yy/mm/dd,hh:mm:ss(+/-)tz,dt"
4561  */
4562 #define RIL_UNSOL_NITZ_TIME_RECEIVED  1008
4563
4564 /**
4565  * RIL_UNSOL_SIGNAL_STRENGTH
4566  *
4567  * Radio may report signal strength rather han have it polled.
4568  *
4569  * "data" is a const RIL_SignalStrength *
4570  */
4571 #define RIL_UNSOL_SIGNAL_STRENGTH  1009
4572
4573
4574 /**
4575  * RIL_UNSOL_DATA_CALL_LIST_CHANGED
4576  *
4577  * "data" is an array of RIL_Data_Call_Response_v6 identical to that
4578  * returned by RIL_REQUEST_DATA_CALL_LIST. It is the complete list
4579  * of current data contexts including new contexts that have been
4580  * activated. A data call is only removed from this list when the
4581  * framework sends a RIL_REQUEST_DEACTIVATE_DATA_CALL or the radio
4582  * is powered off/on.
4583  *
4584  * See also: RIL_REQUEST_DATA_CALL_LIST
4585  */
4586
4587 #define RIL_UNSOL_DATA_CALL_LIST_CHANGED 1010
4588
4589 /**
4590  * RIL_UNSOL_SUPP_SVC_NOTIFICATION
4591  *
4592  * Reports supplementary service related notification from the network.
4593  *
4594  * "data" is a const RIL_SuppSvcNotification *
4595  *
4596  */
4597
4598 #define RIL_UNSOL_SUPP_SVC_NOTIFICATION 1011
4599
4600 /**
4601  * RIL_UNSOL_STK_SESSION_END
4602  *
4603  * Indicate when STK session is terminated by SIM.
4604  *
4605  * "data" is NULL
4606  */
4607 #define RIL_UNSOL_STK_SESSION_END 1012
4608
4609 /**
4610  * RIL_UNSOL_STK_PROACTIVE_COMMAND
4611  *
4612  * Indicate when SIM issue a STK proactive command to applications
4613  *
4614  * "data" is a const char * containing SAT/USAT proactive command
4615  * in hexadecimal format string starting with command tag
4616  *
4617  */
4618 #define RIL_UNSOL_STK_PROACTIVE_COMMAND 1013
4619
4620 /**
4621  * RIL_UNSOL_STK_EVENT_NOTIFY
4622  *
4623  * Indicate when SIM notifies applcations some event happens.
4624  * Generally, application does not need to have any feedback to
4625  * SIM but shall be able to indicate appropriate messages to users.
4626  *
4627  * "data" is a const char * containing SAT/USAT commands or responses
4628  * sent by ME to SIM or commands handled by ME, in hexadecimal format string
4629  * starting with first byte of response data or command tag
4630  *
4631  */
4632 #define RIL_UNSOL_STK_EVENT_NOTIFY 1014
4633
4634 /**
4635  * RIL_UNSOL_STK_CALL_SETUP
4636  *
4637  * Indicate when SIM wants application to setup a voice call.
4638  *
4639  * "data" is const int *
4640  * ((const int *)data)[0] contains timeout value (in milliseconds)
4641  */
4642 #define RIL_UNSOL_STK_CALL_SETUP 1015
4643
4644 /**
4645  * RIL_UNSOL_SIM_SMS_STORAGE_FULL
4646  *
4647  * Indicates that SMS storage on the SIM is full.  Sent when the network
4648  * attempts to deliver a new SMS message.  Messages cannot be saved on the
4649  * SIM until space is freed.  In particular, incoming Class 2 messages
4650  * cannot be stored.
4651  *
4652  * "data" is null
4653  *
4654  */
4655 #define RIL_UNSOL_SIM_SMS_STORAGE_FULL 1016
4656
4657 /**
4658  * RIL_UNSOL_SIM_REFRESH
4659  *
4660  * Indicates that file(s) on the SIM have been updated, or the SIM
4661  * has been reinitialized.
4662  *
4663  * In the case where RIL is version 6 or older:
4664  * "data" is an int *
4665  * ((int *)data)[0] is a RIL_SimRefreshResult.
4666  * ((int *)data)[1] is the EFID of the updated file if the result is
4667  * SIM_FILE_UPDATE or NULL for any other result.
4668  *
4669  * In the case where RIL is version 7:
4670  * "data" is a RIL_SimRefreshResponse_v7 *
4671  *
4672  * Note: If the SIM state changes as a result of the SIM refresh (eg,
4673  * SIM_READY -> SIM_LOCKED_OR_ABSENT), RIL_UNSOL_RESPONSE_SIM_STATUS_CHANGED
4674  * should be sent.
4675  */
4676 #define RIL_UNSOL_SIM_REFRESH 1017
4677
4678 /**
4679  * RIL_UNSOL_CALL_RING
4680  *
4681  * Ring indication for an incoming call (eg, RING or CRING event).
4682  * There must be at least one RIL_UNSOL_CALL_RING at the beginning
4683  * of a call and sending multiple is optional. If the system property
4684  * ro.telephony.call_ring.multiple is false then the upper layers
4685  * will generate the multiple events internally. Otherwise the vendor
4686  * ril must generate multiple RIL_UNSOL_CALL_RING if
4687  * ro.telephony.call_ring.multiple is true or if it is absent.
4688  *
4689  * The rate of these events is controlled by ro.telephony.call_ring.delay
4690  * and has a default value of 3000 (3 seconds) if absent.
4691  *
4692  * "data" is null for GSM
4693  * "data" is const RIL_CDMA_SignalInfoRecord * if CDMA
4694  */
4695 #define RIL_UNSOL_CALL_RING 1018
4696
4697 /**
4698  * RIL_UNSOL_RESPONSE_SIM_STATUS_CHANGED
4699  *
4700  * Indicates that SIM state changes.
4701  *
4702  * Callee will invoke RIL_REQUEST_GET_SIM_STATUS on main thread
4703
4704  * "data" is null
4705  */
4706 #define RIL_UNSOL_RESPONSE_SIM_STATUS_CHANGED 1019
4707
4708 /**
4709  * RIL_UNSOL_RESPONSE_CDMA_NEW_SMS
4710  *
4711  * Called when new CDMA SMS is received
4712  *
4713  * "data" is const RIL_CDMA_SMS_Message *
4714  *
4715  * Callee will subsequently confirm the receipt of the SMS with
4716  * a RIL_REQUEST_CDMA_SMS_ACKNOWLEDGE
4717  *
4718  * No new RIL_UNSOL_RESPONSE_CDMA_NEW_SMS should be sent until
4719  * RIL_REQUEST_CDMA_SMS_ACKNOWLEDGE has been received
4720  *
4721  */
4722 #define RIL_UNSOL_RESPONSE_CDMA_NEW_SMS 1020
4723
4724 /**
4725  * RIL_UNSOL_RESPONSE_NEW_BROADCAST_SMS
4726  *
4727  * Called when new Broadcast SMS is received
4728  *
4729  * "data" can be one of the following:
4730  * If received from GSM network, "data" is const char of 88 bytes
4731  * which indicates each page of a CBS Message sent to the MS by the
4732  * BTS as coded in 3GPP 23.041 Section 9.4.1.2.
4733  * If received from UMTS network, "data" is const char of 90 up to 1252
4734  * bytes which contain between 1 and 15 CBS Message pages sent as one
4735  * packet to the MS by the BTS as coded in 3GPP 23.041 Section 9.4.2.2.
4736  *
4737  */
4738 #define RIL_UNSOL_RESPONSE_NEW_BROADCAST_SMS 1021
4739
4740 /**
4741  * RIL_UNSOL_CDMA_RUIM_SMS_STORAGE_FULL
4742  *
4743  * Indicates that SMS storage on the RUIM is full.  Messages
4744  * cannot be saved on the RUIM until space is freed.
4745  *
4746  * "data" is null
4747  *
4748  */
4749 #define RIL_UNSOL_CDMA_RUIM_SMS_STORAGE_FULL 1022
4750
4751 /**
4752  * RIL_UNSOL_RESTRICTED_STATE_CHANGED
4753  *
4754  * Indicates a restricted state change (eg, for Domain Specific Access Control).
4755  *
4756  * Radio need send this msg after radio off/on cycle no matter it is changed or not.
4757  *
4758  * "data" is an int *
4759  * ((int *)data)[0] contains a bitmask of RIL_RESTRICTED_STATE_* values.
4760  */
4761 #define RIL_UNSOL_RESTRICTED_STATE_CHANGED 1023
4762
4763 /**
4764  * RIL_UNSOL_ENTER_EMERGENCY_CALLBACK_MODE
4765  *
4766  * Indicates that the radio system selection module has
4767  * autonomously entered emergency callback mode.
4768  *
4769  * "data" is null
4770  *
4771  */
4772 #define RIL_UNSOL_ENTER_EMERGENCY_CALLBACK_MODE 1024
4773
4774 /**
4775  * RIL_UNSOL_CDMA_CALL_WAITING
4776  *
4777  * Called when CDMA radio receives a call waiting indication.
4778  *
4779  * "data" is const RIL_CDMA_CallWaiting *
4780  *
4781  */
4782 #define RIL_UNSOL_CDMA_CALL_WAITING 1025
4783
4784 /**
4785  * RIL_UNSOL_CDMA_OTA_PROVISION_STATUS
4786  *
4787  * Called when CDMA radio receives an update of the progress of an
4788  * OTASP/OTAPA call.
4789  *
4790  * "data" is const int *
4791  *  For CDMA this is an integer OTASP/OTAPA status listed in
4792  *  RIL_CDMA_OTA_ProvisionStatus.
4793  *
4794  */
4795 #define RIL_UNSOL_CDMA_OTA_PROVISION_STATUS 1026
4796
4797 /**
4798  * RIL_UNSOL_CDMA_INFO_REC
4799  *
4800  * Called when CDMA radio receives one or more info recs.
4801  *
4802  * "data" is const RIL_CDMA_InformationRecords *
4803  *
4804  */
4805 #define RIL_UNSOL_CDMA_INFO_REC 1027
4806
4807 /**
4808  * RIL_UNSOL_OEM_HOOK_RAW
4809  *
4810  * This is for OEM specific use.
4811  *
4812  * "data" is a byte[]
4813  */
4814 #define RIL_UNSOL_OEM_HOOK_RAW 1028
4815
4816 /**
4817  * RIL_UNSOL_RINGBACK_TONE
4818  *
4819  * Indicates that nework doesn't have in-band information,  need to
4820  * play out-band tone.
4821  *
4822  * "data" is an int *
4823  * ((int *)data)[0] == 0 for stop play ringback tone.
4824  * ((int *)data)[0] == 1 for start play ringback tone.
4825  */
4826 #define RIL_UNSOL_RINGBACK_TONE 1029
4827
4828 /**
4829  * RIL_UNSOL_RESEND_INCALL_MUTE
4830  *
4831  * Indicates that framework/application need reset the uplink mute state.
4832  *
4833  * There may be situations where the mute state becomes out of sync
4834  * between the application and device in some GSM infrastructures.
4835  *
4836  * "data" is null
4837  */
4838 #define RIL_UNSOL_RESEND_INCALL_MUTE 1030
4839
4840 /**
4841  * RIL_UNSOL_CDMA_SUBSCRIPTION_SOURCE_CHANGED
4842  *
4843  * Called when CDMA subscription source changed.
4844  *
4845  * "data" is int *
4846  * ((int *)data)[0] is == RIL_CdmaSubscriptionSource
4847  */
4848 #define RIL_UNSOL_CDMA_SUBSCRIPTION_SOURCE_CHANGED 1031
4849
4850 /**
4851  * RIL_UNSOL_CDMA_PRL_CHANGED
4852  *
4853  * Called when PRL (preferred roaming list) changes.
4854  *
4855  * "data" is int *
4856  * ((int *)data)[0] is PRL_VERSION as would be returned by RIL_REQUEST_CDMA_SUBSCRIPTION
4857  */
4858 #define RIL_UNSOL_CDMA_PRL_CHANGED 1032
4859
4860 /**
4861  * RIL_UNSOL_EXIT_EMERGENCY_CALLBACK_MODE
4862  *
4863  * Called when Emergency Callback Mode Ends
4864  *
4865  * Indicates that the radio system selection module has
4866  * proactively exited emergency callback mode.
4867  *
4868  * "data" is NULL
4869  *
4870  */
4871 #define RIL_UNSOL_EXIT_EMERGENCY_CALLBACK_MODE 1033
4872
4873 /**
4874  * RIL_UNSOL_RIL_CONNECTED
4875  *
4876  * Called the ril connects and returns the version
4877  *
4878  * "data" is int *
4879  * ((int *)data)[0] is RIL_VERSION
4880  */
4881 #define RIL_UNSOL_RIL_CONNECTED 1034
4882
4883 /**
4884  * RIL_UNSOL_VOICE_RADIO_TECH_CHANGED
4885  *
4886  * Indicates that voice technology has changed. Contains new radio technology
4887  * as a data in the message.
4888  *
4889  * "data" is int *
4890  * ((int *)data)[0] is of type const RIL_RadioTechnology
4891  *
4892  */
4893 #define RIL_UNSOL_VOICE_RADIO_TECH_CHANGED 1035
4894
4895 /**
4896  * RIL_UNSOL_CELL_INFO_LIST
4897  *
4898  * Same information as returned by RIL_REQUEST_GET_CELL_INFO_LIST, but returned
4899  * at the rate no greater than specified by RIL_REQUEST_SET_UNSOL_CELL_INFO_RATE.
4900  *
4901  * "data" is NULL
4902  *
4903  * "response" is an array of RIL_CellInfo.
4904  */
4905 #define RIL_UNSOL_CELL_INFO_LIST 1036
4906
4907 /**
4908  * RIL_UNSOL_RESPONSE_IMS_NETWORK_STATE_CHANGED
4909  *
4910  * Called when IMS registration state has changed
4911  *
4912  * To get IMS registration state and IMS SMS format, callee needs to invoke the
4913  * following request on main thread:
4914  *
4915  * RIL_REQUEST_IMS_REGISTRATION_STATE
4916  *
4917  * "data" is NULL
4918  *
4919  */
4920 #define RIL_UNSOL_RESPONSE_IMS_NETWORK_STATE_CHANGED 1037
4921
4922 /**
4923  * RIL_UNSOL_UICC_SUBSCRIPTION_STATUS_CHANGED
4924  *
4925  * Indicated when there is a change in subscription status.
4926  * This event will be sent in the following scenarios
4927  *  - subscription readiness at modem, which was selected by telephony layer
4928  *  - when subscription is deactivated by modem due to UICC card removal
4929  *  - When network invalidates the subscription i.e. attach reject due to authentication reject
4930  *
4931  * "data" is const int *
4932  * ((const int *)data)[0] == 0 for Subscription Deactivated
4933  * ((const int *)data)[0] == 1 for Subscription Activated
4934  *
4935  */
4936 #define RIL_UNSOL_UICC_SUBSCRIPTION_STATUS_CHANGED 1038
4937
4938 /**
4939  * RIL_UNSOL_SRVCC_STATE_NOTIFY
4940  *
4941  * Called when Single Radio Voice Call Continuity(SRVCC)
4942  * progress state has changed
4943  *
4944  * "data" is int *
4945  * ((int *)data)[0] is of type const RIL_SrvccState
4946  *
4947  */
4948
4949 #define RIL_UNSOL_SRVCC_STATE_NOTIFY 1039
4950
4951 /**
4952  * RIL_UNSOL_HARDWARE_CONFIG_CHANGED
4953  *
4954  * Called when the hardware configuration associated with the RILd changes
4955  *
4956  * "data" is an array of RIL_HardwareConfig
4957  *
4958  */
4959 #define RIL_UNSOL_HARDWARE_CONFIG_CHANGED 1040
4960
4961 /**
4962  * RIL_UNSOL_DC_RT_INFO_CHANGED
4963  *
4964  * Sent when the DC_RT_STATE changes but the time
4965  * between these messages must not be less than the
4966  * value set by RIL_REQUEST_SET_DC_RT_RATE.
4967  *
4968  * "data" is the most recent RIL_DcRtInfo
4969  *
4970  */
4971 #define RIL_UNSOL_DC_RT_INFO_CHANGED 1041
4972
4973 /**
4974  * RIL_UNSOL_RADIO_CAPABILITY
4975  *
4976  * Sent when RIL_REQUEST_SET_RADIO_CAPABILITY completes.
4977  * Returns the phone radio capability exactly as
4978  * RIL_REQUEST_GET_RADIO_CAPABILITY and should be the
4979  * same set as sent by RIL_REQUEST_SET_RADIO_CAPABILITY.
4980  *
4981  * "data" is the RIL_RadioCapability structure
4982  */
4983 #define RIL_UNSOL_RADIO_CAPABILITY 1042
4984
4985 /*
4986  * RIL_UNSOL_ON_SS
4987  *
4988  * Called when SS response is received when DIAL/USSD/SS is changed to SS by
4989  * call control.
4990  *
4991  * "data" is const RIL_StkCcUnsolSsResponse *
4992  *
4993  */
4994 #define RIL_UNSOL_ON_SS 1043
4995
4996 /**
4997  * RIL_UNSOL_STK_CC_ALPHA_NOTIFY
4998  *
4999  * Called when there is an ALPHA from UICC during Call Control.
5000  *
5001  * "data" is const char * containing ALPHA string from UICC in UTF-8 format.
5002  *
5003  */
5004 #define RIL_UNSOL_STK_CC_ALPHA_NOTIFY 1044
5005
5006 /**
5007  * RIL_UNSOL_LCEDATA_RECV
5008  *
5009  * Called when there is an incoming Link Capacity Estimate (LCE) info report.
5010  *
5011  * "data" is the RIL_LCEDataInfo structure.
5012  *
5013  */
5014 #define RIL_UNSOL_LCEDATA_RECV 1045
5015
5016 /***********************************************************************/
5017
5018
5019 #if defined(ANDROID_MULTI_SIM)
5020 /**
5021  * RIL_Request Function pointer
5022  *
5023  * @param request is one of RIL_REQUEST_*
5024  * @param data is pointer to data defined for that RIL_REQUEST_*
5025  *        data is owned by caller, and should not be modified or freed by callee
5026  * @param t should be used in subsequent call to RIL_onResponse
5027  * @param datalen the length of data
5028  *
5029  */
5030 typedef void (*RIL_RequestFunc) (int request, void *data,
5031                                     size_t datalen, RIL_Token t, RIL_SOCKET_ID socket_id);
5032
5033 /**
5034  * This function should return the current radio state synchronously
5035  */
5036 typedef RIL_RadioState (*RIL_RadioStateRequest)(RIL_SOCKET_ID socket_id);
5037
5038 #else
5039 /* Backward compatible */
5040
5041 /**
5042  * RIL_Request Function pointer
5043  *
5044  * @param request is one of RIL_REQUEST_*
5045  * @param data is pointer to data defined for that RIL_REQUEST_*
5046  *        data is owned by caller, and should not be modified or freed by callee
5047  * @param t should be used in subsequent call to RIL_onResponse
5048  * @param datalen the length of data
5049  *
5050  */
5051 typedef void (*RIL_RequestFunc) (int request, void *data,
5052                                     size_t datalen, RIL_Token t);
5053
5054 /**
5055  * This function should return the current radio state synchronously
5056  */
5057 typedef RIL_RadioState (*RIL_RadioStateRequest)();
5058
5059 #endif
5060
5061
5062 /**
5063  * This function returns "1" if the specified RIL_REQUEST code is
5064  * supported and 0 if it is not
5065  *
5066  * @param requestCode is one of RIL_REQUEST codes
5067  */
5068
5069 typedef int (*RIL_Supports)(int requestCode);
5070
5071 /**
5072  * This function is called from a separate thread--not the
5073  * thread that calls RIL_RequestFunc--and indicates that a pending
5074  * request should be cancelled.
5075  *
5076  * On cancel, the callee should do its best to abandon the request and
5077  * call RIL_onRequestComplete with RIL_Errno CANCELLED at some later point.
5078  *
5079  * Subsequent calls to  RIL_onRequestComplete for this request with
5080  * other results will be tolerated but ignored. (That is, it is valid
5081  * to ignore the cancellation request)
5082  *
5083  * RIL_Cancel calls should return immediately, and not wait for cancellation
5084  *
5085  * Please see ITU v.250 5.6.1 for how one might implement this on a TS 27.007
5086  * interface
5087  *
5088  * @param t token wants to be canceled
5089  */
5090
5091 typedef void (*RIL_Cancel)(RIL_Token t);
5092
5093 typedef void (*RIL_TimedCallback) (void *param);
5094
5095 /**
5096  * Return a version string for your RIL implementation
5097  */
5098 typedef const char * (*RIL_GetVersion) (void);
5099
5100 typedef struct {
5101     int version;        /* set to RIL_VERSION */
5102     RIL_RequestFunc onRequest;
5103     RIL_RadioStateRequest onStateRequest;
5104     RIL_Supports supports;
5105     RIL_Cancel onCancel;
5106     RIL_GetVersion getVersion;
5107 } RIL_RadioFunctions;
5108
5109 typedef struct {
5110     char *apn;
5111     char *protocol;
5112     int authtype;
5113     char *username;
5114     char *password;
5115 } RIL_InitialAttachApn;
5116
5117 typedef struct {
5118     int authContext;            /* P2 value of authentication command, see P2 parameter in
5119                                    3GPP TS 31.102 7.1.2 */
5120     char *authData;             /* the challenge string in Base64 format, see 3GPP
5121                                    TS 31.102 7.1.2 */
5122     char *aid;                  /* AID value, See ETSI 102.221 8.1 and 101.220 4,
5123                                    NULL if no value. */
5124 } RIL_SimAuthentication;
5125
5126 #ifdef RIL_SHLIB
5127 struct RIL_Env {
5128     /**
5129      * "t" is parameter passed in on previous call to RIL_Notification
5130      * routine.
5131      *
5132      * If "e" != SUCCESS, then response can be null/is ignored
5133      *
5134      * "response" is owned by caller, and should not be modified or
5135      * freed by callee
5136      *
5137      * RIL_onRequestComplete will return as soon as possible
5138      */
5139     void (*OnRequestComplete)(RIL_Token t, RIL_Errno e,
5140                            void *response, size_t responselen);
5141
5142 #if defined(ANDROID_MULTI_SIM)
5143     /**
5144      * "unsolResponse" is one of RIL_UNSOL_RESPONSE_*
5145      * "data" is pointer to data defined for that RIL_UNSOL_RESPONSE_*
5146      *
5147      * "data" is owned by caller, and should not be modified or freed by callee
5148      */
5149     void (*OnUnsolicitedResponse)(int unsolResponse, const void *data, size_t datalen, RIL_SOCKET_ID socket_id);
5150 #else
5151     /**
5152      * "unsolResponse" is one of RIL_UNSOL_RESPONSE_*
5153      * "data" is pointer to data defined for that RIL_UNSOL_RESPONSE_*
5154      *
5155      * "data" is owned by caller, and should not be modified or freed by callee
5156      */
5157     void (*OnUnsolicitedResponse)(int unsolResponse, const void *data, size_t datalen);
5158 #endif
5159     /**
5160      * Call user-specifed "callback" function on on the same thread that
5161      * RIL_RequestFunc is called. If "relativeTime" is specified, then it specifies
5162      * a relative time value at which the callback is invoked. If relativeTime is
5163      * NULL or points to a 0-filled structure, the callback will be invoked as
5164      * soon as possible
5165      */
5166
5167     void (*RequestTimedCallback) (RIL_TimedCallback callback,
5168                                    void *param, const struct timeval *relativeTime);
5169 };
5170
5171
5172 /**
5173  *  RIL implementations must defined RIL_Init
5174  *  argc and argv will be command line arguments intended for the RIL implementation
5175  *  Return NULL on error
5176  *
5177  * @param env is environment point defined as RIL_Env
5178  * @param argc number of arguments
5179  * @param argv list fo arguments
5180  *
5181  */
5182 const RIL_RadioFunctions *RIL_Init(const struct RIL_Env *env, int argc, char **argv);
5183
5184 #else /* RIL_SHLIB */
5185
5186 /**
5187  * Call this once at startup to register notification routine
5188  *
5189  * @param callbacks user-specifed callback function
5190  */
5191 void RIL_register (const RIL_RadioFunctions *callbacks);
5192
5193
5194 /**
5195  *
5196  * RIL_onRequestComplete will return as soon as possible
5197  *
5198  * @param t is parameter passed in on previous call to RIL_Notification
5199  *          routine.
5200  * @param e error code
5201  *          if "e" != SUCCESS, then response can be null/is ignored
5202  * @param response is owned by caller, and should not be modified or
5203  *                 freed by callee
5204  * @param responselen the length of response in byte
5205  */
5206 void RIL_onRequestComplete(RIL_Token t, RIL_Errno e,
5207                            void *response, size_t responselen);
5208
5209 #if defined(ANDROID_MULTI_SIM)
5210 /**
5211  * @param unsolResponse is one of RIL_UNSOL_RESPONSE_*
5212  * @param data is pointer to data defined for that RIL_UNSOL_RESPONSE_*
5213  *     "data" is owned by caller, and should not be modified or freed by callee
5214  * @param datalen the length of data in byte
5215  */
5216
5217 void RIL_onUnsolicitedResponse(int unsolResponse, const void *data,
5218                                 size_t datalen, RIL_SOCKET_ID socket_id);
5219 #else
5220 /**
5221  * @param unsolResponse is one of RIL_UNSOL_RESPONSE_*
5222  * @param data is pointer to data defined for that RIL_UNSOL_RESPONSE_*
5223  *     "data" is owned by caller, and should not be modified or freed by callee
5224  * @param datalen the length of data in byte
5225  */
5226
5227 void RIL_onUnsolicitedResponse(int unsolResponse, const void *data,
5228                                 size_t datalen);
5229 #endif
5230
5231 /**
5232  * Call user-specifed "callback" function on on the same thread that
5233  * RIL_RequestFunc is called. If "relativeTime" is specified, then it specifies
5234  * a relative time value at which the callback is invoked. If relativeTime is
5235  * NULL or points to a 0-filled structure, the callback will be invoked as
5236  * soon as possible
5237  *
5238  * @param callback user-specifed callback function
5239  * @param param parameter list
5240  * @param relativeTime a relative time value at which the callback is invoked
5241  */
5242
5243 void RIL_requestTimedCallback (RIL_TimedCallback callback,
5244                                void *param, const struct timeval *relativeTime);
5245
5246
5247 #endif /* RIL_SHLIB */
5248
5249 #ifdef __cplusplus
5250 }
5251 #endif
5252
5253 #endif /*ANDROID_RIL_H*/