Deprecates obsoleted radio hal interfaces

Makes a ABI preserving change to radio hal by adding deprecation comments for following interfaces: - startLceService - stopLceService - pullLceData - lceData - setSimCardPower - setIndicationFilter - setupDataCall - deactivateDataCall - startNetworkScan - startNetworkScan_1_2 Bug: 170288130 Test: make Merged-In: I4563b7081dec6fa64b7faff7c8e3c2c3b1239880 Change-Id: I4563b7081dec6fa64b7faff7c8e3c2c3b1239880 (cherry picked from commit 1fd7cb029b)
2021-02-18 20:55:26 -08:00 · 2021-02-18 20:55:26 -08:00 · b6e354680f
commit b6e354680f
parent 98bdd3c979
7 changed files with 53 additions and 17 deletions
--- a/current.txt
+++ b/current.txt
@ -783,6 +783,12 @@ b9fbb6e2e061ed0960939d48b785e9700210add1f13ed32ecd688d0f1ca20ef7 android.hardwar
 0f53d70e1eadf8d987766db4bf6ae2048004682168f4cab118da576787def3fa android.hardware.radio@1.0::types
 38d65fb20c60a5b823298560fc0825457ecdc49603a4b4e94bf81511790737da android.hardware.radio@1.4::types
 954c334efd80e8869b66d1ce5fe2755712d96ba4b3c38d415739c330af5fb4cb android.hardware.radio@1.5::types
+cfaab0e45c5d7b3595032d649da29ed712e920f956c13671efd35602fa81c923 android.hardware.radio@1.0::IRadio
+89d78fa49b09e2f31812bb63e1bfac2bf318a9561473c6b0ed6904ce18377d54 android.hardware.radio@1.0::IRadioIndication
+bc3c8c233085fca3879dc74b490b9e5bc1063258470d3b4c12f7a74bf215cbbd android.hardware.radio@1.0::IRadioResponse
+86fb079a600b2301a752249dfbfc53983a795d752f11aabcb68315a189f6c9a2 android.hardware.radio@1.1::IRadio
+00366b2f88f9ec2458014972938270c8413d4ab303218e37bf3add2b8e6b829a android.hardware.radio@1.1::IRadioResponse
+2b5afef68e3e2ff1dab63e4f2ee57337ef2635ec812f49080cadfce966d33b52 android.hardware.radio@1.2::IRadio

 # HALs released in Android S
 # NOTE: waiting to freeze HALs until later in the release
