| /* |
| * Copyright (C) 2021 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package android.hardware.radio.network; |
| |
| import android.hardware.radio.RadioIndicationType; |
| import android.hardware.radio.RadioTechnology; |
| import android.hardware.radio.network.BarringInfo; |
| import android.hardware.radio.network.CellIdentity; |
| import android.hardware.radio.network.CellInfo; |
| import android.hardware.radio.network.CellularIdentifierDisclosure; |
| import android.hardware.radio.network.DisplayNetworkType; |
| import android.hardware.radio.network.EmergencyRegResult; |
| import android.hardware.radio.network.LinkCapacityEstimate; |
| import android.hardware.radio.network.NetworkScanResult; |
| import android.hardware.radio.network.PhoneRestrictedState; |
| import android.hardware.radio.network.PhysicalChannelConfig; |
| import android.hardware.radio.network.SecurityAlgorithmUpdate; |
| import android.hardware.radio.network.SignalStrength; |
| import android.hardware.radio.network.SuppSvcNotification; |
| |
| /** |
| * Interface declaring unsolicited radio indications for network APIs. |
| * @hide |
| */ |
| @VintfStability |
| oneway interface IRadioNetworkIndication { |
| /** |
| * Indicate barring information for the user’s access category / access class and PLMN. |
| * |
| * <p>Provide information about the barring status of the cell for the user. The information |
| * provided should describe all barring configurations that are applicable to the current user, |
| * even if the user is not currently barred (due to conditional barring). This informs Android |
| * of likely future (statistical) barring for specific services. |
| * |
| * <p>This indication should be sent whenever the cell’s barring config changes for the current |
| * user, or if the user’s conditional barring status changes due to re-evaluation of the |
| * barring conditions. Barring status will likely change when the device camps for service, |
| * when PLMN selection is completed, when the device attempts to access a conditionally barred |
| * service, and when the System Information including barring info for a camped cell is updated. |
| * |
| * @param type Type of radio indication |
| * @param cellIdentity cellIdentity for the barring infos |
| * @param barringInfos a vector of BarringInfos for all barring service types |
| */ |
| void barringInfoChanged(in RadioIndicationType type, in CellIdentity cellIdentity, |
| in BarringInfo[] barringInfos); |
| |
| /** |
| * Indicates when PRL (preferred roaming list) changes. |
| * |
| * @param type Type of radio indication |
| * @param version PRL version after PRL changes |
| * @deprecated Legacy CDMA is unsupported. |
| */ |
| void cdmaPrlChanged(in RadioIndicationType type, in int version); |
| |
| /** |
| * Report all of the current cell information known to the radio. |
| * |
| * @param type Type of radio indication |
| * @param records Current cell information |
| */ |
| void cellInfoList(in RadioIndicationType type, in CellInfo[] records); |
| |
| /** |
| * Indicates current link capacity estimate. This indication is sent whenever the reporting |
| * criteria, as set by IRadioNetwork.setLinkCapacityReportingCriteria(), are met and the |
| * indication is not suppressed by IRadioNetwork.setIndicationFilter(). |
| * |
| * @param type Type of radio indication |
| * @param lce LinkCapacityEstimate |
| */ |
| void currentLinkCapacityEstimate(in RadioIndicationType type, in LinkCapacityEstimate lce); |
| |
| /** |
| * Indicates physical channel configurations. An empty configs list shall be returned when the |
| * radio is in idle mode (i.e. RRC idle). |
| * |
| * @param type Type of radio indication |
| * @param configs Vector of PhysicalChannelConfigs |
| */ |
| void currentPhysicalChannelConfigs( |
| in RadioIndicationType type, in PhysicalChannelConfig[] configs); |
| |
| /** |
| * Indicates current signal strength of the radio. |
| * |
| * @param type Type of radio indication |
| * @param signalStrength SignalStrength information |
| */ |
| void currentSignalStrength(in RadioIndicationType type, in SignalStrength signalStrength); |
| |
| /** |
| * Indicates when IMS registration state has changed. To get IMS registration state and IMS SMS |
| * format, callee needs to invoke getImsRegistrationState(). |
| * |
| * @param type Type of radio indication |
| */ |
| void imsNetworkStateChanged(in RadioIndicationType type); |
| |
| /** |
| * Incremental network scan results. |
| * |
| * @param type Type of radio indication |
| * @param result the result of the network scan |
| */ |
| void networkScanResult(in RadioIndicationType type, in NetworkScanResult result); |
| |
| /** |
| * Indicates when voice or data network state changed. Callee must invoke |
| * IRadioNetwork.getVoiceRegistrationState(), IRadioNetwork.getDataRegistrationState(), and |
| * IRadioNetwork.getOperator() |
| * |
| * @param type Type of radio indication |
| */ |
| void networkStateChanged(in RadioIndicationType type); |
| |
| /** |
| * Indicates when radio has received a NITZ time message. |
| * |
| * @param type Type of radio indication |
| * @param nitzTime NITZ time string in the form "yy/mm/dd,hh:mm:ss(+/-)tz,dt" |
| * @param receivedTimeMs time (in milliseconds since boot) at which RIL sent the NITZ time to |
| * the framework |
| * @param ageMs time in milliseconds indicating how long NITZ was cached in RIL and modem. |
| * This must track true age and therefore must be calculated using clocks that |
| * include the time spent in sleep / low power states. If it can not be guaranteed, |
| * there must not be any caching done at the modem and should fill in 0 for ageMs |
| */ |
| void nitzTimeReceived( |
| in RadioIndicationType type, in String nitzTime, in long receivedTimeMs, in long ageMs); |
| |
| /** |
| * Report that Registration or a Location/Routing/Tracking Area update has failed. |
| * |
| * <p>Indicate whenever a registration procedure, including a location, routing, or tracking |
| * area update fails. This includes procedures that do not necessarily result in a change of |
| * the modem's registration status. If the modem's registration status changes, that is |
| * reflected in the onNetworkStateChanged() and subsequent get{Voice/Data}RegistrationState(). |
| * |
| * @param cellIdentity the CellIdentity, which must include the globally unique identifier for |
| * the cell (for example, all components of the CGI or ECGI). |
| * @param chosenPlmn a 5 or 6 digit alphanumeric PLMN (MCC|MNC) among those broadcast by the |
| * cell that was chosen for the failed registration attempt. |
| * @param domain Domain::CS, Domain::PS, or both in case of a combined procedure. |
| * @param causeCode the primary failure cause code of the procedure. |
| * For GSM/UMTS (MM), values are in TS 24.008 Sec 10.5.95 |
| * For GSM/UMTS (GMM), values are in TS 24.008 Sec 10.5.147 |
| * For LTE (EMM), cause codes are TS 24.301 Sec 9.9.3.9 |
| * For NR (5GMM), cause codes are TS 24.501 Sec 9.11.3.2 |
| * MAX_INT if this value is unused. |
| * @param additionalCauseCode the cause code of any secondary/combined procedure if appropriate. |
| * For UMTS, if a combined attach succeeds for PS only, then the GMM cause code shall be |
| * included as an additionalCauseCode. |
| * For LTE (ESM), cause codes are in TS 24.301 9.9.4.4 |
| * MAX_INT if this value is unused. |
| */ |
| void registrationFailed(in RadioIndicationType type, in CellIdentity cellIdentity, |
| in String chosenPlmn, in int domain, in int causeCode, in int additionalCauseCode); |
| |
| /** |
| * Indicates a restricted state change (eg, for Domain Specific Access Control). |
| * Radio must send this msg after radio off/on cycle no matter it is changed or not. |
| * |
| * @param type Type of radio indication |
| * @param state Bitmask of restricted state as defined by PhoneRestrictedState |
| */ |
| void restrictedStateChanged(in RadioIndicationType type, in PhoneRestrictedState state); |
| |
| /** |
| * Reports supplementary service related notification from the network. |
| * |
| * @param type Type of radio indication |
| * @param suppSvc SuppSvcNotification |
| */ |
| void suppSvcNotify(in RadioIndicationType type, in SuppSvcNotification suppSvc); |
| |
| /** |
| * Indicates that voice technology has changed. Responds with new rat. |
| * |
| * @param type Type of radio indication |
| * @param rat Current new voice rat |
| */ |
| void voiceRadioTechChanged(in RadioIndicationType type, in RadioTechnology rat); |
| |
| /** |
| * Emergency Scan Results. |
| * |
| * @param type Type of radio indication |
| * @param result the result of the Emergency Network Scan |
| */ |
| void emergencyNetworkScanResult(in RadioIndicationType type, in EmergencyRegResult result); |
| |
| /** |
| * Report a cellular identifier disclosure event. See |
| * IRadioNetwork.setCellularIdnetifierTransparencyEnabled for more details. |
| * |
| * A non-exhaustive list of when this method should be called follows: |
| * |
| * - If a device attempts an IMSI attach to the network. |
| * - If a device includes an IMSI in the IDENTITY_RESPONSE message on the NAS and a security |
| * context has not yet been established. |
| * - If a device includes an IMSI in a DETACH_REQUEST message sent on the NAS and the message is |
| * sent before a security context has been established. |
| * - If a device includes an IMSI in a TRACKING_AREA_UPDATE message sent on the NAS and the |
| * message is sent before a security context has been established. |
| * - If a device uses a 2G network to send a LOCATION_UPDATE_REQUEST message on the NAS that |
| * includes an IMSI or IMEI. |
| * - If a device uses a 2G network to send a AUTHENTICATION_AND_CIPHERING_RESPONSE message on |
| * the NAS and the message includes an IMEISV. |
| * |
| * cellularIdentifierDisclosure indications must be sent to Android regardless of the screen |
| * state. If the screen is off, the indications must still be sent to Android. |
| * |
| * Note: in the NRSA scenario, only a SUCI generated by a null scheme should be considered as a |
| * plain-text identifier. |
| * |
| * @param type Type of radio indication |
| * @param disclosure A CellularIdentifierDisclosure as specified by |
| * IRadioNetwork.setCellularIdentifierTransparencyEnabled. |
| * |
| */ |
| void cellularIdentifierDisclosed( |
| in RadioIndicationType type, in CellularIdentifierDisclosure disclosure); |
| |
| /* |
| * Indicates that a new ciphering or integrity algorithm was used for a particular voice, |
| * signaling, or data connection for a given PLMN and/or access network. Due to power |
| * concerns, once a ConnectionEvent has been reported on, follow-up reports about that |
| * ConnectionEvent are only generated if there is any change to the most-recently reported |
| * encryption or integrity, if there is a RAT change, or if the value of |
| * SecurityAlgorithmUpdate#isUnprotectedEmergency changes. A change only in cell ID should not |
| * trigger an update, as the design is intended to be agnostic to dual connectivity ("secondary |
| * serving cells"). |
| * |
| * Example to further clarify "most-recently reported": |
| * 1. After booting up, the UE is in ENDC with LTE. Modem reports NAS_SIGNALLING_LTE and |
| * AS_SIGNALLING_LTE are well-ciphered but AS_SIGNALLING_5G is null-ciphered. |
| * 2. UE moves to 3G and enters the connected mode. Modem reports indications of PS_SERVICE_3G |
| * and SIGNALLING_3G to Android. |
| * 3. UE moves to LTE. UE enters the connected mode and there is no ENDC. The algorithms of |
| * NAS_SIGNALLING_LTE and AS_SIGNALLING_LTE are the same as in Step 1. The UE should send |
| * this indication to AP as it’s a RAT switch. |
| * 4. Later, UE establishes ENDC. AS_SIGNALLING_5G is null-ciphered. The UE should send this |
| * indication as well, as it is a RAT switch. |
| * 5. The UE enter IDLE mode, and later connected mode in ENDC. There are no changes to security |
| * algorithms, so the modem does not need to send any updates. |
| * |
| * Most recently reported state is reset when (1) RadioState is transitioned to ON from any |
| * other state (e.g. radio is turned on during device boot, or modem boot), and (2) when |
| * CardState is transitioned to PRESENT from any other state (e.g. when SIM is inserted), or (3) |
| * if there is a change in access network (PLMN) or RAT. |
| * |
| * securityAlgorithmUpdate indications must be sent to Android regardless of the screen state. |
| * If the screen is off, the indications must still be sent to Android. |
| * |
| * |
| * 5G TS 38.331 cipheringDisabled and integrityProtection |
| * ====================================================== |
| * For most connections, generally what is reported by the network is what ends up being used. |
| * There are two significant cases where this may not be the case. In 5G, per the introduction |
| * of network configuration options cipheringDisabled and integrityProtection (TS 38.331), the |
| * network can have declared certain security algorithms to be used while also requiring a null |
| * algorithm via those parameters. |
| * |
| * |
| * Exceptions for DRBs with null integrity (pre-5G Rel 16) |
| * ======================================================= |
| * When reporting the SecurityAlgorithm for a ConnectionType which includes a DRB, there is an |
| * exception where a DRB with null integrity is not to be considered/included in reporting |
| * except for 5G Rel 16 connections and newer. Because DRBs almost always use null integrity in |
| * practice, and thus if included the report would always be null, rendering the report |
| * useless. For anything 5G Rel 16 or newer, accurate reporting for the DRB's integrity is |
| * required. |
| * |
| * |
| * NRDC MCG and SCGs |
| * ================= |
| * In the NRDC case, there can be two sets of algorithms, one for the MCG (Master Cell Group) |
| * and one for the SCG (Secondary Cell Group). In this case, always send a combined update that |
| * reflects the weaker of the algorithms, e.g. (weakest) NEA0 < NEA1 < NEA2 < NEA3 (strongest). |
| * This applies to both the ciphering and integrity algorithms. |
| * |
| * |
| * Determining the value of isUnprotectedEmergency |
| * =============================================== |
| * - 2G ConnectionEvents: |
| * - For CS_SIGNALLING_GSM and PS_SIGNALLING_GPRS isUnprotectedEmergency is true if emergency |
| * mode is ongoing and the ciphering algorithm is NULL (A5/0). |
| * - 3G ConnectionEvents: |
| * - For CS_SIGNALLING_3G and PS_SIGNALLING_3G isUnprotectedEmergency is true if emergency |
| * mode is ongoing and the ciphering OR integrity algorithms are NULL (UEA0 or UIA0). |
| * - 4G ConnectionEvents: |
| * - For NAS_SIGNALLING_LTE, isUnprotectedEmergency is true if emergency mode is ongoing and |
| * ciphering OR integrity are NULL (EEA0 or EIA0). |
| * - For AS_SIGNALLING_LTE, isUnprotectedEmergency is true if emergency mode is ongoing and |
| * a null encryption algorithm is used (EEA0). |
| * - For VOLTE_SIP, isUnprotectedEmergency is true if (1) emergency call is over IMS PDN, AND |
| * (2) IPSec configuration is absent (SIP_NO_IPSEC_CONFIG) OR NULL encryption OR NULL |
| * integrity algorithms are in use (e.g. SIP_NULL). |
| * - For VOLTE_SIP_SOS, isUnprotectedEmergency is true if (1) emergency call is over |
| * emergency IMS PDN, AND (2) IPSec configuration is absent (SIP_NO_IPSEC_CONFIG) OR NULL |
| * encryption OR NULL integrity algorithm are in use (e.g. SIP_NULL). |
| * - For VOLTE_RTP, isUnprotectedEmergency is true if (1) emergency call is over normal PDN, |
| * and (2) SRTP is not utilized (e.g. RTP or SRTP_NULL enums) OR NULL encryption OR NULL |
| * integrity algorithms are used. |
| * - For VOLTE_RTP_SOS, isUnprotectedEmergency is true if (1) emergency call is over |
| * emergency IMS PDN, and (2) SRTP is not utilized (RTP or SRTP_NULL enums) OR NULL |
| * encryption OR NULL integrity algorithms are used. |
| * - 5G ConnectionEvents: |
| * - For NAS_SIGNALLING_5G, isUnprotectedEmergency is true if emergency mode is ongoing and |
| * NULL encryption OR NULL integrity are used (e.g. NEA0 or NIA0). |
| * - For AS_SIGNALLING_5G, isUnprotectedEmergency is true if emergency mode is ongoing and |
| * a NULL encryption algorithm us used (e.g. NEA0). |
| * - For VONR_SIP, isUnprotectedEmergency is true if (1) emergency call is over normal IMS |
| * PDN, AND (2) IPSec configuration is absent OR NULL encryption or NULL integrity |
| * algorithms are used. |
| * - For VONR_SIP_SOS, isUnprotectedEmergency is true if (1) emergency call is over emergency |
| * IMS PDN, and (2) IPSec configuration is absent OR NULL encryption or NULL integrity |
| * algorithm is used. |
| * - For VONR_RTP, isUnprotectedEmergency is true if (1) emergency call is over normal IMS |
| * PDN, AND (2) SRTP is not utilized OR NULL encryption OR NULL integrity algorithm is used |
| * - For VONR_RTP_SOS, isUnprotectedEmergency is true if (1) Emergency call is over emergency |
| * IMS PDN, AND (2) SRTP is not utilized OR NULL encryption OR NULL integrity algorithm is |
| * used. |
| * Notes: |
| * - On integrity: In 4G, PDCP can be LTE-based or NR-based. Starting from 5G Rel 17, only |
| * the NR-based PDCP supports DRB integrity. As the PDCP version can change during a DRB's |
| * operation, it becomes complicated when integrity is used to determine whether an |
| * emergency call is protected or not, hence its exclusion to simplify implementation. |
| * - 4G and 5G with multiple DRBs : emergency calls are protected under that RAT only if all |
| * SRBs and DRBs are protected (including IMS DRB). |
| * - 4G and 5G DRB integrity: Since DRB integrity is not enabled in most networks, if both |
| * ciphering and integrity are taken into account to determine the value of |
| * isUnprotectedEmergency, the value will mostly be false, hence why it is excluded. |
| * |
| * @param type Type of radio indication |
| * @param securityAlgorithmUpdate SecurityAlgorithmUpdate encapsulates details of security |
| * algorithm updates |
| */ |
| void securityAlgorithmsUpdated( |
| in RadioIndicationType type, in SecurityAlgorithmUpdate securityAlgorithmUpdate); |
| |
| /** |
| * Indicates that the modem suggests display network type has changed. |
| * |
| * This unsolicited indication is sent by the modem to the framework whenever |
| * it determines that the user-facing representation of the network service |
| * (e.g., "5G+", "5G UW", "5G UC") should be updated. |
| * |
| * The Android framework, upon receiving this indication, should evaluate the |
| * new {@link DisplayNetworkType}. If the feature is enabled (e.g., via the |
| * {@code KEY_USE_MODEM_DISPLAY_NETWORK_TYPE_BOOL} carrier configuration), |
| * the framework should update the network indicator icon and related text in the UI |
| * accordingly. |
| * |
| * @param type The type of indication, which will be {@link RadioIndicationType#UNSOLICITED} |
| * for this message. |
| * @param dnt The new display network type category suggested by the modem. |
| * @hide |
| */ |
| void displayNetworkTypeChanged(in RadioIndicationType type, in DisplayNetworkType dnt); |
| } |
