LwIP应用开发笔记之十一：LwIP带操作系统UDP服务器

Posted 2021-10-31 木南创智

  我们已经实现了在FreeRTOS系统上的LwIP的移植工作，但只是简单的在系统平台上跑了起来。我们还希望能做更多的事情，这一节我们就在FreeRTOS系统上实现基于LwIP的UDP服务器。

1、UDP协议简述

  UDP协议全称是用户数据报协议，在网络中它与TCP协议一样用于处理数据包，是一种无连接的协议。在OSI模型中，处于传输层，是IP协议的上层协议。UDP有不提供数据包分组、组装和不能对数据包进行排序的缺点，也就是说，当报文发送之后，是无法得知其是否安全完整到达的。

  UDP协议的主要作用是将网络数据流量压缩成数据包的形式。一个典型的数据包就是一个二进制数据的传输单位。每一个数据包的前8个字节用来包含报头信息，剩余字节则用来包含具体的传输数据。

  UDP报头由4个域组成，其中每个域各占用2个字节，具体如下：源端口号、目标端口号、数据报长度、校验值。其数据结构如下：

    UDP协议使用端口号为不同的应用保留其各自的数据传输通道。UDP和TCP协议正是采用这一机制实现对同一时刻内多项应用同时发送和接收数据的支持。数据发送一方（可以是客户端或服务器端）将UDP数据包通过源端口发送出去，而数据接收一方则通过目标端口接收数据。有的网络应用只能使用预先为其预留或注册的静态端口；而另外一些网络应用则可以使用未被注册的动态端口。因为UDP报头使用两个字节存放端口号，所以端口号的有效范围是从0到65535。一般来说，大于49151的端口号都代表动态端口。

  数据报的长度是指包括报头和数据部分在内的总字节数。因为报头的长度是固定的，所以该域主要被用来计算可变长度的数据部分。数据报的最大长度根据操作环境的不同而各异。从理论上说，包含报头在内的数据报的最大长度为65535字节。不过，一些实际应用往往会限制数据报的大小，有时会降低到8192字节。

  UDP协议使用报头中的校验值来保证数据的安全。校验值首先在数据发送方通过特殊的算法计算得出，在传递到接收方之后，还需要再重新计算。如果某个数据报在传输过程中被第三方篡改或者由于线路噪音等原因受到损坏，发送和接收方的校验计算值将不会相符，由此UDP协议可以检测是否出错。

2、带系统UDP服务器的设计

  关于UDP服务器，我们以前在裸机状态下，使用RAW/CallBack API函数实现过。在这里我们将基于操作系统来实现UDP服务器，在此我们需要使用netconn API函数实现。

2.1、netconn API

  在带操作系统的LwIP应用中，应用程序需要使用netconn API函数来实现相关的应用，接下来我们了解一下netconn API函数。

（1）、公用部分函数

  其中即可用于TCP也可用于UDP的公共netconn API函数如下：

序号	函数	描述
1	netconn_new（）	创建一个新连接
2	netconn_peer()	获取远程IP地址和端口
3	netconn_addr()	获取本地IP地址和端口
4	netconn_set_ipv6only()	设置netconn调用的IPv6状态
5	netconn_get_ipv6only()	获取netconn调用的IPv6状态
6	netconn_delete（）	删除现有连接
7	netconn_bind（）	绑定到本地端口/ ip的连接
8	netconn_connect（）	连接到远程端口/ ip的连接
9	netconn_recv（）	从netconn接收数据
10	netconn_gethostbyname_addrtype ()	执行DNS查询，只返回一个IP地址

（2）、用于TCP的函数

  对于TCP连接来说，还包括如下的netconn API函数：

序号	函数	描述
1	netconn_listen（）	将TCP连接设置为侦听模式
2	netconn_write（）	在连接的TCP netconn上发送数据
3	netconn_listen_with_backlog ()	将TCP netconn设置为侦听模式
4	netconn_accept（）	接受侦听TCP连接上的传入连接
5	netconn_recv_tcp_pbuf ()	从TCP netconn接收数据（以pbuf的形式）
6	netconn_write_partly ()	通过TCP netconn发送数据
7	netconn_close（）	关闭TCP netconn而不删除它
8	netconn_shutdown ()	关闭TCP netconn的一端或两端（不删除它）

（3）、用于UDP的函数

  对于UDP连接来说，还包括如下的netconn API函数：

