Developer World
Spresense SDK Library v3.2.0-ebc0364
Classes | Macros | Typedefs
lte.h File Reference
LTE Driver
#include <stdbool.h>
#include <stdint.h>

Go to the source code of this file.

Classes

struct  lte_version
 
struct  lte_getpin
 
struct  lte_localtime
 
struct  lte_quality
 
struct  lte_neighbor_cell
 
struct  lte_cellinfo
 
struct  lte_edrx_setting
 
struct  lte_psm_timeval
 
struct  lte_psm_setting
 
struct  lte_apn_setting
 
struct  lte_ipaddr
 
struct  lte_pdn
 
struct  lte_reject_cause
 
struct  lte_nw_err_info
 
struct  lte_netinfo
 
struct  lte_error_info
 
struct  lte_ce_setting
 
struct  lte_siminfo
 
struct  lte_ratinfo
 
struct  ltefw_injectdata_s
 

Macros

#define LTE_RESULT_OK   (0)
 
#define LTE_RESULT_ERROR   (1)
 
#define LTE_RESULT_CANCEL   (2)
 
#define LTE_VALID   (true)
 
#define LTE_INVALID   (false)
 
#define LTE_ENABLE   (true)
 
#define LTE_DISABLE   (false)
 
#define LTE_ERR_WAITENTERPIN   (1)
 
#define LTE_ERR_REJECT   (2)
 
#define LTE_ERR_MAXRETRY   (3)
 
#define LTE_ERR_BARRING   (4)
 
#define LTE_ERR_DETACHED   (5)
 
#define LTE_ERR_UNEXPECTED   (255)
 
#define LTE_SESSION_ID_MIN   (1)
 
#define LTE_SESSION_ID_MAX   (5)
 
#define LTE_NETSTAT_NOT_REG_NOT_SEARCHING   (0)
 
#define LTE_NETSTAT_REG_HOME   (1)
 
#define LTE_NETSTAT_NOT_REG_SEARCHING   (2)
 
#define LTE_NETSTAT_REG_DENIED   (3)
 
#define LTE_NETSTAT_UNKNOWN   (4)
 
#define LTE_NETSTAT_REG_ROAMING   (5)
 
#define LTE_NETSTAT_REG_SMS_ONLY_HOME   (6)
 
#define LTE_NETSTAT_REG_SMS_ONLY_ROAMING   (7)
 
#define LTE_NETSTAT_NOT_REG_EMERGENCY   (8)
 
#define LTE_NETSTAT_REG_CSFB_NOT_PREF_HOME   (9)
 
#define LTE_NETSTAT_REG_CSFB_NOT_PREF_ROAMING   (10)
 
#define LTE_APN_LEN   (101)
 
#define LTE_APN_USER_NAME_LEN   (64)
 
#define LTE_APN_PASSWD_LEN   (32)
 
#define LTE_IPTYPE_V4   (0)
 
#define LTE_IPTYPE_V6   (1)
 
#define LTE_IPTYPE_V4V6   (2)
 
#define LTE_IPTYPE_NON   (3)
 
#define LTE_APN_AUTHTYPE_NONE   (0)
 
#define LTE_APN_AUTHTYPE_PAP   (1)
 
#define LTE_APN_AUTHTYPE_CHAP   (2)
 
#define LTE_APN_TYPE_UNKNOWN   (0x01)
 
#define LTE_APN_TYPE_DEFAULT   (0x02)
 
#define LTE_APN_TYPE_MMS   (0x04)
 
#define LTE_APN_TYPE_SUPL   (0x08)
 
#define LTE_APN_TYPE_DUN   (0x10)
 
#define LTE_APN_TYPE_HIPRI   (0x20)
 
#define LTE_APN_TYPE_FOTA   (0x40)
 
#define LTE_APN_TYPE_IMS   (0x80)
 
#define LTE_APN_TYPE_CBS   (0x100)
 
#define LTE_APN_TYPE_IA   (0x200)
 
