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;

    uref.usage_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;

    uref.usage_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 */

}