序号	函数	描述
1	netconn_disconnect（）	断开与远程端口/ ip的连接
2	netconn_sendto（）	将数据发送到指定的远程端口/ ip（不适用于TCP）
3	netconn_send（）	将数据发送到当前连接的远程端口/ ip（不适用于TCP）
4	netconn_join_leave_group（）	基本的IGMP多播支持

2.2、UDP服务器的流程

  在RAW API实现UDP服务器时，我们使用回调函数，当接受到数据报文时，回调函数会被调用。在有操作系统的情况下，我们肯定是实现多线程，所以我们将UDP服务器设定为一个任务来执行。在这个任务中我们将按如下流程来实现UDP服务器。

  从上图中我们与无操作系统时的操作很类似。创建控制块、绑定端口等是一样的。但在内部接收和发送报文的方式却是有区别的。

  至于UDP服务器最终实现了哪些功能，需要我们根据实际需要在处理并返回信息阶段实施。功能可以很复杂也可以很简单，在这里我们就是实现一个简单的回环服务器。

3、带系统UDP服务器的实现

  我们已经明白了UDP服务器在使用netconn API的实现方式及流程。接下来我们就来实现它。我们通过两个函数来实现：一是初始化任务，即创建相应的任务；二是实现这个任务函数，也就是我们的UDP服务器。

  先实现任务的创建。这个函数很简单，因为在移植LwIP协议栈时，要求在sys_arch.c文件中实现一个名为sys_thread_new的任务创建函数，而我们已经实现了这个任务创建函数，所以我们直接调用它就好了。

/* UDP初始化配置 */
void UDP_Server_Initialization(void)
{
 sys_thread_new("udpserver_thread", UDPServerThread, NULL, DEFAULT_THREAD_STACKSIZE,UDPECHO_THREAD_PRIO );
}

  接下来，我们看看UDP服务器任务函数的实现，根据上一节我们给出的流程，实现如下：

/* 定义UDP服务器数据处理进程 */
static void UDPServerThread(void *arg)
{
 err_t err, recv_err;
 static struct netconn *conn;
 static struct netbuf *buf;
static ip_addr_t *addr;
static unsigned short port;
 
 LWIP_UNUSED_ARG(arg);
 
 conn = netconn_new(NETCONN_UDP);
 if (conn!= NULL)
 {
  err = netconn_bind(conn, IP_ADDR_ANY,UDP_ECHO_SERVER_PORT);
  if (err == ERR_OK)
  {
   while (1) 
   {
     recv_err = netconn_recv(conn, &buf);
   
     if (recv_err == ERR_OK) 
     {
      addr = netbuf_fromaddr(buf);
      port = netbuf_fromport(buf);
      netconn_connect(conn, addr, port);
      buf->addr.addr = 0;
      netconn_send(conn,buf);
      netbuf_delete(buf);
     }
   }
  }
  else
  {
   netconn_delete(conn);
  }
 }
}

  对于UDP连接来说，netconn_connect函数的调用只是简单的设置UDP控制块中的remote_ip和remote_port字段。其实在这里不使用该函数也是没问题的，因为buf中已经包含了相关的信息。

4、带系统UDP服务器总结

  我们实现了一个简单的UDP服务器应用，其实带有操作系统时只是在软件编写方面采用的形式不一样。从外界看来，依然是一个UDP服务器，与有无操作系统无关。所以我们的测试方法也是一样的，与我们预期的结果也是一样的。

欢迎关注：

如果阅读这篇文章让您略有所得，还请点击下方的【好文要顶】按钮。

当然，如果您想及时了解我的博客更新，不妨点击下方的【关注我】按钮。

如果您希望更方便且及时的阅读相关文章，也可以扫描上方二维码关注我的微信公众号【木南创智】

《嵌入式 - Lwip开发指南》第3章 移植LWIP(无系统)

开发环境：
Keil：V5.30
开发板：STM32 Nucleo-F746ZG开发板
LWIP：V2.1.2
PHY芯片：LAN8742A

3.1 STM32CudeMX配置工程

由于STM32CudeMX内集成LWIP（TCP/IP协议栈），不需要我们进行复杂的移植，只需简单的配置。

1.选择时钟源

在前文已经讲过了，这里使用MCO，所以HSE选择BYPASS旁路，也就是ST-Link输入的时钟源，时钟输入为8M。

2.选择Debug方式和时基

这里是没有使用系统，这里使用SysTick作为时基。

