Linux USB驱动程序设计

Linux USB驱动程序设计

1. USB发展史

USB(Universal Serial Bus )，通用串行总线，是一种外部总线标准，用于规范电脑与外部设备的连接和通讯。
USB是在1994年底由英特尔、康柏、IBM、Microsoft等多家公司联合提出的，自1996年推出后，已成功替代串口和并口，成为当今个人电脑和大量智能设备的必配接口之一。
•USB 1.0出现在1996年的，速度只有1.5Mb/s1998年升级为USB 1.1，速度也提升到12Mb/s，称之为”full speed”
•USB 2.0规范是由USB1.1规范演变而来的。它的传输速率达到了480Mbps，称之为”high speed”
•USB 3.0提供了十倍于USB 2.0的传输速度和更高的节能效率，被称为”super speed”

2. USB信号线

3. USB系统拓扑结构

对于每个USB系统来说，都有一个称为主机控制器的设备，该控制器和一个根Hub作为一个整体。这个根Hub下可以接多级的Hub，每个子Hub又可以接子Hub。每个USB设备作为一个节点接在不同级别的Hub上。每条USB总线上最多可以接127个设备。
常见的USB主控制器规格有：
OHCI：主要是非PC系统上的USB芯片
UHCI：大多是Intel和Via主板上的USB控制器芯片。他们都是由USB1.1规格的。
EHCI是有Intel等几个厂商研发，兼容OHCI 、UHCI ，遵循USB2.0规范。

2. USB协议分析

在USB设备的逻辑组织中，包含设备、配置、接口和端点4个层次。设备通常有一个或者多个配置，配置通常有一个或多个接口，接口有0或多个端点。

设备逻辑结构：

每个USB设备都可以包含一个或多个配置，不同的配置使设备表现出不同的功能组合，配置有多个接口组成，在USB协议中，接口代表一个基本的功能，一个功能复杂的USB设备可以具有多个接口，而接口是端点的汇集。

一个USB播放器带有音频，视频功能，还有旋钮和按钮。

配置1：音频（接口）+ 旋钮（接口）

配置2：视频（接口）+ 旋钮（接口）

配置3：音频（接口）+ 视频（接口） + 按钮（接口）

音频接口，视频接口，按钮接口， 旋钮接口均需要一个驱动程序。

USB设备中的唯一可寻址的部分是设备端点，端点的作用类似于寄存器。每个端点在设备内部有唯一的端点号，这个端点号是在设备设计时给定的。主机和设备的通信最终都作用于设备上的各个端点。每个端点所支持的操作都是单向的，要么只读，要么只写。

USB描述符

当我们把USB设备插到我们的PC时，主机能够自动识别出我们的USB设备类型？？？

在每一个USB设备内部，包含的固定格式的数据，通过这些数据，USB主机就可以获取USB设备的类型、生产厂商等信息。这些固定格式的数据我们就称之为USB描述符。标准的USB设备有5种USB描述符：

设备描述符、配置描述符、接口描述符、端点描述符、字符串描述符

一个USB设备只有一个设备描述符，设备描述符长度为18个字节，

USB配置描述符长度为8个字节，格式可以百度得到，这里介绍每个字节的的含义

接口描述符8个字节

usb端点描述符：

2 USB数据通讯：

2.1. 通讯模型

2.2. 传输

USB的数据通讯首先是基于传输（Transfer）的，传输的类型有：中断传输，批量传输，同步传输，控制传输

2.3. 事物

一次传输由一个或多个事物（Transaction）构成，事务可分为：In 事务，Out事务，Setup事务

2.4. 包

一个事务由一个或多个包构成，包可分为：令牌包（setup）、数据包（data）、握手包（ACK）和特殊包

2.5. 域

一个包由多个域构成，域可分为：同步域（SYNC），标识域（PID），地址域，端点域（ENDP）,帧号（FRAM），数据域（DATA），校验域（CRC）。

3. USB设备枚举

USB设备在正常工作以前, 第一件要做的事就是枚举。枚举是让主机认得这个USB设备, 并且为该设备准备资源，建立好主机和设备之间的数据传递通道。

