OpenHarmony轻量化系统ANY技术实践

X丶昕雪 2023-03-28 原文

想了解更多关于开源的内容，请访问：

51CTO 开源基础软件社区

https://ost.51cto.com

概述

ANY功能是一种华为私有的短数据通信功能，允许处于同一信道的2个Wi-Fi设备进行直接的点对点无连接通信。

ANY可以应用于智能开关控制灯泡、传感器数据采集、遥控器控制家用电器等无线控制场景。

ANY功能特点

每个设备可以选择一个接口（例如：wlan0或ap0）用于ANY报文的收发。
ANY报文采用接口当前所在信道进行收发，和通信对端需要处于同一信道。
单个ANY报文最多可以支持250byte的用户层数据。
单个ANY设备最多支持同时和16个ANY对端设备进行通信，其中最多允许和6个对端进行加密通信。
ANY设备可以收发ANY单播报文和ANY广播报文，不支持组播报文。
ANY设备可以扫描发现附近的其他ANY设备。

环境

OpenHarmony-3.1
润和hispark_pegasus Hi3861开发板
DevEco Device Tool
串口调试助手

总体流程

总体流程为：

ANY功能初始化。
注册收发回调函数。
创建收发线程T1处理收发回调（将收发回调函数用此线程完成，避免长期占用主线程）。
进行ANY设备扫描。
调用hi_wifi_any_deinit，去初始化ANY。

1、初始化

首先设备需要完成STA或者SoftAP的初始化；再以此作为ANY收发通信的接口，初始化ANY功能。初始化ANY功能之后，ANY会采用其所在的信道进行通信，并采用MAC地址作为发送接收的地址。

对于SoftAP模式下,所在的信道就是创建的时候指定的信道。
对于STA模式，若已连接到了SoftAP，所在信道为该SoftAP指定的信道。
对于STA模式，若未连接，可以采用设置信道的API函数hi_wifi_set_channel给STA指定一个信道。

对于ANY功能初始化，步骤为：启动STA或SoftAP调用hi_wifi_any_init，选择STA接口（wlan0）或AP接口（ap0）作为ANY通信接口。

调用hi_wifi_any_deinit，去初始化ANY（关闭WiFi会自动关闭ANY）。
对于初始化函数，返回值为0即执行成功，1则为执行失败。

/* STA接口的信息 */
    hi_char ifname[16 + 1] = {0};
    hi_s32 len = sizeof(ifname);
    /*WIFI_STA功能启动*/
    hi_wifi_sta_start(ifname, &len);
    /* 初始化并注册发送完成和接收回调函数 */
    hi_wifi_any_init(ifname);

/* AP接口的信息 */
    hi_wifi_softap_config hapd_conf = {
        "my_wifi", "", 1, 0, HI_WIFI_SECURITY_OPEN, HI_WIFI_PARIWISE_UNKNOWN};
    hi_char ifname[16 + 1] = {0}; /* 创建的SoftAP接口名 */
    hi_s32 len = sizeof(ifname);                    /* SoftAP接口名长度 */
    struct netif *netif_p = HI_NULL;
    ip4_addr_t st_gw;
    ip4_addr_t st_ipaddr;

    ip4_addr_t st_netmask;
    /* 这里用户配置自己的网关、IP、掩码 */
    IP4_ADDR(&st_gw, 0, 0, 0, 0);
    IP4_ADDR(&st_ipaddr, 0, 0, 0, 0);
    IP4_ADDR(&st_netmask, 0, 0, 0, 0);
    hi_u8 ap_msg[] = "msg from my_wifi";
    /* 配置SoftAP网络参数,beacon周期修改为200ms */
    hi_wifi_softap_set_beacon_period(200);
    /* 启动SoftAP接口 */
    hi_wifi_softap_start(&hapd_conf, ifname, &len);
    /* 配置DHCP服务器 */
    netif_p = netif_find(ifname);
    if (netif_p == HI_NULL)
    {
        (hi_void) hi_wifi_softap_stop();
        return HISI_FAIL;
    }
    if (netifapi_netif_set_addr(netif_p, &st_ipaddr, &st_netmask, &st_gw) != HISI_OK)
    {
        (hi_void) hi_wifi_softap_stop();
        return HISI_FAIL;
    }
    if (netifapi_dhcps_start(netif_p, NULL, 0) != HISI_OK)
    {
        (hi_void) hi_wifi_softap_stop();
        return HISI_FAIL;
    }
    /* 初始化并注册发送完成和接收回调函数 */
    hi_wifi_any_init(ifname);

