一目了然
- 1. 准备工作
- 2. 裸机移植LwIP
- 2.1 LwIP目录创建
- 2.2 LwIP源文件移植
- 2.3 LwIP头文件移植
- 2.4 网口驱动开发
- 2.4.1 MAC模块驱动
- 2.4.2 PHY模块驱动
- 2.5 LwIP网卡接口适配
- 2.6 LwIP运行和测试
1. 准备工作
LwIP正式移植之前,登录LwIP官方网站:https://savannah.nongnu.org/projects/lwip/,此网站包含有关LwIP协议的各种信息,可根据兴趣进行查看。若要下载源码,点击进入到LwIP协议的源码下载界面。这里您可以看到LwIP协议各个版本的发布包,根据需求选择适当版本的“contrib”和“lwip”源码包进行下载,下载完成后解压便可看到LwIP的所有源码。本文中选取的LwIP源码包的版本分别是“contrib-2.0.1”和“lwip-2.0.3”。
2. 裸机移植LwIP
2.1 LwIP目录创建
裸机移植LwIP主要应用到“lwip-2.0.3\src”目录下的源码文件夹(api、core、和netif)和头文件夹(include),移植时可在自己的工程中创建“LwIP”目录,并在此目录下分别建立api、core、netif和include目录,如下图所示:
2.2 LwIP源文件移植
接下来需要往工程的各个目录中添加LwIP源文件(以IPV4版本协议的移植为例):
工程api目录:添加“lwip-2.0.3\src\api”中的所有文件;
工程core目录:添加“lwip-2.0.3\src\core”中除“ipv6”外的所有文件和目录;
工程netif目录:添加“lwip-2.0.3\src\netif”中的所有文件:
至此,裸机移植LwIP所需的所有源文件都已添加完成,接下来是往工程中添加头文件。
2.3 LwIP头文件移植
工程include目录:添加“lwip-2.0.3\src\include”中的所有文件:
在工程中“LwIP”目录下创建“port”目录,并在工程“port”目录下创建“include\arch”目录。将“contrib-2.0.1\ports\unix\minimal”目录下的“lwipopts.h”文件添加至工程“port\include”目录中,将“contrib-2.0.1\ports\unix\port\include\arch”目录下“cc.h”和“perf.h”文件添加至工程目录“port\include\arch”下,添加完成后如下图所示:
lwipopts.h是对LwIP协议使用功能的配置文件,类似于FreeRTOS系统文件中的FreeRTOSConfig.h文件。一个配置例程如下所示:
#ifndef LWIP_LWIPOPTS_H
#define LWIP_LWIPOPTS_H
#define NO_SYS 1
#define SYS_LIGHTWEIGHT_PROT 0
#define MEM_ALIGNMENT 4
#define MEM_SIZE (30 * 1024)
#define MEMP_NUM_PBUF 30
#define MEMP_NUM_RAW_PCB 4
#define MEMP_NUM_UDP_PCB 4
#define MEMP_NUM_TCP_PCB 2
#define MEMP_NUM_TCP_PCB_LISTEN 8
#define MEMP_NUM_TCP_SEG 16
#define MEMP_NUM_ARP_QUEUE 2
#define MEMP_NUM_SYS_TIMEOUT (LWIP_TCP + IP_REASSEMBLY + LWIP_ARP + (2*LWIP_DHCP) + LWIP_AUTOIP + LWIP_IGMP + LWIP_DNS + PPP_SUPPORT + (LWIP_IPV6 ? (1 + LWIP_IPV6_REASS + LWIP_IPV6_MLD) : 0)) + 1
#define MEMP_NUM_NETBUF 0
#define MEMP_NUM_NETCONN 0
#define MEMP_NUM_TCPIP_MSG_API 0
#define MEMP_NUM_TCPIP_MSG_INPKT 0
#define PBUF_POOL_SIZE 32
#define MEMP_OVERFLOW_CHECK 0
#define LWIP_ARP 1
#define IP_FORWARD 0
#define IP_OPTIONS_ALLOWED 1
#define IP_REASSEMBLY 1
#define IP_FRAG 1
#define IP_REASS_MAXAGE 3
#define IP_REASS_MAX_PBUFS 10
#define IP_FRAG_USES_STATIC_BUF 0
#define IP_DEFAULT_TTL 255
#define LWIP_ICMP 1
#define ICMP_TTL (IP_DEFAULT_TTL)
#define LWIP_RAW 1
#define LWIP_DHCP 0
#define LWIP_AUTOIP 0
#define LWIP_SNMP 1
#define LWIP_MIB2_CALLBACKS 0
#define MIB2_STATS 1
#define LWIP_IGMP 1
#define LWIP_DNS 0
#define LWIP_UDP 1
#define LWIP_UDPLITE 0
#define UDP_TTL (IP_DEFAULT_TTL)
#define LWIP_TCP 1
#define TCP_TTL 255
#define TCP_QUEUE_OOSEQ 0
#define TCP_MSS (1500 - 40)
#define TCP_SND_BUF (4 * TCP_MSS)
#define TCP_SND_QUEUELEN (2 * TCP_SND_BUF / TCP_MSS)
#define TCP_WND (2 * TCP_MSS)
#define PBUF_LINK_HLEN 16
#define LWIP_HAVE_LOOPIF 0
#define LWIP_NETCONN 0
#define LWIP_SOCKET 0
#define LWIP_STATS 1
#define LWIP_MAC_ADDR 0x11, 0x22, 0x33, 0x44, 0x55, 0x66
#define LWIP_NETIF_HOSTNAME 1
#define LWIP_NETIF_HOSTNAME_TEXT "LwIP_Net"
#define LWIP_IPV4 1
#define LWIP_LINK_SPEED_IN_BPS 100000000
#define LWIP_INIT_IPADDR(addr) IP4_ADDR((addr), 192,168,0,10)
#define LWIP_INIT_NETMASK(addr) IP4_ADDR((addr), 255,255,255,0)
#define LWIP_INIT_GW(addr) IP4_ADDR((addr), 192,168,0,1)
#define TAPIF_DEBUG LWIP_DBG_ON
#define TUNIF_DEBUG LWIP_DBG_OFF
#define UNIXIF_DEBUG LWIP_DBG_OFF
#define DELIF_DEBUG LWIP_DBG_OFF
#define SIO_FIFO_DEBUG LWIP_DBG_OFF
#define TCPDUMP_DEBUG LWIP_DBG_ON
#define API_LIB_DEBUG LWIP_DBG_ON
#define API_MSG_DEBUG LWIP_DBG_ON
#define TCPIP_DEBUG LWIP_DBG_ON
#define NETIF_DEBUG LWIP_DBG_ON
#define SOCKETS_DEBUG LWIP_DBG_ON
#define DEMO_DEBUG LWIP_DBG_ON
#define IP_DEBUG LWIP_DBG_ON
#define IP_REASS_DEBUG LWIP_DBG_ON
#define RAW_DEBUG LWIP_DBG_ON
#define ICMP_DEBUG LWIP_DBG_ON
#define UDP_DEBUG LWIP_DBG_ON
#define TCP_DEBUG LWIP_DBG_ON
#define TCP_INPUT_DEBUG LWIP_DBG_ON
#define TCP_OUTPUT_DEBUG LWIP_DBG_ON
#define TCP_RTO_DEBUG LWIP_DBG_ON
#define TCP_CWND_DEBUG LWIP_DBG_ON
#define TCP_WND_DEBUG LWIP_DBG_ON
#define TCP_FR_DEBUG LWIP_DBG_ON
#define TCP_QLEN_DEBUG LWIP_DBG_ON
#define TCP_RST_DEBUG LWIP_DBG_ON
extern unsigned char debug_flags;
#define LWIP_DBG_TYPES_ON debug_flags
#endif
cc.h包含针对处理器和编译器的一些数据类型、字节对齐方式和宏定义等内容。一个例程如下所示:
#ifndef LWIP_ARCH_CC_H
#define LWIP_ARCH_CC_H
#include <stdio.h>
#include <stdint.h>
#define LWIP_NO_STDINT_H 1
typedef uint8_t u8_t;
typedef int8_t s8_t;
typedef uint16_t u16_t;
typedef int16_t s16_t;
typedef uint32_t u32_t;
typedef int32_t s32_t;
typedef uintptr_t mem_ptr_t;
typedef int sys_prot_t;
#define X8_F "02x"
#define U16_F "hu"
#define S16_F "hd"
#define X16_F "hx"
#define U32_F "lu"
#define S32_F "ld"
#define X32_F "lx"
#define SZT_F "lu"
#define BYTE_ORDER LITTLE_ENDIAN
#if defined (__ICCARM__)
#define PACK_STRUCT_BEGIN
#define PACK_STRUCT_STRUCT
#define PACK_STRUCT_END
#define PACK_STRUCT_FIELD(x) x
#define PACK_STRUCT_USE_INCLUDES
#elif defined (__CC_ARM)
#define PACK_STRUCT_BEGIN __packed
#define PACK_STRUCT_STRUCT
#define PACK_STRUCT_END
#define PACK_STRUCT_FIELD(x) x
#elif defined (__GNUC__)
#define PACK_STRUCT_BEGIN
#define PACK_STRUCT_STRUCT __attribute__ ((__packed__))
#define PACK_STRUCT_END
#define PACK_STRUCT_FIELD(x) x
#elif defined (__TASKING__)
#define PACK_STRUCT_BEGIN
#define PACK_STRUCT_STRUCT
#define PACK_STRUCT_END
#define PACK_STRUCT_FIELD(x) x
#endif
#define LWIP_PLATFORM_ASSERT(x) do {printf("Assertion failed: ");\
printf("Assertion failed: ");}while(0)
extern u32_t sys_now(void);
#endif
cc.h文件中声明的sys_now函数需借助处理芯片(如MCU)的定时器实现。
perf.h是与系统统计和测量有关的文件,一般无需求是可不使用。如下所示:
#ifndef LWIP_ARCH_PERF_H
#define LWIP_ARCH_PERF_H
#define PERF_START
#define PERF_STOP(x)
#endif
2.4 网口驱动开发
网口驱动主要包含两部分的驱动:MAC模块驱动和PHY模块驱动。MAC和PHY位于ISO/OSI模型的最后两层,完成数据链路层和物理层的数据传输。两者之间的具体关系可在网上查询学习,此处不做过多阐述。
2.4.1 MAC模块驱动
一般MAC模块位于MCU中,MCU厂商会提供相应的基本驱动程序,如若没有,则需要开发人员参照Datasheet描述进行编写,必须要实现的接口包括模块初始化、数据发送和数据接收接口。其中模块初始化的基本步骤大致如下:
1、Ethernet端口时钟设置;
2、Ethernet端口引脚设置;
3、MAC模块具体寄存器设置,涉及到MAC地址、接口模式(MII、RMII等)、通信速率、数据接收和发送缓存设置、数据接收和发送模式(轮询、中断或者DMA)等;
4、模块功能(数据接收和发送)启动。
2.4.2 PHY模块驱动
PHY模块通过MII、RMII等连接方式与MAC模块进行连接,在编写驱动时需要参考具体的硬件设计以及PHY芯片数据手册完成驱动操作。可参考如下步骤进行:
1、PHY芯片电源控制,按照硬件电路设计完成对PHY芯片上电和下电的驱动控制;
2、参考PHY芯片数据手册完成初始化设置,具体配置信息根据PHY芯片的不同或有差异,但是主要目的都是为了打通网络数据的传输链路。
开发人员可能会发现,有的硬件电路设计中找不到PHY芯片,与处理器MAC模块的通信连接可能会被叫做Switch芯片的模块代替,此处要说明的是Switch常用于多网口的电路设计中,由于Switch芯片内部集成了多个MAC和PHY模块,可完成数据在多路网口之间的数据传输。此时只需参照PHY芯片的驱动开发步骤完成Switch芯片的驱动的开发。当然,Switch芯片的功能要比PHY芯片的功能复杂,驱动支持接口可能会相对较多,开发人员需根据使用需求选择具体开发哪些功能驱动。
网口驱动开发一旦完成,便保证了网络数据的传输链路已经打通,在移植过程中便不用再担心硬件导致的LwIP数据传输不成功问题了,接下来便是将网口驱动程序加入到LwIP协议栈中的工作。
2.5 LwIP网卡接口适配
LwIP网卡驱动适配工作主要是完善“lwip-2.0.3\src\netif\ethernetif.c”文件中部分函数接口,包括以下函数:
low_level_init
low_level_output
low_level_input
在low_level_init函数中应当完成MAC地址的设置,同时调用网口驱动初始化函数,完成网络的初始化工作,low_level_init函数中已经指示了应当在哪些地方进行修改,下述代码是移植过程中的一个实例,其中带有“Add by myself start ”和“Add by myself end”注释部分是移植过程中添加的完善代码;
static void
low_level_init(struct netif *netif)
{
struct ethernetif *ethernetif = netif->state;
uint8_t aMacAddr[6] = {0x11, 0x22, 0x33, 0x44, 0x55, 0x66};
netif->hwaddr_len = ETHARP_HWADDR_LEN;
netif->hwaddr[0] = aMacAddr[0];
netif->hwaddr[1] = aMacAddr[1];
netif->hwaddr[2] = aMacAddr[2];
netif->hwaddr[3] = aMacAddr[3];
netif->hwaddr[4] = aMacAddr[4];
netif->hwaddr[5] = aMacAddr[5];
netif->mtu = 1500;
netif->num = ETHERNET_PORT0;
netif->flags = NETIF_FLAG_BROADCAST | NETIF_FLAG_ETHARP | NETIF_FLAG_LINK_UP;
#if LWIP_IPV6 && LWIP_IPV6_MLD
if (netif->mld_mac_filter != NULL) {
ip6_addr_t ip6_allnodes_ll;
ip6_addr_set_allnodes_linklocal(&ip6_allnodes_ll);
netif->mld_mac_filter(netif, &ip6_allnodes_ll, NETIF_ADD_MAC_FILTER);
}
#endif
DevEthernetInit(netif->num);
}
在low_level_output函数中调用网卡数据发送接口,完成网络数据的发送工作,low_level_output函数中已经指示了应当在哪些地方进行修改,下述代码是移植过程中的一个实例,其中带有“Add by myself start ”和“Add by myself end”注释部分是移植过程中添加的完善代码;
static err_t
low_level_output(struct netif *netif, struct pbuf *p)
{
struct ethernetif *ethernetif = netif->state;
struct pbuf *q;
// initiate transfer();
#if ETH_PAD_SIZE
pbuf_header(p, -ETH_PAD_SIZE);
#endif
for (q = p; q != NULL; q = q->next) {
// send data from(q->payload, q->len);
DevEthernetSend(netif->num, q->payload, q->len);
}
// signal that packet should be sent();
MIB2_STATS_NETIF_ADD(netif, ifoutoctets, p->tot_len);
if (((u8_t*)p->payload)[0] & 1) {
MIB2_STATS_NETIF_INC(netif, ifoutnucastpkts);
} else {
MIB2_STATS_NETIF_INC(netif, ifoutucastpkts);
}
#if ETH_PAD_SIZE
pbuf_header(p, ETH_PAD_SIZE);
#endif
LINK_STATS_INC(link.xmit);
return ERR_OK;
}
在low_level_input函数中调用网卡数据接收接口,完成网络数据的接收工作,low_level_input函数中已经指示了应当在哪些地方进行修改,下述代码是移植过程中的一个实例,其中带有“Add by myself start ”和“Add by myself end”注释部分是移植过程中添加的完善代码;
static struct pbuf *
low_level_input(struct netif *netif)
{
struct ethernetif *ethernetif = netif->state;
struct pbuf *p, *q;
u16_t len;
uint8_t *pFrame = NULL;
len = DevEthernetGetRecvLength(netif->num);
#if ETH_PAD_SIZE
len += ETH_PAD_SIZE;
#endif
p = pbuf_alloc(PBUF_RAW, len, PBUF_POOL);
if (p != NULL) {
#if ETH_PAD_SIZE
pbuf_header(p, -ETH_PAD_SIZE);
#endif
for (q = p; q != NULL; q = q->next) {
//read data into(q->payload, q->len);
pFrame = (uint8_t *)DevEthernetRecv(netif->num);
if (NULL != pFrame)
{
memcpy((uint8_t *)q->payload, pFrame, len);
}
}
//acknowledge that packet has been read();
DevEthernetFreeRecvBuf(netif->num);
MIB2_STATS_NETIF_ADD(netif, ifinoctets, p->tot_len);
if (((u8_t*)p->payload)[0] & 1) {
MIB2_STATS_NETIF_INC(netif, ifinnucastpkts);
} else {
MIB2_STATS_NETIF_INC(netif, ifinucastpkts);
}
#if ETH_PAD_SIZE
pbuf_header(p, ETH_PAD_SIZE);
#endif
LINK_STATS_INC(link.recv);
} else {
drop packet();
LINK_STATS_INC(link.memerr);
LINK_STATS_INC(link.drop);
MIB2_STATS_NETIF_INC(netif, ifindiscards);
}
return p;
}
上述接口完善结束,意味着离LwIP裸机移植的成功又进了一步,接下来便是想办法将LwIP协议栈调度运行起来,测试运行效果。
2.6 LwIP运行和测试
在调度运行LwIP之前还需完成两个重要的接口:LwIP_Init和LwIP_Test。
LwIP_Init用于完成LwIP协议栈的初始化工作,如网关设置、IP地址设置、子网掩码设置、初始化处理和网络链接启动等。有关网关、IP地址和子网掩码等信息的配置已在lwipopts.h文件中体现,如下所示:
#define LWIP_MAC_ADDR 0x11, 0x22, 0x33, 0x44, 0x55, 0x66
#define LWIP_NETIF_HOSTNAME 1
#define LWIP_NETIF_HOSTNAME_TEXT "LwIP_Net"
#define LWIP_IPV4 1
#define LWIP_LINK_SPEED_IN_BPS 100000000
#define LWIP_INIT_IPADDR(addr) IP4_ADDR((addr), 192,168,0,10)
#define LWIP_INIT_NETMASK(addr) IP4_ADDR((addr), 255,255,255,0)
#define LWIP_INIT_GW(addr) IP4_ADDR((addr), 192,168,0,1)
LwIP_Init函数的实现例程如下所示:
void LwIP_Init(void)
{
#if LWIP_IPV4
ip4_addr_t ipaddr, netmask, gw;
#if (!LWIP_DHCP) && (!LWIP_AUTOIP)
LWIP_INIT_GW(&gw);
LWIP_INIT_IPADDR(&ipaddr);
LWIP_INIT_NETMASK(&netmask);
#endif
#endif
lwip_init();
netif_set_default(netif_add(&gnetif, &ipaddr, &netmask, &gw, NULL, ethernetif_init, netif_input));
if (netif_is_link_up(&gnetif))
{
netif_set_up(&gnetif);
}
else
{
netif_set_down(&gnetif);
}
}
LwIP_Test函数则用于接收网络数据和监测LwIP的timeout事件,此函数要周期性地被调用,保证网络模块接收到的网络数据及时传入LwIP协议栈中进行处理。LwIP_Test函数示例如下所示:
void LwIPTestProcess(void)
{
ethernetif_input(&gnetif);
sys_check_timeouts();
}
进行到这一步,LwIP裸机移植工作已全部完成,如无意外,此时应当可以通过电脑端cmd窗口与烧录了LwIP程序的硬件开发板进行ping通信,前提是需设置电脑IPv4的网关地址、IP地址和子网掩码,保证电脑和开发板在同一IP段内。