USB_HOST_RESULT Enumeration

USB Host Result

This enumeration defines the possible returns values of USB Host Layer API. A function may only return some of the values in this enumeration. Refer to function description for details on which values will be returned.

typedef enum {
  USB_HOST_RESULT_REQUEST_BUSY = USB_HOST_RESULT_MIN,
  USB_HOST_RESULT_STRING_DESCRIPTOR_UNSUPPORTED,
  USB_HOST_RESULT_TRANSFER_ABORTED,
  USB_HOST_RESULT_REQUEST_STALLED,
  USB_HOST_RESULT_PIPE_HANDLE_INVALID,
  USB_HOST_RESULT_END_OF_DEVICE_LIST,
  USB_HOST_RESULT_INTERFACE_UNKNOWN,
  USB_HOST_RESULT_PARAMETER_INVALID,
  USB_HOST_RESULT_CONFIGURATION_UNKNOWN,
  USB_HOST_RESULT_BUS_NOT_ENABLED,
  USB_HOST_RESULT_BUS_UNKNOWN,
  USB_HOST_RESULT_DEVICE_UNKNOWN,
  USB_HOST_RESULT_FAILURE,
  USB_HOST_RESULT_FALSE = 0,
  USB_HOST_RESULT_TRUE = 1,
  USB_HOST_RESULT_SUCCESS = USB_HOST_RESULT_TRUE
} USB_HOST_RESULT;

Members

Members	Description
USB_HOST_RESULT_REQUEST_BUSY = USB_HOST_RESULT_MIN	Indicates that the Host Layer cannot accept any requests at this point
USB_HOST_RESULT_STRING_DESCRIPTOR_UNSUPPORTED	The device does not support the request string descriptor
USB_HOST_RESULT_TRANSFER_ABORTED	Request was aborted
USB_HOST_RESULT_REQUEST_STALLED	Request was stalled
USB_HOST_RESULT_PIPE_HANDLE_INVALID	The specified pipe is not valid
USB_HOST_RESULT_END_OF_DEVICE_LIST	The end of the device list was reached.
USB_HOST_RESULT_INTERFACE_UNKNOWN	The specified interface is not available
USB_HOST_RESULT_PARAMETER_INVALID	A NULL parameter was passed to the function
USB_HOST_RESULT_CONFIGURATION_UNKNOWN	The specified configuration does not exist on this device.
USB_HOST_RESULT_BUS_NOT_ENABLED	A bus operation was requested but the bus was not operated
USB_HOST_RESULT_BUS_UNKNOWN	The specified bus does not exist in the system
USB_HOST_RESULT_DEVICE_UNKNOWN	The specified device does not exist in the system
USB_HOST_RESULT_FAILURE	An unknown failure has occurred
USB_HOST_RESULT_FALSE = 0	Indicates a false condition
USB_HOST_RESULT_TRUE = 1	Indicate a true condition
USB_HOST_RESULT_SUCCESS = USB_HOST_RESULT_TRUE	Indicates that the operation succeeded or the request was accepted and will be processed.

Remarks

None.

USB Libraries Help > USB Host Libraries > USB Host Layer Library > Library Interface > b) Data Types and Constants > USB_HOST_RESULT Enumeration

MPLAB Harmony USB Stack

Contents | Home

Previous | Up | Next

Documentation Feedback
Microchip Support