这里展示一个USB抓包工具抓的鼠标USB 数据包

下面来介绍USB软件系统架构

上面两个框框代表了两种USB架构模型 第一种是比如开发板上通过USB挂载U盘，第二种是开发板直接通过usb连PC机,通过配置内核选项可以将USB接口模拟网口与PC机进行通信！

USB驱动程序设计

1. USB驱动模型

USB设备包括配置、接口和端点，一个USB设备驱动程序对应一个USB接口，而非整个USB设备

在Linux内核中，使用struct usb_driver结构描述一个USB驱动

2. URB

        2.1 URB通讯模型

          

       USB请求块（USB request block-URB）是USB设备驱动中用来与USB设备通信所用的基本载体和核心数据结            构，非常类似于网络设备驱动中的sk_buff结构体，是USB主机与设备通信的“电波”。
       1. USB 设备驱动程序创建并初始化一个访问特定端点的urb，并提交给USB core；
         2. USB core提交该urb到USB主控制器驱动程序；
           3. USB 主控制器驱动程序根据该urb描述的信息，来访问USB设备；
             4. 当设备访问结束后，USB 主控制器驱动程序通知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

          

        2.4 提交URB

       在完成urb的创建和初始化后，USB驱动需要将urb提交给USB核心. 
      int usb_submit_urb(struct urb *urb, gfp_t mem_flags)
      参数：
              urb：要提交urb的指针
             mem_flags: 内存分配标识(如GFP_KERNEL)，参考kmalloc
      URB被提交到USB核心后，USB核心指定usb主控制器驱动程序来处理该urb，处理完之后，urb完成函数将被调用

3. HID协议

HID(Human Interface Device)， 属于人机交互类的设备，如USB鼠标，USB键盘，USB游戏操纵杆等。该类设备必须
遵循HID设计规范。

4. 鼠标驱动分析

1. /*

2. * Copyright (c) 1999-2001 Vojtech Pavlik

3. *

4. * USB HIDBP Mouse support

5. */

6.  

7. /*

8. * This program is free software; you can redistribute it and/or modify

9. * it under the terms of the GNU General Public License as published by

10. * the Free Software Foundation; either version 2 of the License, or

11. * (at your option) any later version.

12. *

13. * This program is distributed in the hope that it will be useful,

14. * but WITHOUT ANY WARRANTY; without even the implied warranty of

15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

16. * GNU General Public License for more details.

17. *

18. */

19.  

20. #include <linux/kernel.h>

21. #include <linux/slab.h>

22. #include <linux/module.h>

23. #include <linux/init.h>

24. #include <linux/usb/input.h>

25. #include <linux/hid.h>

26.  

27. /* for apple IDs */

28. #ifdef CONFIG_USB_HID_MODULE

29. #include "../hid-ids.h"

30. #endif

31.  

32. /*

33. * Version Information

34. */

35. #define DRIVER_VERSION "v1.6"

36. #define DRIVER_AUTHOR "Vojtech Pavlik <[email protected]>"

37. #define DRIVER_DESC "USB HID Boot Protocol mouse driver"

38. #define DRIVER_LICENSE "GPL"

39.  

40. MODULE_AUTHOR(DRIVER_AUTHOR);

41. MODULE_DESCRIPTION(DRIVER_DESC);

42. MODULE_LICENSE(DRIVER_LICENSE);

43.  

44. struct usb_mouse {

45. char name[128];

46. char phys[64];

47. struct usb_device *usbdev;

48. struct input_dev *dev;

49. struct urb *irq;

50.  

51. signed char *data;

52. dma_addr_t data_dma;

53. };

54.  

55. static void usb_mouse_irq(struct urb *urb)