#define LTE_APN_TYPE_EMERGENCY   (0x400)
 
#define LTE_NETERR_MAXRETRY   (0)
 
#define LTE_NETERR_REJECT   (1)
 
#define LTE_NETERR_NWDTCH   (2)
 
#define LTE_REJECT_CATEGORY_EMM   (0)
 
#define LTE_REJECT_CATEGORY_ESM   (1)
 
#define LTE_VER_BB_PRODUCT_LEN   (32)
 
#define LTE_VER_NP_PACKAGE_LEN   (32)
 
#define LTE_VER_FIRMWARE_LEN   (32)
 
#define LTE_PINSTAT_READY   (0)
 
#define LTE_PINSTAT_SIM_PIN   (1)
 
#define LTE_PINSTAT_SIM_PUK   (2)
 
#define LTE_PINSTAT_PH_SIM_PIN   (3)
 
#define LTE_PINSTAT_PH_FSIM_PIN   (4)
 
#define LTE_PINSTAT_PH_FSIM_PUK   (5)
 
#define LTE_PINSTAT_SIM_PIN2   (6)
 
#define LTE_PINSTAT_SIM_PUK2   (7)
 
#define LTE_PINSTAT_PH_NET_PIN   (8)
 
#define LTE_PINSTAT_PH_NET_PUK   (9)
 
#define LTE_PINSTAT_PH_NETSUB_PIN   (10)
 
#define LTE_PINSTAT_PH_NETSUB_PUK   (11)
 
#define LTE_PINSTAT_PH_SP_PIN   (12)
 
#define LTE_PINSTAT_PH_SP_PUK   (13)
 
#define LTE_PINSTAT_PH_CORP_PIN   (14)
 
#define LTE_PINSTAT_PH_CORP_PUK   (15)
 
#define LTE_TARGET_PIN   (0)
 
#define LTE_TARGET_PIN2   (1)
 
#define LTE_SIMSTAT_REMOVAL   (0)
 
#define LTE_SIMSTAT_INSERTION   (1)
 
#define LTE_SIMSTAT_WAIT_PIN_UNLOCK   (2)
 
#define LTE_SIMSTAT_PERSONAL_FAILED   (3)
 
#define LTE_SIMSTAT_ACTIVATE   (4)
 
#define LTE_SIMSTAT_DEACTIVATE   (5)
 
#define LTE_MCC_DIGIT   (3)
 
#define LTE_MNC_DIGIT_MAX   (3)
 
#define LTE_EDRX_ACTTYPE_WBS1   (0)
 
#define LTE_EDRX_ACTTYPE_NBS1   (1)
 
#define LTE_EDRX_ACTTYPE_ECGSMIOT   (2)
 
#define LTE_EDRX_ACTTYPE_GSM   (3)
 
#define LTE_EDRX_ACTTYPE_IU   (4)
 
#define LTE_EDRX_ACTTYPE_NOTUSE   (5)
 
#define LTE_EDRX_CYC_512   (0)
 
#define LTE_EDRX_CYC_1024   (1)
 
#define LTE_EDRX_CYC_2048   (2)
 
#define LTE_EDRX_CYC_4096   (3)
 
#define LTE_EDRX_CYC_6144   (4)
 
#define LTE_EDRX_CYC_8192   (5)
 
#define LTE_EDRX_CYC_10240   (6)
 
#define LTE_EDRX_CYC_12288   (7)
 
#define LTE_EDRX_CYC_14336   (8)
 
#define LTE_EDRX_CYC_16384   (9)
 
#define LTE_EDRX_CYC_32768   (10)
 
#define LTE_EDRX_CYC_65536   (11)
 
#define LTE_EDRX_CYC_131072   (12)
 
#define LTE_EDRX_CYC_262144   (13)
 
#define LTE_EDRX_CYC_524288   (14)
 
#define LTE_EDRX_CYC_1048576   (15)
 
#define LTE_EDRX_PTW_128   (0)
 
#define LTE_EDRX_PTW_256   (1)
 
