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

Commit af90af79 authored by Yu-Han Yang's avatar Yu-Han Yang
Browse files

Add GnssAutomaticGainControl to GnssMeasurementsEvent (frameworks/base) 

AgcLevelDb has been a subfield of GnssMeasurement. However,
GnssMeasurement is only reported by the chipset when there
is GNSS signal. For example, in deep indoor, or when there
is strong jamming signal, no GnssMeasurement can be reported,
and thus no AGC value can be reported.

To resolve that, we are adding this GnssAgc to GnssMeasurementsEvent
directly, so that the client can get AGC values even without GNSS
signal (i.e., without GnssMeasurement).

Bug: 206670536
Test: atest GnssAutomaticGainControlTest
      atest GnssMeasurementsEventTest
Change-Id: I97c7ec98b6e8cc977c6e879b52a8cf75c355ae33
parent b559ac4e

core/api/current.txt

+30 −2
Original line number Diff line number Diff line
@@ -20140,6 +20140,24 @@ package android.location { 
    field @NonNull public static final android.os.Parcelable.Creator<android.location.GnssAntennaInfo.SphericalCorrections> CREATOR;

  }













  public final class GnssAutomaticGainControl implements android.os.Parcelable {













    method public int describeContents();













    method @IntRange(from=0) public long getCarrierFrequencyHz();













    method public int getConstellationType();













    method @FloatRange(from=0xffffd8f0, to=10000) public double getLevelDb();













    method public void writeToParcel(@NonNull android.os.Parcel, int);













    field @NonNull public static final android.os.Parcelable.Creator<android.location.GnssAutomaticGainControl> CREATOR;













  }

























  public static final class GnssAutomaticGainControl.Builder {













    ctor public GnssAutomaticGainControl.Builder();













    ctor public GnssAutomaticGainControl.Builder(@NonNull android.location.GnssAutomaticGainControl);













    method @NonNull public android.location.GnssAutomaticGainControl build();













    method @NonNull public android.location.GnssAutomaticGainControl.Builder setCarrierFrequencyHz(@IntRange(from=0) long);













    method @NonNull public android.location.GnssAutomaticGainControl.Builder setConstellationType(int);













    method @NonNull public android.location.GnssAutomaticGainControl.Builder setLevelDb(@FloatRange(from=0xffffd8f0, to=10000) double);













  }



























  public final class GnssCapabilities implements android.os.Parcelable {















    method public int describeContents();















    method public boolean hasAntennaInfo();










@@ -20196,7 +20214,7 @@ package android.location {













    method public double getAccumulatedDeltaRangeMeters();















    method public int getAccumulatedDeltaRangeState();















    method public double getAccumulatedDeltaRangeUncertaintyMeters();













    method public double getAutomaticGainControlLevelDb();













    method @Deprecated public double getAutomaticGainControlLevelDb();















    method @FloatRange(from=0, to=63) public double getBasebandCn0DbHz();















    method @Deprecated public long getCarrierCycles();















    method public float getCarrierFrequencyHz();









@@ -20218,7 +20236,7 @@ package android.location {













    method public int getState();















    method public int getSvid();















    method public double getTimeOffsetNanos();













    method public boolean hasAutomaticGainControlLevelDb();













    method @Deprecated public boolean hasAutomaticGainControlLevelDb();















    method public boolean hasBasebandCn0DbHz();















    method @Deprecated public boolean hasCarrierCycles();















    method public boolean hasCarrierFrequencyHz();










@@ -20280,11 +20298,21 @@ package android.location {













  public final class GnssMeasurementsEvent implements android.os.Parcelable {















    method public int describeContents();















    method @NonNull public android.location.GnssClock getClock();













    method @NonNull public java.util.Collection<android.location.GnssAutomaticGainControl> getGnssAutomaticGainControls();















    method @NonNull public java.util.Collection<android.location.GnssMeasurement> getMeasurements();















    method public void writeToParcel(android.os.Parcel, int);















    field @NonNull public static final android.os.Parcelable.Creator<android.location.GnssMeasurementsEvent> CREATOR;















  }



























  public static final class GnssMeasurementsEvent.Builder {













    ctor public GnssMeasurementsEvent.Builder();













    ctor public GnssMeasurementsEvent.Builder(@NonNull android.location.GnssMeasurementsEvent);













    method @NonNull public android.location.GnssMeasurementsEvent build();













    method @NonNull public android.location.GnssMeasurementsEvent.Builder setClock(@NonNull android.location.GnssClock);













    method @NonNull public android.location.GnssMeasurementsEvent.Builder setGnssAutomaticGainControls(@NonNull java.util.Collection<android.location.GnssAutomaticGainControl>);













    method @NonNull public android.location.GnssMeasurementsEvent.Builder setMeasurements(@NonNull java.util.Collection<android.location.GnssMeasurement>);













  }



























  public abstract static class GnssMeasurementsEvent.Callback {















    ctor public GnssMeasurementsEvent.Callback();















    method public void onGnssMeasurementsReceived(android.location.GnssMeasurementsEvent);

























core/api/test-current.txt



+1
−5




























Original line number
Diff line number
Diff line








@@ -1319,7 +1319,7 @@ package android.location {













    method public void setAccumulatedDeltaRangeMeters(double);















    method public void setAccumulatedDeltaRangeState(int);















    method public void setAccumulatedDeltaRangeUncertaintyMeters(double);













    method public void setAutomaticGainControlLevelInDb(double);













    method @Deprecated public void setAutomaticGainControlLevelInDb(double);















    method public void setBasebandCn0DbHz(double);















    method @Deprecated public void setCarrierCycles(long);















    method public void setCarrierFrequencyHz(float);









@@ -1346,10 +1346,6 @@ package android.location {













    field public static final int ADR_STATE_ALL = 31; // 0x1f















  }





























  public final class GnssMeasurementsEvent implements android.os.Parcelable {













    ctor public GnssMeasurementsEvent(android.location.GnssClock, android.location.GnssMeasurement[]);













  }





























  public final class GnssNavigationMessage implements android.os.Parcelable {















    ctor public GnssNavigationMessage();















    method public void reset();

































location/java/android/location/GnssAutomaticGainControl.aidl
0 → 100644



+19
−0




























Original line number
Diff line number
Diff line













/*













 * Copyright (C) 2022 The Android Open Source Project













 *













 * Licensed under the Apache License, Version 2.0 (the "License");













 * you may not use this file except in compliance with the License.













 * You may obtain a copy of the License at













 *













 *      http://www.apache.org/licenses/LICENSE-2.0













 *













 * Unless required by applicable law or agreed to in writing, software













 * distributed under the License is distributed on an "AS IS" BASIS,













 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.













 * See the License for the specific language governing permissions and













 * limitations under the License.













 */



























package android.location;



























parcelable GnssAutomaticGainControl;
























location/java/android/location/GnssAutomaticGainControl.java
0 → 100644



+215
−0




























Original line number
Diff line number
Diff line













/*













 * Copyright (C) 2022 The Android Open Source Project













 *













 * Licensed under the Apache License, Version 2.0 (the "License");













 * you may not use this file except in compliance with the License.













 * You may obtain a copy of the License at













 *













 *      http://www.apache.org/licenses/LICENSE-2.0













 *













 * Unless required by applicable law or agreed to in writing, software













 * distributed under the License is distributed on an "AS IS" BASIS,













 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.













 * See the License for the specific language governing permissions and













 * limitations under the License.













 */



























package android.location;



























import android.annotation.FloatRange;













import android.annotation.IntRange;













import android.annotation.NonNull;













import android.os.Parcel;













import android.os.Parcelable;



























import com.android.internal.util.Preconditions;



























import java.util.Objects;



























/**













 * A class that contains GNSS Automatic Gain Control (AGC) information.













 *













 * <p> AGC acts as a variable gain amplifier adjusting the power of the incoming signal. The AGC













 * level may be used to indicate potential interference. Higher gain (and/or lower input power)













 * shall be output as a positive number. Hence in cases of strong jamming, in the band of this













 * signal, this value will go more negative. This value must be consistent given the same level













 * of the incoming signal power.













 *













 * <p> Note: Different hardware designs (e.g. antenna, pre-amplification, or other RF HW













 * components) may also affect the typical output of this value on any given hardware design













 * in an open sky test - the important aspect of this output is that changes in this value are













 * indicative of changes on input signal power in the frequency band for this measurement.













 */













public final class GnssAutomaticGainControl implements Parcelable {













    private final double mLevelDb;













    private final int mConstellationType;













    private final long mCarrierFrequencyHz;



























    /**













     * Creates a {@link GnssAutomaticGainControl} with a full list of parameters.













     */













    private GnssAutomaticGainControl(double levelDb, int constellationType,













            long carrierFrequencyHz) {













        mLevelDb = levelDb;













        mConstellationType = constellationType;













        mCarrierFrequencyHz = carrierFrequencyHz;













    }



























    /**













     * Gets the Automatic Gain Control level in dB.













     */













    @FloatRange(from = -10000, to = 10000)













    public double getLevelDb() {













        return mLevelDb;













    }



























    /**













     * Gets the constellation type.













     *













     * <p>The return value is one of those constants with {@code CONSTELLATION_} prefix in













     * {@link GnssStatus}.













     */













    @GnssStatus.ConstellationType













    public int getConstellationType() {













        return mConstellationType;













    }



























    /**













     * Gets the carrier frequency of the tracked signal.













     *













     * <p>For example it can be the GPS central frequency for L1 = 1575.45 MHz, or L2 = 1227.60 MHz,













     * L5 = 1176.45 MHz, varying GLO channels, etc.













     *













     * @return the carrier frequency of the signal tracked in Hz.













     */













    @IntRange(from = 0)













    public long getCarrierFrequencyHz() {













        return mCarrierFrequencyHz;













    }



























    @Override













    public int describeContents() {













        return 0;













    }



























    @Override













    public void writeToParcel(@NonNull Parcel parcel, int flag) {













        parcel.writeDouble(mLevelDb);













        parcel.writeInt(mConstellationType);













        parcel.writeLong(mCarrierFrequencyHz);













    }



























    @NonNull













    public static final Creator<GnssAutomaticGainControl> CREATOR =













            new Creator<GnssAutomaticGainControl>() {













                @Override













                @NonNull













                public GnssAutomaticGainControl createFromParcel(@NonNull Parcel parcel) {













                    return new GnssAutomaticGainControl(parcel.readDouble(), parcel.readInt(),













                            parcel.readLong());













                }



























                @Override













                public GnssAutomaticGainControl[] newArray(int i) {













                    return new GnssAutomaticGainControl[i];













                }













            };



























    @NonNull













    @Override













    public String toString() {













        StringBuilder s = new StringBuilder();













        s.append("GnssAutomaticGainControl[");













        s.append("Level=").append(mLevelDb).append(" dB");













        s.append(" Constellation=").append(













                GnssStatus.constellationTypeToString(mConstellationType));













        s.append(" CarrierFrequency=").append(mCarrierFrequencyHz).append(" Hz");













        s.append(']');













        return s.toString();













    }



























    @Override













    public boolean equals(Object obj) {













        if (this == obj) {













            return true;













        }













        if (!(obj instanceof GnssAutomaticGainControl)) {













            return false;













        }



























        GnssAutomaticGainControl other = (GnssAutomaticGainControl) obj;













        if (Double.compare(mLevelDb, other.mLevelDb)













                != 0) {













            return false;













        }













        if (mConstellationType != other.mConstellationType) {













            return false;













        }













        if (mCarrierFrequencyHz != other.mCarrierFrequencyHz) {













            return false;













        }













        return true;













    }



























    @Override













    public int hashCode() {













        return Objects.hash(mLevelDb, mConstellationType, mCarrierFrequencyHz);













    }



























    /** Builder for {@link GnssAutomaticGainControl} */













    public static final class Builder {













        private double mLevelDb;













        private int mConstellationType;













        private long mCarrierFrequencyHz;



























        /**













         * Constructs a {@link GnssAutomaticGainControl.Builder} instance.













         */













        public Builder() {













        }



























        /**













         * Constructs a {@link GnssAutomaticGainControl.Builder} instance by copying a













         * {@link GnssAutomaticGainControl}.













         */













        public Builder(@NonNull GnssAutomaticGainControl agc) {













            mLevelDb = agc.getLevelDb();













            mConstellationType = agc.getConstellationType();













            mCarrierFrequencyHz = agc.getCarrierFrequencyHz();













        }



























        /**













         * Sets the Automatic Gain Control level in dB.













         */













        @NonNull













        public Builder setLevelDb(@FloatRange(from = -10000, to = 10000) double levelDb) {













            Preconditions.checkArgument(levelDb >= -10000 && levelDb <= 10000);













            mLevelDb = levelDb;













            return this;













        }



























        /**













         * Sets the constellation type.













         */













        @NonNull













        public Builder setConstellationType(@GnssStatus.ConstellationType int constellationType) {













            mConstellationType = constellationType;













            return this;













        }



























        /**













         * Sets the Carrier frequency in Hz.













         */













        @NonNull public Builder setCarrierFrequencyHz(@IntRange(from = 0) long carrierFrequencyHz) {













            Preconditions.checkArgumentNonnegative(carrierFrequencyHz);













            mCarrierFrequencyHz = carrierFrequencyHz;













            return this;













        }



























        /** Builds a {@link GnssAutomaticGainControl} instance as specified by this builder. */













        @NonNull













        public GnssAutomaticGainControl build() {













            return new GnssAutomaticGainControl(mLevelDb, mConstellationType, mCarrierFrequencyHz);













        }













    }













}
























location/java/android/location/GnssMeasurement.java



+8
−0




























Original line number
Diff line number
Diff line








@@ -1381,7 +1381,10 @@ public final class GnssMeasurement implements Parcelable {













    /**















     * Returns {@code true} if {@link #getAutomaticGainControlLevelDb()} is available,















     * {@code false} otherwise.













     *













     * @deprecated Use {@link GnssMeasurementsEvent#getGnssAutomaticGainControls()} instead.















     */













    @Deprecated















    public boolean hasAutomaticGainControlLevelDb() {















        return isFlagSet(HAS_AUTOMATIC_GAIN_CONTROL);















    }









@@ -1401,7 +1404,10 @@ public final class GnssMeasurement implements Parcelable {













     * indicative of changes on input signal power in the frequency band for this measurement.















     *















     * <p> The value is only available if {@link #hasAutomaticGainControlLevelDb()} is {@code true}













     *













     * @deprecated Use {@link GnssMeasurementsEvent#getGnssAutomaticGainControls()} instead.















     */













    @Deprecated















    public double getAutomaticGainControlLevelDb() {















        return mAutomaticGainControlLevelInDb;















    }









@@ -1409,7 +1415,9 @@ public final class GnssMeasurement implements Parcelable {













    /**















     * Sets the Automatic Gain Control level in dB.















     * @hide













     * @deprecated Use {@link GnssMeasurementsEvent.Builder#setGnssAutomaticGainControls()} instead.















     */













    @Deprecated















    @TestApi















    public void setAutomaticGainControlLevelInDb(double agcLevelDb) {















        setFlag(HAS_AUTOMATIC_GAIN_CONTROL);