2、注册ANY收发回调函数

ANY设备能够与同信道的其他ANY设备进行通信。其中单个ANY报文最多支持250Byte的用户数据。支持加密通信或不加密通信，加密通信需要要求双方提前配置同样的16Byte长度密钥。

在通信前需要确保：ANY功能初始化，以及通信双方处于同一个信道。

接受和发送回调函数同样是运行于驱动线程，建议新建一个线程T1(第三步骤)处理收发报文,所以回调函数内的任务只是将msg数据通过消息队列传到收发线程T1。

实现接收回调函数&& 发送完成回调函数，hi_wifi_any_recv_cb && hi_wifi_any_send_complete_cb。
回调函数内调用write_any_msg函数,msg数据将会在收发线程T1里面处理。
调用hi_wifi_any_set_callback向驱动注册回调函数，其中发送回调函数反馈发送结果（成功为1），若不需要该函数，注册时可以设置为HI_NULL。

ANY只在当前信道通信，想要与其他信道设备通信，需要下调用切信道API
一个ANY设备支持和16个对端通信，最多6个对端加密通信，并且需要双方配置相同密钥。
接收回调函数的数据内存由驱动自行管理。

hi_wifi_any_set_callback(wifi_any_send_cb, wifi_any_recv_cb);

/*发送完成回调函数*/
void wifi_any_send_cb(unsigned char *mac, unsigned char status, unsigned char seqnum)
{
    any_msg_stru msg = {0};
    memcpy_s(msg.mac, sizeof(msg.mac), mac, sizeof(msg.mac));
    msg.type = ANY_SEND_COMPLETE_CALLBACK;
    msg.status = status;
    msg.seqnum = seqnum;

    //调用write_any_msg函数
    write_any_msg(&msg);
}
/* 接收回调函数*/
void wifi_any_recv_cb(unsigned char *mac, unsigned char *data, unsigned short len, unsigned char seqnum)
{
    any_msg_stru msg = {0};
    msg.type = ANY_RECV_CALLBACK;
    memcpy_s(msg.mac, sizeof(msg.mac), mac, sizeof(msg.mac));
    msg.len = len;
    msg.seqnum = seqnum;
    msg.data = (unsigned char *)hi_malloc(HI_MOD_ID_WIFI_DRV, len);
    if (msg.data == NULL)
        return;
    if (memcpy_s(msg.data, len, data, len) != EOK)
    {
        hi_free(HI_MOD_ID_WIFI_DRV, msg.data);
        return;
    }
    //调用write_any_msg函数
    if (write_any_msg(&msg) != HI_ERR_SUCCESS)
        hi_free(HI_MOD_ID_WIFI_DRV, msg.data);
}
/* 向收发线程T1发送msg */
hi_u32 write_any_msg(any_msg_stru *msg)
{
    hi_u32 ret;
    if ((g_any_msg_queue == 0) || (g_task_running == 0))
    {
        printf("msg queue or task is not working!\r\n");
        return HI_ERR_FAILURE;
    }
    //将msg消息发送到消息队列
    ret = hi_msg_queue_send(g_any_msg_queue, msg, 0, sizeof(any_msg_stru));
    return ret;
}

3、处理子线程T1

