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

Commit b8651d71 authored by ziyiw's avatar ziyiw
Browse files

[framework] Add saving routing option oem extension APIs. 

Bug: 356419585
Test: atest CtsNfcTestCases
Change-Id: I823c3ce394653cfa0574732975eaf1155d2ed871
parent 39de4cd4

nfc/api/current.txt

+1 −0
Original line number Original line Diff line number Diff line
@@ -223,6 +223,7 @@ package android.nfc.cardemulation { 
    field public static final String CATEGORY_PAYMENT = "payment";

    field public static final String CATEGORY_PAYMENT = "payment";

    field public static final String EXTRA_CATEGORY = "category";

    field public static final String EXTRA_CATEGORY = "category";

    field public static final String EXTRA_SERVICE_COMPONENT = "component";

    field public static final String EXTRA_SERVICE_COMPONENT = "component";

    field @FlaggedApi("android.nfc.nfc_override_recover_routing_table") public static final int PROTOCOL_AND_TECHNOLOGY_ROUTE_DEFAULT = 3; // 0x3

    field @FlaggedApi("android.nfc.nfc_override_recover_routing_table") public static final int PROTOCOL_AND_TECHNOLOGY_ROUTE_DH = 0; // 0x0

    field @FlaggedApi("android.nfc.nfc_override_recover_routing_table") public static final int PROTOCOL_AND_TECHNOLOGY_ROUTE_DH = 0; // 0x0

    field @FlaggedApi("android.nfc.nfc_override_recover_routing_table") public static final int PROTOCOL_AND_TECHNOLOGY_ROUTE_ESE = 1; // 0x1

    field @FlaggedApi("android.nfc.nfc_override_recover_routing_table") public static final int PROTOCOL_AND_TECHNOLOGY_ROUTE_ESE = 1; // 0x1

    field @FlaggedApi("android.nfc.nfc_override_recover_routing_table") public static final int PROTOCOL_AND_TECHNOLOGY_ROUTE_UICC = 2; // 0x2

    field @FlaggedApi("android.nfc.nfc_override_recover_routing_table") public static final int PROTOCOL_AND_TECHNOLOGY_ROUTE_UICC = 2; // 0x2

nfc/api/system-current.txt

+10 −0
Original line number Original line Diff line number Diff line
@@ -58,12 +58,16 @@ package android.nfc { 
  @FlaggedApi("android.nfc.nfc_oem_extension") public final class NfcOemExtension {

  @FlaggedApi("android.nfc.nfc_oem_extension") public final class NfcOemExtension {

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public void clearPreference();

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public void clearPreference();

    method @FlaggedApi("android.nfc.nfc_oem_extension") @NonNull public java.util.List<java.lang.String> getActiveNfceeList();

    method @FlaggedApi("android.nfc.nfc_oem_extension") @NonNull public java.util.List<java.lang.String> getActiveNfceeList();

    method @FlaggedApi("android.nfc.nfc_oem_extension") @NonNull @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public android.nfc.RoutingStatus getRoutingStatus();

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public boolean hasUserEnabledNfc();

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public boolean hasUserEnabledNfc();

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public boolean isAutoChangeEnabled();

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public boolean isTagPresent();

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public boolean isTagPresent();

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public void maybeTriggerFirmwareUpdate();

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public void maybeTriggerFirmwareUpdate();

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public void overwriteRoutingTable(int, int, int);

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public void pausePolling(int);

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public void pausePolling(int);

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public void registerCallback(@NonNull java.util.concurrent.Executor, @NonNull android.nfc.NfcOemExtension.Callback);

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public void registerCallback(@NonNull java.util.concurrent.Executor, @NonNull android.nfc.NfcOemExtension.Callback);

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public void resumePolling();

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public void resumePolling();

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public void setAutoChangeEnabled(boolean);

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.NFC_SET_CONTROLLER_ALWAYS_ON) public void setControllerAlwaysOnMode(int);

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.NFC_SET_CONTROLLER_ALWAYS_ON) public void setControllerAlwaysOnMode(int);

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public void synchronizeScreenState();

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public void synchronizeScreenState();

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public void triggerInitialization();

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public void triggerInitialization();
@@ -105,6 +109,12 @@ package android.nfc { 
    method public void onTagDispatch(@NonNull java.util.function.Consumer<java.lang.Boolean>);

    method public void onTagDispatch(@NonNull java.util.function.Consumer<java.lang.Boolean>);

  }

  }





  @FlaggedApi("android.nfc.nfc_oem_extension") public class RoutingStatus {

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public int getDefaultIsoDepRoute();

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public int getDefaultOffHostRoute();

    method @FlaggedApi("android.nfc.nfc_oem_extension") @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public int getDefaultRoute();

  }



}

}





