天天看點
傳回

USB驅動程式設計(4)—Linux USB驅動程式設計

1.USB驅動模型

USB驅動程式設計(4)—Linux USB驅動程式設計
  • USB裝置包括配置(configuration)、接口（interface）和端點(endpoint)，一個USB裝置驅動程式對應一個USB接口，而非整個USB裝置。比如說一個MP4的播放裝置，他可以播放視訊、也可以播放聲音，這2個功能稱為一個接口，而每一個驅動隻能驅動一個接口，是以如果需要同時播放視訊和音頻則需要2個驅動程式。
  •  在Linux核心中，使用struct usb_driver結構描述一個USB驅動： 
struct usb_driver {
const char *name; /*驅動程式名*/
 
/* 當USB核心發現了該驅動能夠處理的USB接口時，調用該函數 */
int (*probe) (struct usb_interface *intf, const struct usb_device_id *id);
 
/* 當相應的USB接口被移除時，調用該函數 */
void (*disconnect) (struct usb_interface *intf);
 
/* USB驅動能夠處理的裝置清單 */
const struct usb_device_id *id_table;
}
  • id_table裡面記錄了這個驅動支援的裝置清單，一個裝置ID有vendID和deviceID來标記。如果USB驅動在加載的時候，在Linux中發現了它支援的裝置将會調用probe函數。

 2.URB通訊模型

  • USB主機和USB裝置之間的通信是通過主機請求的方式來完成的，我們先看下面這一幅圖
USB驅動程式設計(4)—Linux USB驅動程式設計
  • 主機向裝置送出請求，然後裝置響應請求。發起請求的源是usb client driver，然後提供給usb core，接着傳給usb host controller driver，最後通過主要制器發給usb裝置。主要器收到響應後按原路傳回，交給usb client driver。usb請求是通過核心中的URB來描述的。

 2.1 URB請求塊

  • USB請求塊（USB request block-URB）是USB裝置驅動中用來與USB裝置通信所用的基本載體和核心資料結構，非常類似于網絡裝置驅動中的sk_buff結構體，是USB主機與裝置通信的“電波”。
  • USB的通信模型如下：
    • 1. USB裝置驅動程式建立并初始化一個通路特定端點的urb，并送出給USB core；
    • 2. USB core送出該urb到USB主要制器驅動程式；
    • 3. USB主要制器驅動程式根據該urb描述的資訊，來通路USB裝置；
    • 4. 當裝置通路結束後，USB主要制器驅動程式按原來傳回，通過usb core來通知USB裝置驅動程式。

 2.2 建立URB

struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags)
  • 參數：
  • iso_packets：urb所包含的等時資料包的個數。
  • mem_flags：記憶體配置設定辨別(如GFP_KERNEL)，參考kmalloc。

 2.3 初始化URB

  • 對于中斷urb，使用usb_fill_int_urb函數來初始化
  • 對于批量urb，使用usb_fill_bulk_urb函數來初始化
  • 對于控制urb，使用usb_fill_control_urb函數來初始化
  • 對于等時urb，隻能手動地初始化urb。 
static inline void usb_fill_int_urb(
struct urb *urb, // 待初始化的urb
struct usb_device *dev, // urb所要通路的裝置
unsigned int pipe, // 要通路的端點所對應的管道，
void *transfer_buffer, // 儲存傳輸資料的buffer
int buffer_length, // buffer長度
usb_complete_t complete_fn, // urb完成時調用的函數
void *context, // 指派到urb->context的資料
int interval) // urb被排程的時間間隔

2.4 送出URB

  • 在完成urb的建立和初始化後，USB驅動需要将urb送出給USB核心，URB被送出到USB核心後，USB核心指定usb主要制器驅動程式來處理該urb，處理完之後，urb完成函數将被調用。 
int usb_submit_urb(struct urb *urb, gfp_t mem_flags)
  • 參數：
  • urb：要送出urb的指針
  • mem_flags：記憶體配置設定辨別(如GFP_KERNEL)，參考kmalloc

