luat_mobile.h

浏览该文件的文档.

/*
 * Copyright (c) 2022 OpenLuat & AirM2M
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
 
#ifndef __LUAT_MOBILE_H__
#define __LUAT_MOBILE_H__
 
#include "luat_base.h"
int luat_mobile_get_imei(int sim_id, char* buff, size_t buf_len);
 
int luat_mobile_get_sn(char* buff, size_t buf_len);
 
int luat_mobile_set_sn(char* buff, uint8_t buf_len);
 
int luat_mobile_get_muid(char* buff, size_t buf_len);
 
int luat_mobile_get_iccid(int sim_id, char* buff, size_t buf_len);
 
int luat_mobile_get_imsi(int sim_id, char* buff, size_t buf_len);
 
int luat_mobile_get_sim_number(int sim_id, char* buff, size_t buf_len);
 
int luat_mobile_get_sim_id(int *id);
 
int luat_mobile_set_sim_id(int id);
 
typedef enum LUAT_MOBILE_SIM_PIN_OP
{
    LUAT_SIM_PIN_VERIFY = 0,       /* verify pin code */
    LUAT_SIM_PIN_CHANGE,       /* change pin code */
    LUAT_SIM_PIN_ENABLE,       /* enable the pin1 state for verification */
    LUAT_SIM_PIN_DISABLE,      /* disable the pin1 state */
    LUAT_SIM_PIN_UNBLOCK,      /* unblock pin code */
//  LUAT_SIM_PIN_QUERY,        /* query pin1 state, enable or disable */
}LUAT_MOBILE_SIM_PIN_OP_E;
 
int luat_mobile_set_sim_pin(int id, uint8_t operation, char pin1[9], char pin2[9]);
 
uint8_t luat_mobile_get_sim_ready(int id);
 
void luat_mobile_set_sim_detect_sim0_first(void);
 
void luat_mobile_set_default_pdn_ipv6(uint8_t onoff);
 
uint8_t luat_mobile_get_default_pdn_ipv6(void);
 
 
int luat_mobile_get_apn(int sim_id, int cid, char* buff, size_t buf_len);
 
void luat_mobile_user_ctrl_apn(void);
void luat_mobile_user_ctrl_apn_stop(void);
int luat_mobile_set_apn_base_info(int sim_id, int cid, uint8_t type, uint8_t* apn_name, uint8_t name_len);
 
 
int luat_mobile_set_apn_auth_info(int sim_id, int cid, uint8_t protocol, uint8_t *user_name, uint8_t user_name_len, uint8_t *password, uint8_t password_len);
 
int luat_mobile_active_apn(int sim_id, int cid, uint8_t state);
 
int luat_mobile_active_netif(int sim_id, int cid);
 
void luat_mobile_user_apn_auto_active(int sim_id, uint8_t cid,
        uint8_t ip_type,
        uint8_t protocol_type,
        uint8_t *apn_name, uint8_t apn_name_len,
        uint8_t *user, uint8_t user_len,
        uint8_t *password, uint8_t password_len);
 
int luat_mobile_get_default_apn(int sim_id, char* buff, size_t buf_len);
 
int luat_mobile_del_apn(int sim_id, uint8_t cid, uint8_t is_dedicated);
 
int luat_mobile_set_flymode(int index, int mode);
 
int luat_mobile_get_flymode(int index);
 
#if (!defined __LUATOS__) || ((defined __LUATOS__) && (defined LUAT_USE_LWIP))
#include "lwip/opt.h"
#include "lwip/netif.h"
#include "lwip/inet.h"
 
int luat_mobile_get_local_ip(int sim_id, int cid, ip_addr_t *ip_v4, ip_addr_t *ip_v6);
#endif
/* -------------------------------------------------- cell info begin -------------------------------------------------- */
#define LUAT_MOBILE_CELL_MAX_NUM 21
 
typedef struct luat_mobile_gsm_service_cell_info
{
    int cid;        
    int mcc;        
    int mnc;        
    int lac;        
    int arfcn;      
    int bsic;       
    int rssi;       
}luat_mobile_gsm_service_cell_info_t;
 