package android.nfc.cardemulation {

package android.nfc.cardemulation {

nfc/java/android/nfc/INfcCardEmulation.aidl

+4 −0
Original line number Original line Diff line number Diff line
@@ -51,4 +51,8 @@ interface INfcCardEmulation 
    void overrideRoutingTable(int userHandle, String protocol, String technology, in String pkg);

    void overrideRoutingTable(int userHandle, String protocol, String technology, in String pkg);

    void recoverRoutingTable(int userHandle);

    void recoverRoutingTable(int userHandle);

    boolean isEuiccSupported();

    boolean isEuiccSupported();

    void setAutoChangeStatus(boolean state);

    boolean isAutoChangeEnabled();

    List<String> getRoutingStatus();

    void overwriteRoutingTable(int userHandle, String emptyAid, String protocol, String tech);

}
 
}

nfc/java/android/nfc/NfcOemExtension.java

+96 −0
Original line number Original line Diff line number Diff line
@@ -16,6 +16,12 @@ 




package android.nfc;

package android.nfc;





import static android.nfc.cardemulation.CardEmulation.PROTOCOL_AND_TECHNOLOGY_ROUTE_DH;

import static android.nfc.cardemulation.CardEmulation.PROTOCOL_AND_TECHNOLOGY_ROUTE_ESE;

import static android.nfc.cardemulation.CardEmulation.PROTOCOL_AND_TECHNOLOGY_ROUTE_UICC;

import static android.nfc.cardemulation.CardEmulation.routeIntToString;



import android.Manifest;

import android.annotation.CallbackExecutor;

import android.annotation.CallbackExecutor;

import android.annotation.FlaggedApi;

import android.annotation.FlaggedApi;

import android.annotation.IntDef;

import android.annotation.IntDef;
@@ -27,6 +33,8 @@ import android.content.ComponentName; 
import android.content.Context;

import android.content.Context;

import android.content.Intent;

import android.content.Intent;

import android.nfc.cardemulation.ApduServiceInfo;

import android.nfc.cardemulation.ApduServiceInfo;

import android.nfc.cardemulation.CardEmulation;

import android.nfc.cardemulation.CardEmulation.ProtocolAndTechnologyRoute;

import android.os.Binder;

import android.os.Binder;

import android.os.Bundle;

import android.os.Bundle;

import android.os.RemoteException;

