radio/aidl/android/hardware/radio/sim/CardStatus.aidl

/*
 * Copyright (C) 2021 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.hardware.radio.sim;

import android.hardware.radio.config.MultipleEnabledProfilesMode;
import android.hardware.radio.config.SlotPortMapping;
import android.hardware.radio.sim.AppStatus;
import android.hardware.radio.sim.PinState;

/** @hide */
@VintfStability
@JavaDerive(toString=true)
parcelable CardStatus {
    /*
     * Card is physically absent from device. (Some old modems use STATE_ABSENT when the SIM
     * is powered off. This is no longer correct, however the platform will still support this
     * legacy behavior.)
     */
    const int STATE_ABSENT = 0;
    /*
     * Card is inserted in the device
     */
    const int STATE_PRESENT = 1;
    const int STATE_ERROR = 2;
    /*
     * Card is present but not usable due to carrier restrictions
     */
    const int STATE_RESTRICTED = 3;

    /**
     * Values are STATE_
     */
    int cardState;
    /**
     * Applicable to USIM and CSIM
     */
    PinState universalPinState;
    /**
     * Value < RadioConst:CARD_MAX_APPS, -1 if none
     */
    int gsmUmtsSubscriptionAppIndex;
    /**
     * Value < RadioConst:CARD_MAX_APPS, -1 if none
     */
    int cdmaSubscriptionAppIndex;
    /**
     * Value < RadioConst:CARD_MAX_APPS, -1 if none
     */
    int imsSubscriptionAppIndex;
    /**
     * size <= RadioConst::CARD_MAX_APPS
     */
    AppStatus[] applications;
    /**
     * An Answer To Reset (ATR) is a message output by a Smart Card conforming to ISO/IEC 7816
     * standards, following electrical reset of the card's chip. The ATR conveys information about
     * the communication parameters proposed by the card, and the card's nature and state.
     *
     * This data is applicable only when cardState is STATE_PRESENT.
     */
    String atr;
    /**
     * Integrated Circuit Card IDentifier (ICCID) is Unique Identifier of the SIM CARD. File is
     * located in the SIM card at EFiccid (0x2FE2) as per ETSI 102.221. The ICCID is defined by
     * the ITU-T recommendation E.118 ISO/IEC 7816.
     *
     * This data is applicable only when cardState is STATE_PRESENT.
     */
    String iccid;
    /**
     * The EID is the eUICC identifier. The EID shall be stored within the ECASD and can be
     * retrieved by the Device at any time using the standard GlobalPlatform GET DATA command.
     *
     * This data is mandatory and applicable only when cardState is STATE_PRESENT and SIM card
     * supports eUICC.
     */
    String eid;
    /* SlotPortMapping:
     * SlotPortMapping consists of physical slot id and port id.
     * Physical slot is the actual physical slot.
     * PortId is the id (enumerated value) for the associated port available on the SIM.
     */
    SlotPortMapping slotMap;
    /**
     * Jointly supported Multiple Enabled Profiles(MEP) mode as per SGP.22 V3.0
     */
    MultipleEnabledProfilesMode supportedMepMode = MultipleEnabledProfilesMode.NONE;
}