CellSignalStrengthLte.java revision 2900a3fae6e3da65522ffc16673ab1757352afbb 
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.util.Log;
22
23/**
24 * LTE signal strength related information.
25 */
26public 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.getLteSignalStrenght();
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 LTE as level 0..4
138     *
139     * @hide
140     */
141    @Override
142    public int getLevel() {
143        int levelRsrp = 0;
144        int levelRssnr = 0;
145
146        if (mRsrp == Integer.MAX_VALUE) levelRsrp = 0;
147        else if (mRsrp >= -95) levelRsrp = SIGNAL_STRENGTH_GREAT;
148        else if (mRsrp >= -105) levelRsrp = SIGNAL_STRENGTH_GOOD;
149        else if (mRsrp >= -115) levelRsrp = SIGNAL_STRENGTH_MODERATE;
150        else levelRsrp = SIGNAL_STRENGTH_POOR;
151
152        // See RIL_LTE_SignalStrength in ril.h
153        if (mRssnr == Integer.MAX_VALUE) levelRssnr = 0;
154        else if (mRssnr >= 45) levelRssnr = SIGNAL_STRENGTH_GREAT;
155        else if (mRssnr >= 10) levelRssnr = SIGNAL_STRENGTH_GOOD;
156        else if (mRssnr >= -30) levelRssnr = SIGNAL_STRENGTH_MODERATE;
157        else levelRssnr = SIGNAL_STRENGTH_POOR;
158
159        int level;
160        if (mRsrp == Integer.MAX_VALUE)
161            level = levelRssnr;
162        else if (mRssnr == Integer.MAX_VALUE)
163            level = levelRsrp;
164        else
165            level = (levelRssnr < levelRsrp) ? levelRssnr : levelRsrp;
166
167        if (DBG) log("Lte rsrp level: " + levelRsrp
168                + " snr level: " + levelRssnr + " level: " + level);
169        return level;
170    }
171
172    /**
173     * Get LTE as dBm
174     *
175     * @hide
176     */
177    @Override
178    public int getDbm() {
179        return mRsrp;
180    }
181
182    /**
183     * Get the LTE signal level as an asu value between 0..97, 99 is unknown
184     * Asu is calculated based on 3GPP RSRP. Refer to 3GPP 27.007 (Ver 10.3.0) Sec 8.69
185     *
186     * @hide
187     */
188    @Override
189    public int getAsuLevel() {
190        int lteAsuLevel = 99;
191        int lteDbm = getDbm();
192        if (lteDbm <= -140) lteAsuLevel = 0;
193        else if (lteDbm >= -43) lteAsuLevel = 97;
194        else lteAsuLevel = lteDbm + 140;
195        if (DBG) log("Lte Asu level: "+lteAsuLevel);
196        return lteAsuLevel;
197    }
198
199    /**
200     * Get the timing advance value for LTE.
201     * See 3GPP xxxx
202     */
203    public int getTimingAdvance() {
204        return mTimingAdvance;
205    }
206
207    @Override
208    public int hashCode() {
209        int primeNum = 31;
210        return (mSignalStrength * primeNum) + (mRsrp * primeNum)
211                + (mRsrq * primeNum) + (mRssnr * primeNum) + (mCqi * primeNum)
212                + (mTimingAdvance * primeNum);
213    }
214
215    @Override
216    public boolean equals (Object o) {
217        CellSignalStrengthLte s;
218
219        try {
220            s = (CellSignalStrengthLte) o;
221        } catch (ClassCastException ex) {
222            return false;
223        }
224
225        if (o == null) {
226            return false;
227        }
228
229        return mSignalStrength == s.mSignalStrength
230                && mRsrp == s.mRsrp
231                && mRsrq == s.mRsrq
232                && mRssnr == s.mRssnr
233                && mCqi == s.mCqi
234                && mTimingAdvance == s.mTimingAdvance;
235    }
236
237    /**
238     * @return string representation.
239     */
240    @Override
241    public String toString() {
242        return "CellSignalStrengthLte:"
243                + " ss=" + mSignalStrength
244                + " rsrp=" + mRsrp
245                + " rsrq=" + mRsrq
246                + " rssnr=" + mRssnr
247                + " cqi=" + mCqi
248                + " ta=" + mTimingAdvance;
249    }
250
251    /** Implement the Parcelable interface */
252    @Override
253    public void writeToParcel(Parcel dest, int flags) {
254        if (DBG) log("writeToParcel(Parcel, int): " + toString());
255        dest.writeInt(CellSignalStrength.TYPE_LTE);
256        dest.writeInt(mSignalStrength);
257        dest.writeInt(mRsrp);
258        dest.writeInt(mRsrq);
259        dest.writeInt(mRssnr);
260        dest.writeInt(mCqi);
261        dest.writeInt(mTimingAdvance);
262    }
263
264    /**
265     * Construct a SignalStrength object from the given parcel
266     * where the token is already been processed.
267     */
268    private CellSignalStrengthLte(Parcel in) {
269        mSignalStrength = in.readInt();
270        mRsrp = in.readInt();
271        mRsrq = in.readInt();
272        mRssnr = in.readInt();
273        mCqi = in.readInt();
274        mTimingAdvance = in.readInt();
275        if (DBG) log("CellSignalStrengthLte(Parcel): " + toString());
276    }
277
278    /** Implement the Parcelable interface */
279    @Override
280    public int describeContents() {
281        return 0;
282    }
283
284    /** Implement the Parcelable interface */
285    @SuppressWarnings("hiding")
286    public static final Parcelable.Creator<CellSignalStrengthLte> CREATOR =
287            new Parcelable.Creator<CellSignalStrengthLte>() {
288        @Override
289        public CellSignalStrengthLte createFromParcel(Parcel in) {
290            if (in.readInt() != CellSignalStrength.TYPE_LTE) {
291                throw new RuntimeException("Expecting TYPE_LTE");
292            }
293            return createFromParcelBody(in);
294        }
295
296        @Override
297        public CellSignalStrengthLte[] newArray(int size) {
298            return new CellSignalStrengthLte[size];
299        }
300    };
301
302    /** @hide */
303    public static CellSignalStrengthLte createFromParcelBody(Parcel in) {
304        return new CellSignalStrengthLte(in);
305    }
306
307    /**
308     * log
309     */
310    private static void log(String s) {
311        Log.w(LOG_TAG, s);
312    }
313}
314