Jayachandran C | 262b606 | 2020-07-22 15:53:58 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2020 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 | package android.hardware.radio@1.6; |
| 18 | |
allenwtsu | 1c3dcd3 | 2020-09-25 17:58:01 +0800 | [diff] [blame] | 19 | |
| 20 | import @1.0::CdmaSmsMessage; |
Shuo Qian | 3f86533 | 2021-02-02 00:05:42 +0000 | [diff] [blame] | 21 | import @1.0::Dial; |
allenwtsu | 1c3dcd3 | 2020-09-25 17:58:01 +0800 | [diff] [blame] | 22 | import @1.0::GsmSmsMessage; |
Jordan Liu | e4f5f02 | 2020-10-21 16:28:40 -0700 | [diff] [blame] | 23 | import @1.1::CardPowerState; |
Jayachandran C | 9bc276b | 2020-07-24 00:46:58 -0700 | [diff] [blame] | 24 | import @1.2::DataRequestReason; |
Shuo Qian | 3f86533 | 2021-02-02 00:05:42 +0000 | [diff] [blame] | 25 | import @1.4::EmergencyCallRouting; |
| 26 | import @1.4::EmergencyServiceCategory; |
ThiƩbaud Weksteen | 5ae16f3 | 2020-08-21 16:46:07 +0200 | [diff] [blame] | 27 | import @1.4::RadioAccessFamily; |
Jayachandran C | 262b606 | 2020-07-22 15:53:58 -0700 | [diff] [blame] | 28 | import @1.5::IRadio; |
Jayachandran C | 9bc276b | 2020-07-24 00:46:58 -0700 | [diff] [blame] | 29 | import @1.5::AccessNetwork; |
| 30 | import @1.5::DataProfileInfo; |
| 31 | import @1.5::LinkAddress; |
Jayachandran C | 262b606 | 2020-07-22 15:53:58 -0700 | [diff] [blame] | 32 | |
| 33 | /** |
| 34 | * This interface is used by telephony and telecom to talk to cellular radio. |
| 35 | * All the functions have minimum one parameter: |
| 36 | * serial: which corresponds to serial no. of request. Serial numbers must only be memorized for the |
| 37 | * duration of a method call. If clients provide colliding serials (including passing the same |
| 38 | * serial to different methods), multiple responses (one for each method call) must still be served. |
Jayachandran C | 9bc276b | 2020-07-24 00:46:58 -0700 | [diff] [blame] | 39 | * setResponseFunctions must work with @1.6::IRadioResponse and @1.6::IRadioIndication. |
Jayachandran C | 262b606 | 2020-07-22 15:53:58 -0700 | [diff] [blame] | 40 | */ |
| 41 | interface IRadio extends @1.5::IRadio { |
Jayachandran C | 9bc276b | 2020-07-24 00:46:58 -0700 | [diff] [blame] | 42 | /** |
Tim Lin | e29df60 | 2020-09-26 22:43:24 +0800 | [diff] [blame] | 43 | * Toggle radio on and off (for "airplane" mode) |
| 44 | * If the radio is turned off/on the radio modem subsystem |
| 45 | * is expected return to an initialized state. For instance, |
| 46 | * any voice and data calls must be terminated and all associated |
| 47 | * lists emptied. |
| 48 | * |
| 49 | * When setting radio power on to exit from airplane mode to place an emergency call on this |
| 50 | * logical modem, powerOn, forEmergencyCall and preferredForEmergencyCall must be true. In |
| 51 | * this case, this modem is optimized to scan only emergency call bands, until: |
| 52 | * 1) Emergency call is completed; or |
| 53 | * 2) Another setRadioPower_1_5 is issued with forEmergencyCall being false or |
| 54 | * preferredForEmergencyCall being false; or |
| 55 | * 3) Timeout after 30 seconds if dial or emergencyDial is not called. |
| 56 | * Once one of these conditions is reached, the modem should move into normal operation. |
| 57 | * |
| 58 | * @param serial Serial number of request. |
| 59 | * @param powerOn To turn on radio -> on = true, to turn off radio -> on = false. |
| 60 | * @param forEmergencyCall To indication to radio if this request is due to emergency call. |
| 61 | * No effect if powerOn is false. |
| 62 | * @param preferredForEmergencyCall indicate whether the following emergency call will be sent |
| 63 | * on this modem or not. No effect if forEmergencyCall is false, or powerOn is false. |
| 64 | * |
| 65 | * Response callback is IRadioConfigResponse. setRadioPowerResponse_1_6. |
| 66 | |
| 67 | * Note this API is the same as the 1.5 |
| 68 | */ |
| 69 | oneway setRadioPower_1_6(int32_t serial, bool powerOn, bool forEmergencyCall, |
| 70 | bool preferredForEmergencyCall); |
| 71 | |
| 72 | /** |
Jayachandran C | 9bc276b | 2020-07-24 00:46:58 -0700 | [diff] [blame] | 73 | * Returns the data call list. An entry is added when a setupDataCall() is issued and removed |
| 74 | * on a deactivateDataCall(). The list is emptied when setRadioPower() off/on issued or when |
| 75 | * the vendor HAL or modem crashes. |
| 76 | * |
| 77 | * @param serial Serial number of request. |
| 78 | * |
| 79 | * Response function is IRadioResponse.getDataCallListResponse_1_6() |
| 80 | */ |
| 81 | oneway getDataCallList_1_6(int32_t serial); |
| 82 | |
| 83 | /** |
| 84 | * Setup a packet data connection. If DataCallResponse.status returns DataCallFailCause:NONE, |
| 85 | * the data connection must be added to data calls and a unsolDataCallListChanged() must be |
| 86 | * sent. The call remains until removed by subsequent unsolDataCallIstChanged(). It may be |
| 87 | * lost due to many factors, including deactivateDataCall() being issued, the radio powered |
| 88 | * off, reception lost or even transient factors like congestion. This data call list is |
| 89 | * returned by getDataCallList() and dataCallListChanged(). |
| 90 | * |
| 91 | * The Radio is expected to: |
| 92 | * - Create one data call context. |
| 93 | * - Create and configure a dedicated interface for the context. |
| 94 | * - The interface must be point to point. |
| 95 | * - The interface is configured with one or more addresses and is capable of sending and |
| 96 | * receiving packets. The format is IP address with optional "/" prefix length |
| 97 | * (The format is defined in RFC-4291 section 2.3). For example, "192.0.1.3", |
| 98 | * "192.0.1.11/16", or "2001:db8::1/64". Typically one IPv4 or one IPv6 or one of each. If |
| 99 | * the prefix length is absent, then the addresses are assumed to be point to point with |
| 100 | * IPv4 with prefix length 32 or IPv6 with prefix length 128. |
| 101 | * - Must not modify routing configuration related to this interface; routing management is |
| 102 | * exclusively within the purview of the Android OS. |
| 103 | * - Support simultaneous data call contexts up to DataRegStateResult.maxDataCalls specified |
| 104 | * in the response of getDataRegistrationState. |
| 105 | * |
Sarah Chin | 912e606 | 2021-02-03 12:02:14 -0800 | [diff] [blame] | 106 | * The differences relative to the 1.5 version of the API are: |
| 107 | * - The addition of new parameters pduSessionId, sliceInfo, trafficDescriptor, and |
| 108 | * matchAllRuleAllowed. |
| 109 | * - If an existing data call should be used for the request, that must be indicated in the |
| 110 | * response by setting SetupDataCallResult::cid to the context id of that call. |
| 111 | * |
Jayachandran C | 9bc276b | 2020-07-24 00:46:58 -0700 | [diff] [blame] | 112 | * @param serial Serial number of request. |
| 113 | * @param accessNetwork The access network to setup the data call. If the data connection cannot |
| 114 | * be established on the specified access network then it should be responded with an error. |
| 115 | * @param dataProfileInfo Data profile info. |
| 116 | * @param roamingAllowed Indicates whether or not data roaming is allowed by the user. |
| 117 | * @param reason The request reason. Must be DataRequestReason:NORMAL or |
| 118 | * DataRequestReason:HANDOVER. |
| 119 | * @param addresses If the reason is DataRequestReason:HANDOVER, this indicates the list of link |
| 120 | * addresses of the existing data connection. This parameter must be ignored unless reason |
| 121 | * is DataRequestReason:HANDOVER. |
| 122 | * @param dnses If the reason is DataRequestReason:HANDOVER, this indicates the list of DNS |
| 123 | * addresses of the existing data connection. The format is defined in RFC-4291 section 2.2. |
| 124 | * For example, "192.0.1.3" or "2001:db8::1". This parameter must be ignored unless reason |
| 125 | * is DataRequestReason:HANDOVER. |
Daniel Bright | 3c72fba | 2020-11-03 14:56:23 -0800 | [diff] [blame] | 126 | * @param pduSessionId The pdu session id to be used for this data call. A value of 0 means |
| 127 | * no pdu session id was attached to this call. |
| 128 | * Reference: 3GPP TS 24.007 section 11.2.3.1b |
Daniel Bright | 8e3a2bf | 2020-12-14 12:51:08 -0800 | [diff] [blame] | 129 | * @param sliceInfo SliceInfo to be used for the data connection when a handover occurs from |
| 130 | * EPDG to 5G. It is valid only when accessNetwork is AccessNetwork:NGRAN. If the slice |
Sarah Chin | 912e606 | 2021-02-03 12:02:14 -0800 | [diff] [blame] | 131 | * passed from EPDG is rejected, then the data failure cause must be |
| 132 | * DataCallFailCause:SLICE_REJECTED. |
Hongbo Zeng | 55487e1 | 2021-01-21 17:23:45 +0800 | [diff] [blame] | 133 | * @param trafficDescriptor TrafficDescriptor for which data connection needs to be |
| 134 | * established. It is used for URSP traffic matching as described in TS 24.526 |
| 135 | * Section 4.2.2. It includes an optional DNN which, if present, must be used for traffic |
| 136 | * matching -- it does not specify the end point to be used for the data call. The end |
| 137 | * point is specified by DataProfileInfo.apn; DataProfileInfo.apn must be used as the end |
| 138 | * point if one is not specified through URSP rules. |
| 139 | * @param matchAllRuleAllowed bool to indicate if using default match-all URSP rule for this |
| 140 | * request is allowed. If false, this request must not use the match-all URSP rule and if |
| 141 | * a non-match-all rule is not found (or if URSP rules are not available) it should return |
| 142 | * failure with cause DataCallFailCause:MATCH_ALL_RULE_NOT_ALLOWED. This is needed as some |
| 143 | * requests need to have a hard failure if the intention cannot be met, for example, a |
| 144 | * zero-rating slice. |
Jayachandran C | 9bc276b | 2020-07-24 00:46:58 -0700 | [diff] [blame] | 145 | * |
| 146 | * Response function is IRadioResponse.setupDataCallResponse_1_6() |
| 147 | * |
Jayachandran C | 9bc276b | 2020-07-24 00:46:58 -0700 | [diff] [blame] | 148 | */ |
| 149 | oneway setupDataCall_1_6(int32_t serial, AccessNetwork accessNetwork, |
| 150 | DataProfileInfo dataProfileInfo, bool roamingAllowed, |
Daniel Bright | 3c72fba | 2020-11-03 14:56:23 -0800 | [diff] [blame] | 151 | DataRequestReason reason, vec<LinkAddress> addresses, vec<string> dnses, |
Hongbo Zeng | 55487e1 | 2021-01-21 17:23:45 +0800 | [diff] [blame] | 152 | int32_t pduSessionId, OptionalSliceInfo sliceInfo, |
| 153 | OptionalTrafficDescriptor trafficDescriptor, bool matchAllRuleAllowed); |
allenwtsu | 1c3dcd3 | 2020-09-25 17:58:01 +0800 | [diff] [blame] | 154 | |
| 155 | /** |
| 156 | * Send an SMS message |
| 157 | * |
| 158 | * @param serial Serial number of request. |
| 159 | * @param message GsmSmsMessage as defined in types.hal |
| 160 | * |
| 161 | * Response function is IRadioResponse.sendSmsResponse_1_6() |
| 162 | * |
| 163 | * Note this API is the same as the 1.0 |
| 164 | * |
| 165 | * Based on the return error, caller decides to resend if sending sms |
| 166 | * fails. RadioError:SMS_SEND_FAIL_RETRY means retry (i.e. error cause is 332) |
| 167 | * and RadioError:GENERIC_FAILURE means no retry (i.e. error cause is 500) |
| 168 | */ |
| 169 | oneway sendSms_1_6(int32_t serial, GsmSmsMessage message); |
| 170 | |
| 171 | /** |
| 172 | * Send an SMS message. Identical to sendSms_1_6, |
| 173 | * except that more messages are expected to be sent soon. If possible, |
| 174 | * keep SMS relay protocol link open (eg TS 27.005 AT+CMMS command) |
| 175 | * |
| 176 | * @param serial Serial number of request. |
| 177 | * @param message GsmSmsMessage as defined in types.hal |
| 178 | * |
Zoey Chen | c181c27 | 2021-04-06 23:23:55 +0800 | [diff] [blame] | 179 | * Response function is IRadioResponse.sendSmsExpectMoreResponse_1_6() |
allenwtsu | 1c3dcd3 | 2020-09-25 17:58:01 +0800 | [diff] [blame] | 180 | * |
| 181 | * Note this API is the same as the 1.0 |
| 182 | * |
| 183 | * Based on the return error, caller decides to resend if sending sms |
| 184 | * fails. RadioError:SMS_SEND_FAIL_RETRY means retry (i.e. error cause is 332) |
| 185 | * and RadioError:GENERIC_FAILURE means no retry (i.e. error cause is 500) |
| 186 | */ |
Zoey Chen | c181c27 | 2021-04-06 23:23:55 +0800 | [diff] [blame] | 187 | oneway sendSmsExpectMore_1_6(int32_t serial, GsmSmsMessage message); |
allenwtsu | 1c3dcd3 | 2020-09-25 17:58:01 +0800 | [diff] [blame] | 188 | |
| 189 | /** |
| 190 | * Send a CDMA SMS message |
| 191 | * |
| 192 | * @param serial Serial number of request. |
| 193 | * @param sms Cdma Sms to be sent described by CdmaSmsMessage in types.hal |
| 194 | * |
| 195 | * Response callback is IRadioResponse.sendCdmaSmsResponse_1_6() |
| 196 | * |
| 197 | * Note this API is the same as the 1.0 |
| 198 | * |
| 199 | */ |
| 200 | oneway sendCdmaSms_1_6(int32_t serial, CdmaSmsMessage sms); |
| 201 | |
| 202 | /** |
| 203 | * Send an SMS message. Identical to sendCdmaSms_1_6, |
| 204 | * except that more messages are expected to be sent soon. |
| 205 | * |
| 206 | * @param serial Serial number of request. |
| 207 | * @param sms Cdma Sms to be sent described by CdmaSmsMessage in types.hal |
| 208 | * |
| 209 | * Response callback is IRadioResponse.sendCdmaSMSExpectMoreResponse_1_6() |
| 210 | * |
| 211 | * Note this API is the same as the 1.5 |
| 212 | * |
| 213 | */ |
| 214 | oneway sendCdmaSmsExpectMore_1_6(int32_t serial, CdmaSmsMessage sms); |
Sooraj Sasindran | a9d461b | 2020-08-14 11:00:11 -0700 | [diff] [blame] | 215 | |
| 216 | /** |
Jordan Liu | e4f5f02 | 2020-10-21 16:28:40 -0700 | [diff] [blame] | 217 | * Set SIM card power state. |
| 218 | * Request is used to power off or power on the card. It should not generate |
| 219 | * a CardState.CARDSTATE_ABSENT indication, since the SIM is still physically |
| 220 | * inserted. |
| 221 | * |
| 222 | * @param serial Serial number of request |
| 223 | * @param powerUp POWER_DOWN if powering down the SIM card, |
| 224 | * POWER_UP if powering up the SIM card, |
| 225 | * POWER_UP_PASS_THROUGH if powering up the SIM card in |
| 226 | * pass through mode. |
| 227 | * |
| 228 | * When SIM card is in POWER_UP_PASS_THROUGH, the modem does not send |
| 229 | * any command to it (for example SELECT of MF, or TERMINAL |
| 230 | * CAPABILITY), and the SIM card is controlled completely by Telephony |
| 231 | * sending APDUs directly. The SIM card state must be |
| 232 | * RIL_CARDSTATE_PRESENT and the number of card apps will be 0. |
| 233 | * No new error code is generated. Emergency calls are supported in |
| 234 | * the same way as if the SIM card is absent. |
| 235 | * Pass-through mode is valid only for the specific card session where |
| 236 | * it is activated, and normal behavior occurs at the next SIM |
| 237 | * initialization, unless POWER_UP_PASS_THROUGH is requested again. |
| 238 | * |
| 239 | * The device is required to power down the SIM card before it can |
| 240 | * switch the mode between POWER_UP and POWER_UP_PASS_THROUGH. |
| 241 | * At device power up, the SIM interface is powered up automatically. |
| 242 | * Each subsequent request to this method is processed only after the |
| 243 | * completion of the previous one. |
| 244 | * |
Jordan Liu | 8ca952e | 2020-11-09 15:47:21 -0800 | [diff] [blame] | 245 | * When the SIM is in POWER_DOWN, the modem should send an empty vector of |
| 246 | * AppStatus in CardStatus.applications. If a SIM in the POWER_DOWN state |
| 247 | * is removed and a new SIM is inserted, the new SIM should be in POWER_UP |
| 248 | * mode by default. If the device is turned off or restarted while the SIM |
| 249 | * is in POWER_DOWN, then the SIM should turn on normally in POWER_UP mode |
| 250 | * when the device turns back on. |
| 251 | * |
Jordan Liu | e4f5f02 | 2020-10-21 16:28:40 -0700 | [diff] [blame] | 252 | * Response callback is IRadioResponse.setSimCardPowerResponse_1_6(). |
| 253 | * Note that this differs from setSimCardPower_1_1 in that the response |
| 254 | * callback should only be sent once the device has finished executing |
| 255 | * the request (the SIM has finished powering on or off). |
| 256 | */ |
| 257 | oneway setSimCardPower_1_6(int32_t serial, CardPowerState powerUp); |
| 258 | |
| 259 | /** |
Sooraj Sasindran | a9d461b | 2020-08-14 11:00:11 -0700 | [diff] [blame] | 260 | * Enable or disable E-UTRA-NR dual connectivity. If disabled then UE will not connect |
| 261 | * to secondary carrier. |
| 262 | * |
| 263 | * @param serial Serial number of request. |
| 264 | * @param nrDualConnectivityState expected NR dual connectivity state. |
| 265 | * 1. Enable NR dual connectivity {NrDualConnectivityState:ENABLE} |
| 266 | * 2. Disable NR dual connectivity {NrDualConnectivityState:DISABLE} |
| 267 | * 3. Disable NR dual connectivity and force secondary cell to be released |
| 268 | * {NrDualConnectivityState:DISABLE_IMMEDIATE} |
Zoey Chen | c181c27 | 2021-04-06 23:23:55 +0800 | [diff] [blame] | 269 | * |
Sooraj Sasindran | e9525fd | 2020-11-03 20:46:57 -0800 | [diff] [blame] | 270 | * Response callback is IRadioResponse.setNRDualConnectivityStateResponse() |
Sooraj Sasindran | a9d461b | 2020-08-14 11:00:11 -0700 | [diff] [blame] | 271 | */ |
Sooraj Sasindran | e9525fd | 2020-11-03 20:46:57 -0800 | [diff] [blame] | 272 | oneway setNrDualConnectivityState(int32_t serial, |
Sooraj Sasindran | a9d461b | 2020-08-14 11:00:11 -0700 | [diff] [blame] | 273 | NrDualConnectivityState nrDualConnectivityState); |
| 274 | |
| 275 | /** |
| 276 | * Is E-UTRA-NR Dual Connectivity enabled |
| 277 | * |
| 278 | * @param serial Serial number of request. |
| 279 | * Response callback is IRadioResponse.isNRDualConnectivityEnabledResponse() |
| 280 | */ |
| 281 | oneway isNrDualConnectivityEnabled(int32_t serial); |
Daniel Bright | 15cc34a | 2020-10-26 11:34:53 -0700 | [diff] [blame] | 282 | |
| 283 | /** |
| 284 | * Reserves an unallocated pdu session id from the pool of ids. |
| 285 | * |
| 286 | * The allocated id is returned in the response. |
| 287 | * |
| 288 | * When the id is no longer needed, call releasePduSessionId to |
| 289 | * return it to the pool. |
| 290 | * |
| 291 | * Reference: 3GPP TS 24.007 section 11.2.3.1b |
| 292 | * |
| 293 | * @param serial Serial number of request. |
| 294 | * |
| 295 | * Response function is IRadioResponse.allocatePduSessionIdResponse() |
| 296 | */ |
| 297 | oneway allocatePduSessionId(int32_t serial); |
| 298 | |
| 299 | /** |
| 300 | * Releases a pdu session id that was previously allocated using |
| 301 | * allocatePduSessionId. |
| 302 | * |
| 303 | * Reference: 3GPP TS 24.007 section 11.2.3.1b |
| 304 | * @param serial Serial number of request. |
| 305 | * @param id Pdu session id to release. |
| 306 | * |
| 307 | * Response function is IRadioResponse.releasePduSessionIdResponse() |
| 308 | */ |
| 309 | oneway releasePduSessionId(int32_t serial, int32_t id); |
| 310 | |
| 311 | /** |
| 312 | * Indicates that a handover to the IWLAN transport has begun. |
| 313 | * |
| 314 | * Any resources being transferred to the IWlan transport cannot be released while a |
| 315 | * handover is underway. For example, if a pdu session id needs to be |
| 316 | * transferred to IWlan, then, the modem should not release the id while |
| 317 | * the handover is in progress. |
| 318 | * |
| 319 | * If a handover was unsuccessful, then the framework calls IRadio::cancelHandover. |
| 320 | * The modem retains ownership over any of the resources being transferred to IWlan. |
| 321 | * |
| 322 | * If a handover was successful, the framework calls IRadio::deactivateDataCall with reason |
| 323 | * HANDOVER. The IWlan transport now owns the transferred resources and is responsible for |
| 324 | * releasing them. |
| 325 | * |
| 326 | * @param serial Serial number of request. |
| 327 | * @param id callId The identifier of the data call which is provided in SetupDataCallResult |
| 328 | * |
Daniel Bright | 3c72fba | 2020-11-03 14:56:23 -0800 | [diff] [blame] | 329 | * Response function is IRadioResponse.startHandoverResponse() |
Daniel Bright | 15cc34a | 2020-10-26 11:34:53 -0700 | [diff] [blame] | 330 | */ |
Daniel Bright | 3c72fba | 2020-11-03 14:56:23 -0800 | [diff] [blame] | 331 | oneway startHandover(int32_t serial, int32_t callId); |
Daniel Bright | 15cc34a | 2020-10-26 11:34:53 -0700 | [diff] [blame] | 332 | |
| 333 | /** |
Daniel Bright | 3c72fba | 2020-11-03 14:56:23 -0800 | [diff] [blame] | 334 | * Indicates that a handover was cancelled after a call to IRadio::startHandover. |
Daniel Bright | 15cc34a | 2020-10-26 11:34:53 -0700 | [diff] [blame] | 335 | * |
| 336 | * Since the handover was unsuccessful, the modem retains ownership over any of the resources |
| 337 | * being transferred and is still responsible for releasing them. |
| 338 | * |
| 339 | * @param serial Serial number of request. |
| 340 | * @param id callId The identifier of the data call which is provided in SetupDataCallResult |
| 341 | * |
| 342 | * Response function is IRadioResponse.cancelHandoverResponse() |
| 343 | */ |
| 344 | oneway cancelHandover(int32_t serial, int32_t callId); |
ThiƩbaud Weksteen | 5ae16f3 | 2020-08-21 16:46:07 +0200 | [diff] [blame] | 345 | |
| 346 | /** |
| 347 | * Requests to set the network type for searching and registering. |
| 348 | * |
SongFerngWang | f92b61c | 2021-01-26 03:08:48 +0800 | [diff] [blame] | 349 | * Instruct the radio to *only* accept the types of network provided. |
| 350 | * setPreferredNetworkType, setPreferredNetworkTypesBitmap will not be called anymore |
| 351 | * except for IRadio v1.5 or older devices. |
ThiƩbaud Weksteen | 5ae16f3 | 2020-08-21 16:46:07 +0200 | [diff] [blame] | 352 | * |
ThiƩbaud Weksteen | 2ee3e2e | 2020-12-16 17:08:17 +0100 | [diff] [blame] | 353 | * In case of an emergency call, the modem is authorized to bypass this |
| 354 | * restriction. |
| 355 | * |
ThiƩbaud Weksteen | 5ae16f3 | 2020-08-21 16:46:07 +0200 | [diff] [blame] | 356 | * @param serial Serial number of request. |
| 357 | * @param networkTypeBitmap a 32-bit bearer bitmap of RadioAccessFamily |
| 358 | * |
SongFerngWang | f92b61c | 2021-01-26 03:08:48 +0800 | [diff] [blame] | 359 | * Response callback is IRadioResponse.setAllowedNetworkTypesBitmapResponse() |
ThiƩbaud Weksteen | 5ae16f3 | 2020-08-21 16:46:07 +0200 | [diff] [blame] | 360 | */ |
SongFerngWang | f92b61c | 2021-01-26 03:08:48 +0800 | [diff] [blame] | 361 | oneway setAllowedNetworkTypesBitmap( |
ThiƩbaud Weksteen | 5ae16f3 | 2020-08-21 16:46:07 +0200 | [diff] [blame] | 362 | uint32_t serial, bitfield<RadioAccessFamily> networkTypeBitmap); |
Jack Nudelman | 5cd9414 | 2020-09-24 14:23:35 -0700 | [diff] [blame] | 363 | |
| 364 | /** |
Yomna Nasser | e8bfa9c | 2020-11-17 22:00:55 +0000 | [diff] [blame] | 365 | * Requests bitmap representing the currently allowed network types. |
| 366 | * |
SongFerngWang | f92b61c | 2021-01-26 03:08:48 +0800 | [diff] [blame] | 367 | * getPreferredNetworkType, getPreferredNetworkTypesBitmap will not be called anymore |
| 368 | * except for IRadio v1.5 or older devices. |
Yomna Nasser | e8bfa9c | 2020-11-17 22:00:55 +0000 | [diff] [blame] | 369 | * |
| 370 | * @param serial Serial number of request. |
| 371 | * |
SongFerngWang | f92b61c | 2021-01-26 03:08:48 +0800 | [diff] [blame] | 372 | * Response callback is IRadioResponse.getAllowedNetworkTypesBitmapResponse() |
Yomna Nasser | e8bfa9c | 2020-11-17 22:00:55 +0000 | [diff] [blame] | 373 | */ |
Zoey Chen | c181c27 | 2021-04-06 23:23:55 +0800 | [diff] [blame] | 374 | oneway getAllowedNetworkTypesBitmap(int32_t serial); |
Yomna Nasser | e8bfa9c | 2020-11-17 22:00:55 +0000 | [diff] [blame] | 375 | |
| 376 | /** |
Jack Nudelman | 5cd9414 | 2020-09-24 14:23:35 -0700 | [diff] [blame] | 377 | * Control data throttling at modem. |
| 378 | * - DataThrottlingAction:NO_DATA_THROTTLING should clear any existing |
| 379 | * data throttling within the requested completion window. |
| 380 | * - DataThrottlingAction:THROTTLE_SECONDARY_CARRIER: Remove any existing |
| 381 | * throttling on anchor carrier and achieve maximum data throttling on |
| 382 | * secondary carrier within the requested completion window. |
| 383 | * - DataThrottlingAction:THROTTLE_ANCHOR_CARRIER: disable secondary |
| 384 | * carrier and achieve maximum data throttling on anchor carrier by |
| 385 | * requested completion window. |
| 386 | * - DataThrottlingAction:HOLD: Immediately hold on to current level of |
| 387 | * throttling. |
| 388 | * |
| 389 | * @param serial Serial number of request. |
| 390 | * @param dataThrottlingAction DataThrottlingAction as defined in types.hal |
Jack Nudelman | 3f76554 | 2020-11-18 16:21:06 -0800 | [diff] [blame] | 391 | * @param completionDurationMillis window, in milliseconds, in which the |
| 392 | * requested throttling action has to be achieved. This must be 0 when |
Jack Nudelman | 5cd9414 | 2020-09-24 14:23:35 -0700 | [diff] [blame] | 393 | * dataThrottlingAction is DataThrottlingAction:HOLD. |
| 394 | * |
| 395 | * Response function is IRadioResponse.setDataThrottlingResponse() |
| 396 | */ |
| 397 | oneway setDataThrottling(int32_t serial, |
| 398 | DataThrottlingAction dataThrottlingAction, |
Jack Nudelman | 3f76554 | 2020-11-18 16:21:06 -0800 | [diff] [blame] | 399 | int64_t completionDurationMillis); |
Sarah Chin | f69abcf | 2020-11-18 13:40:15 -0800 | [diff] [blame] | 400 | |
| 401 | /** |
Shuo Qian | 3f86533 | 2021-02-02 00:05:42 +0000 | [diff] [blame] | 402 | * Initiate emergency voice call, with zero or more emergency service category(s), zero or |
| 403 | * more emergency Uniform Resource Names (URN), and routing information for handling the call. |
| 404 | * Android uses this request to make its emergency call instead of using @1.0::IRadio.dial |
| 405 | * if the 'address' in the 'dialInfo' field is identified as an emergency number by Android. |
| 406 | * |
| 407 | * In multi-sim scenario, if the emergency number is from a specific subscription, this radio |
| 408 | * request can still be sent out on the other subscription as long as routing is set to |
| 409 | * @1.4::EmergencyNumberRouting#EMERGENCY. This radio request will not be sent on an inactive |
| 410 | * (PIN/PUK locked) subscription unless both subscriptions are PIN/PUK locked. In this case, |
| 411 | * the request will be sent on the primary subscription. |
| 412 | * |
| 413 | * Some countries or carriers require some emergency numbers that must be handled with normal |
| 414 | * call routing if possible or emergency routing. 1) if the 'routing' field is specified as |
| 415 | * @1.4::EmergencyNumberRouting#NORMAL, the implementation must try the full radio service to |
| 416 | * use normal call routing to handle the call; if service cannot support normal routing, the |
| 417 | * implementation must use emergency routing to handle the call. 2) if 'routing' is specified |
| 418 | * as @1.4::EmergencyNumberRouting#EMERGENCY, the implementation must use emergency routing to |
| 419 | * handle the call. 3) if 'routing' is specified as @1.4::EmergencyNumberRouting#UNKNOWN, |
| 420 | * Android does not know how to handle the call. |
| 421 | * |
| 422 | * If the dialed emergency number does not have a specified emergency service category, the |
| 423 | * 'categories' field is set to @1.4::EmergencyServiceCategory#UNSPECIFIED; if the dialed |
| 424 | * emergency number does not have specified emergency Uniform Resource Names, the 'urns' field |
| 425 | * is set to an empty list. If the underlying technology used to request emergency services |
| 426 | * does not support the emergency service category or emergency uniform resource names, the |
| 427 | * field 'categories' or 'urns' may be ignored. |
| 428 | * |
| 429 | * In the scenarios that the 'address' in the 'dialInfo' field has other functions besides the |
| 430 | * emergency number function, if the 'hasKnownUserIntentEmergency' field is true, the user's |
| 431 | * intent for this dial request is emergency call, and the modem must treat this as an actual |
| 432 | * emergency dial; if the 'hasKnownUserIntentEmergency' field is false, Android does not know |
| 433 | * user's intent for this call. |
| 434 | * |
| 435 | * If 'isTesting' is true, this request is for testing purpose, and must not be sent to a real |
| 436 | * emergency service; otherwise it's for a real emergency call request. |
| 437 | * |
| 438 | * Reference: 3gpp 22.101, Section 10 - Emergency Calls; |
| 439 | * 3gpp 23.167, Section 6 - Functional description; |
| 440 | * 3gpp 24.503, Section 5.1.6.8.1 - General; |
| 441 | * RFC 5031 |
| 442 | * |
| 443 | * @param serial Serial number of request. |
| 444 | * @param dialInfo the same @1.0::Dial information used by @1.0::IRadio.dial. |
| 445 | * @param categories bitfield<@1.4::EmergencyServiceCategory> the Emergency Service Category(s) |
| 446 | * of the call. |
| 447 | * @param urns the emergency Uniform Resource Names (URN) |
| 448 | * @param routing @1.4::EmergencyCallRouting the emergency call routing information. |
| 449 | * @param hasKnownUserIntentEmergency Flag indicating if user's intent for the emergency call |
| 450 | * is known. |
| 451 | * @param isTesting Flag indicating if this request is for testing purpose. |
| 452 | * |
| 453 | * Response function is IRadioResponse.emergencyDialResponse() |
| 454 | */ |
| 455 | oneway emergencyDial_1_6(int32_t serial, Dial dialInfo, |
| 456 | bitfield<EmergencyServiceCategory> categories, vec<string> urns, |
| 457 | EmergencyCallRouting routing, bool hasKnownUserIntentEmergency, bool isTesting); |
| 458 | |
| 459 | /** |
Sarah Chin | f69abcf | 2020-11-18 13:40:15 -0800 | [diff] [blame] | 460 | * Get which bands the modem's background scan is acting on. |
| 461 | * |
| 462 | * @param serial Serial number of request. |
| 463 | * |
| 464 | * Response callback is IRadioResponse.getSystemSelectionChannelsResponse() |
| 465 | */ |
| 466 | oneway getSystemSelectionChannels(int32_t serial); |
Hui Wang | fb20250 | 2020-11-13 04:30:18 +0000 | [diff] [blame] | 467 | |
Mingming Cai | da0d983 | 2020-11-05 17:56:57 -0800 | [diff] [blame] | 468 | /** |
| 469 | * Request all of the current cell information known to the radio. The radio |
| 470 | * must return list of all current cells, including the neighboring cells. If for a particular |
| 471 | * cell information isn't known then the appropriate unknown value will be returned. |
| 472 | * This does not cause or change the rate of unsolicited cellInfoList(). |
| 473 | * |
Sarah Chin | e52a394 | 2021-02-12 11:55:15 -0800 | [diff] [blame] | 474 | * This is identical to getCellInfoList in V1.0, but it requests updated version of CellInfo. |
Mingming Cai | da0d983 | 2020-11-05 17:56:57 -0800 | [diff] [blame] | 475 | * |
| 476 | * @param serial Serial number of request. |
| 477 | * |
| 478 | * Response callback is IRadioResponse.getCellInfoListResponse() |
| 479 | */ |
| 480 | oneway getCellInfoList_1_6(int32_t serial); |
| 481 | |
Hui Wang | fb20250 | 2020-11-13 04:30:18 +0000 | [diff] [blame] | 482 | /** |
| 483 | * Request current voice registration state. |
| 484 | * |
| 485 | * @param serial Serial number of request. |
| 486 | * |
| 487 | * Response function is IRadioResponse.getVoiceRegistrationStateResponse_1_6() |
| 488 | */ |
| 489 | oneway getVoiceRegistrationState_1_6(int32_t serial); |
| 490 | |
| 491 | /** |
Mingming Cai | 20a2f42 | 2020-12-03 12:18:48 -0800 | [diff] [blame] | 492 | * Requests current signal strength and associated information. Must succeed if radio is on. |
| 493 | * |
| 494 | * @param serial Serial number of request. |
| 495 | * |
| 496 | * Response function is IRadioResponse.getSignalStrengthResponse_1_6() |
| 497 | */ |
| 498 | oneway getSignalStrength_1_6(int32_t serial); |
| 499 | |
| 500 | /** |
Hui Wang | fb20250 | 2020-11-13 04:30:18 +0000 | [diff] [blame] | 501 | * Request current data registration state. |
| 502 | * |
| 503 | * @param serial Serial number of request. |
| 504 | * |
| 505 | * Response function is IRadioResponse.getDataRegistrationStateResponse_1_6() |
| 506 | */ |
| 507 | oneway getDataRegistrationState_1_6(int32_t serial); |
Shinsuke Ishioka | ede1e95 | 2018-08-17 18:02:29 +0900 | [diff] [blame] | 508 | |
| 509 | /** |
| 510 | * Requests current call list |
| 511 | * |
| 512 | * @param serial Serial number of request. |
| 513 | * |
| 514 | * Response function is IRadioResponse.getCurrentCallsResponse_1_6() |
| 515 | */ |
| 516 | oneway getCurrentCalls_1_6(int32_t serial); |
Tyler Wear | 6c9d2c6 | 2020-07-30 13:21:03 -0700 | [diff] [blame] | 517 | |
| 518 | /** |
Hongbo Zeng | b1ea8db | 2021-02-02 23:01:12 +0800 | [diff] [blame] | 519 | * Request to get the current slicing configuration including URSP rules and |
| 520 | * NSSAIs (configured, allowed and rejected). |
| 521 | * URSP stands for UE route selection policy and is defined in 3GPP TS 24.526 |
| 522 | * Section 4.2. |
| 523 | * An NSSAI is a collection of network slices. Each network slice is identified by |
| 524 | * an S-NSSAI and is represented by the struct SliceInfo. NSSAI and S-NSSAI |
| 525 | * are defined in 3GPP TS 24.501. |
| 526 | * |
| 527 | * Response function is IRadioResponse.getSlicingConfigResponse() |
| 528 | */ |
| 529 | oneway getSlicingConfig(int32_t serial); |
| 530 | |
| 531 | /** |
Tyler Wear | 6c9d2c6 | 2020-07-30 13:21:03 -0700 | [diff] [blame] | 532 | * Provide Carrier specific information to the modem that must be used to |
| 533 | * encrypt the IMSI and IMPI. Sent by the framework during boot, carrier |
| 534 | * switch and everytime the framework receives a new certificate. |
| 535 | * |
| 536 | * @param serial Serial number of request. |
| 537 | * @param imsiEncryptionInfo ImsiEncryptionInfo as defined in types.hal. |
| 538 | * |
| 539 | * Response callback is |
| 540 | * IRadioResponse.setCarrierInfoForImsiEncryptionResponse() |
| 541 | * |
| 542 | * Note this API is the same as the 1.1 version except using the 1.6 ImsiEncryptionInfo |
| 543 | * as the input param. |
| 544 | */ |
| 545 | oneway setCarrierInfoForImsiEncryption_1_6(int32_t serial, @1.6::ImsiEncryptionInfo imsiEncryptionInfo); |
Mengjun Leng | 48966f0 | 2021-03-16 10:09:20 +0800 | [diff] [blame] | 546 | |
| 547 | /** |
| 548 | * Get the local and global phonebook records from the SIM card. |
| 549 | * This should be called again after a simPhonebookChanged notification is received. |
| 550 | * |
| 551 | * The phonebook records are received via IRadioIndication.simPhonebookRecordsReceived() |
| 552 | * |
| 553 | * @param serial Serial number of request. |
| 554 | * |
| 555 | * Response callback is IRadioResponse.getSimPhonebookRecordsResponse() |
| 556 | */ |
| 557 | oneway getSimPhonebookRecords(int32_t serial); |
| 558 | |
| 559 | /** |
| 560 | * Get the phone book capacity |
| 561 | * |
| 562 | * @param serial Serial number of request. |
| 563 | * |
| 564 | * Response function is defined from IRadioResponse.getSimPhonebookCapacityResponse() |
| 565 | */ |
| 566 | oneway getSimPhonebookCapacity(int32_t serial); |
| 567 | |
| 568 | /** |
| 569 | * Insert, delete or update a phonebook record on the SIM card. |
| 570 | * If the index of recordInfo is 0, the phonebook record will be added to global or |
| 571 | * local phonebook, and global phonebook has higher priority than local phonebook. |
| 572 | * |
| 573 | * If the fields in the recordInfo are all empty except for the index, the phonebook |
| 574 | * record specified by the index will be deleted. |
| 575 | * |
| 576 | * The indication simPhonebookChanged will be called after every successful call of |
| 577 | * updateSimPhonebookRecords. |
| 578 | * |
| 579 | * @param serial Serial number of request. |
| 580 | * @param recordInfo Details of the record to insert, delete or update. |
| 581 | * |
| 582 | * Response callback is IRadioResponse.updateSimPhonebookRecordsResponse() |
| 583 | */ |
| 584 | oneway updateSimPhonebookRecords(int32_t serial, PhonebookRecordInfo recordInfo); |
Jayachandran C | 262b606 | 2020-07-22 15:53:58 -0700 | [diff] [blame] | 585 | }; |