Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation to specify units and accepted ranges.

Browse Source 
Bug: b/212721664
Test: make
Change-Id: Ie3cbbc01f20ac93f30788ce721b1f599e10914ca
This commit is contained in:
Jack Nudelman
2022-02-28 14:48:46 -08:00
parent 7a25b6f379
commit 35d623833b
2 changed files with 48 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
telephony/java/android/telephony/CarrierConfigManager.java
View File

@@ -3778,30 +3778,42 @@ public class CarrierConfigManager {
public static final String KEY_OPPORTUNISTIC_ESIM_DOWNLOAD_VIA_WIFI_ONLY_BOOL =
"opportunistic_esim_download_via_wifi_only_bool";
/**
* Controls RSRP threshold at which OpportunisticNetworkService will decide whether
/**
* Controls RSRP threshold, in dBm, at which OpportunisticNetworkService will decide whether
* the opportunistic network is good enough for internet data.
*
* <p>The value of {@link CellSignalStrengthLte#getRsrp()} will be compared with this
* threshold.
*/
public static final String KEY_OPPORTUNISTIC_NETWORK_ENTRY_THRESHOLD_RSRP_INT =
"opportunistic_network_entry_threshold_rsrp_int";
/**
* Controls RSSNR threshold at which OpportunisticNetworkService will decide whether
* the opportunistic network is good enough for internet data.
* Controls RSSNR threshold, in dB, at which OpportunisticNetworkService will
* decide whether the opportunistic network is good enough for internet data.
*
* <p>The value of {@link CellSignalStrengthLte#getRssnr()} will be compared with this
* threshold.
*/
public static final String KEY_OPPORTUNISTIC_NETWORK_ENTRY_THRESHOLD_RSSNR_INT =
"opportunistic_network_entry_threshold_rssnr_int";
/**
* Controls RSRP threshold below which OpportunisticNetworkService will decide whether
* Controls RSRP threshold, in dBm, below which OpportunisticNetworkService will decide whether
* the opportunistic network available is not good enough for internet data.
*
* <p>The value of {@link CellSignalStrengthLte#getRsrp()} will be compared with this
* threshold.
*/
public static final String KEY_OPPORTUNISTIC_NETWORK_EXIT_THRESHOLD_RSRP_INT =
"opportunistic_network_exit_threshold_rsrp_int";
/**
* Controls RSSNR threshold below which OpportunisticNetworkService will decide whether
* the opportunistic network available is not good enough for internet data.
* Controls RSSNR threshold, in dB, below which OpportunisticNetworkService will
* decide whether the opportunistic network available is not good enough for internet data.
*
* <p>The value of {@link CellSignalStrengthLte#getRssnr()} will be compared with this
* threshold.
*/
public static final String KEY_OPPORTUNISTIC_NETWORK_EXIT_THRESHOLD_RSSNR_INT =
"opportunistic_network_exit_threshold_rssnr_int";
@@ -3899,7 +3911,7 @@ public class CarrierConfigManager {
* good enough for internet data. Note other factors may be considered for the final
* decision.
*
* <p>The value of {@link CellSignalStrengthNr#getSsRsrp} will be compared with this
* <p>The value of {@link CellSignalStrengthNr#getSsRsrp()} will be compared with this
* threshold.
*
* @hide
@@ -3926,7 +3938,7 @@ public class CarrierConfigManager {
* good enough for internet data. Note other factors may be considered for the final
* decision.
*
* <p>The value of {@link CellSignalStrengthNr#getSsRsrq} will be compared with this
* <p>The value of {@link CellSignalStrengthNr#getSsRsrq()} will be compared with this
* threshold.
*
* @hide
@@ -3953,6 +3965,9 @@ public class CarrierConfigManager {
* be considered good enough for internet data. Note other factors may be considered
* for the final decision.
*
* <p>The value of {@link CellSignalStrengthNr#getSsRsrp()} will be compared with this
* threshold.
*
* @hide
*/
public static final String KEY_EXIT_THRESHOLD_SS_RSRP_INT =
@@ -3976,6 +3991,9 @@ public class CarrierConfigManager {
* be considered good enough for internet data. Note other factors may be considered
* for the final decision.
*
* <p>The value of {@link CellSignalStrengthNr#getSsRsrq()} will be compared with this
* threshold.
*
* @hide
*/
public static final String KEY_EXIT_THRESHOLD_SS_RSRQ_DOUBLE =
@@ -6180,9 +6198,9 @@ public class CarrierConfigManager {
/* Default value is minimum RSRP level needed for SIGNAL_STRENGTH_MODERATE */
sDefaults.putInt(KEY_OPPORTUNISTIC_NETWORK_EXIT_THRESHOLD_RSRP_INT, -118);
/* Default value is minimum RSSNR level needed for SIGNAL_STRENGTH_GOOD */
sDefaults.putInt(KEY_OPPORTUNISTIC_NETWORK_ENTRY_THRESHOLD_RSSNR_INT, 45);
sDefaults.putInt(KEY_OPPORTUNISTIC_NETWORK_ENTRY_THRESHOLD_RSSNR_INT, 5);
/* Default value is minimum RSSNR level needed for SIGNAL_STRENGTH_MODERATE */
sDefaults.putInt(KEY_OPPORTUNISTIC_NETWORK_EXIT_THRESHOLD_RSSNR_INT, 10);
sDefaults.putInt(KEY_OPPORTUNISTIC_NETWORK_EXIT_THRESHOLD_RSSNR_INT, 1);
/* Default value is 1024 kbps */
sDefaults.putInt(KEY_OPPORTUNISTIC_NETWORK_ENTRY_THRESHOLD_BANDWIDTH_INT, 1024);
/* Default value is 10 seconds */

35
telephony/java/android/telephony/CellSignalStrengthLte.java
View File

@@ -125,13 +125,13 @@ public final class CellSignalStrengthLte extends CellSignalStrength implements P
/**
* Construct a cell signal strength
*
* @param rssi in dBm [-113,-51], UNKNOWN
* @param rsrp in dBm [-140,-43], UNKNOWN
* @param rsrq in dB [-34, 3], UNKNOWN
* @param rssnr in dB [-20, +30], UNKNOWN
* @param cqiTableIndex [1, 6], UNKNOWN
* @param cqi [0, 15], UNKNOWN
* @param timingAdvance [0, 1282], UNKNOWN
* @param rssi in dBm [-113,-51], {@link CellInfo#UNAVAILABLE}
* @param rsrp in dBm [-140,-43], {@link CellInfo#UNAVAILABLE}
* @param rsrq in dB [-34, 3], {@link CellInfo#UNAVAILABLE}
* @param rssnr in dB [-20, +30], {@link CellInfo#UNAVAILABLE}
* @param cqiTableIndex [1, 6], {@link CellInfo#UNAVAILABLE}
* @param cqi [0, 15], {@link CellInfo#UNAVAILABLE}
* @param timingAdvance [0, 1282], {@link CellInfo#UNAVAILABLE}
*
*/
/** @hide */
@@ -151,12 +151,12 @@ public final class CellSignalStrengthLte extends CellSignalStrength implements P
/**
* Construct a cell signal strength
*
* @param rssi in dBm [-113,-51], UNKNOWN
* @param rsrp in dBm [-140,-43], UNKNOWN
* @param rsrq in dB [-34, 3], UNKNOWN
* @param rssnr in dB [-20, +30], UNKNOWN
* @param cqi [0, 15], UNKNOWN
* @param timingAdvance [0, 1282], UNKNOWN
* @param rssi in dBm [-113,-51], {@link CellInfo#UNAVAILABLE}
* @param rsrp in dBm [-140,-43], {@link CellInfo#UNAVAILABLE}
* @param rsrq in dB [-34, 3], {@link CellInfo#UNAVAILABLE}
* @param rssnr in dB [-20, +30], {@link CellInfo#UNAVAILABLE}
* @param cqi [0, 15], {@link CellInfo#UNAVAILABLE}
* @param timingAdvance [0, 1282], {@link CellInfo#UNAVAILABLE}
*
*/
/** @hide */
@@ -403,10 +403,11 @@ public final class CellSignalStrengthLte extends CellSignalStrength implements P
}
/**
* Get reference signal signal-to-noise ratio
* Get reference signal signal-to-noise ratio in dB
* Range: -20 dB to +30 dB.
*
* @return the RSSNR if available or
* {@link android.telephony.CellInfo#UNAVAILABLE UNAVAILABLE} if unavailable.
* {@link android.telephony.CellInfo#UNAVAILABLE} if unavailable.
*/
public int getRssnr() {
return mRssnr;
@@ -414,8 +415,10 @@ public final class CellSignalStrengthLte extends CellSignalStrength implements P
/**
* Get reference signal received power in dBm
* Range: -140 dBm to -43 dBm.
*
* @return the RSRP of the measured cell.
* @return the RSRP of the measured cell or {@link CellInfo#UNAVAILABLE} if
* unavailable.
*/
public int getRsrp() {
return mRsrp;