#define LTE_EDRX_PTW_384   (2)
 
#define LTE_EDRX_PTW_512   (3)
 
#define LTE_EDRX_PTW_640   (4)
 
#define LTE_EDRX_PTW_768   (5)
 
#define LTE_EDRX_PTW_896   (6)
 
#define LTE_EDRX_PTW_1024   (7)
 
#define LTE_EDRX_PTW_1152   (8)
 
#define LTE_EDRX_PTW_1280   (9)
 
#define LTE_EDRX_PTW_1408   (10)
 
#define LTE_EDRX_PTW_1536   (11)
 
#define LTE_EDRX_PTW_1664   (12)
 
#define LTE_EDRX_PTW_1792   (13)
 
#define LTE_EDRX_PTW_1920   (14)
 
#define LTE_EDRX_PTW_2048   (15)
 
#define LTE_EDRX_PTW_2304   (16)
 
#define LTE_EDRX_PTW_2560   (17)
 
#define LTE_EDRX_PTW_2816   (18)
 
#define LTE_EDRX_PTW_3072   (19)
 
#define LTE_EDRX_PTW_3328   (20)
 
#define LTE_EDRX_PTW_3584   (21)
 
#define LTE_EDRX_PTW_3840   (22)
 
#define LTE_EDRX_PTW_4096   (23)
 
#define LTE_PSM_T3324_UNIT_2SEC   (0)
 
#define LTE_PSM_T3324_UNIT_1MIN   (1)
 
#define LTE_PSM_T3324_UNIT_6MIN   (2)
 
#define LTE_PSM_T3324_UNIT_DEACT   (3)
 
#define LTE_PSM_T3412_UNIT_2SEC   (0)
 
#define LTE_PSM_T3412_UNIT_30SEC   (1)
 
#define LTE_PSM_T3412_UNIT_1MIN   (2)
 
#define LTE_PSM_T3412_UNIT_10MIN   (3)
 
#define LTE_PSM_T3412_UNIT_1HOUR   (4)
 
#define LTE_PSM_T3412_UNIT_10HOUR   (5)
 
#define LTE_PSM_T3412_UNIT_320HOUR   (6)
 
#define LTE_PSM_T3412_UNIT_DEACT   (7)
 
#define LTE_PSM_TIMEVAL_MIN   (0)
 
#define LTE_PSM_TIMEVAL_MAX   (31)
 
#define LTE_IPADDR_MAX_LEN   (40)
 
#define LTE_PDN_SESSIONID_INVALID_ID   (0)
 
#define LTE_PDN_SESSIONID_MIN   (LTE_PDN_SESSIONID_INVALID_ID)
 
#define LTE_PDN_SESSIONID_MAX   (255)
 
#define LTE_PDN_DEACTIVE   (0)
 
#define LTE_PDN_ACTIVE   (1)
 
#define LTE_PDN_IPADDR_MAX_COUNT   (2)
 
#define LTE_IMS_NOT_REGISTERED   (0)
 
#define LTE_IMS_REGISTERED   (1)
 
#define LTE_DATA_DISALLOW   (0)
 
#define LTE_DATA_ALLOW   (1)
 
#define LTE_RESTART_USER_INITIATED   (0)
 
#define LTE_RESTART_MODEM_INITIATED   (1)
 
#define LTE_RESTART_VERSION_ERROR   (2)
 
#define LTE_ERR_INDICATOR_ERRCODE   (0x01)
 
#define LTE_ERR_INDICATOR_ERRNO   (0x02)
 
#define LTE_ERR_INDICATOR_ERRSTR   (0x04)
 
#define LTE_ERROR_STRING_MAX_LEN   (64)
 
#define LTE_SIMINFO_GETOPT_MCCMNC   (1 << 0)
 
#define LTE_SIMINFO_GETOPT_SPN   (1 << 1)
 
#define LTE_SIMINFO_GETOPT_ICCID   (1 << 2)
 
#define LTE_SIMINFO_GETOPT_IMSI   (1 << 3)
 
