libusb的使用教程和例子

风火石

驱动开发向来是内核开发中工作量最多的一块，随着USB设备的普及，大量的USB设备的驱动开发也成为驱动开发者手头上做的最多的事情。本文主要介绍 Linux平台下基于libusb的驱动开发，希望能够给从事Linux驱动开发的朋友带来些帮助，更希望能够给其他平台上的无驱设计带来些帮助。文章是我在工作中使用libusb的一些总结，难免有错误，如有不当的地方，还请指正。

    Linux 平台上的usb驱动开发，主要有内核驱动的开发和基于libusb的无驱设计。

对于内核驱动的大部分设备，诸如带usb接口的hid设备，linux本身已经自带了相关的驱动，我们只要操作设备文件便可以完成对设备大部分的操作，而另外一些设备，诸如自己设计的硬件产品，这些驱动就需要我们驱动工程师开发出相关的驱动了。内核驱动有它的优点，然而内核驱动在某些情况下会遇到如下的一些问题：

1 当使用我们产品的客户有2.4内核的平台，同时也有2.6内核的平台，我们要设计的驱动是要兼容两个平台的，就连makefile 我们都要写两个。

2 当我们要把linux移植到嵌入平台上，你会发现原先linux自带的驱动移过去还挺大的，我的内核当然是越小越好拉，这样有必要么。这还不是最郁闷的地方，如果嵌入平台是客户的，客户要购买你的产品，你突然发现客户设备里的系统和你的环境不一样，它没有你要的驱动了，你的程序运行不了，你会先想：“没关系，我写个内核驱动加载一下不就行了“。却发现客户连insmod加载模块的工具都没移植，那时你就看看老天，说声我怎么那么倒霉啊，客户可不想你动他花了n时间移植的内核哦

3 花了些功夫写了个新产品的驱动，挺有成就感啊，代码质量也是相当的有水准啊。正当你沉醉在你的代码中时，客服不断的邮件来了，“客户需要2.6.5内核的驱动，config文件我已经发你了” “客户需要双核的 2.6.18-smp 的驱动” “客户的平台是自己定制的是2.6.12-xxx “   你恨不得把驱动的源代码给客户，这样省得编译了。你的一部分工作时间编译内核，定制驱动

有问题产生必然会有想办法解决问题的人， libusb的出现给我们带来了某些方便，即节约了我们的时间，也降低了公司的成本。 所以在一些情况下，就可以考虑使用libusb的无驱设计了。

    下面我们就来详细讨论一下libusb, 并以写一个hid设备的驱动来讲解如何运用libusb,至于文章中涉及的usb协议的知识，限于篇幅，就不详细讲解了，相关的可自行查看usb相关协议。

一 libusb 介绍

   libusb 设计了一系列的外部API 为应用程序所调用，通过这些API应用程序可以操作硬件，从libusb的源代码可以看出，这些API 调用了内核的底层接口，和kernel driver中所用到的函数所实现的功能差不多，只是libusb更加接近USB 规范。使得libusb的使用也比开发内核驱动相对容易的多。

Libusb 的编译安装请查看Readme,这里不做详解

二 libusb 的外部接口

2.1 初始化设备接口

这些接口也可以称为核心函数，它们主要用来初始化并寻找相关设备。

usb_init
函数定义： void usb_init(void);
从函数名称可以看出这个函数是用来初始化相关数据的，这个函数大家只要记住必须调用就行了，而且是一开始就要调用的.

usb_find_busses
函数定义： int usb_find_busses(void);
寻找系统上的usb总线，任何usb设备都通过usb总线和计算机总线通信。进而和其他设备通信。此函数返回总线数。

usb_find_devices
函数定义： int usb_find_devices(void);
寻找总线上的usb设备，这个函数必要在调用usb_find_busses()后使用。以上的三个函数都是一开始就要用到的，此函数返回设备数量。

usb_get_busses
函数定义： struct usb_bus *usb_get_busses(void);
这个函数返回总线的列表，在高一些的版本中已经用不到了，这在下面的实例中会有讲解

2.2 操作设备接口

