一、 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 */
}


小結
   到此,使用libusb進行驅動程式開發介紹完了,通過對函式庫所提供的API的使用可以體會到libusb的易用性。

 

 

//本文转载自http://blog.csdn.net/leino11121/article/details/6344088

//仅供学习参考 欢迎交流