#define LTE_SIMINFO_GETOPT_GID1   (1 << 4)
 
#define LTE_SIMINFO_GETOPT_GID2   (1 << 5)
 
#define LTE_SIMINFO_SPN_LEN   (16)
 
#define LTE_SIMINFO_ICCID_LEN   (10)
 
#define LTE_SIMINFO_IMSI_LEN   (15)
 
#define LTE_SIMINFO_GID_LEN   (128)
 
#define LTE_PHONENO_LEN   (41)
 
#define LTE_IMEI_LEN   (16)
 
#define LTE_OPERATOR_LEN   (17)
 
#define LTE_IMSI_LEN   (LTE_SIMINFO_IMSI_LEN + 1)
 
#define LTE_CELLINFO_OPT_GCID   (1 << 0)
 
#define LTE_CELLINFO_OPT_AREACODE   (1 << 1)
 
#define LTE_CELLINFO_OPT_SFN   (1 << 2)
 
#define LTE_CELLINFO_OPT_RSRP   (1 << 3)
 
#define LTE_CELLINFO_OPT_RSRQ   (1 << 4)
 
#define LTE_CELLINFO_OPT_TIMEDIFFIDX   (1 << 5)
 
#define LTE_CELLINFO_OPT_TA   (1 << 6)
 
#define LTE_CELLINFO_OPT_NEIGHBOR   (1 << 7)
 
#define LTE_NEIGHBOR_CELL_MAX   (32)
 
#define LTE_RAT_CATM   (2)
 
#define LTE_RAT_NBIOT   (3)
 
#define LTE_RAT_MODE_SINGLE   (0)
 
#define LTE_RAT_MODE_MULTIPLE   (1)
 
#define LTE_RAT_SOURCE_DEFAULT   (0)
 
#define LTE_RAT_SOURCE_HOST   (1)
 
#define LTE_RAT_SOURCE_LWM2M   (2)
 
#define LTE_AT_COMMAND_MAX_LEN   (2048)
 
#define LTEFW_INJECTION_MODE_NEW   (0)
 
#define LTEFW_INJECTION_MODE_APPEND   (1)
 
#define LTEFW_RESULT_OK   (0x0000)
 
#define LTEFW_RESULT_NOT_ENOUGH_INJECTSTORAGE   (-1)
 
#define LTEFW_RESULT_DELTAIMAGE_HDR_CRC_ERROR   (-2)
 
#define LTEFW_RESULT_DELTAIMAGE_HDR_UNSUPPORTED   (-3)
 
#define LTEFW_RESULT_PRECHK_SET_DELTAIMAGE_FAILED   (-4)
 
#define LTEFW_RESULT_DELTAUPDATE_FAILED   (-5)
 
#define LTEFW_RESULT_PRECHK_DELTAIMAGE_MISSING   (-6)
 
#define LTEFW_RESULT_PRECHK_OOM   (-7)
 
#define LTEFW_RESULT_PRECHK_SIZE_ERROR   (-8)
 
#define LTEFW_RESULT_PRECHK_PKG_ERROR   (-9)
 
#define LTEFW_RESULT_PRECHK_CRC_ERROR   (-10)
 
#define LTEFW_RESULT_DELTAUPDATE_NORESULT   (-11)
 
#define LTE_LOG_NAME_LEN   32
 
#define LTE_LOG_LIST_SIZE   3
 

Typedefs

typedef struct lte_version lte_version_t
 
typedef struct lte_getpin lte_getpin_t
 
typedef struct lte_localtime lte_localtime_t
 
typedef struct lte_quality lte_quality_t
 
typedef struct lte_neighbor_cell lte_neighbor_cell_t
 
typedef struct lte_cellinfo lte_cellinfo_t
 
typedef struct lte_edrx_setting lte_edrx_setting_t
 
typedef struct lte_psm_timeval lte_psm_timeval_t
 
typedef struct lte_psm_setting lte_psm_setting_t
 
