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$
  28 .\"
  29 .Dd August 16, 2011
  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 .Pp
  47 .Ft int
  48 .Fn libusb_init libusb_context **ctx
  49 This function initialises libusb.
  50 It must be called at the beginning
  51 of the program, before other libusb routines are used.
  52 This function returns 0 on success or LIBUSB_ERROR on
  53 failure.
  54 .Pp
  55 .Ft void
  56 .Fn libusb_exit "libusb_context *ctx"
  57 Deinitialise libusb.
  58 Must be called at the end of the application.
  59 Other libusb routines may not be called after this function.
  60 .Pp
  61 .Ft const char *
  62 .Fn libusb_strerror "int code"
  63 Get the ASCII representation of the error given by the
  64 .Fa code
  65 argument.
  66 This function does not return NULL.
  67 .Pp
  68 .Ft const char *
  69 .Fn libusb_error_name "int code"
  70 Get the ASCII representation of the error enum given by the
  71 .Fa code
  72 argument.
  73 This function does not return NULL.
  74 .Pp
  75 .Ft void
  76 .Fn libusb_set_debug "libusb_context *ctx" "int level"
  77 Set the debug level to
  78 .Fa level .
  79 .Pp
  80 .Ft ssize_t
  81 .Fn libusb_get_device_list "libusb_context *ctx" "libusb_device ***list"
  82 Populate
  83 .Fa list
  84 with the list of usb devices available, adding a reference to each
  85 device in the list.
  86 All the list entries created by this
  87 function must have their reference counter
  88 decremented when you are done with them,
  89 and the list itself must be freed.
  90 This
  91 function returns the number of devices in the list or a LIBUSB_ERROR code.
  92 .Pp
  93 .Ft void
  94 .Fn libusb_free_device_list "libusb_device **list" "int unref_devices"
  95 Free the list of devices discovered by libusb_get_device_list.
  96 If
  97 .Fa unref_device
  98 is set to 1 all devices in the list have their reference
  99 counter decremented once.
 100 .Pp
 101 .Ft uint8_t
 102 .Fn libusb_get_bus_number "libusb_device *dev"
 103 Returns the number of the bus contained by the device
 104 .Fa dev.
 105 .Pp
 106 .Ft uint8_t
 107 .Fn libusb_get_device_address "libusb_device *dev"
 108 Returns the device_address contained by the device
 109 .Fa dev.
 110 .Pp
 111 .Ft enum libusb_speed
 112 .Fn libusb_get_device_speed "libusb_device *dev"
 113 Returns the wire speed at which the device is connected.
 114 See the LIBUSB_SPEED_XXX enums for more information.
 115 LIBUSB_SPEED_UNKNOWN is returned in case of unknown wire speed.
 116 .Pp
 117 .Ft int
 118 .Fn libusb_get_max_packet_size "libusb_device *dev" "unsigned char endpoint"
 119 Returns the wMaxPacketSize value on success, LIBUSB_ERROR_NOT_FOUND if the
 120 endpoint does not exist and LIBUSB_ERROR_OTHERS on other failure.
 121 .Pp
 122 .Ft libusb_device *
 123 .Fn libusb_ref_device "libusb_device *dev"
 124 Increment the reference counter of the device
 125 .Fa dev.
 126 .Pp
 127 .Ft void
 128 .Fn libusb_unref_device "libusb_device *dev"
 129 Decrement the reference counter of the device
 130 .Fa dev.
 131 .Pp
 132 .Ft int
 133 .Fn libusb_open "libusb_device *dev" "libusb_device_handle **devh"
 134 Open a device and obtain a device_handle.
 135 Returns 0 on success,
 136 LIBUSB_ERROR_NO_MEM on memory allocation problems, LIBUSB_ERROR_ACCESS
 137 on permissions problems, LIBUSB_ERROR_NO_DEVICE if the device has been
 138 disconnected and a LIBUSB_ERROR code on other errors.
 139 .Pp
 140 .Ft libusb_device_handle *
 141 .Fn libusb_open_device_with_vid_pid "libusb_context *ctx" "uint16_t vid" "uint16_t pid"
 142 A convenience function to open a device by vendor and product IDs
 143 .Fa vid
 144 and
 145 .Fa pid.
 146 Returns NULL on error.
 147 .Pp
 148 .Ft void
 149 .Fn libusb_close "libusb_device_handle *devh"
 150 Close a device handle.
 151 .Pp
 152 .Ft libusb_device *
 153 .Fn libusb_get_device "libusb_device_handle *devh"
 154 Get the device contained by devh.
 155 Returns NULL on error.
 156 .Pp
 157 .Ft int
 158 .Fn libusb_get_configuration "libusb_device_handle *devh" "int *config"
 159 Returns the bConfiguration value of the current configuration.
 160 Returns 0
 161 on success, LIBUSB_ERROR_NO_DEVICE if the device has been disconnected
 162 and a LIBUSB_ERROR code on error.
 163 .Pp
 164 .Ft int
 165 .Fn libusb_set_configuration "libusb_device_handle *devh" "int config"
 166 Set the active configuration to
 167 .Fa config
 168 for the device contained by
 169 .Fa devh.
 170 This function returns 0 on success, LIBUSB_ERROR_NOT_FOUND if the requested
 171 configuration does not exist, LIBUSB_ERROR_BUSY if the interfaces are currently
 172 claimed, LIBUSB_ERROR_NO_DEVICE if the device has been disconnected and a
 173 LIBUSB_ERROR code on failure.
 174 .Pp
 175 .Ft int
 176 .Fn libusb_claim_interface "libusb_device_handle *devh" "int interface_number"
 177 Claim an interface in a given libusb_handle
 178 .Fa devh.
 179 This is a non-blocking function.
 180 It returns 0 on success, LIBUSB_ERROR_NOT_FOUND
 181 if the requested interface does not exist, LIBUSB_ERROR_BUSY if a program or
 182 driver has claimed the interface, LIBUSB_ERROR_NO_DEVICE if the device has
 183 been disconnected and a LIBUSB_ERROR code on failure.
 184 .Pp
 185 .Ft int
 186 .Fn libusb_release_interface "libusb_device_handle *devh" "int interface_number"
 187 This function releases an interface.
 188 All the claimed interfaces on a device must be released
 189 before closing the device.
 190 Returns 0 on success, LIBUSB_ERROR_NOT_FOUND if the
 191 interface was not claimed, LIBUSB_ERROR_NO_DEVICE if the device has been
 192 disconnected and LIBUSB_ERROR on failure.
 193 .Pp
 194 .Ft int
 195 .Fn libusb_set_interface_alt_setting "libusb_device_handle *dev" "int interface_number" "int alternate_setting"
 196 Activate an alternate setting for an interface.
 197 Returns 0 on success,
 198 LIBUSB_ERROR_NOT_FOUND if the interface was not claimed or the requested
 199 setting does not exist, LIBUSB_ERROR_NO_DEVICE if the device has been
 200 disconnected and a LIBUSB_ERROR code on failure.
 201 .Pp
 202 .Ft int
 203 .Fn libusb_clear_halt "libusb_device_handle *devh" "unsigned char endpoint"
 204 Clear an halt/stall for a endpoint.
 205 Returns 0 on success, LIBUSB_ERROR_NOT_FOUND
 206 if the endpoint does not exist, LIBUSB_ERROR_NO_DEVICE if the device has been
 207 disconnected and a LIBUSB_ERROR code on failure.
 208 .Pp
 209 .Ft int
 210 .Fn libusb_reset_device "libusb_device_handle *devh"
 211 Perform an USB port reset for an usb device.
 212 Returns 0 on success,
 213 LIBUSB_ERROR_NOT_FOUND if re-enumeration is required or if the device has
 214 been disconnected and a LIBUSB_ERROR code on failure.
 215 .Pp
 216 .Ft int
 217 .Fn libusb_check_connected "libusb_device_handle *devh"
 218 Test if the USB device is still connected.
 219 Returns 0 on success,
 220 LIBUSB_ERROR_NO_DEVICE if it has been disconnected and a LIBUSB_ERROR
 221 code on failure.
 222 .Pp
 223 .Ft int
 224 .Fn libusb_kernel_driver_active "libusb_device_handle *devh" "int interface"
 225 Determine if a driver is active on a interface.
 226 Returns 0 if no kernel driver is active
 227 and 1 if a kernel driver is active, LIBUSB_ERROR_NO_DEVICE
 228 if the device has been disconnected and a LIBUSB_ERROR code on failure.
 229 .Pp
 230 .Ft int
 231 .Fn libusb_get_driver "libusb_device_handle *devh" "int interface" "char *name" "int namelen"
 232 or
 233 .Ft int
 234 .Fn libusb_get_driver_np "libusb_device_handle *devh" "int interface" "char *name" "int namelen"
 235 Copy the name of the driver attached to the given
 236 .Fa device
 237 and
 238 .Fa interface
 239 into the buffer
 240 .Fa name
 241 of length
 242 .Fa namelen .
 243 Returns 0 on success, LIBUSB_ERROR_NOT_FOUND if no kernel driver is attached
 244 to the given interface and LIBUSB_ERROR_INVALID_PARAM if the interface does
 245 not exist.
 246 This function is non-portable.
 247 The buffer pointed to by
 248 .Fa name
 249 is only zero terminated on success.
 250 .Pp
 251 .Ft int
 252 .Fn libusb_detach_kernel_driver "libusb_device_handle *devh" "int interface"
 253 or
 254 .Ft int
 255 .Fn libusb_detach_kernel_driver_np "libusb_device_handle *devh" "int interface"
 256 Detach a kernel driver from an interface.
 257 This is needed to claim an interface already claimed by a kernel driver.
 258 Returns 0 on success, LIBUSB_ERROR_NOT_FOUND if no kernel driver was active,
 259 LIBUSB_ERROR_INVALID_PARAM if the interface does not exist,
 260 LIBUSB_ERROR_NO_DEVICE if the device has been disconnected
 261 and a LIBUSB_ERROR code on failure.
 262 This function is non-portable.
 263 .Pp
 264 .Ft int
 265 .Fn libusb_attach_kernel_driver "libusb_device_handle *devh" "int interface"
 266 Re-attach an interface kernel driver that was previously detached.
 267 Returns 0 on success,
 268 LIBUSB_ERROR_INVALID_PARAM if the interface does not exist,
 269 LIBUSB_ERROR_NO_DEVICE
 270 if the device has been disconnected, LIBUSB_ERROR_BUSY if the driver cannot be
 271 attached because the interface is claimed by a program or driver and a
 272 LIBUSB_ERROR code on failure.
 273 .Pp
 274 .Sh USB DESCRIPTORS
 275 .Pp
 276 .Ft int
 277 .Fn libusb_get_device_descriptor "libusb_device *dev" "libusb_device_descriptor *desc"
 278 Get the USB device descriptor for the device
 279 .Fa dev.
 280 This is a non-blocking function.
 281 Returns 0 on success and a LIBUSB_ERROR code on
 282 failure.
 283 .Pp
 284 .Ft int
 285 .Fn libsub_get_active_config_descriptor "libusb_device *dev" "struct libusb_config_descriptor **config"
 286 Get the USB configuration descriptor for the active configuration.
 287 Returns 0 on
 288 success, LIBUSB_ERROR_NOT_FOUND if the device is in
 289 an unconfigured state
 290 and a LIBUSB_ERROR code on error.
 291 .Pp
 292 .Ft int
 293 .Fn libusb_get_config_descriptor "libusb_device *dev" "uint8_t config_index" "libusb_config_descriptor **config"
 294 Get a USB configuration descriptor based on its index
 295 .Fa idx.
 296 Returns 0 on success, LIBUSB_ERROR_NOT_FOUND if the configuration does not exist
 297 and a LIBUSB_ERROR code on error.
 298 .Pp
 299 .Ft int
 300 .Fn libusb_get_config_descriptor_by_value "libusb_device *dev" "uint8 bConfigurationValue" "libusb_config_descriptor **config"
 301 Get a USB configuration descriptor with a specific bConfigurationValue.
 302 This is
 303 a non-blocking function which does not send a request through the device.
 304 Returns 0
 305 on success, LIBUSB_ERROR_NOT_FOUND if the configuration
 306 does not exist and a
 307 LIBUSB_ERROR code on failure.
 308 .Pp
 309 .Ft void
 310 .Fn libusb_free_config_descriptor "libusb_config_descriptor *config"
 311 Free a configuration descriptor.
 312 .Pp
 313 .Ft int
 314 .Fn libusb_get_string_descriptor_ascii "libusb_device_handle *devh" "uint8_t desc_idx" "unsigned char *data" "int length"
 315 Retrieve a string descriptor in C style ASCII.
 316 Returns the positive number of bytes in the resulting ASCII string
 317 on success and a LIBUSB_ERROR code on failure.
 318 .Pp
 319 .Sh USB ASYNCHRONOUS I/O
 320 .Pp
 321 .Ft struct libusb_transfer *
 322 .Fn libusb_alloc_transfer "int iso_packets"
 323 Allocate a transfer with the number of isochronous packet descriptors
 324 specified by
 325 .Fa iso_packets .
 326 Returns NULL on error.
 327 .Pp
 328 .Ft void
 329 .Fn libusb_free_transfer "struct libusb_transfer *tr"
 330 Free a transfer.
 331 .Pp
 332 .Ft int
 333 .Fn libusb_submit_transfer "struct libusb_transfer *tr"
 334 This function will submit a transfer and returns immediately.
 335 Returns 0 on success, LIBUSB_ERROR_NO_DEVICE if
 336 the device has been disconnected and a
 337 LIBUSB_ERROR code on other failure.
 338 .Pp
 339 .Ft int
 340 .Fn libusb_cancel_transfer "struct libusb_transfer *tr"
 341 This function asynchronously cancels a transfer.
 342 Returns 0 on success and a LIBUSB_ERROR code on failure.
 343 .Pp
 344 .Sh USB SYNCHRONOUS I/O
 345 .Pp
 346 .Ft int
 347 .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"
 348 Perform a USB control transfer.
 349 Returns the actual number of bytes
 350 transferred on success, in the range from and including zero up to and
 351 including
 352 .Fa wLength .
 353 On error a LIBUSB_ERROR code is returned, for example
 354 LIBUSB_ERROR_TIMEOUT if the transfer timed out, LIBUSB_ERROR_PIPE if the
 355 control request was not supported, LIBUSB_ERROR_NO_DEVICE if the
 356 device has been disconnected and another LIBUSB_ERROR code on other failures.
 357 The LIBUSB_ERROR codes are all negative.
 358 .Pp
 359 .Ft int
 360 .Fn libusb_bulk_transfer "struct libusb_device_handle *devh" "unsigned char endpoint" "unsigned char *data" "int length" "int *transferred" "unsigned int timeout"
 361 Perform an USB bulk transfer.
 362 A timeout value of zero means no timeout.
 363 The timeout value is given in milliseconds.
 364 Returns 0 on success, LIBUSB_ERROR_TIMEOUT
 365 if the transfer timed out, LIBUSB_ERROR_PIPE if the control request was not
 366 supported, LIBUSB_ERROR_OVERFLOW if the device offered more data,
 367 LIBUSB_ERROR_NO_DEVICE if the device has been disconnected and
 368 a LIBUSB_ERROR code on other failure.
 369 .Pp
 370 .Ft int
 371 .Fn libusb_interrupt_transfer "struct libusb_device_handle *devh" "unsigned char endpoint" "unsigned char *data" "int length" "int *transferred" "unsigned int timeout"
 372 Perform an USB Interrupt transfer.
 373 A timeout value of zero means no timeout.
 374 The timeout value is given in milliseconds.
 375 Returns 0 on success, LIBUSB_ERROR_TIMEOUT
 376 if the transfer timed out, LIBUSB_ERROR_PIPE if the control request was not
 377 supported, LIBUSB_ERROR_OVERFLOW if the device offered more data,
 378 LIBUSB_ERROR_NO_DEVICE if the device has been disconnected and
 379 a LIBUSB_ERROR code on other failure.
 380 .Pp
 381 .Sh USB EVENTS
 382 .Pp
 383 .Ft int
 384 .Fn libusb_try_lock_events "libusb_context *ctx"
 385 Try to acquire the event handling lock.
 386 Returns 0 if the lock was obtained and 1 if not.
 387 .Pp
 388 .Ft void
 389 .Fn libusb_lock_events "libusb_context *ctx"
 390 Acquire the event handling lock.
 391 This function is blocking.
 392 .Pp
 393 .Ft void
 394 .Fn libusb_unlock_events "libusb_context *ctx"
 395 Release the event handling lock.
 396 This will wake up any thread blocked
 397 on
 398 .B libusb_wait_for_event() .
 399 .Pp
 400 .Ft int
 401 .Fn libusb_event_handling_ok "libusb_context *ctx"
 402 Determine if it still OK for this thread to be doing event handling.
 403 Returns 1
 404 if event handling can start or continue.
 405 Returns 0 if this thread must give up
 406 the events lock.
 407 .Pp
 408 .Ft int
 409 .Fn libusb_event_handler_active "libusb_context *ctx"
 410 Determine if an active thread is handling events.
 411 Returns 1 if there is a thread handling events and 0 if there
 412 are no threads currently handling events.
 413 .Pp
 414 .Ft void
 415 .Fn libusb_lock_event_waiters "libusb_context *ctx"
 416 Acquire the event_waiters lock.
 417 This lock is designed to be obtained in the
 418 situation where you want to be aware when events are completed, but some other
 419 thread is event handling so calling libusb_handle_events() is not allowed.
 420 .Pp
 421 .Ft void
 422 .Fn libusb_unlock_event_waiters "libusb_context *ctx"
 423 Release the event_waiters lock.
 424 .Pp
 425 .Ft int
 426 .Fn libusb_wait_for_event "libusb_context *ctx" "struct timeval *tv"
 427 Wait for another thread to signal completion of an event.
 428 Must be called
 429 with the event waiters lock held, see libusb_lock_event_waiters().
 430 This will
 431 block until the timeout expires or a transfer completes or a thread releases
 432 the event handling lock through libusb_unlock_events().
 433 Returns 0 after a
 434 transfer completes or another thread stops event handling, and 1 if the
 435 timeout expired.
 436 .Pp
 437 .Ft int
 438 .Fn libusb_handle_events_timeout "libusb_context *ctx" "struct timeval *tv"
 439 Handle any pending events by checking if timeouts have expired and by
 440 checking the set of file descriptors for activity.
 441 Returns 0 on success, or a
 442 LIBUSB_ERROR code on failure.
 443 .Pp
 444 .Ft int
 445 .Fn libusb_handle_events "libusb_context *ctx"
 446 Handle any pending events in blocking mode with a sensible timeout.
 447 Returns 0
 448 on success and a LIBUSB_ERROR code on failure.
 449 .Pp
 450 .Ft int
 451 .Fn libusb_handle_events_locked "libusb_context *ctx" "struct timeval *tv"
 452 Handle any pending events by polling file desciptors, without checking if
 453 another thread is already doing so.
 454 Must be called with the event lock held.
 455 .Pp
 456 .Ft int
 457 .Fn libusb_get_next_timeout "libusb_context *ctx" "struct timeval *tv"
 458 Determine the next internal timeout that libusb needs to handle.
 459 Returns 0
 460 if there are no pending timeouts, 1 if a timeout was returned, or a LIBUSB_ERROR
 461 code on failure.
 462 .Pp
 463 .Ft void
 464 .Fn libusb_set_pollfd_notifiers "libusb_context *ctx" "libusb_pollfd_added_cb added_cb" "libusb_pollfd_removed_cb remove_cb" "void *user_data"
 465 Register notification functions for file descriptor additions/removals.
 466 These functions will be invoked for every new or removed file descriptor
 467 that libusb uses as an event source.
 468 .Pp
 469 .Ft const struct libusb_pollfd **
 470 .Fn libusb_get_pollfds "libusb_context *ctx"
 471 Retrive a list of file descriptors that should be polled by your main loop as
 472 libusb event sources.
 473 Returns a NULL-terminated list on success or NULL on failure.
 474 .Sh LIBUSB VERSION 0.1 COMPATIBILITY
 475 .Pp
 476 The library is also compliant with LibUSB version 0.1.12.
 477 .Pp
 478 .Fn usb_open
 479 .Fn usb_close
 480 .Fn usb_get_string
 481 .Fn usb_get_string_simple
 482 .Fn usb_get_descriptor_by_endpoint
 483 .Fn usb_get_descriptor
 484 .Fn usb_parse_descriptor
 485 .Fn usb_parse_configuration
 486 .Fn usb_destroy_configuration
 487 .Fn usb_fetch_and_parse_descriptors
 488 .Fn usb_bulk_write
 489 .Fn usb_bulk_read
 490 .Fn usb_interrupt_write
 491 .Fn usb_interrupt_read
 492 .Fn usb_control_msg
 493 .Fn usb_set_configuration
 494 .Fn usb_claim_interface
 495 .Fn usb_release_interface
 496 .Fn usb_set_altinterface
 497 .Fn usb_resetep
 498 .Fn usb_clear_halt
 499 .Fn usb_reset
 500 .Fn usb_strerror
 501 .Fn usb_init
 502 .Fn usb_set_debug
 503 .Fn usb_find_busses
 504 .Fn usb_find_devices
 505 .Fn usb_device
 506 .Fn usb_get_busses
 507 .Fn usb_check_connected
 508 .Fn usb_get_driver_np
 509 .Fn usb_detach_kernel_driver_np
 510 .Sh SEE ALSO
 511 .Xr libusb20 3 ,
 512 .Xr usb 4 ,
 513 .Xr usbconfig 8 ,
 514 .Xr usbdump 8
 515 .Pp
 516 .Pa http://libusb.sourceforge.net/
 517 .Sh HISTORY
 518 .Nm
 519 support first appeared in
 520 .Fx 8.0 .