USB驱动程序设计

1.USB驱动模型

①USB HOST控制器驱动
②USBhexin
③USB客户端驱动


设备4个层次：设备(device)、配置(Config)、接口(Interface)、端点(Endpoint).
一个接口就是一个基本功能。如:MP4的视频、音频。
USB设备包括配置(configuration)、接口（interface）和端点(endpoint)，一个USB设备驱动程序对应一个USB接口，而非整个USB设备。
在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;
}

2.URB
2.1 URB通讯模型
主机发送请求，USB从机返回消息。
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
①对于中断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核心.

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个字节报告描述符）


4.鼠标驱动分析

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);                                                                       //这里把接口转化成dev设备

    /* 接口设置描述 */
    struct usb_host_interface *interface;

    /* 端点描述符 */
    struct usb_endpoint_descriptor *endpoint;

    struct usb_mouse *mouse;
    struct input_dev *input_dev;
    int pipe, maxp;                                                                                                            //这里创建了一个pipe
    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);                                                                     //这里给pipe创建了接收管道，端点的地址从上面来（端点的地址）

    /* 返回该端点能够传输的最大的包长度，鼠标的返回的最大数据包为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);                                                          //给data分配了一个空间
    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来创建一个URB
    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;
}

打开时会上传这个URB数据：

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;
}

上传完毕后，回传回来的数据就有中断函数：

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);                                                     //data[0]中的第一个位，左键
    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]);                                                                //X轴信息
    input_report_rel(dev, REL_Y, data[2]);                                                                //Y轴信息
    input_report_rel(dev, REL_WHEEL, data[3]);                                                            //滑轮的信息

    input_sync(dev);
resubmit:
    /* 提交下次传输 */
    status = usb_submit_urb (urb, GFP_ATOMIC);                                                             //再次提交urb
    if (status)
        err ("can't resubmit intr, %s-%s/input0, status %d",
                mouse->usbdev->bus->bus_name,
                mouse->usbdev->devpath, status);
}