typedef struct luat_mobile_gsm_cell_info
{
    int cid;        
    int mcc;        
    int mnc;        
    int lac;        
    int arfcn;      
    int bsic;       
    int rssi;       
}luat_mobile_gsm_cell_info_t;
 
typedef struct luat_mobile_lte_service_cell_info
{
    uint32_t cid;           
    uint16_t mcc;           
    uint16_t mnc;           
    uint16_t tac;           
    uint16_t pci;           
    uint32_t earfcn;        
    int16_t rssi;          
    int16_t rsrp;
    int16_t rsrq;
    int16_t snr;
    uint8_t is_tdd;
    uint8_t band;
    uint8_t ulbandwidth;
    uint8_t dlbandwidth;
}luat_mobile_lte_service_cell_info_t;
 
typedef struct luat_mobile_lte_cell_info
{
    uint32_t cid;           
    uint16_t mcc;           
    uint16_t mnc;           
    uint16_t tac;           
    uint16_t pci;           
    union
    {
        uint32_t earfcn;        
        uint32_t frequency;
    };
    uint16_t bandwidth;
    uint16_t celltype; /*0:intra lte ncell, 1:inter lte ncell */
    int16_t rsrp;
    int16_t rsrq;
    int16_t snr;
    int16_t rssi;
}luat_mobile_lte_cell_info_t;
 
typedef struct luat_mobile_cell_info
{
    luat_mobile_gsm_service_cell_info_t gsm_service_info;                   
    luat_mobile_gsm_cell_info_t    gsm_info[LUAT_MOBILE_CELL_MAX_NUM];    
    luat_mobile_lte_service_cell_info_t lte_service_info;                   
    luat_mobile_lte_cell_info_t    lte_info[LUAT_MOBILE_CELL_MAX_NUM];    
    uint32_t                        version;
    uint8_t                         gsm_info_valid;                         
    uint8_t                         gsm_neighbor_info_num;                           
    uint8_t                         lte_info_valid;                         
    uint8_t                         lte_neighbor_info_num;                           
}luat_mobile_cell_info_t;
 
int luat_mobile_get_cell_info(luat_mobile_cell_info_t  *info);
 
int luat_mobile_get_cell_info_async(uint8_t max_time);
 
int luat_mobile_get_cell_info_async_with_sim_id(uint8_t sim_id);
int luat_mobile_get_last_notify_cell_info(luat_mobile_cell_info_t  *info);
int luat_mobile_get_last_notify_cell_info_with_sim_id(uint8_t sim_id, luat_mobile_cell_info_t  *info);
 
void luat_mobile_print_last_notify_cell_info_with_sim_id(uint8_t sim_id);
 
typedef struct luat_mobile_gw_signal_strength_info
{
    int rssi;
    int bitErrorRate;
    int rscp;
    int ecno;
}luat_mobile_gw_signal_strength_info_t;
 
typedef struct luat_mobile_lte_signal_strength_info
{
    int16_t rssi;          
    int16_t rsrp;
    int16_t rsrq;
    int16_t snr;
}luat_mobile_lte_signal_strength_info_t;
 
typedef struct luat_mobile_signal_strength_info
{
    luat_mobile_gw_signal_strength_info_t   gw_signal_strength;
    luat_mobile_lte_signal_strength_info_t  lte_signal_strength;
    uint8_t luat_mobile_gw_signal_strength_vaild;
    uint8_t luat_mobile_lte_signal_strength_vaild;
}luat_mobile_signal_strength_info_t;
 
uint8_t luat_mobile_rssi_to_csq(int8_t rssi);
 
int luat_mobile_get_signal_strength_info(luat_mobile_signal_strength_info_t *info);
 
int luat_mobile_get_signal_strength(uint8_t *csq);
 
int luat_mobile_get_last_notify_signal_strength_info(luat_mobile_signal_strength_info_t *info);
 
