usbh_hid.h

Go to the documentation of this file.

#ifndef __INCLUDED_HID_H__
#define __INCLUDED_HID_H__
 
#include <usbh_core.h>
 
 
 
 
//#define HID_DEBUG
 
/*
 * Debug message
 */
#ifdef HID_DEBUG
#define HID_DBGMSG      printf
#else
#define HID_DBGMSG(...)
#endif
 
 
 
#define CONFIG_HID_MAX_DEV            3     
#define HID_MAX_BUFFER_SIZE           64    
#define HID_CLIENT_SIZE               64    
/*
 * Constants
 */
#define HID_RET_OK                      0   
#define HID_RET_DEV_NOT_FOUND          -9   
#define HID_RET_IO_ERR                -11   
#define HID_RET_INVALID_PARAMETER     -13   
#define HID_RET_OUT_OF_MEMORY         -15   
#define HID_RET_NOT_SUPPORTED         -17   
#define HID_REPORT_GET                0x01  
#define HID_GET_IDLE                  0x02  
#define HID_GET_PROTOCOL              0x03  
#define HID_REPORT_SET                0x09  
#define HID_SET_IDLE                  0x0A  
#define HID_SET_PROTOCOL              0x0B  
/*
 * Report type
 */
#define RT_INPUT          1      
#define RT_OUTPUT         2      
#define RT_FEATURE        3       /* end of group USBH_HID_EXPORTED_CONSTANTS */
 
 
struct usbhid_dev;               
typedef void (HID_IR_FUNC)(struct usbhid_dev *hdev, uint8_t *rdata, int data_len);      
typedef void (HID_IW_FUNC)(struct usbhid_dev *hdev, uint8_t **wbuff, int *buff_size);    /* end of group USBH_HID_EXPORTED_TYPEDEFS */
 
 
/*-----------------------------------------------------------------------------------
 *  HID device
 */
typedef struct usbhid_dev
{
    USB_DEV_T           *udev;          
    int                 ifnum;          
    uint8_t             bSubClassCode;  
    uint8_t             bProtocolCode;  
    URB_T               *urbin;         
    URB_T               *urbout;        
    uint8_t             inbuf[HID_MAX_BUFFER_SIZE];  
    HID_IR_FUNC         *read_func;     
    HID_IW_FUNC         *write_func;    
    struct usbhid_dev   *next;          
    uint8_t             client[HID_CLIENT_SIZE]; 
} HID_DEV_T;                             /* end of group USBH_HID_EXPORTED_STRUCTURES */
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
void     USBH_HidInit(void);
HID_DEV_T * USBH_HidGetDeviceList(void);
int32_t  HID_HidGetReportDescriptor(HID_DEV_T *hdev, uint8_t *desc_buf, int buf_max_len);
int32_t  HID_HidGetReport(HID_DEV_T *hdev, int rtp_typ, int rtp_id, uint8_t *data, int len);
int32_t  HID_HidSetReport(HID_DEV_T *hdev, int rtp_typ, int rtp_id, uint8_t *data, int len);
int32_t  HID_HidGetIdle(HID_DEV_T *hdev, int rtp_id, uint8_t *idle_rate);
int32_t  HID_HidSetIdle(HID_DEV_T *hdev, int rtp_id, uint8_t idle_rate);
int32_t  HID_HidGetProtocol(HID_DEV_T *hdev, uint8_t *protocol);
int32_t  HID_HidSetProtocol(HID_DEV_T *hdev, uint8_t protocol);
int32_t  USBH_HidStartIntReadPipe(HID_DEV_T *hdev, HID_IR_FUNC *func);
int32_t  USBH_HidStartIntWritePipe(HID_DEV_T *hdev, HID_IW_FUNC *func);
 
 /* end of group USBH_HID_EXPORTED_FUNCTIONS */
 /* end of group USBH_HID_Driver */
 /* end of group USB_Host_Driver */
 /* end of group Component_Library */
 
#ifdef __cplusplus
}
#endif
 
#endif /* __INCLUDED_HID_H__ */