沁恆 CH32V208(四): CH32V208 網路DHCP範例程式碼分析

2023-05-15 06:00:56

目錄

硬體部分

  • CH32V208WBU6 評估板
  • WCH-LinkE 或 WCH-Link

硬體環境前面幾節相同, 不再詳細說明. 本節網路測試需要準備支援DHCP的有線網口, 五類/六類網線.

軟體部分

本節以沁恆的網路範例專案為例進行說明.

範例程式碼位於 CH32V20xEVT 壓縮包的 EVT/EXAM/ETH/DHCP 目錄.

對應 GCC 環境的專案程式碼位於 https://github.com/IOsetting/ch32v208-template/tree/main/Examples/ETH/DHCP

編譯和燒錄

這裡只介紹 GCC & Makefile 環境的編譯和燒錄. 參考上一節進行 GCC 環境的設定

  1. 修改 Makefile 中的 USE_NET_LIB 選項, 設定為USE_NET_LIB ?= y, 開啟這個選項, 在編譯時會包含 NetLib 庫
  2. 清空 User 目錄, 將 Examples/ETH/DHCP 目錄下的檔案複製到 User 目錄, 執行 make 編譯專案
  3. 連線好 WCH-Link 和 CH32V208 評估板, 執行 make flash 燒錄

執行範例

除了使用評估板的網口連線網線, 還需要將評估板的串列埠輸出連線到 WCH-Link, 在PC端使用串列埠工具, 波特率115200開啟 /dev/ttyACM0 觀察輸出

啟動階段會列印系統時鐘, MAC地址

22:02:27.934 DHCP Test
SystemClk:120000000
net version:15
mac addr:38 3b 26 88 3f 30 
22:02:28.037 WCHNET_LibInit Success

接入網線後, 會提示

22:02:29.693 PHY Link Success

等待幾秒DHCP獲得IP後, 顯示網路資訊

22:02:33.934 DHCP Success
IPAddr = 192.168.1.222 
GWIPAddr = 192.168.1.1 
IPAddr = 255.255.255.0 
DNS1: 192.168.1.1 
DNS2: 0.0.0.0 
WCH22:02:33.938 NET_SocketCreat 0

此時, 通過PC端可以 ping 通這個IP地址.

程式碼分析

網路庫 NetLib

實現部分是閉源的, 沁恆只提供了一部分外部呼叫的介面. 結構如下

 NetLib
├── eth_driver.c
├── eth_driver.h
├── libwchnet.a
└── wchnet.h

對於使用者的專案, 還需要外加一個 net_config.h 檔案, 用於定義網路設定.

工作機制

流程圖

流程說明

如上圖所示, main 函數中的網路功能主要是兩個入口, 一個是 TIM2 的初始化, 給 NetLib 提供系統 tick, 另一個是 ETH_LibInit 之後的主迴圈

int main(void)
{
    u8 i;

    Delay_Init();
    USART_Printf_Init(115200);                                 // 串列埠初始化
    printf("DHCP Test\r\n");
    printf("SystemClk:%ld\r\n",SystemCoreClock);
    printf("net version:%x\n",WCHNET_GetVer());
    if( WCHNET_LIB_VER != WCHNET_GetVer() ){
      printf("version error.\n");                              // 檢查 wchnet.h 的版本(WCHNET_LIB_VER)和 libwchnet.a 中的版本是否一致
    }                                                                   

    WCHNET_GetMacAddr(MACAddr);                                // 從晶片內部FLASH讀取MAC地址, 晶片自帶MAC地址
    printf("mac addr:");
    for(i = 0; i < 6; i++) 
        printf("%x ",MACAddr[i]);
    printf("\n");

                                                               // 以上都是顯示內容, 和網路功能DHCP沒什麼關係, 以下是必須的步驟
    TIM2_Init();                                               // 初始化 TIM2, 用於每隔10ms呼叫 WCHNET_TimeIsr(WCHNETTIMERPERIOD), LocalTime增長
    WCHNET_DHCPSetHostname("WCHNET");                          // 設定本機 host name, 用於DHCP
    i = ETH_LibInit(IPAddr, GWIPAddr, IPMask, MACAddr);        // 初始化 Netlib
    mStopIfError(i);                                           // 檢查初始化是否成功
    if(i == WCHNET_ERR_SUCCESS)
    {
        printf("WCHNET_LibInit Success\r\n");
    }
    WCHNET_DHCPStart(WCHNET_DHCPCallBack);                     // 啟動 DHCP

    while(1)
    {
        WCHNET_MainTask();                                     // 需要重複執行的網路任務

        if(WCHNET_QueryGlobalInt())                            // 如果存在網路中斷, 呼叫網路中斷處理常式
        {
            WCHNET_HandleGlobalInt();
        }
    }
}

NetLib 的系統 Tick

首先是建立一個間隔10ms的定時器