56. {

57. struct usb_mouse *mouse = urb->context;

58. signed char *data = mouse->data;

59. struct input_dev *dev = mouse->dev;

60. int status;

61.  

62. /* 检测urb传输是否成功 */

63. switch (urb->status) {

64. case 0: /* success */

65. break;

66. case -ECONNRESET: /* unlink */

67. case -ENOENT:

68. case -ESHUTDOWN:

69. return;

70. /* -EPIPE: should clear the halt */

71. default: /* error */

72. goto resubmit;

73. }

74.  

75. /* 报告按键状态 */

76. input_report_key(dev, BTN_LEFT, data[0] & 0x01);

77. input_report_key(dev, BTN_RIGHT, data[0] & 0x02);

78. input_report_key(dev, BTN_MIDDLE, data[0] & 0x04);

79. input_report_key(dev, BTN_SIDE, data[0] & 0x08);

80. input_report_key(dev, BTN_EXTRA, data[0] & 0x10);

81.  

82. input_report_rel(dev, REL_X, data[1]);

83. input_report_rel(dev, REL_Y, data[2]);

84. input_report_rel(dev, REL_WHEEL, data[3]);

85.  

86. input_sync(dev);

87. resubmit:

88. /* 提交下次传输 */

89. status = usb_submit_urb (urb, GFP_ATOMIC);

90. if (status)

91. err ("can't resubmit intr, %s-%s/input0, status %d",

92. mouse->usbdev->bus->bus_name,

93. mouse->usbdev->devpath, status);

94. }

95.  

96. static int usb_mouse_open(struct input_dev *dev)

97. {

98. struct usb_mouse *mouse = input_get_drvdata(dev);

99.  

100. mouse->irq->dev = mouse->usbdev;

101. if (usb_submit_urb(mouse->irq, GFP_KERNEL))

102. return -EIO;

103.  

104. return 0;

105. }

106.  

107. static void usb_mouse_close(struct input_dev *dev)

108. {

109. struct usb_mouse *mouse = input_get_drvdata(dev);

110.  

111. usb_kill_urb(mouse->irq);

112. }

113.  

114. static int usb_mouse_probe(struct usb_interface *intf, const struct usb_device_id *id)

115. {

116. /* 设备描述 usb_device */

117. /* 接口描述 usb_interface */

118. struct usb_device *dev = interface_to_usbdev(intf);

119.  

120. /* 接口设置描述 */

121. struct usb_host_interface *interface;

122.  

123. /* 端点描述符 */

124. struct usb_endpoint_descriptor *endpoint;

125.  

126. struct usb_mouse *mouse;

127. struct input_dev *input_dev;

128. int pipe, maxp;

129. int error = -ENOMEM;

130.  

131. /* 获取当前接口设置 */

132. interface = intf->cur_altsetting;

133.  

134. 　　 /* 根据HID规范，鼠标只有一个端点（不包含0号控制端点）*/

135. if (interface->desc.bNumEndpoints != 1)

136. return -ENODEV;

137.  

138. /* 获取端点0描述符 */

139. endpoint = &interface->endpoint[0].desc;

140.  

141. /* 根据HID规范，鼠标唯一的端点应为中断端点 */

142. if (!usb_endpoint_is_int_in(endpoint))

143. return -ENODEV;

144.  

145. /* 生成中断管道 */

146. pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);

147.  

148. /* 返回该端点能够传输的最大的包长度，鼠标的返回的最大数据包为4个字节。*/

149. maxp = usb_maxpacket(dev, pipe, usb_pipeout(pipe));

150.  

151. /* 创建input设备 */

152. mouse = kzalloc(sizeof(struct usb_mouse), GFP_KERNEL);

153. input_dev = input_allocate_device();

154. if (!mouse || !input_dev)

155. goto fail1;

156.  

157. /* 申请内存空间用于数据传输，data 为指向该空间的地址*/

158. mouse->data = usb_buffer_alloc(dev, 8, GFP_ATOMIC, &mouse->data_dma);

159. if (!mouse->data)

160. goto fail1;

161.  

162. /* 分配URB */

163. mouse->irq = usb_alloc_urb(0, GFP_KERNEL);

164. if (!mouse->irq)

165. goto fail2;

166.  

167. mouse->usbdev = dev;

168. mouse->dev = input_dev;

169.  

170. if (dev->manufacturer)

171. strlcpy(mouse->name, dev->manufacturer, sizeof(mouse->name));

172.  

173. if (dev->product) {

174. if (dev->manufacturer)

175. strlcat(mouse->name, " ", sizeof(mouse->name));

176. strlcat(mouse->name, dev->product, sizeof(mouse->name));

177. }

