lr1110_gnss_types.h

Go to the documentation of this file.

 
#ifndef LR1110_GNSS_TYPES_H
#define LR1110_GNSS_TYPES_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * -----------------------------------------------------------------------------
 * --- DEPENDENCIES ------------------------------------------------------------
 */
 
#include <stdbool.h>
#include <stdint.h>
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC MACROS -----------------------------------------------------------
 */
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC CONSTANTS --------------------------------------------------------
 */
 
#define LR1110_GNSS_MAX_SIZE_ARRAY 2820  
 
#define LR1110_GNSS_FULL_UPDATE_N_ALMANACS ( 128 )
 
#define LR1110_GNSS_SINGLE_ALMANAC_READ_SIZE ( 22 )
 
#define LR1110_GNSS_SINGLE_ALMANAC_WRITE_SIZE ( 20 )
 
#define LR1110_GNSS_CONTEXT_STATUS_LENGTH ( 9 )
 
#define LR1110_GNSS_FULL_ALMANAC_READ_BUFFER_SIZE \
    ( ( LR1110_GNSS_FULL_UPDATE_N_ALMANACS * LR1110_GNSS_SINGLE_ALMANAC_READ_SIZE ) + 4 )
 
#define LR1110_GNSS_DMC_ALMANAC_UPDATE_POS ( 1U )
#define LR1110_GNSS_DMC_ALMANAC_UPDATE_GPS_MASK ( 0x01UL << LR1110_GNSS_DMC_ALMANAC_UPDATE_POS )
#define LR1110_GNSS_DMC_ALMANAC_UPDATE_BEIDOU_MASK ( 0x02UL << LR1110_GNSS_DMC_ALMANAC_UPDATE_POS )
 
#define LR1110_GNSS_DMC_FREQUENCY_SEARCH_SPACE_MSB_POS ( 0U )
#define LR1110_GNSS_DMC_FREQUENCY_SEARCH_SPACE_MSB_MASK ( 0x01UL << LR1110_GNSS_DMC_FREQUENCY_SEARCH_SPACE_MSB_POS )
 
#define LR1110_GNSS_DMC_FREQUENCY_SEARCH_SPACE_LSB_POS ( 7U )
#define LR1110_GNSS_DMC_FREQUENCY_SEARCH_SPACE_LSB_MASK ( 0x01UL << LR1110_GNSS_DMC_FREQUENCY_SEARCH_SPACE_LSB_POS )
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC TYPES ------------------------------------------------------------
 */
 
typedef uint8_t lr1110_gnss_satellite_id_t;
 
enum lr1110_gnss_result_fields_legacy_e
{
    LR1110_GNSS_RESULTS_LEGACY_PSEUDO_RANGE_MASK = ( 1 << 0 ),  
    LR1110_GNSS_RESULTS_LEGACY_DOPPLER_MASK      = ( 1 << 1 ),  
    LR1110_GNSS_RESULTS_LEGACY_BIT_CHANGE_MASK   = ( 1 << 2 ),  
};
 
enum lr1110_gnss_result_fields_e
{
    LR1110_GNSS_RESULTS_DOPPLER_ENABLE_MASK = ( 1 << 0 ),  
    LR1110_GNSS_RESULTS_DOPPLER_MASK = ( 1 << 1 ),     
    LR1110_GNSS_RESULTS_BIT_CHANGE_MASK = ( 1 << 2 ),  
};
 
typedef enum
{
    LR1110_GNSS_GPS_MASK    = 0x01,
    LR1110_GNSS_BEIDOU_MASK = 0x02
} lr1110_gnss_constellation_t;
 
typedef uint8_t lr1110_gnss_constellation_mask_t;
 
typedef enum
{
    LR1110_GNSS_OPTION_DEFAULT     = 0x00,  
    LR1110_GNSS_OPTION_BEST_EFFORT = 0x01  
} lr1110_gnss_search_mode_t;
 
typedef enum
{
    LR1110_GNSS_DESTINATION_HOST   = 0x00,  
    LR1110_GNSS_DESTINATION_SOLVER = 0x01,  
    LR1110_GNSS_DESTINATION_DMC    = 0x02  
} lr1110_gnss_destination_t;
 
