From 591387fb4f670ac303777f505f8ee5909f40d62c Mon Sep 17 00:00:00 2001 From: Eric Schwarzenbach Date: Tue, 13 Feb 2018 11:08:17 -0800 Subject: [PATCH] Fix comments for link capacity and signal strength reporting. Bug: 72110413 Test: n/a Change-Id: Ie808f4dcb559a50bee111051290266ba47f676da --- radio/1.2/IRadio.hal | 25 ++++++++++++------------- radio/1.2/types.hal | 10 ++++++++-- 2 files changed, 20 insertions(+), 15 deletions(-) diff --git a/radio/1.2/IRadio.hal b/radio/1.2/IRadio.hal index 11809e5cb3..6463b0fcc0 100644 --- a/radio/1.2/IRadio.hal +++ b/radio/1.2/IRadio.hal @@ -50,7 +50,7 @@ interface IRadio extends @1.1::IRadio { * * @param serial Serial number of request. * @param indicationFilter 32-bit bitmap of IndicationFilter. Bits set to 1 indicate the - * indications are enabled. See @1.2::IndicationFilter for the definition of each bit. + * indications are enabled. See @1.2::IndicationFilter for the definition of each bit. * * Response callback is IRadioResponse.setIndicationFilterResponse() */ @@ -68,12 +68,12 @@ interface IRadio extends @1.1::IRadio { * * @param serial Serial number of request. * @param hysteresisMs A hysteresis time in milliseconds to prevent flapping. A value of 0 - * disables hysteresis. + * disables hysteresis. * @param hysteresisDb An interval in dB defining the required magnitude change between reports. - * hysteresisDb must be smaller than the smallest threshold delta. An - * interval value of 0 disables hysteresis. + * hysteresisDb must be smaller than the smallest threshold delta. An + * interval value of 0 disables hysteresis. * @param thresholdsDbm A vector of trigger thresholds in dBm. A vector size of 0 disables the - * use of thresholds for reporting. + * use of thresholds for reporting. * @param accessNetwork The type of network for which to apply these thresholds. */ oneway setSignalStrengthReportingCriteria(int32_t serial, int32_t hysteresisMs, @@ -91,18 +91,17 @@ interface IRadio extends @1.1::IRadio { * * @param serial Serial number of request. * @param hysteresisMs A hysteresis time in milliseconds to prevent flapping. A value of 0 - * disables hysteresis. + * disables hysteresis. * @param hysteresisDlKbps An interval in kbps defining the required magnitude change between DL - * reports. hysteresisDlKbps must be smaller than the smallest threshold - * delta. A value of 0 disables hysteresis. + * reports. hysteresisDlKbps must be smaller than the smallest threshold delta. A value of 0 + * disables hysteresis. * @param hysteresisUlKbps An interval in kbps defining the required magnitude change between UL - * reports. hysteresisUlKbps must be smaller than the smallest threshold - * delta. A value of 0 disables hysteresis. + * reports. hysteresisUlKbps must be smaller than the smallest threshold delta. A value of 0 + * disables hysteresis. * @param thresholdsDownlinkKbps A vector of trigger thresholds in kbps for downlink reports. A - * vector size of 0 disables the use of DL thresholds for - * reporting. + * vector size of 0 disables the use of DL thresholds for reporting. * @param thresholdsUplinkKbps A vector of trigger thresholds in kbps for uplink reports. A - * vector size of 0 disables the use of UL thresholds for reporting. + * vector size of 0 disables the use of UL thresholds for reporting. * @param accessNetwork The type of network for which to apply these thresholds. */ oneway setLinkCapacityReportingCriteria(int32_t serial, int32_t hysteresisMs, diff --git a/radio/1.2/types.hal b/radio/1.2/types.hal index 8b38f428f7..b68895e15b 100644 --- a/radio/1.2/types.hal +++ b/radio/1.2/types.hal @@ -361,11 +361,17 @@ struct CardStatus { struct LinkCapacityEstimate { /** - * Estimated downlink capacity in kbps. + * Estimated downlink capacity in kbps. This bandwidth estimate shall be the estimated + * maximum sustainable link bandwidth (as would be measured at the Upper PDCP or SNDCP SAP). + * If the DL Aggregate Maximum Bit Rate is known, this value shall not exceed the DL-AMBR + * for the Internet PDN connection. */ uint32_t downlinkCapacityKbps; /** - * Estimated uplink capacity in kbps. + * Estimated uplink capacity in kbps. This bandwidth estimate shall be the estimated + * maximum sustainable link bandwidth (as would be measured at the Upper PDCP or SNDCP SAP). + * If the UL Aggregate Maximum Bit Rate is known, this value shall not exceed the UL-AMBR + * for the Internet PDN connection. */ uint32_t uplinkCapacityKbps; };