libusb的使用教程和例子

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(注：代码只是为了⽅便解说，不保证代码的健全)
/* 我们简单看⼀下使⽤hid驱动寻找设备的实现，然后在看⼀下libusb是如何寻找设备的 */
int Device_Find()
{
char dir_str[100]; /* 这个变量我们⽤来保存设备⽂件的⽬录路径 */
char hiddev[100]; /* 这个变量⽤来保存设备⽂件的全路径 */
DIR dir;
/* 申请的字符串数组清空，这个编程习惯要养成 */
memset (dir_str, 0 , sizeof(dir_str));
memset (hiddev, 0 , sizeof(hiddev));
/* hiddev 的设备描述符不在/dev/usb/hid下⾯，就在/dev/usb 下⾯
这⾥我们使⽤opendir函数来检验⽬录的有效性
打开⽬录返回的值保存在变量dir⾥，dir前⾯有声明
*/
dir=opendir("/dev/usb/hid");
if(dir){
/* 程序运⾏到这⾥，说明存在 /dev/usb/hid 路径的⽬录 */
sprintf(dir_str,"/dev/usb/hid/");
closedir(dir);
}else{
/* 如果不存在hid⽬录，那么设备⽂件就在/dev/usb下 */
sprintf(dir_str,"/dev/usb/");
}
/* DEVICE_MINOR 是指设备数，HID⼀般是16个 */
for(i = 0; i < DEVICE_MINOR; i++) {
/* 获得全路径的设备⽂件名，⼀般hid设备⽂件名是hiddev0 到 hiddev16 */
sprintf(hiddev, "%shiddev%d", dir_str,i);
/* 打开设备⽂件,获得⽂件句柄 */
fd = open(hiddev, O_RDWR);
if(fd > 0) {
/* 操作设备获得设备信息 */
ioctl(fd, HIDIOCGDEVINFO, &info);
/* VENDOR_ID 和 PRODUCT_ID 是标识usb设备⼚家和产品ID,驱动都需要这两个参数来寻找设备,到此我们寻找到了设备 */
if(info.vendor== VENDOR_ID && info.product== PRODUCT_ID) {
/* 这⾥添加设备的初始化代码 */
device_num++; /* 找到的设备数 */
}
close(fd);
}
}
return device_num; /* 返回寻找的设备数量 */
}
我们再来看libusb是如何来寻找和初始化设备
int Device_Find()
{
struct usb_bus *busses;
int device_num = 0;
device_num = 0; /* 记录设备数量 */
usb_init(); /* 初始化 */
usb_find_busses(); /* 寻找系统上的usb总线 */
usb_find_devices(); /* 寻找usb总线上的usb设备 */
/* 获得系统总线链表的句柄 */
busses = usb_get_busses();
struct usb_bus *bus;
/* 遍历总线 */
for (bus = busses; bus; bus = bus->next) {
struct usb_device *dev;
/* 遍历总线上的设备 */
for (dev = bus->devices; dev; dev = dev->next) {
/* 寻找到相关设备， */
if(dev->descriptor.idVendor==VENDOR_ID&& dev->descriptor.idProduct == PRODUCT_ID) {
/* 这⾥添加设备的初始化代码 */
device_num++; /* 找到的设备数 */
}
}
}
return device_num; /* 返回设备数量 */
}
注：在新版本的libusb中，usb_get_busses就可以不⽤了，这个函数是返回系统上的usb总线链表句柄
这⾥我们直接⽤usb_busses变量，这个变量在usb.h中被定义为外部变量
所以可以直接写成这样：
struct usb_bus *bus;
for (bus = usb_busses; bus; bus = bus->next) {
struct usb_device *dev;
for (dev = bus->devices; dev; dev = dev->next) {
/* 这⾥添加设备的初始化代码 */
}
}
3.2 打开设备
假设我们定义的打开设备的函数名是device_open,
/* 使⽤hid驱动打开设备 */
int Device_Open()
{
int handle;
/* 传统HID驱动调⽤,通过open打开设备⽂件就可 */
handle = open(“hiddev0”, O_RDONLY);
}
/* 使⽤libusb打开驱动 */
int Device_Open()
{
/* LIBUSB 驱动打开设备，这⾥写的是伪代码，不保证代码有⽤ */
struct usb_device* udev;
usb_dev_handle* device_handle;
/* 当找到设备后，通过usb_open打开设备，这⾥的函数就相当open 函数 */
device_handle = usb_open(udev);
}
3.3 读写设备和操作设备
假设我们的设备使⽤控制传输⽅式，⾄于批处理传输和中断传输限于篇幅这⾥不介绍
我们这⾥定义三个函数，Device_Write, Device_Read, Device_Report
Device_Report 功能发送接收函数
Device_Write 功能写数据
Device_Read 功能读数据
Device_Write和Device_Read调⽤Device_Report发送写的信息和读的信息，开发者根据发送的命令协议来设计，我们这⾥只简单实现发送数据的函数。

