WiFi配网HAL

原型

typedef void *p_HAL_Aes128_t;

int HAL_Aes128_Cbc_Decrypt(
            _IN_ p_HAL_Aes128_t aes,
            _IN_ const void *src,
            _IN_ size_t blockNum,
            _OU_ void *dst);
            

接口说明

参数说明

返回值说明

HAL_Aes128_Cbc_Encrypt

原型

int HAL_Aes128_Cbc_Encrypt(
            _IN_ p_HAL_Aes128_t aes,
            _IN_ const void *src,
            _IN_ size_t blockNum,
            _OU_ void *dst);
            

接口说明

以AES-CBC-128的加解密模式，用HAL_Aes128_Init()被调用时传入的密钥，加密从src位置起长度为blockNum块数的明文，并把密文结果存放到dst起始的内存缓冲区中。

参数说明

返回值说明

HAL_Aes128_Cfb_Decrypt

原型

int HAL_Aes128_Cfb_Decrypt(
            _IN_ p_HAL_Aes128_t aes,
            _IN_ const void *src,
            _IN_ size_t length,
            _OU_ void *dst);
            

接口说明

CFB模式的AES128解密接口函数，使用此接口前必须先调用HAL_Aes128_Init()建立AES上下文数据结构体。

参数length为分组数量（AES128一个分组的长度为128bits，也就是16bytes）， 而非字节数。

用户在实现此函数时无需考虑padding问题，因为SDK在调用此接口前已完成padding处理。

参数说明

返回值说明

HAL_Aes128_Cfb_Encrypt

原型

int HAL_Aes128_Cfb_Encrypt(
            _IN_ p_HAL_Aes128_t aes,
            _IN_ const void *src,
            _IN_ size_t length,
            _OU_ void *dst);
            

接口说明

CFB模式的AES128加密接口函数，使用此接口前必须先调用HAL_Aes128_Init()建立AES上下文数据结构体。

参数length为分组数量（AES128一个分组的长度为128bits，也就是16bytes），而非字节数

用户在实现此函数时无需考虑padding问题，因为SDK在调用此接口前已完成padding处理。

参数说明

返回值说明

HAL_Aes128_Destroy

原型

int HAL_Aes128_Destroy(_IN_ p_HAL_Aes128_t aes);
            

接口说明

销毁AES加解密算法的上下文结构体，释放内存资源。

参数说明

返回值说明

HAL_Aes128_Init

原型

p_HAL_Aes128_t HAL_Aes128_Init(
            _IN_ const uint8_t *key,
            _IN_ const uint8_t *iv,
            _IN_ AES_DIR_t dir);
            

接口说明

初始化AES加解密算法的上下文结构体，并根据dir参数完成AES算法的初始化。用户可自定义结构体类型，但结构体中应包含key，iv等上下文数据。

参数说明

typedef enum {
    HAL_AES_ENCRYPTION = 0,     // 用于加密
    HAL_AES_DECRYPTION = 1,     // 用于解密
} AES_DIR_t;
            

返回值说明

指向所初始化的AES加解密上下文结构体的指针，p_HAL_Aes128_t的类型定义如下所示：

typedef void *p_HAL_Aes128_t;
            

HAL_Awss_Close_Monitor

原型

void HAL_Awss_Close_Monitor(void);
            

接口说明

设置Wi-Fi网卡离开监听（Monitor）模式，并开始以站点（Station）模式工作，并不再以Sniffer抓包。

参数说明

void

返回值说明

void

HAL_Awss_Connect_Ap

原型

int HAL_Awss_Connect_Ap(
            _IN_ uint32_t connection_timeout_ms,
            _IN_ char ssid[HAL_MAX_SSID_LEN],
            _IN_ char passwd[HAL_MAX_PASSWD_LEN],
            _IN_OPT_ enum AWSS_AUTH_TYPE auth,
            _IN_OPT_ enum AWSS_ENC_TYPE encry,
            _IN_OPT_ uint8_t bssid[ETH_ALEN],
            _IN_OPT_ uint8_t channel);

            

接口说明

要求Wi-Fi网卡连接指定热点（Access Point）的函数，bssid指定特定AP，另外bssid也可能为空或无效值（全0或全0xff）。

参数说明

返回值说明

HAL_Awss_Get_Channelscan_Interval_Ms

原型

int HAL_Awss_Get_Channelscan_Interval_Ms(void);
            

接口说明

获取在每个信道(channel)上扫描的时间长度，单位是毫秒，建议200ms~400ms，默认250ms。

参数说明

void

返回值说明

时间长度, 单位是毫秒

HAL_Awss_Get_Connect_Default_Ssid_Timeout_Interval_Ms

原型

int HAL_Awss_Get_Connect_Default_Ssid_Timeout_Interval_Ms(void);
            

接口说明

获取配网服务(AWSS)超时时长到达之后，去连接默认SSID时的超时时长，单位是毫秒（该接口已经废弃，不再使用，不用对接）

参数说明

void

返回值说明

时时长，单位是毫秒。

HAL_Awss_Get_Conn_Encrypt_Type

原型

int HAL_Awss_Get_Conn_Encrypt_Type(void);
            

接口说明

获取零配，热点配网和路由器配网的安全等级。

参数说明

void

返回值说明

HAL_Awss_Get_Encrypt_Type

原型

int HAL_Awss_Get_Encrypt_Type(void);
            

接口说明

获取smartconfig服务的安全等级

参数说明

void

返回值说明

HAL_Awss_Get_Timeout_Interval_Ms

原型

int HAL_Awss_Get_Timeout_Interval_Ms(void);
            

接口说明