3.HID協定

  • HID(Human Interface Device)， 屬于人機互動類的裝置， 如USB滑鼠，USB鍵盤，USB遊戲操縱杆等。該類裝置必須遵循HID設計規範。
  • 我們在使用滑鼠的時候會發現，不管插入那個品牌的滑鼠都可以被電腦識别到并且通路。這是因為所有的滑鼠都遵循一個規範，這個規範就是HID協定了。
USB驅動程式設計(4)—Linux USB驅動程式設計
  • 對于滑鼠來講，HID規範了它傳輸資料的格式。滑鼠的一次傳輸成為報告描述符，它包含4個位元組：
  • 第一個位元組首先是5個bit的填充，然後是3個bit的按鈕資訊，也就是左鍵、右鍵、滾輪了。
  • 接下來的3個位元組分别是X、Y坐标和滾輪資訊。
  • 具體的協定可以參考HID的協定文檔，比如說這個滑鼠裝置：
USB驅動程式設計(4)—Linux USB驅動程式設計
  • 我們這裡着重分析Input，不過對于每個Input需要從下往上看。比如第一個Input，他有3個資訊，每個資訊的大小是1位、代表的是按鈕資訊。然後第二個Input是5個bit的填充。最後一個Input是X、Y軸的資訊，它有2個，每個大小是8個bit、最小值是-127，最大值是127。（這裡的順序好像沒有和上一幅圖對應上，并且少了一個滾輪資訊，可能是這個協定文檔太老了吧）

4.滑鼠驅動分析

static struct usb_driver usb_mouse_driver = {
	.name		= "usbmouse",   /* 驅動名 */
	.probe		= usb_mouse_probe, /* 捕獲函數 */
	.disconnect	= usb_mouse_disconnect, /* 解除安裝函數 */
	.id_table	= usb_mouse_id_table, /* 裝置清單 */
};
 
static int __init usb_mouse_init(void)
{
	/* 注冊滑鼠驅動程式 */
	int retval = usb_register(&usb_mouse_driver);
	if (retval == 0)
		printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
				DRIVER_DESC "\n");
	return retval;
}
 
static void __exit usb_mouse_exit(void)
{
	usb_deregister(&usb_mouse_driver);
}
 
module_init(usb_mouse_init);
module_exit(usb_mouse_exit);
  • 在子產品初始化函數中，隻做了注冊滑鼠驅動這一件事、在子產品退出函數中則登出了這個驅動。一個USB滑鼠的驅usb_mouse_driver 來定義。當在系統中發現了裝置清單中支援的裝置時，将會調用usb_mouse_probe這個函數，我們接下來分析這個函數。 
