tkl_cellular_base.h

浏览该文件的文档.

 
#ifndef __TKL_CELLULAR_BASE_H__
#define __TKL_CELLULAR_BASE_H__
#include <stdint.h>
#include "tuya_cloud_types.h"
#include "tkl_uart.h"
#include "tkl_cellular_mds.h"
#ifdef __cplusplus
extern "C" {
#endif
 
 
/* 蜂窝设备基本的IOCTL命令 */
 
typedef INT_T CELL_IOCTRL_CMD;
 
// 设置类命令起始值
#define CELL_IOCTL_CMD_SET_START                           0
 
//打开AP LOG输出
#define CELL_IOCTL_SET_TRACE_ON                            1
//关闭AP LOG输出
#define CELL_IOCTL_SET_TRACE_OFF                           2
//电源键关机功能使能
#define CELL_IOCTL_SET_POWEKEY_ENABLE_POWEROFF            3
//电源键关机功能禁止
#define CELL_IOCTL_SET_POWEKEY_DISABLE_POWEROFF           4
//关闭UART的AT命令服务
#define CELL_IOCTL_SET_ATUART_OFF                          5
//打开UART的AT命令服务
#define CELL_IOCTL_SET_ATUART_ON                          6
//获取RSSI dBm值
#define CELL_IOCTL_GET_RSSIDBM                            7
 
//获取当前蜂窝设备所在的网络类型
#define CELL_IOCTL_GET_NET_TYPE                           8
 
/*
获取当前蜂窝设备的参考信号质量，参考AT+CSQ
<rssi>:
    0 113 dBm or less
    1 111 dBm
    2. . . 30 109. . . 53 dBm
    31 51 dBm or greater
    99 not known or not detectable
*/
#define CELL_IOCTL_GET_RSSI                               9
 
// 设置短信内容格式
#define CELL_IOCTL_SET_SMS_CHAR                           10
 
// 设置蜂窝拨号IP类型(IPV4,IPV6,IPV4V6)
#define CELL_IOCTL_SET_PDP_TYPE                           11
 
// 串口自检，一般用于涂鸦产测方案
#define CELL_IOCTL_SET_UART_SELFTEST             0x100
// TF卡自检，一般用于涂鸦产测方案
#define CELL_IOCTL_SET_TFCARD_SELFTEST           0x101
// ADC自检，一般用于涂鸦产测方案
#define CELL_IOCTL_SET_ADC_SELFTEST              0x102
// 麦克风喇叭自检，一般用于涂鸦产测方案
#define CELL_IOCTL_SET_MIC_SELFTEST              0x103
 
// 获取信息类命令起始值
#define CELL_IOCTL_CMD_GET_START                 0x400
 
// 获取系统的Epoch 时间，单位秒
#define CELL_IOCTL_GET_EPOCH_TIME                0x401
// 获取本次系统上电后的累计时间，单位ms
#define CELL_IOCTL_GET_UP_TIME                   0x402
// 获取本次系统上电后的累计时间,单位us
#define CELL_IOCTL_GET_UP_TIME_US                0x403
 
// 获取底层蜂窝数据上下行统计
#define CELL_IOCTL_GET_DATA_STATICS              0x404
 
// USB设备控制
 
#define TUYA_CELL_USB_DEV_MODE_E    INT_T
 
enum {
    USB_DEV_MODE_CHARGE_ONLY = 0,
    USB_DEV_MODE_ROM_SERIAL = 1,
    USB_DEV_MODE_8SERIALS =2,
    USB_DEV_MODE_RNDIS= 3,
    USB_DEV_MODE_ECM = 5,
};
typedef struct{
    BOOL_T                      get_contrl;     //TRUE get，false set
    BOOL_T                      enable;         //TRUE enable,false disable
    TUYA_CELL_USB_DEV_MODE_E    usb_mode;
}TUYA_CELL_USB_CTRL;
 
#define CELL_IOCTL_USB_CTRL                      0x405
 
#define CELL_IOCTL_SET_REGISTION_HOOK           0x406   //设置一个蜂窝网络注册状态的回调函数到底层
 
#define CELL_IOCTL_GET_LOCAL_TIME               0x407   //根据基站同步的时间，获取蜂窝的设备的本地时间
 
 
 
#define CELL_IOCTL_INIT_VIRTUAL_AT              0X408   //启动虚拟AT
 
#define CELL_IOCTL_SEND_VIRTUAL_AT_CMD          0x409   //发送虚拟AT命令
 
 
#define CELL_IOCTL_SET_GENERAL_HOOK             0X410   //设置到蜂窝设备中，通用的回调函数
 
#define CELL_IOCTL_GET_TIMEZONE                 0x411   //根据基站同步的时间，获取时区信息
 
#define CELL_IOCTL_SET_RRC_RELEASE_TIME         0x412   //设置RRC connect切换到idle的延迟时间
 
#define CELL_IOCTL_GET_RRC_RELEASE_TIME         0x413   //获取RRC connect切换到idle的延迟时间
 
#define CELL_IOCTL_GET_SN                       0x414   //获取蜂窝SN号
 
#define CELL_IOCTL_SET_SN                       0x415   //设置蜂窝SN号
 
#define CELL_IOCTL_GET_SYSFWKEY                 0x416   //获取基础固件的FW key
 
#define CELL_IOCTL_MODULE_NAME                  0x417   //获取模组型号
 
#define CELL_IOCTL_CMD_USR_START                0x1000
 
 
typedef enum
{
    TKL_NO_SIM,     /*< 无SIM卡 */
    TKL_SIM_READY,  /*< SIM已识别 */
    TKL_SIM_INIT,   /*< SIM卡初始化中>*/
    TKL_SIM_WAIT_PIN,
    TKL_SIM_WAIT_PUK,
} TKL_SIM_STATE_E;
 
typedef enum{
    TUYA_TSIM_TYPE, /* 物理卡 */
    TUYA_VSIM_TYPE, /* 虚拟卡 */
}TUYA_SIM_TYPE_E;
 
typedef enum {
    DOUBLE_SIM_DOUBLE_CHANNEL = 1,
    DOUBLE_SIM_SINGLE_CHANNEL = 2,
    SINGLE_SIM_SINGLE_CHANNEL = 4,
}TKL_CELLULAR_ABILITY_E;
 
typedef enum
{
    TUYA_CELL_NET_TYPE_UNKNOWN = -1,
    TUYA_CELL_NET_TYPE_GSM = 1,
    TUYA_CELL_NET_TYPE_LTE,
    TUYA_CELL_NET_TYPE_3G,
    TUYA_CELL_NET_TYPE_CATM, //CATM1
    TUYA_CELL_NET_TYPE_NB,
}TUYA_CELLULAR_RAT_E;
 
#define NEIGHBOUR_NUM   4
typedef struct {
    UINT16_T lac;           //LAC
    INT16_T  rx_pwr;
    UINT_T   cellid;        //20bits(eNodeID)+8bits(Cellid)
}TKL_CELL_INFO_T;
 
typedef struct
{
    UCHAR_T mcc[3];
    UCHAR_T mnc[3];
    TKL_CELL_INFO_T main;
    TKL_CELL_INFO_T neighbour[NEIGHBOUR_NUM];
}TKL_LBS_INFO_T;
 
typedef struct {
   INT_T fd;
   CHAR_T name[32+1];
   TUYA_UART_BASE_CFG_T cfg;
   UINT8_T              sim_id;
   TUYA_SIM_TYPE_E      sim_type;
}TKL_CELL_INIT_PARAM_T;
 
typedef struct{
    INT_T cid;
    UINT32_T rx_count;
    UINT32_T tx_count;
}TKL_CELL_DATA_STATISTICS;
 
 
typedef  INT_T CELL_GENERAL_MSGID;
 
#define CELL_GENERAL_MSGID_RTC_SYNC     1
#define CELL_GENERAL_MSGID_RSSI_UPDATE  2
 
typedef struct{
    CELL_GENERAL_MSGID id;
    VOID *pdata;
    INT_T data_len;
}TKL_CELL_GENERAL_INFO_T;
 
typedef VOID (*TKL_GENERAL_CALLBACK)(TKL_CELL_GENERAL_INFO_T *param);
 
 
 
typedef VOID (*TKL_VIRTAT_RESP)(CHAR_T *resp,INT_T len);
 
typedef VOID (*TKL_SIM_NOTIFY)(TKL_SIM_STATE_E status);
 
 
OPERATE_RET tkl_cellular_base_init(TKL_CELL_INIT_PARAM_T *param);
 
 
typedef VOID (*TKL_REGISTION_NOTIFY)(UINT8_T sim_id,TUYA_CELLULAR_MDS_STATUS_E st);
 
 
OPERATE_RET tkl_cellular_base_get_ability(TKL_CELLULAR_ABILITY_E *ability);
 
OPERATE_RET tkl_cellular_base_switch_sim(UINT8_T sim_id);
 
OPERATE_RET tkl_cellular_base_register_sim_state_notify(UINT8_T simd_id,TKL_SIM_NOTIFY fun);
 
OPERATE_RET tkl_cellular_base_enable_sim_hotplug(UINT8_T sim_id, BOOL_T enable);
 
OPERATE_RET tkl_cellular_base_sim_get_status(UINT8_T sim_id, UCHAR_T *state);
 
OPERATE_RET tkl_cellular_base_get_cfun_mode(UINT8_T simd_id,PINT_T cfun);
 
OPERATE_RET tkl_cellular_base_set_cfun_mode(UINT8_T simd_id,INT_T cfun);
 
OPERATE_RET tkl_cellular_base_get_imsi(UINT8_T sim_id,CHAR_T imsi[15 + 1]);
 
OPERATE_RET tkl_cellular_base_get_iccid (UINT8_T sim_id,CHAR_T iccid[20 + 1]);
OPERATE_RET tkl_cellular_base_get_imei (UINT8_T sim_id,CHAR_T imei[15 + 1]);
 
OPERATE_RET tkl_cellular_base_set_imei (UINT8_T sim_id,CHAR_T imei[15 + 1]);
 
OPERATE_RET tkl_cellular_base_get_rsrp(UINT8_T sim_id,INT_T *rsrp);
 
OPERATE_RET tkl_cellular_base_get_sinr(UINT8_T sim_id,INT_T *sinr,INT_T *bit_error);
 
OPERATE_RET tkl_cellular_base_get_lbs(UINT8_T sim_id,TKL_LBS_INFO_T *lbs,BOOL_T neighbour,INT_T timeout);
 
BOOL_T tkl_cellular_base_rf_calibrated(VOID_T);
 
 
OPERATE_RET tkl_cellular_base_enable_sim_detect(UINT8_T simid, BOOL_T enable);
 
INT8_T tkl_cellular_base_get_default_simid(VOID);
 
 
OPERATE_RET tkl_cellular_base_ioctl(INT_T cmd,VOID* argv);
 
#ifdef __cplusplus
}
#endif
 
#endif