3.配置USART3

使用USART3进行printf打印调试信息

Nucleo-F746ZG调试串口使用的是USART3，映射IO口如下：

值得注意的是，这里需要手动调整映射接口，默认选择的映射不匹配。

4.以太网配置

NCULEO-F746ZG的板载了LAN8742的PHY。

STM32F746通过RMII 接口连接PHY芯片LAN8742, 然后经过百兆网络变压器到RJ45接口。因为 LAN8742A只有 RMII 接口，因此这里与开发板的连接采用了 RMII 接口。

RMII对应的引脚连接如下：

RMII接口	STM32F746ZG引脚
RMII_TXEN	PG11
RMII_TXD0	PG13
RMII_TXD1	PB13
RMII_RXD0	PC4
RMII_RXD1	PC5
RMII_CRS_DV	PA7
RMII_MDC	PC1
RMII_MDIO	PA2
RMII_REF_CLK	PA1

ETH引脚默认的和原理图不匹配，主要是ETH_TX_EN 和 ETH_TXD0，需要手动映射。

值得注意的是需要先手动手动映射，在使能ETH。

另外原理图中LAN8742的PHYAD0引脚下拉到地。

根据数据手册，ETH 的 Configuration 中PHY Address设为0。

PHY芯片设置，需根据LAN8742A的芯片手册来配置。

这里默认即可。

5.LWIP配置
Middleware -> LwIP，勾选使能。

其他默认即可。

【注】当然为了方便调试，也可使用静态IP，但是在调试过程中要保证调试PC与开发板连接同一个路由器。

最后生程工程即可。

3.2代码编写

1.调试串口输出
在生成的main.c文件中增加以下代码：

/**
  * @brief   重定向c库函数printf到串口
  * @param   ch
  * @retval  HAL_OK       = 0x00U
	*	@ 			 HAL_ERROR    = 0x01U
	*	@		     HAL_BUSY     = 0x02U
	*	@		     HAL_TIMEOUT  = 0x03U
  */
int fputc(int ch, FILE *f)
{
    return HAL_UART_Transmit(&huart3, (uint8_t *)&ch, 1, 0xFFFF);
}

然后就可以使用printf函数将调试信息通过串口打印出来。

2.IP地址获取

新建app_lwip.c和app_lwip.h，移植为了处理热插拔网口，检测板子的IP地址，另外以后的应用也将放在里面。

app_lwip.h代码如下：

#ifndef __APP_LWIP_H_
#define __APP_LWIP_H_

/* Includes ------------------------------------------------------------------*/
#include <string.h>
#include "lwip.h"

void app_lwip_process(void);

#endif

app_lwip.c代码如下：

/**
  ******************************************************************************
  * @file                app_lwip.c
  * @author              BruceOu
  * @lib version         HAL
  * @version             V1.0
  * @date                2021-07-06
  * @blog                https://blog.bruceou.cn/
  * @Official Accounts   嵌入式实验楼
  * @brief               lwip app
  ******************************************************************************
  */
/* Includes ------------------------------------------------------------------*/
#include "app_lwip.h"

/* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/* Private macro -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
static uint8_t b_ip_state = 0;			//ip状态
static uint8_t b_network_cable = 0;		//网线状态

/* Private function prototypes -----------------------------------------------*/
/* Private functions ---------------------------------------------------------*/

/* Exported macro ------------------------------------------------------------*/
/* Exported variables --------------------------------------------------------*/
extern struct netif *netif_default;
extern struct netif gnetif;
extern ETH_HandleTypeDef heth;

/**/
/**
  * @brief  插入网线的话重新获取IP操作
  * @param  netif
  * @retval None
  */
void ethernetif_notify_conn_changed(struct netif *netif)
{
    if(netif_is_link_up(netif) && !netif_is_up(netif))
    {
        netif_set_up(netif);
        extern err_t dhcp_start(struct netif *netif);
		    dhcp_start(netif);
    }
}

/**
  * @brief  读取网线状态,读取IP值
  * @param  None
  * @retval None
  */