int luat_mobile_get_last_notify_signal_strength(uint8_t *csq);
 
int luat_mobile_get_service_cell_identifier(uint32_t *eci);
 
int luat_mobile_get_service_tac_or_lac(uint16_t *tac);
/* --------------------------------------------------- cell info end --------------------------------------------------- */
 
 
/* ------------------------------------------------ mobile status begin ----------------------------------------------- */
typedef enum LUAT_MOBILE_EVENT
{
    LUAT_MOBILE_EVENT_CFUN = 0, 
    LUAT_MOBILE_EVENT_SIM, 
    LUAT_MOBILE_EVENT_REGISTER_STATUS,     
    LUAT_MOBILE_EVENT_CELL_INFO,    
    LUAT_MOBILE_EVENT_PDP,  
    LUAT_MOBILE_EVENT_NETIF,    
    LUAT_MOBILE_EVENT_TIME_SYNC,    
    LUAT_MOBILE_EVENT_CSCON, 
    LUAT_MOBILE_EVENT_BEARER,
    LUAT_MOBILE_EVENT_SMS,  
    LUAT_MOBILE_EVENT_NAS_ERROR,
    LUAT_MOBILE_EVENT_IMS_REGISTER_STATUS, 
    LUAT_MOBILE_EVENT_CC,   
    LUAT_MOBILE_EVENT_FATAL_ERROR = 0xff,
}LUAT_MOBILE_EVENT_E;
 
typedef enum LUAT_MOBILE_CFUN_STATUS
{
    LUAT_MOBILE_CFUN_OFF = 0,
    LUAT_MOBILE_CFUN_ON,
    LUAT_MOBILE_CFUN_NO_RF = 4,
}LUAT_MOBILE_CFUN_STATUS_E;
 
typedef enum LUAT_MOBILE_SIM_STATUS
{
    LUAT_MOBILE_SIM_READY = 0,  
    LUAT_MOBILE_NO_SIM,         
    LUAT_MOBILE_SIM_NEED_PIN,   
    LUAT_MOBILE_SIM_ENTER_PIN_RESULT,   
    LUAT_MOBILE_SIM_NUMBER,     
    LUAT_MOBILE_SIM_WC          
}LUAT_MOBILE_SIM_STATUS_E;
 
typedef enum LUAT_MOBILE_REGISTER_STATUS
{
    LUAT_MOBILE_STATUS_UNREGISTER,  
    LUAT_MOBILE_STATUS_REGISTERED,  
    LUAT_MOBILE_STATUS_SEARCHING,   
    LUAT_MOBILE_STATUS_DENIED,      
    LUAT_MOBILE_STATUS_UNKNOW,      
    LUAT_MOBILE_STATUS_REGISTERED_ROAMING,  
    LUAT_MOBILE_STATUS_SMS_ONLY_REGISTERED,
    LUAT_MOBILE_STATUS_SMS_ONLY_REGISTERED_ROAMING,
    LUAT_MOBILE_STATUS_EMERGENCY_REGISTERED,
    LUAT_MOBILE_STATUS_CSFB_NOT_PREFERRED_REGISTERED,
    LUAT_MOBILE_STATUS_CSFB_NOT_PREFERRED_REGISTERED_ROAMING,
}LUAT_MOBILE_REGISTER_STATUS_E;
 
typedef enum LUAT_MOBILE_CELL_INFO_STATUS
{
    LUAT_MOBILE_CELL_INFO_UPDATE = 0,   
    LUAT_MOBILE_SIGNAL_UPDATE,          
}LUAT_MOBILE_CELL_INFO_STATUS_E;
 
typedef enum LUAT_MOBILE_PDP_STATUS
{
    LUAT_MOBILE_PDP_ACTIVED = 0,
    LUAT_MOBILE_PDP_DEACTIVING,
    LUAT_MOBILE_PDP_DEACTIVED,
}LUAT_MOBILE_PDP_STATUS_E;
 
