framework/java/android/nfc/T4tNdefNfcee.java - platform/packages/modules/Nfc - Git at Google

 /*
  * 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.IntDef;
 import android.annotation.IntRange;
 import android.annotation.NonNull;
 import android.annotation.Nullable;
 import android.annotation.RequiresPermission;
 import android.annotation.SystemApi;
 import android.annotation.WorkerThread;

 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;

 /**
  * This class is used for performing T4T (Type-4 Tag) NDEF (NFC Data Exchange Format)
  * NFCEE (NFC Execution Environment) operations.
  * This can be used to write NDEF data to emulate a T4T tag in an NFCEE
  * (NFC Execution Environment - eSE, SIM, etc). Refer to the NFC forum specification
  * "NFCForum-TS-NCI-2.3 section 10.4" and "NFCForum-TS-T4T-1.1 section 4.2" for more details.
  * @hide
  */
 @FlaggedApi(Flags.FLAG_NFC_OEM_EXTENSION)
 @SystemApi
 public final class T4tNdefNfcee {
     private static final String TAG = "NdefNfcee";
     static T4tNdefNfcee sNdefNfcee;

     private T4tNdefNfcee() {
     }

     /**
      * Helper to get an instance of this class.
      *
      * @return
      * @hide
      */
     @NonNull
     public static T4tNdefNfcee getInstance() {
         if (sNdefNfcee == null) {
             sNdefNfcee = new T4tNdefNfcee();
         }
         return sNdefNfcee;
     }

     /**
      * Return flag for {@link #writeData(int, byte[])}.
      * It indicates write data is successful.
      */
     public static final int WRITE_DATA_SUCCESS = 0;
     /**
      * Return flag for {@link #writeData(int, byte[])}.
      * It indicates write data fail due to unknown reasons.
      */
     public static final int WRITE_DATA_ERROR_INTERNAL = -1;
     /**
      * Return flag for {@link #writeData(int, byte[])}.
      * It indicates write data fail due to ongoing rf activity.
      */
     public static final int WRITE_DATA_ERROR_RF_ACTIVATED = -2;
     /**
      * Return flag for {@link #writeData(int, byte[])}.
      * It indicates write data fail due to Nfc off.
      */
     public static final int WRITE_DATA_ERROR_NFC_NOT_ON = -3;
     /**
      * Return flag for {@link #writeData(int, byte[])}.
      * It indicates write data fail due to invalid file id.
      */
     public static final int WRITE_DATA_ERROR_INVALID_FILE_ID = -4;
     /**
      * Return flag for {@link #writeData(int, byte[])}.
      * It indicates write data fail due to invalid length.
      */
     public static final int WRITE_DATA_ERROR_INVALID_LENGTH = -5;
     /**
      * Return flag for {@link #writeData(int, byte[])}.
      * It indicates write data fail due to core connection create failure.
      */
     public static final int WRITE_DATA_ERROR_CONNECTION_FAILED = -6;
     /**
      * Return flag for {@link #writeData(int, byte[])}.
      * It indicates write data fail due to empty payload.
      */
     public static final int WRITE_DATA_ERROR_EMPTY_PAYLOAD = -7;
     /**
      * Returns flag for {@link #writeData(int, byte[])}.
      * It indicates write data fail due to invalid ndef format.
      */
     public static final int WRITE_DATA_ERROR_NDEF_VALIDATION_FAILED = -8;
     /**
      * Returns flag for {@link #writeData(int, byte[])}.
      * It indicates write data fail if a concurrent NDEF NFCEE operation is ongoing.
      */
     public static final int WRITE_DATA_ERROR_DEVICE_BUSY = -9;

     /**
      * Possible return values for {@link #writeData(int, byte[])}.
      *
      * @hide
      */
     @IntDef(prefix = { "WRITE_DATA_" }, value = {
         WRITE_DATA_SUCCESS,
         WRITE_DATA_ERROR_INTERNAL,
         WRITE_DATA_ERROR_RF_ACTIVATED,
         WRITE_DATA_ERROR_NFC_NOT_ON,
         WRITE_DATA_ERROR_INVALID_FILE_ID,
         WRITE_DATA_ERROR_INVALID_LENGTH,
         WRITE_DATA_ERROR_CONNECTION_FAILED,
         WRITE_DATA_ERROR_EMPTY_PAYLOAD,
         WRITE_DATA_ERROR_NDEF_VALIDATION_FAILED,
         WRITE_DATA_ERROR_DEVICE_BUSY,
     })
     @Retention(RetentionPolicy.SOURCE)
     public @interface WriteDataStatus{}

     /**
      * This API performs writes of T4T data to NFCEE.
      *
      * <p>This is an I/O operation and will block until complete. It must
      * not be called from the main application thread.</p>
      * <p>Applications must send complete Ndef Message payload, do not need to fragment
      * the payload, it will be automatically fragmented and defragmented by
      * {@link #writeData} if it exceeds max message length limits</p>
      *
      * @param fileId File id (Refer NFC Forum Type 4 Tag Specification
      *               Section 4.2 File Identifiers and Access Conditions
      *               for more information) to which to write.
      * @param data   This should be valid Ndef Message format.
      *               Refer to Nfc forum NDEF specification NDEF Message section
      * @return status of the operation.
      * @hide
      */
     @SystemApi
     @WorkerThread
     @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
     public @WriteDataStatus int writeData(@IntRange(from = 0, to = 65535) int fileId,
             @NonNull byte[] data) {
         return NfcAdapter.callServiceReturn(() ->
                 NfcAdapter.getNdefNfceeService().writeData(fileId, data), WRITE_DATA_ERROR_INTERNAL);
     }

     /**
      * This API performs reading of T4T content of Nfcee.
      *
      * <p>This is an I/O operation and will block until complete. It must
      * not be called from the main application thread.</p>
      *
      * @param fileId File Id (Refer
      *               Section 4.2 File Identifiers and Access Conditions
      *               for more information) from which to read.
      * @return - Returns complete Ndef message if success
      *           Refer to Nfc forum NDEF specification NDEF Message section
      * @throws IllegalStateException if read fails because the fileId is invalid
      *         or if a concurrent operation is in progress.
      * @hide
      */
     @SystemApi
     @WorkerThread
     @NonNull
     @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
     public byte[] readData(@IntRange(from = 0, to = 65535) int fileId) {
         return NfcAdapter.callServiceReturn(() ->
             NfcAdapter.getNdefNfceeService().readData(fileId), null);
     }

     /**
      * Return flag for {@link #clearNdefData()}.
      * It indicates clear data is successful.
      */
     public static final int CLEAR_DATA_SUCCESS = 1;
      /**
      * Return flag for {@link #clearNdefData()}.
      * It indicates clear data failed due to internal error while processing the clear.
      */
     public static final int CLEAR_DATA_FAILED_INTERNAL = 0;
     /**
      * Return flag for {@link #clearNdefData()}.
      * It indicates clear data failed  if a concurrent NDEF NFCEE operation is ongoing.
      */
     public static final int CLEAR_DATA_FAILED_DEVICE_BUSY = -1;


     /**
      * Possible return values for {@link #clearNdefData()}.
      *
      * @hide
      */
     @IntDef(prefix = { "CLEAR_DATA_" }, value = {
         CLEAR_DATA_SUCCESS,
         CLEAR_DATA_FAILED_INTERNAL,
         CLEAR_DATA_FAILED_DEVICE_BUSY,
     })
     @Retention(RetentionPolicy.SOURCE)
     public @interface ClearDataStatus{}

     /**
      * This API will set all the T4T NDEF NFCEE data to zero.
      *
      * <p>This is an I/O operation and will block until complete. It must
      * not be called from the main application thread.
      *
      * <p>This API can be called regardless of NDEF file lock state.
      * </p>
      * @return status of the operation
      *
      * @hide
      */
     @SystemApi
     @WorkerThread
     @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
     public @ClearDataStatus int clearData() {
         return NfcAdapter.callServiceReturn(() ->
             NfcAdapter.getNdefNfceeService().clearNdefData(), CLEAR_DATA_FAILED_INTERNAL);
     }

     /**
      * Returns whether NDEF NFCEE operation is ongoing or not.
      *
      * @return true if NDEF NFCEE operation is ongoing, else false.
      * @hide
      */
     @SystemApi
     @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
     public boolean isOperationOngoing() {
         return NfcAdapter.callServiceReturn(() ->
             NfcAdapter.getNdefNfceeService().isNdefOperationOngoing(), false);
     }

     /**
      * This Api is to check the status of NDEF NFCEE emulation feature is
      * supported or not.
      *
      * @return true if NDEF NFCEE emulation feature is supported, else false.
      * @hide
      */
     @SystemApi
     @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
     public boolean isSupported() {
         return NfcAdapter.callServiceReturn(() ->
             NfcAdapter.getNdefNfceeService().isNdefNfceeEmulationSupported(), false);
     }

     /**
      * This API performs reading of T4T NDEF NFCEE CC file content.
      *
      * Refer to the NFC forum specification "NFCForum-TS-T4T-1.1 section 4.4" for more details.
      *
      * @return Returns CC file content if success or null if failed to read.
      * @throws IllegalStateException if the device is busy.
      * @hide
      */
     @SystemApi
     @WorkerThread
     @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
     @Nullable
     public T4tNdefNfceeCcFileInfo readCcfile() {
         return NfcAdapter.callServiceReturn(() ->
             NfcAdapter.getNdefNfceeService().readCcfile(), null);
     }
 }
	/*
	* 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.IntDef;
	import android.annotation.IntRange;
	import android.annotation.NonNull;
	import android.annotation.Nullable;
	import android.annotation.RequiresPermission;
	import android.annotation.SystemApi;
	import android.annotation.WorkerThread;

	import java.lang.annotation.Retention;
	import java.lang.annotation.RetentionPolicy;

	/**
	* This class is used for performing T4T (Type-4 Tag) NDEF (NFC Data Exchange Format)
	* NFCEE (NFC Execution Environment) operations.
	* This can be used to write NDEF data to emulate a T4T tag in an NFCEE
	* (NFC Execution Environment - eSE, SIM, etc). Refer to the NFC forum specification
	* "NFCForum-TS-NCI-2.3 section 10.4" and "NFCForum-TS-T4T-1.1 section 4.2" for more details.
	* @hide
	*/
	@FlaggedApi(Flags.FLAG_NFC_OEM_EXTENSION)
	@SystemApi
	public final class T4tNdefNfcee {
	private static final String TAG = "NdefNfcee";
	static T4tNdefNfcee sNdefNfcee;

	private T4tNdefNfcee() {
	}

	/**
	* Helper to get an instance of this class.
	*
	* @return
	* @hide
	*/
	@NonNull
	public static T4tNdefNfcee getInstance() {
	if (sNdefNfcee == null) {
	sNdefNfcee = new T4tNdefNfcee();
	}
	return sNdefNfcee;
	}

	/**
	* Return flag for {@link #writeData(int, byte[])}.
	* It indicates write data is successful.
	*/
	public static final int WRITE_DATA_SUCCESS = 0;
	/**
	* Return flag for {@link #writeData(int, byte[])}.
	* It indicates write data fail due to unknown reasons.
	*/
	public static final int WRITE_DATA_ERROR_INTERNAL = -1;
	/**
	* Return flag for {@link #writeData(int, byte[])}.
	* It indicates write data fail due to ongoing rf activity.
	*/
	public static final int WRITE_DATA_ERROR_RF_ACTIVATED = -2;
	/**
	* Return flag for {@link #writeData(int, byte[])}.
	* It indicates write data fail due to Nfc off.
	*/
	public static final int WRITE_DATA_ERROR_NFC_NOT_ON = -3;
	/**
	* Return flag for {@link #writeData(int, byte[])}.
	* It indicates write data fail due to invalid file id.
	*/
	public static final int WRITE_DATA_ERROR_INVALID_FILE_ID = -4;
	/**
	* Return flag for {@link #writeData(int, byte[])}.
	* It indicates write data fail due to invalid length.
	*/
	public static final int WRITE_DATA_ERROR_INVALID_LENGTH = -5;
	/**
	* Return flag for {@link #writeData(int, byte[])}.
	* It indicates write data fail due to core connection create failure.
	*/
	public static final int WRITE_DATA_ERROR_CONNECTION_FAILED = -6;
	/**
	* Return flag for {@link #writeData(int, byte[])}.
	* It indicates write data fail due to empty payload.
	*/
	public static final int WRITE_DATA_ERROR_EMPTY_PAYLOAD = -7;
	/**
	* Returns flag for {@link #writeData(int, byte[])}.
	* It indicates write data fail due to invalid ndef format.
	*/
	public static final int WRITE_DATA_ERROR_NDEF_VALIDATION_FAILED = -8;
	/**
	* Returns flag for {@link #writeData(int, byte[])}.
	* It indicates write data fail if a concurrent NDEF NFCEE operation is ongoing.
	*/
	public static final int WRITE_DATA_ERROR_DEVICE_BUSY = -9;

	/**
	* Possible return values for {@link #writeData(int, byte[])}.
	*
	* @hide
	*/
	@IntDef(prefix = { "WRITE_DATA_" }, value = {
	WRITE_DATA_SUCCESS,
	WRITE_DATA_ERROR_INTERNAL,
	WRITE_DATA_ERROR_RF_ACTIVATED,
	WRITE_DATA_ERROR_NFC_NOT_ON,
	WRITE_DATA_ERROR_INVALID_FILE_ID,
	WRITE_DATA_ERROR_INVALID_LENGTH,
	WRITE_DATA_ERROR_CONNECTION_FAILED,
	WRITE_DATA_ERROR_EMPTY_PAYLOAD,
	WRITE_DATA_ERROR_NDEF_VALIDATION_FAILED,
	WRITE_DATA_ERROR_DEVICE_BUSY,
	})
	@Retention(RetentionPolicy.SOURCE)
	public @interface WriteDataStatus{}

	/**
	* This API performs writes of T4T data to NFCEE.
	*
	* <p>This is an I/O operation and will block until complete. It must
	* not be called from the main application thread.</p>
	* <p>Applications must send complete Ndef Message payload, do not need to fragment
	* the payload, it will be automatically fragmented and defragmented by
	* {@link #writeData} if it exceeds max message length limits</p>
	*
	* @param fileId File id (Refer NFC Forum Type 4 Tag Specification
	* Section 4.2 File Identifiers and Access Conditions
	* for more information) to which to write.
	* @param data This should be valid Ndef Message format.
	* Refer to Nfc forum NDEF specification NDEF Message section
	* @return status of the operation.
	* @hide
	*/
	@SystemApi
	@WorkerThread
	@RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
	public @WriteDataStatus int writeData(@IntRange(from = 0, to = 65535) int fileId,
	@NonNull byte[] data) {
	return NfcAdapter.callServiceReturn(() ->
	NfcAdapter.getNdefNfceeService().writeData(fileId, data), WRITE_DATA_ERROR_INTERNAL);
	}

	/**
	* This API performs reading of T4T content of Nfcee.
	*
	* <p>This is an I/O operation and will block until complete. It must
	* not be called from the main application thread.</p>
	*
	* @param fileId File Id (Refer
	* Section 4.2 File Identifiers and Access Conditions
	* for more information) from which to read.
	* @return - Returns complete Ndef message if success
	* Refer to Nfc forum NDEF specification NDEF Message section
	* @throws IllegalStateException if read fails because the fileId is invalid
	* or if a concurrent operation is in progress.
	* @hide
	*/
	@SystemApi
	@WorkerThread
	@NonNull
	@RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
	public byte[] readData(@IntRange(from = 0, to = 65535) int fileId) {
	return NfcAdapter.callServiceReturn(() ->
	NfcAdapter.getNdefNfceeService().readData(fileId), null);
	}

	/**
	* Return flag for {@link #clearNdefData()}.
	* It indicates clear data is successful.
	*/
	public static final int CLEAR_DATA_SUCCESS = 1;
	/**
	* Return flag for {@link #clearNdefData()}.
	* It indicates clear data failed due to internal error while processing the clear.
	*/
	public static final int CLEAR_DATA_FAILED_INTERNAL = 0;
	/**
	* Return flag for {@link #clearNdefData()}.
	* It indicates clear data failed if a concurrent NDEF NFCEE operation is ongoing.
	*/
	public static final int CLEAR_DATA_FAILED_DEVICE_BUSY = -1;


	/**
	* Possible return values for {@link #clearNdefData()}.
	*
	* @hide
	*/
	@IntDef(prefix = { "CLEAR_DATA_" }, value = {
	CLEAR_DATA_SUCCESS,
	CLEAR_DATA_FAILED_INTERNAL,
	CLEAR_DATA_FAILED_DEVICE_BUSY,
	})
	@Retention(RetentionPolicy.SOURCE)
	public @interface ClearDataStatus{}

	/**
	* This API will set all the T4T NDEF NFCEE data to zero.
	*
	* <p>This is an I/O operation and will block until complete. It must
	* not be called from the main application thread.
	*
	* <p>This API can be called regardless of NDEF file lock state.
	* </p>
	* @return status of the operation
	*
	* @hide
	*/
	@SystemApi
	@WorkerThread
	@RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
	public @ClearDataStatus int clearData() {
	return NfcAdapter.callServiceReturn(() ->
	NfcAdapter.getNdefNfceeService().clearNdefData(), CLEAR_DATA_FAILED_INTERNAL);
	}

	/**
	* Returns whether NDEF NFCEE operation is ongoing or not.
	*
	* @return true if NDEF NFCEE operation is ongoing, else false.
	* @hide
	*/
	@SystemApi
	@RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
	public boolean isOperationOngoing() {
	return NfcAdapter.callServiceReturn(() ->
	NfcAdapter.getNdefNfceeService().isNdefOperationOngoing(), false);
	}

	/**
	* This Api is to check the status of NDEF NFCEE emulation feature is
	* supported or not.
	*
	* @return true if NDEF NFCEE emulation feature is supported, else false.
	* @hide
	*/
	@SystemApi
	@RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
	public boolean isSupported() {
	return NfcAdapter.callServiceReturn(() ->
	NfcAdapter.getNdefNfceeService().isNdefNfceeEmulationSupported(), false);
	}

	/**
	* This API performs reading of T4T NDEF NFCEE CC file content.
	*
	* Refer to the NFC forum specification "NFCForum-TS-T4T-1.1 section 4.4" for more details.
	*
	* @return Returns CC file content if success or null if failed to read.
	* @throws IllegalStateException if the device is busy.
	* @hide
	*/
	@SystemApi
	@WorkerThread
	@RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
	@Nullable
	public T4tNdefNfceeCcFileInfo readCcfile() {
	return NfcAdapter.callServiceReturn(() ->
	NfcAdapter.getNdefNfceeService().readCcfile(), null);
	}
	}