opendevice.h 4.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. /*
  2. * =====================================================================================
  3. *
  4. * ________ .__ __ ________ ____ ________
  5. * \_____ \ __ __|__| ____ | | __\______ \ _______ _/_ |/ _____/
  6. * / / \ \| | \ |/ ___\| |/ / | | \_/ __ \ \/ /| / __ \
  7. * / \_/. \ | / \ \___| < | ` \ ___/\ / | \ |__\ \
  8. * \_____\ \_/____/|__|\___ >__|_ \/_______ /\___ >\_/ |___|\_____ /
  9. * \__> \/ \/ \/ \/ \/
  10. *
  11. * www.optixx.org
  12. *
  13. *
  14. * Version: 1.0
  15. * Created: 07/21/2009 03:32:16 PM
  16. * Author: david@optixx.org
  17. * Based on: custom-class, a basic USB example
  18. * Author: Christian Starkjohann
  19. * =====================================================================================
  20. */
  21. #ifndef __OPENDEVICE_H_INCLUDED__
  22. #define __OPENDEVICE_H_INCLUDED__
  23. #include <usb.h> /* this is libusb, see http://libusb.sourceforge.net/ */
  24. #include <stdio.h>
  25. int usbGetStringAscii(usb_dev_handle *dev, int index, char *buf, int buflen);
  26. /* This function gets a string descriptor from the device. 'index' is the
  27. * string descriptor index. The string is returned in ISO Latin 1 encoding in
  28. * 'buf' and it is terminated with a 0-character. The buffer size must be
  29. * passed in 'buflen' to prevent buffer overflows. A libusb device handle
  30. * must be given in 'dev'.
  31. * Returns: The length of the string (excluding the terminating 0) or
  32. * a negative number in case of an error. If there was an error, use
  33. * usb_strerror() to obtain the error message.
  34. */
  35. int usbOpenDevice(usb_dev_handle **device, int vendorID, char *vendorNamePattern, int productID, char *productNamePattern, char *serialNamePattern, FILE *printMatchingDevicesFp, FILE *warningsFp);
  36. /* This function iterates over all devices on all USB busses and searches for
  37. * a device. Matching is done first by means of Vendor- and Product-ID (passed
  38. * in 'vendorID' and 'productID'. An ID of 0 matches any numeric ID (wildcard).
  39. * When a device matches by its IDs, matching by names is performed. Name
  40. * matching can be done on textual vendor name ('vendorNamePattern'), product
  41. * name ('productNamePattern') and serial number ('serialNamePattern'). A
  42. * device matches only if all non-null pattern match. If you don't care about
  43. * a string, pass NULL for the pattern. Patterns are Unix shell style pattern:
  44. * '*' stands for 0 or more characters, '?' for one single character, a list
  45. * of characters in square brackets for a single character from the list
  46. * (dashes are allowed to specify a range) and if the lis of characters begins
  47. * with a caret ('^'), it matches one character which is NOT in the list.
  48. * Other parameters to the function: If 'warningsFp' is not NULL, warning
  49. * messages are printed to this file descriptor with fprintf(). If
  50. * 'printMatchingDevicesFp' is not NULL, no device is opened but matching
  51. * devices are printed to the given file descriptor with fprintf().
  52. * If a device is opened, the resulting USB handle is stored in '*device'. A
  53. * pointer to a "usb_dev_handle *" type variable must be passed here.
  54. * Returns: 0 on success, an error code (see defines below) on failure.
  55. */
  56. /* usbOpenDevice() error codes: */
  57. #define USBOPEN_SUCCESS 0 /* no error */
  58. #define USBOPEN_ERR_ACCESS 1 /* not enough permissions to open device */
  59. #define USBOPEN_ERR_IO 2 /* I/O error */
  60. #define USBOPEN_ERR_NOTFOUND 3 /* device not found */
  61. /* Obdev's free USB IDs, see USBID-License.txt for details */
  62. #define USB_VID_OBDEV_SHARED 5824 /* obdev's shared vendor ID */
  63. #define USB_PID_OBDEV_SHARED_CUSTOM 1500 /* shared PID for custom class devices */
  64. #define USB_PID_OBDEV_SHARED_HID 1503 /* shared PID for HIDs except mice & keyboards */
  65. #define USB_PID_OBDEV_SHARED_CDCACM 1505 /* shared PID for CDC Modem devices */
  66. #define USB_PID_OBDEV_SHARED_MIDI 1508 /* shared PID for MIDI class devices */
  67. #endif /* __OPENDEVICE_H_INCLUDED__ */