typedef enum LUAT_MOBILE_NETIF_STATUS
{
    LUAT_MOBILE_NETIF_LINK_ON = 0, 
    LUAT_MOBILE_NETIF_LINK_OFF, 
    LUAT_MOBILE_NETIF_LINK_OOS, 
}LUAT_MOBILE_NETIF_STATUS_E;
 
typedef enum LUAT_MOBILE_BEARER_STATUS
{
    LUAT_MOBILE_BEARER_GET_DEFAULT_APN = 0,
    LUAT_MOBILE_BEARER_APN_SET_DONE,
    LUAT_MOBILE_BEARER_AUTH_SET_DONE,
    LUAT_MOBILE_BEARER_DEL_DONE,
    LUAT_MOBILE_BEARER_SET_ACT_STATE_DONE,
}LUAT_MOBILE_BEARER_STATUS_E;
 
typedef enum LUAT_MOBILE_SMS_STATUS
{
    LUAT_MOBILE_SMS_READY = 0, 
    LUAT_MOBILE_NEW_SMS, 
    LUAT_MOBILE_SMS_SEND_DONE, 
    LUAT_MOBILE_SMS_ACK, 
}LUAT_MOBILE_SMS_STATUS_E;
 
typedef enum LUAT_MOBILE_IMS_REGISTER_STATUS
{
    LUAT_MOBILE_IMS_READY = 0,   
}LUAT_MOBILE_IMS_REGISTER_STATUS_E;
 
typedef enum LUAT_MOBILE_CC_STATUS
{
    LUAT_MOBILE_CC_READY = 0, 
    LUAT_MOBILE_CC_INCOMINGCALL, 
    LUAT_MOBILE_CC_CALL_NUMBER, 
    LUAT_MOBILE_CC_CONNECTED_NUMBER, 
    LUAT_MOBILE_CC_CONNECTED, 
    LUAT_MOBILE_CC_DISCONNECTED, 
    LUAT_MOBILE_CC_SPEECH_START, 
    LUAT_MOBILE_CC_MAKE_CALL_OK, 
    LUAT_MOBILE_CC_MAKE_CALL_FAILED, 
    LUAT_MOBILE_CC_ANSWER_CALL_DONE, 
    LUAT_MOBILE_CC_HANGUP_CALL_DONE, 
    LUAT_MOBILE_CC_LIST_CALL_RESULT, 
    LUAT_MOBILE_CC_PLAY, 
}LUAT_MOBILE_CC_STATUS_E;
 
typedef enum LUAT_MOBILE_CC_MAKE_CALL_RESULT
{
    LUAT_MOBILE_CC_MAKE_CALL_RESULT_OK = 0, 
    LUAT_MOBILE_CC_MAKE_CALL_RESULT_NO_CARRIER, 
    LUAT_MOBILE_CC_MAKE_CALL_RESULT_BUSY, 
    LUAT_MOBILE_CC_MAKE_CALL_RESULT_ERROR, 
}LUAT_MOBILE_CC_MAKE_CALL_RESULT_E;
 
typedef enum LUAT_MOBILE_CC_PLAY_IND
{
    LUAT_MOBILE_CC_PLAY_STOP, 
    LUAT_MOBILE_CC_PLAY_DIAL_TONE, 
    LUAT_MOBILE_CC_PLAY_RINGING_TONE, 
    LUAT_MOBILE_CC_PLAY_CONGESTION_TONE, 
    LUAT_MOBILE_CC_PLAY_BUSY_TONE, 
    LUAT_MOBILE_CC_PLAY_CALL_WAITING_TONE, 
    LUAT_MOBILE_CC_PLAY_MULTI_CALL_PROMPT_TONE, 
    LUAT_MOBILE_CC_PLAY_CALL_INCOMINGCALL_RINGING, 
}LUAT_MOBILE_CC_PLAY_IND_E;
 
LUAT_MOBILE_SIM_STATUS_E luat_mobile_get_sim_status(void);
 
LUAT_MOBILE_REGISTER_STATUS_E luat_mobile_get_register_status(void);
 
