[add] 添加 UART、UDP、TCP 端口

[add] 添加软件包 README.md

README.md

@@ -1,2 +1,59 @@
 # rt-link_hw
-The underlying communication port adaptation layer of the rt-link component. Used to adapt to different communication ports including but not limited to UART, SPI, UDP...
+## 简介
+
+rt-link_hw 软件包是 rt-link 组件的底层通信端口适配层。由不同端口类型的移植文件组成，用于适配不同类型的通信端口，目前支持的通信端口类型有：UART、TCP、UDP 等。
+
+## 目录结构
+| 名称 | 说明                                              |
+| ---- | ------------------------------------------------- |
+| uart | 用于 rt-link 组件适配 UART 端口连接，实现数据收发 |
+| tcp  | 用于 rt-link 组件适配 TCP 端口连接，实现数据收发  |
+| udp  | 用于 rt-link 组件适配 UDP 端口连接，实现数据收发  |
+
+## 依赖
+
+- rt-link 组件
+- UART 依赖 rtdevice框架
+- TCP、UDP 依赖 SAL 组件
+
+## 如何添加新的端口类型
+
+可以根据 [rt-link 组件文档](https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/programming-manual/rtlink/rtlink?id=底层链路对接接口介绍)，了解需要对接的 rt-link 接口，并参考现有的实现方式来完成对新的端口类型的移植对接。
+
+## 配置说明
+
+- 选择使用的端口类型，默认使用 UART
+
+	```
+    Select the underlying transport (use UART)  ---> 
+        (x) use UART
+        ( ) use UDP
+        ( ) use TCP
+	```
+
+- UART
+
+  ```
+  (uart2) the name of base actual device
+  ```
+  
+  选择使用 UART 需要配置使用的串口设备名称，此名称是串口设备注册到 rtdevice 框架的名称，需要按照实际使用的串口号更改。配置类型是 string，默认配置是 uart2。
+
+- UDP
+
+	```
+    (8080) local udp port  //配置本地 UDP 端口号
+    (8080) remote udp port //配置远端 UDP 端口号
+    (192.168.12.109) the other side IP address for rtlink	//配置对端 IP
+  ```
+  
+- TCP
+
+	```
+    (8080) local tcp port  //配置本地 TCP 端口号
+    (8080) remote tcp port //配置远端 TCP 端口号
+    (192.168.12.109) the other side IP address for rtlink	//配置对端 IP
+    [*]   config rtlink in server mode	//是否为 TCP-server，选中则是 TCP server
+  ```
+	
+	选择使用 TCP 需要注意设备是 TCP 的 server 端还是 client 端，选中`config rtlink in server mode` 选项代表此设备是 TCP server。

SConscript

@@ -0,0 +1,15 @@
+# RT-Thread building script for bridge
+
+import os
+from building import *
+
+cwd = GetCurrentDir()
+objs = []
+list = os.listdir(cwd)
+
+for d in list:
+    path = os.path.join(cwd, d)
+    if os.path.isfile(os.path.join(path, 'SConscript')):
+        objs = objs + SConscript(os.path.join(d, 'SConscript'))
+
+Return('objs')

tcp/SConscript

@@ -0,0 +1,12 @@
+from building import *
+
+cwd  = GetCurrentDir()
+src  = []
+CPPPATH = []
+
+if GetDepend('PKG_RT_LINK_USING_TCP'):
+    src += ['./rtlink_port_tcp.c']
+
+group = DefineGroup('rt-link-port', src, depend = ['RT_USING_RT_LINK'], CPPPATH = CPPPATH)
+
+Return('group')

tcp/rtlink_port_tcp.c

