simcom-sim7080.h

Go to the documentation of this file.

 
#ifndef ZEPHYR_INCLUDE_DRIVERS_MODEM_SIMCOM_SIM7080_H
#define ZEPHYR_INCLUDE_DRIVERS_MODEM_SIMCOM_SIM7080_H
 
#include <zephyr/types.h>
 
#include <stdbool.h>
#include <stdint.h>
#include <time.h>
 
#ifdef __cplusplus
extern "C" {
#endif


#define SIM7080_GNSS_DATA_UTC_LEN 20
#define SIM7080_SMS_MAX_LEN 160
#define SIM7080_UE_SYS_INFO_BAND_SIZE 32
#define SIM7080_DNS_MAX_RECOUNT 10
#define SIM7080_DNS_MAX_TIMEOUT_MS 60000

#define SIM7080_LTE_CHANNEL_MASK_NB1 0x7BEFFU
#define SIM7080_LTE_CHANNEL_MASK_M1  0x5FFFFU
#define SIM7080_NUM_LTE_CHANNELS     19U

enum sim7080_state {
        SIM7080_STATE_INIT = 0, 
        SIM7080_STATE_IDLE, 
        SIM7080_STATE_NETWORKING, 
        SIM7080_STATE_GNSS, 
        SIM7080_STATE_OFF, 
};

enum sim7080_rat {
        SIM7080_RAT_LTE_NB1,  
        SIM7080_RAT_LTE_M1,   
        SIM7080_RAT_LTE_AUTO, 
        SIM7080_RAT_GSM,      
};

enum sim7080_lte_chan {
        SIM7080_LTE_CHAN_B1 = BIT(0),   
        SIM7080_LTE_CHAN_B2 = BIT(1),   
        SIM7080_LTE_CHAN_B3 = BIT(2),   
        SIM7080_LTE_CHAN_B4 = BIT(3),   
        SIM7080_LTE_CHAN_B5 = BIT(4),   
        SIM7080_LTE_CHAN_B8 = BIT(5),   
        SIM7080_LTE_CHAN_B12 = BIT(6),  
        SIM7080_LTE_CHAN_B13 = BIT(7),  
        SIM7080_LTE_CHAN_B14 = BIT(8),  
        SIM7080_LTE_CHAN_B18 = BIT(9),  
        SIM7080_LTE_CHAN_B19 = BIT(10), 
        SIM7080_LTE_CHAN_B20 = BIT(11), 
        SIM7080_LTE_CHAN_B25 = BIT(12), 
        SIM7080_LTE_CHAN_B26 = BIT(13), 
        SIM7080_LTE_CHAN_B27 = BIT(14), 
        SIM7080_LTE_CHAN_B28 = BIT(15), 
        SIM7080_LTE_CHAN_B66 = BIT(16), 
        SIM7080_LTE_CHAN_B71 = BIT(17), 
        SIM7080_LTE_CHAN_B85 = BIT(18), 
};

struct sim7080_gnss_data {
        bool run_status;
        bool fix_status;
        char utc[SIM7080_GNSS_DATA_UTC_LEN];
        int32_t lat;
        int32_t lon;
        int32_t alt;
        uint16_t hdop;
        uint16_t cog;
        uint16_t kmh;
};

enum sim7080_sms_stat {
        SIM7080_SMS_STAT_REC_UNREAD = 0, 
        SIM7080_SMS_STAT_REC_READ, 
        SIM7080_SMS_STAT_STO_UNSENT, 
        SIM7080_SMS_STAT_STO_SENT, 
        SIM7080_SMS_STAT_ALL, 
};

enum sim7080_ftp_rc {
        SIM7080_FTP_RC_OK = 0, 
        SIM7080_FTP_RC_FINISHED, 
        SIM7080_FTP_RC_ERROR, 
};

struct sim7080_sms {
        uint8_t first_octet;
        uint8_t tp_pid;
        enum sim7080_sms_stat stat;
        uint16_t index;
        struct {
                uint8_t year; 
                uint8_t month; 
                uint8_t day; 
                uint8_t hour; 
                uint8_t minute; 
                uint8_t second; 
                uint8_t timezone; 
        } time;
        char data[SIM7080_SMS_MAX_LEN + 1];
        uint8_t data_len;
};

struct sim7080_sms_buffer {
        struct sim7080_sms *sms;
        uint8_t nsms;
};

enum sim7080_ue_sys_mode {
        SIM7080_UE_SYS_MODE_NO_SERVICE, 
        SIM7080_UE_SYS_MODE_GSM, 
        SIM7080_UE_SYS_MODE_LTE_CAT_M1, 
        SIM7080_UE_SYS_MODE_LTE_NB_IOT, 
};

enum sim7080_ue_op_mode {
        SIM7080_UE_OP_MODE_ONLINE, 
        SIM7080_UE_OP_MODE_OFFLINE, 
        SIM7080_UE_OP_MODE_FACTORY_TEST_MODE, 
        SIM7080_UE_OP_MODE_RESET, 
        SIM7080_UE_OP_MODE_LOW_POWER_MODE, 
};

struct sim7080_ue_sys_info_gsm {
        uint16_t mcc;
        uint16_t mcn;
        uint16_t lac;
        uint16_t cid;
        uint8_t arfcn[SIM7080_UE_SYS_INFO_BAND_SIZE + 1];
        int16_t rx_lvl;
        int16_t track_lo_adjust;
        uint16_t c1;
        uint16_t c2;
};

struct sim7080_ue_sys_info_lte {
        uint16_t mcc;
        uint16_t mcn;
        uint16_t tac;
        uint32_t sci;
        uint16_t pci;
        uint8_t band[SIM7080_UE_SYS_INFO_BAND_SIZE + 1];
        uint16_t earfcn;
        uint16_t dlbw;
        uint16_t ulbw;
        int16_t rsrq;
        int16_t rsrp;
        int16_t rssi;
        int16_t rssnr;
        int16_t sinr;
};

struct sim7080_ue_sys_info {
        enum sim7080_ue_sys_mode sys_mode;
        enum sim7080_ue_op_mode op_mode;
        union {
                struct sim7080_ue_sys_info_gsm gsm;
                struct sim7080_ue_sys_info_lte lte;
        } cell; 
};

enum sim7080_state mdm_sim7080_get_state(void);

int mdm_sim7080_power_on(void);

int mdm_sim7080_power_off(void);

void mdm_sim7080_force_reset(void);

int mdm_sim7080_start_network(void);

int mdm_sim7080_stop_network(void);

int mdm_sim7080_start_gnss(void);

int mdm_sim7080_start_gnss_xtra(void);

int mdm_sim7080_stop_gnss(void);

int mdm_sim7080_download_xtra(uint8_t server_id, const char *f_name);

int mdm_sim7080_query_xtra_validity(int16_t *diff_h, int16_t *duration_h, struct tm *inject);

int mdm_sim7080_query_gnss(struct sim7080_gnss_data *data);

const char *mdm_sim7080_get_manufacturer(void);

const char *mdm_sim7080_get_model(void);

const char *mdm_sim7080_get_revision(void);

const char *mdm_sim7080_get_imei(void);

const char *mdm_sim7080_get_iccid(void);

int mdm_sim7080_read_sms(struct sim7080_sms_buffer *buffer);

int mdm_sim7080_delete_sms(uint16_t index);

int mdm_sim7080_set_gpio(int gpio, int level);

int mdm_sim7080_ftp_get_start(const char *server, const char *user, const char *passwd,
                                  const char *file, const char *path);

int mdm_sim7080_ftp_get_read(char *dst, size_t *size);

int mdm_sim7080_get_battery_charge(uint8_t *bcs, uint8_t *bcl, uint16_t *voltage);

int mdm_sim7080_get_ue_sys_info(struct sim7080_ue_sys_info *info);

int mdm_sim7080_get_local_time(struct tm *t);

int mdm_sim7080_dns_set_lookup_params(uint8_t recount, uint16_t timeout);

void mdm_sim7080_dns_get_lookup_params(uint8_t *recount, uint16_t *timeout);
 
#if defined(CONFIG_MODEM_SIMCOM_SIM7080_SOCKETS_SOCKOPT_TLS)
typedef int (*sim7080_tls_cert_read_func)(uint8_t *buf, size_t max_len, size_t offset);

int mdm_sim7080_import_root_ca(const char *cert_name, sim7080_tls_cert_read_func read_func,
                               size_t cert_len);

int mdm_sim7080_import_client_cert(const char *cert_name, sim7080_tls_cert_read_func cert_read_func,
                                   size_t cert_len, const char *key_name,
                                   sim7080_tls_cert_read_func key_read_func, size_t key_len,
                                   const char *passwd);

int mdm_sim7080_import_dtls_psk(const char *psk_name, sim7080_tls_cert_read_func read_func,
                                size_t psk_len);

int mdm_sim7080_configure_tls_certs(int fd, const char *root_ca, const char *client_cert);

int mdm_sim7080_configure_dtls_psktable(int fd, const char *psktable);
#endif

void mdm_sim7080_get_rat(enum sim7080_rat *rat);

int mdm_sim7080_set_rat(enum sim7080_rat rat);

void mdm_sim7080_get_lte_bands(uint32_t *nb1, uint32_t *m1);

int mdm_sim7080_set_lte_bands(uint32_t nb1, uint32_t m1);
 
#ifdef __cplusplus
}
#endif

 
#endif /* ZEPHYR_INCLUDE_DRIVERS_MODEM_SIMCOM_SIM7080_H */