void TIM2_Init(void)
{
    TIM_TimeBaseInitTypeDef TIM_TimeBaseStructure = {0};

    RCC_APB1PeriphClockCmd(RCC_APB1Periph_TIM2, ENABLE);

    TIM_TimeBaseStructure.TIM_Period = SystemCoreClock / 1000000 - 1;
    TIM_TimeBaseStructure.TIM_Prescaler = WCHNETTIMERPERIOD * 1000 - 1;
    TIM_TimeBaseStructure.TIM_ClockDivision = 0;
    TIM_TimeBaseStructure.TIM_CounterMode = TIM_CounterMode_Up;
    TIM_TimeBaseInit(TIM2, &TIM_TimeBaseStructure);
    TIM_ITConfig(TIM2, TIM_IT_Update, ENABLE);

    TIM_Cmd(TIM2, ENABLE);
    TIM_ClearITPendingBit(TIM2, TIM_IT_Update);
    NVIC_SetPriority(TIM2_IRQn, 0x80);
    NVIC_EnableIRQ(TIM2_IRQn);
}

在中斷中呼叫 WCHNET_TimeIsr(WCHNETTIMERPERIOD)

void TIM2_IRQHandler(void)
{
    WCHNET_TimeIsr(WCHNETTIMERPERIOD);
    TIM_ClearITPendingBit(TIM2, TIM_IT_Update);
}

在 eth_driver.c 中有這個函數的定義, LocalTime是一個遞增的32位元時間戳, 作用類似於 SysTick, 用於函數進行時間判斷

void WCHNET_TimeIsr( uint16_t timperiod )
{
    LocalTime += timperiod;
}

不能確定在 libwchnet 中是否用到 LocalTime, 能觀察到使用這個 LocalTime 只有一處程式碼, 用於PHY每隔50ms一次檢查Link狀態

void WCHNET_HandlePhyNegotiation(void)
{
    if( !phyStatus )                        /* Handling PHY Negotiation Exceptions */
    {
        if(phyLinkTime > LocalTime)
            phyLinkTime = LocalTime;
        if( LocalTime - phyLinkTime >= PHY_LINK_TASK_PERIOD )  /* 50ms cycle timing call */
        {
            phyLinkTime = LocalTime;
            WCHNET_LinkProcess( );
        }
    }
}

NetLib 的初始化和 DHCP 流程

ETH_LibInit 是 Netlib 的初始化函數, 在函數中

  • 通過 _WCH_CFG 結構體設定傳送緩衝區大小, TCP_MSS大小,ARP Table 大小, 以及網口燈對應的GPIO
  • 初始化 NetLib
  • 初始化並啟動 ETH
uint8_t ETH_LibInit( uint8_t *ip, uint8_t *gwip, uint8_t *mask, uint8_t *macaddr )
{
    uint8_t s;
    struct _WCH_CFG  cfg;

    memset(&cfg,0,sizeof(cfg));
    cfg.TxBufSize = ETH_TX_BUF_SZE;
    cfg.TCPMss   = WCHNET_TCP_MSS;
    cfg.HeapSize = WCHNET_MEM_HEAP_SIZE;
    cfg.ARPTableNum = WCHNET_NUM_ARP_TABLE;
    cfg.MiscConfig0 = WCHNET_MISC_CONFIG0;
    cfg.MiscConfig1 = WCHNET_MISC_CONFIG1;
    cfg.led_link = ETH_LedLinkSet;
    cfg.led_data = ETH_LedDataSet;
    cfg.net_send = ETH_TxPktChainMode;
    cfg.CheckValid = WCHNET_CFG_VALID;
    s = WCHNET_ConfigLIB(&cfg);             // NetLib引數設定, 閉源方法
    if(s){
       return (s);
    }
    s = WCHNET_Init(ip,gwip,mask,macaddr);  // 初始化 NetLib, 閉源方法
    ETH_Init(macaddr);                      // ETH傳送與接收的DMA設定, ETH中斷初始化, 啟動ETH
    return (s);
}

DHCP 的啟動方法 WCHNET_DHCPStart 是閉源的, 通過這個方法啟動 DHCP, 其引數是一個回撥函數, 用於 DHCP 結束(成功或失敗)時回撥

uint8_t WCHNET_DHCPStart( dhcp_callback dhcp );

範例專案中的回撥函數實現, 入參 arg 指標指向一片資料, 包含DHCP獲取的IP地址, 閘道器地址, IP掩碼等.

