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

Commit a629ea39 authored by Nathan Harold's avatar Nathan Harold
Browse files

Define CellInfo.UNAVAILABLE for Unreported Fields 

For all CellInfo classes, there is a common value for
fields that are unreported by the modem: Integer.MAX_VALUE.
To better document this value, this CL defines it as a
constant "UNAVAILABLE" to indicate that for whatever reason
the framework is not reporting this value to the caller.

Bug: 28171234
Test: make; make offline-sdk-docs
Change-Id: I0aa692e3f1b5478284d262ef97fd65b90bce8293
parent 4d3f84fd

api/current.txt

+1 −0
Original line number Diff line number Diff line
@@ -42107,6 +42107,7 @@ package android.telephony { 
    field public static final int CONNECTION_SECONDARY_SERVING = 2; // 0x2

    field public static final int CONNECTION_UNKNOWN = 2147483647; // 0x7fffffff

    field public static final android.os.Parcelable.Creator<android.telephony.CellInfo> CREATOR;

    field public static final int UNAVAILABLE = 2147483647; // 0x7fffffff

  }















  public final class CellInfoCdma extends android.telephony.CellInfo implements android.os.Parcelable {

























telephony/java/android/telephony/CellIdentityCdma.java



+18
−16




























Original line number
Diff line number
Diff line








@@ -16,7 +16,6 @@





























package android.telephony;





























import android.annotation.Nullable;















import android.annotation.UnsupportedAppUsage;















import android.os.Parcel;















import android.telephony.cdma.CdmaCellLocation;










@@ -56,11 +55,11 @@ public final class CellIdentityCdma extends CellIdentity {













     */















    public CellIdentityCdma() {















        super(TAG, CellInfo.TYPE_CDMA, null, null, null, null);













        mNetworkId = Integer.MAX_VALUE;













        mSystemId = Integer.MAX_VALUE;













        mBasestationId = Integer.MAX_VALUE;













        mLongitude = Integer.MAX_VALUE;













        mLatitude = Integer.MAX_VALUE;













        mNetworkId = CellInfo.UNAVAILABLE;













        mSystemId = CellInfo.UNAVAILABLE;













        mBasestationId = CellInfo.UNAVAILABLE;













        mLongitude = CellInfo.UNAVAILABLE;













        mLatitude = CellInfo.UNAVAILABLE;















    }































    /**










@@ -104,7 +103,7 @@ public final class CellIdentityCdma extends CellIdentity {













            mLongitude = lon;















            mLatitude = lat;















        } else {













            mLongitude = mLatitude = Integer.MAX_VALUE;













            mLongitude = mLatitude = CellInfo.UNAVAILABLE;















        }















    }

























@@ -130,21 +129,24 @@ public final class CellIdentityCdma extends CellIdentity {













    }































    /**













     * @return Network Id 0..65535, Integer.MAX_VALUE if unknown













     * @return Network Id 0..65535, {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE}













     *         if unavailable.















     */















    public int getNetworkId() {















        return mNetworkId;















    }































    /**













     * @return System Id 0..32767, Integer.MAX_VALUE if unknown













     * @return System Id 0..32767, {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE}













     *         if unavailable.















     */















    public int getSystemId() {















        return mSystemId;















    }































    /**













     * @return Base Station Id 0..65535, Integer.MAX_VALUE if unknown













     * @return Base Station Id 0..65535, {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE}













     *         if unavailable.















     */















    public int getBasestationId() {















        return mBasestationId;









@@ -155,7 +157,7 @@ public final class CellIdentityCdma extends CellIdentity {













     * specified in 3GPP2 C.S0005-A v6.0. It is represented in units















     * of 0.25 seconds and ranges from -2592000 to 2592000, both















     * values inclusive (corresponding to a range of -180













     * to +180 degrees). Integer.MAX_VALUE if unknown.













     * to +180 degrees). {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE} if unavailable.















     */















    public int getLongitude() {















        return mLongitude;









@@ -166,7 +168,7 @@ public final class CellIdentityCdma extends CellIdentity {













     * specified in 3GPP2 C.S0005-A v6.0. It is represented in units















     * of 0.25 seconds and ranges from -1296000 to 1296000, both















     * values inclusive (corresponding to a range of -90













     * to +90 degrees). Integer.MAX_VALUE if unknown.













     * to +90 degrees). {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE} if unavailable.















     */















    public int getLatitude() {















        return mLatitude;









@@ -182,10 +184,10 @@ public final class CellIdentityCdma extends CellIdentity {













    @Override















    public CdmaCellLocation asCellLocation() {















        CdmaCellLocation cl = new CdmaCellLocation();













        int bsid = mBasestationId != Integer.MAX_VALUE ? mBasestationId : -1;













        int sid = mSystemId != Integer.MAX_VALUE ? mSystemId : -1;













        int nid = mNetworkId != Integer.MAX_VALUE ? mNetworkId : -1;













        // lat and long already use Integer.MAX_VALUE for invalid/unknown













        int bsid = mBasestationId != CellInfo.UNAVAILABLE ? mBasestationId : -1;













        int sid = mSystemId != CellInfo.UNAVAILABLE ? mSystemId : -1;













        int nid = mNetworkId != CellInfo.UNAVAILABLE ? mNetworkId : -1;













        // lat and long already use CellInfo.UNAVAILABLE for invalid/unknown















        cl.setCellLocationData(bsid, mLatitude, mLongitude, sid, nid);















        return cl;















    }

































telephony/java/android/telephony/CellIdentityGsm.java



+27
−24




























Original line number
Diff line number
Diff line








@@ -16,7 +16,6 @@





























package android.telephony;





























import android.annotation.Nullable;















import android.annotation.UnsupportedAppUsage;















import android.os.Parcel;















import android.telephony.gsm.GsmCellLocation;










@@ -48,10 +47,10 @@ public final class CellIdentityGsm extends CellIdentity {













    @UnsupportedAppUsage















    public CellIdentityGsm() {















        super(TAG, CellInfo.TYPE_GSM, null, null, null, null);













        mLac = Integer.MAX_VALUE;













        mCid = Integer.MAX_VALUE;













        mArfcn = Integer.MAX_VALUE;













        mBsic = Integer.MAX_VALUE;













        mLac = CellInfo.UNAVAILABLE;













        mCid = CellInfo.UNAVAILABLE;













        mArfcn = CellInfo.UNAVAILABLE;













        mBsic = CellInfo.UNAVAILABLE;















    }















    /**















     * public constructor









@@ -63,7 +62,7 @@ public final class CellIdentityGsm extends CellIdentity {













     * @hide















     */















    public CellIdentityGsm(int mcc, int mnc, int lac, int cid) {













        this(lac, cid, Integer.MAX_VALUE, Integer.MAX_VALUE,













        this(lac, cid, CellInfo.UNAVAILABLE, CellInfo.UNAVAILABLE,















                String.valueOf(mcc), String.valueOf(mnc), null, null);















    }


























@@ -103,7 +102,7 @@ public final class CellIdentityGsm extends CellIdentity {













        mArfcn = arfcn;















        // In RIL BSIC is a UINT8, so 0xFF is the 'INVALID' designator















        // for inbound parcels













        mBsic = (bsic == 0xFF) ? Integer.MAX_VALUE : bsic;













        mBsic = (bsic == 0xFF) ? CellInfo.UNAVAILABLE : bsic;















    }































    private CellIdentityGsm(CellIdentityGsm cid) {









@@ -116,69 +115,73 @@ public final class CellIdentityGsm extends CellIdentity {













    }































    /**













     * @return 3-digit Mobile Country Code, 0..999, Integer.MAX_VALUE if unknown













     * @return 3-digit Mobile Country Code, 0..999,













     *         {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE} if unavailable.















     * @deprecated Use {@link #getMccString} instead.















     */















    @Deprecated















    public int getMcc() {













        return (mMccStr != null) ? Integer.valueOf(mMccStr) : Integer.MAX_VALUE;













        return (mMccStr != null) ? Integer.valueOf(mMccStr) : CellInfo.UNAVAILABLE;















    }































    /**













     * @return 2 or 3-digit Mobile Network Code, 0..999, Integer.MAX_VALUE if unknown













     * @return 2 or 3-digit Mobile Network Code, 0..999,













     *         {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE} if unavailable.















     * @deprecated Use {@link #getMncString} instead.















     */















    @Deprecated















    public int getMnc() {













        return (mMncStr != null) ? Integer.valueOf(mMncStr) : Integer.MAX_VALUE;













        return (mMncStr != null) ? Integer.valueOf(mMncStr) : CellInfo.UNAVAILABLE;















    }































    /**













     * @return 16-bit Location Area Code, 0..65535, Integer.MAX_VALUE if unknown













     * @return 16-bit Location Area Code, 0..65535,













     *         {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE} if unavailable.















     */















    public int getLac() {















        return mLac;















    }































    /**













     * @return CID













     * Either 16-bit GSM Cell Identity described













     * in TS 27.007, 0..65535, Integer.MAX_VALUE if unknown













     * @return 16-bit GSM Cell Identity described in TS 27.007, 0..65535,













     *         {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE} if unavailable.















     */















    public int getCid() {















        return mCid;















    }































    /**













     * @return 16-bit GSM Absolute RF Channel Number, Integer.MAX_VALUE if unknown













     * @return 16-bit GSM Absolute RF Channel Number,













     *         {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE} if unavailable.















     */















    public int getArfcn() {















        return mArfcn;















    }































    /**













     * @return 6-bit Base Station Identity Code, Integer.MAX_VALUE if unknown













     * @return 6-bit Base Station Identity Code,













     *         {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE} if unavailable.















     */















    public int getBsic() {















        return mBsic;















    }































    /**













     * @return a 5 or 6 character string (MCC+MNC), null if any field is unknown













     * @return a 5 or 6 character string (MCC+MNC), null if any field is unknown.















     */















    public String getMobileNetworkOperator() {















        return (mMccStr == null || mMncStr == null) ? null : mMccStr + mMncStr;















    }































    /**













     * @return Mobile Country Code in string format, null if unknown













     * @return Mobile Country Code in string format, null if unavailable.















     */















    public String getMccString() {















        return mMccStr;















    }































    /**













     * @return Mobile Network Code in string format, null if unknown













     * @return Mobile Network Code in string format, null if unavailable.















     */















    public String getMncString() {















        return mMncStr;









@@ -192,19 +195,19 @@ public final class CellIdentityGsm extends CellIdentity {





























    /**















     * @deprecated Primary Scrambling Code is not applicable to GSM.













     * @return Integer.MAX_VALUE, undefined for GSM













     * @return {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE} - undefined for GSM















     */















    @Deprecated















    public int getPsc() {













        return Integer.MAX_VALUE;













        return CellInfo.UNAVAILABLE;















    }































    /** @hide */















    @Override















    public GsmCellLocation asCellLocation() {















        GsmCellLocation cl = new GsmCellLocation();













        int lac = mLac != Integer.MAX_VALUE ? mLac : -1;













        int cid = mCid != Integer.MAX_VALUE ? mCid : -1;













        int lac = mLac != CellInfo.UNAVAILABLE ? mLac : -1;













        int cid = mCid != CellInfo.UNAVAILABLE ? mCid : -1;















        cl.setLacAndCid(lac, cid);















        cl.setPsc(-1);















        return cl;

































telephony/java/android/telephony/CellIdentityLte.java



+28
−22




























Original line number
Diff line number
Diff line








@@ -16,7 +16,6 @@





























package android.telephony;





























import android.annotation.Nullable;















import android.annotation.UnsupportedAppUsage;















import android.os.Parcel;















import android.telephony.gsm.GsmCellLocation;










@@ -49,11 +48,11 @@ public final class CellIdentityLte extends CellIdentity {













    @UnsupportedAppUsage















    public CellIdentityLte() {















        super(TAG, CellInfo.TYPE_LTE, null, null, null, null);













        mCi = Integer.MAX_VALUE;













        mPci = Integer.MAX_VALUE;













        mTac = Integer.MAX_VALUE;













        mEarfcn = Integer.MAX_VALUE;













        mBandwidth = Integer.MAX_VALUE;













        mCi = CellInfo.UNAVAILABLE;













        mPci = CellInfo.UNAVAILABLE;













        mTac = CellInfo.UNAVAILABLE;













        mEarfcn = CellInfo.UNAVAILABLE;













        mBandwidth = CellInfo.UNAVAILABLE;















    }































    /**









@@ -68,7 +67,7 @@ public final class CellIdentityLte extends CellIdentity {













     */















    @UnsupportedAppUsage















    public CellIdentityLte(int mcc, int mnc, int ci, int pci, int tac) {













        this(ci, pci, tac, Integer.MAX_VALUE, Integer.MAX_VALUE, String.valueOf(mcc),













        this(ci, pci, tac, CellInfo.UNAVAILABLE, CellInfo.UNAVAILABLE, String.valueOf(mcc),















                String.valueOf(mnc), null, null);















    }

























@@ -84,7 +83,7 @@ public final class CellIdentityLte extends CellIdentity {













     * @hide















     */















    public CellIdentityLte(int mcc, int mnc, int ci, int pci, int tac, int earfcn) {













        this(ci, pci, tac, earfcn, Integer.MAX_VALUE, String.valueOf(mcc), String.valueOf(mnc),













        this(ci, pci, tac, earfcn, CellInfo.UNAVAILABLE, String.valueOf(mcc), String.valueOf(mnc),















                null, null);















    }


























@@ -122,74 +121,81 @@ public final class CellIdentityLte extends CellIdentity {













    }































    /**













     * @return 3-digit Mobile Country Code, 0..999, Integer.MAX_VALUE if unknown













     * @return 3-digit Mobile Country Code, 0..999,













     *         {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE} if unavailable.















     * @deprecated Use {@link #getMccString} instead.















     */















    @Deprecated















    public int getMcc() {













        return (mMccStr != null) ? Integer.valueOf(mMccStr) : Integer.MAX_VALUE;













        return (mMccStr != null) ? Integer.valueOf(mMccStr) : CellInfo.UNAVAILABLE;















    }































    /**













     * @return 2 or 3-digit Mobile Network Code, 0..999, Integer.MAX_VALUE if unknown













     * @return 2 or 3-digit Mobile Network Code, 0..999,













     *         {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE} if unavailable.















     * @deprecated Use {@link #getMncString} instead.















     */















    @Deprecated















    public int getMnc() {













        return (mMncStr != null) ? Integer.valueOf(mMncStr) : Integer.MAX_VALUE;













        return (mMncStr != null) ? Integer.valueOf(mMncStr) : CellInfo.UNAVAILABLE;















    }































    /**













     * @return 28-bit Cell Identity, Integer.MAX_VALUE if unknown













     * @return 28-bit Cell Identity,













     *         {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE} if unavailable.















     */















    public int getCi() {















        return mCi;















    }































    /**













     * @return Physical Cell Id 0..503, Integer.MAX_VALUE if unknown













     * @return Physical Cell Id 0..503,













     *         {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE} if unavailable.















     */















    public int getPci() {















        return mPci;















    }































    /**













     * @return 16-bit Tracking Area Code, Integer.MAX_VALUE if unknown













     * @return 16-bit Tracking Area Code,













     *         {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE} if unavailable.















     */















    public int getTac() {















        return mTac;















    }































    /**













     * @return 18-bit Absolute RF Channel Number, Integer.MAX_VALUE if unknown













     * @return 18-bit Absolute RF Channel Number,













     *         {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE} if unavailable.















     */















    public int getEarfcn() {















        return mEarfcn;















    }































    /**













     * @return Cell bandwidth in kHz, Integer.MAX_VALUE if unknown













     * @return Cell bandwidth in kHz,













     *         {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE} if unavailable.















     */















    public int getBandwidth() {















        return mBandwidth;















    }































    /**













     * @return Mobile Country Code in string format, null if unknown













     * @return Mobile Country Code in string format, null if unavailable.















     */















    public String getMccString() {















        return mMccStr;















    }































    /**













     * @return Mobile Network Code in string format, null if unknown













     * @return Mobile Network Code in string format, null if unavailable.















     */















    public String getMncString() {















        return mMncStr;















    }































    /**













     * @return a 5 or 6 character string (MCC+MNC), null if any field is unknown













     * @return a 5 or 6 character string (MCC+MNC), null if any field is unknown.















     */















    public String getMobileNetworkOperator() {















        return (mMccStr == null || mMncStr == null) ? null : mMccStr + mMncStr;









@@ -216,8 +222,8 @@ public final class CellIdentityLte extends CellIdentity {













    @Override















    public GsmCellLocation asCellLocation() {















        GsmCellLocation cl = new GsmCellLocation();













        int tac = mTac != Integer.MAX_VALUE ? mTac : -1;













        int cid = mCi != Integer.MAX_VALUE ? mCi : -1;













        int tac = mTac != CellInfo.UNAVAILABLE ? mTac : -1;













        int cid = mCi != CellInfo.UNAVAILABLE ? mCi : -1;















        cl.setLacAndCid(tac, cid);















        cl.setPsc(0);















        return cl;

































telephony/java/android/telephony/CellIdentityTdscdma.java



+26
−18




























Original line number
Diff line number
Diff line








@@ -28,11 +28,12 @@ public final class CellIdentityTdscdma extends CellIdentity {













    private static final String TAG = CellIdentityTdscdma.class.getSimpleName();















    private static final boolean DBG = false;





























    // 16-bit Location Area Code, 0..65535, INT_MAX if unknown.













    // 16-bit Location Area Code, 0..65535, CellInfo.UNAVAILABLE if unknown.















    private final int mLac;













    // 28-bit UMTS Cell Identity described in TS 25.331, 0..268435455, INT_MAX if unknown.













    // 28-bit UMTS Cell Identity described in TS 25.331, 0..268435455, CellInfo.UNAVAILABLE













    // if unknown.















    private final int mCid;













    // 8-bit Cell Parameters ID described in TS 25.331, 0..127, INT_MAX if unknown.













    // 8-bit Cell Parameters ID described in TS 25.331, 0..127, CellInfo.UNAVAILABLE if unknown.















    private final int mCpid;















    // 16-bit UMTS Absolute RF Channel Number described in TS 25.101 sec. 5.4.3















    private final int mUarfcn;









@@ -42,18 +43,20 @@ public final class CellIdentityTdscdma extends CellIdentity {













     */















    public CellIdentityTdscdma() {















        super(TAG, CellInfo.TYPE_TDSCDMA, null, null, null, null);













        mLac = Integer.MAX_VALUE;













        mCid = Integer.MAX_VALUE;













        mCpid = Integer.MAX_VALUE;













        mUarfcn = Integer.MAX_VALUE;













        mLac = CellInfo.UNAVAILABLE;













        mCid = CellInfo.UNAVAILABLE;













        mCpid = CellInfo.UNAVAILABLE;













        mUarfcn = CellInfo.UNAVAILABLE;















    }































    /**















     * @param mcc 3-digit Mobile Country Code, 0..999















     * @param mnc 2 or 3-digit Mobile Network Code, 0..999













     * @param lac 16-bit Location Area Code, 0..65535, INT_MAX if unknown













     * @param cid 28-bit UMTS Cell Identity described in TS 25.331, 0..268435455, INT_MAX if unknown













     * @param cpid 8-bit Cell Parameters ID described in TS 25.331, 0..127, INT_MAX if unknown













     * @param lac 16-bit Location Area Code, 0..65535, CellInfo.UNAVAILABLE if unknown













     * @param cid 28-bit UMTS Cell Identity described in TS 25.331, 0..268435455, CellInfo.













     *        UNAVAILABLE if unknown













     * @param cpid 8-bit Cell Parameters ID described in TS 25.331, 0..127, CellInfo.UNAVAILABLE













     *        if unknown















     * @param uarfcn 16-bit UMTS Absolute RF Channel Number described in TS 25.101 sec. 5.4.3















     *















     * @hide









@@ -65,9 +68,11 @@ public final class CellIdentityTdscdma extends CellIdentity {













    /**















     * @param mcc 3-digit Mobile Country Code in string format















     * @param mnc 2 or 3-digit Mobile Network Code in string format













     * @param lac 16-bit Location Area Code, 0..65535, INT_MAX if unknown













     * @param cid 28-bit UMTS Cell Identity described in TS 25.331, 0..268435455, INT_MAX if unknown













     * @param cpid 8-bit Cell Parameters ID described in TS 25.331, 0..127, INT_MAX if unknown













     * @param lac 16-bit Location Area Code, 0..65535, CellInfo.UNAVAILABLE if unknown













     * @param cid 28-bit UMTS Cell Identity described in TS 25.331, 0..268435455,













     *        CellInfo.UNAVAILABLE if unknown













     * @param cpid 8-bit Cell Parameters ID described in TS 25.331, 0..127,













     *        CellInfo.UNAVAILABLE if unknown















     * @param uarfcn 16-bit UMTS Absolute RF Channel Number described in TS 25.101 sec. 5.4.3















     * @param alphal long alpha Operator Name String or Enhanced Operator Name String















     * @param alphas short alpha Operator Name String or Enhanced Operator Name String










@@ -116,21 +121,24 @@ public final class CellIdentityTdscdma extends CellIdentity {













    }































    /**













     * @return 16-bit Location Area Code, 0..65535, INT_MAX if unknown













     * @return 16-bit Location Area Code, 0..65535,













     *         {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE} if unavailable.















     */















    public int getLac() {















        return mLac;















    }































    /**













     * @return 28-bit UMTS Cell Identity described in TS 25.331, 0..268435455, INT_MAX if unknown













     * @return 28-bit UMTS Cell Identity described in TS 25.331, 0..268435455,













     *         {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE} if unavailable.















     */















    public int getCid() {















        return mCid;















    }































    /**













     * @return 8-bit Cell Parameters ID described in TS 25.331, 0..127, INT_MAX if unknown













     * @return 8-bit Cell Parameters ID described in TS 25.331, 0..127,













     *         {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE} if unavailable.















     */















    public int getCpid() {















        return mCpid;









@@ -146,8 +154,8 @@ public final class CellIdentityTdscdma extends CellIdentity {













    @Override















    public GsmCellLocation asCellLocation() {















        GsmCellLocation cl = new GsmCellLocation();













        int lac = mLac != Integer.MAX_VALUE ? mLac : -1;













        int cid = mCid != Integer.MAX_VALUE ? mCid : -1;













        int lac = mLac != CellInfo.UNAVAILABLE ? mLac : -1;













        int cid = mCid != CellInfo.UNAVAILABLE ? mCid : -1;















        cl.setLacAndCid(lac, cid);















        cl.setPsc(-1); // There is no PSC for TD-SCDMA; not using this for CPI to stem shenanigans















        return cl;