lr1110_modem_gnss_types.h

Go to the documentation of this file.

 
#ifndef LR1110_MODEM_GNSS_TYPES_H
#define LR1110_MODEM_GNSS_TYPES_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * -----------------------------------------------------------------------------
 * --- DEPENDENCIES ------------------------------------------------------------
 */
 
#include <stdbool.h>
#include <stdint.h>
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC MACROS -----------------------------------------------------------
 */
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC CONSTANTS --------------------------------------------------------
 */
 
#define LR1110_MODEM_GNSS_FULL_UPDATE_N_ALMANACS ( 128 )
 
#define LR1110_MODEM_GNSS_SINGLE_ALMANAC_READ_SIZE ( 22 )
 
#define LR1110_MODEM_GNSS_SINGLE_ALMANAC_WRITE_SIZE ( 20 )
 
#define LR1110_MODEM_GNSS_FULL_ALMANAC_WRITE_BUFFER_SIZE \
    ( ( LR1110_MODEM_GNSS_FULL_UPDATE_N_ALMANACS * LR1110_MODEM_GNSS_SINGLE_ALMANAC_WRITE_SIZE ) + 20 )
 
#define LR1110_MODEM_GNSS_SCAN_RESULT_DESTINATION_INDEX ( 0 )
 
#define LR1110_MODEM_GNSS_SCAN_RESULT_EVENT_TYPE_INDEX ( 1 )
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC TYPES ------------------------------------------------------------
 */
 
typedef enum
{
    LR1110_MODEM_GNSS_SCAN_DONE_PROCESS_OK                                 = 0x00,
    LR1110_MODEM_GNSS_SCAN_DONE_IQ_FAILS                                   = 0x05,
    LR1110_MODEM_GNSS_SCAN_DONE_NO_TIME                                    = 0x06,
    LR1110_MODEM_GNSS_SCAN_DONE_NO_SATELLITE_DETECTED                      = 0x07,
    LR1110_MODEM_GNSS_SCAN_DONE_ALMANAC_TOO_OLD                            = 0x08,
    LR1110_MODEM_GNSS_SCAN_DONE_ALMANAC_UPDATE_FAILS_CRC_ERROR             = 0x09,
    LR1110_MODEM_GNSS_SCAN_DONE_ALMANAC_UPDATE_FAILS_FLASH_INTEGRITY_ERROR = 0x0A,
    LR1110_MODEM_GNSS_SCAN_DONE_GLOBAL_ALMANAC_CRC_ERROR                   = 0x0D,
    LR1110_MODEM_GNSS_SCAN_DONE_ALMANAC_VERSION_NOT_SUPPORTED              = 0x0E
} lr1110_modem_gnss_scan_done_event_t;
 
typedef enum
{
    LR1110_MODEM_GNSS_DESTINATION_HOST   = 0x00,  
    LR1110_MODEM_GNSS_DESTINATION_SOLVER = 0x01   
} lr1110_modem_gnss_destination_t;
 
typedef enum
{
    LR1110_MODEM_GNSS_OPTION_DEFAULT     = 0x00,  
    LR1110_MODEM_GNSS_OPTION_BEST_EFFORT = 0x01   
} lr1110_modem_gnss_search_mode_t;
 
enum lr1110_modem_gnss_result_mask_e
{
    LR1110_MODEM_GNSS_PSEUDO_RANGE_MASK = ( 1 << 0 ),
    LR1110_MODEM_GNSS_DOPPLER_MASK      = ( 1 << 1 ),
    LR1110_MODEM_GNSS_BIT_CHANGE_MASK   = ( 1 << 2 )
};
 
typedef enum
{
    LR1110_MODEM_GNSS_GPS_MASK    = 0x01,
    LR1110_MODEM_GNSS_BEIDOU_MASK = 0x02
} lr1110_modem_gnss_constellation_t;
 
typedef enum
{
    LR1110_MODEM_GNSS_ALMANAC_CONSTELLATION_GPS       = 0x01,
    LR1110_MODEM_GNSS_ALMANAC_CONSTELLATION_BEIDOU    = 0x02,
    LR1110_MODEM_GNSS_ALMANAC_CONSTELLATION_UNDEFINED = 0x08
} lr1110_modem_gnss_almanac_constellation_id_t;
 
typedef enum
{
    LR1110_MODEM_GNSS_FREQUENCY_SEARCH_SPACE_250_HZ = 0x00,
    LR1110_MODEM_GNSS_FREQUENCY_SEARCH_SPACE_500_HZ = 0x01,
    LR1110_MODEM_GNSS_FREQUENCY_SEARCH_SPACE_1_KHZ  = 0x02,
    LR1110_MODEM_GNSS_FREQUENCY_SEARCH_SPACE_2_KHZ  = 0x03
} lr1110_modem_gnss_frequency_search_space_t;
 
typedef enum
{
    LR1110_MODEM_GNSS_CONTEXT_STATUS_NO_ERROR                         = 0x00,  
    LR1110_MODEM_GNSS_CONTEXT_STATUS_ALMANAC_TOO_OLD                  = 0x01,  
    LR1110_MODEM_GNSS_CONTEXT_STATUS_LAST_ALMANAC_UPDATE_CRC_MISMATCH = 0x02,  
    LR1110_MODEM_GNSS_CONTEXT_STATUS_FLASH_MEMORY_INTEGRITY_ERROR     = 0x03,  
    LR1110_MODEM_GNSS_CONTEXT_STATUS_LAST_ALMANAC_UPDATE_TOO_OLD =
        0x04   
} lr1110_modem_gnss_context_status_error_code_t;
 
typedef uint8_t lr1110_modem_gnss_satellite_id_t;
 
typedef uint8_t lr1110_modem_gnss_constellation_mask_t;
 
typedef uint8_t lr1110_modem_gnss_frequency_search_space_mask_t;
 
typedef uint8_t lr1110_modem_gnss_almanac_full_update_bytestream_t[LR1110_MODEM_GNSS_FULL_ALMANAC_WRITE_BUFFER_SIZE];
 
typedef uint8_t lr1110_modem_gnss_almanac_one_chunk_bytestream_t[LR1110_MODEM_GNSS_SINGLE_ALMANAC_WRITE_SIZE];
 
typedef struct
{
    float latitude;   
    float longitude;  
} lr1110_modem_gnss_solver_assistance_position_t;
 
typedef struct
{
    lr1110_modem_gnss_satellite_id_t satellite_id;  
    int8_t                           cnr;           
} lr1110_modem_gnss_detected_satellite_t;
 
typedef struct
{
    uint32_t radio_ms;        
    uint32_t computation_ms;  
} lr1110_modem_gnss_timings_t;
 
typedef struct
{
    uint8_t gnss_firmware;  
    uint8_t gnss_almanac;   
} lr1110_modem_gnss_version_t;
 
typedef struct
{
    uint8_t  gnss_firmware_version;  
    uint32_t global_almanac_crc;  
    uint8_t  error_code;               
    uint8_t  almanac_update_bit_mask;  
    uint8_t  frequency_search_space;   
} lr1110_modem_gnss_context_t;
 
#ifdef __cplusplus
}
#endif
 
#endif  // LR1110_MODEM_GNSS_TYPES_H