178.  

179. if (!strlen(mouse->name))

180. snprintf(mouse->name, sizeof(mouse->name),

181. "USB HIDBP Mouse %04x:%04x",

182. le16_to_cpu(dev->descriptor.idVendor),

183. le16_to_cpu(dev->descriptor.idProduct));

184.  

185. /* usb_make_path 用来获取 USB 设备在 Sysfs 中的路径*/

186. usb_make_path(dev, mouse->phys, sizeof(mouse->phys));

187.  

188. strlcat(mouse->phys, "/input0", sizeof(mouse->phys));

189.  

190. /* 字符设备初始化 */

191. input_dev->name = mouse->name;

192. input_dev->phys = mouse->phys;

193. usb_to_input_id(dev, &input_dev->id);

194. input_dev->dev.parent = &intf->dev;

195.  

196. input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);

197. input_dev->keybit[BIT_WORD(BTN_MOUSE)] = BIT_MASK(BTN_LEFT) |

198. BIT_MASK(BTN_RIGHT) | BIT_MASK(BTN_MIDDLE);

199. input_dev->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y);

200. input_dev->keybit[BIT_WORD(BTN_MOUSE)] |= BIT_MASK(BTN_SIDE) |

201. BIT_MASK(BTN_EXTRA);

202. input_dev->relbit[0] |= BIT_MASK(REL_WHEEL);

203.  

204. input_set_drvdata(input_dev, mouse);

205.  

206. input_dev->open = usb_mouse_open;

207. input_dev->close = usb_mouse_close;

208.  

209. /* 初始化中断URB */

210. /* 思考实验：将interval参数设置为1分钟，观察现象 */

211. usb_fill_int_urb(mouse->irq, dev, pipe, mouse->data,

212. (maxp > 8 ? 8 : maxp),

213. usb_mouse_irq, mouse, endpoint->bInterval);

214. mouse->irq->transfer_dma = mouse->data_dma;

215. mouse->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;

216.  

217. error = input_register_device(mouse->dev);

218. if (error)

219. goto fail3;

220.  

221. /*将mouse指针保存到intf的dev成员中*/

222. usb_set_intfdata(intf, mouse);

223. return 0;

224.  

225. fail3:

226. usb_free_urb(mouse->irq);

227. fail2:

228. usb_buffer_free(dev, 8, mouse->data, mouse->data_dma);

229. fail1:

230. input_free_device(input_dev);

231. kfree(mouse);

232. return error;

233. }

234.  

235. static void usb_mouse_disconnect(struct usb_interface *intf)

236. {

237. struct usb_mouse *mouse = usb_get_intfdata (intf);

238.  

239. usb_set_intfdata(intf, NULL);

240. if (mouse) {

241. usb_kill_urb(mouse->irq);

242. input_unregister_device(mouse->dev);

243. usb_free_urb(mouse->irq);

244. usb_buffer_free(interface_to_usbdev(intf), 8, mouse->data, mouse->data_dma);

245. kfree(mouse);

246. }

247. }

248.  

249. static struct usb_device_id usb_mouse_id_table [] = {

250. { USB_INTERFACE_INFO(USB_INTERFACE_CLASS_HID, USB_INTERFACE_SUBCLASS_BOOT,

251. USB_INTERFACE_PROTOCOL_MOUSE) },

252. { } /* Terminating entry */

253. };

254.  

255. MODULE_DEVICE_TABLE (usb, usb_mouse_id_table);

256.  

257. static struct usb_driver usb_mouse_driver = {

258. .name = "usbmouse", /* 驱动名 */

259. .probe = usb_mouse_probe, /* 捕获函数 */

260. .disconnect = usb_mouse_disconnect, /* 卸载函数 */

261. .id_table = usb_mouse_id_table, /* 设备列表 */

262. };

263.  

264. static int __init usb_mouse_init(void)

265. {

266. /* 注册鼠标驱动程序 */

267. int retval = usb_register(&usb_mouse_driver);

268. if (retval == 0)

269. printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"

270. DRIVER_DESC "\n");

271. return retval;

272. }

273.  

274. static void __exit usb_mouse_exit(void)