usb_open
函数定义： usb_dev_handle *usb_open(struct *usb_device dev);
打开要使用的设备，在对硬件进行操作前必须要调用usb_open 来打开设备，这里大家看到有两个结构体 usb_dev_handle 和 usb_device 是我们在开发中经常碰到的，有必要把它们的结构看一看。在libusb 中的usb.h和usbi.h中有定义。
这里我们不妨理解为返回的 usb_dev_handle 指针是指向设备的句柄，而行参里输入就是需要打开的设备。

usb_close
函数定义： int usb_close(usb_dev_handle *dev);
与usb_open相对应，关闭设备，是必须调用的, 返回0成功，<0 失败。

usb_set_configuration
函数定义： int usb_set_configuration(usb_dev_handle *dev, int configuration);
设置当前设备使用的configuration，参数configuration 是你要使用的configurtation descriptoes中的bConfigurationValue, 返回0成功，<0失败( 一个设备可能包含多个configuration,比如同时支持高速和低速的设备就有对应的两个configuration,详细可查看usb标准)

usb_set_altinterface
函数定义： int usb_set_altinterface(usb_dev_handle *dev, int alternate);
和名字的意思一样，此函数设置当前设备配置的interface descriptor，参数alternate是指interface descriptor中的bAlternateSetting。返回0成功，<0失败

usb_resetep
函数定义： int usb_resetep(usb_dev_handle *dev, unsigned int ep);
复位指定的endpoint，参数ep 是指bEndpointAddress,。这个函数不经常用，被下面介绍的usb_clear_halt函数所替代。

usb_clear_halt
函数定义： int usb_clear_halt (usb_dev_handle *dev, unsigned int ep);
复位指定的endpoint，参数ep 是指bEndpointAddress。这个函数用来替代usb_resetep

usb_reset
函数定义： int usb_reset(usb_dev_handle *dev);
这个函数现在基本不怎么用，不过这里我也讲一下，和名字所起的意思一样，这个函数reset设备，因为重启设备后还是要重新打开设备，所以用usb_close就已经可以满足要求了。

usb_claim_interface
函数定义： int usb_claim_interface(usb_dev_handle *dev, int interface);
注册与操作系统通信的接口，这个函数必须被调用，因为只有注册接口，才能做相应的操作。
Interface 指 bInterfaceNumber. (下面介绍的usb_release_interface 与之相对应，也是必须调用的函数)

usb_release_interface
函数定义： int usb_release_interface(usb_dev_handle *dev, int interface);
注销被usb_claim_interface函数调用后的接口，释放资源，和usb_claim_interface对应使用。

2.3 控制传输接口

usb_control_msg
函数定义：int usb_control_msg(usb_dev_handle *dev, int requesttype, int request, int value, int index, char *bytes, int size, int timeout);
从默认的管道发送和接受控制数据

usb_get_string
函数定义： int usb_get_string(usb_dev_handle *dev, int index, int langid, char *buf, size_t buflen);

usb_get_string_simple
函数定义： int usb_get_string_simple(usb_dev_handle *dev, int index, char *buf, size_t buflen);

usb_get_descriptor
函数定义： int usb_get_descriptor(usb_dev_handle *dev, unsigned char type, unsigned char index, void *buf, int size);

usb_get_descriptor_by_endpoint
函数定义： int usb_get_descriptor_by_endpoint(usb_dev_handle *dev, int ep, unsigned char type, unsigned char index, void *buf, int size);

2.4 批传输接口

usb_bulk_write
函数定义： int usb_bulk_write(usb_dev_handle *dev, int ep, char *bytes, int size, int timeout);

usb_interrupt_read
函数定义： int usb_interrupt_read(usb_dev_handle *dev, int ep, char *bytes, int size, int timeout);

2.5 中断传输接口
usb_bulk_write
函数定义： int usb_bulk_write(usb_dev_handle *dev, int ep, char *bytes, int size, int timeout);

usb_interrupt_read
函数定义： int usb_interrupt_read(usb_dev_handle *dev, int ep, char *bytes, int size, int timeout);
基本上libusb所经常用到的函数就有这些了，和usb协议确实很接近吧。下面我们实例在介绍一个应用。

//----------------===================================

Libusb库的使用
使用libusb之前你的linux系统必须装有usb文件系统，这里还介绍了使用hiddev设备文件来访问设备，目的在于不仅可以比较出usb的易用性，还提供了一个转化成libusb驱动的案例。