由于接收回调、发送回调、扫描回调都不易过多占用主线程的运行，所以我们需要创建一个新的线程用于实现接收回调、发送回调、扫描回调的活。
创建线程&&线程实现：

/*创建处理子线程T1*/
hi_u32 any_start_callback_task(hi_void)
{
    hi_u32 ret;
    if (g_any_msg_task_id != 0)
    {
        return HI_ERR_FAILURE;
    }
    hi_task_attr task_init = {0};
    task_init.task_prio = ANY_TASK_PRIORITY;
    task_init.stack_size = ANY_TASK_STACK_SIZE;
    task_init.task_name = ANY_TASK_NAME;
    g_task_running = 1;
    ret = hi_task_create(&g_any_msg_task_id, &task_init, handle_any_msg, HI_NULL);
    if (ret != HI_ERR_SUCCESS)
    {
        printf("create any msg task ret:%d\r\n", ret);
        return ret;
    }

    printf("create any msg task success!\r\n");
    return ret;
}
hi_u32 any_destory_callback_task(hi_void)
{
    printf("destory any callback task\r\n");
    g_task_running = 0;
    return HI_ERR_FAILURE;
}
/*处理子线程T1*/
static hi_void *handle_any_msg(hi_void *data)
{
    (hi_void) data;
    int ret;
    any_msg_stru msg = {0};
    if (g_any_msg_queue == 0)
    {
        ret = hi_msg_queue_create(&g_any_msg_queue, ANY_MSG_QUEUE_MAX_LEN, sizeof(any_msg_stru));
        if (ret != HI_ERR_SUCCESS)
        {
            printf("create any message queue ret:%d\r\n", ret);
            g_any_msg_task_id = 0;
            return HI_NULL;
        }
    }
    while (1)
    {
        hi_u32 msg_size = sizeof(any_msg_stru);
        ret = hi_msg_queue_wait(g_any_msg_queue, (hi_pvoid)&msg, ANY_TASK_SLEEP_TIME,&msg_size);
        if (ret == HI_ERR_SUCCESS)
        {

            switch (msg.type)
            {
            case ANY_SCAN_CALLBACK:
                /*扫描回调*/
                wifi_any_scan_success_proc(msg.mac, msg.channel);
                break;
            case ANY_RECV_CALLBACK:
                /*接收回调*/
                wifi_any_recv_proc(msg.mac, msg.data, msg.len, msg.seqnum);
                hi_free(HI_MOD_ID_WIFI_DRV, msg.data);
                break;
            case ANY_SEND_COMPLETE_CALLBACK:
                /*发送完成回调*/
                wifi_any_send_complete_proc(msg.mac, msg.status, msg.seqnum);
                break;
            default:
                break;
            }
        }
        else
        {
            if (g_task_running == 0)
            {
                break;
            }
        }
    }
    g_any_msg_task_id = 0;
    hi_u8 trycount = 3;
    while (trycount > 0)
    {
        if (hi_msg_queue_delete(g_any_msg_queue) == HI_ERR_SUCCESS)
        {
            g_any_msg_queue = 0;
            return HI_NULL;
        }
        trycount--;
    }
    printf("delete any msg queue failed!\r\n");
    return HI_NULL;
}

真正的接收回调、发送回调、扫描回调(可参考文章末尾的源码)：

/* 接收回调 */
void wifi_any_recv_proc(const unsigned char *mac, unsigned char *data, unsigned short len,unsigned char seqnum)
{}
/* 发送完成回调 */
void wifi_any_send_complete_proc(const unsigned char *mac, unsigned char status, unsigned char seqnum)
{}
/* 扫描回调 */
void wifi_any_scan_success_proc(const unsigned char *mac, unsigned char channel)
{}

4、ANY设备扫描

完成ANY初始化后，STA端可以进行设备的扫描：