--- a/radio/1.0/IRadio.hal
+++ b/radio/1.0/IRadio.hal
@ -385,7 +385,10 @@ interface IRadio {
     *                  Note this is for backward compatibility with the old radio modem. The modem
     *                  must not use this param for any other reason.
     *
-     * Response function is IRadioResponse.setupDataCallResponse()
+     * Response function is IRadioResponse.setupDataCallResponse() which may return
+     * RadioError:REQUEST_NOT_SUPPORTED if @1.2::IRadio or higher is supported.
+     *
+     * DEPRECATED in @1.2 or higher, use @1.2::IRadio.setupDataCall_1_2() instead.
     */
    oneway setupDataCall(int32_t serial, RadioTechnology radioTechnology,
            DataProfileInfo dataProfileInfo, bool modemCognitive, bool roamingAllowed,
@ -546,7 +549,10 @@ interface IRadio {
     *        false => No specific reason specified
     *        true => Radio shutdown requested
     *
-     * Response function is IRadioResponse.deactivateDataCallResponse()
+     * Response function is IRadioResponse.deactivateDataCallResponse() which may return
+     * RadioError:REQUEST_NOT_SUPPORTED if @1.2::IRadio or higher is supported.
+     *
+     * DEPRECATED in @1.2 or higher, use @1.2::IRadio.deactivateDataCall_1_2() instead.
     */
    oneway deactivateDataCall(int32_t serial, int32_t cid,
            bool reasonRadioShutDown);
@ -1456,7 +1462,10 @@ interface IRadio {
     * @param reportInterval desired reporting interval (ms).
     * @param pullMode LCE service mode. true: PULL; false: PUSH.
     *
-     * Response callback is IRadioResponse.startLceServiceResponse()
+     * Response callback is IRadioResponse.startLceServiceResponse() which may return
+     * RadioError:REQUEST_NOT_SUPPORTED if @1.2::IRadio or higher is supported.
+     *
+     * DEPRECATED in @1.2 or higher which use the always-on LCE that relies on indications.
     */
    oneway startLceService(int32_t serial, int32_t reportInterval, bool pullMode);

@ -1466,7 +1475,10 @@ interface IRadio {
     *
     * @param serial Serial number of request.
     *
-     * Response callback is IRadioResponse.stopLceServiceResponse()
+     * Response callback is IRadioResponse.stopLceServiceResponse() which may return
+     * RadioError:REQUEST_NOT_SUPPORTED if @1.2::IRadio or higher is supported.
+     *
+     * DEPRECATED in @1.2 or higher which use the always-on LCE that relies on indications.
     */
    oneway stopLceService(int32_t serial);

@ -1475,7 +1487,10 @@ interface IRadio {
     *
     * @param serial Serial number of request.
     *
-     * Response callback is IRadioResponse.pullLceDataResponse()
+     * Response callback is IRadioResponse.pullLceDataResponse() which may return
+     * RadioError:REQUEST_NOT_SUPPORTED if @1.2::IRadio or higher is supported.
+     *
+     * DEPRECATED in @1.2 or higher which use the always-on LCE that relies on indications.
     */
    oneway pullLceData(int32_t serial);

@ -1546,7 +1561,10 @@ interface IRadio {
     * @param indicationFilter 32-bit bitmap of IndicationFilter. Bits set to 1 indicate the
     *        indications are enabled. See IndicationFilter for the definition of each bit.
     *
-     * Response callback is IRadioResponse.setIndicationFilterResponse()
+     * Response callback is IRadioResponse.setIndicationFilterResponse() which may return
+     * RadioError:REQUEST_NOT_SUPPORTED if @1.2::IRadio or higher is supported.
+     *
+     * DEPRECATED in @1.2 or higher, use @1.2::IRadio.setIndicationFilter_1_2() instead.
     */
    oneway setIndicationFilter(int32_t serial, bitfield<IndicationFilter> indicationFilter);

@ -1560,7 +1578,10 @@ interface IRadio {
     * @param serial Serial number of request
     * @param powerUp True if powering up the sim card
     *
-     * Response callback is IRadioResponse.setSimCardPowerResponse()
+     * Response callback is IRadioResponse.setSimCardPowerResponse() which may return
+     * RadioError:REQUEST_NOT_SUPPORTED if @1.1::IRadio or higher is supported.
+     *
+     * DEPRECATED in @1.1 or higher, use @1.1::IRadio.setSimCardPower_1_1() instead.
     */
    oneway setSimCardPower(int32_t serial, bool powerUp);

--- a/radio/1.0/IRadioIndication.hal
+++ b/radio/1.0/IRadioIndication.hal
@ -427,6 +427,9 @@ interface IRadioIndication {
    *
    * @param type Type of radio indication
    * @param lce LceData information
+    *
+    * DEPRECATED in @1.2 and above, use
+    * @1.2::IRadioIndication.currentLinkCapacityEstimate() instead.
    */
   oneway lceData(RadioIndicationType type, LceDataInfo lce);

--- a/radio/1.0/IRadioResponse.hal
+++ b/radio/1.0/IRadioResponse.hal
@ -590,10 +590,10 @@ interface IRadioResponse {
     *   RadioError:NONE must be returned on both success and failure of setup with the
     *              DataCallResponse.status containing the actual status
     *              For all other errors the DataCallResponse is ignored.
+     *   RadioError:REQUEST_NOT_SUPPORTED may be returned when HAL 1.2 or higher is supported.
     *   RadioError:RADIO_NOT_AVAILABLE
     *   RadioError:OP_NOT_ALLOWED_BEFORE_REG_TO_NW
     *   RadioError:OP_NOT_ALLOWED_DURING_VOICE_CALL
-     *   RadioError:REQUEST_NOT_SUPPORTED
     *   RadioError:INVALID_ARGUMENTS
     *   RadioError:INTERNAL_ERR
     *   RadioError:NO_MEMORY
@ -856,12 +856,12 @@ interface IRadioResponse {
     * @param info Response info struct containing response type, serial no. and error
     *
     * Valid errors returned:
+     *   RadioError:REQUEST_NOT_SUPPORTED may be returned when HAL 1.2 or higher is supported.
     *   RadioError:NONE
     *   RadioError:RADIO_NOT_AVAILABLE
     *   RadioError:INVALID_CALL_ID
     *   RadioError:INVALID_STATE
     *   RadioError:INVALID_ARGUMENTS
-     *   RadioError:REQUEST_NOT_SUPPORTED
     *   RadioError:INTERNAL_ERR
     *   RadioError:NO_MEMORY
     *   RadioError:NO_RESOURCES
@ -2420,11 +2420,11 @@ interface IRadioResponse {
     * @param statusInfo LceStatusInfo indicating LCE status
     *
     * Valid errors returned:
+     *   RadioError:REQUEST_NOT_SUPPORTED may be returned when HAL 1.2 or higher is supported.
     *   RadioError:NONE
     *   RadioError:RADIO_NOT_AVAILABLE
     *   RadioError:LCE_NOT_SUPPORTED
     *   RadioError:INTERNAL_ERR
-     *   RadioError:REQUEST_NOT_SUPPORTED
     *   RadioError:NO_MEMORY
     *   RadioError:NO_RESOURCES
     *   RadioError:CANCELLED
@ -2436,6 +2436,7 @@ interface IRadioResponse {
     * @param statusInfo LceStatusInfo indicating LCE status
     *
     * Valid errors returned:
+     *   RadioError:REQUEST_NOT_SUPPORTED may be returned when HAL 1.2 or higher is supported.
     *   RadioError:NONE
     *   RadioError:RADIO_NOT_AVAILABLE
     *   RadioError:LCE_NOT_SUPPORTED
@ -2443,7 +2444,6 @@ interface IRadioResponse {
     *   RadioError:NO_MEMORY
     *   RadioError:NO_RESOURCES
     *   RadioError:CANCELLED
-     *   RadioError:REQUEST_NOT_SUPPORTED
     *   RadioError:SIM_ABSENT
     */
    oneway stopLceServiceResponse(RadioResponseInfo info, LceStatusInfo statusInfo);
@ -2453,6 +2453,7 @@ interface IRadioResponse {
     * @param lceInfo LceDataInfo indicating LCE data as defined in types.hal
     *
     * Valid errors returned:
+     *   RadioError:REQUEST_NOT_SUPPORTED may be returned when HAL 1.2 or higher is supported.
     *   RadioError:NONE
     *   RadioError:RADIO_NOT_AVAILABLE
     *   RadioError:LCE_NOT_SUPPORTED
@ -2460,7 +2461,6 @@ interface IRadioResponse {
     *   RadioError:NO_MEMORY
     *   RadioError:NO_RESOURCES
     *   RadioError:CANCELLED
-     *   RadioError:REQUEST_NOT_SUPPORTED
     *   RadioError:SIM_ABSENT
     */
    oneway pullLceDataResponse(RadioResponseInfo info, LceDataInfo lceInfo);
@ -2534,13 +2534,13 @@ interface IRadioResponse {
     * @param info Response info struct containing response type, serial no. and error
     *
     * Valid errors returned:
+     *   RadioError:REQUEST_NOT_SUPPORTED may be returned when HAL 1.2 or higher is supported.
     *   RadioError:NONE
     *   RadioError:INVALID_ARGUMENTS
     *   RadioError:RADIO_NOT_AVAILABLE
     *   RadioError:NO_MEMORY
     *   RadioError:INTERNAL_ERR
     *   RadioError:SYSTEM_ERR
-     *   RadioError:REQUEST_NOT_SUPPORTED
     *   RadioError:NO_RESOURCES
     *   RadioError:CANCELLED
     */
@ -2550,9 +2550,9 @@ interface IRadioResponse {
     * @param info Response info struct containing response type, serial no. and error
     *
     * Valid errors returned:
+     *   RadioError:REQUEST_NOT_SUPPORTED may be returned when HAL 1.1 or higher is supported.
     *   RadioError:NONE
     *   RadioError:RADIO_NOT_AVAILABLE
-     *   RadioError:REQUEST_NOT_SUPPORTED
     *   RadioError:INVALID_ARGUMENTS
     *   RadioError:INTERNAL_ERR
     *   RadioError:NO_MEMORY
--- a/radio/1.1/IRadio.hal
+++ b/radio/1.1/IRadio.hal
@ -77,7 +77,10 @@ interface IRadio extends @1.0::IRadio {
     * @param serial Serial number of request.
     * @param request Defines the radio networks/bands/channels which need to be scanned.
     *
-     * Response function is IRadioResponse.startNetworkScanResponse()
+     * Response function is IRadioResponse.startNetworkScanResponse() which may return
+     * RadioError:REQUEST_NOT_SUPPORTED if @1.2::IRadio or higher is supported.
+     *
+     * DEPRECATED in @1.2 or higher, use @1.2::IRadio.startNetworkScan_1_2() instead.
     */
    oneway startNetworkScan(int32_t serial, NetworkScanRequest request);

--- a/radio/1.1/IRadioResponse.hal
+++ b/radio/1.1/IRadioResponse.hal
@ -51,6 +51,7 @@ interface IRadioResponse extends @1.0::IRadioResponse {
     * @param info Response info struct containing response type, serial no. and error
     *
     * Valid errors returned:
+     *   RadioError:REQUEST_NOT_SUPPORTED may be returned when HAL 1.2 or higher is supported.
     *   RadioError:NONE
     *   RadioError:RADIO_NOT_AVAILABLE
     *   RadioError:OPERATION_NOT_ALLOWED
@ -59,7 +60,6 @@ interface IRadioResponse extends @1.0::IRadioResponse {
     *   RadioError:NO_MEMORY
     *   RadioError:MODEM_ERR
     *   RadioError:INVALID_ARGUMENTS
-     *   RadioError:REQUEST_NOT_SUPPORTED
     */
    oneway startNetworkScanResponse(RadioResponseInfo info);

--- a/radio/1.2/IRadio.hal
+++ b/radio/1.2/IRadio.hal
@ -37,7 +37,10 @@ interface IRadio extends @1.1::IRadio {
     * @param serial Serial number of request.
     * @param request Defines the radio networks/bands/channels which need to be scanned.
     *
-     * Response function is IRadioResponse.startNetworkScanResponse()
+     * Response function is IRadioResponse.startNetworkScanResponse() which may return
+     * RadioError:REQUEST_NOT_SUPPORTED if @1.4::IRadio or higher is supported.
+     *
+     * DEPRECATED in @1.4 or higher, use @1.4::IRadio.startNetworkScan_1_4() instead.
     */
    oneway startNetworkScan_1_2(int32_t serial, NetworkScanRequest request);