static int usb_mouse_probe(struct usb_interface *intf, const struct usb_device_id *id)
{
	/* 裝置描述 usb_device */
	/* 接口描述 usb_interface */
	struct usb_device *dev = interface_to_usbdev(intf); 
	
	/* 接口設定描述 */
	struct usb_host_interface *interface;
	
	/* 端點描述符 */
	struct usb_endpoint_descriptor *endpoint;
		
	struct usb_mouse *mouse;
	struct input_dev *input_dev;
	int pipe, maxp;
	int error = -ENOMEM;
 
	/* 擷取目前接口設定 */
	interface = intf->cur_altsetting;
 
　　   /* 根據HID規範，滑鼠隻有一個端點（不包含0号控制端點）*/
	if (interface->desc.bNumEndpoints != 1)
		return -ENODEV;
 
	/* 擷取端點0描述符 */
	endpoint = &interface->endpoint[0].desc;
	
	/* 根據HID規範，滑鼠唯一的端點應為中斷端點 */
	if (!usb_endpoint_is_int_in(endpoint))
		return -ENODEV;
 
	/* 生成中斷管道 */
	pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
	
	/* 傳回該端點能夠傳輸的最大的包長度，滑鼠的傳回的最大資料包為4個位元組。*/  
	maxp = usb_maxpacket(dev, pipe, usb_pipeout(pipe));
 
	/* 建立input裝置 */
	mouse = kzalloc(sizeof(struct usb_mouse), GFP_KERNEL);
	input_dev = input_allocate_device();
	if (!mouse || !input_dev)
		goto fail1;
 
   	/* 申請記憶體空間用于資料傳輸，data 為指向該空間的位址*/
	mouse->data = usb_buffer_alloc(dev, 8, GFP_ATOMIC, &mouse->data_dma);
	if (!mouse->data)
		goto fail1;
	
	/* 配置設定URB */
	mouse->irq = usb_alloc_urb(0, GFP_KERNEL);
	if (!mouse->irq)
		goto fail2;
 
	mouse->usbdev = dev;
	mouse->dev = input_dev;
 
	if (dev->manufacturer)
		strlcpy(mouse->name, dev->manufacturer, sizeof(mouse->name));
 
	if (dev->product) {
		if (dev->manufacturer)
			strlcat(mouse->name, " ", sizeof(mouse->name));
		strlcat(mouse->name, dev->product, sizeof(mouse->name));
	}
 
	if (!strlen(mouse->name))
		snprintf(mouse->name, sizeof(mouse->name),
			 "USB HIDBP Mouse %04x:%04x",
			 le16_to_cpu(dev->descriptor.idVendor),
			 le16_to_cpu(dev->descriptor.idProduct));
 
	/* usb_make_path 用來擷取 USB 裝置在 Sysfs 中的路徑*/
	usb_make_path(dev, mouse->phys, sizeof(mouse->phys));
	
	strlcat(mouse->phys, "/input0", sizeof(mouse->phys));
 
	/* 字元裝置初始化 */
	input_dev->name = mouse->name;
	input_dev->phys = mouse->phys;
	usb_to_input_id(dev, &input_dev->id);
	input_dev->dev.parent = &intf->dev;
 
	input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
	input_dev->keybit[BIT_WORD(BTN_MOUSE)] = BIT_MASK(BTN_LEFT) |
		BIT_MASK(BTN_RIGHT) | BIT_MASK(BTN_MIDDLE);
	input_dev->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y);
	input_dev->keybit[BIT_WORD(BTN_MOUSE)] |= BIT_MASK(BTN_SIDE) |
		BIT_MASK(BTN_EXTRA);
	input_dev->relbit[0] |= BIT_MASK(REL_WHEEL);
 
	input_set_drvdata(input_dev, mouse);
 
	input_dev->open = usb_mouse_open;
	input_dev->close = usb_mouse_close;
 
	/* 初始化中斷URB */
	/* 思考實驗：将interval參數設定為1分鐘，觀察現象 */
	usb_fill_int_urb(mouse->irq, dev, pipe, mouse->data,
			 (maxp > 8 ? 8 : maxp),
			 usb_mouse_irq, mouse, endpoint->bInterval);
	mouse->irq->transfer_dma = mouse->data_dma;
	mouse->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 
	error = input_register_device(mouse->dev);
	if (error)
		goto fail3;
 
	/*将mouse指針儲存到intf的dev成員中*/
	usb_set_intfdata(intf, mouse);
	return 0;
 
fail3:	
	usb_free_urb(mouse->irq);
fail2:	
	usb_buffer_free(dev, 8, mouse->data, mouse->data_dma);
fail1:	
	input_free_device(input_dev);
	kfree(mouse);
	return error;
}

  在probe函數中主要圍繞這幾個點構成，首先是URB。

  • 配置設定URB，由 mouse->irq = usb_alloc_urb(0, GFP_KERNEL)；來完成。
  • 初始化URB，由以下函數來完成。 
usb_fill_int_urb(mouse->irq, dev, pipe, mouse->data,
			 (maxp > 8 ? 8 : maxp),
			 usb_mouse_irq, mouse, endpoint->bInterval);
  • 第一個參數是URB結構。
  • 第二個參數是dev裝置檔案，裝置檔案通過參數來擷取struct usb_device *dev = interface_to_usbdev(intf);
  • 第三個參數是pipe，用來通信的管道，通過pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress)；來生成一個中斷pipe，這裡面的第二個參數是USB裝置裡面的端點，這個端點通過接口擷取到endpoint = &interface->endpoint[0].desc；接口又通過傳入的參數來擷取。
  • 第四個參數是存放資料的緩存，這個額緩存位址這樣來擷取mouse->data = usb_buffer_alloc(dev, 8, GFP_ATOMIC, &mouse->data_dma);
  • 第五個參數是該端點能夠傳輸的最大長度，最大是4個位元組，它這樣來擷取，maxp = usb_maxpacket(dev, pipe, usb_pipeout(pipe))
  • 第六個參數是傳輸完成後的回調函數，回調函數是usb_mouse_irq
  • 第七個參數指派給urb->context的資料
  • 最後一個參數是請求的資料的間隔。

  但是這裡面并沒有送出URB這個函數，他在什麼時候送出呢？他在打開USB滑鼠裝置檔案的時候送出。

