blob: 236dbf5bd6e61d2fdc2913eb3baa6054df2ddecc [file] [log] [blame]
Amit Mahajan4cb7b842016-08-12 15:25:10 -07001/*
2 * Copyright (C) 2016 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
17package android.hardware.radio@1.0;
18
Sanket Padawe76372492016-10-27 13:20:49 -070019import IRadioResponse;
20import IRadioIndication;
Amit Mahajan4cb7b842016-08-12 15:25:10 -070021
Andreas Huber675ae492017-03-28 14:40:58 -070022/**
Sanket Padawe76372492016-10-27 13:20:49 -070023 * This interface is used by telephony & telecom to talk to cellular radio.
Sanket Padawed52335c2016-11-03 16:46:32 -070024 * All the functions have minimum one parameter:
Sanket Padawe76372492016-10-27 13:20:49 -070025 * serial: which corresponds to serial no. of request. Serial numbers must only be memorized for the
26 * duration of a method call. If clients provide colliding serials (including passing the same
27 * serial to different methods), multiple responses (one for each method call) must still be served.
28 */
Amit Mahajan4cb7b842016-08-12 15:25:10 -070029interface IRadio {
Andreas Huber675ae492017-03-28 14:40:58 -070030 /**
Sanket Padawe76372492016-10-27 13:20:49 -070031 * Set response functions for radio requests & radio indications.
Amit Mahajan4cb7b842016-08-12 15:25:10 -070032 *
Sanket Padawe76372492016-10-27 13:20:49 -070033 * @param radioResponse Object containing response functions
34 * @param radioIndication Object containing radio indications
Amit Mahajan4cb7b842016-08-12 15:25:10 -070035 */
Steven Moreland32a8a982017-03-21 23:09:44 +000036 setResponseFunctions(IRadioResponse radioResponse,
Sanket Padawe76372492016-10-27 13:20:49 -070037 IRadioIndication radioIndication);
Amit Mahajan4cb7b842016-08-12 15:25:10 -070038
Andreas Huber675ae492017-03-28 14:40:58 -070039 /**
Amit Mahajan4cb7b842016-08-12 15:25:10 -070040 * Requests status of the ICC card
41 *
Sanket Padawe76372492016-10-27 13:20:49 -070042 * @param serial Serial number of request.
Amit Mahajan4cb7b842016-08-12 15:25:10 -070043 *
Sanket Padawe76372492016-10-27 13:20:49 -070044 * Response function is IRadioResponse.getIccCardStatusResponse()
45 *
46 */
Sanket Padawed52335c2016-11-03 16:46:32 -070047 oneway getIccCardStatus(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -070048
Andreas Huber675ae492017-03-28 14:40:58 -070049 /**
Sanket Padawe76372492016-10-27 13:20:49 -070050 * Supplies ICC PIN. Only called if CardStatus has AppState.PIN state
Amit Mahajan4cb7b842016-08-12 15:25:10 -070051 *
Sanket Padawe76372492016-10-27 13:20:49 -070052 * @param serial Serial number of request.
53 * @param pin PIN value
54 * @param aid AID value, See ETSI 102.221 8.1 and 101.220 4, empty string if no value.
55 *
56 * Response function is IRadioResponse.supplyIccPinForAppResponse()
57 *
Amit Mahajan4cb7b842016-08-12 15:25:10 -070058 */
Sanket Padawed52335c2016-11-03 16:46:32 -070059 oneway supplyIccPinForApp(int32_t serial, string pin, string aid);
Sanket Padawe76372492016-10-27 13:20:49 -070060
Andreas Huber675ae492017-03-28 14:40:58 -070061 /**
Sanket Padawe76372492016-10-27 13:20:49 -070062 * Supplies ICC PUK and new PIN.
63 *
Sanket Padawe76372492016-10-27 13:20:49 -070064 * @param serial Serial number of request.
65 * @param puk PUK value
66 * @param pin New PIN value
67 * @param aid AID value, See ETSI 102.221 8.1 and 101.220 4, empty string if no value.
68 *
69 * Response function is IRadioResponse.supplyIccPukForAppResponse()
70 *
71 */
Sanket Padawed52335c2016-11-03 16:46:32 -070072 oneway supplyIccPukForApp(int32_t serial, string puk, string pin, string aid);
Sanket Padawe76372492016-10-27 13:20:49 -070073
Andreas Huber675ae492017-03-28 14:40:58 -070074 /**
Sanket Padawe76372492016-10-27 13:20:49 -070075 * Supplies ICC PIN2. Only called following operation where SIM_PIN2 was
76 * returned as a a failure from a previous operation.
77 *
Sanket Padawe76372492016-10-27 13:20:49 -070078 * @param serial Serial number of request.
79 * @param pin2 PIN2 value
80 * @param aid AID value, See ETSI 102.221 8.1 and 101.220 4, empty string if no value.
81 *
82 * Response function is IRadioResponse.supplyIccPin2ForAppResponse()
83 *
84 */
Sanket Padawed52335c2016-11-03 16:46:32 -070085 oneway supplyIccPin2ForApp(int32_t serial, string pin2, string aid);
Sanket Padawe76372492016-10-27 13:20:49 -070086
Andreas Huber675ae492017-03-28 14:40:58 -070087 /**
Sanket Padawe76372492016-10-27 13:20:49 -070088 * Supplies ICC PUK2 and new PIN2.
89 *
Sanket Padawe76372492016-10-27 13:20:49 -070090 * @param serial Serial number of request.
91 * @param puk2 PUK2 value
92 * @param pin2 New PIN2 value
93 * @param aid AID value, See ETSI 102.221 8.1 and 101.220 4, empty string if no value.
94 *
95 * Response function is IRadioResponse.supplyIccPuk2ForAppResponse()
96 *
97 */
Sanket Padawed52335c2016-11-03 16:46:32 -070098 oneway supplyIccPuk2ForApp(int32_t serial, string puk2, string pin2,
Sanket Padawe76372492016-10-27 13:20:49 -070099 string aid);
100
Andreas Huber675ae492017-03-28 14:40:58 -0700101 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700102 * Supplies old ICC PIN and new PIN.
103 *
Sanket Padawe76372492016-10-27 13:20:49 -0700104 * @param serial Serial number of request.
105 * @param oldPin Old pin value
106 * @param newPin New pin value
107 * @param aid AID value, See ETSI 102.221 8.1 and 101.220 4, empty string if no value.
108 *
109 * Response function is IRadioResponse.changeIccPinForAppResponse()
110 *
111 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700112 oneway changeIccPinForApp(int32_t serial, string oldPin, string newPin,
Sanket Padawe76372492016-10-27 13:20:49 -0700113 string aid);
114
Andreas Huber675ae492017-03-28 14:40:58 -0700115 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700116 * Supplies old ICC PIN2 and new PIN2.
117 *
Sanket Padawe76372492016-10-27 13:20:49 -0700118 * @param serial Serial number of request.
119 * @param oldPin2 Old pin2 value
120 * @param newPin2 New pin2 value
121 * @param aid AID value, See ETSI 102.221 8.1 and 101.220 4, empty string if no value.
122 *
123 * Response function is IRadioResponse.changeIccPin2ForAppResponse()
124 *
125 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700126 oneway changeIccPin2ForApp(int32_t serial, string oldPin2, string newPin2,
Sanket Padawe76372492016-10-27 13:20:49 -0700127 string aid);
128
Andreas Huber675ae492017-03-28 14:40:58 -0700129 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700130 * Requests that network personalization be deactivated
131 *
Sanket Padawe76372492016-10-27 13:20:49 -0700132 * @param serial Serial number of request.
133 * @param netPin Network depersonlization code
134 *
135 * Response function is IRadioResponse.supplyNetworkDepersonalizationResponse()
136 *
137 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700138 oneway supplyNetworkDepersonalization(int32_t serial, string netPin);
Sanket Padawe76372492016-10-27 13:20:49 -0700139
Andreas Huber675ae492017-03-28 14:40:58 -0700140 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700141 * Requests current call list
142 *
Sanket Padawe76372492016-10-27 13:20:49 -0700143 * @param serial Serial number of request.
144 *
145 * Response function is IRadioResponse.getCurrentCallsResponse()
146 *
147 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700148 oneway getCurrentCalls(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700149
Andreas Huber675ae492017-03-28 14:40:58 -0700150 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700151 * Initiate voice call.
152 * This method is never used for supplementary service codes
153 *
Sanket Padawe76372492016-10-27 13:20:49 -0700154 * @param serial Serial number of request.
155 * @param dialInfo Dial struct
156 *
157 * Response function is IRadioResponse.dialResponse()
158 *
159 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700160 oneway dial(int32_t serial, Dial dialInfo);
Sanket Padawe76372492016-10-27 13:20:49 -0700161
Andreas Huber675ae492017-03-28 14:40:58 -0700162 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700163 * Get the SIM IMSI
164 * Only valid when radio state is "RADIO_STATE_ON"
165 *
Sanket Padawe76372492016-10-27 13:20:49 -0700166 * @param serial Serial number of request.
167 * @param aid AID value, See ETSI 102.221 8.1 and 101.220 4, empty string if no value.
168 *
169 * Response function is IRadioResponse.getImsiForAppResponse()
170 *
171 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700172 oneway getImsiForApp(int32_t serial, string aid);
Sanket Padawe76372492016-10-27 13:20:49 -0700173
Andreas Huber675ae492017-03-28 14:40:58 -0700174 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700175 * Hang up a specific line (like AT+CHLD=1x)
176 * After this HANGUP request returns, Radio must show the connection is NOT
177 * active anymore in next requestGetCurrentCalls query.
178 *
Sanket Padawe76372492016-10-27 13:20:49 -0700179 * @param serial Serial number of request.
180 * @param gsmIndex Connection index (value of 'x' in CHLD above)
181 *
182 * Response function is IRadioResponse.hangupResponse()
183 *
184 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700185 oneway hangup(int32_t serial, int32_t gsmIndex);
Sanket Padawe76372492016-10-27 13:20:49 -0700186
Andreas Huber675ae492017-03-28 14:40:58 -0700187 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700188 * Hang up waiting or held (like AT+CHLD=0)
189 * After this HANGUP request returns, Radio must show the connection is NOT
190 * active anymore in next getCurrentCalls() query.
191 *
Sanket Padawe76372492016-10-27 13:20:49 -0700192 * @param serial Serial number of request.
193 *
194 * Response function is IRadioResponse.hangupWaitingOrBackgroundResponse()
195 *
196 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700197 oneway hangupWaitingOrBackground(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700198
Andreas Huber675ae492017-03-28 14:40:58 -0700199 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700200 * Hang up waiting or held (like AT+CHLD=1)
201 * After this HANGUP request returns, Radio must show the connection is NOT
202 * active anymore in next getCurrentCalls query.
203 *
Sanket Padawe76372492016-10-27 13:20:49 -0700204 * @param serial Serial number of request.
205 *
206 * Response function is IRadioResponse.hangupForegroundResumeBackgroundResponse()
207 *
208 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700209 oneway hangupForegroundResumeBackground(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700210
Andreas Huber675ae492017-03-28 14:40:58 -0700211 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700212 * Switch waiting or holding call and active call (like AT+CHLD=2)
213 * State transitions must be as follows:
214 *
215 * Call transitions must happen as shown below.
216 *
217 * BEFORE AFTER
218 * Call 1 Call 2 Call 1 Call 2
219 * ACTIVE HOLDING HOLDING ACTIVE
220 * ACTIVE WAITING HOLDING ACTIVE
221 * HOLDING WAITING HOLDING ACTIVE
222 * ACTIVE IDLE HOLDING IDLE
223 * IDLE IDLE IDLE IDLE
224 *
Sanket Padawe76372492016-10-27 13:20:49 -0700225 * @param serial Serial number of request.
226 *
227 * Response function is IRadioResponse.switchWaitingOrHoldingAndActiveResponse()
228 *
229 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700230 oneway switchWaitingOrHoldingAndActive(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700231
Andreas Huber675ae492017-03-28 14:40:58 -0700232 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700233 * Conference holding and active (like AT+CHLD=3)
234 *
Sanket Padawe76372492016-10-27 13:20:49 -0700235 * @param serial Serial number of request.
236 *
237 * Response function is IRadioResponse.conferenceResponse()
238 *
239 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700240 oneway conference(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700241
Andreas Huber675ae492017-03-28 14:40:58 -0700242 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700243 * Send UDUB (user determined user busy) to ringing or
244 * waiting call answer)
245 *
Sanket Padawe76372492016-10-27 13:20:49 -0700246 * @param serial Serial number of request.
247 *
248 * Response function is IRadioResponse.rejectCallResponse()
249 *
250 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700251 oneway rejectCall(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700252
Andreas Huber675ae492017-03-28 14:40:58 -0700253 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700254 * Requests the failure cause code for the most recently terminated call.
255 *
Sanket Padawe76372492016-10-27 13:20:49 -0700256 * @param serial Serial number of request.
257 *
258 * Response function is IRadioResponse.getLastCallFailCauseResponse()
259 *
260 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700261 oneway getLastCallFailCause(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700262
Andreas Huber675ae492017-03-28 14:40:58 -0700263 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700264 * Requests current signal strength and associated information.
265 * Must succeed if radio is on.
266 *
Sanket Padawe76372492016-10-27 13:20:49 -0700267 * @param serial Serial number of request.
268 *
269 * Response function is IRadioResponse.getSignalStrengthResponse()
270 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700271 oneway getSignalStrength(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700272
Andreas Huber675ae492017-03-28 14:40:58 -0700273 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700274 * Request current voice registration state
275 *
Sanket Padawe76372492016-10-27 13:20:49 -0700276 * @param serial Serial number of request.
277 *
278 * Response function is IRadioResponse.getVoiceRegistrationStateResponse()
279 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700280 oneway getVoiceRegistrationState(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700281
Andreas Huber675ae492017-03-28 14:40:58 -0700282 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700283 * Request current data registration state
284 *
Sanket Padawe76372492016-10-27 13:20:49 -0700285 * @param serial Serial number of request.
286 *
287 * Response function is IRadioResponse.getDataRegistrationStateResponse()
288 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700289 oneway getDataRegistrationState(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700290
Andreas Huber675ae492017-03-28 14:40:58 -0700291 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700292 * Request current operator ONS or EONS
293 *
Sanket Padawe76372492016-10-27 13:20:49 -0700294 * @param serial Serial number of request.
295 *
296 * Response function is IRadioResponse.getOperatorResponse()
297 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700298 oneway getOperator(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700299
Andreas Huber675ae492017-03-28 14:40:58 -0700300 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700301 * Toggle radio on and off (for "airplane" mode)
302 * If the radio is turned off/on the radio modem subsystem
303 * is expected return to an initialized state. For instance,
304 * any voice and data calls must be terminated and all associated
305 * lists emptied.
306 *
Sanket Padawe76372492016-10-27 13:20:49 -0700307 * @param serial Serial number of request.
308 * @param on To turn on radio -> on = true, to turn off radio -> on = false.
309 *
310 * Response function is IRadioResponse.setRadioPowerResponse()
311 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700312 oneway setRadioPower(int32_t serial, bool on);
Sanket Padawe76372492016-10-27 13:20:49 -0700313
Andreas Huber675ae492017-03-28 14:40:58 -0700314 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700315 * Send a DTMF tone
316 *
317 * If the implementation is currently playing a tone requested via
318 * startDtmf(), that tone must be cancelled and the new tone
319 * must be played instead
320 *
Sanket Padawe76372492016-10-27 13:20:49 -0700321 * @param serial Serial number of request.
322 * @param s string with single char having one of 12 values: 0-9, *, #
323 *
324 * Response function is IRadioResponse.sendDtmfResponse()
325 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700326 oneway sendDtmf(int32_t serial, string s);
Sanket Padawe76372492016-10-27 13:20:49 -0700327
Andreas Huber675ae492017-03-28 14:40:58 -0700328 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700329 * Send an SMS message
330 *
Sanket Padawe76372492016-10-27 13:20:49 -0700331 * @param serial Serial number of request.
Sanket Padawed52335c2016-11-03 16:46:32 -0700332 * @param message GsmSmsMessage as defined in types.hal
Sanket Padawe76372492016-10-27 13:20:49 -0700333 *
334 * Response function is IRadioResponse.sendSmsResponse()
335 *
336 * Based on the return error, caller decides to resend if sending sms
337 * fails. RadioError:SMS_SEND_FAIL_RETRY means retry (i.e. error cause is 332)
338 * and RadioError:GENERIC_FAILURE means no retry (i.e. error cause is 500)
339 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700340 oneway sendSms(int32_t serial, GsmSmsMessage message);
Sanket Padawe76372492016-10-27 13:20:49 -0700341
Andreas Huber675ae492017-03-28 14:40:58 -0700342 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700343 * Send an SMS message. Identical to sendSms,
344 * except that more messages are expected to be sent soon. If possible,
345 * keep SMS relay protocol link open (eg TS 27.005 AT+CMMS command)
346 *
Sanket Padawe76372492016-10-27 13:20:49 -0700347 * @param serial Serial number of request.
Sanket Padawed52335c2016-11-03 16:46:32 -0700348 * @param message GsmSmsMessage as defined in types.hal
Sanket Padawe76372492016-10-27 13:20:49 -0700349 *
350 * Response function is IRadioResponse.sendSMSExpectMoreResponse()
351 *
352 * Based on the return error, caller decides to resend if sending sms
353 * fails. RadioError:SMS_SEND_FAIL_RETRY means retry (i.e. error cause is 332)
354 * and RadioError:GENERIC_FAILURE means no retry (i.e. error cause is 500)
355 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700356 oneway sendSMSExpectMore(int32_t serial, GsmSmsMessage message);
Sanket Padawe76372492016-10-27 13:20:49 -0700357
Andreas Huber675ae492017-03-28 14:40:58 -0700358 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700359 * Setup a packet data connection. If DataCallResponse.status
360 * return DataCallFailCause:NONE it is added to the list of data calls and a
361 * unsolDataCallListChanged() is sent. The call remains in the
362 * list until deactivateDataCall() is issued or the
363 * radio is powered off/on. This list is returned by getDataCallList()
364 * and dataCallListChanged().
365 *
Sanket Padawed52335c2016-11-03 16:46:32 -0700366 * The Radio is expected to:
Sanket Padawe76372492016-10-27 13:20:49 -0700367 * - Create one data call context.
368 * - Create and configure a dedicated interface for the context
369 * - The interface must be point to point.
370 * - The interface is configured with one or more addresses and
371 * is capable of sending and receiving packets. The prefix length
372 * of the addresses must be /32 for IPv4 and /128 for IPv6.
373 * - Must NOT change the linux routing table.
374 * - Support up to getDataRegistrationState response[5]
375 * number of simultaneous data call contexts.
376 *
Sanket Padawe76372492016-10-27 13:20:49 -0700377 * @param serial Serial number of request.
Jack Yued7ef812017-01-24 11:56:52 -0800378 * @param radioTechnology Radio technology to use.
379 * @param dataProfileInfo data profile info.
380 * @param modemCognitive Indicating this profile was sent to the modem through setDataProfile
Jack Yu439a6e72017-02-23 12:40:56 -0800381 * earlier.
Jack Yued7ef812017-01-24 11:56:52 -0800382 * @param roamingAllowed Indicating data roaming is allowed or not by the user.
Jack Yu439a6e72017-02-23 12:40:56 -0800383 * @param isRoaming Indicating the device is roaming or not. The 'protocol' parameter in the old
384 * RIL API must be filled accordingly based on the roaming condition.
385 * Note this is for backward compatibility with the old radio modem. The modem
386 * must not use this param for any other reason.
Sanket Padawe76372492016-10-27 13:20:49 -0700387 *
388 * Response function is IRadioResponse.setupDataCallResponse()
389 */
Jack Yued7ef812017-01-24 11:56:52 -0800390 oneway setupDataCall(int32_t serial, RadioTechnology radioTechnology,
Jack Yu439a6e72017-02-23 12:40:56 -0800391 DataProfileInfo dataProfileInfo, bool modemCognitive, bool roamingAllowed,
392 bool isRoaming);
Sanket Padawe76372492016-10-27 13:20:49 -0700393
Andreas Huber675ae492017-03-28 14:40:58 -0700394 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700395 * Request ICC I/O operation.
396 * This is similar to the TS 27.007 "restricted SIM" operation
397 * where it assumes all of the EF selection must be done by the
398 * callee
399 *
400 * Arguments and responses that are unused for certain
401 * values of "command" must be ignored or set to empty string
402 *
Sanket Padawe76372492016-10-27 13:20:49 -0700403 * @param serial Serial number of request.
404 * @param iccIo IccIo
405 *
406 * Please note that IccIo has a "PIN2" field which may be empty string,
407 * or may specify a PIN2 for operations that require a PIN2 (eg
408 * updating FDN records)
409 *
410 * Response function is IRadioResponse.iccIOForAppResponse()
411 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700412 oneway iccIOForApp(int32_t serial, IccIo iccIo);
Sanket Padawe76372492016-10-27 13:20:49 -0700413
Andreas Huber675ae492017-03-28 14:40:58 -0700414 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700415 * Send a USSD message.
416 *
417 * If a USSD session already exists, the message must be sent in the
418 * context of that session. Otherwise, a new session must be created.
419 *
420 * The network reply must be reported via unsolOnUssd
421 *
422 * Only one USSD session must exist at a time, and the session is assumed
423 * to exist until:
424 * a) The android system invokes cancelUssd()
425 * b) The implementation sends a unsolOnUssd() with a type code
426 * of "0" (USSD-Notify/no further action) or "2" (session terminated)
427 *
Sanket Padawe76372492016-10-27 13:20:49 -0700428 * @param serial Serial number of request.
429 * @param ussd string containing the USSD request in UTF-8 format
430 *
431 * Response function is IRadioResponse.sendUssdResponse()
432 *
433 * See also requestCancelUssd, unsolOnUssd
434 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700435 oneway sendUssd(int32_t serial, string ussd);
Sanket Padawe76372492016-10-27 13:20:49 -0700436
Andreas Huber675ae492017-03-28 14:40:58 -0700437 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700438 * Cancel the current USSD session if one exists.
439 *
Sanket Padawe76372492016-10-27 13:20:49 -0700440 * @param serial Serial number of request.
441 *
442 * Response function is IRadioResponse.cancelPendingUssdResponse()
443 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700444 oneway cancelPendingUssd(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700445
Andreas Huber675ae492017-03-28 14:40:58 -0700446 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700447 * Gets current CLIR status
448 *
Sanket Padawe76372492016-10-27 13:20:49 -0700449 * @param serial Serial number of request.
450 *
451 * Response function is IRadioResponse.getClirResponse()
452 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700453 oneway getClir(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700454
Andreas Huber675ae492017-03-28 14:40:58 -0700455 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700456 * Set current CLIR status
457 *
Sanket Padawe76372492016-10-27 13:20:49 -0700458 * @param serial Serial number of request.
459 * @param status "n" parameter from TS 27.007 7.7
460 *
461 * Response function is IRadioResponse.setClirResponse()
462 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700463 oneway setClir(int32_t serial, int32_t status);
Sanket Padawe76372492016-10-27 13:20:49 -0700464
Andreas Huber675ae492017-03-28 14:40:58 -0700465 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700466 * Request call forward status.
467 *
Sanket Padawe76372492016-10-27 13:20:49 -0700468 * @param serial Serial number of request.
469 * @param callInfo CallForwardInfo
470 *
471 * Response function is IRadioResponse.getCallForwardStatusResponse()
472 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700473 oneway getCallForwardStatus(int32_t serial,
Sanket Padawe76372492016-10-27 13:20:49 -0700474 CallForwardInfo callInfo);
475
Andreas Huber675ae492017-03-28 14:40:58 -0700476 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700477 * Configure call forward rule
478 *
Sanket Padawe76372492016-10-27 13:20:49 -0700479 * @param serial Serial number of request.
480 * @param callInfo CallForwardInfo
481 *
482 * Response function is IRadioResponse.setCallForwardResponse()
483 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700484 oneway setCallForward(int32_t serial, CallForwardInfo callInfo);
Sanket Padawe76372492016-10-27 13:20:49 -0700485
Andreas Huber675ae492017-03-28 14:40:58 -0700486 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700487 * Query current call waiting state
488 *
Sanket Padawe76372492016-10-27 13:20:49 -0700489 * @param serial Serial number of request.
490 * @param serviceClass Service class is the TS 27.007 service class to query
491 *
492 * Response function is IRadioResponse.getCallWaitingResponse()
493 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700494 oneway getCallWaiting(int32_t serial, int32_t serviceClass);
Sanket Padawe76372492016-10-27 13:20:49 -0700495
Andreas Huber675ae492017-03-28 14:40:58 -0700496 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700497 * Configure current call waiting state
498 *
Sanket Padawe76372492016-10-27 13:20:49 -0700499 * @param serial Serial number of request.
500 * @param enable is false for "disabled" and true for "enabled"
501 * @param serviceClass is the TS 27.007 service class bit vector of services to modify
502 *
503 * Response function is IRadioResponse.setCallWaitingResponse()
504 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700505 oneway setCallWaiting(int32_t serial, bool enable,
Sanket Padawe76372492016-10-27 13:20:49 -0700506 int32_t serviceClass);
507
Andreas Huber675ae492017-03-28 14:40:58 -0700508 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700509 * Acknowledge successful or failed receipt of SMS previously indicated
510 * via unsolResponseNewSms
511 *
Sanket Padawe76372492016-10-27 13:20:49 -0700512 * @param serial Serial number of request.
513 * @param success is true on successful receipt
514 * (basically, AT+CNMA=1 from TS 27.005 is 0 on failed receipt
515 * (basically, AT+CNMA=2 from TS 27.005)
516 * @param cause: if success is false, this contains the failure cause as defined
517 * in TS 23.040, 9.2.3.22.
518 *
519 * Response function is IRadioResponse.acknowledgeLastIncomingGsmSmsResponse()
520 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700521 oneway acknowledgeLastIncomingGsmSms(int32_t serial, bool success,
Sanket Padawe76372492016-10-27 13:20:49 -0700522 SmsAcknowledgeFailCause cause);
523
Andreas Huber675ae492017-03-28 14:40:58 -0700524 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700525 * Answer incoming call
526 * Must not be called for WAITING calls.
527 * switchWaitingOrHoldingAndActive() must be used in this case
528 * instead
529 *
Sanket Padawe76372492016-10-27 13:20:49 -0700530 * @param serial Serial number of request.
531 *
532 * Response function is IRadioResponse.acceptCallResponse()
533 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700534 oneway acceptCall(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700535
Andreas Huber675ae492017-03-28 14:40:58 -0700536 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700537 * Deactivate packet data connection and remove from the
538 * data call list if RadioError:NONE is returned. Any other return
539 * values must also try to remove the call from the list. An
540 * unsolDataCallListChanged must be
541 * issued because of an deactivateDataCall.
542 *
Sanket Padawe76372492016-10-27 13:20:49 -0700543 * @param serial Serial number of request.
544 * @param cid Indicates CID
545 * @param reasonRadioShutDown Indicates Disconnect Reason
546 * false => No specific reason specified
547 * true => Radio shutdown requested
548 *
549 * Response function is IRadioResponse.deactivateDataCallResponse()
550 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700551 oneway deactivateDataCall(int32_t serial, int32_t cid,
Sanket Padawe76372492016-10-27 13:20:49 -0700552 bool reasonRadioShutDown);
553
Andreas Huber675ae492017-03-28 14:40:58 -0700554 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700555 * Query the status of a facility lock state
556 *
Sanket Padawe76372492016-10-27 13:20:49 -0700557 * @param serial Serial number of request.
558 * @param facility is the facility string code from TS 27.007 7.4
559 * (eg "AO" for BAOC, "SC" for SIM lock)
560 * @param password is the password, or "" if not required
561 * @param serviceClass is the TS 27.007 service class bit vector of services to query
562 * @param appId is AID value, See ETSI 102.221 8.1 and 101.220 4, empty string if no value.
563 * This is only applicable in the case of Fixed Dialing Numbers (FDN) requests.
564 *
565 * Response function is IRadioResponse.getFacilityLockForAppResponse()
566 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700567 oneway getFacilityLockForApp(int32_t serial, string facility,
Sanket Padawe76372492016-10-27 13:20:49 -0700568 string password, int32_t serviceClass, string appId);
569
Andreas Huber675ae492017-03-28 14:40:58 -0700570 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700571 * Enable/disable one facility lock
572 *
Sanket Padawe76372492016-10-27 13:20:49 -0700573 * @param serial Serial number of request.
574 * @param facility is the facility string code from TS 27.007 7.4 (eg "AO" for BAOC)
575 * @param lockState false for "unlock" and true for "lock"
576 * @param password is the password
577 * @param serviceClass is string representation of decimal TS 27.007
578 * service class bit vector. Eg, the string
579 * "1" means "set this facility for voice services"
580 * @param appId is AID value, See ETSI 102.221 8.1 and 101.220 4, empty string if no value.
581 * This is only applicable in the case of Fixed Dialing Numbers (FDN) requests.
582 *
583 * Response function is IRadioResponse.setFacilityLockForAppResponse()
584 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700585 oneway setFacilityLockForApp(int32_t serial, string facility, bool lockState,
Sanket Padawe76372492016-10-27 13:20:49 -0700586 string password, int32_t serviceClass, string appId);
587
Andreas Huber675ae492017-03-28 14:40:58 -0700588 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700589 * Change call barring facility password
590 *
Sanket Padawe76372492016-10-27 13:20:49 -0700591 * @param serial Serial number of request.
592 * @param facility facility string code from TS 27.007 7.4 (eg "AO" for BAOC)
593 * @param oldPassword old password
594 * @param newPassword new password
595 *
596 * Response function is IRadioResponse.setBarringPasswordResponse()
597 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700598 oneway setBarringPassword(int32_t serial, string facility,
Sanket Padawe76372492016-10-27 13:20:49 -0700599 string oldPassword, string newPassword);
600
Andreas Huber675ae492017-03-28 14:40:58 -0700601 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700602 * Query current network selection mode
603 *
Sanket Padawe76372492016-10-27 13:20:49 -0700604 * @param serial Serial number of request.
605 *
606 * Response function is IRadioResponse.getNetworkSelectionModeResponse()
607 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700608 oneway getNetworkSelectionMode(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700609
Andreas Huber675ae492017-03-28 14:40:58 -0700610 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700611 * Specify that the network must be selected automatically.
612 * This request must not respond until the new operator is selected and registered.
613 *
Sanket Padawe76372492016-10-27 13:20:49 -0700614 * @param serial Serial number of request.
615 *
616 * Response function is IRadioResponse.setNetworkSelectionModeAutomaticResponse()
617 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700618 oneway setNetworkSelectionModeAutomatic(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700619
Andreas Huber675ae492017-03-28 14:40:58 -0700620 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700621 * Manually select a specified network.
622 * This request must not respond until the new operator is selected and registered.
623 *
Sanket Padawe76372492016-10-27 13:20:49 -0700624 * @param serial Serial number of request.
625 * @param operatorNumeric string specifying MCCMNC of network to select (eg "310170")
626 *
627 * Response function is IRadioResponse.setNetworkSelectionModeManualResponse()
628 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700629 oneway setNetworkSelectionModeManual(int32_t serial, string operatorNumeric);
Sanket Padawe76372492016-10-27 13:20:49 -0700630
Andreas Huber675ae492017-03-28 14:40:58 -0700631 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700632 * Scans for available networks
Sanket Padawe76372492016-10-27 13:20:49 -0700633 *
Sanket Padawe76372492016-10-27 13:20:49 -0700634 * @param serial Serial number of request.
635 *
636 * Response function is IRadioResponse.getAvailableNetworksResponse()
637 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700638 oneway getAvailableNetworks(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700639
Andreas Huber675ae492017-03-28 14:40:58 -0700640 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700641 * Start playing a DTMF tone. Continue playing DTMF tone until
642 * stopDtmf is received.
643 * If a startDtmf() is received while a tone is currently playing,
644 * it must cancel the previous tone and play the new one.
645 *
Sanket Padawe76372492016-10-27 13:20:49 -0700646 * @param serial Serial number of request.
647 * @param s string having a single character with one of 12 values: 0-9,*,#
648 *
649 * Response function is IRadioResponse.startDtmfResponse()
650 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700651 oneway startDtmf(int32_t serial, string s);
Sanket Padawe76372492016-10-27 13:20:49 -0700652
Andreas Huber675ae492017-03-28 14:40:58 -0700653 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700654 * Stop playing a currently playing DTMF tone.
655 *
Sanket Padawe76372492016-10-27 13:20:49 -0700656 * @param serial Serial number of request.
657 *
658 * Response function is IRadioResponse.stopDtmfResponse()
659 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700660 oneway stopDtmf(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700661
Andreas Huber675ae492017-03-28 14:40:58 -0700662 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700663 * Return string value indicating baseband version, eg response from AT+CGMR
664 *
Sanket Padawe76372492016-10-27 13:20:49 -0700665 * @param serial Serial number of request.
666 *
667 * Response function is IRadioResponse.getBasebandVersionResponse()
668 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700669 oneway getBasebandVersion(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700670
Andreas Huber675ae492017-03-28 14:40:58 -0700671 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700672 * Separate a party from a multiparty call placing the multiparty call
673 * (less the specified party) on hold and leaving the specified party
674 * as the only other member of the current (active) call
675 *
676 * Like AT+CHLD=2x
677 *
678 * See TS 22.084 1.3.8.2 (iii)
679 * TS 22.030 6.5.5 "Entering "2X followed by send"
680 * TS 27.007 "AT+CHLD=2x"
681 *
Sanket Padawe76372492016-10-27 13:20:49 -0700682 * @param serial Serial number of request.
683 * @param gsmIndex contains Connection index (value of 'x' in CHLD above)
684 *
685 * Response function is IRadioResponse.separateConnectionResponse()
686 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700687 oneway separateConnection(int32_t serial, int32_t gsmIndex);
Sanket Padawe76372492016-10-27 13:20:49 -0700688
Andreas Huber675ae492017-03-28 14:40:58 -0700689 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700690 * Turn on or off uplink (microphone) mute.
691 * Must only be sent while voice call is active.
692 * Must always be reset to "disable mute" when a new voice call is initiated
693 *
Sanket Padawe76372492016-10-27 13:20:49 -0700694 * @param serial Serial number of request.
695 * @param enable true for "enable mute" and false for "disable mute"
696 *
697 * Response function is IRadioResponse.setMuteResponse()
698 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700699 oneway setMute(int32_t serial, bool enable);
Sanket Padawe76372492016-10-27 13:20:49 -0700700
Andreas Huber675ae492017-03-28 14:40:58 -0700701 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700702 * Queries the current state of the uplink mute setting
703 *
Sanket Padawe76372492016-10-27 13:20:49 -0700704 * @param serial Serial number of request.
705 *
706 * Response function is IRadioResponse.getMuteResponse()
707 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700708 oneway getMute(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700709
Andreas Huber675ae492017-03-28 14:40:58 -0700710 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700711 * Queries the status of the CLIP supplementary service
712 * (for MMI code "*#30#")
713 *
Sanket Padawe76372492016-10-27 13:20:49 -0700714 * @param serial Serial number of request.
715 *
716 * Response function is IRadioResponse.getClipResponse()
717 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700718 oneway getClip(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700719
Andreas Huber675ae492017-03-28 14:40:58 -0700720 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700721 * Returns the data call list. An entry is added when a
722 * setupDataCall() is issued and removed on a
723 * deactivateDataCall(). The list is emptied when
724 * setRadioPower() off/on is issued.
725 *
Sanket Padawe76372492016-10-27 13:20:49 -0700726 * @param serial Serial number of request.
727 *
728 * Response function is IRadioResponse.getDataCallListResponse()
729 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700730 oneway getDataCallList(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700731
Andreas Huber675ae492017-03-28 14:40:58 -0700732 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700733 * Enables/disables supplementary service related notifications from the network.
734 * Notifications are reported via unsolSuppSvcNotification().
735 *
Sanket Padawe76372492016-10-27 13:20:49 -0700736 * @param serial Serial number of request.
737 * @param enable true = notifications enabled, false = notifications disabled.
738 *
739 * Response function is IRadioResponse.setSuppServiceNotificationsResponse()
740 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700741 oneway setSuppServiceNotifications(int32_t serial, bool enable);
Sanket Padawe76372492016-10-27 13:20:49 -0700742
Andreas Huber675ae492017-03-28 14:40:58 -0700743 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700744 * Stores a SMS message to SIM memory.
745 *
Sanket Padawe76372492016-10-27 13:20:49 -0700746 * @param serial Serial number of request.
747 * @param smsWriteArgs SmsWriteArgs defined in types.hal
748 *
749 * Response function is IRadioResponse.writeSmsToSimResponse()
750 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700751 oneway writeSmsToSim(int32_t serial, SmsWriteArgs smsWriteArgs);
Sanket Padawe76372492016-10-27 13:20:49 -0700752
Andreas Huber675ae492017-03-28 14:40:58 -0700753 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700754 * Deletes a SMS message from SIM memory.
755 *
Sanket Padawe76372492016-10-27 13:20:49 -0700756 * @param serial Serial number of request.
757 * @param index Record index of the message to delete.
758 *
759 * Response function is IRadioResponse.deleteSmsOnSimResponse()
760 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700761 oneway deleteSmsOnSim(int32_t serial, int32_t index);
Sanket Padawe76372492016-10-27 13:20:49 -0700762
Andreas Huber675ae492017-03-28 14:40:58 -0700763 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700764 * Assign a specified band for RF configuration.
765 *
Sanket Padawe76372492016-10-27 13:20:49 -0700766 * @param serial Serial number of request.
767 * @param mode RadioBandMode defined in types.hal
768 *
769 * Response function is IRadioResponse.setBandModeResponse()
770 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700771 oneway setBandMode(int32_t serial, RadioBandMode mode);
Sanket Padawe76372492016-10-27 13:20:49 -0700772
Andreas Huber675ae492017-03-28 14:40:58 -0700773 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700774 * Get the list of band modes supported by RF.
775 *
Sanket Padawe76372492016-10-27 13:20:49 -0700776 * @param serial Serial number of request.
777 *
778 * Response function is IRadioResponse.getAvailableBandModesResponse()
779 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700780 oneway getAvailableBandModes(int32_t serial);
Sanket Padawe76372492016-10-27 13:20:49 -0700781
Andreas Huber675ae492017-03-28 14:40:58 -0700782 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700783 * Requests to send a SAT/USAT envelope command to SIM.
784 * The SAT/USAT envelope command refers to 3GPP TS 11.14 and 3GPP TS 31.111
785 *
Sanket Padawe76372492016-10-27 13:20:49 -0700786 * @param serial Serial number of request.
787 * @param command SAT/USAT command in hexadecimal format string starting with command tag
788 *
789 * Response function is IRadioResponse.sendEnvelopeResponse()
790 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700791 oneway sendEnvelope(int32_t serial, string command);
Sanket Padawe76372492016-10-27 13:20:49 -0700792
Andreas Huber675ae492017-03-28 14:40:58 -0700793 /**
Sanket Padawe76372492016-10-27 13:20:49 -0700794 * Requests to send a terminal response to SIM for a received proactive command
795 *
Sanket Padawe76372492016-10-27 13:20:49 -0700796 * @param serial Serial number of request.
797 * @param commandResponse SAT/USAT response in hexadecimal format string starting with
798 * first byte of response data
799 *
800 * Response function is IRadioResponse.sendTerminalResponseResponseToSim()
801 */
Sanket Padawed52335c2016-11-03 16:46:32 -0700802 oneway sendTerminalResponseToSim(int32_t serial, string commandResponse);
803
Andreas Huber675ae492017-03-28 14:40:58 -0700804 /**
Sanket Padawed52335c2016-11-03 16:46:32 -0700805 * When STK application gets stkCallSetup(), the call actually has
806 * been initialized by mobile device already. (We could see the call has been in the 'call
807 * list') So, STK application needs to accept/reject the call according to user
808 * operations.
809 *
810 * @param serial Serial number of request.
811 * @param accept true = accept the call setup, false = reject the call setup
812 *
Jack Yued7ef812017-01-24 11:56:52 -0800813 * Response callback is IRadioResponse.handleStkCallSetupRequestFromSimResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -0700814 */
815 oneway handleStkCallSetupRequestFromSim(int32_t serial,
816 bool accept);
817
Andreas Huber675ae492017-03-28 14:40:58 -0700818 /**
Sanket Padawed52335c2016-11-03 16:46:32 -0700819 * Connects the two calls and disconnects the subscriber from both calls.
820 *
821 * @param serial Serial number of request.
822 *
Jack Yued7ef812017-01-24 11:56:52 -0800823 * Response callback is IRadioResponse.explicitCallTransferResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -0700824 */
825 oneway explicitCallTransfer(int32_t serial);
826
Andreas Huber675ae492017-03-28 14:40:58 -0700827 /**
Sanket Padawed52335c2016-11-03 16:46:32 -0700828 * Requests to set the preferred network type for searching and registering
829 * (CS/PS domain, RAT, and operation mode)
830 *
831 * @param serial Serial number of request.
832 * @param nwType PreferredNetworkType defined in types.hal
833 *
Jack Yued7ef812017-01-24 11:56:52 -0800834 * Response callback is IRadioResponse.setPreferredNetworkTypeResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -0700835 */
836 oneway setPreferredNetworkType(int32_t serial,
837 PreferredNetworkType nwType);
838
Andreas Huber675ae492017-03-28 14:40:58 -0700839 /**
Sanket Padawed52335c2016-11-03 16:46:32 -0700840 * Query the preferred network type (CS/PS domain, RAT, and operation mode)
841 * for searching and registering
842 *
843 * @param serial Serial number of request.
844 *
Jack Yued7ef812017-01-24 11:56:52 -0800845 * Response callback is IRadioResponse.getPreferredNetworkTypeResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -0700846 */
847 oneway getPreferredNetworkType(int32_t serial);
848
Andreas Huber675ae492017-03-28 14:40:58 -0700849 /**
Sanket Padawed52335c2016-11-03 16:46:32 -0700850 * Request neighboring cell id in GSM network
851 *
852 * @param serial Serial number of request.
853 *
Jack Yued7ef812017-01-24 11:56:52 -0800854 * Response callback is IRadioResponse.getNeighboringCidsResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -0700855 */
856 oneway getNeighboringCids(int32_t serial);
857
Andreas Huber675ae492017-03-28 14:40:58 -0700858 /**
Sanket Padawed52335c2016-11-03 16:46:32 -0700859 * Enables/disables network state change notifications due to changes in
860 * LAC and/or CID (for GSM) or BID/SID/NID/latitude/longitude (for CDMA).
861 * Basically +CREG=2 vs. +CREG=1 (TS 27.007).
862 * Note: The Radio implementation must default to "updates enabled"
863 * when the screen is on and "updates disabled" when the screen is off.
864 *
865 * @param serial Serial number of request.
866 * @param enable true = updates enabled (+CREG=2), false = updates disabled (+CREG=1)
867 *
Jack Yued7ef812017-01-24 11:56:52 -0800868 * Response callback is IRadioResponse.setLocationUpdatesResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -0700869 */
870 oneway setLocationUpdates(int32_t serial, bool enable);
871
Andreas Huber675ae492017-03-28 14:40:58 -0700872 /**
Sanket Padawed52335c2016-11-03 16:46:32 -0700873 * Request to set the location where the CDMA subscription shall
874 * be retrieved
875 *
876 * @param serial Serial number of request.
877 * @param cdmaSub CdmaSubscriptionSource
878 *
Jack Yued7ef812017-01-24 11:56:52 -0800879 * Response callback is IRadioResponse.setCdmaSubscriptionSourceResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -0700880 */
881 oneway setCdmaSubscriptionSource(int32_t serial,
882 CdmaSubscriptionSource cdmaSub);
883
Andreas Huber675ae492017-03-28 14:40:58 -0700884 /**
Sanket Padawed52335c2016-11-03 16:46:32 -0700885 * Request to set the roaming preferences in CDMA
886 *
887 * @param serial Serial number of request.
888 * @param type CdmaRoamingType defined in types.hal
889 *
Jack Yued7ef812017-01-24 11:56:52 -0800890 * Response callback is IRadioResponse.setCdmaRoamingPreferenceResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -0700891 */
892 oneway setCdmaRoamingPreference(int32_t serial,
893 CdmaRoamingType type);
894
Andreas Huber675ae492017-03-28 14:40:58 -0700895 /**
Sanket Padawed52335c2016-11-03 16:46:32 -0700896 * Request the actual setting of the roaming preferences in CDMA in the modem
897 *
898 * @param serial Serial number of request.
899 *
Jack Yued7ef812017-01-24 11:56:52 -0800900 * Response callback is IRadioResponse.getCdmaRoamingPreferenceResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -0700901 */
902 oneway getCdmaRoamingPreference(int32_t serial);
903
Andreas Huber675ae492017-03-28 14:40:58 -0700904 /**
Sanket Padawed52335c2016-11-03 16:46:32 -0700905 * Request to set the TTY mode
906 *
907 * @param serial Serial number of request.
908 * @param mode TtyMode
909 *
Jack Yued7ef812017-01-24 11:56:52 -0800910 * Response callback is IRadioResponse.setTTYModeResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -0700911 */
912 oneway setTTYMode(int32_t serial, TtyMode mode);
913
Andreas Huber675ae492017-03-28 14:40:58 -0700914 /**
Sanket Padawed52335c2016-11-03 16:46:32 -0700915 * Request the setting of TTY mode
916 *
917 * @param serial Serial number of request.
918 *
Jack Yued7ef812017-01-24 11:56:52 -0800919 * Response callback is IRadioResponse.getTTYModeResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -0700920 */
921 oneway getTTYMode(int32_t serial);
922
Andreas Huber675ae492017-03-28 14:40:58 -0700923 /**
Sanket Padawed52335c2016-11-03 16:46:32 -0700924 * Request to set the preferred voice privacy mode used in voice scrambling.
925 *
926 * @param serial Serial number of request.
927 * @param enable false for Standard Privacy Mode (Public Long Code Mask)
928 * true for Enhanced Privacy Mode (Private Long Code Mask)
929 *
Jack Yued7ef812017-01-24 11:56:52 -0800930 * Response callback is IRadioResponse.setPreferredVoicePrivacyResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -0700931 */
932 oneway setPreferredVoicePrivacy(int32_t serial, bool enable);
933
Andreas Huber675ae492017-03-28 14:40:58 -0700934 /**
Sanket Padawed52335c2016-11-03 16:46:32 -0700935 * Request the setting of preferred voice privacy mode.
936 *
937 * @param serial Serial number of request.
938 *
Jack Yued7ef812017-01-24 11:56:52 -0800939 * Response callback is IRadioResponse.getPreferredVoicePrivacyResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -0700940 */
941 oneway getPreferredVoicePrivacy(int32_t serial);
942
Andreas Huber675ae492017-03-28 14:40:58 -0700943 /**
Sanket Padawed52335c2016-11-03 16:46:32 -0700944 * Send FLASH command
945 *
946 * @param serial Serial number of request.
947 * @param featureCode String associated with Flash command
948 *
Jack Yued7ef812017-01-24 11:56:52 -0800949 * Response callback is IRadioResponse.sendCDMAFeatureCodeResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -0700950 */
951 oneway sendCDMAFeatureCode(int32_t serial, string featureCode);
952
Andreas Huber675ae492017-03-28 14:40:58 -0700953 /**
Sanket Padawed52335c2016-11-03 16:46:32 -0700954 * Send DTMF string
955 *
956 * @param serial Serial number of request.
957 * @param dtmf DTMF string
958 * @param on DTMF ON length in milliseconds, or 0 to use default
959 * @param off is the DTMF OFF length in milliseconds, or 0 to use default
960 *
Jack Yued7ef812017-01-24 11:56:52 -0800961 * Response callback is IRadioResponse.sendBurstDtmfResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -0700962 */
963 oneway sendBurstDtmf(int32_t serial, string dtmf, int32_t on, int32_t off);
964
Andreas Huber675ae492017-03-28 14:40:58 -0700965 /**
Sanket Padawed52335c2016-11-03 16:46:32 -0700966 * Send a CDMA SMS message
967 *
968 * @param serial Serial number of request.
969 * @param sms Cdma Sms to be sent described by CdmaSmsMessage in types.hal
970 *
Jack Yued7ef812017-01-24 11:56:52 -0800971 * Response callback is IRadioResponse.sendCdmaSmsResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -0700972 */
973 oneway sendCdmaSms(int32_t serial, CdmaSmsMessage sms);
974
Andreas Huber675ae492017-03-28 14:40:58 -0700975 /**
Sanket Padawed52335c2016-11-03 16:46:32 -0700976 * Acknowledge the success or failure in the receipt of SMS
977 * previously indicated via responseCdmaNewSms()
978 *
979 * @param serial Serial number of request.
980 * @param smsAck Cdma Sms ack to be sent described by CdmaSmsAck in types.hal
981 *
Jack Yued7ef812017-01-24 11:56:52 -0800982 * Response callback is IRadioResponse.acknowledgeLastIncomingCdmaSmsResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -0700983 */
984 oneway acknowledgeLastIncomingCdmaSms(int32_t serial, CdmaSmsAck smsAck);
985
Andreas Huber675ae492017-03-28 14:40:58 -0700986 /**
Sanket Padawed52335c2016-11-03 16:46:32 -0700987 * Request the setting of GSM/WCDMA Cell Broadcast SMS config.
988 *
989 * @param serial Serial number of request.
990 *
Jack Yued7ef812017-01-24 11:56:52 -0800991 * Response callback is IRadioResponse.getGsmBroadcastConfigResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -0700992 */
993 oneway getGsmBroadcastConfig(int32_t serial);
994
Andreas Huber675ae492017-03-28 14:40:58 -0700995 /**
Sanket Padawed52335c2016-11-03 16:46:32 -0700996 * Set GSM/WCDMA Cell Broadcast SMS config
997 *
998 * @param serial Serial number of request.
999 * @param configInfo Setting of GSM/WCDMA Cell broadcast config
1000 *
Jack Yued7ef812017-01-24 11:56:52 -08001001 * Response callback is IRadioResponse.setGsmBroadcastConfigResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001002 */
Sanket Padawe865834e2016-12-28 16:04:10 -08001003 oneway setGsmBroadcastConfig(int32_t serial, vec<GsmBroadcastSmsConfigInfo> configInfo);
Sanket Padawed52335c2016-11-03 16:46:32 -07001004
Andreas Huber675ae492017-03-28 14:40:58 -07001005 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001006 * Enable or disable the reception of GSM/WCDMA Cell Broadcast SMS
1007 *
1008 * @param serial Serial number of request.
1009 * @param activate indicates to activate or turn off the reception of GSM/WCDMA
1010 * Cell Broadcast SMS. true = activate, false = turn off
1011 *
Jack Yued7ef812017-01-24 11:56:52 -08001012 * Response callback is IRadioResponse.setGsmBroadcastActivationResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001013 */
1014 oneway setGsmBroadcastActivation(int32_t serial, bool activate);
1015
Andreas Huber675ae492017-03-28 14:40:58 -07001016 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001017 * Request the setting of CDMA Broadcast SMS config
1018 *
1019 * @param serial Serial number of request.
1020 *
Jack Yued7ef812017-01-24 11:56:52 -08001021 * Response callback is IRadioResponse.getCdmaBroadcastConfigResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001022 */
1023 oneway getCdmaBroadcastConfig(int32_t serial);
1024
Andreas Huber675ae492017-03-28 14:40:58 -07001025 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001026 * Set CDMA Broadcast SMS config
1027 *
1028 * @param serial Serial number of request.
1029 * @param configInfo CDMA Broadcast SMS config to be set.
1030 *
Jack Yued7ef812017-01-24 11:56:52 -08001031 * Response callback is IRadioResponse.setCdmaBroadcastConfigResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001032 */
Sanket Padawe865834e2016-12-28 16:04:10 -08001033 oneway setCdmaBroadcastConfig(int32_t serial, vec<CdmaBroadcastSmsConfigInfo> configInfo);
Sanket Padawed52335c2016-11-03 16:46:32 -07001034
Andreas Huber675ae492017-03-28 14:40:58 -07001035 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001036 * Enable or disable the reception of CDMA Cell Broadcast SMS
1037 *
1038 * @param serial Serial number of request.
1039 * @param activate indicates to activate or turn off the reception of CDMA
1040 * Cell Broadcast SMS. true = activate, false = turn off
1041 *
Jack Yued7ef812017-01-24 11:56:52 -08001042 * Response callback is IRadioResponse.setCdmaBroadcastActivationResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001043 */
1044 oneway setCdmaBroadcastActivation(int32_t serial, bool activate);
1045
Andreas Huber675ae492017-03-28 14:40:58 -07001046 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001047 * Request the device MDN / H_SID / H_NID.
1048 * The request is only allowed when CDMA subscription is available. When CDMA
1049 * subscription is changed, application layer must re-issue the request to
1050 * update the subscription information.
1051 *
1052 * @param serial Serial number of request.
1053 *
Jack Yued7ef812017-01-24 11:56:52 -08001054 * Response callback is IRadioResponse.getCDMASubscriptionResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001055 */
1056 oneway getCDMASubscription(int32_t serial);
1057
Andreas Huber675ae492017-03-28 14:40:58 -07001058 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001059 * Stores a CDMA SMS message to RUIM memory.
1060 *
1061 * @param serial Serial number of request.
1062 * @param cdmaSms CDMA message as defined by CdmaSmsWriteArgs in types.hal
1063 *
Jack Yued7ef812017-01-24 11:56:52 -08001064 * Response callback is IRadioResponse.writeSmsToRuimResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001065 */
1066 oneway writeSmsToRuim(int32_t serial, CdmaSmsWriteArgs cdmaSms);
1067
Andreas Huber675ae492017-03-28 14:40:58 -07001068 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001069 * Deletes a CDMA SMS message from RUIM memory.
1070 *
1071 * @param serial Serial number of request.
1072 * @param index record index of the message to delete
1073 *
Jack Yued7ef812017-01-24 11:56:52 -08001074 * Response callback is IRadioResponse.deleteSmsOnRuimResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001075 */
1076 oneway deleteSmsOnRuim(int32_t serial, int32_t index);
1077
Andreas Huber675ae492017-03-28 14:40:58 -07001078 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001079 * Request the device ESN / MEID / IMEI / IMEISV.
1080 * The request is always allowed and contains GSM and CDMA device identity.
1081 * When CDMA subscription is changed the ESN/MEID changes. The application
1082 * layer must re-issue the request to update the device identity in this case.
1083 *
1084 * @param serial Serial number of request.
1085 *
Jack Yued7ef812017-01-24 11:56:52 -08001086 * Response callback is IRadioResponse.getDeviceIdentityResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001087 */
1088 oneway getDeviceIdentity(int32_t serial);
1089
Andreas Huber675ae492017-03-28 14:40:58 -07001090 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001091 * Request the radio's system selection module to exit emergency
1092 * callback mode. Radio must not respond with SUCCESS until the modem has
1093 * completely exited from Emergency Callback Mode.
1094 *
1095 * @param serial Serial number of request.
1096 *
Jack Yued7ef812017-01-24 11:56:52 -08001097 * Response callback is IRadioResponse.exitEmergencyCallbackModeResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001098 */
1099 oneway exitEmergencyCallbackMode(int32_t serial);
1100
Andreas Huber675ae492017-03-28 14:40:58 -07001101 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001102 * Get the default Short Message Service Center address on the device.
1103 *
1104 * @param serial Serial number of request.
1105 *
Jack Yued7ef812017-01-24 11:56:52 -08001106 * Response callback is IRadioResponse.getSmscAddressResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001107 */
1108 oneway getSmscAddress(int32_t serial);
1109
Andreas Huber675ae492017-03-28 14:40:58 -07001110 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001111 * Set the default Short Message Service Center address on the device.
1112 *
1113 * @param serial Serial number of request.
1114 * @param smsc Short Message Service Center address to set
1115 *
Jack Yued7ef812017-01-24 11:56:52 -08001116 * Response callback is IRadioResponse.setSmscAddressResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001117 */
1118 oneway setSmscAddress(int32_t serial, string smsc);
1119
Andreas Huber675ae492017-03-28 14:40:58 -07001120 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001121 * Indicates whether there is storage available for new SMS messages.
1122 *
1123 * @param serial Serial number of request.
1124 * @param available true if memory is available for storing new messages,
1125 * false if memory capacity is exceeded
1126 *
Jack Yued7ef812017-01-24 11:56:52 -08001127 * Response callback is IRadioResponse.reportSmsMemoryStatusResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001128 */
1129 oneway reportSmsMemoryStatus(int32_t serial, bool available);
1130
Andreas Huber675ae492017-03-28 14:40:58 -07001131 /**
Jack Yu439a6e72017-02-23 12:40:56 -08001132 * Indicates that the StkService is running and is
Sanket Padawed52335c2016-11-03 16:46:32 -07001133 * ready to receive unsolicited stkXXXXX commands.
1134 *
1135 * @param serial Serial number of request.
1136 *
Jack Yued7ef812017-01-24 11:56:52 -08001137 * Response callback is IRadioResponse.reportStkServiceIsRunningResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001138 */
1139 oneway reportStkServiceIsRunning(int32_t serial);
1140
Andreas Huber675ae492017-03-28 14:40:58 -07001141 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001142 * Request to query the location where the CDMA subscription shall be retrieved.
1143 *
1144 * @param serial Serial number of request.
1145 *
Jack Yued7ef812017-01-24 11:56:52 -08001146 * Response callback is IRadioResponse.getCdmaSubscriptionSourceResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001147 */
1148 oneway getCdmaSubscriptionSource(int32_t serial);
1149
Andreas Huber675ae492017-03-28 14:40:58 -07001150 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001151 * Request the ISIM application on the UICC to perform AKA
1152 * challenge/response algorithm for IMS authentication
1153 *
1154 * @param serial Serial number of request.
1155 * @param challenge challenge string in Base64 format
1156 *
Jack Yued7ef812017-01-24 11:56:52 -08001157 * Response callback is IRadioResponse.requestIsimAuthenticationResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001158 */
1159 oneway requestIsimAuthentication(int32_t serial, string challenge);
1160
Andreas Huber675ae492017-03-28 14:40:58 -07001161 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001162 * Acknowledge successful or failed receipt of SMS previously indicated
1163 * via unsol responseNewSms(), including acknowledgement TPDU to send
1164 * as the RP-User-Data element of the RP-ACK or RP-ERROR PDU.
1165 *
1166 * @param serial Serial number of request.
1167 * @param success true on successful receipt (send RP-ACK)
1168 * false on failed receipt (send RP-ERROR)
1169 * @param ackPdu acknowledgement TPDU in hexadecimal format
1170 *
Jack Yued7ef812017-01-24 11:56:52 -08001171 * Response callback is IRadioResponse.acknowledgeIncomingGsmSmsWithPduResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001172 */
1173 oneway acknowledgeIncomingGsmSmsWithPdu(int32_t serial, bool success, string ackPdu);
1174
Andreas Huber675ae492017-03-28 14:40:58 -07001175 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001176 * Requests to send a SAT/USAT envelope command to SIM.
1177 * The SAT/USAT envelope command refers to 3GPP TS 11.14 and 3GPP TS 31.111.
1178 *
1179 * This request has one difference from sendEnvelope():
1180 * the SW1 and SW2 status bytes from the UICC response are returned along with
1181 * the response data, using the same structure as iccIOForApp().
1182 *
1183 * The implementation must perform normal processing of a '91XX'
1184 * response in SW1/SW2 to retrieve the pending proactive command and send it
1185 * as an unsolicited response, as sendEnvelope() does.
1186 *
1187 * @param serial Serial number of request.
1188 * @param contents SAT/USAT command in hexadecimal format starting with command tag
1189 *
Jack Yued7ef812017-01-24 11:56:52 -08001190 * Response callback is IRadioResponse.sendEnvelopeWithStatusResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001191 */
1192 oneway sendEnvelopeWithStatus(int32_t serial, string contents);
1193
Andreas Huber675ae492017-03-28 14:40:58 -07001194 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001195 * Query the radio technology type (3GPP/3GPP2) used for voice. Query is valid only
1196 * when radio state is not RADIO_STATE_UNAVAILABLE
1197 *
1198 * @param serial Serial number of request.
1199 *
Jack Yued7ef812017-01-24 11:56:52 -08001200 * Response callback is IRadioResponse.getVoiceRadioTechnologyResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001201 */
1202 oneway getVoiceRadioTechnology(int32_t serial);
1203
Andreas Huber675ae492017-03-28 14:40:58 -07001204 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001205 * Request all of the current cell information known to the radio. The radio
1206 * must return list of all current cells, including the neighboring cells. If for a particular
1207 * cell information isn't known then the appropriate unknown value will be returned.
1208 * This does not cause or change the rate of unsolicited cellInfoList().
1209 *
1210 * @param serial Serial number of request.
1211 *
Jack Yued7ef812017-01-24 11:56:52 -08001212 * Response callback is IRadioResponse.getCellInfoListResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001213 */
1214 oneway getCellInfoList(int32_t serial);
1215
Andreas Huber675ae492017-03-28 14:40:58 -07001216 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001217 * Sets the minimum time between when unsolicited cellInfoList() must be invoked.
1218 * A value of 0, means invoke cellInfoList() when any of the reported
1219 * information changes. Setting the value to INT_MAX(0x7fffffff) means never issue
1220 * a unsolicited cellInfoList().
1221 *
1222 * @param serial Serial number of request.
1223 * @param rate minimum time in milliseconds to indicate time between unsolicited cellInfoList()
1224 *
Jack Yued7ef812017-01-24 11:56:52 -08001225 * Response callback is IRadioResponse.setCellInfoListRateResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001226 */
1227 oneway setCellInfoListRate(int32_t serial, int32_t rate);
1228
Andreas Huber675ae492017-03-28 14:40:58 -07001229 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001230 * Set an apn to initial attach network
1231 *
1232 * @param serial Serial number of request.
Jack Yued7ef812017-01-24 11:56:52 -08001233 * @param dataProfileInfo data profile containing APN settings
Jack Yu439a6e72017-02-23 12:40:56 -08001234 * @param modemCognitive indicating the data profile was sent to the modem through
1235 * setDataProfile earlier.
1236 * @param isRoaming Indicating the device is roaming or not. The 'protocol' parameter in the old
1237 * RIL_InitialAttachApn must be filled accordingly based on the roaming
1238 * condition. Note this is for backward compatibility with the old radio modem.
1239 * The modem must not use this param for any other reason.
Sanket Padawed52335c2016-11-03 16:46:32 -07001240 *
Jack Yued7ef812017-01-24 11:56:52 -08001241 * Response callback is IRadioResponse.setInitialAttachApnResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001242 */
Jack Yued7ef812017-01-24 11:56:52 -08001243 oneway setInitialAttachApn(int32_t serial, DataProfileInfo dataProfileInfo,
Jack Yu439a6e72017-02-23 12:40:56 -08001244 bool modemCognitive, bool isRoaming);
Sanket Padawed52335c2016-11-03 16:46:32 -07001245
Andreas Huber675ae492017-03-28 14:40:58 -07001246 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001247 * Request current IMS registration state
1248 *
1249 * @param serial Serial number of request.
1250 *
Jack Yued7ef812017-01-24 11:56:52 -08001251 * Response callback is IRadioResponse.getImsRegistrationStateResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001252 */
1253 oneway getImsRegistrationState(int32_t serial);
1254
Andreas Huber675ae492017-03-28 14:40:58 -07001255 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001256 * Send a SMS message over IMS.
1257 * Based on the return error, caller decides to resend if sending sms
1258 * fails. SMS_SEND_FAIL_RETRY means retry, and other errors means no retry.
1259 * In case of retry, data is encoded based on Voice Technology available.
1260 *
1261 * @param serial Serial number of request.
1262 * @param message ImsSmsMessage as defined in types.hal to be sent
1263 *
Jack Yued7ef812017-01-24 11:56:52 -08001264 * Response callback is IRadioResponse.sendImsSmsResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001265 */
1266 oneway sendImsSms(int32_t serial, ImsSmsMessage message);
1267
Andreas Huber675ae492017-03-28 14:40:58 -07001268 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001269 * Request APDU exchange on the basic channel. This command reflects TS 27.007
1270 * "generic SIM access" operation (+CSIM). The modem must ensure proper function
1271 * of GSM/CDMA, and filter commands appropriately. It must filter
1272 * channel management and SELECT by DF name commands.
1273 * "sessionid" field must be ignored.
1274 *
1275 * @param serial Serial number of request.
1276 * @param message SimApdu as defined in types.hal to be sent
1277 *
Jack Yued7ef812017-01-24 11:56:52 -08001278 * Response callback is IRadioResponse.iccTransmitApduBasicChannelResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001279 */
1280 oneway iccTransmitApduBasicChannel(int32_t serial, SimApdu message);
1281
Andreas Huber675ae492017-03-28 14:40:58 -07001282 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001283 * Open a new logical channel and select the given application. This command
1284 * reflects TS 27.007 "open logical channel" operation (+CCHO).
1285 *
1286 * @param serial Serial number of request.
1287 * @param aid AID value, See ETSI 102.221 and 101.220.
Wileen Chiud87bd022017-03-03 11:57:48 -08001288 * @param p2 P2 value, described in ISO 7816-4. Ignore if equal to P2Constant:NO_P2
Sanket Padawed52335c2016-11-03 16:46:32 -07001289 *
Jack Yued7ef812017-01-24 11:56:52 -08001290 * Response callback is IRadioResponse.iccOpenLogicalChannelResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001291 */
Wileen Chiud87bd022017-03-03 11:57:48 -08001292 oneway iccOpenLogicalChannel(int32_t serial, string aid, int32_t p2);
Sanket Padawed52335c2016-11-03 16:46:32 -07001293
Andreas Huber675ae492017-03-28 14:40:58 -07001294 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001295 * Close a previously opened logical channel. This command reflects TS 27.007
1296 * "close logical channel" operation (+CCHC).
1297 *
1298 * @param serial Serial number of request.
1299 * @param channelId session id of the logical channel (+CCHC).
1300 *
Jack Yued7ef812017-01-24 11:56:52 -08001301 * Response callback is IRadioResponse.iccCloseLogicalChannelResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001302 */
1303 oneway iccCloseLogicalChannel(int32_t serial, int32_t channelId);
1304
Andreas Huber675ae492017-03-28 14:40:58 -07001305 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001306 * Exchange APDUs with a UICC over a previously opened logical channel. This
1307 * command reflects TS 27.007 "generic logical channel access" operation
1308 * (+CGLA). The modem must filter channel management and SELECT by DF name
1309 * commands.
1310 *
1311 * @param serial Serial number of request.
1312 * @param message SimApdu as defined in types.hal to be sent
1313 *
Jack Yued7ef812017-01-24 11:56:52 -08001314 * Response callback is IRadioResponse.iccTransmitApduLogicalChannelResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001315 */
1316 oneway iccTransmitApduLogicalChannel(int32_t serial, SimApdu message);
1317
Andreas Huber675ae492017-03-28 14:40:58 -07001318 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001319 * Read one of the radio NV items.
1320 * This is used for device configuration by some CDMA operators.
1321 *
1322 * @param serial Serial number of request.
1323 * @param itemId NvItem is radio NV item as defined in types.hal
1324 *
Jack Yued7ef812017-01-24 11:56:52 -08001325 * Response callback is IRadioResponse.nvReadItemResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001326 */
1327 oneway nvReadItem(int32_t serial, NvItem itemId);
1328
Andreas Huber675ae492017-03-28 14:40:58 -07001329 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001330 * Write one of the radio NV items.
1331 * This is used for device configuration by some CDMA operators.
1332 *
1333 * @param serial Serial number of request.
1334 * @param item NvWriteItem as defined in types.hal
1335 *
Jack Yued7ef812017-01-24 11:56:52 -08001336 * Response callback is IRadioResponse.nvWriteItemResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001337 */
1338 oneway nvWriteItem(int32_t serial, NvWriteItem item);
1339
Andreas Huber675ae492017-03-28 14:40:58 -07001340 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001341 * Update the CDMA Preferred Roaming List (PRL) in the radio NV storage.
1342 * This is used for device configuration by some CDMA operators.
1343 *
1344 * @param serial Serial number of request.
1345 * @param prl PRL as a byte array
1346 *
Jack Yued7ef812017-01-24 11:56:52 -08001347 * Response callback is IRadioResponse.nvWriteCdmaPrlResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001348 */
1349 oneway nvWriteCdmaPrl(int32_t serial, vec<uint8_t> prl);
1350
Andreas Huber675ae492017-03-28 14:40:58 -07001351 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001352 * Reset the radio NV configuration to the factory state.
1353 * This is used for device configuration by some CDMA operators.
1354 *
1355 * @param serial Serial number of request.
1356 * @param resetType ResetNvType as defined in types.hal
1357 *
Jack Yued7ef812017-01-24 11:56:52 -08001358 * Response callback is IRadioResponse.nvResetConfigResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001359 */
1360 oneway nvResetConfig(int32_t serial, ResetNvType resetType);
1361
Andreas Huber675ae492017-03-28 14:40:58 -07001362 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001363 * Selection/de-selection of a subscription from a SIM card
1364 *
1365 * @param serial Serial number of request.
1366 * @param uiccSub SelectUiccSub as defined in types.hal
1367 *
Jack Yued7ef812017-01-24 11:56:52 -08001368 * Response callback is IRadioResponse.setUiccSubscriptionResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001369 */
1370 oneway setUiccSubscription(int32_t serial, SelectUiccSub uiccSub);
1371
Andreas Huber675ae492017-03-28 14:40:58 -07001372 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001373 * Tells the modem whether data calls are allowed or not
1374 *
1375 * @param serial Serial number of request.
1376 * @param allow true to allow data calls, false to disallow data calls
1377 *
Jack Yued7ef812017-01-24 11:56:52 -08001378 * Response callback is IRadioResponse.setDataAllowedResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001379 */
1380 oneway setDataAllowed(int32_t serial, bool allow);
1381
Andreas Huber675ae492017-03-28 14:40:58 -07001382 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001383 * Request all of the current hardware (modem and sim) associated with Radio.
1384 *
1385 * @param serial Serial number of request.
1386 *
Jack Yued7ef812017-01-24 11:56:52 -08001387 * Response callback is IRadioResponse.getHardwareConfigResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001388 */
1389 oneway getHardwareConfig(int32_t serial);
1390
Andreas Huber675ae492017-03-28 14:40:58 -07001391 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001392 * Returns the response of SIM Authentication through Radio challenge request.
1393 *
1394 * @param serial Serial number of request.
1395 * @param authContext P2 value of authentication command, see P2 parameter in
1396 * 3GPP TS 31.102 7.1.2
1397 * @param authData the challenge string in Base64 format, see 3GPP TS 31.102 7.1.2
1398 * @param aid AID value, See ETSI 102.221 8.1 and 101.220 4, empty string if no value
1399 *
Jack Yued7ef812017-01-24 11:56:52 -08001400 * Response callback is IRadioResponse.requestIccSimAuthenticationResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001401 */
1402 oneway requestIccSimAuthentication(int32_t serial, int32_t authContext, string authData,
1403 string aid);
1404
Andreas Huber675ae492017-03-28 14:40:58 -07001405 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001406 * Set data profile in modem.
1407 * Modem must erase existed profiles from framework, and apply new profiles
1408 *
1409 * @param serial Serial number of request.
1410 * @param profiles Array of DataProfiles to set.
Jack Yu439a6e72017-02-23 12:40:56 -08001411 * @param isRoaming Indicating the device is roaming or not. The 'protocol' parameter in the old
1412 * RIL API RIL_DataProfileInfo must be filled accordingly based on the
1413 * roaming condition. Note this is for backward compatibility with the old
1414 * radio modem. The modem must not use this param for any other reason.
Sanket Padawed52335c2016-11-03 16:46:32 -07001415 *
Jack Yued7ef812017-01-24 11:56:52 -08001416 * Response callback is IRadioResponse.setDataProfileResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001417 */
Jack Yu439a6e72017-02-23 12:40:56 -08001418 oneway setDataProfile(int32_t serial, vec<DataProfileInfo> profiles, bool isRoaming);
Sanket Padawed52335c2016-11-03 16:46:32 -07001419
Andreas Huber675ae492017-03-28 14:40:58 -07001420 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001421 * Device is shutting down. All further commands are ignored
1422 * and RADIO_NOT_AVAILABLE must be returned.
1423 *
1424 * @param serial Serial number of request.
1425 *
Jack Yued7ef812017-01-24 11:56:52 -08001426 * Response callback is IRadioResponse.requestShutdownResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001427 */
1428 oneway requestShutdown(int32_t serial);
1429
Andreas Huber675ae492017-03-28 14:40:58 -07001430 /**
Jack Yu439a6e72017-02-23 12:40:56 -08001431 * Used to get phone radio capability.
Sanket Padawed52335c2016-11-03 16:46:32 -07001432 *
1433 * @param serial Serial number of request.
1434 *
Jack Yued7ef812017-01-24 11:56:52 -08001435 * Response callback is IRadioResponse.getRadioCapabilityResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001436 */
1437 oneway getRadioCapability(int32_t serial);
1438
Andreas Huber675ae492017-03-28 14:40:58 -07001439 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001440 * Used to set the phones radio capability. Be VERY careful
1441 * using this request as it may cause some vendor modems to reset. Because
1442 * of the possible modem reset any radio commands after this one may not be
1443 * processed.
1444 *
1445 * @param serial Serial number of request.
1446 * @param rc RadioCapability structure to be set
1447 *
Jack Yued7ef812017-01-24 11:56:52 -08001448 * Response callback is IRadioResponse.setRadioCapabilityResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001449 */
1450 oneway setRadioCapability(int32_t serial, RadioCapability rc);
1451
Andreas Huber675ae492017-03-28 14:40:58 -07001452 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001453 * Start Link Capacity Estimate (LCE) service if supported by the radio.
1454 *
1455 * @param serial Serial number of request.
1456 * @param reportInterval desired reporting interval (ms).
1457 * @param pullMode LCE service mode. true: PULL; false: PUSH.
1458 *
Jack Yued7ef812017-01-24 11:56:52 -08001459 * Response callback is IRadioResponse.startLceServiceResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001460 */
1461 oneway startLceService(int32_t serial, int32_t reportInterval, bool pullMode);
1462
Andreas Huber675ae492017-03-28 14:40:58 -07001463 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001464 * Stop Link Capacity Estimate (LCE) service, the STOP operation must be
1465 * idempotent for the radio modem.
1466 *
1467 * @param serial Serial number of request.
1468 *
Jack Yued7ef812017-01-24 11:56:52 -08001469 * Response callback is IRadioResponse.stopLceServiceResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001470 */
1471 oneway stopLceService(int32_t serial);
1472
Andreas Huber675ae492017-03-28 14:40:58 -07001473 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001474 * Pull LCE service for capacity information.
1475 *
1476 * @param serial Serial number of request.
1477 *
Jack Yued7ef812017-01-24 11:56:52 -08001478 * Response callback is IRadioResponse.pullLceDataResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001479 */
1480 oneway pullLceData(int32_t serial);
1481
Andreas Huber675ae492017-03-28 14:40:58 -07001482 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001483 * Get modem activity information for power consumption estimation.
1484 * Request clear-on-read statistics information that is used for
1485 * estimating the per-millisecond power consumption of the cellular
1486 * modem.
1487 *
1488 * @param serial Serial number of request.
1489 *
Jack Yued7ef812017-01-24 11:56:52 -08001490 * Response callback is IRadioResponse.getModemActivityInfoResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001491 */
1492 oneway getModemActivityInfo(int32_t serial);
1493
Andreas Huber675ae492017-03-28 14:40:58 -07001494 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001495 * Set carrier restrictions. Expected modem behavior:
1496 * If never receives this command
1497 * - Must allow all carriers
1498 * Receives this command with allAllowed true
1499 * - Must allow all carriers. If a previously allowed SIM is present, modem must not reload
1500 * the SIM. If a previously disallowed SIM is present, reload the SIM and notify Android.
1501 * Receives this command with a list of carriers & allAllowed = false
1502 * - Only allow specified carriers, persist across power cycles and FDR. If a present SIM
1503 * is in the allowed list, modem must not reload the SIM. If a present SIM is *not* in
1504 * the allowed list, modem must detach from the registered network and only keep emergency
1505 * service, and notify Android SIM refresh reset with new SIM state being
1506 * CardState:RESTRICTED. Emergency service must be enabled.
1507 *
1508 * @param serial Serial number of request.
1509 * @param allAllowed true only when all carriers are allowed. Ignore "carriers" struct.
1510 * If false, consider "carriers" struct
1511 * @param carriers CarrierRestrictions consisting allowed and excluded carriers as defined
1512 * in types.hal
1513 *
Jack Yued7ef812017-01-24 11:56:52 -08001514 * Response callback is IRadioResponse.setAllowedCarriersResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001515 */
1516 oneway setAllowedCarriers(int32_t serial, bool allAllowed, CarrierRestrictions carriers);
1517
Andreas Huber675ae492017-03-28 14:40:58 -07001518 /**
Sanket Padawed52335c2016-11-03 16:46:32 -07001519 * Get carrier restrictions.
1520 *
1521 * @param serial Serial number of request.
1522 *
Jack Yued7ef812017-01-24 11:56:52 -08001523 * Response callback is IRadioResponse.getAllowedCarriersResponse()
Sanket Padawed52335c2016-11-03 16:46:32 -07001524 */
1525 oneway getAllowedCarriers(int32_t serial);
Sanket Padawef6e345a2016-11-17 15:28:31 -08001526
Andreas Huber675ae492017-03-28 14:40:58 -07001527 /**
Jack Yued7ef812017-01-24 11:56:52 -08001528 * Send the updated device state.
1529 * This is providing the device state information for the modem to perform power saving
1530 * strategies.
1531 *
1532 * @param serial Serial number of request.
1533 * @param deviceStateType The updated device state type.
1534 * @param state The updated state. See the definition of state at DeviceStateType.
1535 *
1536 * Response callback is IRadioResponse.sendDeviceStateResponse()
1537 */
1538 oneway sendDeviceState(int32_t serial, DeviceStateType deviceStateType, bool state);
1539
Andreas Huber675ae492017-03-28 14:40:58 -07001540 /**
Jack Yued7ef812017-01-24 11:56:52 -08001541 * Set the indication filter.
1542 * This is used to prevent unnecessary application processor wake up for power saving purposes
1543 * by suppressing the indications in certain scenarios.
1544 *
1545 * @param serial Serial number of request.
1546 * @param indicationFilter 32-bit bitmap of IndicationFilter. Bits set to 1 indicate the
1547 * indications are enabled. See IndicationFilter for the definition of each bit.
1548 *
1549 * Response callback is IRadioResponse.setIndicationFilterResponse()
1550 */
1551 oneway setIndicationFilter(int32_t serial, bitfield<IndicationFilter> indicationFilter);
1552
Andreas Huber675ae492017-03-28 14:40:58 -07001553 /**
Jack Yua2118692017-02-15 15:31:34 -08001554 * Set SIM card power state.
1555 * Request is equivalent to inserting or removing the card.
1556 *
1557 * The radio modem must generate IRadioIndication.simStatusChanged() as if the SIM had been
1558 * inserted or removed.
1559 *
1560 * @param serial Serial number of request
1561 * @param powerUp True if powering up the sim card
1562 *
1563 * Response callback is IRadioResponse.setSimCardPowerResponse()
1564 */
1565 oneway setSimCardPower(int32_t serial, bool powerUp);
1566
Andreas Huber675ae492017-03-28 14:40:58 -07001567 /**
Sanket Padawef6e345a2016-11-17 15:28:31 -08001568 * When response type received from a radio indication or radio response is
1569 * RadioIndicationType:UNSOLICITED_ACK_EXP or RadioResponseType:SOLICITED_ACK_EXP respectively,
Jack Yued7ef812017-01-24 11:56:52 -08001570 * acknowledge the receipt of those messages by sending responseAcknowledgement().
Sanket Padawef6e345a2016-11-17 15:28:31 -08001571 *
1572 */
1573 oneway responseAcknowledgement();
Sanket Padawe865834e2016-12-28 16:04:10 -08001574};