usb骨架程序学习

Linux 内核源代码中的driver/usb/usb-skeleton.c 文件为我们提供了一个最基础的USB 驱动程序，即USB骨架程序，可被看做一个最简单的USB 设备驱动实例。尽管具体USB 设备驱动千差万别，但其骨架则万变不离其宗。首先看看 USB 骨架程序的usb_driver 结构体定义，如代码清单1.1所示。

static struct usb_driver skel_driver =
{
    .name = "skeleton",
    .probe = skel_probe,
    .disconnect = skel_disconnect,
    .id_table = skel_table,
};

                                                      代码清单1.1 USB 骨架程序的usb_driver 结构体

从上述代码第6行可以看出，它所支持的USB 设备的列表数组为skel_table[]，其定义如代码清单1.2所示。

/* 本驱动支持的USB 设备列表 */
static struct usb_device_id skel_table [] = {
{ 
    USB_DEVICE(USB_SKEL_VENDOR_ID,
    USB_SKEL_PRODUCT_ID) },
    { }
};
MODULE_DEVICE_TABLE (usb, skel_table);

                                                       代码清单1.2 USB 骨架程序的id_table

对上述usb_driver 的注册和注销发生在USB 骨架程序的模块加载与卸载函数内，如代码清单1.3所示，其分别调用了usb_register()和usb_deregister()。

static int __init usb_skel_init(void)
{
    int result;

    /* 注册USB 驱动 */
    result = usb_register(&skel_driver);
    if (result)
        err("usb_register failed. Error number %d", result);

    return result;
}
static void __exit usb_skel_exit(void)
{
    /* 注销USB 驱动 */
    usb_deregister(&skel_driver);
}

                                                代码清单1.3 USB 骨架程序的模块加载与卸载函数

usb_driver 的probe()成员函数中，会根据usb_interface 的成员寻找第一个批量输入和输出端点，将端点地址、缓冲区等信息存入为USB 骨架程序定义的usb_skel 结构体，并将usb_skel 实例的指针传入usb_set_intfdata()作为USB 接口的私有数据，最后，它会注册USB 设备，如代码清单1.4所示。

static int skel_probe(struct usb_interface *interface, const struct usb_device_id *id)
{
    struct usb_skel *dev = NULL;
    struct usb_host_interface *iface_desc;
    struct usb_endpoint_descriptor *endpoint;
    size_t buffer_size;
    int i;
    int retval = -ENOMEM;

    /* 分配设备状态的内存并初始化 */
    dev = kzalloc(sizeof(*dev), GFP_KERNEL);
    if (dev == NULL) {
        err("Out of memory");
        goto error;
    }
    kref_init(&dev->kref);
    sema_init(&dev->limit_sem, WRITES_IN_FLIGHT);

    dev->udev = usb_get_dev(interface_to_usbdev(interface));
    dev->interface = interface;

    /* 设置端点信息 */
    /* 仅使用第一个bulk-in 和bulk-out */
    iface_desc = interface->cur_altsetting;
    for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
        endpoint = &iface_desc->endpoint[i].desc;

        if (!dev->bulk_in_endpointAddr &&
        ((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN) &&
        ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_BULK)) {
            /* 找到了一个批量IN 端点 */
            buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
            dev->bulk_in_size = buffer_size;
            dev->bulk_in_endpointAddr = endpoint->bEndpointAddress;
            dev->bulk_in_buffer = kmalloc(buffer_size, GFP_KERNEL);
            if (!dev->bulk_in_buffer) {
                err("Could not allocate bulk_in_buffer");
                goto error;
            }
        }

        if (!dev->bulk_out_endpointAddr &&
        ((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT) &&
        ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_BULK)) {
            /* 找到了一个批量OUT 端点 */
            dev->bulk_out_endpointAddr = endpoint->bEndpointAddress;
        }
    }
    
    if(!(dev->bulk_in_endpointAddr && dev->bulk_out_endpointAddr)) {
        err("Could not find both bulk-in and bulk-out endpoints");
        goto error;
    }

    /* 在设备结构中保存数据指针 */
    usb_set_intfdata(interface, dev);

    /* 注册USB 设备 */
    retval = usb_register_dev(interface, &skel_class);
    if (retval) {
        /* something prevented us from registering this driver */
        err("Not able to get a minor for this device.");
        usb_set_intfdata(interface, NULL);
        goto error;
    }

    /* 告知用户设备依附于什么node */
    info("USB Skeleton device now attached to USBSkel-%d", interface->minor);
    return 0;

