nrf_cloud_pgps.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef NRF_CLOUD_PGPS_H_
#define NRF_CLOUD_PGPS_H_
 
#include <zephyr/kernel.h>
#if defined(CONFIG_NRF_MODEM)
#include <nrf_modem_gnss.h>
#else
struct nrf_modem_gnss_agnss_data_frame;
#endif
#include "nrf_cloud_agnss_schema_v1.h"
#if defined(CONFIG_NRF_CLOUD_COAP)
#include <net/nrf_cloud_location.h>
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NRF_CLOUD_PGPS_NUM_SV                           (32U)
 
struct nrf_cloud_pgps_system_time {
        uint16_t date_day;
        uint32_t time_full_s;
        uint16_t time_frac_ms;
        uint32_t sv_mask;
        uint32_t pad;
} __packed;
 
struct nrf_cloud_pgps_prediction {
        uint8_t time_type;
        uint16_t time_count;
        struct nrf_cloud_pgps_system_time time;
        uint8_t schema_version;
        uint8_t ephemeris_type;
        uint16_t ephemeris_count;
        struct nrf_cloud_agnss_ephemeris ephemerii[NRF_CLOUD_PGPS_NUM_SV];
        uint32_t sentinel;
} __packed;
 
#define NRF_CLOUD_PGPS_REQ_NO_COUNT     0
#define NRF_CLOUD_PGPS_REQ_NO_INTERVAL  0
#define NRF_CLOUD_PGPS_REQ_NO_GPS_DAY   0
#define NRF_CLOUD_PGPS_REQ_NO_GPS_TOD   (-1)
 
struct gps_pgps_request {
        uint16_t prediction_count;
        uint16_t prediction_period_min;
        uint16_t gps_day;
        uint32_t gps_time_of_day;
} __packed;
 
struct nrf_cloud_pgps_result {
        char *host;
        size_t host_sz;
        char *path;
        size_t path_sz;
};
 
struct nrf_cloud_coap_pgps_request {
        const struct gps_pgps_request *pgps_req;
};
 
#define ETIMEUNKNOWN    8000
#define ELOADING        8001
 
#define NRF_CLOUD_PGPS_EMPTY_EPHEM_HEALTH (0xff)
 
enum nrf_cloud_pgps_event_type {
        PGPS_EVT_INIT,
        PGPS_EVT_UNAVAILABLE,
        PGPS_EVT_LOADING,
        PGPS_EVT_AVAILABLE,
        PGPS_EVT_READY,
        PGPS_EVT_REQUEST,
};
 
struct nrf_cloud_pgps_event {
        enum nrf_cloud_pgps_event_type type;
        union {
                struct nrf_cloud_pgps_prediction *prediction;
                struct gps_pgps_request *request;
        };
};
 
typedef void (*pgps_event_handler_t)(struct nrf_cloud_pgps_event *event);
 
struct nrf_cloud_pgps_init_param {
        pgps_event_handler_t event_handler;
        uint32_t storage_base;
        uint32_t storage_size;
};
 
void nrf_cloud_pgps_set_location_normalized(int32_t latitude, int32_t longitude);
 
void nrf_cloud_pgps_set_location(double latitude, double longitude);
 
void nrf_cloud_pgps_clear_location(void);
 
void nrf_cloud_pgps_set_leap_seconds(int leap_seconds);
 
int nrf_cloud_pgps_notify_prediction(void);
 
int nrf_cloud_pgps_find_prediction(struct nrf_cloud_pgps_prediction **prediction);
 
int nrf_cloud_pgps_request(const struct gps_pgps_request *request);
 
int nrf_cloud_pgps_request_all(void);
 
int nrf_cloud_pgps_begin_update(void);
 
int nrf_cloud_pgps_process_update(uint8_t *buf, size_t len);
 
int nrf_cloud_pgps_finish_update(void);
 
void nrf_cloud_pgps_request_reset(void);
 
int nrf_cloud_pgps_process(const char *buf, size_t buf_len);
 
int nrf_cloud_pgps_update(struct nrf_cloud_pgps_result *file_location);
 
int nrf_cloud_pgps_inject(struct nrf_cloud_pgps_prediction *p,
                          const struct nrf_modem_gnss_agnss_data_frame *request);
 
bool nrf_cloud_pgps_loading(void);
 
int nrf_cloud_pgps_preemptive_updates(void);
 
int nrf_cloud_pgps_init(struct nrf_cloud_pgps_init_param *param);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_CLOUD_PGPS_H_ */