NfcNci/src/com/android/nfc/DeviceHost.java

/*
 * Copyright (C) 2011 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 com.android.nfc;

import android.annotation.Nullable;
import android.nfc.NdefMessage;
import android.nfc.cardemulation.PollingFrame;
import android.os.Bundle;

import java.io.FileDescriptor;
import java.io.PrintWriter;
import java.util.List;
import java.util.Map;

public interface DeviceHost {
    public interface DeviceHostListener {
        public void onRemoteEndpointDiscovered(TagEndpoint tag);

        /**
         */
        public void onHostCardEmulationActivated(int technology);
        public void onHostCardEmulationData(int technology, byte[] data);
        public void onHostCardEmulationDeactivated(int technology);

        public void onRemoteFieldActivated();

        public void onRemoteFieldDeactivated();

        public void onNfcTransactionEvent(byte[] aid, byte[] data, String seName);

        public void onEeUpdated();

        public void onHwErrorReported();

        public void onPollingLoopDetected(List<PollingFrame> pollingFrames);

        public void onWlcStopped(int wpt_end_condition);

        public void onTagRfDiscovered(boolean discovered);

        public void onVendorSpecificEvent(int gid, int oid, byte[] payload);

        public void onObserveModeStateChanged(boolean enable);

        public void onRfDiscoveryEvent(boolean isDiscoveryStarted);

        public void onEeListenActivated(boolean isActivated);

        public void onSeSelected();

        public void onCommandTimeout();

        public void onEndpointRemoved(int reason);
    }

    public interface TagEndpoint {
        boolean connect(int technology);
        boolean reconnect();
        boolean disconnect();

        boolean presenceCheck();
        boolean isPresent();
        void startPresenceChecking(int presenceCheckDelay,
                                   @Nullable TagDisconnectedCallback callback);
        void stopPresenceChecking();
        boolean isPresenceCheckStopped();
        void prepareForRemovalDetectionMode();

        int[] getTechList();
        void removeTechnology(int tech); // TODO remove this one
        Bundle[] getTechExtras();
        byte[] getUid();
        int getHandle();

        byte[] transceive(byte[] data, boolean raw, int[] returnCode);

        boolean checkNdef(int[] out);
        byte[] readNdef();
        boolean writeNdef(byte[] data);
        NdefMessage findAndReadNdef();
        NdefMessage getNdef();
        boolean formatNdef(byte[] key);
        boolean isNdefFormatable();
        boolean makeReadOnly();

        int getConnectedTechnology();

        /**
         * Find Ndef only
         * As per NFC forum test specification ndef write test expects only
         * ndef detection followed by ndef write. System property
         * nfc.dta.skipNdefRead added to skip default ndef read before tag
         * dispatch. This system property is valid only in reader mode.
         */
        void findNdef();
    }

    public interface TagDisconnectedCallback {
        void onTagDisconnected();
    }

    public interface NfceeEndpoint {
        // TODO flesh out multi-EE and use this
    }

    public interface NfcDepEndpoint {
        /**
         * Invalid target mode
         */
        public static final short MODE_INVALID = 0xff;

        public byte[] receive();

        public boolean send(byte[] data);

        public boolean connect();

        public boolean disconnect();

        public byte[] transceive(byte[] data);

        public int getHandle();

        public int getMode();

        public byte[] getGeneralBytes();
    }

    /**
     * Called at boot if NFC is disabled to give the device host an opportunity
     * to check the firmware version to see if it needs updating. Normally the firmware version
     * is checked during {@link #initialize(boolean enableScreenOffSuspend)},
     * but the firmware may need to be updated after an OTA update.
     *
     * <p>This is called from a thread
     * that may block for long periods of time during the update process.
     */
    public boolean checkFirmware();

    public boolean initialize();

    public void setPartialInitMode(int mode);

    public boolean deinitialize();

    public String getName();

    public void enableDiscovery(NfcDiscoveryParameters params, boolean restart);

    public void disableDiscovery();

    public boolean sendRawFrame(byte[] data);

    public boolean routeAid(byte[] aid, int route, int aidInfo, int power);

    public boolean unrouteAid(byte[] aid);

    public int commitRouting();

    /**
     * Get the T4T Nfcee power state supported.
     * @return T4T Nfcee power state
     */
    int getT4TNfceePowerState();

    /**
     * Get the NDEF NFCEE Route ID.
     * @return NDEF NFCEE Route ID
     */
    int getNdefNfceeRouteId();

    /**
     * Write the data into the NDEF NFCEE file of the specific file ID
     * @param fileId
     * @param data
     * @return number of data bytes written
     */
    int doWriteData(byte[] fileId, byte[] data);

    /**
     * Read the data from the NDEF NFCEE file of the specific file ID.
     * @param fileId
     * @return read data buffer
     */
    byte[] doReadData(byte[] fileId);

    /**
     * This API will set all the NFCEE NDEF data to zero.
     * @return "True" when operation is successful. else "False"
     */
    boolean doClearNdefData();

    /**
     * This API will get NDEF NFCEE status.
     * @return Indicates whether NDEF NFCEE Read or write operation is under process
     *         Return "True" when operation is in progress. else "False"
     */
    boolean isNdefOperationOngoing();

    /**
     * This API will tell whether NDEF NFCEE emulation is supported or not.
     * @return "True" when feature supported. else "False"
     */
    boolean isNdefNfceeEmulationSupported();

    public void registerT3tIdentifier(byte[] t3tIdentifier);

    public void deregisterT3tIdentifier(byte[] t3tIdentifier);

    public void clearT3tIdentifiersCache();

    public int getLfT3tMax();

    public void resetTimeouts();

    public boolean setTimeout(int technology, int timeout);

    public int getTimeout(int technology);

    public void doAbort(String msg);

    boolean canMakeReadOnly(int technology);

    int getMaxTransceiveLength(int technology);

    public int getAidTableSize();

    boolean getExtendedLengthApdusSupported();

    void dump(PrintWriter pw, FileDescriptor fd);

    public void doSetScreenState(int screen_state_mask, boolean alwaysPoll);

    public int getNciVersion();

    public void enableDtaMode();

    public void disableDtaMode();

    public void factoryReset();

    public void shutdown();

    public boolean setNfcSecure(boolean enable);

    public boolean isObserveModeSupported();

    public boolean setObserveMode(boolean enable);

    public boolean isObserveModeEnabled();

    public boolean isFirmwareExitFramesSupported();

    /**
    * Get the committed listen mode routing configuration
    */
    byte[] getRoutingTable();

    /**
    * Get the Max Routing Table size from cache
    */
    int getMaxRoutingTableSize();

    /**
    * Start or stop RF polling
    */
    void startStopPolling(boolean enable);

    /**
    * Set NFCC power state by sending NFCEE_POWER_AND_LINK_CNTRL_CMD
    */
    void setNfceePowerAndLinkCtrl(boolean enable);

    /**
     * Enable or Disable the Power Saving Mode based on flag
     */
    boolean setPowerSavingMode(boolean flag);

    boolean isMultiTag();

    void setIsoDepProtocolRoute(int route);
    /**
    * Set NFCC technology routing for ABF listening
    */
    void setTechnologyABFRoute(int route, int felicaRoute);
    void setSystemCodeRoute(int route);
    void clearRoutingEntry(int clearFlags);

    /**
    * Set NFCC discovery technology for polling and listening
    */
    void setDiscoveryTech(int pollTech, int listenTech);
    void resetDiscoveryTech();
    /**
     * Sends Vendor NCI command
     */

    NfcVendorNciResponse sendRawVendorCmd(int mt, int gid, int oid, byte[] payload);

    public boolean detectEpRemoval(int waiting_time_int);

    void enableVendorNciNotifications(boolean enabled);

    /**
     * Get the active NFCEE list
     */
    public Map<String, Integer> dofetchActiveNfceeList();
    public boolean isRemovalDetectionInPollModeSupported();
}