u8 WCHNET_DHCPCallBack(u8 status, void *arg)
{
    u8 *p;
    u8 tmp[4] = {0, 0, 0, 0};

    if(!status)                                                           // status = 0 表示成功
    {
        p = arg;
        printf("DHCP Success\r\n");

        if(!memcmp(IPAddr, p ,sizeof(IPAddr)))                            // 檢查輸入的IP與當前IP是否相同(結果為0, 要加!), 無變化則直接返回
            return READY;

        if(memcmp(IPAddr, tmp ,sizeof(IPAddr))){                          // 當前的IP是否已經設定(不等於0.0.0.0, 不為0), 說明IP產生了變化, 需要關閉當前 Socket
            WCHNET_SocketClose(SocketId, TCP_CLOSE_NORMAL);               // 關閉 Socket, 閉源方法
        }
        memcpy(IPAddr, p, 4);                                             // 從入參中讀取 IP, 閘道器, 掩碼
        memcpy(GWIPAddr, &p[4], 4);
        memcpy(IPMask, &p[8], 4);
        printf("IPAddr = %d.%d.%d.%d \r\n", (u16)IPAddr[0], (u16)IPAddr[1],
               (u16)IPAddr[2], (u16)IPAddr[3]);
        printf("GWIPAddr = %d.%d.%d.%d \r\n", (u16)GWIPAddr[0], (u16)GWIPAddr[1],
               (u16)GWIPAddr[2], (u16)GWIPAddr[3]);
        printf("IPAddr = %d.%d.%d.%d \r\n", (u16)IPMask[0], (u16)IPMask[1],
               (u16)IPMask[2], (u16)IPMask[3]);
        printf("DNS1: %d.%d.%d.%d \r\n", p[12], p[13], p[14], p[15]);
        printf("DNS2: %d.%d.%d.%d \r\n", p[16], p[17], p[18], p[19]);
        WCHNET_CreateTcpSocket();                                         // 建立 TCP Socket 並連線
        return READY;
    }
    else
    {
        printf("DHCP Fail %02x \r\n", status);

        if(memcmp(IPAddr, tmp ,sizeof(IPAddr))){                          // 對於失敗的狀態, 如果IP已經設定, 說明之前成功過, 需要關閉當前 Socket
            /*The obtained IP is different from the last value*/
            WCHNET_SocketClose(SocketId, TCP_CLOSE_NORMAL);               // 關閉 Socket, 閉源方法
        }
        return NoREADY;
    }
}

DHCP 獲取IP成功後呼叫的 WCHNET_CreateTcpSocket() 函數. 這個函數用於建立Socket建立目標IP的連線

void WCHNET_CreateTcpSocket(void)
{
    u8 i;
    SOCK_INF TmpSocketInf;

    memset((void *) &TmpSocketInf, 0, sizeof(SOCK_INF));
    memcpy((void *) TmpSocketInf.IPAddr, DESIP, 4);
    TmpSocketInf.DesPort = desport;
    TmpSocketInf.SourPort = srcport++;
    TmpSocketInf.ProtoType = PROTO_TYPE_TCP;
    TmpSocketInf.RecvBufLen = RECE_BUF_LEN;
    i = WCHNET_SocketCreat(&SocketId, &TmpSocketInf);   // 建立 Socket, 閉源方法
    printf("WCHNET_SocketCreat %d\r\n", SocketId);
    mStopIfError(i);
    i = WCHNET_SocketConnect(SocketId);                 // 建立連線, 閉源方法
    mStopIfError(i);
}

主迴圈

NetLib 初始化結束後, 在主迴圈中的處理

WCHNET_MainTask();              // 處理資料輸入, 協定棧定時任務, 檢查PHY Link狀態
if(WCHNET_QueryGlobalInt())     // 查詢全域性中斷狀態, 閉源方法
{
    WCHNET_HandleGlobalInt();
}

其中 WCHNET_MainTask 的定義

void WCHNET_MainTask(void)
{
    WCHNET_NetInput( );         /* Ethernet data input */
    WCHNET_PeriodicHandle( );   /* Protocol stack time-related task processing */
    WCHNET_HandlePhyNegotiation( );
}
  • 前兩個都是閉源方法, WCHNET_NetInput()處理資料輸入, WCHNET_PeriodicHandle()處理協定棧定時任務.
  • WCHNET_HandlePhyNegotiation() 就是前面提到的每隔50ms的定時任務, 用於PHY每隔50秒一次檢查Link狀態

最後是 WCHNET_HandleGlobalInt() 方法, 根據中斷型別, 分別處理

void WCHNET_HandleGlobalInt(void)
{
    u8 intstat;
    u16 i;
    u8 socketint;

    intstat = WCHNET_GetGlobalInt();                              // 讀取全境中斷狀態
    if (intstat & GINT_STAT_UNREACH)                              // Unreachable (無法到達)中斷
    {
        printf("GINT_STAT_UNREACH\r\n");
    }
    if (intstat & GINT_STAT_IP_CONFLI)                            // IP衝突中斷
    {
        printf("GINT_STAT_IP_CONFLI\r\n");
    }
    if (intstat & GINT_STAT_PHY_CHANGE)                           // PHY連線狀態變化中斷
    {
        i = WCHNET_GetPHYStatus();                                // 讀取新狀態, 閉源方法
        if (i & PHY_Linked_Status)
            printf("PHY Link Success\r\n");
    }
    if (intstat & GINT_STAT_SOCKET) {                             // Socket相關中斷
        for (i = 0; i < WCHNET_MAX_SOCKET_NUM; i++) {
            socketint = WCHNET_GetSocketInt(i);                   // 輪詢各個Socket中斷狀態, 如果存在中斷則處理
            if (socketint)
                WCHNET_HandleSockInt(i, socketint);               // 處理 Socket 的 接收, 連線, 斷開, 超時 事件
        }
    }
}

以上是對CH32V20xEVT 網路DHCP範例程式碼的分析. 詳細的NetLib函數說明在 CH32V20xEVT.ZIP 的 EVT/EXAM/ETH 目錄下.