275. {

276. usb_deregister(&usb_mouse_driver);

277. }

278.  

279. module_init(usb_mouse_init);

280. module_exit(usb_mouse_exit);

鼠标驱动总结：

鼠标是一个USB设备 usb设备驱动就是urb的创建、初始化、提交到usb_core

同时鼠标设备还是一个输入设备， 输入设备就包括注册、上报， 其中还有一个HID鼠标规范协议
 

这里小总结一下：

USB模型模型分为三个部分：USB主控制器驱动、USB核心、USB设备驱动，而整个USB驱动是围绕URB来进行的。

前面用到的dnw驱动源码 dnw_usb.c

1. #include <linux/module.h>

2. #include <linux/kernel.h>

3. #include <linux/usb.h>

4. #include <linux/fs.h>

5. #include <linux/uaccess.h>

6. #include <linux/slab.h>

7.  

8. #define BULKOUT_BUFFER_SIZE 512

9. char *bulkout_buffer;

10. struct usb_device *udev;

11. __u8 bulk_out_endaddr;

12.  

13. static struct usb_device_id dnw_id_table [] = {

14. { USB_DEVICE(0x5345, 0x1234) },

15. { }

16. };

17.  

18. static int dnw_open(struct inode* inode, struct file *file)

19. {

20. bulkout_buffer = kmalloc(BULKOUT_BUFFER_SIZE,GFP_KERNEL);

21. return 0;

22. }

23.  

24. static int dnw_release (struct inode* inode, struct file *file)

25. {

26. kfree(bulkout_buffer);

27. return 0;

28. }

29.  

30. static ssize_t dnw_write(struct file *file, const char __user *buf, size_t len, loff_t *pos)

31. {

32. size_t to_write;

33. size_t total_write = 0;

34. size_t act_len;

35.  

36. while(len>0)

37. {

38. to_write = min(len,(size_t)BULKOUT_BUFFER_SIZE);

39.  

40. copy_from_user(bulkout_buffer,buf+total_write,to_write);

41.  

42. usb_bulk_msg(udev,usb_sndbulkpipe(udev,bulk_out_endaddr),bulkout_buffer,to_write,&act_len,3*HZ);

43.  

44. len -= to_write;

45. total_write += to_write;

46. }

47.  

48. return total_write;

49. }

50.  

51. static struct file_operations dnw_ops =

52. {

53. .owner = THIS_MODULE,

54. .write = dnw_write,

55. .open = dnw_open,

56. .release = dnw_release,

57. };

58.  

59. static struct usb_class_driver dnw_class = {

60. .name = "secbulk%d",

61. .fops = &dnw_ops,

62. .minor_base = 100,

63. };

64.  
65.  

66. static int dnw_probe(struct usb_interface *intf, const struct usb_device_id *id)

67. {

68. /* 接口设置描述 */

69. struct usb_host_interface *interface;

70. struct usb_endpoint_descriptor *endpoint;

71. int i;

72.  

73. interface = intf->cur_altsetting;

74.  
75.  
76.  

77. for(i=0;i<interface->desc.bNumEndpoints;i++)

78. {

79. endpoint = &interface->endpoint[i].desc;

80. if(usb_endpoint_is_bulk_out(endpoint))

81. {

82. bulk_out_endaddr = endpoint->bEndpointAddress;

83. break;

84. }

85.  

86. }

87.  

88. usb_register_dev(intf,&dnw_class);

89.  

90. udev = usb_get_dev(interface_to_usbdev(intf));

91.  

92. }

93.  

94. static void dnw_disconnect(struct usb_interface *intf)

95. {

96. usb_deregister_dev(intf,&dnw_class);

97. }

98.  

99. struct usb_driver dnw_driver = {

100. .name = "dnw", /* 驱动名 */

101. .probe = dnw_probe, /* 捕获函数 */

102. .disconnect = dnw_disconnect, /* 卸载函数 */

103. .id_table = dnw_id_table, /* 设备列表 */

104. };

105.  
106.  
107.  

108. int dnw_init()

109. {

110. usb_register(&dnw_driver);

111. return 0;

112. }

113.  