static void use_read_network_cable(void)
{
	uint32_t phy_data = 0;
	
	HAL_ETH_ReadPHYRegister(&heth, PHY_BSR, &phy_data);			//读取PHY数据
	
	if(((phy_data & PHY_LINKED_STATUS) != PHY_LINKED_STATUS))	//
	{
		if(!b_network_cable) 
			return;
		b_network_cable = 0;
		printf("未插网线\\r\\n");
		
		b_ip_state = 0;
		gnetif.ip_addr.addr = 0;
		
		return;
	}
	
	if(!b_network_cable)
	{
		b_network_cable = 1;
		printf("已插网线\\r\\n");
		return;
	}
	
	if(b_ip_state)
		return;
	if(gnetif.ip_addr.addr)
	{
		b_ip_state = 1;
		
		uint8_t ip4_number[6];
		ip4_number[0] = gnetif.hwaddr[0];
		ip4_number[1] = gnetif.hwaddr[1];
		ip4_number[2] = gnetif.hwaddr[2];
		ip4_number[3] = gnetif.hwaddr[3];
		ip4_number[4] = gnetif.hwaddr[4];
		ip4_number[5] = gnetif.hwaddr[5];
		printf("MAC地址..............%x.%x.%x.%x.%x.%x\\r\\n",ip4_number[0],ip4_number[1],ip4_number[2],ip4_number[3],ip4_number[4],ip4_number[5]);
		ip4_number[3] = gnetif.ip_addr.addr >> 24;
		ip4_number[2] = gnetif.ip_addr.addr >> 16;
		ip4_number[1] = gnetif.ip_addr.addr >> 8;
		ip4_number[0] = gnetif.ip_addr.addr >> 0;
		printf("通过DHCP获取到IP地址..............%d.%d.%d.%d\\r\\n",ip4_number[0],ip4_number[1],ip4_number[2],ip4_number[3]);
		
		ip4_number[3] = gnetif.netmask.addr >> 24;
		ip4_number[2] = gnetif.netmask.addr >> 16;
		ip4_number[1] = gnetif.netmask.addr >> 8;
		ip4_number[0] = gnetif.netmask.addr >> 0;
		printf("通过DHCP获取到子网掩码..............%d.%d.%d.%d\\r\\n",ip4_number[0],ip4_number[1],ip4_number[2],ip4_number[3]);
		
		ip4_number[3] = gnetif.gw.addr >> 24;
		ip4_number[2] = gnetif.gw.addr >> 16;
		ip4_number[1] = gnetif.gw.addr >> 8;
		ip4_number[0] = gnetif.gw.addr >> 0;
		printf("通过DHCP获取到默认网关..............%d.%d.%d.%d\\r\\n",ip4_number[0],ip4_number[1],ip4_number[2],ip4_number[3]);
	}
}

/**
  * @brief  lwip app
  * @param  None
  * @retval None
  */
void app_lwip_process(void)
{
	MX_LWIP_Process();					//LWIP轮询任务
	
	ethernetif_set_link(netif_default);	//重新插网线进行获取IP的任务
	
	use_read_network_cable();
}

最后在主函数中调用一下即可。

/**
  * @brief  The application entry point.
  * @retval int
  */
int main(void)
{
  /* USER CODE BEGIN 1 */

  /* USER CODE END 1 */

  /* Enable I-Cache---------------------------------------------------------*/
  SCB_EnableICache();

  /* Enable D-Cache---------------------------------------------------------*/
  SCB_EnableDCache();

  /* MCU Configuration--------------------------------------------------------*/

  /* Reset of all peripherals, Initializes the Flash interface and the Systick. */
  HAL_Init();

  /* USER CODE BEGIN Init */

  /* USER CODE END Init */

  /* Configure the system clock */
  SystemClock_Config();

  /* USER CODE BEGIN SysInit */

  /* USER CODE END SysInit */

  /* Initialize all configured peripherals */
  MX_GPIO_Init();
  MX_USART3_UART_Init();
  MX_LWIP_Init();
  /* USER CODE BEGIN 2 */
	

  /* USER CODE END 2 */

  /* Infinite loop */
  /* USER CODE BEGIN WHILE */
  while (1)
  {
    /* USER CODE END WHILE */
		app_lwip_process();
    /* USER CODE BEGIN 3 */
  }
  /* USER CODE END 3 */
}

3.3测试

编译，下载，连接好网线，打开串口调试助手，可以尝试插拔网线

最后在电脑上面ping一下：

---

---

代码获取方法

1.长按下面二维码，关注公众号[嵌入式实验楼]
2.在公众号回复关键词[LWIP]获取资料

---

---

欢迎访问我的网站

BruceOu的哔哩哔哩
BruceOu的主页
BruceOu的博客
BruceOu的CSDN博客
BruceOu的简书