CellSignalStrengthLte.java revision 90bc8e30ad3b0c211ef6e4a2e54cfadd28df1b2d 
1/*
2 * Copyright (C) 2012 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.telephony;
18
19import android.os.Parcel;
20import android.os.Parcelable;
21import android.telephony.Rlog;
22
23/**
24 * LTE signal strength related information.
25 */
26public final class CellSignalStrengthLte extends CellSignalStrength implements Parcelable {
27
28    private static final String LOG_TAG = "CellSignalStrengthLte";
29    private static final boolean DBG = false;
30
31    private int mSignalStrength;
32    private int mRsrp;
33    private int mRsrq;
34    private int mRssnr;
35    private int mCqi;
36    private int mTimingAdvance;
37
38    /**
39     * Empty constructor
40     *
41     * @hide
42     */
43    public CellSignalStrengthLte() {
44        setDefaultValues();
45    }
46
47    /**
48     * Constructor
49     *
50     * @hide
51     */
52    public CellSignalStrengthLte(int signalStrength, int rsrp, int rsrq, int rssnr, int cqi,
53            int timingAdvance) {
54        initialize(signalStrength, rsrp, rsrq, rssnr, cqi, timingAdvance);
55    }
56
57    /**
58     * Copy constructors
59     *
60     * @param s Source SignalStrength
61     *
62     * @hide
63     */
64    public CellSignalStrengthLte(CellSignalStrengthLte s) {
65        copyFrom(s);
66    }
67
68    /**
69     * Initialize all the values
70     *
71     * @param lteSignalStrength
72     * @param rsrp
73     * @param rsrq
74     * @param rssnr
75     * @param cqi
76     *
77     * @hide
78     */
79    public void initialize(int lteSignalStrength, int rsrp, int rsrq, int rssnr, int cqi,
80            int timingAdvance) {
81        mSignalStrength = lteSignalStrength;
82        mRsrp = rsrp;
83        mRsrq = rsrq;
84        mRssnr = rssnr;
85        mCqi = cqi;
86        mTimingAdvance = timingAdvance;
87    }
88
89    /**
90     * Initialize from the SignalStrength structure.
91     *
92     * @param ss
93     *
94     * @hide
95     */
96    public void initialize(SignalStrength ss, int timingAdvance) {
97        mSignalStrength = ss.getLteSignalStrength();
98        mRsrp = ss.getLteRsrp();
99        mRsrq = ss.getLteRsrq();
100        mRssnr = ss.getLteRssnr();
101        mCqi = ss.getLteCqi();
102        mTimingAdvance = timingAdvance;
103    }
104
105    /**
106     * @hide
107     */
108    protected void copyFrom(CellSignalStrengthLte s) {
109        mSignalStrength = s.mSignalStrength;
110        mRsrp = s.mRsrp;
111        mRsrq = s.mRsrq;
112        mRssnr = s.mRssnr;
113        mCqi = s.mCqi;
114        mTimingAdvance = s.mTimingAdvance;
115    }
116
117    /**
118     * @hide
119     */
120    @Override
121    public CellSignalStrengthLte copy() {
122        return new CellSignalStrengthLte(this);
123    }
124
125    /** @hide */
126    @Override
127    public void setDefaultValues() {
128        mSignalStrength = Integer.MAX_VALUE;
129        mRsrp = Integer.MAX_VALUE;
130        mRsrq = Integer.MAX_VALUE;
131        mRssnr = Integer.MAX_VALUE;
132        mCqi = Integer.MAX_VALUE;
133        mTimingAdvance = Integer.MAX_VALUE;
134    }
135
136    /**
137     * Get signal level as an int from 0..4
138     */
139    @Override
140    public int getLevel() {
141        int levelRsrp = 0;
142        int levelRssnr = 0;
143
144        if (mRsrp == Integer.MAX_VALUE) levelRsrp = 0;
145        else if (mRsrp >= -95) levelRsrp = SIGNAL_STRENGTH_GREAT;
146        else if (mRsrp >= -105) levelRsrp = SIGNAL_STRENGTH_GOOD;
147        else if (mRsrp >= -115) levelRsrp = SIGNAL_STRENGTH_MODERATE;
148        else levelRsrp = SIGNAL_STRENGTH_POOR;
149
150        // See RIL_LTE_SignalStrength in ril.h
151        if (mRssnr == Integer.MAX_VALUE) levelRssnr = 0;
152        else if (mRssnr >= 45) levelRssnr = SIGNAL_STRENGTH_GREAT;
153        else if (mRssnr >= 10) levelRssnr = SIGNAL_STRENGTH_GOOD;
154        else if (mRssnr >= -30) levelRssnr = SIGNAL_STRENGTH_MODERATE;
155        else levelRssnr = SIGNAL_STRENGTH_POOR;
156
157        int level;
158        if (mRsrp == Integer.MAX_VALUE)
159            level = levelRssnr;
160        else if (mRssnr == Integer.MAX_VALUE)
161            level = levelRsrp;
162        else
163            level = (levelRssnr < levelRsrp) ? levelRssnr : levelRsrp;
164
165        if (DBG) log("Lte rsrp level: " + levelRsrp
166                + " snr level: " + levelRssnr + " level: " + level);
167        return level;
168    }
169
170    /**
171     * @hide
172     */
173    public int getRsrq() {
174        return mRsrq;
175    }
176
177    /**
178     * @hide
179     */
180    public int getRssnr() {
181        return mRssnr;
182    }
183
184    /**
185     * Get signal strength as dBm
186     */
187    @Override
188    public int getDbm() {
189        return mRsrp;
190    }
191
192    /**
193     * Get the LTE signal level as an asu value between 0..97, 99 is unknown
194     * Asu is calculated based on 3GPP RSRP. Refer to 3GPP 27.007 (Ver 10.3.0) Sec 8.69
195     */
196    @Override
197    public int getAsuLevel() {
198        int lteAsuLevel = 99;
199        int lteDbm = getDbm();
200        if (lteDbm == Integer.MAX_VALUE) lteAsuLevel = 99;
201        else if (lteDbm <= -140) lteAsuLevel = 0;
202        else if (lteDbm >= -43) lteAsuLevel = 97;
203        else lteAsuLevel = lteDbm + 140;
204        if (DBG) log("Lte Asu level: "+lteAsuLevel);
205        return lteAsuLevel;
206    }
207
208    /**
209     * Get the timing advance value for LTE, as a value between 0..63.
210     * Integer.MAX_VALUE is reported when there is no active RRC
211     * connection. Refer to 3GPP 36.213 Sec 4.2.3
212     * @return the LTE timing advance, if available.
213     */
214    public int getTimingAdvance() {
215        return mTimingAdvance;
216    }
217
218    @Override
219    public int hashCode() {
220        int primeNum = 31;
221        return (mSignalStrength * primeNum) + (mRsrp * primeNum)
222                + (mRsrq * primeNum) + (mRssnr * primeNum) + (mCqi * primeNum)
223                + (mTimingAdvance * primeNum);
224    }
225
226    @Override
227    public boolean equals (Object o) {
228        CellSignalStrengthLte s;
229
230        try {
231            s = (CellSignalStrengthLte) o;
232        } catch (ClassCastException ex) {
233            return false;
234        }
235
236        if (o == null) {
237            return false;
238        }
239
240        return mSignalStrength == s.mSignalStrength
241                && mRsrp == s.mRsrp
242                && mRsrq == s.mRsrq
243                && mRssnr == s.mRssnr
244                && mCqi == s.mCqi
245                && mTimingAdvance == s.mTimingAdvance;
246    }
247
248    /**
249     * @return string representation.
250     */
251    @Override
252    public String toString() {
253        return "CellSignalStrengthLte:"
254                + " ss=" + mSignalStrength
255                + " rsrp=" + mRsrp
256                + " rsrq=" + mRsrq
257                + " rssnr=" + mRssnr
258                + " cqi=" + mCqi
259                + " ta=" + mTimingAdvance;
260    }
261
262    /** Implement the Parcelable interface */
263    @Override
264    public void writeToParcel(Parcel dest, int flags) {
265        if (DBG) log("writeToParcel(Parcel, int): " + toString());
266        dest.writeInt(mSignalStrength);
267        // Need to multiply rsrp and rsrq by -1
268        // to ensure consistency when reading values written here
269        // unless the values are invalid
270        dest.writeInt(mRsrp * (mRsrp != Integer.MAX_VALUE ? -1 : 1));
271        dest.writeInt(mRsrq * (mRsrq != Integer.MAX_VALUE ? -1 : 1));
272        dest.writeInt(mRssnr);
273        dest.writeInt(mCqi);
274        dest.writeInt(mTimingAdvance);
275    }
276
277    /**
278     * Construct a SignalStrength object from the given parcel
279     * where the token is already been processed.
280     */
281    private CellSignalStrengthLte(Parcel in) {
282        mSignalStrength = in.readInt();
283        // rsrp and rsrq are written into the parcel as positive values.
284        // Need to convert into negative values unless the values are invalid
285        mRsrp = in.readInt();
286        if (mRsrp != Integer.MAX_VALUE) mRsrp *= -1;
287        mRsrq = in.readInt();
288        if (mRsrq != Integer.MAX_VALUE) mRsrq *= -1;
289        mRssnr = in.readInt();
290        mCqi = in.readInt();
291        mTimingAdvance = in.readInt();
292        if (DBG) log("CellSignalStrengthLte(Parcel): " + toString());
293    }
294
295    /** Implement the Parcelable interface */
296    @Override
297    public int describeContents() {
298        return 0;
299    }
300
301    /** Implement the Parcelable interface */
302    @SuppressWarnings("hiding")
303    public static final Parcelable.Creator<CellSignalStrengthLte> CREATOR =
304            new Parcelable.Creator<CellSignalStrengthLte>() {
305        @Override
306        public CellSignalStrengthLte createFromParcel(Parcel in) {
307            return new CellSignalStrengthLte(in);
308        }
309
310        @Override
311        public CellSignalStrengthLte[] newArray(int size) {
312            return new CellSignalStrengthLte[size];
313        }
314    };
315
316    /**
317     * log
318     */
319    private static void log(String s) {
320        Rlog.w(LOG_TAG, s);
321    }
322}
323