• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (C) 2019 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.5;
18
19import @1.0::RadioIndicationType;
20import @1.4::IRadioIndication;
21
22/**
23 * Interface declaring unsolicited radio indications.
24 */
25interface IRadioIndication extends @1.4::IRadioIndication {
26    /**
27     * Report change of whether uiccApplications are enabled, or disabled.
28     *
29     * @param type Type of radio indication
30     * @param enabled whether uiccApplications are enabled, or disabled
31     */
32    oneway uiccApplicationsEnablementChanged(RadioIndicationType type, bool enabled);
33
34    /**
35     * Report that Registration or a Location/Routing/Tracking Area update has failed.
36     *
37     * <p>Indicate whenever a registration procedure, including a location, routing, or tracking
38     * area update fails. This includes procedures that do not necessarily result in a change of
39     * the modem's registration status. If the modem's registration status changes, that is
40     * reflected in the onNetworkStateChanged() and subsequent get{Voice/Data}RegistrationState().
41     *
42     * @param cellIdentity the CellIdentity, which must include the globally unique identifier for
43     *        the cell (for example, all components of the CGI or ECGI).
44     * @param chosenPlmn a 5 or 6 digit alphanumeric PLMN (MCC|MNC) among those broadcast by the
45     *        cell that was chosen for the failed registration attempt.
46     * @param domain Domain::CS, Domain::PS, or both in case of a combined procedure.
47     * @param causeCode the primary failure cause code of the procedure.
48     *        For GSM/UMTS (MM), values are in TS 24.008 Sec 10.5.95
49     *        For GSM/UMTS (GMM), values are in TS 24.008 Sec 10.5.147
50     *        For LTE (EMM), cause codes are TS 24.301 Sec 9.9.3.9
51     *        For NR (5GMM), cause codes are TS 24.501 Sec 9.11.3.2
52     *        MAX_INT if this value is unused.
53     * @param additionalCauseCode the cause code of any secondary/combined procedure if appropriate.
54     *        For UMTS, if a combined attach succeeds for PS only, then the GMM cause code shall be
55     *        included as an additionalCauseCode.
56     *        For LTE (ESM), cause codes are in TS 24.301 9.9.4.4
57     *        MAX_INT if this value is unused.
58     */
59    oneway registrationFailed(
60            RadioIndicationType type, CellIdentity cellIdentity, string chosenPlmn,
61            bitfield<Domain> domain, int32_t causeCode, int32_t additionalCauseCode);
62
63    /**
64     * Indicate barring information for the user’s access category / access class and PLMN.
65     *
66     * <p>Provide information about the barring status of the cell for the user. The information
67     * provided should describe all barring configurations that are applicable to the current user,
68     * even if the user is not currently barred (due to conditional barring). This informs Android
69     * of likely future (statistical) barring for specific services.
70     *
71     * <p>This indication should be sent whenever the cell’s barring config changes for the current
72     * user, or if the user’s conditional barring status changes due to re-evaluation of the
73     * barring conditions. Barring status will likely change when the device camps for service,
74     * when PLMN selection is completed, when the device attempts to access a conditionally barred
75     * service, and when the System Information including barring info for a camped cell is updated.
76     */
77    oneway barringInfoChanged(
78            RadioIndicationType type, CellIdentity cellIdentity, vec<BarringInfo> barringInfos);
79
80    /**
81     * Report all of the current cell information known to the radio.
82     *
83     * This indication is updated from IRadioIndication@1.4 to report the @1.5 version of
84     * CellInfo.
85     *
86     * @param type Type of radio indication
87     * @param records Current cell information
88     */
89    oneway cellInfoList_1_5(RadioIndicationType type, vec<CellInfo> records);
90
91    /**
92     * Incremental network scan results.
93     *
94     * This indication is updated from IRadioIndication@1.4 to report the @1.5 version of
95     * CellInfo.
96     */
97    oneway networkScanResult_1_5(RadioIndicationType type, NetworkScanResult result);
98
99    /**
100     * Indicates data call contexts have changed.
101     *
102     * This indication is updated from IRadioIndication@1.4 to report the @1.5 version of
103     * SetupDataCallResult.
104     *
105     * @param type Type of radio indication
106     * @param dcList Array of SetupDataCallResult identical to that returned by
107     *        IRadio.getDataCallList(). It is the complete list of current data contexts including
108     *        new contexts that have been activated. A data call is only removed from this list
109     *        when below conditions matched.
110     *        1. The framework sends a IRadio.deactivateDataCall().
111     *        2. The radio is powered off/on.
112     *        3. Unsolicited disconnect from either modem or network side.
113     */
114    oneway dataCallListChanged_1_5(RadioIndicationType type, vec<SetupDataCallResult> dcList);
115};
116