1.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 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协议了。
- 对于鼠标来讲,HID规范了它传输数据的格式。鼠标的一次传输成为报告描述符,它包含4个字节:
- 第一个字节首先是5个bit的填充,然后是3个bit的按钮信息,也就是左键、右键、滚轮了。
- 接下来的3个字节分别是X、Y坐标和滚轮信息。
- 具体的协议可以参考HID的协议文档,比如说这个鼠标设备:
- 我们这里着重分析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请求了。