首先实现hi_wifi_any_scan_result_cb扫描回调函数，用于处理扫描完成之后的结果。对于该回调函数，驱动传入的输入参数为发现的ANY设备的指针数组和数组元素个数，每个元素指向一个发现的ANY设备相关信息。
调用hi_wifi_any_discover_peer，向驱动注册回调函数，并**启动一次ANY扫描。

扫描过程中，发现的设备是SoftAP，则设备信息会包括SSID信息，STA则为空字符串。
回调函数运行于驱动线程，不能阻塞或长时间等待，使用第三步骤的处理子线程T1进行处理。
单次扫描最多通过回调函数返回32个对端设备信息，回调函数传入的数组内存由驱动自行管理，在回调函数中不应释放。

//g_find_any_device初始值为0,完成扫描回调函数退出whil循环
while (!g_find_any_device)
    {
        /* wifi_any_scan_result_cb : 扫描回调函数 */
        hi_wifi_any_discover_peer(wifi_any_scan_result_cb);
        hi_sleep(2000);    //延时2s
    }
/*扫描回调函数*/
void wifi_any_scan_result_cb(hi_wifi_any_device *devices[], unsigned char num)
{
    unsigned char target_ssid[] = "my_wifi";
    any_msg_stru msg = {0};
    unsigned char loop;
    if ((devices == NULL) || (num == 0))
    {
        printf("Total scanned ANY dev num: 0\r\n");
        return;
    }

    for (loop = 0; (loop < num) && (devices[loop] != NULL); loop++)
    {
        if (strcmp((char *)devices[loop]->ssid, (char *)target_ssid) != 0)
        {
            continue;
        }
        g_find_any_device = 1;
        msg.type = ANY_SCAN_CALLBACK;
        msg.channel = devices[loop]->channel;
        memcpy_s(msg.mac, WIFI_ANY_MAC_LEN, devices[loop]->bssid, WIFI_ANY_MAC_LEN);
        if (write_any_msg(&msg) != HI_ERR_SUCCESS)
        {
            printf("write scan result failed\r\n");
        }
        break;
    }
    printf("Total scanned ANY dev num: %d\r\n", num);
    return;
}

5、加密

ANY设备支持加密通信，要求通信双方采用同样的16byte长度密钥进行加解密，一个密钥对应一个对端MAC地址，即采用该密钥加解密来自该MAC地址的ANY报文。用户应根据产品应用场景确定ANY设备之间如何产生和共享同样的密钥。

设备1和设备2的配对协商消息均是采用ANY报文。协商请求消息中携带了随机数R1，协商应答消息携带了随机数R2和Cookie值。参与协商的2个设备需要采用同样的预共享密钥PSK，设备获取到随机数R1和R2之后结合PSK生成一个临时密钥用于加密密钥协商消息。设备1采用该临时密钥加密密钥请求消息，密钥请求消息中包括来自设备2的Cookie和随机生成的密钥因子K1。设备2采用临时密钥解密消息之后验证Cookie是否正确，验证通过则回复密钥应答消息。密钥应答消息中包含随机生成密钥因子K2，并采用临时密钥加密。双方完成上述交互之后，通过随机数R1和R2、密钥因子K1和K2采用同样的算法生成用于通信的最终的密钥。

6、发送函数

向指定MAC地址的设备发送ANY数据。

int hi_wifi_any_send(const unsigned char *mac, unsigned char mac_len, unsigned char *data,unsigned short data_len, unsigned char seq);

mac：6字节长度目的MAC地址, 可为单播或者广播地址, 不支持组播地址。
mac_len：MAC地址长度, 需为6字节。
data：待发送数据的缓存地址。
len：待发送的数据长度, 最大为250字节。
seqnum：待发送的ANY帧的序列号,范围0-255。

效果

此样例连接后互相发送信息。

这里可以看到AP端的mac地址为0x8e，STA端的mac地址为0x32。

STA端扫描发现ANY设备：

互相发送信息：

文章相关附件可以点击下面的原文链接前往下载：

https://ost.51cto.com/resource/2570。