3.1 find设备
任何驱动第一步首先是寻找到要操作的设备，我们先来看看HID驱动是怎样寻找到设备的。我们假设寻找设备的函数Device_Find(注：代码只是为了方便解说，不保证代码的健全)

1. 
   
2. /* 我们简单看一下使用hid驱动寻找设备的实现，然后在看一下libusb是如何寻找设备的 */
   
3. int Device_Find()
   
4. {
   
5.     char dir_str[100];   /* 这个变量我们用来保存设备文件的目录路径 */
   
6.     char hiddev[100];    /* 这个变量用来保存设备文件的全路径 */
   
7. DIR dir;              
   
8. /* 申请的字符串数组清空，这个编程习惯要养成 */
   
9. memset (dir_str, 0 , sizeof(dir_str));
   
10. memset (hiddev, 0 , sizeof(hiddev));
    
11.    /* hiddev 的设备描述符不在/dev/usb/hid下面，就在/dev/usb 下面
    
12. 这里我们使用opendir函数来检验目录的有效性
    
13. 打开目录返回的值保存在变量dir里，dir前面有声明
    
14. */
    
15. dir=opendir("/dev/usb/hid");
    
16.     if(dir){
    
17.         /* 程序运行到这里，说明存在 /dev/usb/hid 路径的目录 */
    
18.         sprintf(dir_str,"/dev/usb/hid/");
    
19.         closedir(dir);
    
20.     }else{
    
21.         /* 如果不存在hid目录，那么设备文件就在/dev/usb下 */
    
22.         sprintf(dir_str,"/dev/usb/");
    
23.     }
    
24.     /* DEVICE_MINOR 是指设备数，HID一般是16个 */
    
25. for(i = 0; i < DEVICE_MINOR; i++) {
    
26.     /* 获得全路径的设备文件名，一般hid设备文件名是hiddev0 到 hiddev16 */
    
27.         sprintf(hiddev, "%shiddev%d", dir_str,i);
    
28. 
    
29.        /* 打开设备文件,获得文件句柄 */
    
30.        fd = open(hiddev, O_RDWR);
    
31.        if(fd > 0) {
    
32. 
    
33.           /* 操作设备获得设备信息 */
    
34.           ioctl(fd, HIDIOCGDEVINFO, &info);
    
35.    
    
36.               /* VENDOR_ID 和 PRODUCT_ID 是标识usb设备厂家和产品ID,驱动都需要这两个参数来寻找设备,到此我们寻找到了设备 */
    
37.            if(info.vendor== VENDOR_ID && info.product== PRODUCT_ID) {
    
38.                 /* 这里添加设备的初始化代码 */
    
39.                   
    
40.                device_num++;   /* 找到的设备数 */
    
41.            }
    
42.            close(fd);
    
43.        }
    
44.     }
    
45.     return device_num;         /* 返回寻找的设备数量 */
    
46. }
    

复制代码

我们再来看libusb是如何来寻找和初始化设备

1. int Device_Find()
   
2. {
   
3. struct usb_bus             *busses;
   
4.    int                           device_num = 0;
   
5.     device_num = 0;       /* 记录设备数量 */
   
6.     usb_init();            /* 初始化 */
   
7.     usb_find_busses();   /* 寻找系统上的usb总线 */
   
8.     usb_find_devices(); /* 寻找usb总线上的usb设备 */
   
9. 
   
10.     /* 获得系统总线链表的句柄 */
    
11. busses = usb_get_busses();
    
12.     struct usb_bus       *bus;
    
13.     /* 遍历总线 */
    
14.     for (bus = busses; bus; bus = bus->next) {
    
15.         struct usb_device *dev;
    
16.         /* 遍历总线上的设备 */
    
17.         for (dev = bus->devices; dev; dev = dev->next) {
    
18.            /* 寻找到相关设备， */
    
19. if(dev->descriptor.idVendor==VENDOR_ID&& dev->descriptor.idProduct == PRODUCT_ID) {
    
20.                 /* 这里添加设备的初始化代码 */
    
21.                device_num++;   /* 找到的设备数 */
    
22. }              
    
23.         }      
    
24.     }
    
25.     return device_num;        /* 返回设备数量 */
    
26. }

复制代码

注：在新版本的libusb中，usb_get_busses就可以不用了 ，这个函数是返回系统上的usb总线链表句柄
这里我们直接用usb_busses变量，这个变量在usb.h中被定义为外部变量
所以可以直接写成这样：

