某設備需要提供多路USB串口的功能給主機端使用,比如一路用作業務1通信功能,一路用作業務2通信功能,一路用作debug抓log用途,諸如此類。如下圖所示。
要實現上述設備功能,可以參考如下步驟。
1)首先,了解一下背景知識。Linux kernel為設備端USB驅動提供了名為USB Gadget的驅動框架,設備端要基於Linux系統實現USB device功能,都需要基於Gadget框架。各種USB class定義的功能,在設備端的實現,稱之為USB function。常見的USB function,比如 serial, ecm, storage, video, audio等,kernel原生代碼都已經實現了。產品開發的大部分工作是放在理解並使用這些代碼,並調試可能出現的bug;以及針對某些usb controller的特性,需要在function driver層面處理的時候,打一些補丁,當然這種補丁是很難合入kernel社區的,只能是在自家的產品上用用。
2)其次,了解一下gadget驅動代碼目錄結構。如下圖所示。
gadget驅動包含三大部分:
-
function驅動 —— 實現各種usb class功能
-
udc驅動 —— 實現usb controller driver
-
輔助驅動 —— configfs.c實現用戶空間配置usb, composite.c實現復合設備
進入function目錄,可以看到各種已經實現的function,接下來我們要用到的serial function也在其中。
3)了解具體如何開啟usb串口的功能。其實很簡單,要開啟usb serial function driver,在kernel config中開啟以下CONFIG即可:
CONFIG_USB_GADGET=y
CONFIG_USB_U_SERIAL=y
CONFIG_USB_F_SERIAL=y
開啟以上CONFIG后,只是打開了usb driver支持serial的能力;要生成多路串口,還需要通過configfs動態配置相關功能,以下就是生成三路USB generic serial串口的示例:
mkdir -p /sys/kernel/config/usb_gadget/g1/functions/gser.gs0 chmod 755 /sys/kernel/config/usb_gadget/g1/functions/gser.gs0 mkdir -p /sys/kernel/config/usb_gadget/g1/functions/gser.gs1 chmod 755 /sys/kernel/config/usb_gadget/g1/functions/gser.gs1 mkdir -p /sys/kernel/config/usb_gadget/g1/functions/gser.gs2 chmod 755 /sys/kernel/config/usb_gadget/g1/functions/gser.gs2 ln -s /sys/kernel/config/usb_gadget/g1/functions/gser.gs2 /sys/kernel/config/usb_gadget/g1/configs/b.1/f1 ln -s /sys/kernel/config/usb_gadget/g1/functions/gser.gs0 /sys/kernel/config/usb_gadget/g1/configs/b.1/f2 ln -s /sys/kernel/config/usb_gadget/g1/functions/gser.gs1 /sys/kernel/config/usb_gadget/g1/configs/b.1/f3
configfs本身的介紹,可參考kernel文檔:
Documentation\filesystems\configfs\configfs.txt
USB gadget configfs的使用介紹,可以參考kernel文檔:
Documentation\ABI\testing\configfs-usb-gadget
Documentation\ABI\testing\configfs-usb-gadget-serial
三路USB串口啟用成功后,在設備端會生成三個ttyGS設備:
-
/dev/ttyGS0
-
/dev/ttyGS1
-
/dev/ttyGS2
4)主機端看到的情況
主機端識別USB串口和加載相關驅動的方法,可以參考我的另一篇文章
這里主要講一講主機端生成了多個名為ttyUSBx(x=0~n)的設備,我們如何確定它們與設備端多路USB串口(ttyGSx)的對應關系?
方法之一,當然可以通過遍歷測試串口通信的方式來找到對應關系。比如主機端用串口工具或者echo指令發送數據,設備端用串口工具或者cat指令接收數據,一個一個遍歷嘗試,能正常通信的,就說明兩邊是對應的。
方法之二,通過主機端和設備端的USB interface number (接口號)找到對應關系。以Ubuntu主機為例:
在Ubuntu端執行 ls -l /sys/class/tty/ttyUSB*,可以看到ttyUSBx和USB接口號的對應關系。比如ttyUSB1對應3-6:1.2,這個末尾的數字2就表示接口2(簡稱f2)。
user@PC1002:~$ ls -l /sys/class/tty/ttyUSB* lrwxrwxrwx 1 root root 0 5月 21 13:15 /sys/class/tty/ttyUSB0 -> ../../devices/pci0000:00/0000:00:14.0/usb3/3-6/3-6:1.1/ttyUSB0/tty/ttyUSB0 lrwxrwxrwx 1 root root 0 5月 21 13:15 /sys/class/tty/ttyUSB1 -> ../../devices/pci0000:00/0000:00:14.0/usb3/3-6/3-6:1.2/ttyUSB1/tty/ttyUSB1 lrwxrwxrwx 1 root root 0 5月 21 13:15 /sys/class/tty/ttyUSB2 -> ../../devices/pci0000:00/0000:00:14.0/usb3/3-6/3-6:1.3/ttyUSB2/tty/ttyUSB2
類似的,在設備端也可以獲得ttyGSx與接口號的對應關系。進入設備端shell,執行如下指令。
ls -l /sys/kernel/config/usb_gadget/g1/configs/b.1/ -rw-r--r-- 1 root root 4096 May 4 10:40 MaxPower -rw-r--r-- 1 root root 4096 May 4 10:40 bmAttributes lrwxrwxrwx 1 root root 0 May 4 10:40 f1 -> ../../../../usb_gadget/g1/functions/gser.gs2 lrwxrwxrwx 1 root root 0 May 4 10:40 f2 -> ../../../../usb_gadget/g1/functions/gser.gs0 lrwxrwxrwx 1 root root 0 May 4 10:40 f3 -> ../../../../usb_gadget/g1/functions/gser.gs1
可以看到f2對應gser.gs0,表示gser.gs0對應接口2。那么gser.gs0是不是一定就與ttyGS0對應呢?先說答案,不一定。准確的做法是讀取gser.gs0目錄下的port_num的值來獲知是ttyGS幾。比如port_num是0,那就說明gser.gs0對應/dev/ttyGS0,如果port_num是1,那就說明gser.gs0對應/dev/ttyGS1。
cat /sys/kernel/config/usb_gadget/g1/functions/gser.gs0/port_num 0
這里假定gser.gs0對應/dev/ttyGS0,那么到此就可以得知主機和設備的對應關系:ttyUSB1對應ttyGS0。如果設備端的業務2代碼是通過讀寫/dev/ttyGS0來實現通信,那么主機端的業務2代碼就需要通過讀寫/dev/ttyUSB1來實現和設備端業務2的交互。
至於port_num編號的背后規律,與每個gser.gsN這個末尾數字N無關;與我們前面編寫configfs配置USB的指令時,mkdir指令執行的次序有關,port_num從0開始,依次+1。從我們前面的編寫的指令看,先mkdir gser.gs0,再mkdir gser.gs1,那么gser.gs0的port_num是0,gser.gs1的port_num就是1。如果先mkdir gser.gs1,再mkdir gser.gs0,那么就會反過來,gser.gs1的port_num是0,gser.gs0的port_num是1。
5)USB gadget serial function的驅動實現細節,不是本文的重點,暫且不講,后續會專門介紹USB gadget function driver。
以上是本文全部內容,謝謝閱讀,希望能幫到你。
文章會在公眾號“大魚嵌入式”同步發布,歡迎關注,一起交流。