lib/libusb/libusb.3

   1 .\"
   2 .\" Copyright (c) 2009 Sylvestre Gallon
   3 .\"
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/lib/libusb/libusb.3,v 1.27 2012/05/11 20:06:46 gjb Exp $
  28 .\"
  29 .Dd October 14, 2012
  30 .Dt LIBUSB 3
  31 .Os
  32 .Sh NAME
  33 .Nm libusb
  34 .Nd "USB access library"
  35 .Sh LIBRARY
  36 USB access library
  37 .Pq libusb, -lusb
  38 .Sh SYNOPSIS
  39 .In libusb.h
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 library contains interfaces for directly managing a usb device.
  44 The current implementation supports v1.0 of the libusb API.
  45 .Sh LIBRARY INITIALISATION / DEINITIALISATION
  46 .Ft int
  47 .Fn libusb_init libusb_context **ctx
  48 This function initialises libusb.
  49 It must be called at the beginning
  50 of the program, before other libusb routines are used.
  51 This function returns 0 on success or LIBUSB_ERROR on
  52 failure.
  53 .Pp
  54 .Ft void
  55 .Fn libusb_exit "libusb_context *ctx"
  56 Deinitialise libusb.
  57 Must be called at the end of the application.
  58 Other libusb routines may not be called after this function.
  59 .Pp
  60 .Ft const char *
  61 .Fn libusb_strerror "int code"
  62 Get the ASCII representation of the error given by the
  63 .Fa code
  64 argument.
  65 This function does not return NULL.
  66 .Pp
  67 .Ft const char *
  68 .Fn libusb_error_name "int code"
  69 Get the ASCII representation of the error enum given by the
  70 .Fa code
  71 argument.
  72 This function does not return NULL.
  73 .Pp
  74 .Ft void
  75 .Fn libusb_set_debug "libusb_context *ctx" "int level"
  76 Set the debug level to
  77 .Fa level .
  78 .Pp
  79 .Ft ssize_t
  80 .Fn libusb_get_device_list "libusb_context *ctx" "libusb_device ***list"
  81 Populate
  82 .Fa list
  83 with the list of usb devices available, adding a reference to each
  84 device in the list.
  85 All the list entries created by this
  86 function must have their reference counter
  87 decremented when you are done with them,
  88 and the list itself must be freed.
  89 This
  90 function returns the number of devices in the list or a LIBUSB_ERROR code.
  91 .Pp
  92 .Ft void
  93 .Fn libusb_free_device_list "libusb_device **list" "int unref_devices"
  94 Free the list of devices discovered by libusb_get_device_list.
  95 If
  96 .Fa unref_device
  97 is set to 1 all devices in the list have their reference
  98 counter decremented once.
  99 .Pp
 100 .Ft uint8_t
 101 .Fn libusb_get_bus_number "libusb_device *dev"
 102 Returns the number of the bus contained by the device
 103 .Fa dev .
 104 .Pp
 105 .Ft uint8_t
 106 .Fn libusb_get_device_address "libusb_device *dev"
 107 Returns the device_address contained by the device
 108 .Fa dev .
 109 .Pp
 110 .Ft enum libusb_speed
 111 .Fn libusb_get_device_speed "libusb_device *dev"
 112 Returns the wire speed at which the device is connected.
 113 See the LIBUSB_SPEED_XXX enums for more information.
 114 LIBUSB_SPEED_UNKNOWN is returned in case of unknown wire speed.
 115 .Pp
 116 .Ft int
 117 .Fn libusb_get_max_packet_size "libusb_device *dev" "unsigned char endpoint"
 118 Returns the wMaxPacketSize value on success, LIBUSB_ERROR_NOT_FOUND if the
 119 endpoint does not exist and LIBUSB_ERROR_OTHERS on other failure.
 120 .Pp
 121 .Ft int
 122 .Fn libusb_get_max_iso_packet_size "libusb_device *dev" "unsigned char endpoint"
 123 Returns the packet size multiplied by the packet multiplier on success,
 124 LIBUSB_ERROR_NOT_FOUND if the endpoint does not exist and
 125 LIBUSB_ERROR_OTHERS on other failure.
 126 .Pp
 127 .Ft libusb_device *
 128 .Fn libusb_ref_device "libusb_device *dev"
 129 Increment the reference counter of the device
 130 .Fa dev .
 131 .Pp
 132 .Ft void
 133 .Fn libusb_unref_device "libusb_device *dev"
 134 Decrement the reference counter of the device
 135 .Fa dev .
 136 .Pp
 137 .Ft int
 138 .Fn libusb_open "libusb_device *dev" "libusb_device_handle **devh"
 139 Open a device and obtain a device_handle.
 140 Returns 0 on success,
 141 LIBUSB_ERROR_NO_MEM on memory allocation problems, LIBUSB_ERROR_ACCESS
 142 on permissions problems, LIBUSB_ERROR_NO_DEVICE if the device has been
 143 disconnected and a LIBUSB_ERROR code on other errors.
 144 .Pp
 145 .Ft libusb_device_handle *
 146 .Fn libusb_open_device_with_vid_pid "libusb_context *ctx" "uint16_t vid" "uint16_t pid"
 147 A convenience function to open a device by vendor and product IDs
 148 .Fa vid
 149 and
 150 .Fa pid .
 151 Returns NULL on error.
 152 .Pp
 153 .Ft void
 154 .Fn libusb_close "libusb_device_handle *devh"
 155 Close a device handle.
 156 .Pp
 157 .Ft libusb_device *
 158 .Fn libusb_get_device "libusb_device_handle *devh"
 159 Get the device contained by devh.
 160 Returns NULL on error.
 161 .Pp
 162 .Ft int
 163 .Fn libusb_get_configuration "libusb_device_handle *devh" "int *config"
 164 Returns the value of the current configuration.
 165 Returns 0
 166 on success, LIBUSB_ERROR_NO_DEVICE if the device has been disconnected
 167 and a LIBUSB_ERROR code on error.
 168 .Pp
 169 .Ft int
 170 .Fn libusb_set_configuration "libusb_device_handle *devh" "int config"
 171 Set the active configuration to
 172 .Fa config
 173 for the device contained by
 174 .Fa devh .
 175 This function returns 0 on success, LIBUSB_ERROR_NOT_FOUND if the requested
 176 configuration does not exist, LIBUSB_ERROR_BUSY if the interfaces are currently
 177 claimed, LIBUSB_ERROR_NO_DEVICE if the device has been disconnected and a
 178 LIBUSB_ERROR code on failure.
 179 .Pp
 180 .Ft int
 181 .Fn libusb_claim_interface "libusb_device_handle *devh" "int interface_number"
 182 Claim an interface in a given libusb_handle
 183 .Fa devh .
 184 This is a non-blocking function.
 185 It returns 0 on success, LIBUSB_ERROR_NOT_FOUND
 186 if the requested interface does not exist, LIBUSB_ERROR_BUSY if a program or
 187 driver has claimed the interface, LIBUSB_ERROR_NO_DEVICE if the device has
 188 been disconnected and a LIBUSB_ERROR code on failure.
 189 .Pp
 190 .Ft int
 191 .Fn libusb_release_interface "libusb_device_handle *devh" "int interface_number"
 192 This function releases an interface.
 193 All the claimed interfaces on a device must be released
 194 before closing the device.
 195 Returns 0 on success, LIBUSB_ERROR_NOT_FOUND if the
 196 interface was not claimed, LIBUSB_ERROR_NO_DEVICE if the device has been
 197 disconnected and LIBUSB_ERROR on failure.
 198 .Pp
 199 .Ft int
 200 .Fn libusb_set_interface_alt_setting "libusb_device_handle *dev" "int interface_number" "int alternate_setting"
 201 Activate an alternate setting for an interface.
 202 Returns 0 on success,
 203 LIBUSB_ERROR_NOT_FOUND if the interface was not claimed or the requested
 204 setting does not exist, LIBUSB_ERROR_NO_DEVICE if the device has been
 205 disconnected and a LIBUSB_ERROR code on failure.
 206 .Pp
 207 .Ft int
 208 .Fn libusb_clear_halt "libusb_device_handle *devh" "unsigned char endpoint"
 209 Clear an halt/stall for a endpoint.
 210 Returns 0 on success, LIBUSB_ERROR_NOT_FOUND
 211 if the endpoint does not exist, LIBUSB_ERROR_NO_DEVICE if the device has been
 212 disconnected and a LIBUSB_ERROR code on failure.
 213 .Pp
 214 .Ft int
 215 .Fn libusb_reset_device "libusb_device_handle *devh"
 216 Perform an USB port reset for an usb device.
 217 Returns 0 on success,
 218 LIBUSB_ERROR_NOT_FOUND if re-enumeration is required or if the device has
 219 been disconnected and a LIBUSB_ERROR code on failure.
 220 .Pp
 221 .Ft int
 222 .Fn libusb_check_connected "libusb_device_handle *devh"
 223 Test if the USB device is still connected.
 224 Returns 0 on success,
 225 LIBUSB_ERROR_NO_DEVICE if it has been disconnected and a LIBUSB_ERROR
 226 code on failure.
 227 .Pp
 228 .Ft int
 229 .Fn libusb_kernel_driver_active "libusb_device_handle *devh" "int interface"
 230 Determine if a driver is active on a interface.
 231 Returns 0 if no kernel driver is active
 232 and 1 if a kernel driver is active, LIBUSB_ERROR_NO_DEVICE
 233 if the device has been disconnected and a LIBUSB_ERROR code on failure.
 234 .Pp
 235 .Ft int
 236 .Fn libusb_get_driver "libusb_device_handle *devh" "int interface" "char *name" "int namelen"
 237 or
 238 .Ft int
 239 .Fn libusb_get_driver_np "libusb_device_handle *devh" "int interface" "char *name" "int namelen"
 240 Copy the name of the driver attached to the given
 241 .Fa device
 242 and
 243 .Fa interface
 244 into the buffer
 245 .Fa name
 246 of length
 247 .Fa namelen .
 248 Returns 0 on success, LIBUSB_ERROR_NOT_FOUND if no kernel driver is attached
 249 to the given interface and LIBUSB_ERROR_INVALID_PARAM if the interface does
 250 not exist.
 251 This function is non-portable.
 252 The buffer pointed to by
 253 .Fa name
 254 is only zero terminated on success.
 255 .Pp
 256 .Ft int
 257 .Fn libusb_detach_kernel_driver "libusb_device_handle *devh" "int interface"
 258 or
 259 .Ft int
 260 .Fn libusb_detach_kernel_driver_np "libusb_device_handle *devh" "int interface"
 261 Detach a kernel driver from an interface.
 262 This is needed to claim an interface already claimed by a kernel driver.
 263 Returns 0 on success, LIBUSB_ERROR_NOT_FOUND if no kernel driver was active,
 264 LIBUSB_ERROR_INVALID_PARAM if the interface does not exist,
 265 LIBUSB_ERROR_NO_DEVICE if the device has been disconnected
 266 and a LIBUSB_ERROR code on failure.
 267 This function is non-portable.
 268 .Pp
 269 .Ft int
 270 .Fn libusb_attach_kernel_driver "libusb_device_handle *devh" "int interface"
 271 Re-attach an interface kernel driver that was previously detached.
 272 Returns 0 on success,
 273 LIBUSB_ERROR_INVALID_PARAM if the interface does not exist,
 274 LIBUSB_ERROR_NO_DEVICE
 275 if the device has been disconnected, LIBUSB_ERROR_BUSY if the driver cannot be
 276 attached because the interface is claimed by a program or driver and a
 277 LIBUSB_ERROR code on failure.
 278 .Sh USB DESCRIPTORS
 279 .Ft int
 280 .Fn libusb_get_device_descriptor "libusb_device *dev" "libusb_device_descriptor *desc"
 281 Get the USB device descriptor for the device
 282 .Fa dev .
 283 This is a non-blocking function.
 284 Returns 0 on success and a LIBUSB_ERROR code on
 285 failure.
 286 .Pp
 287 .Ft int
 288 .Fn libusb_get_active_config_descriptor "libusb_device *dev" "struct libusb_config_descriptor **config"
 289 Get the USB configuration descriptor for the active configuration.
 290 Returns 0 on
 291 success, LIBUSB_ERROR_NOT_FOUND if the device is in
 292 an unconfigured state
 293 and a LIBUSB_ERROR code on error.
 294 .Pp
 295 .Ft int
 296 .Fn libusb_get_config_descriptor "libusb_device *dev" "uint8_t config_index" "libusb_config_descriptor **config"
 297 Get a USB configuration descriptor based on its index
 298 .Fa idx.
 299 Returns 0 on success, LIBUSB_ERROR_NOT_FOUND if the configuration does not exist
 300 and a LIBUSB_ERROR code on error.
 301 .Pp
 302 .Ft int
 303 .Fn libusb_get_config_descriptor_by_value "libusb_device *dev" "uint8 bConfigurationValue" "libusb_config_descriptor **config"
 304 Get a USB configuration descriptor with a specific bConfigurationValue.
 305 This is
 306 a non-blocking function which does not send a request through the device.
 307 Returns 0
 308 on success, LIBUSB_ERROR_NOT_FOUND if the configuration
 309 does not exist and a
 310 LIBUSB_ERROR code on failure.
 311 .Pp
 312 .Ft void
 313 .Fn libusb_free_config_descriptor "libusb_config_descriptor *config"
 314 Free a configuration descriptor.
 315 .Pp
 316 .Ft int
 317 .Fn libusb_get_string_descriptor "libusb_device_handle *devh" "uint8_t desc_idx" "uint16_t langid" "unsigned char *data" "int length"
 318 Retrieve a string descriptor in raw format.
 319 Returns the number of bytes actually transferred on success
 320 or a negative LIBUSB_ERROR code on failure.
 321 .Pp
 322 .Ft int
 323 .Fn libusb_get_string_descriptor_ascii "libusb_device_handle *devh" "uint8_t desc_idx" "unsigned char *data" "int length"
 324 Retrieve a string descriptor in C style ASCII.
 325 Returns the positive number of bytes in the resulting ASCII string
 326 on success and a LIBUSB_ERROR code on failure.
 327 .Pp
 328 .Ft int
 329 .Fn libusb_parse_ss_endpoint_comp "const void *buf" "int len" "libusb_ss_endpoint_companion_descriptor **ep_comp"
 330 This function parses the USB 3.0 endpoint companion descriptor in host endian format pointed to by
 331 .Fa buf
 332 and having a length of
 333 .Fa len .
 334 Typically these arguments are the extra and extra_length fields of the
 335 endpoint descriptor.
 336 On success the pointer to resulting descriptor is stored at the location given by
 337 .Fa ep_comp .
 338 Returns zero on success and a LIBUSB_ERROR code on failure.
 339 On success the parsed USB 3.0 endpoint companion descriptor must be
 340 freed using the libusb_free_ss_endpoint_comp function.
 341 .Pp
 342 .Ft void
 343 .Fn libusb_free_ss_endpoint_comp "libusb_ss_endpoint_companion_descriptor *ep_comp"
 344 This function is NULL safe and frees a parsed USB 3.0 endpoint companion descriptor.
 345 .Pp
 346 .Ft int
 347 .Fn libusb_parse_bos_descriptor "const void *buf" "int len" "libusb_bos_descriptor **bos"
 348 This function parses a Binary Object Store, BOS, descriptor into host endian format pointed to by
 349 .Fa buf
 350 and having a length of
 351 .Fa len .
 352 On success the pointer to resulting descriptor is stored at the location given by
 353 .Fa bos .
 354 Returns zero on success and a LIBUSB_ERROR code on failure.
 355 On success the parsed BOS descriptor must be freed using the
 356 libusb_free_bos_descriptor function.
 357 .Pp
 358 .Ft void
 359 .Fn libusb_free_bos_descriptor "libusb_bos_descriptor *bos"
 360 This function is NULL safe and frees a parsed BOS descriptor.
 361 .Sh USB ASYNCHRONOUS I/O
 362 .Ft struct libusb_transfer *
 363 .Fn libusb_alloc_transfer "int iso_packets"
 364 Allocate a transfer with the number of isochronous packet descriptors
 365 specified by
 366 .Fa iso_packets .
 367 Returns NULL on error.
 368 .Pp
 369 .Ft void
 370 .Fn libusb_free_transfer "struct libusb_transfer *tr"
 371 Free a transfer.
 372 .Pp
 373 .Ft int
 374 .Fn libusb_submit_transfer "struct libusb_transfer *tr"
 375 This function will submit a transfer and returns immediately.
 376 Returns 0 on success, LIBUSB_ERROR_NO_DEVICE if
 377 the device has been disconnected and a
 378 LIBUSB_ERROR code on other failure.
 379 .Pp
 380 .Ft int
 381 .Fn libusb_cancel_transfer "struct libusb_transfer *tr"
 382 This function asynchronously cancels a transfer.
 383 Returns 0 on success and a LIBUSB_ERROR code on failure.
 384 .Sh USB SYNCHRONOUS I/O
 385 .Ft int
 386 .Fn libusb_control_transfer "libusb_device_handle *devh" "uint8_t bmRequestType" "uint8_t bRequest" "uint16_t wValue" "uint16_t wIndex" "unsigned char *data" "uint16_t wLength" "unsigned int timeout"
 387 Perform a USB control transfer.
 388 Returns the actual number of bytes
 389 transferred on success, in the range from and including zero up to and
 390 including
 391 .Fa wLength .
 392 On error a LIBUSB_ERROR code is returned, for example
 393 LIBUSB_ERROR_TIMEOUT if the transfer timed out, LIBUSB_ERROR_PIPE if the
 394 control request was not supported, LIBUSB_ERROR_NO_DEVICE if the
 395 device has been disconnected and another LIBUSB_ERROR code on other failures.
 396 The LIBUSB_ERROR codes are all negative.
 397 .Pp
 398 .Ft int
 399 .Fn libusb_bulk_transfer "struct libusb_device_handle *devh" "unsigned char endpoint" "unsigned char *data" "int length" "int *transferred" "unsigned int timeout"
 400 Perform an USB bulk transfer.
 401 A timeout value of zero means no timeout.
 402 The timeout value is given in milliseconds.
 403 Returns 0 on success, LIBUSB_ERROR_TIMEOUT
 404 if the transfer timed out, LIBUSB_ERROR_PIPE if the control request was not
 405 supported, LIBUSB_ERROR_OVERFLOW if the device offered more data,
 406 LIBUSB_ERROR_NO_DEVICE if the device has been disconnected and
 407 a LIBUSB_ERROR code on other failure.
 408 .Pp
 409 .Ft int
 410 .Fn libusb_interrupt_transfer "struct libusb_device_handle *devh" "unsigned char endpoint" "unsigned char *data" "int length" "int *transferred" "unsigned int timeout"
 411 Perform an USB Interrupt transfer.
 412 A timeout value of zero means no timeout.
 413 The timeout value is given in milliseconds.
 414 Returns 0 on success, LIBUSB_ERROR_TIMEOUT
 415 if the transfer timed out, LIBUSB_ERROR_PIPE if the control request was not
 416 supported, LIBUSB_ERROR_OVERFLOW if the device offered more data,
 417 LIBUSB_ERROR_NO_DEVICE if the device has been disconnected and
 418 a LIBUSB_ERROR code on other failure.
 419 .Sh USB EVENTS
 420 .Ft int
 421 .Fn libusb_try_lock_events "libusb_context *ctx"
 422 Try to acquire the event handling lock.
 423 Returns 0 if the lock was obtained and 1 if not.
 424 .Pp
 425 .Ft void
 426 .Fn libusb_lock_events "libusb_context *ctx"
 427 Acquire the event handling lock.
 428 This function is blocking.
 429 .Pp
 430 .Ft void
 431 .Fn libusb_unlock_events "libusb_context *ctx"
 432 Release the event handling lock.
 433 This will wake up any thread blocked
 434 on
 435 .Fn libusb_wait_for_event .
 436 .Pp
 437 .Ft int
 438 .Fn libusb_event_handling_ok "libusb_context *ctx"
 439 Determine if it still OK for this thread to be doing event handling.
 440 Returns 1
 441 if event handling can start or continue.
 442 Returns 0 if this thread must give up
 443 the events lock.
 444 .Pp
 445 .Ft int
 446 .Fn libusb_event_handler_active "libusb_context *ctx"
 447 Determine if an active thread is handling events.
 448 Returns 1 if there is a thread handling events and 0 if there
 449 are no threads currently handling events.
 450 .Pp
 451 .Ft void
 452 .Fn libusb_lock_event_waiters "libusb_context *ctx"
 453 Acquire the event_waiters lock.
 454 This lock is designed to be obtained in the
 455 situation where you want to be aware when events are completed, but some other
 456 thread is event handling so calling libusb_handle_events() is not allowed.
 457 .Pp
 458 .Ft void
 459 .Fn libusb_unlock_event_waiters "libusb_context *ctx"
 460 Release the event_waiters lock.
 461 .Pp
 462 .Ft int
 463 .Fn libusb_wait_for_event "libusb_context *ctx" "struct timeval *tv"
 464 Wait for another thread to signal completion of an event.
 465 Must be called
 466 with the event waiters lock held, see libusb_lock_event_waiters().
 467 This will
 468 block until the timeout expires or a transfer completes or a thread releases
 469 the event handling lock through libusb_unlock_events().
 470 Returns 0 after a
 471 transfer completes or another thread stops event handling, and 1 if the
 472 timeout expired.
 473 .Pp
 474 .Ft int
 475 .Fn libusb_handle_events_timeout "libusb_context *ctx" "struct timeval *tv"
 476 Handle any pending events by checking if timeouts have expired and by
 477 checking the set of file descriptors for activity.
 478 Returns 0 on success, or a
 479 LIBUSB_ERROR code on failure.
 480 .Pp
 481 .Ft int
 482 .Fn libusb_handle_events "libusb_context *ctx"
 483 Handle any pending events in blocking mode with a sensible timeout.
 484 Returns 0
 485 on success and a LIBUSB_ERROR code on failure.
 486 .Pp
 487 .Ft int
 488 .Fn libusb_handle_events_locked "libusb_context *ctx" "struct timeval *tv"
 489 Handle any pending events by polling file descriptors, without checking if
 490 another thread is already doing so.
 491 Must be called with the event lock held.
 492 .Pp
 493 .Ft int
 494 .Fn libusb_get_next_timeout "libusb_context *ctx" "struct timeval *tv"
 495 Determine the next internal timeout that libusb needs to handle.
 496 Returns 0
 497 if there are no pending timeouts, 1 if a timeout was returned, or a LIBUSB_ERROR
 498 code on failure.
 499 .Pp
 500 .Ft void
 501 .Fn libusb_set_pollfd_notifiers "libusb_context *ctx" "libusb_pollfd_added_cb added_cb" "libusb_pollfd_removed_cb remove_cb" "void *user_data"
 502 Register notification functions for file descriptor additions/removals.
 503 These functions will be invoked for every new or removed file descriptor
 504 that libusb uses as an event source.
 505 .Pp
 506 .Ft const struct libusb_pollfd **
 507 .Fn libusb_get_pollfds "libusb_context *ctx"
 508 Retrive a list of file descriptors that should be polled by your main loop as
 509 libusb event sources.
 510 Returns a NULL-terminated list on success or NULL on failure.
 511 .Sh LIBUSB VERSION 0.1 COMPATIBILITY
 512 The library is also compliant with LibUSB version 0.1.12.
 513 .Pp
 514 .Fn usb_open
 515 .Fn usb_close
 516 .Fn usb_get_string
 517 .Fn usb_get_string_simple
 518 .Fn usb_get_descriptor_by_endpoint
 519 .Fn usb_get_descriptor
 520 .Fn usb_parse_descriptor
 521 .Fn usb_parse_configuration
 522 .Fn usb_destroy_configuration
 523 .Fn usb_fetch_and_parse_descriptors
 524 .Fn usb_bulk_write
 525 .Fn usb_bulk_read
 526 .Fn usb_interrupt_write
 527 .Fn usb_interrupt_read
 528 .Fn usb_control_msg
 529 .Fn usb_set_configuration
 530 .Fn usb_claim_interface
 531 .Fn usb_release_interface
 532 .Fn usb_set_altinterface
 533 .Fn usb_resetep
 534 .Fn usb_clear_halt
 535 .Fn usb_reset
 536 .Fn usb_strerror
 537 .Fn usb_init
 538 .Fn usb_set_debug
 539 .Fn usb_find_busses
 540 .Fn usb_find_devices
 541 .Fn usb_device
 542 .Fn usb_get_busses
 543 .Fn usb_check_connected
 544 .Fn usb_get_driver_np
 545 .Fn usb_detach_kernel_driver_np
 546 .Sh SEE ALSO
 547 .Xr libusb20 3 ,
 548 .Xr usb 4 ,
 549 .Xr usbconfig 8 ,
 550 .Xr usbdump 8
 551 .Pp
 552 .Pa http://libusb.sourceforge.net/
 553 .Sh HISTORY
 554 .Nm
 555 support first appeared in
 556 .Fx 8.0 .