gnss/include/gnss_vendor.h

/*
 * Copyright (C) 2022 Huawei Device Co., Ltd.
 * 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.
 */

#ifndef GNSS_VENDOR_H
#define GNSS_VENDOR_H

#include <stdint.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <stdbool.h>

namespace OHOS {
namespace Location {
const int SV_NUM_MAX = 64;

enum class AgnssSetIdClass {
    AGNSS_SETID_CLASS_NONE = 0,
    AGNSS_SETID_CLASS_IMSI = 1,
    AGNSS_SETID_CLASS_MSISDM = 2,
};

enum class AgnssRefLocClass {
    AGNSS_REF_LOC_CLASS_CELLID = 1,
    AGNSS_REF_LOC_CLASS_MAC = 2,
};

enum class GnssStartClass {
    GNSS_START_CLASS_NORMAL = 1,
    GNSS_START_CLASS_GNSS_CACHE = 2,
};

enum class CellIdClass {
    GSM_CELLID = 1,
    UMTS_CELLID = 2,
    LTE_CELLID = 3,
};

enum class ApnIpClass {
    APN_CLASS_INVALID = 0,
    APN_CLASS_IPV4 = 1,
    APN_CLASS_IPV6 = 2,
    APN_CLASS_IPV4V6 = 3
};

enum class AgnssDataConnStatus {
    /* AGNSS data connecting. */
    AGNSS_DATA_CONN_CONNECTING = 1,
    /* AGNSS data connection initiated. */
    AGNSS_DATA_CONN_CONNECTED = 2,
    /* AGNSS data disconnecting. */
    AGNSS_DATA_CONN_DISCONNECTING = 3,
    /* AGNSS data disconnected. */
    AGNSS_DATA_CONN_DISCONNECTED = 4
};

enum class AgnssClass {
    AGNSS_CLASS_SUPL = 1,
    AGNSS_CLASS_C2K = 2
};

/*
 * Constellation class
 */
enum class ConstellationClass {
    GNSS_CONSTELLATION_UNKNOWN = 0,
    /* Global Positioning System. */
    GNSS_CONSTELLATION_GPS = 1,
    /* Satellite-Based Augmentation System. */
    GNSS_CONSTELLATION_SBAS = 2,
    /* Global Navigation Satellite System. */
    GNSS_CONSTELLATION_GLONASS = 3,
    /* Quasi-Zenith Satellite System. */
    GNSS_CONSTELLATION_QZSS = 4,
    /* BeiDou Navigation Satellite System. */
    GNSS_CONSTELLATION_BEIDOU = 5,
    /* Galileo Navigation Satellite System. */
    GNSS_CONSTELLATION_GALILEO = 6,
    /* Indian Regional Navigation Satellite System. */
    GNSS_CONSTELLATION_IRNSS = 7,
};

/* GNSS working status values. */
enum class GnssWorkingStatus {
    /* GNSS status unknown. */
    GNSS_STATUS_NONE = 0,
    /* GNSS has begun navigating. */
    GNSS_STATUS_SESSION_BEGIN = 1,
    /* GNSS has stopped navigating. */
    GNSS_STATUS_SESSION_END = 2,
    /* GNSS has powered on but is not navigating. */
    GNSS_STATUS_ENGINE_ON = 3,
    /* GNSS is powered off. */
    GNSS_STATUS_ENGINE_OFF = 4
};

enum class GnssCapabilities {
    /* GNSS supports MS-Based AGNSS mode */
    GNSS_CAP_SUPPORT_MSB = (1 << 0),
    /* GNSS supports MS-Assisted AGNSS mode */
    GNSS_CAP_SUPPORT_MSA = (1 << 1),
    /* GNSS supports Geofencing  */
    GNSS_CAP_SUPPORT_GEOFENCING = (1 << 2),
    /* GNSS supports Measurements for at least GPS. */
    GNSS_CAP_SUPPORT_MEASUREMENTS = (1 << 3),
    /* GNSS supports Navigation Messages */
    GNSS_CAP_SUPPORT_NAV_MESSAGES = (1 << 4),
    /* GNSS supports location caching */
    GNSS_CAP_SUPPORT_GNSS_CACHE = (1 << 5),
};

enum class SatellitesStatusFlag {
    SATELLITES_STATUS_NONE = 0,
    SATELLITES_STATUS_HAS_EPHEMERIS_DATA = 1 << 0,
    SATELLITES_STATUS_HAS_ALMANAC_DATA = 1 << 1,
    SATELLITES_STATUS_USED_IN_FIX = 1 << 2,
    SATELLITES_STATUS_HAS_CARRIER_FREQUENCY = 1 << 3
};

enum class GnssWorkingMode {
    GNSS_WORKING_MODE_STANDALONE = 1, /* GNSS standalone (no assistance) */
    GNSS_WORKING_MODE_MS_BASED = 2, /* AGNSS MS-Based mode */
    GNSS_WORKING_MODE_MS_ASSISTED = 3 /* AGPS MS-Assisted mode */
};

enum class GnssRefInfoClass {
    GNSS_REF_INFO_TIME = 1,
    GNSS_REF_INFO_LOCATION = 2,
    GNSS_REF_INFO_BEST_LOCATION = 3,
};

enum class GnssAuxiliaryDataClass {
    GNSS_AUXILIARY_DATA_CLASS_EPHEMERIS = 0x0001,
    GNSS_AUXILIARY_DATA_CLASS_ALMANAC = 0x0002,
    GNSS_AUXILIARY_DATA_CLASS_POSITION = 0x0004,
    GNSS_AUXILIARY_DATA_CLASS_TIME = 0x0008,
    GNSS_AUXILIARY_DATA_CLASS_IONO = 0x0010,
    GNSS_AUXILIARY_DATA_CLASS_UTC = 0x0020,
    GNSS_AUXILIARY_DATA_CLASS_HEALTH = 0x0040,
    GNSS_AUXILIARY_DATA_CLASS_SVDIR = 0x0080,
    GNSS_AUXILIARY_DATA_CLASS_SVSTEER = 0x0100,
    GNSS_AUXILIARY_DATA_CLASS_SADATA = 0x0200,
    GNSS_AUXILIARY_DATA_CLASS_RTI = 0x0400,
    GNSS_AUXILIARY_DATA_CLASS_CELLDB_INFO = 0x8000,
    GNSS_AUXILIARY_DATA_CLASS_ALL = 0xFFFF
};

enum class GnssModuleIfaceClass {
    AGPS_INTERFACE = 1,
    GNSS_GEOFENCING_INTERFACE = 2,
    GNSS_CACHE_INTERFACE = 3,
};

enum class GeofenceEvent {
    GEOFENCE_EVENT_UNCERTAIN = (1 << 0),
    GEOFENCE_EVENT_ENTERED = (1 << 1),
    GEOFENCE_EVENT_EXITED = (1 << 2),
};

enum class GeofenceOperateClass {
    GEOFENCE_ADD = 1,
    GEOFENCE_DELETE = 2,
};

enum class GeofenceOperateResult {
    GEOFENCE_OPERATION_SUCCESS = 0,
    GEOFENCE_OPERATION_ERROR_UNKNOWN = -100,
    GEOFENCE_OPERATION_ERROR_TOO_MANY_GEOFENCES = -101,
    GEOFENCE_OPERATION_ERROR_GEOFENCE_ID_EXISTS = -102,
    GEOFENCE_OPERATION_ERROR_PARAMS_INVALID = -103,
};

/* CellID info struct. */
typedef struct {
    size_t size;
    /* See CellIdClass for the definition of type. */
    uint16_t type;
    /* Mobile Country Code. */
    uint16_t mcc;
    /* Mobile Network Code. */
    uint16_t mnc;
    /* Location Area Code in 2G, 3G and LTE. */
    uint16_t lac;
    /* 2G:Cell id. 3G:Utran Cell id. LTE:Cell Global Id EUTRA. */
    uint32_t cid;
    /* Tracking Area Code in LTE. */
    uint16_t tac;
    /* Physical Cell id in LTE. */
    uint16_t pcid;
} AGnssRefInfoCellId;

typedef struct {
    size_t size;
    uint8_t mac[6];
} AGnssRefInfoMac;

/* Agnss reference location information structure */
typedef struct {
    size_t size;
    /* See AgnssRefLocClass for the definition of type. */
    uint32_t type;
    union {
        AGnssRefInfoCellId cellId;
        AGnssRefInfoMac mac;
    } u;
} AGnssRefLocInfo;

/* GNSS position structure. */
typedef struct {
    size_t size;
    uint32_t flags;
    double latitude;
    double longitude;
    /* Altitude in meters. */
    double altitude;
    /* Speed in meters per second. */
    float speed;
    /* Heading in degrees. */
    float bearing;
    /*
     * Represents expected horizontal position accuracy, radial, in meters
     * (68% confidence).
     */
    float horizontalAccuracy;
    /*
     * Represents expected vertical position accuracy in meters
     * (68% confidence).
     */
    float verticalAccuracy;
    /*
     * Represents expected speed accuracy in meter per seconds
     * (68% confidence).
     */
    float speedAccuracy;
    /*
     * Represents expected bearing accuracy in degrees
     * (68% confidence).
     */
    float bearingAccuracy;
    /* Timestamp for the location fix.Milliseconds since January 1, 1970. */
    int64_t timestamp;
    /* Timestamp since boot.Milliseconds since January 1, 1970. */
    int64_t timestampSinceBoot;
} GnssLocation;

typedef struct {
    size_t size;
    /* min interval between locations in ms. */
    uint32_t interval;
    /* If the value is true, the cached locations
     *  are reported and the AP is woken up after the FIFO is full.
     */
    bool fifoFullNotify;
} GnssCachingConfig;

/*
 * Represents Satellite Statu info.
 */
typedef struct {
    size_t size;
    /*
     * Pseudo-random or satellite ID number for the satellite, a.k.a. Space Vehicle (SV), or
     * FCN/OSN number for Glonass. The distinction is made by looking at constellation field.
     * Values must be in the range of:
     *
     * - GNSS:    1-32
     * - SBAS:    120-151, 183-192
     * - GLONASS: 1-24, the orbital slot number (OSN), if known.  Or, if not:
     *            93-106, the frequency channel number (FCN) (-7 to +6) offset by
     *            + 100
     *            i.e. report an FCN of -7 as 93, FCN of 0 as 100, and FCN of +6
     *            as 106.
     * - QZSS:    193-200
     * - Galileo: 1-36
     * - Beidou:  1-37
     * - IRNSS:   1-14
     */
    int16_t satelliteId;

    /* Defines the constellation type.
     * See ConstellationClass for the definition of constellationType */
    uint8_t constellationType;

    /* Carrier-to-noise density in dB-Hz */
    float cn0;

    /* Elevation of SV in degrees. */
    float elevation;

    /* Azimuth of SV in degrees. */
    float azimuth;

    /* Carrier frequency of the signal tracked. */
    float carrierFrequencie;

    /* See SatellitesStatusFlag for the definition of flag. */
    uint32_t flag;
} SatelliteStatusInfo;

/*
 * Represents all satellite status info.
 */
typedef struct {
    /* set to sizeof(GnssSatelliteStatus) */
    size_t size;

    /* Number of GNSS SVs currently visible. */
    uint32_t satellitesNum;

    /* Pointer to an array of SVs information for all GNSS constellations. */
    SatelliteStatusInfo satellitesList[SV_NUM_MAX];
} GnssSatelliteStatus;

/*  Callback with location information. */
typedef void (* on_location_change)(GnssLocation* location);

/*
 * Callback with gnss working status information.
 * Parameters:
 *      status  - Working status of GNSS chip.
 *                See GnssWorkingStatus for the definition of status.
 */
typedef void (* on_gnss_status_change)(uint16_t* status);

/* Callback with satellite status information. */
typedef void (* on_sv_status_change)(GnssSatelliteStatus* status);

/*
 * Callback for reporting NMEA info.
 * Parameters:
 *      timestamp   - Timestamp when the nmea was reported. Milliseconds since January 1, 1970.
 *      nmea  - NMEA string.
 *      length  - length of NMEA string.
 */
typedef void (* on_gnss_nmea_change)(int64_t timestamp, const char* nmea, int length);

/*
 * Callback to reporting the GNSS capabilities.
 * Parameters:
 *      capabilities   - GNSS capabilities,See GnssCapabilities for the definition of capabilities.
 */
typedef void (* on_capabilities_change)(uint32_t capabilities);

/*
 * Request Delivery Reference Information.
 * Parameters:
 *      type   - Type of GNSS reference information,See GnssRefInfoClass for the definition of type.
 */
typedef void (* request_reference_information)(int type);

/* Gnss basic config structure. */
typedef struct {
    size_t size;
    uint32_t minInterval; /* min interval between locations in ms */
    int gnssMode; /* See GnssWorkingMode for the definition of gnssMode */
} GnssBasicConfigPara;

/* GNSS config structure. */
typedef struct {
    size_t size;
    /*
     * Indicates the method of location reporting,
     * whether to report immediately or after caching for a
     * period of time. See GnssStartClass for the definition of type.
     */
    uint32_t type;
    union {
        GnssBasicConfigPara gnssBasicConfig;
        GnssCachingConfig gnssCacheConfig;
    } u;
} GnssConfigPara;

/* Gnss reference time. */
typedef struct {
    size_t size;
    int64_t time; /* Milliseconds since January 1, 1970. */
    int64_t timeReference; /* Milliseconds since January 1, 1970. */
    int uncertainty;
} GnssRefTime;

/* Gnss reference position. */
typedef struct {
    size_t size;
    double latitude;
    double longitude;
    float accuracy;
} GnssRefLocation;

/* Gnss reference information structure. */
typedef struct {
    size_t size;
    /*
     * Type of GNSS reference information,
     * See GnssRefInfoClass for the definition of type.
     */
    int type;
    union {
        GnssRefTime time;
        GnssRefLocation location;
        GnssLocation bestLocation;
    } u;
} GnssRefInfo;

/* Callback to request the client to download XTRA data. */
typedef void (* extended_ephemeris_download_request)();

/* GNSS cache location information reporting. */
typedef void (* on_cached_locations_change)(const GnssLocation** locationArray, size_t len);

/* GNSS basic callback functions. */
typedef struct {
    size_t size;
    on_location_change locationUpdate;
    on_gnss_status_change statusUpdate;
    on_sv_status_change svStatusUpdate;
    on_gnss_nmea_change nmeaUpdate;
    on_capabilities_change capabilitiesUpdate;
    request_reference_information refInfoRequest;
    extended_ephemeris_download_request downloadRequestCb;
} GnssBasicCallbackIfaces;

/* GNSS cache callback functions. */
typedef struct {
    size_t size;
    on_cached_locations_change cachedLocationCb;
} GnssCacheCallbackIfaces;

/* GNSS callback structure. */
typedef struct {
    size_t size;
    GnssBasicCallbackIfaces gnssCb;
    GnssCacheCallbackIfaces gnssCacheCb;
} GnssCallbackStruct;

/* GNSS vendor interface definition. */
typedef struct {
    size_t size;

    /* Enable the GNSS function.Initializing the GNSS Chip. */
    int (* enable_gnss)(GnssCallbackStruct* callbacks);

    /* Disables the GNSS function. */
    int (* disable_gnss)(void);

    /* start navigating.See GnssStartClass for the definition of type. */
    int (* start_gnss)(uint32_t type);

    /* Stops navigating.See GnssStartClass for the definition of type. */
    int (* stop_gnss)(uint32_t type);

    /* Inject reference information into the GNSS chip.
     * See GnssRefInfoClass for the definition of type. */
    int (* injects_reference_information)(int type, GnssRefInfo* info);

    /* Set gnss configuration parameters. */
    int (* set_gnss_config_para)(GnssConfigPara* para);

    /*
     * Specifies that the next call to start will not use the
     * information defined in the flags.
     * See GnssAuxiliaryDataClass for the definition of flags.
     */
    void (* remove_auxiliary_data)(uint16_t flags);

    /* Injects XTRA data into the GNSS. */
    int (* inject_extended_ephemeris)(char* data, int length);

    /* Return the cached locations size. */
    int (* get_cached_locations_size)();

    /* Retrieve all cached locations currently stored and clear the buffer. */
    void (* flush_cached_gnss_locations)();

    /* Get a pointer to gnss module interface.See GnssModuleIfaceClass for the definition of iface. */
    const void* (* get_gnss_module_iface)(int iface);
} GnssVendorInterface;

struct GnssVendorDevice {
    size_t size;
    const GnssVendorInterface* (*get_gnss_interface)();
};

/* Status of AGNSS. */
typedef struct {
    size_t size;
    /* See AgnssClass for the definition of agnssType */
    uint16_t agnssType;
    /* See AgnssDataConnStatus for the definition of connStatus. */
    uint16_t connStatus;
    /* IPv4 address. */
    uint32_t ipaddr;
    /* Contain the IPv4 (AF_INET) or IPv6 (AF_INET6) address to report. */
    struct sockaddr_storage sockAddr;
} AGnssStatusInfo;

typedef void (* on_agnss_status_change)(const AGnssStatusInfo* status);

/*
 * Callback function for requesting setid.
 * Parameters:
 *      type   - Type of setid,See enum class agnssSetidClass for the definition of type.
 */
typedef void (* get_setid_cb)(uint16_t type);

/*
 * Callback function for requesting setid.
 * Parameters:
 *      type   - Type of Type of reference location,See enum class AgnssRefLocClass for the definition of type.
 */
typedef void (* get_ref_location_cb)(uint32_t type);

typedef struct {
    size_t size;
    on_agnss_status_change agnssStatusChange;
    get_setid_cb getSetid;
    get_ref_location_cb getRefLoc;
} AGnssCallbackIfaces;

/* interface for AGNSS support */
typedef struct {
    size_t size;

    /*
     * Opens the AGNSS interface and provides the callback interfaces
     */
    bool (* set_agnss_callback)(AGnssCallbackIfaces* callbacks);

    /*
     * Sets the reference cell id.
     */
    bool (* set_ref_location)(const AGnssRefLocInfo* refLoc);

    /*
     * Sets the set ID.
     * Parameters:
     *      type   - Type of setid,See enum class agnssSetidClass for the definition of type.
     *      setid  - String to hold setid.
     *      len    - length of setid.
     */
    bool (* set_setid)(uint16_t type, const char* setid, size_t len);

    /*
     * Setting the Agnss Server Information.
     * Parameters:
     * type    - type of agnss.See AgnssClass for the definition of type.
     * server  - agnss server.
     * len     - length of server string.
     * port    - port of agnss server.
     */
    bool (* set_agnss_server)(uint16_t type, const char* server, size_t len, int32_t port);
} AGnssModuleInterface;

/*
 * The callback associated with the geofence.
 * Parameters:
 *      geofenceId - The id associated with the add_gnss_geofence.
 *      location    - The current GNSS location.
 *      event  - Can be one of GEOFENCE_EVENT_UNCERTAIN, GEOFENCE_EVENT_ENTERED,
 *                    GEOFENCE_EVENT_EXITED.
 *      timestamp   - Timestamp when the transition was detected. Milliseconds since January 1, 1970.
 */
typedef void (* geofence_event_callback)(int32_t geofenceId,  GnssLocation* location,
    int32_t event, int64_t timestamp);

/*
 * Callback function that indicates whether the geofence service is available.
 *
 * Parameters:
 *  isAvailable is true when gnss geofence service is available.
 */
typedef void (* geofence_availability_callback)(bool isAvailable);

/*
 * Callback function indicating the result of the geofence operation
 *
 * geofenceId - Id of the geofence.
 * operateType - geofence operate type.
 * result - GEOFENCE_OPERATION_SUCCESS
 *          GEOFENCE_OPERATION_ERROR_TOO_MANY_GEOFENCES  - geofence limit has been reached.
 *          GEOFENCE_OPERATION_ERROR_GEOFENCE_ID_EXISTS  - geofence with id already exists
 *          GEOFENCE_OPERATION_ERROR_PARAMS_INVALID - input params are invalid.
 */
typedef void (* geofence_operate_result_callback)(int32_t geofenceId, int32_t operateType,
    int32_t result);

typedef struct {
    size_t size;
    geofence_availability_callback on_geofence_availability_change;
    geofence_event_callback geofence_event_notify;
    geofence_operate_result_callback geofence_operate_result_cb;
} GeofenceCallbackIfaces;

/* Interface for GNSS Geofence */
typedef struct {
    size_t size;

    /*
     * Opens the geofence interface and provides the callback interfaces.
     */
    bool (* set_callback)(GeofenceCallbackIfaces* callbacks);

    /*
     * Add a geofence area. This api currently supports circular geofences.
     * Parameters:
     *    geofenceId - The id for the geofence.
     *    latitude, longtitude, radiusMeters - The lat, long and radius
     *       (in meters) for the geofence
     *    monitorEvent - Which transitions to monitor. Bitwise OR of
     *       GEOFENCE_EVENT_UNCERTAIN, GEOFENCE_EVENT_ENTERED and
     *       GEOFENCE_EVENT_EXITED.
     */
    bool (* add_gnss_geofence)(int32_t geofenceId, double latitude, double longitude,
       double radius, int32_t monitorEvent);

    /*
     * Remove a gnss geofence.
     * geofenceId - The id for the geofence.
     * Return true if delete successful.
     */
    bool (* delete_gnss_geofence)(int32_t geofenceId);
} GeofenceModuleInterface;
} // namespace Location
} // namespace OHOS
#endif // GNSS_VENDOR_H