Developer World
Spresense SDK Library v1.4.2-3df2e9d
lte_api.h File Reference

LTE API definitions. More...

#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_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
 

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_APN_IPTYPE_IP   (0)
 
#define LTE_APN_IPTYPE_IPV6   (1)
 
#define LTE_APN_IPTYPE_IPV4V6   (2)
 
#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   (5)
 
#define LTE_VER_NP_PACKAGE_LEN   (32)
 
#define LTE_PIN_ENABLE   (true)
 
#define LTE_PIN_DISABLE   (false)
 
#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_CELLINFO_MCC_DIGIT   LTE_MCC_DIGIT
 
#define LTE_CELLINFO_MNC_DIGIT_MAX   LTE_MNC_DIGIT_MAX
 
#define LTE_EDRX_ACTTYPE_WBS1   (0)
 
#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_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_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_IPTYPE_V4   (0)
 
#define LTE_IPTYPE_V6   (1)
 
#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_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_MCC_DIGIT   LTE_MCC_DIGIT
 
#define LTE_SIMINFO_MNC_DIGIT_MAX   LTE_MNC_DIGIT_MAX
 
#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 EXTERN   extern "C"
 

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_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 void(* get_ver_cb_t) (uint32_t result, lte_version_t *version)
 
typedef void(* get_phoneno_cb_t) (uint32_t result, uint8_t errcause, int8_t *phoneno)
 
typedef void(* get_imsi_cb_t) (uint32_t result, uint8_t errcause, int8_t *imsi)
 
typedef void(* get_imei_cb_t) (uint32_t result, int8_t *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, int8_t *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_quality_cb_t) (uint32_t result, lte_quality_t *quality)
 

Functions

Functions
int32_t lte_initialize (void)
 
int32_t lte_finalize (void)
 
int32_t lte_set_report_restart (restart_report_cb_t restart_callback)
 
int32_t lte_power_on (void)
 
int32_t lte_power_off (void)
 
int32_t lte_radio_on (radio_on_cb_t callback)
 
int32_t lte_radio_off (radio_off_cb_t callback)
 
int32_t lte_get_netinfo (get_netinfo_cb_t callback)
 
int32_t lte_activate_pdn (lte_apn_setting_t *apn, activate_pdn_cb_t callback)
 
int32_t lte_activate_pdn_cancel (void)
 
int32_t lte_deactivate_pdn (uint8_t session_id, deactivate_pdn_cb_t callback)
 
int32_t lte_data_allow (uint8_t session_id, uint8_t allow, uint8_t roaming_allow, data_allow_cb_t callback)
 
int32_t lte_get_imscap (get_imscap_cb_t callback)
 
int32_t lte_get_version (get_ver_cb_t callback)
 
int32_t lte_get_phoneno (get_phoneno_cb_t callback)
 
int32_t lte_get_imsi (get_imsi_cb_t callback)
 
int32_t lte_get_imei (get_imei_cb_t callback)
 
int32_t lte_get_pinset (get_pinset_cb_t callback)
 
int32_t lte_set_pinenable (bool enable, int8_t *pincode, set_pinenable_cb_t callback)
 
int32_t lte_change_pin (int8_t target_pin, int8_t *pincode, int8_t *new_pincode, change_pin_cb_t callback)
 
int32_t lte_enter_pin (int8_t *pincode, int8_t *new_pincode, enter_pin_cb_t callback)
 
int32_t lte_get_localtime (get_localtime_cb_t callback)
 
int32_t lte_get_operator (get_operator_cb_t callback)
 
int32_t lte_get_edrx (get_edrx_cb_t callback)
 
int32_t lte_set_edrx (lte_edrx_setting_t *settings, set_edrx_cb_t callback)
 
int32_t lte_get_psm (get_psm_cb_t callback)
 
int32_t lte_set_psm (lte_psm_setting_t *settings, set_psm_cb_t callback)
 
int32_t lte_get_ce (get_ce_cb_t callback)
 
int32_t lte_set_ce (lte_ce_setting_t *settings, set_ce_cb_t callback)
 
int32_t lte_set_report_simstat (simstat_report_cb_t simstat_callback)
 
int32_t lte_set_report_localtime (localtime_report_cb_t localtime_callback)
 
int32_t lte_set_report_quality (quality_report_cb_t quality_callback, uint32_t period)
 
int32_t lte_set_report_cellinfo (cellinfo_report_cb_t cellinfo_callback, uint32_t period)
 
int32_t lte_set_report_netinfo (netinfo_report_cb_t netinfo_callback)
 
int32_t lte_get_errinfo (lte_errinfo_t *info)
 
int32_t lte_get_siminfo (uint32_t option, get_siminfo_cb_t callback)
 
int32_t lte_get_dynamic_edrx_param (get_dynamic_edrx_param_cb_t callback)
 
int32_t lte_get_dynamic_psm_param (get_dynamic_psm_param_cb_t callback)
 
int32_t lte_get_quality (get_quality_cb_t callback)
 

Detailed Description

LTE API definitions.