114. void dnw_exit()

115. {

116. usb_deregister(&dnw_driver);

117. }

118.  
119.  

120. module_init(dnw_init);

121. module_exit(dnw_exit);

122. MODULE_LICENSE("GPL");

应用程序dnw.c

1. #include <stdio.h>

2. #include <stdlib.h>

3. #include <malloc.h>

4. #include <sys/types.h>

5. #include <sys/stat.h>

6. #include <unistd.h>

7. #include <fcntl.h>

8. #include <string.h>

9.  

10. const char* dev = "/dev/dnw0";

11.  
12.  

13. int main(int argc, char* argv[])

14. {

15. unsigned char* file_buffer = NULL;

16.  

17. long int addr = 0;

18.  

19. if( 3 != argc ) {

20. printf("Usage: dwn <filename> address\n");

21. return 1;

22. }

23.  
24.  

25. int fd = open(argv[1], O_RDONLY);

26. if(-1 == fd) {

27. printf("Can not open file - %s\n", argv[1]);

28. return 1;

29. }

30. addr = strtol((char *) argv[2] ,NULL, 16);

31.  

32. printf("addr = %x \n", addr);

33.  
34.  

35. // get file size

36. struct stat file_stat;

37. if( -1 == fstat(fd, &file_stat) ) {

38. printf("Get file size filed!\n");

39. return 1;

40. }

41.  

42. file_buffer = (unsigned char*)malloc(file_stat.st_size+10);

43. if(NULL == file_buffer) {

44. printf("malloc failed!\n");

45. goto error;

46. }

47. //memset(file_buffer, '\0', sizeof(file_buffer)); // bad code ! corrected by Qulory

48. memset(file_buffer, '\0', sizeof(char)*(file_stat.st_size+10));

49.  

50. // the first 8 bytes in the file_buffer is reserved, the last 2 bytes also;

51. if( file_stat.st_size != read(fd, file_buffer+8, file_stat.st_size)) {

52. printf("Read file failed!\n");

53. goto error;

54. }

55.  

56. printf("File name : %s\n", argv[1]);

57. printf("File size : %ld bytes\n", file_stat.st_size);// off_t is long int

58.  

59. int fd_dev = open(dev, O_WRONLY);

60. if( -1 == fd_dev) {

61. printf("Can not open %s\n", dev);

62. goto error;

63. }

64.  

65. /*

66. * Note: the first 4 bytes store the dest addr ;

67. * the following 4 bytes store the file size ;

68. * and the last 2 bytes store the sum of each bytes of the file ;

69. */

70. *((unsigned long*)file_buffer) = addr; //load address

71. *((unsigned long*)file_buffer+1) = file_stat.st_size+10; //file size

72. unsigned short sum = 0;

73. int i;

74. for(i=8; i<file_stat.st_size+8; i++) {

75. sum += file_buffer[i];

76. }

77.  

78. *((unsigned short*)(file_buffer+8+file_stat.st_size)) = sum;

79.  

80. printf("Start Sending data...\n");

81. size_t remain_size = file_stat.st_size+10;

82. size_t block_size = 512;

83. size_t written = 0;

84. while(remain_size > 0) {

85. size_t to_write = remain_size > block_size ? block_size:remain_size;

86. size_t real_write = write(fd_dev, file_buffer+written, to_write);

87. if( to_write != real_write) {

88. printf(" write /dev/secbulk0 failed! to_write = %u real_write = %u \n" , to_write ,real_write );

89. return 1;

90. }

91. remain_size -= to_write;

92. written += to_write;

93. printf("\rSent %lu%% \t %u bytes !", written*100/(file_stat.st_size+10), written);

94. fflush(stdout);

95.  

96. }

97.  

98. printf("OK\n");

99. return 0;

100.  

101. error:

102. if(-1 != fd_dev) {

103. close(fd_dev);

104. }

105. if(fd != -1) {

106. close(fd);

107. }

108. if( NULL != file_buffer ) {

109. free(file_buffer);

110. }

111. return -1;

112. }

这个usb驱动和应用程序可以通过虚拟机用来下载文件到开发板！前面的的uboot课程有演示这里就不贴效果图了！