import android.os.RemoteException;
@@ -581,6 +589,85 @@ public final class NfcOemExtension { 
        NfcAdapter.callService(() -> NfcAdapter.sService.resumePolling());

        NfcAdapter.callService(() -> NfcAdapter.sService.resumePolling());

    }

    }





    /**

     * Set whether to enable auto routing change or not (enabled by default).

     * If disabled, routing targets are limited to a single off-host destination.

     *

     * @param state status of auto routing change, true if enable, otherwise false

     */

    @FlaggedApi(Flags.FLAG_NFC_OEM_EXTENSION)

    @RequiresPermission(Manifest.permission.WRITE_SECURE_SETTINGS)

    public void setAutoChangeEnabled(boolean state) {

        NfcAdapter.callService(() ->

                NfcAdapter.sCardEmulationService.setAutoChangeStatus(state));

    }



    /**

     * Check if auto routing change is enabled or not.

     *

     * @return true if enabled, otherwise false

     */

    @FlaggedApi(Flags.FLAG_NFC_OEM_EXTENSION)

    @RequiresPermission(Manifest.permission.WRITE_SECURE_SETTINGS)

    public boolean isAutoChangeEnabled() {

        return NfcAdapter.callServiceReturn(() ->

                NfcAdapter.sCardEmulationService.isAutoChangeEnabled(), false);

    }



    /**

     * Get current routing status

     *

     * @return {@link RoutingStatus} indicating the default route, default ISO-DEP

     * route and default off-host route.

     */

    @NonNull

    @FlaggedApi(Flags.FLAG_NFC_OEM_EXTENSION)

    @RequiresPermission(Manifest.permission.WRITE_SECURE_SETTINGS)

    public RoutingStatus getRoutingStatus() {

        List<String> status = NfcAdapter.callServiceReturn(() ->

                NfcAdapter.sCardEmulationService.getRoutingStatus(), new ArrayList<>());

        return new RoutingStatus(routeStringToInt(status.get(0)),

                routeStringToInt(status.get(1)),

                routeStringToInt(status.get(2)));

    }



    /**

     * Overwrites NFC controller routing table, which includes Protocol Route, Technology Route,

     * and Empty AID Route.

     *

     * The parameter set to

     * {@link ProtocolAndTechnologyRoute#PROTOCOL_AND_TECHNOLOGY_ROUTE_UNSET}

     * can be used to keep current values for that entry. At least one route should be overridden

     * when calling this API, otherwise throw {@link IllegalArgumentException}.

     *

     * @param protocol ISO-DEP route destination, where the possible inputs are defined in

     *                 {@link ProtocolAndTechnologyRoute}.

     * @param technology Tech-A, Tech-B and Tech-F route destination, where the possible inputs

     *                   are defined in

     *                   {@link ProtocolAndTechnologyRoute}

     * @param emptyAid Zero-length AID route destination, where the possible inputs are defined in

     *                 {@link ProtocolAndTechnologyRoute}

     */

    @RequiresPermission(Manifest.permission.WRITE_SECURE_SETTINGS)

    @FlaggedApi(Flags.FLAG_NFC_OEM_EXTENSION)

    public void overwriteRoutingTable(

            @CardEmulation.ProtocolAndTechnologyRoute int protocol,

            @CardEmulation.ProtocolAndTechnologyRoute int technology,

            @CardEmulation.ProtocolAndTechnologyRoute int emptyAid) {



        String protocolRoute = routeIntToString(protocol);

        String technologyRoute = routeIntToString(technology);

        String emptyAidRoute = routeIntToString(emptyAid);



        NfcAdapter.callService(() ->

                NfcAdapter.sCardEmulationService.overwriteRoutingTable(

                        mContext.getUser().getIdentifier(),

                        emptyAidRoute,

                        protocolRoute,

                        technologyRoute

                ));

    }



    private final class NfcOemExtensionCallback extends INfcOemExtensionCallback.Stub {

    private final class NfcOemExtensionCallback extends INfcOemExtensionCallback.Stub {





        @Override

        @Override
@@ -829,6 +916,15 @@ public final class NfcOemExtension { 
        }

        }

    }

    }





    private @CardEmulation.ProtocolAndTechnologyRoute int routeStringToInt(String route) {

        return switch (route) {

            case "DH" -> PROTOCOL_AND_TECHNOLOGY_ROUTE_DH;

            case "eSE" -> PROTOCOL_AND_TECHNOLOGY_ROUTE_ESE;

            case "SIM" -> PROTOCOL_AND_TECHNOLOGY_ROUTE_UICC;

            default -> throw new IllegalStateException("Unexpected value: " + route);

        };

    }



    private class ReceiverWrapper<T> implements Consumer<T> {

    private class ReceiverWrapper<T> implements Consumer<T> {

        private final ResultReceiver mResultReceiver;

        private final ResultReceiver mResultReceiver;

nfc/java/android/nfc/RoutingStatus.java

0 → 100644
+79 −0
Original line number Original line Diff line number Diff line 
/*

 * Copyright (C) 2024 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.nfc;



import android.annotation.FlaggedApi;

import android.annotation.RequiresPermission;

import android.annotation.SystemApi;

import android.nfc.cardemulation.CardEmulation;



/**

 * A class indicating default route, ISO-DEP route and off-host route.

 *

 * @hide

 */

@SystemApi

@FlaggedApi(Flags.FLAG_NFC_OEM_EXTENSION)

public class RoutingStatus {

    private final @CardEmulation.ProtocolAndTechnologyRoute int mDefaultRoute;

    private final @CardEmulation.ProtocolAndTechnologyRoute int mDefaultIsoDepRoute;

    private final @CardEmulation.ProtocolAndTechnologyRoute int mDefaultOffHostRoute;



    RoutingStatus(@CardEmulation.ProtocolAndTechnologyRoute int mDefaultRoute,

                  @CardEmulation.ProtocolAndTechnologyRoute int mDefaultIsoDepRoute,

                  @CardEmulation.ProtocolAndTechnologyRoute int mDefaultOffHostRoute) {

        this.mDefaultRoute = mDefaultRoute;

        this.mDefaultIsoDepRoute = mDefaultIsoDepRoute;

        this.mDefaultOffHostRoute = mDefaultOffHostRoute;

    }



    /**

     * Getter of the default route.

     * @return an integer defined in

     * {@link android.nfc.cardemulation.CardEmulation.ProtocolAndTechnologyRoute}

     */

    @FlaggedApi(Flags.FLAG_NFC_OEM_EXTENSION)

    @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)

    @CardEmulation.ProtocolAndTechnologyRoute

    public int getDefaultRoute() {

        return mDefaultRoute;

    }



    /**

     * Getter of the default ISO-DEP route.

     * @return an integer defined in

     * {@link android.nfc.cardemulation.CardEmulation.ProtocolAndTechnologyRoute}

     */

    @FlaggedApi(Flags.FLAG_NFC_OEM_EXTENSION)

    @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)

    @CardEmulation.ProtocolAndTechnologyRoute

    public int getDefaultIsoDepRoute() {

        return mDefaultIsoDepRoute;

    }



    /**

     * Getter of the default off-host route.

     * @return an integer defined in

     * {@link android.nfc.cardemulation.CardEmulation.ProtocolAndTechnologyRoute}

     */

    @FlaggedApi(Flags.FLAG_NFC_OEM_EXTENSION)

    @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)

    @CardEmulation.ProtocolAndTechnologyRoute

    public int getDefaultOffHostRoute() {

        return mDefaultOffHostRoute;

    }



}