本文轉自公眾號,歡迎關注

基于DWC2的USB驅動開發-0x0C 驅動框架設計 (qq.com)

一. 驅動架構

1.1 前言

前面我們介紹了DWC2的控制器相關的寄存器,驅動的編寫本質上就是進行寄存器的配置。為了代碼的健壯性，可移植性，可調試性等我們必須設計一個比較好的架構。對于驅動編程來說輸入就是各個寄存器,如果使用的都是DWC2的話甚至來說寄存器都是一樣的輸入就只需要寄存器基地址，即如果都是使用該IP的驅動甚至只要修改寄存器基地址，然后移植中斷等一些和SOC相關的內容即可復用。

1.2 架構框圖

整體的設計思想如下:

借鑒面向對象的設計的依賴倒置原則:

面向接口編程,不依賴具體實現編程,應用層不直接依賴具體實現而是依賴接口,上層調用接口底層實現接口,接口是硬件隔離的橋梁.

接口即對應上圖的HAL層。

硬件: 對于使用DWC2控制器的則還可以復用HW層本身的內容，只需要修改寄存器的基地址即可，因為DWC2控制器寄存器都是一樣的。另外需要修改一些和SOC相關的內容,比如中斷的設置。對于不同的控制器和SOC平臺的則需要根據具體的平臺進行封裝。理論上也可以直接依賴硬件實現HAL層，而不需要HW層的封裝，但是這樣的話直接在HAL層操作寄存器代碼的閱讀性上不佳。

HW層:即對頭文件中寄存器的操作進行封裝,主要采用宏的方式封裝,目的是為了可閱讀性。同時對于一些聯系緊密的操作放在一起進行封裝，比如初始化等，提供比如結構體參數等，進行相應的參數配置。這一層對于使用同樣的DWC2控制器的也完全可復用。

HAL層:這是硬件和上層隔離的一層，定義了一系列接口，協議棧調用該接口進行硬件操作，而HAL調用HW層實現上述的接口。對于不使用DWC2控制器的，則需要重新實現HAL層，而同使用DWC2控制器的則本層也通用。本層的設計原則是接口個數盡可能少和簡單但是要足夠滿足協議棧層的需要。符合面向對象設計的最少知道原則。

協議棧層:依賴HAL接口，實現USB規格書規定的協議。

協議棧和HAL層以及以下的層次，盡可能不進行資源分配(比如內存)等預留相應的接口，資源分配由應用層實現，這樣設計的目的是在嵌入式開發環境資源往往受限，資源的分配往往需要應用層來把控，應用層來負責。底層盡可能少的依賴資源，盡可能保持確定性，避免過多動態行為。

應用層:調用協議棧實現具體的應用功能。

考慮到通用性和可移植性,我們要支持OS和無OS的實現，所以非必要不依賴OS相關的API，如果不可避免則盡可能少依賴，且實現需要依賴的API的OS和NONE-OS版本，將依賴抽離出來作為需要移植實現的部分,使得在不同OS和裸機下都能運行，這里會涉及到協議棧基于中斷驅動的處理方式和基于事件驅動的處理方式兩種實現，后面到協議棧設計部分再說。

1.3 調試方案

調試手段是驅動開發中需要重點考慮的一環，沒有合適的調試手段，遇到問題，會兩眼一抹黑完全無從下手。進行USB開發，硬件上示波器和協議分析儀是必須的。另外軟件上也需要一些手段配合調試。以下是幾種常見的方式。

1.3.1 仿真器

這是嵌入式開發必須的，尤其是驅動開發階段，需要跟蹤代碼流，寄存器的配置，變量的值等等。仿真器調試有個問題就是需要中斷正常的程序流.USB是一個有著嚴格時序要求，且高速的協議，程序中斷會導致USB的處理過程由于超時等導致異常，所以很多時候不能通過仿真器打斷點等方式進行調試。

1.3.2 IO

