Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 10d496a8 authored by Hakjun Choi's avatar Hakjun Choi
Browse files

Clean up satellite provision APIS 

1) report current status on callback registration
2) No need to have vendors implement provision related apis. We can remove these interfaces
3) store provision status in persistent memory in sim table

Bug: 348272056
Flag: com.android.internal.telephony.flags.carrier_roaming_nb_iot_ntn
Test: atest SatelliteControllerTest, SatelliteSOSMessageRecommenderTest,
SubscriptionDatabaseManagerTest, SubscriptionInfoInternalTest
Test: manual e2e test with several times of provision/deprovision then
check SIM DB

Change-Id: I321488084640f8fd4580c182b65081c5c2ae871f
parent fabd0108

core/java/android/provider/Telephony.java

+12 −1
Original line number Diff line number Diff line
@@ -4985,6 +4985,16 @@ public final class Telephony { 
         */

        public static final String COLUMN_SATELLITE_ESOS_SUPPORTED = "satellite_esos_supported";



        /**

         * TelephonyProvider column name for satellite provisioned status. The value of this

         * column is set based on whether carrier roaming or OEM-enabled NB-IOT satellite service is

         * provisioned or not. By default, it's disabled.

         *

         * @hide

         */

        public static final String COLUMN_IS_SATELLITE_PROVISIONED_FOR_NON_IP_DATAGRAM =

                "is_satellite_provisioned_for_non_ip_datagram";



        /** All columns in {@link SimInfo} table. */

        private static final List<String> ALL_COLUMNS = List.of(

                COLUMN_UNIQUE_KEY_SUBSCRIPTION_ID,
@@ -5061,7 +5071,8 @@ public final class Telephony { 
                COLUMN_TRANSFER_STATUS,

                COLUMN_SATELLITE_ENTITLEMENT_STATUS,

                COLUMN_SATELLITE_ENTITLEMENT_PLMNS,

                COLUMN_SATELLITE_ESOS_SUPPORTED

                COLUMN_SATELLITE_ESOS_SUPPORTED,

                COLUMN_IS_SATELLITE_PROVISIONED_FOR_NON_IP_DATAGRAM

        );



        /**

telephony/java/android/telephony/SubscriptionManager.java

+10 −0
Original line number Diff line number Diff line
@@ -1177,6 +1177,16 @@ public class SubscriptionManager { 
     */

    public static final String SATELLITE_ESOS_SUPPORTED = SimInfo.COLUMN_SATELLITE_ESOS_SUPPORTED;



    /**

     * TelephonyProvider column name for satellite provisioned status. The value of this

     * column is set based on whether carrier roaming NB-IOT satellite service is provisioned or

     * not. By default, it's disabled.

     *

     * @hide

     */

    public static final String IS_SATELLITE_PROVISIONED_FOR_NON_IP_DATAGRAM =

            SimInfo.COLUMN_IS_SATELLITE_PROVISIONED_FOR_NON_IP_DATAGRAM;



    /** @hide */

    @Retention(RetentionPolicy.SOURCE)

    @IntDef(prefix = {"USAGE_SETTING_"},

telephony/java/android/telephony/satellite/stub/ISatellite.aidl

+0 −71
Original line number Diff line number Diff line
@@ -205,77 +205,6 @@ oneway interface ISatellite { 
     */

    void stopSendingSatellitePointingInfo(in IIntegerConsumer resultCallback);



    /**

     * Provision the device with a satellite provider.

     * This is needed if the provider allows dynamic registration.

     * Once provisioned, ISatelliteListener#onSatelliteProvisionStateChanged should report true.

     *

     * @param token The token to be used as a unique identifier for provisioning with satellite

     *              gateway.

     * @param provisionData Data from the provisioning app that can be used by provisioning server

     * @param resultCallback The callback to receive the error code result of the operation.

     *

     * Valid result codes returned:

     *   SatelliteResult:SATELLITE_RESULT_SUCCESS

     *   SatelliteResult:SATELLITE_RESULT_SERVICE_ERROR

     *   SatelliteResult:SATELLITE_RESULT_MODEM_ERROR

     *   SatelliteResult:SATELLITE_RESULT_NETWORK_ERROR

     *   SatelliteResult:SATELLITE_RESULT_INVALID_MODEM_STATE

     *   SatelliteResult:SATELLITE_RESULT_INVALID_ARGUMENTS

     *   SatelliteResult:SATELLITE_RESULT_RADIO_NOT_AVAILABLE

     *   SatelliteResult:SATELLITE_RESULT_REQUEST_NOT_SUPPORTED

     *   SatelliteResult:SATELLITE_RESULT_NO_RESOURCES

     *   SatelliteResult:SATELLITE_RESULT_REQUEST_ABORTED

     *   SatelliteResult:SATELLITE_RESULT_NETWORK_TIMEOUT

     */

    void provisionSatelliteService(in String token, in byte[] provisionData,

            in IIntegerConsumer resultCallback);



    /**

     * Deprovision the device with the satellite provider.

     * This is needed if the provider allows dynamic registration.

     * Once deprovisioned, ISatelliteListener#onSatelliteProvisionStateChanged should report false.

     *

     * @param token The token of the device/subscription to be deprovisioned.

     * @param resultCallback The callback to receive the error code result of the operation.

     *

     * Valid result codes returned:

     *   SatelliteResult:SATELLITE_RESULT_SUCCESS

     *   SatelliteResult:SATELLITE_RESULT_SERVICE_ERROR

     *   SatelliteResult:SATELLITE_RESULT_MODEM_ERROR

     *   SatelliteResult:SATELLITE_RESULT_NETWORK_ERROR

     *   SatelliteResult:SATELLITE_RESULT_INVALID_MODEM_STATE

     *   SatelliteResult:SATELLITE_RESULT_INVALID_ARGUMENTS

     *   SatelliteResult:SATELLITE_RESULT_RADIO_NOT_AVAILABLE

     *   SatelliteResult:SATELLITE_RESULT_REQUEST_NOT_SUPPORTED

     *   SatelliteResult:SATELLITE_RESULT_NO_RESOURCES

     *   SatelliteResult:SATELLITE_RESULT_REQUEST_ABORTED

     *   SatelliteResult:SATELLITE_RESULT_NETWORK_TIMEOUT

     */

    void deprovisionSatelliteService(in String token, in IIntegerConsumer resultCallback);



    /**

     * Request to get whether this device is provisioned with a satellite provider.

     *

     * @param resultCallback The callback to receive the error code result of the operation.

     *                       This must only be sent when the result is not

     *                       SatelliteResult#SATELLITE_RESULT_SUCCESS.

     * @param callback If the result is SatelliteResult#SATELLITE_RESULT_SUCCESS, the callback to

     *                 receive whether this device is provisioned with a satellite provider.

     *

     * Valid result codes returned:

     *   SatelliteResult:SATELLITE_RESULT_SUCCESS

     *   SatelliteResult:SATELLITE_RESULT_SERVICE_ERROR

     *   SatelliteResult:SATELLITE_RESULT_MODEM_ERROR

     *   SatelliteResult:SATELLITE_RESULT_INVALID_MODEM_STATE

     *   SatelliteResult:SATELLITE_RESULT_INVALID_ARGUMENTS

     *   SatelliteResult:SATELLITE_RESULT_RADIO_NOT_AVAILABLE

     *   SatelliteResult:SATELLITE_RESULT_REQUEST_NOT_SUPPORTED

     *   SatelliteResult:SATELLITE_RESULT_NO_RESOURCES

     */

    void requestIsSatelliteProvisioned(in IIntegerConsumer resultCallback,

            in IBooleanConsumer callback);



    /**

     * Poll the pending datagrams to be received over satellite.

     * The satellite service should check if there are any pending datagrams to be received over

telephony/java/android/telephony/satellite/stub/ISatelliteListener.aidl

+0 −7
Original line number Diff line number Diff line
@@ -27,13 +27,6 @@ import android.telephony.satellite.stub.SatelliteModemState; 
 * {@hide}

 */

oneway interface ISatelliteListener {

    /**

     * Indicates that the satellite provision state has changed.

     *

     * @param provisioned True means the service is provisioned and false means it is not.

     */

    void onSatelliteProvisionStateChanged(in boolean provisioned);



    /**

     * Indicates that new datagrams have been received on the device.

     *

telephony/java/android/telephony/satellite/stub/SatelliteImplBase.java

+0 −105
Original line number Diff line number Diff line
@@ -141,32 +141,6 @@ public class SatelliteImplBase extends SatelliteService { 
                    "stopSendingSatellitePointingInfo");

        }



        @Override

        public void provisionSatelliteService(String token, byte[] provisionData,

                IIntegerConsumer resultCallback) throws RemoteException {

            executeMethodAsync(

                    () -> SatelliteImplBase.this

                            .provisionSatelliteService(token, provisionData, resultCallback),

                    "provisionSatelliteService");

        }



        @Override

        public void deprovisionSatelliteService(String token, IIntegerConsumer resultCallback)

                throws RemoteException {

            executeMethodAsync(

                    () -> SatelliteImplBase.this.deprovisionSatelliteService(token, resultCallback),

                    "deprovisionSatelliteService");

        }



        @Override

        public void requestIsSatelliteProvisioned(IIntegerConsumer resultCallback,

                IBooleanConsumer callback) throws RemoteException {

            executeMethodAsync(

                    () -> SatelliteImplBase.this

                            .requestIsSatelliteProvisioned(resultCallback, callback),

                    "requestIsSatelliteProvisioned");

        }



        @Override

        public void pollPendingSatelliteDatagrams(IIntegerConsumer resultCallback)

                throws RemoteException {
@@ -486,85 +460,6 @@ public class SatelliteImplBase extends SatelliteService { 
        // stub implementation

    }



    /**

     * Provision the device with a satellite provider.

     * This is needed if the provider allows dynamic registration.

     * Once provisioned, ISatelliteListener#onSatelliteProvisionStateChanged should report true.

     *

     * @param token The token to be used as a unique identifier for provisioning with satellite

     *              gateway.

     * @param provisionData Data from the provisioning app that can be used by provisioning

     *                      server

     * @param resultCallback The callback to receive the error code result of the operation.

     *

     * Valid result codes returned:

     *   SatelliteResult:SATELLITE_RESULT_SUCCESS

     *   SatelliteResult:SATELLITE_RESULT_SERVICE_ERROR

     *   SatelliteResult:SATELLITE_RESULT_MODEM_ERROR

     *   SatelliteResult:SATELLITE_RESULT_NETWORK_ERROR

     *   SatelliteResult:SATELLITE_RESULT_INVALID_MODEM_STATE

     *   SatelliteResult:SATELLITE_RESULT_INVALID_ARGUMENTS

     *   SatelliteResult:SATELLITE_RESULT_RADIO_NOT_AVAILABLE

     *   SatelliteResult:SATELLITE_RESULT_REQUEST_NOT_SUPPORTED

     *   SatelliteResult:SATELLITE_RESULT_NO_RESOURCES

     *   SatelliteResult:SATELLITE_RESULT_REQUEST_ABORTED

     *   SatelliteResult:SATELLITE_RESULT_NETWORK_TIMEOUT

     */

    public void provisionSatelliteService(@NonNull String token, @NonNull byte[] provisionData,

            @NonNull IIntegerConsumer resultCallback) {

        // stub implementation

    }



    /**

     * Deprovision the device with the satellite provider.

     * This is needed if the provider allows dynamic registration.

     * Once deprovisioned, ISatelliteListener#onSatelliteProvisionStateChanged should report false.

     *

     * @param token The token of the device/subscription to be deprovisioned.

     * @param resultCallback The callback to receive the error code result of the operation.

     *

     * Valid result codes returned:

     *   SatelliteResult:SATELLITE_RESULT_SUCCESS

     *   SatelliteResult:SATELLITE_RESULT_SERVICE_ERROR

     *   SatelliteResult:SATELLITE_RESULT_MODEM_ERROR

     *   SatelliteResult:SATELLITE_RESULT_NETWORK_ERROR

     *   SatelliteResult:SATELLITE_RESULT_INVALID_MODEM_STATE

     *   SatelliteResult:SATELLITE_RESULT_INVALID_ARGUMENTS

     *   SatelliteResult:SATELLITE_RESULT_RADIO_NOT_AVAILABLE

     *   SatelliteResult:SATELLITE_RESULT_REQUEST_NOT_SUPPORTED

     *   SatelliteResult:SATELLITE_RESULT_NO_RESOURCES

     *   SatelliteResult:SATELLITE_RESULT_REQUEST_ABORTED

     *   SatelliteResult:SATELLITE_RESULT_NETWORK_TIMEOUT

     */

    public void deprovisionSatelliteService(@NonNull String token,

            @NonNull IIntegerConsumer resultCallback) {

        // stub implementation

    }



    /**

     * Request to get whether this device is provisioned with a satellite provider.

     *

     * @param resultCallback The callback to receive the error code result of the operation.

     *                       This must only be sent when the result is not

     *                       SatelliteResult#SATELLITE_RESULT_SUCCESS.

     * @param callback If the result is SatelliteResult#SATELLITE_RESULT_SUCCESS, the callback to

     *                 receive whether this device is provisioned with a satellite provider.

     *

     * Valid result codes returned:

     *   SatelliteResult:SATELLITE_RESULT_SUCCESS

     *   SatelliteResult:SATELLITE_RESULT_SERVICE_ERROR

     *   SatelliteResult:SATELLITE_RESULT_MODEM_ERROR

     *   SatelliteResult:SATELLITE_RESULT_INVALID_MODEM_STATE

     *   SatelliteResult:SATELLITE_RESULT_INVALID_ARGUMENTS

     *   SatelliteResult:SATELLITE_RESULT_RADIO_NOT_AVAILABLE

     *   SatelliteResult:SATELLITE_RESULT_REQUEST_NOT_SUPPORTED

     *   SatelliteResult:SATELLITE_RESULT_NO_RESOURCES

     */

    public void requestIsSatelliteProvisioned(@NonNull IIntegerConsumer resultCallback,

            @NonNull IBooleanConsumer callback) {

        // stub implementation

    }



    /**

     * Poll the pending datagrams to be received over satellite.

     * The satellite service should check if there are any pending datagrams to be received over