typedef enum
{
    LR1110_GNSS_HOST_OK                                             = 0x00,
    LR1110_GNSS_HOST_UNEXPECTED_CMD                                 = 0x01,
    LR1110_GNSS_HOST_UNIMPLEMENTED_CMD                              = 0x02,
    LR1110_GNSS_HOST_INVALID_PARAMETERS                             = 0x03,
    LR1110_GNSS_HOST_MESSAGE_SANITY_CHECK_ERROR                     = 0x04,
    LR1110_GNSS_HOST_IQ_CAPTURE_FAILS                               = 0x05,
    LR1110_GNSS_HOST_NO_TIME                                        = 0x06,
    LR1110_GNSS_HOST_NO_SATELLITE_DETECTED                          = 0x07,
    LR1110_GNSS_HOST_ALMANAC_IN_FLASH_TOO_OLD                       = 0x08,
    LR1110_GNSS_HOST_ALMANAC_UPDATE_FAILS_CRC_ERROR                 = 0x09,
    LR1110_GNSS_HOST_ALMANAC_UPDATE_FAILS_FLASH_INTEGRITY_ERROR     = 0x0A,
    LR1110_GNSS_HOST_ALMANAC_UPDATE_NOT_ALLOWED                     = 0x0B,
    LR1110_GNSS_HOST_ALMANAC_CRC_ERROR                              = 0x0C,
    LR1110_GNSS_HOST_ALMANAC_VERSION_NOT_SUPPORTED                  = 0x0D,
    LR1110_GNSS_HOST_NOT_ENOUGH_SV_DETECTED_TO_BUILD_A_NAV_MESSAGE  = 0x10
} lr1110_gnss_message_host_status_t;
 
typedef enum
{
    LR1110_GNSS_DMC_STATUS = 0x18  
} lr1110_gnss_message_dmc_opcode_t;
 
typedef enum
{
    LR1110_GNSS_SCAN_MODE_0_SINGLE_SCAN_LEGACY           = 0x00,  
    LR1110_GNSS_SCAN_MODE_3_SINGLE_SCAN_AND_5_FAST_SCANS = 0x03,  
} lr1110_gnss_scan_mode_t;
 
typedef enum lr1110_gnss_error_code_e
{
    LR1110_GNSS_NO_ERROR                            = 0,
    LR1110_GNSS_ERROR_ALMANAC_TOO_OLD               = 1,
    LR1110_GNSS_ERROR_UPDATE_CRC_MISMATCH           = 2,
    LR1110_GNSS_ERROR_UPDATE_FLASH_MEMORY_INTEGRITY = 3,
    LR1110_GNSS_ERROR_ALMANAC_UPDATE_NOT_ALLOWED = 4  
} lr1110_gnss_error_code_t;
 
typedef enum lr1110_gnss_freq_search_space_e
{
    LR1110_GNSS_FREQUENCY_SEARCH_SPACE_250_HZ = 0,
    LR1110_GNSS_FREQUENCY_SEARCH_SPACE_500_HZ = 1,
    LR1110_GNSS_FREQUENCY_SEARCH_SPACE_1_KHZ  = 2,
    LR1110_GNSS_FREQUENCY_SEARCH_SPACE_2_KHZ  = 3
} lr1110_gnss_freq_search_space_t;
 
typedef uint32_t lr1110_gnss_date_t;
 
typedef uint8_t lr1110_gnss_almanac_full_read_bytestream_t[LR1110_GNSS_FULL_ALMANAC_READ_BUFFER_SIZE];
 
typedef uint8_t lr1110_gnss_context_status_bytestream_t[LR1110_GNSS_CONTEXT_STATUS_LENGTH];
 
typedef struct lr1110_gnss_solver_assistance_position_s
{
    float latitude;   
    float longitude;  
} lr1110_gnss_solver_assistance_position_t;
 
typedef struct lr1110_gnss_detected_satellite_s
{
    lr1110_gnss_satellite_id_t satellite_id;
    int8_t                     cnr;     
    int16_t                    doppler; 
} lr1110_gnss_detected_satellite_t;
 
typedef struct lr1110_gnss_timings_s
{
    uint32_t radio_ms;
    uint32_t computation_ms;
} lr1110_gnss_timings_t;
 
typedef struct lr1110_gnss_version_s
{
    uint8_t gnss_firmware;  
    uint8_t gnss_almanac;   
} lr1110_gnss_version_t;
 
typedef struct lr1110_gnss_context_status_s
{
    uint8_t     firmware_version;
    uint32_t    global_almanac_crc;
    uint8_t     error_code;
    bool        almanac_update_gps;
    bool        almanac_update_beidou;
    uint8_t     freq_search_space;
} lr1110_gnss_context_status_t;
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC FUNCTIONS PROTOTYPES ---------------------------------------------
 */
 
#ifdef __cplusplus
}
#endif
 
#endif  // LR1110_GNSS_TYPES_H
 
/* --- EOF ------------------------------------------------------------------ */