@@ -0,0 +1,235 @@
+/*
+ * Copyright (c) 2006-2021, RT-Thread Development Team
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Change Logs:
+ * Date           Author       Notes
+ * 2021-7-13     songchao   the first version
+ */
+
+#include <rtthread.h>
+#include <rtlink_port.h>
+#include <string.h>
+
+#if !defined(SAL_USING_POSIX)
+#error "Please enable SAL_USING_POSIX!"
+#else
+#include <sys/time.h>
+#include <sys/select.h>
+#endif
+#include <sys/socket.h> /* To use the BSD socket, you need to include the socket.h header file */
+#include "netdb.h"
+#define DBG_TAG              "rtlink_port"
+#define DBG_LVL              DBG_LOG
+#include <rtdbg.h>
+
+#define BUFSZ   4096
+static struct sockaddr_in remote_addr;
+static uint8_t socket_buffer[BUFSZ];
+static int32_t rtlink_socket = -1;
+static int32_t connect_socket = -1;
+static int32_t rtlink_tcp_delete_flag = 0;
+
+#ifdef RTLINK_IN_SERVER_MODE
+static struct sockaddr_in local_addr;
+#endif
+
+static void rtlink_socket_thread_entry(void *param)
+{
+    fd_set readset;
+    uint32_t bytes_received;
+    struct timeval timeout;
+    struct sockaddr_in;
+    uint32_t recv_count = 0;
+#ifdef RTLINK_IN_SERVER_MODE    
+    fd_set connectset;
+    socklen_t addr_len;
+    addr_len = sizeof(struct sockaddr);
+#endif    
+    timeout.tv_sec = 0;
+    timeout.tv_usec = 10000;
+    while(1)
+    {
+        if(rtlink_socket < 0)
+        {
+            rt_thread_delay(100);
+            if(rtlink_tcp_delete_flag == 1)
+            {
+                LOG_D("rtlink tcp thread exit\n");
+                return;
+            }
+        }
+        else
+        {
+#ifdef RTLINK_IN_SERVER_MODE
+            FD_ZERO(&connectset);
+            FD_SET(rtlink_socket, &connectset);
+            if (select(rtlink_socket + 1, &connectset, RT_NULL, RT_NULL, &timeout) == 0)
+            {
+                continue;
+            }
+            connect_socket = accept(rtlink_socket, (struct sockaddr *)&remote_addr, &addr_len);
+            if (connect_socket < 0)
+            {
+                LOG_E("accept connection failed! errno = %d", errno);
+                continue;
+            }
+            LOG_D("accept success\n");
+#else
+            if(connect_socket < 0)
+            {
+                if (connect(rtlink_socket, (struct sockaddr *)&remote_addr, sizeof(struct sockaddr)) == -1)
+                {
+                    LOG_D("Connect to IP %s port %d failed!",RTLINK_REMOTE_HOST_IP,RTLINK_REMOTE_TCP_PORT);
+                    rt_thread_delay(1000);
+                    continue;
+                }
+                else
+                {
+                    connect_socket = rtlink_socket;
+                    LOG_D("Connect to IP %s port %d success",RTLINK_REMOTE_HOST_IP,RTLINK_REMOTE_TCP_PORT);
+                }
+            }
+#endif
+            while(connect_socket >= 0)
+            {
+                FD_ZERO(&readset);
+                FD_SET(connect_socket, &readset);
+                if (select(connect_socket + 1, &readset, RT_NULL, RT_NULL, &timeout) == 0)
+                {
+                    continue;
+                }
+                else
+                {
+                    if(connect_socket >= 0)
+                    {
+                        bytes_received = recv(connect_socket, socket_buffer, BUFSZ - 1, 0);
+                        if (bytes_received < 0)
+                        {
+                            LOG_E("Received error, close the socket.");
+                            closesocket(connect_socket);
+                            connect_socket = -1;
+                        }
+                        else if (bytes_received == 0)
+                        {
+                            LOG_W("Received warning, recv function return 0.");
+                        }
+                        else
+                        {
+                            recv_count++;
+                            rt_link_hw_write_cb(&socket_buffer, bytes_received);
+                        }
+                    }
+                }
+            }
+        }
+    }
+}
+
+rt_size_t rt_link_port_send(void *data, rt_size_t length)
+{
+    rt_size_t size = 0;
+    ssize_t ret;
+    if(connect_socket >= 0)
+    {
+        ret = send(connect_socket, data, length, 0);
+        if (ret < 0)
+        {
+            LOG_E("send error, close the socket.");
+            closesocket(connect_socket);
+            connect_socket = -1;
+        }
+        else if (ret == 0)
+        {
+            LOG_W("Send warning, send function return 0.");
+        }
+    }
+
+    return size;
+}
+
+rt_err_t rt_link_port_init(void)
+{
+    if ((rtlink_socket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP)) == -1)
+    {
+        LOG_E("Create socket error");
+        goto __exit;
+    }
+#ifdef RTLINK_IN_SERVER_MODE
+    local_addr.sin_family = AF_INET;
+    local_addr.sin_port = htons(RTLINK_LOCAL_TCP_PORT);
+    local_addr.sin_addr.s_addr = INADDR_ANY;
+    rt_memset(&(local_addr.sin_zero), 0, sizeof(local_addr.sin_zero));
+
+    if (bind(rtlink_socket, (struct sockaddr *)&local_addr,sizeof(struct sockaddr)) == -1)
+    {
+        LOG_E("Unable to bind");
+        goto __exit;
+    }
+    LOG_D("bind to port %d ip_addr %s success\n",RTLINK_LOCAL_TCP_PORT,RTLINK_REMOTE_HOST_IP);
+    if (listen(rtlink_socket, 10) == -1)
+    {
+        LOG_E("Listen error");
+        goto __exit;
+    }
+#else
+        remote_addr.sin_family = AF_INET;
+        remote_addr.sin_port = htons(RTLINK_REMOTE_TCP_PORT);
+        remote_addr.sin_addr.s_addr = inet_addr(RTLINK_REMOTE_HOST_IP);
+        rt_memset(&(remote_addr.sin_zero), 0, sizeof(remote_addr.sin_zero));
+
+#endif
+    rtlink_tcp_delete_flag = 0;
+    rt_thread_t rtlink_socket_tid;
+    rtlink_socket_tid = rt_thread_create("rl_sock",
+                            rtlink_socket_thread_entry,
+                            RT_NULL,
+                            4096,
+                            RT_THREAD_PRIORITY_MAX - 2,
+                            2);
+    if (rtlink_socket_tid != RT_NULL)
+    {
+        rt_thread_startup(rtlink_socket_tid);
+    }
+    else
+    {
+        goto __exit;
+    }
+    return RT_EOK;
+
+__exit:
+    if(rtlink_socket >= 0)
+    {
+        closesocket(rtlink_socket);
+        rtlink_socket = -1;
+    }
+    return RT_ERROR;
+
+}
+
+rt_err_t rt_link_port_deinit(void)
+{
+    rtlink_tcp_delete_flag = 1;
+#ifdef RTLINK_IN_SERVER_MODE
+    if(rtlink_socket >= 0)
+    {
+        closesocket(rtlink_socket);
+        rtlink_socket = -1;
+    }
+    if(connect_socket >= 0)
+    {
+        closesocket(connect_socket);
+        connect_socket = -1;
+    }
+#else
+    if(rtlink_socket >= 0)
+    {
+        closesocket(rtlink_socket);
+        rtlink_socket = -1;
+        connect_socket = -1;
+    }
+#endif
+
+    return RT_EOK;
+}