假设我们要给设备发送72字节的数据，头8个字节是报告头，是我们定义的和设备相关的规则，后64位是数据。

HID驱动的实现(这⾥只是⽤代码来有助理解，代码是伪代码)
int Device_Report(int fd, unsigned char *buffer72)
{
int ret; /* 保存ioctl函数的返回值 */
int index;
unsigned char send_data[72]; /* 发送的数据 */
unsigned char recv_data[72]; /* 接收的数据 */
struct hiddev_usage_ref uref; /* hid驱动定义的数据包 */
struct hiddev_report_info rinfo; /* hid驱动定义的
memset(send_data, 0, sizeof(send_data));
memset(recv_data, 0, sizeof(recv_data));
memcpy(send_data, buffer72, 72);
/* 这在发送数据之前必须调⽤的，初始化设备 */
ret = ioctl(fd, HIDIOCINITREPORT, 0);
if( ret !=0) {
return NOT_OPENED_DEVICE;/* NOT_OPENED_DEVICE 属于⾃⼰定义宏 */
}
/* HID设备每次传输⼀个字节的数据包 */
for(index = 0; index < 72; index++) {
/* 设置发送数据的状态 */
uref.report_type = HID_REPORT_TYPE_FEATURE;
uref.report_id = HID_REPORT_ID_FIRST;
age_index = index;
uref.field_index = 0;
uref.value = send_data[index];
ioctl(fd, HIDIOCGUCODE, &uref);
ret=ioctl(fd, HIDIOCSUSAGE, &uref);
if(ret != 0 ){
return UNKNOWN_ERROR;
}
}
/* 发送数据 */
rinfo.report_type = HID_REPORT_TYPE_FEATURE;
rinfo.report_id = HID_REPORT_ID_FIRST;
rinfo.num_fields = 1;
ret=ioctl(fd, HIDIOCSREPORT, &rinfo); /* 发送数据 */
if(ret != 0) {
return WRITE_REPORT;
}
/* 接受数据 */
ret = ioctl(fd, HIDIOCINITREPORT, 0);
for(index = 0; index < 72; index++) {
uref.report_type = HID_REPORT_TYPE_FEATURE;
uref.report_id = HID_REPORT_ID_FIRST;
age_index = index;
uref.field_index = 0;
ioctl(fd, HIDIOCGUCODE, &uref);
ret = ioctl(fd, HIDIOCGUSAGE, &uref);
if(ret != 0 ) {
return UNKNOWN_ERROR;
}
recv_data[index] = uref.value;
}
memcpy(buffer72, recv_data, 72);
return SUCCESS;
}
libusb驱动的实现
int Device_Report(int fd, unsigned char *buffer72)
{
/* 定义设备句柄 */
usb_dev_handle* Device_handle;
/* save the data of send and receive */
unsigned char send_data[72];
unsigned char recv_data[72];
int send_len;
int recv_len;
/* 数据置空 */
memset(send_data, 0 , sizeof(send_data));
memset(recv_data, 0 , sizeof(recv_data));
/* 这⾥的g_list是全局的数据变量，⾥⾯可以存储相关设备的所需信息，当然我们也可以从函数形参中传输进来，设备的信息在打开设备时初始化，我们将在后⾯的总结中详细描述⼀下 */
Device_handle = (usb_dev_handle*)(g_list[fd].device_handle);
if (Device_handle == NULL) {
return NOT_OPENED_DEVICE;
}
/* 这个函数前⾯已经说过，在操作设备前是必须调⽤的, 0是指⽤默认的设备 */
usb_claim_interface(Device_handle, 0);
/* 发送数据，所⽤到的宏定义在usb.h可以找到，我列出来⼤家看⼀下
#define USB_ENDPOINT_OUT 0x00
#define USB_TYPE_CLASS (0x01 << 5)
#define USB_RECIP_INTERFACE 0x01
#define HID_REPORT_SET 0x09 */
send_len = usb_control_msg(Device_handle,
USB_ENDPOINT_OUT + USB_TYPE_CLASS + USB_RECIP_INTERFACE,
HID_REPORT_SET,
0x300,
0,
send_data, 72, USB_TIMEOUT);
/* 发送数据有错误 */
if (send_len < 0) {
return WRITE_REPORT;
}
if (send_len != 72) {
return send_len;
}
/* 接受数据
#define USB_ENDPOINT_IN 0x80
#define USB_TYPE_CLASS (0x01 << 5)
#define USB_RECIP_INTERFACE 0x01
#define HID_REPORT_GET 0x01
*/
recv_len = usb_control_msg(Device_handle,
USB_ENDPOINT_IN + USB_TYPE_CLASS + USB_RECIP_INTERFACE,
HID_REPORT_GET,
0x300,
0,
recv_data, 72, USB_TIMEOUT);
if (recv_len < 0) {
printf("failed to retrieve report from USB device!\n");
return READ_REPORT;
}
if (recv_len != 72) {
return recv_len;
}
/* 和usb_claim_interface对应 */
usb_release_interface(RY2_handle, 0);
memcpy(buffer72, recv_data, 72);
return SUCCESS;
}
3.4 关闭设备
假设我们定义的关闭设备的函数名是Device_Close()
/* 使⽤hid驱动关闭设备 */
int Device_Close()
{
int handle;
handle = open(“hiddev0”, O_RDONLY);
/* 传统HID驱动调⽤,通过close()设备⽂件就可 */
close( handle );
}
/* 使⽤libusb关闭驱动 */
int Device_Close()
{
/* LIBUSB 驱动打开设备，这⾥写的是伪代码，不保证代码有⽤ */
struct usb_device* udev;
usb_dev_handle* device_handle;
device_handle = usb_open(udev);
/* libusb库使⽤usb_close关闭程序 */
usb_close(device_handle);
}
libusb的驱动框架
前⾯我们看了些主要的libusb函数的使⽤，这⾥我们把前⾯的内容归纳下：
⼀般的驱动应该都包含如下接⼝：
Device_Find(); /* 寻找设备接⼝ */
Device_Open(); /* 打开设备接⼝ */
Device_Write(); /* 写设备接⼝ */
Device_Read(); /* 读设备接⼝ */
Device_Close(); /* 关闭设备接⼝ */
具体代码如下：
#include <usb.h>
/* usb.h 这个头⽂件是要包括的，⾥⾯包含了必须要⽤到的数据结构 */
/* 我们将⼀个设备的属性⽤⼀个结构体来概括 */
typedef struct
{
struct usb_device* udev;
usb_dev_handle* device_handle;
/* 这⾥可以添加设备的其他属性，这⾥只列出每个设备要⽤到的属性 */
} device_descript;
/* ⽤来设置传输数据的时间延迟 */
#define USB_TIMEOUT 10000
/* ⼚家 ID 和产品 ID */
#define VENDOR_ID 0xffff
#define PRODUCT_ID 0xffff
/* 这⾥定义数组来保存设备的相关属性， DEVICE_MINOR 可以设置能够同时操作的设备数量，⽤全局变量的⽬的在于⽅便保存属性 */ #define DEVICE_MINOR 16
int g_num;
device_descript g_list[ DEVICE_MINOR ];
/* 我们写个设备先找到设备，并把相关信息保存在 g_list 中 */
int Device_Find()
{
struct usb_bus *bus;
struct usb_device *dev;
g_num = 0;
usb_find_busses();
usb_find_devices();
/* 寻找设备 */
for (bus = usb_busses; bus; bus = bus->next) {
for (dev = bus->devices; dev; dev = dev->next) {
if(dev->descriptor.idVendor==VENDOR_ID&& dev->descriptor.idProduct == PRODUCT_ID) { /* 保存设备信息 */
if (g_num < DEVICE_MINOR) {
g_list[g_num].udev = dev;
g_num ++;
}
}
}
}
return g_num;
}
/* 找到设备后，我们根据信息打开设备 */
int Device_Open()
{
/* 根据情况打开你所需要操作的设备，这⾥我们仅列出伪代码 */
if(g_list[g_num].udev != NULL) {
g_list[g_num].device_handle = usb_open(g_list[g_num].udev);
}
}
/* 下⾯就是操作设备的函数了，我们就不列出来拉，⼤家可以参考上⾯的介绍 */
int DeviceWite(int handle)
{
/* 填写相关代码，具体查看设备协议 */
}
int DeviceOpen(int handle)
{
/* 填写相关代码，具体查看设备协议 */
}
/* 最后不要忘记关闭设备 */
void Device_close(int handle)
{
/* 调⽤ usb_close */
}。