USB3.h File Reference

Interface for the USB module. More...

Classes
struct	usb_configuration_info
	Container for a specific configuration descriptor of a device. More...
struct	usb_endpoint_info
	Container for endpoint descriptors and their Haiku USB stack identifiers. More...
struct	usb_interface_info
	Container for interface descriptors and their Haiku USB stack identifiers. More...
struct	usb_interface_list
	List of interfaces available to a configuration. More...
struct	usb_module_info
	Interface for drivers to interact with Haiku's USB stack. More...
struct	usb_notify_hooks
	Hooks that the USB stack can callback in case of events. More...
struct	usb_support_descriptor
	Description of device descriptor that the driver can handle. More...

Macros
#define	B_USB_MODULE_NAME   "bus_managers/usb/v3.1"
	The identifier string for the USB Stack interface module.

Typedefs
typedef void(*	usb_callback_func) (void *cookie, status_t status, void *data, size_t actualLength)
	Callback function for asynchronous transfers.
typedef struct usb_configuration_info	usb_configuration_info
	Container for USB configuration descriptors.
typedef usb_id	usb_device
	Uniquely identify USB devices.
typedef struct usb_endpoint_info	usb_endpoint_info
	Container for USB endpoint descriptors.
typedef uint32	usb_id
	Uniquely identify various USB objects that are used in the module.
typedef usb_id	usb_interface
	Uniquely identify USB interfaces.
typedef struct usb_interface_info	usb_interface_info
	Container for USB interface descriptors.
typedef struct usb_interface_list	usb_interface_list
	Container that holds a list of USB interface descriptors.
typedef struct usb_module_info	usb_module_info
	The main interface object. See the usb_module_info documentation.
typedef usb_id	usb_pipe
	Uniquely identify USB pipes.

Detailed Description

Interface for the USB module.

Typedef Documentation

usb_callback_func

typedef void(* usb_callback_func)(void *cookie, status_t status, void *data, size_t actualLength)

Callback function for asynchronous transfers.

Parameters

cookie	The cookie you supplied when you queued the transfer.
status	The status of the transfer. This is one of the following: B_OK The transfer succeeded. B_CANCELED The transfer was cancelled by the user via a usb_module_info::cancel_queued_transfers() call. B_DEV_MULTIPLE_ERRORS More than one of the errors below occurred. Unfortunately, the stack cannot give you more information. B_DEV_STALLED The endpoint is stalled. You can use usb_module_info::clear_feature() method with the associated pipe and the USB_FEATURE_ENDPOINT_HALT arguments. B_DEV_DATA_OVERRUN Incoming transfer: more data flowing in than the size of the buffer. B_DEV_DATA_UNDERRUN Outgoing transfer: more data is flowing out than the endpoint accepts. B_DEV_CRC_ERROR The internal data consistency checks of the USB protocol failed. It is best to retry. If you keep on getting this error there might be something wrong with the device. B_DEV_UNEXPECTED_PID There was an internal error. You should retry your transfer. B_DEV_FIFO_OVERRUN internal error. You should retry your transfer. B_DEV_FIFO_UNDERRUN There was an internal error. You should retry your transfer.
data	The provided buffer.
actualLength	The amount of bytes read or written during the transfer.

usb_configuration_info

struct usb_configuration_info usb_configuration_info

Container for USB configuration descriptors.

See also

Documentation for usb_configuration_info.

usb_endpoint_info

struct usb_endpoint_info usb_endpoint_info

Container for USB endpoint descriptors.

See also

Documentation for usb_endpoint_info.

usb_interface_info

struct usb_interface_info usb_interface_info

Container for USB interface descriptors.

See also

Documentation for usb_interface_info.

usb_interface_list

struct usb_interface_list usb_interface_list

Container that holds a list of USB interface descriptors.

See also

Documentation for usb_interface_list.