uart/SConscript

@@ -0,0 +1,14 @@
+import os
+from building import *
+import rtconfig
+
+cwd  = GetCurrentDir()
+src  = []
+CPPPATH = []
+
+if GetDepend('PKG_RT_LINK_USING_UART'):
+    src += ['./rtlink_port_uart.c']
+
+group = DefineGroup('rt-link-port', src, depend = ['RT_USING_RT_LINK'], CPPPATH = CPPPATH)
+
+Return('group')

uart/rtlink_port_uart.c

@@ -0,0 +1,72 @@
+/*
+ * Copyright (c) 2006-2021, RT-Thread Development Team
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Change Logs:
+ * Date           Author       Notes
+ * 2020-12-09     xiangxistu   the first version
+ */
+
+#define DBG_TAG              "rtlink_hw"
+#define DBG_LVL              DBG_INFO
+#include <rtdbg.h>
+
+#include <rtthread.h>
+#include <rtdevice.h>
+#include <rtlink_port.h>
+
+#ifndef RT_LINK_HW_DEVICE_NAME
+    #define RT_LINK_HW_DEVICE_NAME "uart2"
+#endif
+
+#define RT_LINK_HW_RB_BUFSZ     (BSP_UART2_RX_BUFSIZE / 2)
+
+static struct rt_device *hw_device = RT_NULL;
+static rt_uint8_t buffer[RT_LINK_HW_RB_BUFSZ] = {0};
+rt_err_t rt_link_port_rx_ind(rt_device_t device, rt_size_t size)
+{
+    RT_ASSERT(device != RT_NULL);
+    rt_size_t length = rt_device_read(device, 0, buffer, sizeof(buffer));
+    rt_link_hw_write_cb(&buffer, length);
+    return RT_EOK;
+}
+
+rt_size_t rt_link_port_send(void *data, rt_size_t length)
+{
+    rt_size_t size = 0;
+    size = rt_device_write(hw_device, 0, data, length);
+    return size;
+}
+
+rt_err_t rt_link_port_init(void)
+{
+    hw_device = rt_device_find(RT_LINK_HW_DEVICE_NAME);
+    if (hw_device)
+    {
+        rt_device_open(hw_device, RT_DEVICE_OFLAG_RDWR | RT_DEVICE_FLAG_INT_RX);
+        rt_device_set_rx_indicate(hw_device, rt_link_port_rx_ind);
+    }
+    else
+    {
+        LOG_E("Not find device %s", RT_LINK_HW_DEVICE_NAME);
+        return -RT_ERROR;
+    }
+    return RT_EOK;
+}
+
+rt_err_t rt_link_port_deinit(void)
+{
+    hw_device = rt_device_find(RT_LINK_HW_DEVICE_NAME);
+    if (hw_device)
+    {
+        rt_device_close(hw_device);
+        rt_device_set_rx_indicate(hw_device, RT_NULL);
+    }
+    else
+    {
+        LOG_E("Not find device %s", RT_LINK_HW_DEVICE_NAME);
+        return -RT_ERROR;
+    }
+    return RT_EOK;
+}