typedef struct lte_apn_setting lte_apn_setting_t
 
typedef struct lte_ipaddr lte_ipaddr_t
 
typedef struct lte_pdn lte_pdn_t
 
typedef struct lte_reject_cause lte_reject_cause_t
 
typedef struct lte_nw_err_info lte_nw_err_info_t
 
typedef struct lte_netinfo lte_netinfo_t
 
typedef struct lte_error_info lte_errinfo_t
 
typedef struct lte_ce_setting lte_ce_setting_t
 
typedef struct lte_siminfo lte_siminfo_t
 
typedef struct lte_ratinfo lte_ratinfo_t
 
typedef void(* get_ver_cb_t) (uint32_t result, lte_version_t *version)
 
typedef void(* get_phoneno_cb_t) (uint32_t result, uint8_t errcause, char *phoneno)
 
typedef void(* get_imsi_cb_t) (uint32_t result, uint8_t errcause, char *imsi)
 
typedef void(* get_imei_cb_t) (uint32_t result, char *imei)
 
typedef void(* get_pinset_cb_t) (uint32_t result, lte_getpin_t *pinset)
 
typedef void(* set_pinenable_cb_t) (uint32_t result, uint8_t attemptsleft)
 
typedef void(* change_pin_cb_t) (uint32_t result, uint8_t attemptsleft)
 
typedef void(* enter_pin_cb_t) (uint32_t result, uint8_t simstat, uint8_t attemptsleft)
 
typedef void(* get_localtime_cb_t) (uint32_t result, lte_localtime_t *localtime)
 
typedef void(* get_operator_cb_t) (uint32_t result, char *oper)
 
typedef void(* get_edrx_cb_t) (uint32_t result, lte_edrx_setting_t *settings)
 
typedef void(* set_edrx_cb_t) (uint32_t result)
 
typedef void(* get_psm_cb_t) (uint32_t result, lte_psm_setting_t *settings)
 
typedef void(* set_psm_cb_t) (uint32_t result)
 
typedef void(* get_ce_cb_t) (uint32_t result, lte_ce_setting_t *settings)
 
typedef void(* set_ce_cb_t) (uint32_t result)
 
typedef void(* simstat_report_cb_t) (uint32_t simstat)
 
typedef void(* localtime_report_cb_t) (lte_localtime_t *localtime)
 
typedef void(* quality_report_cb_t) (lte_quality_t *quality)
 
typedef void(* cellinfo_report_cb_t) (lte_cellinfo_t *cellinfo)
 
typedef void(* radio_on_cb_t) (uint32_t result)
 
typedef void(* radio_off_cb_t) (uint32_t result)
 
typedef void(* get_netinfo_cb_t) (uint32_t result, lte_netinfo_t *info)
 
typedef void(* get_imscap_cb_t) (uint32_t result, bool imscap)
 
typedef void(* activate_pdn_cb_t) (uint32_t result, lte_pdn_t *pdn)
 
typedef void(* deactivate_pdn_cb_t) (uint32_t result)
 
typedef void(* data_allow_cb_t) (uint32_t result)
 
typedef void(* restart_report_cb_t) (uint32_t reason)
 
typedef void(* netinfo_report_cb_t) (lte_netinfo_t *info)
 
typedef void(* get_siminfo_cb_t) (uint32_t result, lte_siminfo_t *siminfo)
 
typedef void(* get_dynamic_edrx_param_cb_t) (uint32_t result, lte_edrx_setting_t *param)
 
typedef void(* get_dynamic_psm_param_cb_t) (uint32_t result, lte_psm_setting_t *param)
 
typedef void(* get_current_edrx_cb_t) (uint32_t result, lte_edrx_setting_t *settings)
 
typedef void(* get_current_psm_cb_t) (uint32_t result, lte_psm_setting_t *settings)
 
typedef void(* get_quality_cb_t) (uint32_t result, lte_quality_t *quality)
 
typedef void(* context_save_cb_t) (uint8_t *data, int size)