static int usb_mouse_open(struct input_dev *dev)
{
	struct usb_mouse *mouse = input_get_drvdata(dev);

	mouse->irq->dev = mouse->usbdev;
	if (usb_submit_urb(mouse->irq, GFP_KERNEL))
		return -EIO;

	return 0;
}
  • 從功能的角度來看，滑鼠還是一個輸入裝置，是以probe函數裡面，還有另一條主線，就是輸入型裝置的注冊。這裡就不再詳細介紹了。這樣proc函數就完成了。
  •  當我們的URB送出之後，滑鼠就最做相應的處理，當滑鼠把資料回傳之後，就會調用usb_mouse_irq完成函數，這個函數定義如下： 
static void usb_mouse_irq(struct urb *urb)
{
	struct usb_mouse *mouse = urb->context;
	signed char *data = mouse->data;
	struct input_dev *dev = mouse->dev;
	int status;
 
	/* 檢測urb傳輸是否成功 */
	switch (urb->status) {
	case 0:			/* success */
		break;
	case -ECONNRESET:	/* unlink */
	case -ENOENT:
	case -ESHUTDOWN:
		return;
	/* -EPIPE:  should clear the halt */
	default:		/* error */
		goto resubmit;
	}
 
	/* 報告按鍵狀态 */
	input_report_key(dev, BTN_LEFT,   data[0] & 0x01);
	input_report_key(dev, BTN_RIGHT,  data[0] & 0x02);
	input_report_key(dev, BTN_MIDDLE, data[0] & 0x04);
	input_report_key(dev, BTN_SIDE,   data[0] & 0x08);
	input_report_key(dev, BTN_EXTRA,  data[0] & 0x10);
 
	input_report_rel(dev, REL_X,     data[1]);
	input_report_rel(dev, REL_Y,     data[2]);
	input_report_rel(dev, REL_WHEEL, data[3]);
 
	input_sync(dev);
resubmit:
	/* 送出下次傳輸 */
	status = usb_submit_urb (urb, GFP_ATOMIC);
	if (status)
		err ("can't resubmit intr, %s-%s/input0, status %d",
				mouse->usbdev->bus->bus_name,
				mouse->usbdev->devpath, status);
}
  • 這個函數裡面首先要判斷URB傳輸是否成功，然後把資料從mouse裡面剝離出來。 
struct usb_mouse *mouse = urb->context;
signed char *data = mouse->data;
  • 剝離資料之後需要把資料上報： 
/* 報告按鍵狀态 */
input_report_key(dev, BTN_LEFT,   data[0] & 0x01);
input_report_key(dev, BTN_RIGHT,  data[0] & 0x02);
input_report_key(dev, BTN_MIDDLE, data[0] & 0x04);
input_report_key(dev, BTN_SIDE,   data[0] & 0x08);
input_report_key(dev, BTN_EXTRA,  data[0] & 0x10);
 
input_report_rel(dev, REL_X,     data[1]);
input_report_rel(dev, REL_Y,     data[2]);
input_report_rel(dev, REL_WHEEL, data[3]);
 
input_sync(dev);
  • 可以看到這裡資料的剝離和我們所講的滑鼠的資料協定自一緻的。
  • 第0個位元組提取出滑鼠左鍵、右鍵、中間鍵的資訊
  • 第1、2、3個位元組提取出X軸、Y軸、滾輪的資訊。
  • 把目前資料上報之後，又開始下一次的URB請求了。
Linux底層驅動
上一篇: Titan 的設計與實作
下一篇: 寫給自己的筆記 ~2017~

繼續閱讀