udp/SConscript

@@ -0,0 +1,12 @@
+from building import *
+
+cwd  = GetCurrentDir()
+src  = []
+CPPPATH = []
+
+if GetDepend('PKG_RT_LINK_USING_UDP'):
+    src += ['./rtlink_port_udp.c']
+
+group = DefineGroup('rt-link-port', src, depend = ['RT_USING_RT_LINK'], CPPPATH = CPPPATH)
+
+Return('group')

udp/rtlink_port_udp.c

@@ -0,0 +1,154 @@
+/*
+ * Copyright (c) 2006-2021, RT-Thread Development Team
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Change Logs:
+ * Date           Author       Notes
+ * 2021-7-7     songchao   the first version
+ */
+
+#include <rtthread.h>
+#include <rtlink_port.h>
+#include <string.h>
+
+#if !defined(SAL_USING_POSIX)
+#error "Please enable SAL_USING_POSIX!"
+#else
+#include <sys/time.h>
+#include <sys/select.h>
+#endif
+#include <sys/socket.h> /* To use the BSD socket, you need to include the socket.h header file */
+#include "netdb.h"
+#define DBG_TAG              "rtlink_port"
+#define DBG_LVL              DBG_INFO
+#include <rtdbg.h>
+
+#define BUFSZ   4096
+static struct sockaddr_in local_addr;
+static struct sockaddr_in remote_addr;
+static uint8_t socket_buffer[BUFSZ];
+static int32_t rtlink_socket = -1;
+
+static void rtlink_socket_thread_entry(void *param)
+{
+    fd_set readset;
+    uint32_t bytes_received;
+    struct timeval timeout;
+    socklen_t addr_len;
+    struct sockaddr_in socket_addr;
+    addr_len = sizeof(struct sockaddr);
+    timeout.tv_sec = 0;
+    timeout.tv_usec = 10000;
+    while(1)
+    {
+        if(rtlink_socket == -1)
+        {
+            rt_thread_delay(100);
+        }
+        else
+        {
+            FD_ZERO(&readset);
+            FD_SET(rtlink_socket, &readset);
+            if (select(rtlink_socket + 1, &readset, RT_NULL, RT_NULL, &timeout) == 0)
+            {
+                continue;
+            }
+            else
+            {
+                bytes_received = recvfrom(rtlink_socket, socket_buffer, BUFSZ - 1, 0,
+                              (struct sockaddr *)&socket_addr, &addr_len);
+                if (bytes_received < 0)
+                {
+                    LOG_E("Received error, close the socket.");
+                    closesocket(rtlink_socket);
+                    rtlink_socket = -1;
+                }
+                else if (bytes_received == 0)
+                {
+                    LOG_W("Received warning, recv function return 0.");
+                }
+                else
+                {
+                    rt_link_hw_write_cb(&socket_buffer, bytes_received);
+                }
+            }
+        }
+    }
+}
+
+rt_size_t rt_link_port_send(void *data, rt_size_t length)
+{
+    rt_size_t size = 0;
+    ssize_t ret;
+    static rt_size_t udp_send_count = 0;
+    if(rtlink_socket != -1)
+    {
+        ret = sendto(rtlink_socket, data, length, 0,(struct sockaddr *)&remote_addr, sizeof(struct sockaddr));
+        if (ret < 0)
+        {
+            LOG_I("send error, close the socket.");
+            closesocket(rtlink_socket);
+            rtlink_socket = -1;
+        }
+        else if (ret == 0)
+        {
+            LOG_W("Send warning, send function return 0.");
+        }
+        else
+        {
+            udp_send_count++;
+        }
+        rt_thread_delay(1);
+    }
+
+    return size;
+}
+
+rt_err_t rt_link_port_init(void)
+{
+    if ((rtlink_socket = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP)) == -1)
+    {
+        LOG_E("Create socket error");
+        return 0;
+    }
+
+    local_addr.sin_family = AF_INET;
+    local_addr.sin_port = htons(RTLINK_LOCAL_UDP_PORT);
+    rt_memset(&(local_addr.sin_zero), 0, sizeof(local_addr.sin_zero));
+
+    remote_addr.sin_family = AF_INET;
+    remote_addr.sin_port = htons(RTLINK_REMOTE_UDP_PORT);
+    remote_addr.sin_addr.s_addr = inet_addr(RTLINK_REMOTE_HOST_IP);
+    rt_memset(&(remote_addr.sin_zero), 0, sizeof(remote_addr.sin_zero));
+
+    if (bind(rtlink_socket, (struct sockaddr *)&local_addr,sizeof(struct sockaddr)) == -1)
+    {
+        LOG_E("Unable to bind");
+        closesocket(rtlink_socket);
+        rtlink_socket = -1;
+        return 0;
+    }
+    LOG_D("bind to port %d ip_addr %s success\n",RTLINK_LOCAL_UDP_PORT,RTLINK_REMOTE_HOST_IP);
+
+    rt_thread_t rtlink_socket_tid;
+    rtlink_socket_tid = rt_thread_create("rt_link_socket_thread",
+                            rtlink_socket_thread_entry,
+                            RT_NULL,
+                            4096,
+                            RT_THREAD_PRIORITY_MAX - 2,
+                            2);
+    if (rtlink_socket_tid != RT_NULL)
+    {
+        rt_thread_startup(rtlink_socket_tid);
+    }
+
+    return RT_EOK;
+}
+
+rt_err_t rt_link_port_deinit(void)
+{
+    closesocket(rtlink_socket);
+    rtlink_socket = -1;
+    return RT_EOK;
+}