获取配网服务(AWSS)的超时时间长度，单位是毫秒，建议60s或60000ms。

参数说明

void

返回值说明

超时时长，单位是毫秒

HAL_Awss_Open_Monitor

原型

void HAL_Awss_Open_Monitor(_IN_ awss_recv_80211_frame_cb_t cb);
            

接口说明

设置Wi-Fi网卡工作在监听（Monitor）模式，并在收到802.11帧的时候调用被传入的回调函数。

参数说明

/**
 * @brief   802.11帧的处理函数, 可以将802.11 Frame传递给这个函数
 *
 * @param[in] buf @n 80211 frame buffer, or pointer to struct ht40_ctrl
 * @param[in] length @n 80211 frame buffer length
 * @param[in] link_type @n AWSS_LINK_TYPE_NONE for most rtos HAL,
 *              and for linux HAL, do the following step to check
 *              which header type the driver supported.
 * @param[in] with_fcs @n 80211 frame buffer include fcs(4 byte) or not
 * @param[in] rssi @n rssi of packet, range of `[-127, -1]`
 */
typedef int (*awss_recv_80211_frame_cb_t)(char *buf, int length,
        enum AWSS_LINK_TYPE link_type, int with_fcs, signed char rssi);
            

返回值说明

void

HAL_Awss_Switch_Channel

原型

void HAL_Awss_Switch_Channel(
            _IN_ char primary_channel,
            _IN_OPT_ char secondary_channel,
            _IN_OPT_ uint8_t bssid[ETH_ALEN]);
            

接口说明

设置Wi-Fi网卡切换到指定的信道(channel)上

参数说明

返回值说明

void

HAL_RF433_Get_Rssi_Dbm

原型

int HAL_RF433_Get_Rssi_Dbm(void);
            

接口说明

获取RF433的接收信号强度RSSI（该API已经废弃，不再使用，不用对接）

参数说明

void

返回值说明

信号强度数值，单位是dBm。

HAL_Sys_Net_Is_Ready

原型

int HAL_Sys_Net_Is_Ready(void);
            

接口说明

检查系统网络是否可用（设备是否已经成功获得IP地址并且当前IP地址可用）

参数说明

void

返回值说明

HAL_Wifi_Enable_Mgmt_Frame_Filter

原型

int HAL_Wifi_Enable_Mgmt_Frame_Filter(
            _IN_ uint32_t filter_mask,
            _IN_OPT_ uint8_t vendor_oui[3],
            _IN_ awss_wifi_mgmt_frame_cb_t callback);
            

接口说明

在站点（Station）模式下使能或禁用对特定管理帧的过滤（只接受包含特定OUI的管理帧）

参数说明

返回值说明

HAL_Wifi_Get_Ap_Info

原型

int HAL_Wifi_Get_Ap_Info(
            _OU_ char ssid[HAL_MAX_SSID_LEN],
            _OU_ char passwd[HAL_MAX_PASSWD_LEN],
            _OU_ uint8_t bssid[ETH_ALEN]);
            

接口说明

获取所连接的热点（Access Point）的信息

参数说明

返回值说明

HAL_Wifi_Get_IP

原型

uint32_t HAL_Wifi_Get_IP(_OU_ char ip_str[HAL_IP_LEN], _IN_ const char *ifname);
            

接口说明

获取Wi-Fi网口的IP地址，点分十进制格式保存在字符串数组出参，二进制格式则作为返回值，并以网络字节序（大端）表达

参数说明

返回值说明

二进制形式的IP地址，以网络字节序（大端）组织

HAL_Wifi_Get_Mac

原型

char *HAL_Wifi_Get_Mac(_OU_ char mac_str[HAL_MAC_LEN]);
            

接口说明

获取Wi-Fi网口的MAC地址，格式应当是”XX:XX:XX:XX:XX:XX“

参数说明

返回值说明

指向缓冲区数组起始位置的字符指针

HAL_Wifi_Low_Power

原型

int HAL_Wifi_Low_Power(_IN_ int timeout_ms);
            

接口说明

使WiFi模组进入省电模式，并持续一段时间（该API未用，可以暂时不用对接）

参数说明

返回值说明

HAL_Wifi_Scan

原型

int HAL_Wifi_Scan(awss_wifi_scan_result_cb_t cb);
            

接口说明

启动一次WiFi的空中扫描，该API是一个阻塞操作，扫描没有完成不能结束，所有的AP列表收集完成后，一个一个通过回调函数告知AWSS，最好不要限制AP的数量，否则可能导致中文GBK编码的SSID热点配网失败

参数说明

返回值说明

HAL_Wifi_Send_80211_Raw_Frame

原型

int HAL_Wifi_Send_80211_Raw_Frame(_IN_ enum HAL_Awss_Frame_Type type,
                                  _IN_ uint8_t *buffer, _IN_ int len);

            

接口说明

在当前信道（channel）上以基本数据速率（1Mbps）发送裸的802.11帧（raw 802.11 frame）

参数说明

/* 80211帧类型定义 */
typedef enum HAL_Awss_Frame_Type {
    FRAME_ACTION,
    FRAME_BEACON,
    FRAME_PROBE_REQ,
    FRAME_PROBE_RESPONSE,
    FRAME_DATA
} HAL_Awss_Frame_Type_t;
            

返回值说明

HAL_Awss_Open_Ap

原型

int HAL_Awss_Open_Ap(const char *ssid, const char *passwd, int beacon_interval, int hide);
            

接口说明

开启设备热点（SoftAP模式）

参数说明

HAL_Awss_Close_Ap

原型

int HAL_Awss_Close_Ap(void);
            

接口说明

关闭设备热点

参数说明

void

返回值说明