1. struct usb_bus    *bus;
   
2.         for (bus = usb_busses; bus; bus = bus->next) {
   
3.                struct usb_device *dev;
   
4.         for (dev = bus->devices; dev; dev = dev->next) {
   
5.            /* 这里添加设备的初始化代码 */
   
6.         }
   
7. }

复制代码

3.2 打开设备
假设我们定义的打开设备的函数名是device_open,

1. /* 使用hid驱动打开设备 */
   
2. int Device_Open()
   
3. {
   
4.     int handle;
   
5.     /* 传统HID驱动调用,通过open打开设备文件就可 */
   
6. handle = open(“hiddev0”, O_RDONLY);
   
7. }
   
8. 
   
9. /* 使用libusb打开驱动 */
   
10. int Device_Open()
    
11. {
    
12. /* LIBUSB 驱动打开设备，这里写的是伪代码，不保证代码有用 */
    
13. struct usb_device*    udev;
    
14. usb_dev_handle*        device_handle;
    
15. /* 当找到设备后，通过usb_open打开设备，这里的函数就相当open 函数 */
    
16. device_handle = usb_open(udev);
    
17. }
    

复制代码

3.3 读写设备和操作设备
假设我们的设备使用控制传输方式，至于批处理传输和中断传输限于篇幅这里不介绍
我们这里定义三个函数，Device_Write, Device_Read, Device_Report
Device_Report 功能发送接收函数
Device_Write 功能写数据
Device_Read   功能读数据
Device_Write和Device_Read调用Device_Report发送写的信息和读的信息，开发者根据发送的命令协议来设计，我们这里只简单实现发送数据的函数。
假设我们要给设备发送72字节的数据，头8个字节是报告头，是我们定义的和设备相关的规则，后64位是数据。
HID驱动的实现(这里只是用代码来有助理解，代码是伪代码)

1. 
   
2. int Device_Report(int fd, unsigned char *buffer72)
   
3. {
   
4.         int       ret; /* 保存ioctl函数的返回值 */
   
5.         int      index;
   
6.     unsigned char send_data[72]; /* 发送的数据 */
   
7.         unsigned char recv_data[72]; /* 接收的数据 */
   
8.     struct hiddev_usage_ref uref; /* hid驱动定义的数据包 */
   
9.     struct hiddev_report_info rinfo; /* hid驱动定义的
   
10.     memset(send_data, 0, sizeof(send_data));
    
11.         memset(recv_data, 0, sizeof(recv_data));
    
12.     memcpy(send_data, buffer72, 72);
    
13.    /* 这在发送数据之前必须调用的，初始化设备 */
    
14.     ret = ioctl(fd, HIDIOCINITREPORT, 0);
    
15.     if( ret !=0) {
    
16.         return NOT_OPENED_DEVICE;/* NOT_OPENED_DEVICE 属于自己定义宏 */
    
17.     }
    
18.     /* HID设备每次传输一个字节的数据包 */
    
19.     for(index = 0; index < 72; index++) {
    
20.         /* 设置发送数据的状态 */
    
21.     uref.report_type = HID_REPORT_TYPE_FEATURE;
    
22.     uref.report_id = HID_REPORT_ID_FIRST;
    
23.     uref.usage_index = index;
    
24.     uref.field_index = 0;
    
25.     uref.value = send_data[index];
    
26.     ioctl(fd, HIDIOCGUCODE, &uref);
    
27.     ret=ioctl(fd, HIDIOCSUSAGE, &uref);
    
28.     if(ret != 0 ){
    
29.            return UNKNOWN_ERROR;
    
30.     }
    
31. }
    
32. /* 发送数据 */
    
33. rinfo.report_type = HID_REPORT_TYPE_FEATURE;
    
34. rinfo.report_id = HID_REPORT_ID_FIRST;
    
35. rinfo.num_fields = 1;
    
36. ret=ioctl(fd, HIDIOCSREPORT, &rinfo);   /* 发送数据 */
    
37. if(ret != 0) {
    
38.         return WRITE_REPORT;
    
39. }
    
40. 
    
41. /* 接受数据 */
    
42. ret = ioctl(fd, HIDIOCINITREPORT, 0);
    
43. for(index = 0; index < 72; index++) {
    
44.     uref.report_type = HID_REPORT_TYPE_FEATURE;
    
45.     uref.report_id = HID_REPORT_ID_FIRST;
    
46.     uref.usage_index = index;
    
47.     uref.field_index = 0;
    
48.     ioctl(fd, HIDIOCGUCODE, &uref);
    
49.     ret = ioctl(fd, HIDIOCGUSAGE, &uref);
    
50.     if(ret != 0 ) {
    
51.         return UNKNOWN_ERROR;
    
52.     }
    
53.     recv_data[index] = uref.value;
    
54. }
    
55. 
    
56. memcpy(buffer72, recv_data, 72);
    
57. return SUCCESS;
    
58. }

