Lines Matching +full:usb +full:- +full:valid

2 .\" Copyright (c) 2008-2019 Hans Petter Selasky
33 .Nd "USB access library"
39 USB access library (libusb -lusb)
231 USB through the USB file system interface.
241 .Sh USB TRANSFER OPERATIONS
245 will release all kernel resources associated with an USB
250 Non-zero return values indicate a LIBUSB20_ERROR value.
259 associated with an USB
281 This flag is only valid for ISOCHRONOUS transfers and has no effect
288 Non-zero return values indicate a LIBUSB20_ERROR value.
303 will return a pointer to the allocated USB transfer according to the
314 will return the completion time of an USB transfer in
316 This function is most useful for isochronous USB transfers when doing echo
322 will return the actual number of USB frames after an USB
329 transferred USB frames for the given USB transfer.
334 will return the maximum number of USB frames that were
335 allocated when an USB transfer was setup for the given USB transfer.
341 associated with the given USB transfer.
343 The packet length can be used round up buffer sizes so that short USB
350 will return the maximum value for the data length sum of all USB
351 frames associated with an USB transfer.
355 packet size, wMaxPacketSize, of the endpoint which the USB transfer is
361 will return the status of an USB transfer.
368 will return non-zero if the given USB transfer is
376 This is an internal function used to wrap asynchronous USB callbacks.
382 the given USB transfer.
384 Please see the USB specification for more information on stall
387 If the given USB transfer is pending when this function is called, the
394 will stop the given USB transfer and will not return
395 until the USB transfer has been stopped in hardware.
402 pointer for the given USB transfer and
411 is used to set the USB callback for asynchronous USB
419 is used to set various USB flags for the given USB transfer.
420 .Bl -tag -width "LIBUSB20_TRANSFER_SINGLE_SHORT_NOT_OK"
428 Will do a clear-stall before starting the transfer.
434 returns the length of the given USB frame by index.
435 After an USB transfer is complete the USB frame length will get updated to the actual transferred l…
440 sets the length of the given USB frame by index.
455 sets the timeout for the given USB transfer.
464 sets the total number of frames that should be executed when the USB transfer is submitted.
466 The total number of USB frames must be less than the maximum number of USB frames associated with t…
471 is a helper function for setting up a single frame USB BULK transfer.
477 frame USB CONTROL transfer depending on the control transfer length.
482 is a helper function for setting up a single frame USB INTERRUPT transfer.
487 is a helper function for setting up a multi frame USB ISOCHRONOUS transfer.
496 argument on the USB transfer given by the
502 argument is non-NULL the actual transfer length will be stored at the given pointer destination.
506 argument is non-zero the transfer will timeout after the given value in milliseconds.
515 will get the USB transfer started, if not already
520 This function is non-blocking.
525 will get the USB transfer stopped, if not already stopped.
527 This function is non-blocking, which means that the actual stop can
533 will get the USB transfer queued in hardware.
540 with an USB transfer.
547 with an USB transfer.
550 .Sh USB DEVICE OPERATIONS
559 retrieves the list of USB port numbers which the datastream for a given USB device follows.
563 Valid port numbers start at one and range until and including 255.
575 The USB device given by
583 retrieves the kernel interface description for the given USB
585 The format of the USB interface description is: "drivername<unit>: <description>"
588 The USB device given by
596 returns a zero terminated string describing the given USB device.
610 will close the given USB device.
618 will try to detach the kernel driver for the USB interface given by
627 will try to set the configuration index on an USB
632 The un-configure index is 255.
639 returns the debug level of an USB device.
644 returns the file descriptor of the given USB device.
653 returns zero if a kernel driver is active on the given USB interface.
660 opens an USB device so that setting up USB transfers
663 The number of USB transfers can be zero which means only control
675 is called to sync kernel USB transfers with userland USB
679 returned typically indicating that the given USB device has been
688 Before this call will succeed the USB device must be opened.
710 will synchronously request an USB string by language ID
719 will synchronously request an USB string using the
731 will try to BUS reset the given USB device and restore
732 the last set USB configuration.
741 will check if an opened USB device is still connected.
749 sets the power mode of the USB device.
751 Valid power modes:
752 .Bl -tag -width "LIBUSB20_POWER_OFF"
773 returns the reported power usage in milliamps for the given USB device.
791 The USB device need not be opened when calling this function.
796 will read out and decode the USB config descriptor for the given USB device
805 is an internal function to allocate a new USB device.
811 hardware address of the given USB device.
812 Valid addresses start at one.
818 the given parent USB HUB device.
821 Valid addresses start at one.
826 returns the port number on the parent USB HUB device.
829 Valid port numbers start at one.
834 returns the internal bus number which the given USB
836 Valid bus numbers start at zero.
841 returns the current operation mode of the USB entity.
843 Valid return values are:
844 .Bl -tag -width "LIBUSB20_MODE_DEVICE"
852 returns the current speed of the given USB device.
854 .Bl -tag -width "LIBUSB20_SPEED_VARIABLE"
872 will free the given USB device and all associated USB
878 will set the debug level for the given USB device.
883 will wait until a pending USB transfer has completed on
884 the given USB device.
890 .Sh USB BACKEND OPERATIONS
893 will return the currently selected global USB device
902 will set the global USB device side mode template to
904 The new template is not activated until after the next USB
906 The template number decides how the USB device will present itself to
907 the USB Host, like Mass Storage Device, USB Ethernet Device.
971 These functions are used to allocate a specific USB backend or the operating system
972 default USB backend.
973 Allocating a backend is a way to scan for currently present USB devices.
977 is used to iterate USB devices present in a USB backend.
983 This function returns the next USB device in the list.
985 If NULL is returned the end of the USB device list has been reached.
990 will dequeue the given USB device pointer from the
991 backend USB device list.
993 Dequeued USB devices will not be freed when the backend is freed.
998 will enqueue the given USB device pointer in the backend USB device list.
1000 Enqueued USB devices will get freed when the backend is freed.
1005 will free the given backend and all USB devices in its device list.
1008 .Sh USB DESCRIPTOR PARSING
1019 This function will return a little endian 16-bit value at the given byte offset of a message
1027 This function will encode a so-called *DECODED structure into binary
1039 This function will decode a binary structure into a so-called *DECODED
1047 .Sh USB DEBUGGING
1063 .Bl -tag -width Pa
1064 .It Pa /dev/usb
1068 .Xr usb 4 ,