USB由于其嚴格的時序要求，且高速的處理，很多時候我們需要測試相應的處理時間，使用定時器進行計時并打印時間是一種方法，但是對于高精度計時定時器的處理代碼本身需要時間會帶來誤差。這時使用IO翻轉，來指示某種狀態的變化非常有用，比如測試SOF之間的時間，可以在SOF中斷中翻轉IO，使用示波器或者邏輯分析儀測量波形即可。翻轉IO往往一條指令即可，這使得代碼帶來的誤差減小。

更重要的是可以通過多個IO關聯多個事件，看到多個事件之間的關聯關系，尤其是使用示波器和邏輯分析儀查看時。曲線會非常直觀。這是使用定時器打印所不具備的。

IO翻轉的調試方法是嵌入式實時分析中重要的手段。

1.3.3 串口打印

USB的處理流程對應著狀態的流轉，實際對于軟件來說過是各種中斷的進入與退出。使用仿真器跟蹤會破壞USB的處理流程導致超時等，所以需要一個非中斷方式的跟蹤事件的方式。常見的方式是使用串口打印，這里要注意串口打印不能使用阻塞方式，否則同樣的會導致USB處理流的異常。一般采用緩沖區的方式，打印接口將數據寫入緩沖區，主循環或者其他線程中將緩沖區的數據通過串口發送。

當然除了串口打印還有很多其他類似的方式比如 Jlink提供的rtt等性能更高，也可以使用網口等接口，根據具體平臺而定。

串口打印可是設置為宏的方式，debug版本使能，release版本可不使能，打印輸出也可以設置等級和類別，這樣通過等級和類別控制輸出，避免一次打印過多干擾分析，也可以使用CLI動態配置等級可列別的控制。

如下是一個簡單的示例，依賴printf，假設printf已經實現是一個非阻塞的版本(即寫入緩沖區)，其他地方再真正的發送數據。可以通過宏配置不同等級的LOG,且打印信息對應不同的顏色。

頭文件中

#define USB_HAL_DEBUG 1
#define USB_HAL_LOG_LEVEL_ERROR 1
#define USB_HAL_LOG_LEVEL_WARN 1
#define USB_HAL_LOG_LEVEL_INFO 1


/** Debug levels */
typedef enum 
{
    USB_HAL_DEBUG_ERROR = 0,
    USB_HAL_DEBUG_WARN  = 1,
    USB_HAL_DEBUG_INFO  = 2,
}USB_HAL_DEBUG_e;


#define USB_HAL_DEBUG_COLOR_MASK_COLOR  0x0F
#define USB_HAL_DEBUG_COLOR_MASK_MODIFIER   0xF0


typedef enum {
    /* Colors */
    USB_HAL_DEBUG_COLOR_RESET       = 0xF0,
    USB_HAL_DEBUG_COLOR_BLACK       = 0x01,
    USB_HAL_DEBUG_COLOR_RED     = 0x02,
    USB_HAL_DEBUG_COLOR_GREEN       = 0x03,
    USB_HAL_DEBUG_COLOR_YELLOW  = 0x04,
    USB_HAL_DEBUG_COLOR_BLUE        = 0x05,
    USB_HAL_DEBUG_COLOR_MAGENTA = 0x06,
    USB_HAL_DEBUG_COLOR_CYAN        = 0x07,
    USB_HAL_DEBUG_COLOR_WHITE       = 0x08,
    /* Modifiers */
    USB_HAL_DEBUG_COLOR_NORMAL  = 0x0F,
    USB_HAL_DEBUG_COLOR_BOLD        = 0x10,
    USB_HAL_DEBUG_COLOR_UNDERLINE   = 0x20,
    USB_HAL_DEBUG_COLOR_BLINK       = 0x30,
    USB_HAL_DEBUG_COLOR_HIDE        = 0x40,
} USB_HAL_DEBUG_COLOR_e;


void usb_hal_do_debug(USB_HAL_DEBUG_e level, const char *format, ...);


#ifdef USB_HAL_DEBUG
    #define usb_hal_debug(level, format, ...) do { usb_hal_do_debug(level, format, ##__VA_ARGS__); } while(0)