复制代码

libusb驱动的实现

1. int Device_Report(int fd, unsigned char *buffer72)
   
2. {
   
3.     /* 定义设备句柄 */
   
4.     usb_dev_handle* Device_handle;
   
5. 
   
6.     /* save the data of send and receive */
   
7.     unsigned char   send_data[72];
   
8.     unsigned char   recv_data[72];   
   
9.     int              send_len;
   
10.     int             recv_len;   
    
11. 
    
12.     /* 数据置空 */
    
13.     memset(send_data, 0 , sizeof(send_data));
    
14.     memset(recv_data, 0 , sizeof(recv_data));   
    
15. 
    
16.     /* 这里的g_list是全局的数据变量，里面可以存储相关设备的所需信息，当然我们 也可以从函数形参中传输进来，设备的信息在打开设备时初始化，我们将在后面的总结中详细描述一下 */
    
17.     Device_handle = (usb_dev_handle*)(g_list[fd].device_handle);
    
18.     if (Device_handle == NULL) {
    
19.         return NOT_OPENED_DEVICE;
    
20. }
    
21. /* 这个函数前面已经说过，在操作设备前是必须调用的, 0是指用默认的设备 */
    
22. usb_claim_interface(Device_handle, 0);
    
23. 
    
24. /* 发送数据，所用到的宏定义在usb.h可以找到，我列出来大家看一下
    
25.         #define USB_ENDPOINT_OUT       0x00
    
26.        #define USB_TYPE_CLASS     (0x01 << 5)
    
27.        #define USB_RECIP_INTERFACE 0x01
    
28.        #define HID_REPORT_SET       0x09 */
    
29. send_len = usb_control_msg(Device_handle,
    
30. USB_ENDPOINT_OUT + USB_TYPE_CLASS + USB_RECIP_INTERFACE,
    
31.                                HID_REPORT_SET,
    
32.                                0x300,
    
33.                                0,
    
34.                                send_data, 72, USB_TIMEOUT);
    
35. /* 发送数据有错误 */
    
36. if (send_len < 0) {
    
37.         return WRITE_REPORT;
    
38. }
    
39. if (send_len != 72) {
    
40.         return send_len;
    
41. }
    
42. 
    
43. /* 接受数据
    
44.        #define USB_ENDPOINT_IN         0x80
    
45.        #define USB_TYPE_CLASS          (0x01 << 5)
    
46.        #define USB_RECIP_INTERFACE        0x01
    
47.        #define HID_REPORT_GET          0x01
    
48.     */
    
49. recv_len = usb_control_msg(Device_handle,
    
50. USB_ENDPOINT_IN + USB_TYPE_CLASS + USB_RECIP_INTERFACE,
    
51.                                HID_REPORT_GET,
    
52.                                0x300,
    
53.                                  0,
    
54.                                recv_data, 72, USB_TIMEOUT);                                                   
    
55. 
    
56.     if (recv_len < 0) {
    
57.         printf("failed to retrieve report from USB device!\n");
    
58.         return READ_REPORT;
    
59.     }   
    
60. 
    
61.     if (recv_len != 72) {
    
62.         return recv_len;
    
63.     }
    
64. 
    
65.    
    
66. 
    
67.    
    
68. 
    
69.     /* 和usb_claim_interface对应 */
    
70.     usb_release_interface(RY2_handle, 0);
    
71.     memcpy(buffer72, recv_data, 72);
    
72. return SUCCESS;
    
73. }

复制代码

3.4 关闭设备
假设我们定义的关闭设备的函数名是Device_Close()

