radio/aidl/android/hardware/radio/config/SimSlotStatus.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.config;

import android.hardware.radio.config.MultipleEnabledProfilesMode;
import android.hardware.radio.config.SimPortInfo;

/** @hide */
@VintfStability
@JavaDerive(toString=true)
parcelable SimSlotStatus {
    /**
     * Card state in the physical slot. Values are CardStatus.[STATE_ABSENT, STATE_PRESENT,
     * STATE_ERROR, STATE_RESTRICTED].
     */
    int cardState;
    /**
     * 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 CardStatus.STATE_PRESENT.
     */
    String atr;
    /**
     * 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 CardStatus.STATE_PRESENT and SIM
     * card supports eUICC.
     */
    String eid;
    /**
     * PortInfo contains the ICCID, logical slot ID, and port state.
     * Cardstate has no relationship with whether the slot is active or inactive. Should always
     * report up at least 1 port otherwise the logicalSlotIndex and portActive info will be lost.
     * For example, the pSIM can be removed, but the slot can still be active. In that case, the
     * SIM_STATUS reported for the corresponding logical stack will show CARDSTATE_ABSENT.
     * Similarly, even if there is no profile enabled on the eSIM, that port can still be the
     * active port in the slot mapping.
     */
    SimPortInfo[] portInfo;
    /**
     * Jointly supported Multiple Enabled Profiles(MEP) mode as per SGP.22 V3.0. Should always
     * report proper MEP mode irrespective of whether the slot is active or inactive.
     */
    MultipleEnabledProfilesMode supportedMepMode = MultipleEnabledProfilesMode.NONE;
}