1/*
2 * Copyright (C) 2017 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 [email protected];
18
19import @1.0::IGnssConfiguration;
20import @1.0::GnssConstellationType;
21
22/**
23 * Extended interface for GNSS Configuration support.
24 */
25interface IGnssConfiguration extends @1.0::IGnssConfiguration {
26    struct BlacklistedSource {
27        /**
28         * Defines the constellation of the given satellite(s).
29         */
30        GnssConstellationType constellation;
31
32        /**
33         * Satellite (space vehicle) ID number, as defined in GnssSvInfo::svid
34         *
35         * Or 0 to blacklist all svid's for the specified constellation
36         */
37        int16_t svid;
38    };
39
40    /**
41     * Injects a vector of BlacklistedSource(s) which the HAL must not use to calculate the
42     * GNSS location output.
43     *
44     * The superset of all satellite sources provided, including wildcards, in the latest call
45     * to this method, is the set of satellites sources that must not be used in calculating
46     * location.
47     *
48     * All measurements from the specified satellites, across frequency bands, are blacklisted
49     * together.
50     *
51     * If this method is never called after the IGnssConfiguration.hal connection is made on boot,
52     * or is called with an empty vector, then no satellites are to be blacklisted as a result of
53     * this API.
54     *
55     * This blacklist must be considered as an additional source of which satellites
56     * should not be trusted for location on top of existing sources of similar information
57     * such as satellite broadcast health being unhealthy and measurement outlier removal.
58     *
59     * @param blacklist The BlacklistedSource(s) of satellites the HAL must not use.
60     *
61     * @return success Whether the HAL accepts and abides by the provided blacklist.
62     */
63    setBlacklist(vec<BlacklistedSource> blacklist) generates (bool success);
64};