#else
    #define usb_hal_debug(...) do {} while (0)
#endif


#ifdef USB_HAL_LOG_LEVEL_ERROR
    #define usb_hal_error(format, ...) usb_hal_debug(USB_HAL_DEBUG_ERROR, format, ##__VA_ARGS__)
#else
    #define usb_hal_error(...) do {} while (0)
#endif


#ifdef USB_HAL_LOG_LEVEL_WARN
    #define usb_hal_warn(format, ...) usb_hal_debug(USB_HAL_DEBUG_WARN, format, ##__VA_ARGS__)
#else
    #define usb_hal_warn(...) do {} while (0)
#endif


#ifdef USB_HAL_LOG_LEVEL_INFO
    #define usb_hal_info(format, ...) usb_hal_debug(USB_HAL_DEBUG_INFO, format, ##__VA_ARGS__)
#else
    #define usb_hal_info(...) do {} while (0)
#endif

c文件中

static void usb_hal_set_color(uint32_t color) 
{


    unsigned int color_code, modifier_code;
    switch (color & USB_HAL_DEBUG_COLOR_MASK_COLOR) 
    {
        case USB_HAL_DEBUG_COLOR_BLACK:
            color_code = 30; break;
        case USB_HAL_DEBUG_COLOR_RED:
            color_code = 31; break;
        case USB_HAL_DEBUG_COLOR_GREEN:
            color_code = 32; break;
        case USB_HAL_DEBUG_COLOR_YELLOW:
            color_code = 33; break;
        case USB_HAL_DEBUG_COLOR_BLUE:
            color_code = 34; break;
        case USB_HAL_DEBUG_COLOR_MAGENTA:
            color_code = 35; break;
        case USB_HAL_DEBUG_COLOR_CYAN:
            color_code = 36; break;
        case USB_HAL_DEBUG_COLOR_WHITE:
            color_code = 37; break;
        case USB_HAL_DEBUG_COLOR_RESET:
        default:
            color_code = 0; break;
    }
    
    switch (color & USB_HAL_DEBUG_COLOR_MASK_MODIFIER) 
    {
        case USB_HAL_DEBUG_COLOR_BOLD:
            modifier_code = 1; break;
        case USB_HAL_DEBUG_COLOR_UNDERLINE:
            modifier_code = 2; break;
        case USB_HAL_DEBUG_COLOR_BLINK:
            modifier_code = 3; break;
        case USB_HAL_DEBUG_COLOR_HIDE:
            modifier_code = 4; break;
        case USB_HAL_DEBUG_COLOR_NORMAL:
        default:
            modifier_code = 0; break;
    }


    printf("\\\\033[%u;%um", modifier_code, color_code);
}


void usb_hal_do_debug(USB_HAL_DEBUG_e level, const char *format, ...)
{
    uint32_t color = USB_HAL_DEBUG_COLOR_RESET;
    va_list args;


    switch(level) 
    {
    case USB_HAL_DEBUG_INFO:
        color = USB_HAL_DEBUG_COLOR_GREEN | USB_HAL_DEBUG_COLOR_BOLD;
        break;
    case USB_HAL_DEBUG_ERROR:
        color = USB_HAL_DEBUG_COLOR_RED | USB_HAL_DEBUG_COLOR_BOLD;
        break;
    case USB_HAL_DEBUG_WARN:
        color = USB_HAL_DEBUG_COLOR_YELLOW | USB_HAL_DEBUG_COLOR_BOLD;
        break;
    default:
        return;
    }
    va_start(args, format);
    usb_hal_set_color(color);


    vprintf(format, args);


    //printf("\\\\r\\\\n");
    usb_hal_set_color(USB_HAL_DEBUG_COLOR_RESET);


    va_end(args);
}

1.4 總結

以上從整體上設計了整個的驅動框架，重點考慮可移植性，可維護性等原則，借鑒面向對象的一些設計思想和原則。同時提供了一些調試方案供參考。前面磨刀已經磨了很久了，后面我們就開始正式進入編程階段了。

審核編輯 黃宇