1. /* 使用hid驱动关闭设备 */
   
2. int Device_Close()
   
3. {
   
4.     int handle;
   
5. handle = open(“hiddev0”, O_RDONLY);
   
6. /* 传统HID驱动调用,通过close()设备文件就可 */
   
7. close( handle );
   
8. }
   
9. 
   
10. /* 使用libusb关闭驱动 */
    
11. int Device_Close()
    
12. {
    
13. /* LIBUSB 驱动打开设备，这里写的是伪代码，不保证代码有用 */
    
14. struct usb_device*    udev;
    
15. usb_dev_handle*        device_handle;
    
16. device_handle = usb_open(udev);
    
17. /* libusb库使用usb_close关闭程序 */
    
18. usb_close(device_handle);
    
19. }

复制代码

libusb的驱动框架
前面我们看了些主要的libusb函数的使用，这里我们把前面的内容归纳下：
一般的驱动应该都包含如下接口：
Device_Find(); /* 寻找设备接口 */
Device_Open(); /* 打开设备接口 */
Device_Write(); /* 写设备接口 */
Device_Read(); /* 读设备接口 */
Device_Close(); /* 关闭设备接口 */

具体代码如下：

1. #include <usb.h>
   
2. /* usb.h这个头文件是要包括的，里面包含了必须要用到的数据结构 */
   
3. /* 我们将一个设备的属性用一个结构体来概括 */
   
4. typedef struct
   
5. {
   
6.     struct usb_device*    udev;
   
7.     usb_dev_handle*        device_handle;
   
8.     /* 这里可以添加设备的其他属性，这里只列出每个设备要用到的属性 */
   
9. } device_descript;
   
10. 
    
11. /* 用来设置传输数据的时间延迟 */
    
12. #define USB_TIMEOUT     10000
    
13. /* 厂家ID 和产品 ID */
    
14. #define VENDOR_ID    0xffff   
    
15. #define PRODUCT_ID   0xffff
    
16. 
    
17. /* 这里定义数组来保存设备的相关属性，DEVICE_MINOR可以设置能够同时操作的设备数量，用全局变量的目的在于方便保存属性 */
    
18. #define DEVICE_MINOR 16
    
19. int     g_num;
    
20. device_descript g_list[ DEVICE_MINOR ];
    
21. /* 我们写个设备先找到设备，并把相关信息保存在 g_list 中 */
    
22. int Device_Find()
    
23. {
    
24.     struct usb_bus       *bus;
    
25.     struct usb_device *dev;
    
26.     g_num = 0;
    
27.     usb_find_busses();
    
28.     usb_find_devices();
    
29.     /* 寻找设备 */
    
30.     for (bus = usb_busses; bus; bus = bus->next) {
    
31.         for (dev = bus->devices; dev; dev = dev->next) {
    
32. if(dev->descriptor.idVendor==VENDOR_ID&& dev->descriptor.idProduct == PRODUCT_ID) {
    
33.                     /* 保存设备信息 */
    
34.                     if (g_num < DEVICE_MINOR) {
    
35.                      g_list[g_num].udev = dev;  
    
36.                      g_num ++;
    
37.                      }              
    
38.             }      
    
39.         }
    
40.     }
    
41.     return g_num;
    
42. }
    
43. 
    
44. 
    
45. /* 找到设备后，我们根据信息打开设备 */
    
46. int Device_Open()
    
47. {
    
48.     /* 根据情况打开你所需要操作的设备，这里我们仅列出伪代码 */
    
49.     if(g_list[g_num].udev != NULL) {
    
50.         g_list[g_num].device_handle = usb_open(g_list[g_num].udev);
    
51. }
    
52. }
    
53. 
    
54. /* 下面就是操作设备的函数了，我们就不列出来拉，大家可以参考上面的介绍 */
    
55. int DeviceWite(int handle)
    
56. {
    
57.     /* 填写相关代码，具体查看设备协议*/
    
58.        
    
59. }
    
60. 
    
61. int DeviceOpen(int handle)
    
62. {
    
63.     /* 填写相关代码，具体查看设备协议 */
    
64.        
    
65. }
    
66. 
    
67. /* 最后不要忘记关闭设备 */
    
68. void Device_close(int handle)
    
69. {
    
70.     /* 调用usb_close */
    
71. 
    
72. }

复制代码