/** @file ql_nw.h @brief This file provides the definitions for nw, and declares the API functions. */ /*============================================================================ Copyright (c) 2017 Quectel Wireless Solution, Co., Ltd. All Rights Reserved. Quectel Wireless Solution Proprietary and Confidential. =============================================================================*/ /*=========================================================================== EDIT HISTORY FOR MODULE This section contains comments describing changes made to the module. Notice that changes are listed in reverse chronological order. WHEN WHO WHAT, WHERE, WHY ---------- ------------ ---------------------------------------------------- 01/09/2020 Nebula.li create 22/12/2020 Davison.du add Support dual-SIM dual standby =============================================================================*/ #ifndef __QL_NW_H__ #define __QL_NW_H__ #ifdef __cplusplus extern "C" { #endif #include "ql_type.h" #define QL_NW_IND_VOICE_REG_EVENT_FLAG (1 << 0) //VOICE注册事件 #define QL_NW_IND_DATA_REG_EVENT_FLAG (1 << 1) //DATA注册事件 #define QL_NW_IND_SIGNAL_STRENGTH_EVENT_FLAG (1 << 2) //信号强度事件 #define QL_NW_IND_NITZ_TIME_UPDATE_EVENT_FLAG (1 << 3) //时间跟新事件 #define QL_NW_CELL_MAX_NUM 10 #define QL_NW_MCC_MAX_LEN 3 #define QL_NW_MNC_MAX_LEN 3 #define QL_NW_LONG_EONS_MAX_LEN 32 #define QL_NW_SHORT_EONS_MAX_LEN 32 #define QL_NW_REG_ON_FLAG 0x01 #define QL_NW_REG_OFF_FLAG 0x02 //#pragma pack(push) //#pragma pack(1) typedef enum { QL_NW_SUCCESS, QL_NW_GENERIC_FAILURE, }QL_NW_ERROR_CODE; typedef enum { QL_NW_PREF_NET_TYPE_GSM = 0, /**< GSM */ QL_NW_PREF_NET_TYPE_UMTS, /**< UMTS . not supported in EC100Y and EC200S*/ QL_NW_PREF_NET_TYPE_GSM_UMTS, /**< GSM_UMTS, auto. not supported in EC100Y and EC200S */ QL_NW_PREF_NET_TYPE_GSM_UMTS_PREF_GSM, /**< GSM_UMTS, GSM preferred. not supported in EC100Y and EC200S */ QL_NW_PREF_NET_TYPE_GSM_UMTS_PREF_UMTS, /**< GSM_UMTS, UMTS preferred. not supported in EC100Y and EC200S */ QL_NW_PREF_NET_TYPE_LTE, /**< LTE */ QL_NW_PREF_NET_TYPE_GSM_LTE_AUTO, /**< GSM_LTE, auto, single link */ QL_NW_PREF_NET_TYPE_GSM_LTE_PREF_GSM, /**< GSM_LTE, GSM preferred, single link */ QL_NW_PREF_NET_TYPE_GSM_LTE_PREF_LTE, /**< GSM_LTE, LTE preferred, single link */ QL_NW_PREF_NET_TYPE_UMTS_LTE_AUTO, /**< UMTS_LTE, auto, single link. not supported in EC100Y and EC200S */ QL_NW_PREF_NET_TYPE_UMTS_LTE_PREF_UMTS, /**< UMTS_LTE, UMTS preferred, single link. not supported in EC100Y and EC200S */ QL_NW_PREF_NET_TYPE_UMTS_LTE_PREF_LTE, /**< UMTS_LTE, LTE preferred, single link . not supported in EC100Y and EC200S*/ QL_NW_PREF_NET_TYPE_GSM_UMTS_LTE_AUTO, /**< GSM_UMTS_LTE, auto, single link. not supported in EC100Y and EC200S */ QL_NW_PREF_NET_TYPE_GSM_UMTS_LTE_PREF_GSM, /**< GSM_UMTS_LTE, GSM preferred, single link. not supported in EC100Y and EC200S */ QL_NW_PREF_NET_TYPE_GSM_UMTS_LTE_PREF_UMTS, /**< GSM_UMTS_LTE, UMTS preferred, single link. not supported in EC100Y and EC200S */ QL_NW_PREF_NET_TYPE_GSM_UMTS_LTE_PREF_LTE, /**< GSM_UMTS_LTE, LTE preferred, single link. not supported in EC100Y and EC200S */ QL_NW_PREF_NET_TYPE_GSM_LTE_DUALLINK, /**< GSM_LTE, dual link */ QL_NW_PREF_NET_TYPE_UMTS_LTE_DUALLINK, /**< UMTS_LTE, dual link. not supported in EC100Y and EC200S */ QL_NW_PREF_NET_TYPE_GSM_UMTS_LTE_DUALLINK, /**< GSM_UMTS_LTE, dual link. not supported in EC100Y and EC200S */ } QL_NW_PREFERRED_NETWORK_TYPE; typedef struct { QL_NW_PREFERRED_NETWORK_TYPE preferred_nw_mode; //首选的网络制式,见QL_NW_PREFERRED_NETWORK_TYPE int roaming_pref; //漫游开关。 0 关; 1 开 }QL_NW_CONFIG_INFO_T; typedef struct { char nitz_time[32]; //格式:format: YY/MM/DD HH:MM:SS '+/-'TZ daylight, 18/09/19 07:40:18 +32 00. unsigned long abs_time; //0表示不可用 unsigned char leap_sec; //0表示不可用 }QL_NW_NITZ_TIME_INFO_T; typedef struct { char long_eons[QL_NW_LONG_EONS_MAX_LEN+1]; char short_eons[QL_NW_SHORT_EONS_MAX_LEN+1]; char mcc[QL_NW_MCC_MAX_LEN+1]; char mnc[QL_NW_MNC_MAX_LEN+1]; }QL_NW_OPERATOR_INFO_T; typedef enum { QL_NW_ACCESS_TECH_GSM = 0, QL_NW_ACCESS_TECH_GSM_COMPACT = 1, QL_NW_ACCESS_TECH_UTRAN = 2, QL_NW_ACCESS_TECH_GSM_wEGPRS = 3, QL_NW_ACCESS_TECH_UTRAN_wHSDPA = 4, QL_NW_ACCESS_TECH_UTRAN_wHSUPA = 5, QL_NW_ACCESS_TECH_UTRAN_wHSDPA_HSUPA = 6, QL_NW_ACCESS_TECH_E_UTRAN = 7, QL_NW_ACCESS_TECH_UTRAN_HSPAP = 8, QL_NW_ACCESS_TECH_E_UTRAN_CA = 9, QL_NW_ACCESS_TECH_NONE = 10, }QL_NW_ACCESS_TECHNOLOGY; typedef struct { int status; //0:未知的网络;1:可用的网络;2:当前的网络;3:禁止使用的网络 QL_NW_OPERATOR_INFO_T operator_name; //运营商信息,见QL_NW_OPERATOR_INFO_T。 QL_NW_ACCESS_TECHNOLOGY act; //注网制式,见QL_NW_RADIO_TECH_TYPE_T。 }QL_NW_SCAN_ENTRY_INFO_T; typedef enum { QL_NW_RADIO_TECH_UNKNOWN = 0, QL_NW_RADIO_TECH_GPRS = 1, QL_NW_RADIO_TECH_EDGE = 2, QL_NW_RADIO_TECH_UMTS = 3, QL_NW_RADIO_TECH_IS95A = 4, QL_NW_RADIO_TECH_IS95B = 5, QL_NW_RADIO_TECH_1xRTT = 6, QL_NW_RADIO_TECH_HSDPA = 9, QL_NW_RADIO_TECH_HSUPA = 10, QL_NW_RADIO_TECH_HSPA = 11, QL_NW_RADIO_TECH_EHRPD = 13, QL_NW_RADIO_TECH_LTE = 14, QL_NW_RADIO_TECH_HSPAP = 15, // HSPA+ QL_NW_RADIO_TECH_GSM = 16, QL_NW_RADIO_TECH_TD_SCDMA = 17, QL_NW_RADIO_TECH_IWLAN = 18, QL_NW_RADIO_TECH_LTEP = 19, QL_NW_RADIO_TECH_DC_HSPA = 20 } QL_NW_RADIO_TECHNOLOGY; typedef enum { QL_NW_REG_STATE_NOT_REGISTERED=0, //not registered, MT is not currently searching an operator to register to QL_NW_REG_STATE_HOME_NETWORK=1, //registered, home network QL_NW_REG_STATE_TRYING_ATTACH_OR_SEARCHING=2, //not registered, but MT is currently trying to attach or searching an operator to register to QL_NW_REG_STATE_DENIED=3, //registration denied QL_NW_REG_STATE_UNKNOWN=4, //unknown QL_NW_REG_STATE_ROAMING=5, //registered, roaming QL_NW_REG_STATE_HOME_NETWORK_SMS_ONLY=6, //registered for “SMS only”, home network (not applicable) QL_NW_REG_STATE_ROAMING_SMS_ONLY=7,// registered for “SMS only”, roaming (not applicable) QL_NW_REG_STATE_ATTACHED_EMERGENCY_ONLY=8, //attached for emergency bearer services only QL_NW_REG_STATE_HOME_NETWORK_CSFB_NOT_PREFERRED=9, //registered for “CSFB not preferred”, home network (not applicable) QL_NW_REG_STATE_ROAMING_CSFB_NOT_PREFERRED=10,//registered for “CSFB not preferred”, roaming (not applicable) QL_NW_REG_STATE_EMERGENCY_ONLY=11,//emergency bearer services only }QL_NW_REG_STATE; typedef struct { QL_NW_REG_STATE state; //注册状态 int lac; int cid; QL_NW_ACCESS_TECHNOLOGY rat; int rejectCause; //注册被拒绝的原因 int psc; //Primary Scrambling Code //char act[10]; // Network access technology (GSM, WCDMA, LTE etc.) } QL_NW_COMMON_REG_STATUS_INFO_T; typedef struct { QL_NW_COMMON_REG_STATUS_INFO_T voice_reg; //VOICE注册信息,见QL_NW_COMMON_REG_STATUS_INFO_T QL_NW_COMMON_REG_STATUS_INFO_T data_reg; //DATA注册信息。 }QL_NW_REG_STATUS_INFO_T; typedef struct { int nw_selection_mode; //0 自动;1手动 char mcc[QL_NW_MCC_MAX_LEN+1]; char mnc[QL_NW_MNC_MAX_LEN+1]; QL_NW_ACCESS_TECHNOLOGY act; //selection 制式,见QL_NW_ACCESS_TECHNOLOGY。 }QL_NW_SELECTION_INFO_T; typedef struct { int rssi; int bitErrorRate; int rscp; int ecno; } QL_NW_GW_SIGNAL_STRENGTH_INFO_T; typedef struct { int rssi; int rsrp; int rsrq; int cqi; } QL_NW_LTE_SIGNAL_STRENGTH_INFO_T; typedef struct { QL_NW_GW_SIGNAL_STRENGTH_INFO_T GW_SignalStrength; QL_NW_LTE_SIGNAL_STRENGTH_INFO_T LTE_SignalStrength; }QL_NW_SIGNAL_STRENGTH_INFO_T; typedef struct { int flag; /**Cell type, 0:present,1:neighbor.*/ int cid; /**Cell ID, (0 indicates information is not represent).*/ int mcc; /**This field should be ignored when cid is not present*/ int mnc; /**This field should be ignored when cid is not present*/ int lac; /**Location area code.(This field should be ignord when cid is not present). */ int arfcn; /**Absolute RF channel number. */ char bsic; /**Base station identity code. (0 indicates information is not present). */ int rssi; /**< Receive signal strength,in dBm */ }QL_MCM_NW_GSM_CELL_INFO_T; typedef struct { int flag; /**Cell type, 0:present,1:inter,2:intra.*/ int cid; /**Cell ID, (0 indicates information is not represent).*/ int lcid; /**UTRAN Cell ID (0 indicates information is not present). */ int mcc; /**This field should be ignored when cid is not present*/ int mnc; /**This field should be ignored when cid is not present*/ int lac; /**Location area code. (This field should be ignored when cid is not present). */ int uarfcn; /**UTRA absolute RF channel number. */ int psc; /**Primary scrambling code. */ int rssi; /**< Receive signal strength,in dBm */ }QL_MCM_NW_UMTS_CELL_INFO_T; typedef enum { QL_NW_CELL_PRESENT, QL_NW_CELL_NEIGHBORING, QL_NW_CELL_NEIGHBORING_INTRAR, QL_NW_CELL_NEIGHBORING_INTER, }QL_NW_CELL_TYPE_E; typedef struct { UINT32 flag; /**Cell type, 0:present,1:inter,2:intra.*/ UINT32 cid; /**当扫描的超时时间到达(option) 2> 扫描到指定的数量(scanMaxBssidNum) * 底层task会触发执行设置的callback *****************************************************************/ QL_NW_ERROR_CODE ql_nw_set_wifiscan_callback(QL_NW_Wifiscan_CBFunc_t wifiscan_cb); /***************************************************************** * Function: ql_nw_get_wifiscan_info * * Description: * 申请扫描wifiscan参数 * * Parameters: * option [in] 扫描超时时间,4000-255000ms,默认是12秒,单位是毫秒 * scanRoundNum [in] 扫描轮数 1-3,默认是1轮 * scanMaxBssidNum [in] 扫描上报数量 4-10,默认是5个,规定了上报的mac地址数量。[最多10个] * sacnTimeout [in] 扫描底层超时时间 0-255,默认是5秒,参数用于配置RRC轮询的timeout时间 * scanPriority [in] 扫描优先级 0-1, 默认是0,表示数据优先 * sendUrcFlag [in] 扫描结果上报方式 0-1,0表示通过回调函数上报 1表示通过URC的方式上报 * Return: * QL_NW_SUCCESS 成功。 * QL_NW_GENERIC_FAILURE 失败。 * *****************************************************************/ QL_NW_ERROR_CODE ql_nw_get_wifiscan_info(unsigned long option, unsigned short scanRoundNum, unsigned short scanMaxBssidNum, unsigned short sacnTimeout, unsigned short scanPriority, unsigned char sendUrcFlag); /***************************************************************** * Function: ql_nw_get_gdcnt * * Description: * 获取流量统计值 * * Parameters: * bytes_send [out] The amount of sent bytes * bytes_recv [out] The amount of received bytes * Return: * QL_NW_SUCCESS 成功。 * QL_NW_GENERIC_FAILURE 失败。 * *****************************************************************/ QL_NW_ERROR_CODE ql_nw_get_gdcnt(int *bytes_send, int *bytes_recv); /***************************************************************** * Function: ql_nw_set_gdcnt * * Description: * 设置流量统计 * * Parameters: * op [in] The operation about data counter 0 0 Reset the data counter 1 Save the results of data counter to NVM * Return: * QL_NW_SUCCESS 成功。 * QL_NW_GENERIC_FAILURE 失败。 * *****************************************************************/ QL_NW_ERROR_CODE ql_nw_set_gdcnt(unsigned char op); /***************************************************************** * Function: ql_delete_all_blackcell * * Description: * 清除异常基站策略中所有黑名单小区 * * Return: * QL_NW_SUCCESS 成功。 * QL_NW_GENERIC_FAILURE 失败。 * *****************************************************************/ QL_NW_ERROR_CODE ql_delete_all_blackcell(void); /***************************************************************** * Function: ql_set_black_cell_cfg * * Description: * 使能及配置异常基站策略(old) * Parameters: * blackcellCfg [in] 整型。0/1 使能/关闭异常基站策略(old)。默认配置 0 * blackcellCfg_num [in] 整型。异常基站策略 坏事件触发次数 * Return: * QL_NW_SUCCESS 成功。 * QL_NW_GENERIC_FAILURE 失败。 * *****************************************************************/ QL_NW_ERROR_CODE ql_set_black_cell_cfg(int blackcellCfg,int blackcellCfg_num); /***************************************************************** * Function: ql_get_black_cell_cfg * * Description: * 查询异常基站策略(old) * * Parameters: * blackcellCfg [out] 整型。0/1 使能/关闭异常基站策略(old)。默认配置 0 * blackcellCfg_num [out] 整型。异常基站策略 坏事件触发次数 * Return: * QL_NW_SUCCESS 成功。 * QL_NW_GENERIC_FAILURE 失败。 * *****************************************************************/ QL_NW_ERROR_CODE ql_get_black_cell_cfg(int* blackcellCfg,int* blackcellCfg_num); /***************************************************************** * Function: ql_set_black_cell_cfg_ex * * Description: * 使能及配置异常基站策略 * * Parameters: * blackcellCfg [in] 整型。0/1 使能/关闭异常基站策略。默认配置 0 * delete_timer_size [in] 整型。以定时清除 拉黑小区时的定时器长度。范围:300~86400;单位:秒,默认配置1800 * prevention_mode [in] 整型。0/1 使能/关闭防呆机制。默认配置 1 * prevention_timer_size [in] 整型。无法注册时,按权重逐级释放黑名单小区的定时器长度 ,范围60-3600,单位:秒,默认配置300。(首次触发后减半) * reject_judge_mode [in] 整型。0/1 异常场景1-3的计数判断机制,默认配置0。 * reject_judge_count [in] 整型。异常场景1-3的计数门限,范围1-255 默认配置5(场景2门限对5向上取整) * black_loop_num [in] 整型。异常场景5频繁重选判定的门限次数,范围1-255 默认配置3 * black_loop_cycle [in] 整型。异常场景5频繁重选判定的门限时间,范围60-86400 默认配置600 * Return: * QL_NW_SUCCESS 成功。 * QL_NW_GENERIC_FAILURE 失败。 * *****************************************************************/ QL_NW_ERROR_CODE ql_set_black_cell_cfg_ex( int blackcellCfg, UINT32 delete_timer_size, int prevention_mode, UINT32 prevention_timer_size, int reject_judge_mode, int reject_judge_count, int black_loop_num, UINT32 black_loop_cycle); /***************************************************************** * Function: ql_get_black_cell_cfg_ex * * Description: * 查询异常基站策略 * * Parameters: * blackcellCfg [out] 整型。0/1 使能/关闭异常基站策略。默认配置 0 * delete_timer_size [out] 整型。以定时清除 拉黑小区时的定时器长度。范围:300~86400;单位:秒,默认配置1800 * prevention_mode [out] 整型。0/1 使能/关闭防呆机制。默认配置 1 * prevention_timer_size [out] 整型。无法注册时,按权重逐级释放黑名单小区的定时器长度 ,范围60-3600,单位:秒,默认配置300。(首次触发后减半) * reject_judge_mode [out] 整型。0/1 异常场景1-3的计数判断机制,默认配置0。 * reject_judge_count [out] 整型。异常场景1-3的计数门限,范围1-255 默认配置5(场景2门限对5向上取整) * black_loop_num [out] 整型。异常场景5频繁重选判定的门限次数,范围1-255 默认配置3 * black_loop_cycle [out] 整型。异常场景5频繁重选判定的门限时间,范围60-86400 默认配置600 * Return: * QL_NW_SUCCESS 成功。 * QL_NW_GENERIC_FAILURE 失败。 * *****************************************************************/ QL_NW_ERROR_CODE ql_get_black_cell_cfg_ex( int* blackcellCfg, UINT32* delete_timer_size, int* prevention_mode, UINT32* prevention_timer_size, int* reject_judge_mode, int* reject_judge_count, int* black_loop_num, UINT32* ); /***************************************************************** * Function: ql_set_black_event_weight_ex * * Description: * 配置异常基站策略相关场景权重 * * Parameters: * event_index [in] 整型。0-7 异常基站策略场景索引 * blackeventweight [in] 整型。0-255 场景异常事件对应黑名单权重 * * Return: * QL_NW_SUCCESS 成功。 * QL_NW_GENERIC_FAILURE 失败。 * *****************************************************************/ QL_NW_ERROR_CODE ql_set_black_event_weight_ex(int event_index,int blackeventweight); /***************************************************************** * Function: ql_get_black_event_weight_ex * * Description: * 查询异常基站策略相关场景权重 * * Parameters: * event_index [out] 整型。0-7 异常基站策略场景索引 * blackeventweight [out] 整型。0-255 场景异常事件对应黑名单权重 * * Return: * QL_NW_SUCCESS 成功。 * QL_NW_GENERIC_FAILURE 失败。 * *****************************************************************/ QL_NW_ERROR_CODE ql_get_black_event_weight_ex(int event_index,int* blackeventweight); /***************************************************************** * Function: ql_set_black_lwip_cfg_ex * * Description: * 使能及配置异常基站策略 数据不通检测场景 * * Parameters: * blacklwipcfg_vaild [in] 整型。0/1 使能/关闭异常基站策略 数据不通检测。默认配置 0 * blacklwip_fencenum [in] 整型。异常基站策略 数据不通判定的门限包数。范围:1~255;单位:包,默认配置100 * blacklwip_fencecycle [in] 整型。异常基站策略 数据不通判定的门限时间。范围:60-86400 默认配置600 * blacklwip_retrynum [in] 整型。判定数据不通且ping预置host失败时,尝试CFUN0/1的次数,默认配置3 * blackping_host [in] 整型。字符串类型。预置host,判定数据不通时ping预置host,检测终端网络状态 * blackcell_vaild [in] 整型。整型。是否基于检测结果拉黑小区(暂不支持) * Return: * QL_NW_SUCCESS 成功。 * QL_NW_GENERIC_FAILURE 失败。 * *****************************************************************/ QL_NW_ERROR_CODE ql_set_black_lwip_cfg_ex( int blacklwipcfg_vaild, int blacklwip_fencenum, int blacklwip_fencecycle, int blacklwip_retrynum, char* blackping_host, int blackcell_vaild); /***************************************************************** * Function: ql_get_black_lwip_cfg_ex * * Description: * 查询异常基站策略-数据不通检测场景配置 * * Parameters: * blacklwipcfg_vaild [out] 整型。0/1 使能/关闭异常基站策略 数据不通检测。默认配置 0 * blacklwip_fencenum [out] 整型。异常基站策略 数据不通判定的门限包数。范围:1~255;单位:包,默认配置100 * blacklwip_fencecycle [out] 整型。异常基站策略 数据不通判定的门限时间。范围:60-86400 默认配置600 * blacklwip_retrynum [out] 整型。判定数据不通且ping预置host失败时,尝试CFUN0/1的次数,默认配置3 * blackping_host [out] 整型。字符串类型。预置host,判定数据不通时ping预置host,检测终端网络状态 * blackcell_vaild [out] 整型。整型。是否基于检测结果拉黑小区(暂不支持) * Return: * QL_NW_SUCCESS 成功。 * QL_NW_GENERIC_FAILURE 失败。 * *****************************************************************/ QL_NW_ERROR_CODE ql_get_black_lwip_cfg_ex( int* blacklwipcfg_vaild, int* blacklwip_fencenum, int* blacklwip_fencecycle, int* blacklwip_retrynum, char* blackping_host, int* blackcell_vaild); /***************************************************************** * Function: ql_nw_auto_apn_enable * * Description: * 使能auto apn功能 * * Parameters: * enable [in] 整型。0/1 关闭/开启。默认配置 1 * Return: * QL_NW_SUCCESS 成功。 * 其他值 失败。 * *****************************************************************/ QL_NW_ERROR_CODE ql_nw_auto_apn_enable(BOOL enable); /***************************************************************** * Function: ql_nw_auto_apn_enable * * Description: * 查询auto apn是否使能 * Return: * 0 关闭。 * 1 开启。 * *****************************************************************/ int ql_nw_auto_apn_is_enable(void); #ifdef __cplusplus } #endif #endif