1/*
2 * Copyright (C) 2017 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.2;
18
19import @1.1::IRadio;
20import @1.1::RadioAccessNetworks;
21import @1.0::DataProfileInfo;
22import @1.0::RadioTechnology;
23
24/**
25 * This interface is used by telephony and telecom to talk to cellular radio.
26 * All the functions have minimum one parameter:
27 * serial: which corresponds to serial no. of request. Serial numbers must only be memorized for the
28 * duration of a method call. If clients provide colliding serials (including passing the same
29 * serial to different methods), multiple responses (one for each method call) must still be served.
30 * setResponseFunctions must work with @1.1::IRadioResponse and @1.1::IRadioIndication.
31 */
32interface IRadio extends @1.1::IRadio {
33
34    /**
35     * Starts a network scan
36     *
37     * @param serial Serial number of request.
38     * @param request Defines the radio networks/bands/channels which need to be scanned.
39     *
40     * Response function is IRadioResponse.startNetworkScanResponse()
41     */
42    oneway startNetworkScan_1_2(int32_t serial, NetworkScanRequest request);
43
44    /**
45     * Sets the indication filter.
46     *
47     * Prevents the reporting of specified unsolicited indications from the radio. This is used
48     * for power saving in instances when those indications are not needed. If unset, defaults to
49     * @1.2::IndicationFilter:ALL.
50     *
51     * @param serial Serial number of request.
52     * @param indicationFilter 32-bit bitmap of IndicationFilter. Bits set to 1 indicate the
53     *     indications are enabled. See @1.2::IndicationFilter for the definition of each bit.
54     *
55     * Response callback is IRadioResponse.setIndicationFilterResponse()
56     */
57    oneway setIndicationFilter_1_2(int32_t serial, bitfield<IndicationFilter> indicationFilter);
58
59    /**
60     * Sets the signal strength reporting criteria.
61     *
62     * The resulting reporting rules are the AND of all the supplied criteria. For each RAN
63     * The thresholdsDbm and hysteresisDb apply to only the following measured quantities:
64     * -GERAN    - RSSI
65     * -CDMA2000 - RSSI
66     * -UTRAN    - RSCP
67     * -EUTRAN   - RSRP
68     *
69     * Note: Reporting criteria must be individually set for each RAN. For any unset reporting
70     * criteria, the value is implementation-defined.
71     *
72     * Note: As this mechanism generally only constrains reports based on one measured quantity per
73     * RAN, if multiple measured quantities must be used to trigger a report for a given RAN, the
74     * only valid field may be hysteresisMs: hysteresisDb and thresholdsDbm must be set to zero and
75     * length zero respectively. If either hysteresisDb or thresholdsDbm is set, then reports shall
76     * only be triggered by the respective measured quantity, subject to the applied constraints.
77     *
78     * Response callback is IRadioResponse.setSignalStrengthReportingCriteriaResponse()
79     *
80     * @param serial Serial number of request.
81     * @param hysteresisMs A hysteresis time in milliseconds to prevent flapping. A value of 0
82     *     disables hysteresis.
83     * @param hysteresisDb An interval in dB defining the required magnitude change between reports.
84     *     hysteresisDb must be smaller than the smallest threshold delta. An interval value of 0
85     *     disables hysteresis.
86     * @param thresholdsDbm A vector of trigger thresholds in dBm. A vector size of 0 disables the
87     *     use of thresholds for reporting.
88     * @param accessNetwork The type of network for which to apply these thresholds.
89     */
90    oneway setSignalStrengthReportingCriteria(int32_t serial, int32_t hysteresisMs,
91            int32_t hysteresisDb, vec<int32_t> thresholdsDbm, AccessNetwork accessNetwork);
92
93    /**
94     * Sets the link capacity reporting criteria.
95     *
96     * The resulting reporting criteria are the AND of all the supplied criteria.
97     *
98     * Note: Reporting criteria must be individually set for each RAN. If unset, reporting criteria
99     * for that RAN are implementation-defined.
100     *
101     * Response callback is IRadioResponse.setLinkCapacityReportingCriteriaResponse().
102     *
103     * @param serial Serial number of request.
104     * @param hysteresisMs A hysteresis time in milliseconds to prevent flapping. A value of 0
105     *     disables hysteresis.
106     * @param hysteresisDlKbps An interval in kbps defining the required magnitude change between DL
107     *     reports. hysteresisDlKbps must be smaller than the smallest threshold delta. A value of 0
108     *     disables hysteresis.
109     * @param hysteresisUlKbps An interval in kbps defining the required magnitude change between UL
110     *     reports. hysteresisUlKbps must be smaller than the smallest threshold delta. A value of 0
111     *     disables hysteresis.
112     * @param thresholdsDownlinkKbps A vector of trigger thresholds in kbps for downlink reports. A
113     *     vector size of 0 disables the use of DL thresholds for reporting.
114     * @param thresholdsUplinkKbps A vector of trigger thresholds in kbps for uplink reports. A
115     *     vector size of 0 disables the use of UL thresholds for reporting.
116     * @param accessNetwork The type of network for which to apply these thresholds.
117     */
118    oneway setLinkCapacityReportingCriteria(int32_t serial, int32_t hysteresisMs,
119            int32_t hysteresisDlKbps, int32_t hysteresisUlKbps, vec<int32_t> thresholdsDownlinkKbps,
120            vec<int32_t> thresholdsUplinkKbps, AccessNetwork accessNetwork);
121
122    /**
123     * Setup a packet data connection. If DataCallResponse.status returns DataCallFailCause:NONE,
124     * the data connection must be added to data calls and a unsolDataCallListChanged() must be
125     * sent. The call remains until removed by subsequent unsolDataCallIstChanged(). It may be
126     * lost due to many factors, including deactivateDataCall() being issued, the radio powered
127     * off, reception lost or even transient factors like congestion. This data call list is
128     * returned by getDataCallList() and dataCallListChanged().
129     *
130     * The Radio is expected to:
131     *   - Create one data call context.
132     *   - Create and configure a dedicated interface for the context.
133     *   - The interface must be point to point.
134     *   - The interface is configured with one or more addresses and is capable of sending and
135     *     receiving packets. The prefix length of the addresses must be /32 for IPv4 and /128
136     *     for IPv6.
137     *   - Must not modify routing configuration related to this interface; routing management is
138     *     exclusively within the purview of the Android OS.
139     *   - Support simultaneous data call contexts up to DataRegStateResult.maxDataCalls specified
140     *     in the response of getDataRegistrationState.
141     *
142     * @param serial Serial number of request.
143     * @param accessNetwork The access network to setup the data call. If the data connection cannot
144     *     be established on the specified access network, the setup request must be failed.
145     * @param dataProfileInfo Data profile info.
146     * @param modemCognitive Indicates that the requested profile has previously been provided via
147     *     setDataProfile().
148     * @param roamingAllowed Indicates whether or not data roaming is allowed by the user.
149     * @param isRoaming Indicates whether or not the framework has requested this setupDataCall for
150     *     a roaming network. The 'protocol' parameter in the old RIL API must be filled
151     *     accordingly based on the roaming condition. Note this is for backward compatibility with
152     *     the old radio modem. The modem must not use this param for any other reason.
153     * @param reason The request reason. Must be DataRequestReason.NORMAL or
154     *     DataRequestReason.HANDOVER.
155     * @param addresses If the reason is DataRequestReason.HANDOVER, this indicates the list of link
156     *     addresses of the existing data connection. The format is IP address with optional "/"
157     *     prefix length (The format is defined in RFC-4291 section 2.3). For example, "192.0.1.3",
158     *     "192.0.1.11/16", or "2001:db8::1/64". Typically one IPv4 or one IPv6 or one of each. If
159     *     the prefix length is absent, then the addresses are assumed to be point to point with
160     *     IPv4 with prefix length 32 or IPv6 with prefix length 128. This parameter must be ignored
161     *     unless reason is DataRequestReason.HANDOVER.
162     * @param dnses If the reason is DataRequestReason.HANDOVER, this indicates the list of DNS
163     *     addresses of the existing data connection. The format is defined in RFC-4291 section
164     *     2.2. For example, "192.0.1.3" or "2001:db8::1". This parameter must be ignored unless
165     *     reason is DataRequestReason.HANDOVER.
166     *
167     * Response function is IRadioResponse.setupDataCallResponse()
168     */
169    oneway setupDataCall_1_2(int32_t serial, AccessNetwork accessNetwork,
170            DataProfileInfo dataProfileInfo, bool modemCognitive, bool roamingAllowed,
171            bool isRoaming, DataRequestReason reason, vec<string> addresses, vec<string> dnses);
172
173    /**
174     * Deactivate packet data connection and remove from the data call list. An
175     * unsolDataCallListChanged() must be sent when data connection is deactivated.
176     *
177     * @param serial Serial number of request.
178     * @param cid Data call id.
179     * @param reason The request reason. Must be normal, handover, or shutdown.
180     *
181     * Response function is IRadioResponse.deactivateDataCallResponse()
182     */
183    oneway deactivateDataCall_1_2(int32_t serial, int32_t cid, DataRequestReason reason);
184};
185