typedef void (*luat_mobile_event_callback_t)(LUAT_MOBILE_EVENT_E event, uint8_t index, uint8_t status);
 
 
typedef void (*luat_mobile_sms_event_callback_t)(uint32_t event, void *param);
 
 
int luat_mobile_event_register_handler(luat_mobile_event_callback_t callback_fun);
 
int luat_mobile_event_deregister_handler(void);
 
 
int luat_mobile_sms_sdk_event_register_handler(luat_mobile_sms_event_callback_t callback_fun);
 
int luat_mobile_sms_event_register_handler(luat_mobile_sms_event_callback_t callback_fun);
/* ------------------------------------------------- mobile status end ------------------------------------------------ */
 
void luat_mobile_set_rrc_auto_release_time(uint8_t s);
 
void luat_mobile_rrc_auto_release_pause(uint8_t onoff);
 
 
void luat_mobile_rrc_release_once(void);
 
int luat_mobile_reset_stack(void);
 
void luat_mobile_fatal_error_auto_reset_stack(uint8_t onoff);
int luat_mobile_set_period_work(uint32_t get_cell_period, uint32_t check_sim_period, uint8_t search_cell_time);
int luat_mobile_set_check_sim(uint32_t check_sim_period);
void luat_mobile_set_check_network_period(uint32_t period);
void luat_mobile_get_ip_data_traffic(uint64_t *uplink, uint64_t *downlink);
void luat_mobile_clear_ip_data_traffic(uint8_t clear_uplink, uint8_t clear_downlink);
 
int luat_mobile_get_support_band(uint8_t *band,  uint8_t *total_num);
int luat_mobile_get_band(uint8_t *band,  uint8_t *total_num);
int luat_mobile_set_band(uint8_t *band,  uint8_t total_num);
 
int luat_mobile_config(uint8_t item, uint32_t value);
 
void luat_mobile_rf_test_mode(uint8_t uart_id, uint8_t on_off);
void luat_mobile_rf_test_input(char *data, uint32_t data_len);
 
enum
{
    MOBILE_CONF_RESELTOWEAKNCELL = 1,
    MOBILE_CONF_STATICCONFIG,
    MOBILE_CONF_QUALITYFIRST,
    MOBILE_CONF_USERDRXCYCLE,
    MOBILE_CONF_T3324MAXVALUE,
    MOBILE_CONF_PSM_MODE,
    MOBILE_CONF_CE_MODE,
    MOBILE_CONF_SIM_WC_MODE,
    MOBILE_CONF_FAKE_CELL_BARTIME,
    MOBILE_CONF_RESET_TO_FACTORY,
};
 
uint32_t luat_mobile_sim_write_counter(void);
 
enum
{
    LUAT_MOBILE_ISP_UNKNOW,
    LUAT_MOBILE_ISP_CMCC,   /*中国移动*/
    LUAT_MOBILE_ISP_CTCC,   /*中国电信*/
    LUAT_MOBILE_ISP_CUCC,   /*中国联通*/
    LUAT_MOBILE_ISP_CRCC,   /*中国广电*/
};
 
 
 
int luat_mobile_get_isp_from_plmn(uint16_t mcc, uint8_t mnc);
 
int luat_mobile_get_plmn_from_imsi(char *imsi, uint16_t *mcc, uint8_t *mnc);
 
 
void luat_mobile_get_last_call_num(char *buf, uint8_t buf_len);
int luat_mobile_make_call(uint8_t sim_id, char *number, uint8_t len);
void luat_mobile_hangup_call(uint8_t sim_id);
int luat_mobile_answer_call(uint8_t sim_id);
int luat_mobile_speech_init(uint8_t multimedia_id,void *callback);
int luat_mobile_speech_upload(uint8_t *data, uint32_t len);
 
void luat_mobile_set_sync_time(uint8_t on_off);
 
uint8_t luat_mobile_get_sync_time(void);
 
int luat_mobile_softsim_onoff(uint8_t on_off);
int luat_mobile_sim_detect_onoff(uint8_t on_off);
#endif