71 lines
3.2 KiB
C
71 lines
3.2 KiB
C
|
/* Name: hiddata.h
|
||
|
|
* Author: Christian Starkjohann
|
||
|
|
* Creation Date: 2008-04-11
|
||
|
|
* Tabsize: 4
|
||
|
|
* Copyright: (c) 2008 by OBJECTIVE DEVELOPMENT Software GmbH
|
||
|
|
* License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt)
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef __HIDDATA_H_INCLUDED__
|
||
|
|
#define __HIDDATA_H_INCLUDED__
|
||
|
|
|
||
|
|
/*
|
||
|
|
General Description:
|
||
|
|
This module implements an abstraction layer for data transfer over HID feature
|
||
|
|
requests. The implementation uses native Windows functions on Windows so that
|
||
|
|
no driver installation is required and libusb on Unix. You must link the
|
||
|
|
appropriate libraries in either case: "-lhid -lusb -lsetupapi" on Windows and
|
||
|
|
`libusb-config --libs` on Unix.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/* ------------------------------------------------------------------------ */
|
||
|
|
|
||
|
|
#define USBOPEN_SUCCESS 0 /* no error */
|
||
|
|
#define USBOPEN_ERR_ACCESS 1 /* not enough permissions to open device */
|
||
|
|
#define USBOPEN_ERR_IO 2 /* I/O error */
|
||
|
|
#define USBOPEN_ERR_NOTFOUND 3 /* device not found */
|
||
|
|
|
||
|
|
/* ------------------------------------------------------------------------ */
|
||
|
|
|
||
|
|
typedef struct usbDevice usbDevice_t;
|
||
|
|
/* Opaque data type representing the USB device. This can be a Windows handle
|
||
|
|
* or a libusb handle, depending on the backend implementation.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/* ------------------------------------------------------------------------ */
|
||
|
|
|
||
|
|
int usbhidOpenDevice(usbDevice_t **device, int vendorID, char *vendorName, int productID, char *productName, int usesReportIDs);
|
||
|
|
/* This function opens a USB device. 'vendorID' and 'productID' are the numeric
|
||
|
|
* Vendor-ID and Product-ID of the device we want to open. If 'vendorName' and
|
||
|
|
* 'productName' are both not NULL, only devices with matching manufacturer-
|
||
|
|
* and product name strings are accepted. If the device uses report IDs,
|
||
|
|
* 'usesReportIDs' must be set to a non-zero value.
|
||
|
|
* Returns: If a matching device has been found, USBOPEN_SUCCESS is returned
|
||
|
|
* and '*device' is set to an opaque pointer representing the device. The
|
||
|
|
* device must be closed with usbhidCloseDevice(). If the device has not been
|
||
|
|
* found or opening failed, an error code is returned.
|
||
|
|
*/
|
||
|
|
void usbhidCloseDevice(usbDevice_t *device);
|
||
|
|
/* Every device opened with usbhidOpenDevice() must be closed with this function.
|
||
|
|
*/
|
||
|
|
int usbhidSetReport(usbDevice_t *device, char *buffer, int len);
|
||
|
|
/* This function sends a feature report to the device. The report ID must be
|
||
|
|
* in the first byte of buffer and the length 'len' of the report is specified
|
||
|
|
* including this report ID. If no report IDs are used, buffer[0] must be set
|
||
|
|
* to 0 (dummy report ID).
|
||
|
|
* Returns: 0 on success, an error code otherwise.
|
||
|
|
*/
|
||
|
|
int usbhidGetReport(usbDevice_t *device, int reportID, char *buffer, int *len);
|
||
|
|
/* This function obtains a feature report from the device. The requested
|
||
|
|
* report-ID is passed in 'reportID'. The caller must pass a buffer of the size
|
||
|
|
* of the expected report in 'buffer' and initialize the variable pointed to by
|
||
|
|
* 'len' to the total size of this buffer. Upon successful return, the report
|
||
|
|
* (prefixed with the report-ID) is in 'buffer' and the actual length of the
|
||
|
|
* report is returned in '*len'.
|
||
|
|
* Returns: 0 on success, an error code otherwise.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/* ------------------------------------------------------------------------ */
|
||
|
|
|
||
|
|
#endif /* __HIDDATA_H_INCLUDED__ */
|