lib/libusb/libusb20.3

   1 .\"
   2 .\" Copyright (c) 2008 Hans Petter Selasky
   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 February 14, 2013
  30 .Dt LIBUSB20 3
  31 .Os
  32 .Sh NAME
  33 .Nm libusb20
  34 .
  35 .Nd "USB access library"
  36 .
  37 .
  38 .Sh LIBRARY
  39 .
  40 .
  41 USB access library (libusb -lusb)
  42 .
  43 .
  44 .
  45 .Sh SYNOPSIS
  46 .In libusb20.h
  47 .Ft int
  48 .Fn libusb20_tr_close "struct libusb20_transfer *xfer"
  49 .Ft int
  50 .Fn libusb20_tr_open "struct libusb20_transfer *xfer" "uint32_t max_buf_size" "uint32_t max_frame_count" "uint8_t ep_no"
  51 .Ft struct libusb20_transfer*
  52 .Fn libusb20_tr_get_pointer "struct libusb20_device *pdev"  "uint16_t tr_index"
  53 .Ft uint16_t
  54 .Fn libusb20_tr_get_time_complete "struct libusb20_transfer *xfer"
  55 .Ft uint32_t
  56 .Fn libusb20_tr_get_actual_frames "struct libusb20_transfer *xfer"
  57 .Ft uint32_t
  58 .Fn libusb20_tr_get_actual_length "struct libusb20_transfer *xfer"
  59 .Ft uint32_t
  60 .Fn libusb20_tr_get_max_frames "struct libusb20_transfer *xfer"
  61 .Ft uint32_t
  62 .Fn libusb20_tr_get_max_packet_length "struct libusb20_transfer *xfer"
  63 .Ft uint32_t
  64 .Fn libusb20_tr_get_max_total_length "struct libusb20_transfer *xfer"
  65 .Ft uint8_t
  66 .Fn libusb20_tr_get_status "struct libusb20_transfer *xfer"
  67 .Ft uint8_t
  68 .Fn libusb20_tr_pending "struct libusb20_transfer *xfer"
  69 .Ft void
  70 .Fn libusb20_tr_callback_wrapper "struct libusb20_transfer *xfer"
  71 .Ft void
  72 .Fn libusb20_tr_clear_stall_sync "struct libusb20_transfer *xfer"
  73 .Ft void
  74 .Fn libusb20_tr_drain "struct libusb20_transfer *xfer"
  75 .Ft void
  76 .Fn libusb20_tr_set_buffer "struct libusb20_transfer *xfer" "void *buffer" "uint16_t fr_index"
  77 .Ft void
  78 .Fn libusb20_tr_set_callback "struct libusb20_transfer *xfer" "libusb20_tr_callback_t *cb"
  79 .Ft void
  80 .Fn libusb20_tr_set_flags "struct libusb20_transfer *xfer" "uint8_t flags"
  81 .Ft uint32_t
  82 .Fn libusb20_tr_get_length "struct libusb20_transfer *xfer" "uint16_t fr_index"
  83 .Ft void
  84 .Fn libusb20_tr_set_length "struct libusb20_transfer *xfer" "uint32_t length" "uint16_t fr_index"
  85 .Ft void
  86 .Fn libusb20_tr_set_priv_sc0 "struct libusb20_transfer *xfer" "void *sc0"
  87 .Ft void
  88 .Fn libusb20_tr_set_priv_sc1 "struct libusb20_transfer *xfer" "void *sc1"
  89 .Ft void
  90 .Fn libusb20_tr_set_timeout "struct libusb20_transfer *xfer" "uint32_t timeout"
  91 .Ft void
  92 .Fn libusb20_tr_set_total_frames "struct libusb20_transfer *xfer" "uint32_t nframes"
  93 .Ft void
  94 .Fn libusb20_tr_setup_bulk "struct libusb20_transfer *xfer" "void *pbuf" "uint32_t length" "uint32_t timeout"
  95 .Ft void
  96 .Fn libusb20_tr_setup_control "struct libusb20_transfer *xfer" "void *psetup" "void *pbuf" "uint32_t timeout"
  97 .Ft void
  98 .Fn libusb20_tr_setup_intr "struct libusb20_transfer *xfer" "void *pbuf" "uint32_t length" "uint32_t timeout"
  99 .Ft void
 100 .Fn libusb20_tr_setup_isoc "struct libusb20_transfer *xfer" "void *pbuf" "uint32_t length" "uint61_t fr_index"
 101 .Ft uint8_t
 102 .Fn libusb20_tr_bulk_intr_sync "struct libusb20_transfer *xfer" "void *pbuf" "uint32_t length" "uint32_t *pactlen" "uint32_t timeout"
 103 .Ft void
 104 .Fn libusb20_tr_start "struct libusb20_transfer *xfer"
 105 .Ft void
 106 .Fn libusb20_tr_stop "struct libusb20_transfer *xfer"
 107 .Ft void
 108 .Fn libusb20_tr_submit "struct libusb20_transfer *xfer"
 109 .Ft void *
 110 .Fn libusb20_tr_get_priv_sc0 "struct libusb20_transfer *xfer"
 111 .Ft void *
 112 .Fn libusb20_tr_get_priv_sc1 "struct libusb20_transfer *xfer"
 113 .Ft const char *
 114 .Fn libusb20_dev_get_backend_name "struct libusb20_device *"
 115 .Ft int
 116 .Fn libusb20_dev_get_info "struct libusb20_device *pdev" "struct usb_device_info *pinfo"
 117 .Ft int
 118 .Fn libusb20_dev_get_iface_desc "struct libusb20_device *pdev" "uint8_t iface_index" "char *buf" "uint8_t len"
 119 .Ft const char *
 120 .Fn libusb20_dev_get_desc "struct libusb20_device *pdev"
 121 .Ft int
 122 .Fn libusb20_dev_close "struct libusb20_device *pdev"
 123 .Ft int
 124 .Fn libusb20_dev_detach_kernel_driver "struct libusb20_device *pdev" "uint8_t iface_index"
 125 .Ft int
 126 .Fn libusb20_dev_set_config_index "struct libusb20_device *pdev" "uint8_t configIndex"
 127 .Ft int
 128 .Fn libusb20_dev_get_debug "struct libusb20_device *pdev"
 129 .Ft int
 130 .Fn libusb20_dev_get_fd "struct libusb20_device *pdev"
 131 .Ft int
 132 .Fn libusb20_dev_kernel_driver_active "struct libusb20_device *pdev" "uint8_t iface_index"
 133 .Ft int
 134 .Fn libusb20_dev_open "struct libusb20_device *pdev" "uint16_t transfer_max"
 135 .Ft int
 136 .Fn libusb20_dev_process "struct libusb20_device *pdev"
 137 .Ft int
 138 .Fn libusb20_dev_request_sync "struct libusb20_device *pdev" "struct LIBUSB20_CONTROL_SETUP_DECODED *setup" "void *data" "uint16_t *pactlen" "uint32_t timeout" "uint8_t flags"
 139 .Ft int
 140 .Fn libusb20_dev_req_string_sync "struct libusb20_device *pdev" "uint8_t index" "uint16_t langid" "void *ptr" "uint16_t len"
 141 .Ft int
 142 .Fn libusb20_dev_req_string_simple_sync "struct libusb20_device *pdev" "uint8_t index" "void *ptr" "uint16_t len"
 143 .Ft int
 144 .Fn libusb20_dev_reset "struct libusb20_device *pdev"
 145 .Ft int
 146 .Fn libusb20_dev_check_connected "struct libusb20_device *pdev"
 147 .Ft int
 148 .Fn libusb20_dev_set_power_mode "struct libusb20_device *pdev" "uint8_t power_mode"
 149 .Ft uint8_t
 150 .Fn libusb20_dev_get_power_mode "struct libusb20_device *pdev"
 151 .Ft uint16_t
 152 .Fn libusb20_dev_get_power_usage "struct libusb20_device *pdev"
 153 .Ft int
 154 .Fn libusb20_dev_set_alt_index "struct libusb20_device *pdev" "uint8_t iface_index" "uint8_t alt_index"
 155 .Ft struct LIBUSB20_DEVICE_DESC_DECODED *
 156 .Fn libusb20_dev_get_device_desc "struct libusb20_device *pdev"
 157 .Ft struct libusb20_config *
 158 .Fn libusb20_dev_alloc_config "struct libusb20_device *pdev" "uint8_t config_index"
 159 .Ft struct libusb20_device *
 160 .Fn libusb20_dev_alloc "void"
 161 .Ft uint8_t
 162 .Fn libusb20_dev_get_address "struct libusb20_device *pdev"
 163 .Ft uint8_t
 164 .Fn libusb20_dev_get_parent_address "struct libusb20_device *pdev"
 165 .Ft uint8_t
 166 .Fn libusb20_dev_get_parent_port "struct libusb20_device *pdev"
 167 .Ft uint8_t
 168 .Fn libusb20_dev_get_bus_number "struct libusb20_device *pdev"
 169 .Ft uint8_t
 170 .Fn libusb20_dev_get_mode "struct libusb20_device *pdev"
 171 .Ft uint8_t
 172 .Fn libusb20_dev_get_speed "struct libusb20_device *pdev"
 173 .Ft uint8_t
 174 .Fn libusb20_dev_get_config_index "struct libusb20_device *pdev"
 175 .Ft void
 176 .Fn libusb20_dev_free "struct libusb20_device *pdev"
 177 .Ft void
 178 .Fn libusb20_dev_set_debug "struct libusb20_device *pdev" "int debug"
 179 .Ft void
 180 .Fn libusb20_dev_wait_process "struct libusb20_device *pdev" "int timeout"
 181 .Ft int
 182 .Fn libusb20_be_get_template "struct libusb20_backend *pbe" "int *ptemp"
 183 .Ft int
 184 .Fn libusb20_be_set_template "struct libusb20_backend *pbe" "int temp"
 185 .Ft int
 186 .Fn libusb20_be_get_dev_quirk "struct libusb20_backend *pber" "uint16_t index" "struct libusb20_quirk *pq"
 187 .Ft int
 188 .Fn libusb20_be_get_quirk_name "struct libusb20_backend *pbe" "uint16_t index" "struct libusb20_quirk *pq"
 189 .Ft int
 190 .Fn libusb20_be_add_dev_quirk "struct libusb20_backend *pbe" "struct libusb20_quirk *pq"
 191 .Ft int
 192 .Fn libusb20_be_remove_dev_quirk "struct libusb20_backend *pbe" "struct libusb20_quirk *pq"
 193 .Ft struct libusb20_backend *
 194 .Fn libusb20_be_alloc_default "void"
 195 .Ft struct libusb20_backend *
 196 .Fn libusb20_be_alloc_freebsd "void"
 197 .Ft struct libusb20_backend *
 198 .Fn libusb20_be_alloc_linux "void"
 199 .Ft struct libusb20_device *
 200 .Fn libusb20_be_device_foreach  "struct libusb20_backend *pbe" "struct libusb20_device *pdev"
 201 .Ft void
 202 .Fn libusb20_be_dequeue_device "struct libusb20_backend *pbe" "struct libusb20_device *pdev"
 203 .Ft void
 204 .Fn libusb20_be_enqueue_device "struct libusb20_backend *pbe" "struct libusb20_device *pdev"
 205 .Ft void
 206 .Fn libusb20_be_free "struct libusb20_backend *pbe"
 207 .Ft uint8_t
 208 .Fn libusb20_me_get_1 "const struct libusb20_me_struct *me" "uint16_t off"
 209 .Ft uint16_t
 210 .Fn libusb20_me_get_2 "const struct libusb20_me_struct *me" "uint16_t off"
 211 .Ft uint16_t
 212 .Fn libusb20_me_encode "void *pdata" "uint16_t len" "const void *pdecoded"
 213 .Ft uint16_t
 214 .Fn libusb20_me_decode "const void *pdata" "uint16_t len" "void *pdecoded"
 215 .Ft "const uint8_t *"
 216 .Fn libusb20_desc_foreach "const struct libusb20_me_struct *me" "const uint8_t *pdesc"
 217 .Ft "const char *"
 218 .Fn libusb20_strerror "int code"
 219 .Ft "const char *"
 220 .Fn libusb20_error_name "int code"
 221 .
 222 .
 223 .Sh DESCRIPTION
 224 .
 225 The
 226 .Nm
 227 library implements functions to be able to easily access and control
 228 USB through the USB file system interface.
 229 The
 230 .Nm
 231 interfaces are specific to the
 232 .Fx
 233 usb stack and are not available on other operating systems, portable
 234 applications should consider using
 235 .Xr libusb 3 .
 236 .
 237 .
 238 .Sh USB TRANSFER OPERATIONS
 239 .
 240 .
 241 .Fn libusb20_tr_close
 242 will release all kernel resources associated with an USB
 243 .Fa xfer .
 244 .
 245 This function returns zero upon success.
 246 .
 247 Non-zero return values indicate a LIBUSB20_ERROR value.
 248 .
 249 .Pp
 250 .
 251 .Fn libusb20_tr_open
 252 will allocate kernel buffer resources according to
 253 .Fa max_buf_size
 254 and
 255 .Fa max_frame_count
 256 associated with an USB
 257 .Fa pxfer
 258 and bind the transfer to the specified
 259 .Fa ep_no .
 260 .Fa max_buf_size
 261 is the minimum buffer size which the data transport layer has to support.
 262 If
 263 .Fa max_buf_size
 264 is zero, the
 265 .Nm
 266 library will use wMaxPacketSize to compute the buffer size.
 267 This can be useful for isochronous transfers.
 268 The actual buffer size can be greater than
 269 .Fa max_buf_size
 270 and is returned by
 271 .Fn libusb20_tr_get_max_total_length .
 272 .
 273 If
 274 .Fa max_frame_count
 275 is OR'ed with LIBUSB20_MAX_FRAME_PRE_SCALE the remaining part of the
 276 argument is converted from milliseconds into the actual number of
 277 frames rounded up, when this function returns.
 278 This flag is only valid for ISOCHRONOUS transfers and has no effect
 279 for other transfer types.
 280 The actual number of frames setup is found by calling
 281 .Fn libusb20_tr_get_max_frames .
 282 .
 283 This function returns zero upon success.
 284 .
 285 Non-zero return values indicate a LIBUSB20_ERROR value.
 286 .
 287 .Pp
 288 .
 289 .Fn libusb20_tr_get_pointer
 290 will return a pointer to the allocated USB transfer according to the
 291 .Fa pdev
 292 and
 293 .Fa tr_index
 294 arguments.
 295 .
 296 This function returns NULL in case of failure.
 297 .
 298 .Pp
 299 .
 300 .Fn libusb20_tr_get_time_complete
 301 will return the completion time of an USB transfer in
 302 millisecond units. This function is most useful for isochronous USB
 303 transfers when doing echo cancelling.
 304 .
 305 .Pp
 306 .
 307 .Fn libusb20_tr_get_actual_frames
 308 will return the actual number of USB frames after an USB
 309 transfer completed. A value of zero means that no data was transferred.
 310 .
 311 .Pp
 312 .
 313 .Fn libusb20_tr_get_actual_length
 314 will return the sum of the actual length for all
 315 transferred USB frames for the given USB transfer.
 316 .
 317 .Pp
 318 .
 319 .Fn libusb20_tr_get_max_frames
 320 will return the maximum number of USB frames that were
 321 allocated when an USB transfer was setup for the given USB transfer.
 322 .
 323 .Pp
 324 .
 325 .Fn libusb20_tr_get_max_packet_length
 326 will return the maximum packet length in bytes
 327 associated with the given USB transfer.
 328 .
 329 The packet length can be used round up buffer sizes so that short USB
 330 packets are avoided for proxy buffers.
 331 .
 332 .
 333 .Pp
 334 .
 335 .Fn libusb20_tr_get_max_total_length
 336 will return the maximum value for the data length sum of all USB
 337 frames associated with an USB transfer.
 338 In case of control transfers the value returned does not include the
 339 length of the SETUP packet, 8 bytes, which is part of frame zero.
 340 The returned value of this function is always aligned to the maximum
 341 packet size, wMaxPacketSize, of the endpoint which the USB transfer is
 342 bound to.
 343 .
 344 .Pp
 345 .
 346 .Fn libusb20_tr_get_status
 347 will return the status of an USB transfer.
 348 .
 349 Status values are defined by a set of LIBUSB20_TRANSFER_XXX enums.
 350 .
 351 .Pp
 352 .
 353 .Fn libusb20_tr_pending
 354 will return non-zero if the given USB transfer is
 355 pending for completion.
 356 .
 357 Else this function returns zero.
 358 .
 359 .Pp
 360 .
 361 .Fn libusb20_tr_callback_wrapper
 362 This is an internal function used to wrap asynchronous USB callbacks.
 363 .
 364 .Pp
 365 .
 366 .Fn libusb20_tr_clear_stall_sync
 367 This is an internal function used to synchronously clear the stall on
 368 the given USB transfer.
 369 .
 370 Please see the USB specification for more information on stall
 371 clearing.
 372 .
 373 If the given USB transfer is pending when this function is called, the
 374 USB transfer will complete with an error after that this function has
 375 been called.
 376 .
 377 .Pp
 378 .
 379 .Fn libusb20_tr_drain
 380 will stop the given USB transfer and will not return
 381 until the USB transfer has been stopped in hardware.
 382 .
 383 .Pp
 384 .
 385 .Fn libusb20_tr_set_buffer
 386 is used to set the
 387 .Fa buffer
 388 pointer for the given USB transfer and
 389 .Fa fr_index .
 390 .
 391 Typically the frame index is zero.
 392 .
 393 .
 394 .Pp
 395 .
 396 .Fn libusb20_tr_set_callback
 397 is used to set the USB callback for asynchronous USB
 398 transfers.
 399 .
 400 The callback type is defined by libusb20_tr_callback_t.
 401 .
 402 .Pp
 403 .
 404 .Fn libusb20_tr_set_flags
 405 is used to set various USB flags for the given USB transfer.
 406 .Bl -tag
 407 .It LIBUSB20_TRANSFER_SINGLE_SHORT_NOT_OK
 408 Report a short frame as error.
 409 .It LIBUSB20_TRANSFER_MULTI_SHORT_NOT_OK
 410 Multiple short frames are not allowed.
 411 .It LIBUSB20_TRANSFER_FORCE_SHORT
 412 All transmitted frames are short terminated.
 413 .It LIBUSB20_TRANSFER_DO_CLEAR_STALL
 414 Will do a clear-stall before starting the transfer.
 415 .El
 416 .
 417 .Pp
 418 .
 419 .Fn libusb20_tr_get_length
 420 returns the length of the given USB frame by index.
 421 After an USB transfer is complete the USB frame length will get updated to the actual transferred length.
 422 .
 423 .Pp
 424 .
 425 .Fn libusb20_tr_set_length
 426 sets the length of the given USB frame by index.
 427 .
 428 .Pp
 429 .
 430 .Fn libusb20_tr_set_priv_sc0
 431 sets private driver pointer number zero.
 432 .
 433 .Pp
 434 .
 435 .Fn libusb20_tr_set_priv_sc1
 436 sets private driver pointer number one.
 437 .
 438 .Pp
 439 .
 440 .Fn libusb20_tr_set_timeout
 441 sets the timeout for the given USB transfer.
 442 .
 443 A timeout value of zero means no timeout.
 444 .
 445 The timeout is given in milliseconds.
 446 .
 447 .Pp
 448 .
 449 .Fn libusb20_tr_set_total_frames
 450 sets the total number of frames that should be executed when the USB transfer is submitted.
 451 .
 452 The total number of USB frames must be less than the maximum number of USB frames associated with the given USB transfer.
 453 .
 454 .Pp
 455 .
 456 .Fn libusb20_tr_setup_bulk
 457 is a helper function for setting up a single frame USB BULK transfer.
 458 .
 459 .Pp
 460 .
 461 .Fn libusb20_tr_setup_control
 462 is a helper function for setting up a single or dual
 463 frame USB CONTROL transfer depending on the control transfer length.
 464 .
 465 .Pp
 466 .
 467 .Fn libusb20_tr_setup_intr
 468 is a helper function for setting up a single frame USB INTERRUPT transfer.
 469 .
 470 .Pp
 471 .
 472 .Fn libusb20_tr_setup_isoc
 473 is a helper function for setting up a multi frame USB ISOCHRONOUS transfer.
 474 .
 475 .Pp
 476 .
 477 .Fn libusb20_tr_bulk_intr_sync
 478 will perform a synchronous BULK or INTERRUPT transfer having length given by the
 479 .Fa length
 480 argument and buffer pointer given by the
 481 .Fa pbuf
 482 argument on the USB transfer given by the
 483 .Fa xfer
 484 argument.
 485 .
 486 If the
 487 .Fa pactlen
 488 argument is non-NULL the actual transfer length will be stored at the given pointer destination.
 489 .
 490 If the
 491 .Fa timeout
 492 argument is non-zero the transfer will timeout after the given value in milliseconds.
 493 .
 494 This function does not change the transfer flags, like short packet not ok.
 495 .
 496 This function returns zero on success else a LIBUSB20_TRANSFER_XXX value is returned.
 497 .
 498 .Pp
 499 .
 500 .Fn libusb20_tr_start
 501 will get the USB transfer started, if not already
 502 started.
 503 .
 504 This function will not get the transfer queued in hardware.
 505 .
 506 This function is non-blocking.
 507 .
 508 .Pp
 509 .
 510 .Fn libusb20_tr_stop
 511 will get the USB transfer stopped, if not already stopped.
 512 .
 513 This function is non-blocking, which means that the actual stop can
 514 happen after the return of this function.
 515 .
 516 .Pp
 517 .
 518 .Fn libusb20_tr_submit
 519 will get the USB transfer queued in hardware.
 520 .
 521 .
 522 .Pp
 523 .
 524 .Fn libusb20_tr_get_priv_sc0
 525 returns private driver pointer number zero associated
 526 with an USB transfer.
 527 .
 528 .
 529 .Pp
 530 .
 531 .Fn libusb20_tr_get_priv_sc1
 532 returns private driver pointer number one associated
 533 with an USB transfer.
 534 .
 535 .
 536 .Sh USB DEVICE OPERATIONS
 537 .
 538 .
 539 .Fn libusb20_dev_get_backend_name
 540 returns a zero terminated string describing the backend used.
 541 .
 542 .Pp
 543 .
 544 .Fn libusb20_dev_get_info
 545 retrieves the BSD specific usb_device_info structure into the memory location given by
 546 .Fa pinfo .
 547 The USB device given by
 548 .Fa pdev
 549 must be opened before this function will succeed.
 550 This function returns zero on success else a LIBUSB20_ERROR value is returned.
 551 .
 552 .Pp
 553 .
 554 .Fn libusb20_dev_get_iface_desc
 555 retrieves the kernel interface description for the given USB
 556 .Fa iface_index .
 557 The format of the USB interface description is: "drivername<unit>: <description>"
 558 The description string is always zero terminated.
 559 A zero length string is written in case no driver is attached to the given interface.
 560 The USB device given by
 561 .Fa pdev
 562 must be opened before this function will succeed.
 563 This function returns zero on success else a LIBUSB20_ERROR value is returned.
 564 .
 565 .Pp
 566 .
 567 .Fn libusb20_dev_get_desc
 568 returns a zero terminated string describing the given USB device.
 569 The format of the string is: "drivername<unit>: <description>"
 570 .
 571 .Pp
 572 .
 573 .Fn libusb20_dev_close
 574 will close the given USB device.
 575 .
 576 This function returns zero on success else a LIBUSB20_ERROR value is
 577 returned.
 578 .
 579 .Pp
 580 .
 581 .Fn libusb20_dev_detach_kernel_driver
 582 will try to detach the kernel driver for the USB interface given by
 583 .Fa iface_index .
 584 .
 585 This function returns zero on success else a LIBUSB20_ERROR value is
 586 returned.
 587 .
 588 .Pp
 589 .
 590 .Fn libusb20_dev_set_config_index
 591 will try to set the configuration index on an USB
 592 device.
 593 .
 594 The first configuration index is zero.
 595 .
 596 The un-configure index is 255.
 597 .
 598 This function returns zero on success else a LIBUSB20_ERROR value is returned.
 599 .
 600 .Pp
 601 .
 602 .Fn libusb20_dev_get_debug
 603 returns the debug level of an USB device.
 604 .
 605 .Pp
 606 .
 607 .Fn libusb20_dev_get_fd
 608 returns the file descriptor of the given USB device.
 609 .
 610 A negative value is returned when no file descriptor is present.
 611 .
 612 The file descriptor can be used for polling purposes.
 613 .
 614 .Pp
 615 .
 616 .Fn libusb20_dev_kernel_driver_active
 617 returns zero if a kernel driver is active on the given USB interface.
 618 .
 619 Else a LIBUSB20_ERROR value is returned.
 620 .
 621 .Pp
 622 .
 623 .Fn libusb20_dev_open
 624 opens an USB device so that setting up USB transfers
 625 becomes possible.
 626 .
 627 The number of USB transfers can be zero which means only control
 628 transfers are allowed.
 629 .
 630 This function returns zero on success else a LIBUSB20_ERROR value is
 631 returned.
 632 .
 633 A return value of LIBUSB20_ERROR_BUSY means that the device is already
 634 opened.
 635 .
 636 .Pp
 637 .
 638 .Fn libusb20_dev_process
 639 is called to sync kernel USB transfers with userland USB
 640 transfers.
 641 .
 642 This function returns zero on success else a LIBUSB20_ERROR value is
 643 returned typically indicating that the given USB device has been
 644 detached.
 645 .
 646 .Pp
 647 .
 648 .Fn libusb20_dev_request_sync
 649 will perform a synchronous control request on the given
 650 USB device.
 651 .
 652 Before this call will succeed the USB device must be opened.
 653 .
 654 .Fa setup
 655 is a pointer to a decoded and host endian SETUP packet.
 656 .Fa data
 657 is a pointer to a data transfer buffer associated with the control transaction. This argument can be NULL.
 658 .Fa pactlen
 659 is a pointer to a variable that will hold the actual transfer length after the control transaction is complete.
 660 .Fa timeout
 661 is the transaction timeout given in milliseconds.
 662 A timeout of zero means no timeout.
 663 .Fa flags
 664 is used to specify transaction flags, for example LIBUSB20_TRANSFER_SINGLE_SHORT_NOT_OK.
 665 .
 666 This function returns zero on success else a LIBUSB20_ERROR value is
 667 returned.
 668 .
 669 .Pp
 670 .
 671 .Fn libusb20_dev_req_string_sync
 672 will synchronously request an USB string by language ID
 673 and string index into the given buffer limited by a maximum length.
 674 .
 675 This function returns zero on success else a LIBUSB20_ERROR value is
 676 returned.
 677 .
 678 .Pp
 679 .
 680 .Fn libusb20_dev_req_string_simple_sync
 681 will synchronously request an USB string using the
 682 default language ID and convert the string into ASCII before storing
 683 the string into the given buffer limited by a maximum length which
 684 includes the terminating zero.
 685 .
 686 This function returns zero on success else a LIBUSB20_ERROR value is
 687 returned.
 688 .
 689 .
 690 .Pp
 691 .
 692 .Fn libusb20_dev_reset
 693 will try to BUS reset the given USB device and restore
 694 the last set USB configuration.
 695 .
 696 This function returns zero on success else a LIBUSB20_ERROR value is
 697 returned.
 698 .
 699 .
 700 .Pp
 701 .
 702 .Fn libusb20_dev_check_connected
 703 will check if an opened USB device is still connected.
 704 .
 705 This function returns zero if the device is still connected else a LIBUSB20_ERROR value is returned.
 706 .
 707 .
 708 .Pp
 709 .
 710 .Fn libusb20_dev_set_power_mode
 711 sets the power mode of the USB device.
 712 .
 713 Valid power modes:
 714 .Bl -tag
 715 .It LIBUSB20_POWER_OFF
 716 .It LIBUSB20_POWER_ON
 717 .It LIBUSB20_POWER_SAVE
 718 .It LIBUSB20_POWER_SUSPEND
 719 .It LIBUSB20_POWER_RESUME
 720 .El
 721 .
 722 This function returns zero on success else a LIBUSB20_ERROR value is
 723 returned.
 724 .
 725 .Pp
 726 .
 727 .Fn libusb20_dev_get_power_mode
 728 returns the currently selected power mode for the given
 729 USB device.
 730 .
 731 .Pp
 732 .
 733 .Fn libusb20_dev_get_power_usage
 734 returns the reported power usage in milliamps for the given USB device.
 735 A power usage of zero typically means that the device is self powered.
 736 .
 737 .Pp
 738 .
 739 .Fn libusb20_dev_set_alt_index
 740 will try to set the given alternate index for the given
 741 USB interface index.
 742 .
 743 This function returns zero on success else a LIBUSB20_ERROR value is
 744 returned.
 745 .
 746 .Pp
 747 .
 748 .Fn libusb20_dev_get_device_desc
 749 returns a pointer to the decoded and host endian version
 750 of the device descriptor.
 751 .
 752 The USB device need not be opened when calling this function.
 753 .
 754 .Pp
 755 .
 756 .Fn libusb20_dev_alloc_config
 757 will read out and decode the USB config descriptor for
 758 the given USB device and config index. This function returns a pointer
 759 to the decoded configuration which must eventually be passed to
 760 free(). NULL is returned in case of failure.
 761 .
 762 .Pp
 763 .
 764 .Fn libusb20_dev_alloc
 765 is an internal function to allocate a new USB device.
 766 .
 767 .Pp
 768 .
 769 .Fn libusb20_dev_get_address
 770 returns the internal and not necessarily the real
 771 hardware address of the given USB device.
 772 Valid addresses start at one.
 773 .
 774 .Pp
 775 .
 776 .Fn libusb20_dev_get_parent_address
 777 returns the internal and not necessarily the real hardware address of
 778 the given parent USB HUB device.
 779 This value is zero for the root HUB which usually has a device address
 780 equal to one.
 781 Valid addresses start at one.
 782 .
 783 .Pp
 784 .
 785 .Fn libusb20_dev_get_parent_port
 786 returns the port number on the parent USB HUB device.
 787 This value is zero for the root HUB which usually has a device address
 788 equal to one.
 789 Valid port numbers start at one.
 790 .
 791 .Pp
 792 .
 793 .Fn libusb20_dev_get_bus_number
 794 returns the internal bus number which the given USB
 795 device belongs to.
 796 Valid bus numbers start at zero.
 797 .
 798 .Pp
 799 .
 800 .Fn libusb20_dev_get_mode
 801 returns the current operation mode of the USB entity.
 802 .
 803 Valid return values are:
 804 .Bl -tag
 805 .It LIBUSB20_MODE_HOST
 806 .It LIBUSB20_MODE_DEVICE
 807 .El
 808 .
 809 .Pp
 810 .
 811 .Fn libusb20_dev_get_speed
 812 returns the current speed of the given USB device.
 813 .
 814 .Bl -tag
 815 .It LIBUSB20_SPEED_UNKNOWN
 816 .It LIBUSB20_SPEED_LOW
 817 .It LIBUSB20_SPEED_FULL
 818 .It LIBUSB20_SPEED_HIGH
 819 .It LIBUSB20_SPEED_VARIABLE
 820 .It LIBUSB20_SPEED_SUPER
 821 .El
 822 .
 823 .Pp
 824 .
 825 .Fn libusb20_dev_get_config_index
 826 returns the currently selected config index for the given
 827 USB device.
 828 .
 829 .Pp
 830 .
 831 .Fn libusb20_dev_free
 832 will free the given USB device and all associated USB
 833 transfers.
 834 .
 835 .Pp
 836 .
 837 .Fn libusb20_dev_set_debug
 838 will set the debug level for the given USB device.
 839 .
 840 .Pp
 841 .
 842 .Fn libusb20_dev_wait_process
 843 will wait until a pending USB transfer has completed on
 844 the given USB device.
 845 .
 846 A timeout value can be specified which is passed on to the
 847 .Xr poll 2
 848 function.
 849 .
 850 .Sh USB BACKEND OPERATIONS
 851 .
 852 .Fn libusb20_be_get_template
 853 will return the currently selected global USB device
 854 side mode template into the integer pointer
 855 .Fa ptemp .
 856 This function returns zero on success else a LIBUSB20_ERROR value is
 857 returned.
 858 .
 859 .Pp
 860 .
 861 .Fn libusb20_be_set_template
 862 will set the global USB device side mode template to
 863 .Fa temp .
 864 The new template is not activated until after the next USB
 865 enumeration.
 866 The template number decides how the USB device will present itself to
 867 the USB Host, like Mass Storage Device, USB Ethernet Device. Also see
 868 the
 869 .Xr usb2_template 4
 870 module.
 871 This function returns zero on success else a LIBUSB20_ERROR value is
 872 returned.
 873 .
 874 .Pp
 875 .
 876 .Fn libusb20_be_get_dev_quirk
 877 will return the device quirk according to
 878 .Fa index
 879 into the libusb20_quirk structure pointed to by
 880 .Fa pq .
 881 This function returns zero on success else a LIBUSB20_ERROR value is
 882 returned.
 883 .
 884 If the given quirk does not exist LIBUSB20_ERROR_NOT_FOUND is
 885 returned.
 886 .
 887 .Pp
 888 .
 889 .Fn libusb20_be_get_quirk_name
 890 will return the quirk name according to
 891 .Fa index
 892 into the libusb20_quirk structure pointed to by
 893 .Fa pq .
 894 This function returns zero on success else a LIBUSB20_ERROR value is
 895 returned.
 896 .
 897 If the given quirk does not exist LIBUSB20_ERROR_NOT_FOUND is
 898 returned.
 899 .
 900 .Pp
 901 .
 902 .Fn libusb20_be_add_dev_quirk
 903 will add the libusb20_quirk structure pointed to by the
 904 .Fa pq
 905 argument into the device quirk list.
 906 .
 907 This function returns zero on success else a LIBUSB20_ERROR value is
 908 returned.
 909 .
 910 If the given quirk cannot be added LIBUSB20_ERROR_NO_MEM is
 911 returned.
 912 .
 913 .Pp
 914 .
 915 .Fn libusb20_be_remove_dev_quirk
 916 will remove the quirk matching the libusb20_quirk structure pointed to by the
 917 .Fa pq
 918 argument from the device quirk list.
 919 .
 920 This function returns zero on success else a LIBUSB20_ERROR value is
 921 returned.
 922 .
 923 If the given quirk does not exist LIBUSB20_ERROR_NOT_FOUND is
 924 returned.
 925 .
 926 .Pp
 927 .
 928 .Fn libusb20_be_alloc_default
 929 .Fn libusb20_be_alloc_freebsd
 930 .Fn libusb20_be_alloc_linux
 931 These functions are used to allocate a specific USB backend or the
 932 operating system default USB backend. Allocating a backend is a way to
 933 scan for currently present USB devices.
 934 .
 935 .Pp
 936 .
 937 .Fn libusb20_be_device_foreach
 938 is used to iterate USB devices present in a USB backend.
 939 .
 940 The starting value of
 941 .Fa pdev
 942 is NULL.
 943 .
 944 This function returns the next USB device in the list.
 945 .
 946 If NULL is returned the end of the USB device list has been reached.
 947 .
 948 .Pp
 949 .
 950 .Fn libusb20_be_dequeue_device
 951 will dequeue the given USB device pointer from the
 952 backend USB device list.
 953 .
 954 Dequeued USB devices will not be freed when the backend is freed.
 955 .
 956 .Pp
 957 .
 958 .Fn libusb20_be_enqueue_device
 959 will enqueue the given USB device pointer in the backend USB device list.
 960 .
 961 Enqueued USB devices will get freed when the backend is freed.
 962 .
 963 .Pp
 964 .
 965 .Fn libusb20_be_free
 966 will free the given backend and all USB devices in its device list.
 967 .
 968 .
 969 .Sh USB DESCRIPTOR PARSING
 970 .
 971 .Fn libusb20_me_get_1 pie offset
 972 This function will return a byte at the given byte offset of a message
 973 entity.
 974 .
 975 This function is safe against invalid offsets.
 976 .
 977 .Pp
 978 .
 979 .Fn libusb20_me_get_2 pie offset
 980 This function will return a little endian 16-bit value at the given byte offset of a message
 981 entity.
 982 .
 983 This function is safe against invalid offsets.
 984 .
 985 .Pp
 986 .
 987 .Fn libusb20_me_encode pbuf len pdecoded
 988 This function will encode a so-called *DECODED structure into binary
 989 format.
 990 .
 991 The total encoded length that will fit in the given buffer is
 992 returned.
 993 .
 994 If the buffer pointer is NULL no data will be written to the buffer
 995 location.
 996 .
 997 .Pp
 998 .
 999 .Fn libusb20_me_decode pbuf len pdecoded
1000 This function will decode a binary structure into a so-called *DECODED
1001 structure.
1002 .
1003 The total decoded length is returned.
1004 .
1005 The buffer pointer cannot be NULL.
1006 .
1007 .
1008 .Sh USB DEBUGGING
1009 .Ft const char *
1010 .Fn libusb20_strerror "int code"
1011 Get the ASCII representation of the error given by the
1012 .Fa code
1013 argument.
1014 This function does not return NULL.
1015 .Pp
1016 .Ft const char *
1017 .Fn libusb20_error_name "int code"
1018 Get the ASCII representation of the error enum given by the
1019 .Fa code
1020 argument.
1021 This function does not return NULL.
1022 .
1023 .Sh FILES
1024 .
1025 .
1026 /dev/usb
1027 .Sh SEE ALSO
1028 .Xr usb 4 ,
1029 .Xr libusb 3 ,
1030 .Xr usbconfig 8 ,
1031 .Xr usbdump 8
1032 .
1033 .
1034 .Sh HISTORY
1035 .
1036 .
1037 Some parts of the
1038 .Nm
1039 API derives from the libusb project at sourceforge.