error:
    if (dev)
    kref_put(&dev->kref, skel_delete);
    return retval;
}

                                                           代码清单1.4 USB 骨架程序的探测函数

usb_skel 结构体可以被看作一个私有数据结构体，其定义如代码清单1.5 所示，应该根据具体的设备量身定制。

struct usb_skel
{
    struct usb_device * udev; /* 该设备的usb_device 指针 */
    struct usb_interface * interface; /* 该设备的usb_interface 指针 */
    struct semaphore limit_sem; /* 限制进程写的数量 */
    unsigned char * bulk_in_buffer; /* 接收数据的缓冲区 */
    size_t bulk_in_size; /* 接收缓冲区大小 */
    _ _u8 bulk_in_endpointAddr; /*批量IN 端点的地址 */
    _ _u8 bulk_out_endpointAddr; /* 批量OUT 端点的地址 */
    struct kref kref;
};

                                              代码清单1.5 USB 骨架程序的自定义数据结构usb_skel

USB 骨架程序的断开函数会完成探测函数相反的工作，即设置接口数据为NULL，注销USB 设备，如代码清单1.6 所示。

static void skel_disconnect(struct usb_interface *interface)
{
    struct usb_skel *dev;
    int minor = interface->minor;

    /* 阻止skel_open()与skel_disconnect()的竞争 */
    lock_kernel();

    dev = usb_get_intfdata(interface);
    usb_set_intfdata(interface, NULL);

    /* 注销usb 设备，释放次设备号 */
    usb_deregister_dev(interface, &skel_class);

    unlock_kernel();

    /* 减少引用计数 */
    kref_put(&dev->kref, skel_delete);

    info("USB Skeleton #%d now disconnected", minor);
}

                                                                      代码清单1.6 USB 骨架程序的断开函数

代码清单1.4 第62 行的usb_register_dev(interface, &skel_class)中第二个参数包含了字符设备的file_operations 结构体指针，而这个结构体中的成员实现也是USB 字符设备的另一个组成成分。代码清单1.7 给出了USB 骨架程序的字符设备文件操作file_operations 结构体的定义。

static struct file_operations skel_fops =
{
    .owner = THIS_MODULE,
    .read = skel_read, //读函数
    .write = skel_write, //写函数
    .open = skel_open, //打开函数
    .release = skel_release, //释放函数
};

                                                    代码清单1.7 USB 骨架程序的字符设备文件操作结构体

由于只是一个象征性的骨架程序，open()成员函数的实现非常简单，它根据usb_driver 和次设备号通过usb_find_interface()获得USB 接口，之后通过usb_get_intfdata()获得接口的私有数据并赋予file->private_data，如代码清单1.8 所示。

static int skel_open(struct inode *inode, struct file *file)
{
    struct usb_skel *dev;
    struct usb_interface *interface;
    int subminor;
    int retval = 0;

    subminor = iminor(inode);

    interface = usb_find_interface(&skel_driver, subminor);
    if (!interface) {
        err ("%s - error, can't find device for minor %d",__FUNCTION__, subminor);
        retval = -ENODEV;
        goto exit;
    }

    dev = usb_get_intfdata(interface);/*获得接口数据*/
    if (!dev) {
        retval = -ENODEV;
        goto exit;
    }
    
    /* 增加设备的引用计数 */
    kref_get(&dev->kref);
    
    /* 将接口数据保存在file->private_data 中 */
    file->private_data = dev;
    
exit:
    return retval;
}

                                                           代码清单1.8 USB 骨架程序的字符设备打开函数