SAMV71 Xplained Ultra Software Package 1.3

USB Requests
[Usb_general]

Collaboration diagram for USB Requests:

Data Structures

struct  USBGenericRequest

Modules

 USB Generic Request definitions
 USB Feature Request Definitions

Typedefs

typedef uint8_t USBHS_Add_t
typedef uint8_t USBHS_Ep_t

Functions

uint8_t USBGenericRequest_GetType (const USBGenericRequest *request)
uint8_t USBGenericRequest_GetRequest (const USBGenericRequest *request)
uint16_t USBGenericRequest_GetValue (const USBGenericRequest *request)
uint16_t USBGenericRequest_GetIndex (const USBGenericRequest *request)
uint16_t USBGenericRequest_GetLength (const USBGenericRequest *request)
uint8_t USBGenericRequest_GetEndpointNumber (const USBGenericRequest *request)
uint8_t USBGenericRequest_GetRecipient (const USBGenericRequest *request)
uint8_t USBGenericRequest_GetDirection (const USBGenericRequest *request)
uint8_t USBGetDescriptorRequest_GetDescriptorType (const USBGenericRequest *request)
uint8_t USBGetDescriptorRequest_GetDescriptorIndex (const USBGenericRequest *request)
uint8_t USBSetAddressRequest_GetAddress (const USBGenericRequest *request)
uint8_t USBSetConfigurationRequest_GetConfiguration (const USBGenericRequest *request)
uint8_t USBInterfaceRequest_GetInterface (const USBGenericRequest *request)
uint8_t USBInterfaceRequest_GetAlternateSetting (const USBGenericRequest *request)
uint8_t USBFeatureRequest_GetFeatureSelector (const USBGenericRequest *request)
uint8_t USBFeatureRequest_GetTestSelector (const USBGenericRequest *request)

Function Documentation

uint8_t USBFeatureRequest_GetFeatureSelector ( const USBGenericRequest request  ) 

Returns the feature selector of a given CLEAR_FEATURE or SET_FEATURE request.

Parameters:
request Pointer to a USBGenericRequest instance.
Returns:
Feature selector.
uint8_t USBFeatureRequest_GetTestSelector ( const USBGenericRequest request  ) 

Indicates the test that the device must undertake following a SET_FEATURE request.

Parameters:
request Pointer to a USBGenericRequest instance.
Returns:
Test selector.
uint8_t USBGenericRequest_GetDirection ( const USBGenericRequest request  ) 

Returns the direction of the data transfer following the given request.

Parameters:
request Pointer to a USBGenericRequest instance.
Returns:
Transfer direction.
See also:
"USB Request Directions"
uint8_t USBGenericRequest_GetEndpointNumber ( const USBGenericRequest request  ) 

Returns the endpoint number targeted by a given request.

Parameters:
request Pointer to a USBGenericRequest instance.
Returns:
Endpoint number.
uint16_t USBGenericRequest_GetIndex ( const USBGenericRequest request  ) 

Returns the wIndex field of the given request.

Parameters:
request Pointer to a USBGenericRequest instance.
Returns:
Request index;
uint16_t USBGenericRequest_GetLength ( const USBGenericRequest request  ) 

Returns the expected length of the data phase following a request.

Parameters:
request Pointer to a USBGenericRequest instance.
Returns:
Length of data phase.
uint8_t USBGenericRequest_GetRecipient ( const USBGenericRequest request  ) 

Returns the intended recipient of a given request.

Parameters:
request Pointer to a USBGenericRequest instance.
Returns:
Request recipient.
See also:
"USB Request Recipients"
uint8_t USBGenericRequest_GetRequest ( const USBGenericRequest request  ) 

Returns the request code of the given request.

Parameters:
request Pointer to a USBGenericRequest instance.
Returns:
Request code.
See also:
"USB Request Codes"
uint8_t USBGenericRequest_GetType ( const USBGenericRequest request  ) 

Returns the type of the given request.

Parameters:
request Pointer to a USBGenericRequest instance.
Returns:
"USB Request Types"
uint16_t USBGenericRequest_GetValue ( const USBGenericRequest request  ) 

Returns the wValue field of the given request.

Parameters:
request - Pointer to a USBGenericRequest instance.
Returns:
Request value.
uint8_t USBGetDescriptorRequest_GetDescriptorIndex ( const USBGenericRequest request  ) 

Returns the index of the requested descriptor, given the corresponding GET_DESCRIPTOR request.

Parameters:
request Pointer to a USBGenericDescriptor instance.
Returns:
Index of the requested descriptor.
uint8_t USBGetDescriptorRequest_GetDescriptorType ( const USBGenericRequest request  ) 

Returns the type of the descriptor requested by the host given the corresponding GET_DESCRIPTOR request.

Parameters:
request Pointer to a USBGenericDescriptor instance.
Returns:
Type of the requested descriptor.
uint8_t USBInterfaceRequest_GetAlternateSetting ( const USBGenericRequest request  ) 

Indicates the new alternate setting that the interface targeted by a SET_INTERFACE request should use.

Parameters:
request Pointer to a USBGenericRequest instance.
Returns:
New active setting for the interface.
uint8_t USBInterfaceRequest_GetInterface ( const USBGenericRequest request  ) 

Indicates which interface is targeted by a GET_INTERFACE or SET_INTERFACE request.

Parameters:
request Pointer to a USBGenericRequest instance.
Returns:
Interface number.
uint8_t USBSetAddressRequest_GetAddress ( const USBGenericRequest request  ) 

Returns the address that the device must take in response to a SET_ADDRESS request.

Parameters:
request Pointer to a USBGenericRequest instance.
Returns:
New device address.
uint8_t USBSetConfigurationRequest_GetConfiguration ( const USBGenericRequest request  ) 

Returns the number of the configuration that should be set in response to the given SET_CONFIGURATION request.

Parameters:
request Pointer to a USBGenericRequest instance.
Returns:
Number of the requested configuration.
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines