GPSFrame.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2016-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
 *
 * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
 * property and proprietary rights in and to this material, related
 * documentation and any modifications thereto. Any use, reproduction,
 * disclosure or distribution of this material and related documentation
 * without an express license agreement from NVIDIA CORPORATION or
 * its affiliates is strictly prohibited.
 */
#ifndef DW_SENSORS_GPS_GPSFRAME_H_
#define DW_SENSORS_GPS_GPSFRAME_H_
// Generated by dwProto from gps_frame.proto DO NOT EDIT BY HAND!
// See //3rdparty/shared/dwproto/README.md for more information
 
#include <dw/pbwire/BasicTypes.h>
 
#include <dw/core/base/Exports.h>
 
#include <dw/core/signal/SignalStatus.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
// coverity[misra_c_2012_rule_2_4_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
// coverity[misra_c_2012_rule_2_3_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
typedef enum dwGPSTimestampFormat {
    DW_GPS_TIMESTAMP_FORMAT_UNSPECIFIED = 0,
 
    DW_GPS_TIMESTAMP_FORMAT_PTP64 = 1,
 
    DW_GPS_TIMESTAMP_FORMAT_PTP16 = 2,
 
    DW_GPS_TIMESTAMP_FORMAT_CCPLEX_TSC = 3,
    DW_GPS_TIMESTAMP_FORMAT_FORCE32    = 0x7fffffff,
} dwGPSTimestampFormat;
 
// coverity[misra_c_2012_rule_2_4_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
// coverity[misra_c_2012_rule_2_3_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
typedef enum dwGPSFlags {
    DW_GPS_LAT DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.latitude instead") = 1 << 0, 
 
    DW_GPS_LON DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.longitude instead") = 1 << 1, 
 
    DW_GPS_ALT DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.altitude instead") = 1 << 2, 
 
    DW_GPS_COURSE DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.course instead") = 1 << 3, 
 
    DW_GPS_SPEED DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.speed instead") = 1 << 4, 
 
    DW_GPS_CLIMB DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.climb instead") = 1 << 5, 
 
    DW_GPS_HDOP DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.hdop instead") = 1 << 6, 
 
    DW_GPS_VDOP DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.vdop instead") = 1 << 7, 
 
    DW_GPS_HACC DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.hacc instead") = 1 << 8, 
 
    DW_GPS_VACC DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.vacc instead") = 1 << 9, 
 
    DW_GPS_MODE DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.mode instead") = 1 << 10, 
    DW_GPS_FLAGS_FORCE32                                                       = 0x7fffffff,
} dwGPSFlags;
 
// coverity[misra_c_2012_rule_2_4_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
// coverity[misra_c_2012_rule_2_3_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
typedef enum dwGPSJamState {
    DW_GPS_JAM_STATE_UNSPECIFIED = 0,
 
    DW_GPS_JAM_STATE_OK = 1,
 
    DW_GPS_JAM_STATE_WARN = 2,
 
    DW_GPS_JAM_STATE_CRITICAL = 3,
 
    DW_GPS_JAM_STATE_INIT    = 4,
    DW_GPS_JAM_STATE_FORCE32 = 0x7fffffff,
} dwGPSJamState;
 
// coverity[misra_c_2012_rule_2_4_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
// coverity[misra_c_2012_rule_2_3_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
typedef enum dwGPSSpoofState {
    DW_GPS_SPOOF_STATE_UNSPECIFIED = 0,
 
    DW_GPS_SPOOF_STATE_NO = 1,
 
    DW_GPS_SPOOF_STATE_YES = 2,
 
    DW_GPS_SPOOF_STATE_MULTI = 3,
 
    DW_GPS_SPOOF_STATE_INIT    = 4,
    DW_GPS_SPOOF_STATE_FORCE32 = 0x7fffffff,
} dwGPSSpoofState;
 
// coverity[misra_c_2012_rule_2_4_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
// coverity[misra_c_2012_rule_2_3_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
typedef enum dwGPSMode {
    DW_GPS_MODE_UNKNOWN = 0,
 
    DW_GPS_MODE_INVALID_GPS = 1,
 
    DW_GPS_MODE_DEAD_RECKONING = 2,
 
    DW_GPS_MODE_STAND_ALONE = 3,
 
    DW_GPS_MODE_PRECISE_POINT = 4,
 
    DW_GPS_MODE_CODE_DIFFERENTIAL = 5,
 
    DW_GPS_MODE_RTK_FLOAT = 6,
 
    DW_GPS_MODE_RTK_FIXED = 7,
 
    DW_GPS_MODE_PPP_CONVERGING = 8,
 
    DW_GPS_MODE_PPP_CONVERGED = 9,
    DW_GPS_MODE_FORCE32       = 0x7fffffff,
} dwGPSMode;
 
// coverity[misra_c_2012_rule_2_4_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
// coverity[misra_c_2012_rule_2_3_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
typedef enum dwGPSFixStatus {
    DW_GPS_FIX_STATUS_NO_FIX = 0,
 
    DW_GPS_FIX_STATUS_2D_FIX = 1,
 
    DW_GPS_FIX_STATUS_3D_FIX  = 2,
    DW_GPS_FIX_STATUS_FORCE32 = 0x7fffffff,
} dwGPSFixStatus;
 
// coverity[misra_c_2012_rule_2_4_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
// coverity[misra_c_2012_rule_2_3_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
typedef enum dwGPSTimestampQuality {
    DW_GPS_TIMESTAMP_QUALITY_NOT_INIT = 0,
 
    DW_GPS_TIMESTAMP_QUALITY_OK = 1,
 
    DW_GPS_TIMESTAMP_QUALITY_SYNC_LOST = 2,
    DW_GPS_TIMESTAMP_QUALITY_FORCE32   = 0x7fffffff,
} dwGPSTimestampQuality;
 
// coverity[misra_c_2012_rule_2_4_violation] Deviation Record: AV-NDAS-SWSADR-003
// coverity[misra_c_2012_rule_2_3_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
typedef struct dwGPSSignalValidityInfo
{
    dwSignalValidity timestamp_us;
 
    dwSignalValidity latitude;
 
    dwSignalValidity longitude;
 
    dwSignalValidity altitude;
 
    dwSignalValidity course;
 
    dwSignalValidity speed;
 
    dwSignalValidity climb;
 
    dwSignalValidity hdop;
 
    dwSignalValidity vdop;
 
    dwSignalValidity pdop;
 
    dwSignalValidity hacc;
 
    dwSignalValidity vacc;
 
    dwSignalValidity utcTimeUs;
 
    dwSignalValidity satelliteCount;
 
    dwSignalValidity fixStatus;
 
    dwSignalValidity timestampQuality;
 
    dwSignalValidity mode;
 
    dwSignalValidity errors;
 
    dwSignalValidity courseAccuracy;
 
    dwSignalValidity speedAccuracy;
 
    dwSignalValidity jamState;
 
    dwSignalValidity spoofState;
 
    dwSignalValidity sensorTimestamp;
 
    dwSignalValidity hostTimestamp;
 
    dwSignalValidity sensorTimestampFormat;
 
    dwSignalValidity reserved[55];
    // coverity[misra_c_2012_rule_2_3_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
} dwGPSSignalValidityInfo;
 
// coverity[misra_c_2012_rule_2_4_violation] Deviation Record: AV-NDAS-SWSADR-003
// coverity[misra_c_2012_rule_2_3_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
typedef struct dwGPSFrame
{
 
    dwGPSSignalValidityInfo validityInfo;
 
    dwTime_t timestamp_us;
 
    float64_t latitude;
 
    float64_t longitude;
 
    float64_t altitude;
 
    float64_t course;
 
    float64_t speed;
 
    float64_t climb;
 
    float64_t hdop;
 
    float64_t vdop;
 
    float64_t pdop;
 
    float64_t hacc;
 
    float64_t vacc;
 
    dwTime_t utcTimeUs;
 
    uint8_t satelliteCount;
 
    dwGPSFixStatus fixStatus;
 
    dwGPSTimestampQuality timestampQuality;
 
    dwGPSMode mode;
 
    DW_DEPRECATED("utcTime is deprecated and will be removed soon. Please use utcTimeUs instead")
    char8_t utcTime[16];
 
    DW_DEPRECATED("utcDate is deprecated and will be removed soon. Please use utcTimeUs instead")
    char8_t utcDate[16];
 
    DW_DEPRECATED("flags is deprecated and will be removed soon. Please use struct validityInfo and APIs introduced in GPSGetterSetter.h instead")
    uint32_t flags;
 
    DW_DEPRECATED("gpsMode is deprecated and will be removed soon. Please use mode instead")
    dwGPSMode gpsMode;
 
    uint64_t errors;
 
    float64_t courseAccuracy;
 
    float64_t speedAccuracy;
 
    dwGPSJamState jamState;
 
    dwGPSSpoofState spoofState;
 
    dwTime_t sensorTimestamp;
 
    dwTime_t hostTimestamp;
 
    dwGPSTimestampFormat sensorTimestampFormat;
 
    uint8_t reserved[416];
    // coverity[misra_c_2012_rule_2_3_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
} dwGPSFrame;
 
#ifdef __cplusplus
}
#endif
 
#endif // DW_SENSORS_GPS_GPSFRAME_H_