|
Modules | |
| USB Generic Request definitions | |
| USB Feature Request Definitions | |
Classes | |
| struct | USBGenericRequest |
Typedefs | |
| typedef uint8_t | USBHS_Add_t |
| typedef uint8_t | USBHS_Ep_t |
Detailed Description
Typedef Documentation
◆ USBHS_Add_t
| typedef uint8_t USBHS_Add_t |
Definition at line 255 of file USBRequests.h.
◆ USBHS_Ep_t
| typedef uint8_t USBHS_Ep_t |
Definition at line 256 of file USBRequests.h.
Function Documentation
◆ USBFeatureRequest_GetFeatureSelector()
| 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.
Definition at line 221 of file USBRequests.c.
◆ USBFeatureRequest_GetTestSelector()
| 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.
Definition at line 233 of file USBRequests.c.
◆ USBGenericRequest_GetDirection()
| 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"
Definition at line 129 of file USBRequests.c.
◆ USBGenericRequest_GetEndpointNumber()
| 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.
Definition at line 105 of file USBRequests.c.
◆ USBGenericRequest_GetIndex()
| 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;
Definition at line 85 of file USBRequests.c.
◆ USBGenericRequest_GetLength()
| 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.
Definition at line 95 of file USBRequests.c.
◆ USBGenericRequest_GetRecipient()
| 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"
Definition at line 117 of file USBRequests.c.
◆ USBGenericRequest_GetRequest()
| 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"
Definition at line 65 of file USBRequests.c.
◆ USBGenericRequest_GetType()
| 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"
Definition at line 54 of file USBRequests.c.
◆ USBGenericRequest_GetValue()
| 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.
Definition at line 75 of file USBRequests.c.
◆ USBGetDescriptorRequest_GetDescriptorIndex()
| 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.
Definition at line 158 of file USBRequests.c.
◆ USBGetDescriptorRequest_GetDescriptorType()
| 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.
Definition at line 145 of file USBRequests.c.
◆ USBInterfaceRequest_GetAlternateSetting()
| 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.
Definition at line 208 of file USBRequests.c.
◆ USBInterfaceRequest_GetInterface()
| 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.
Definition at line 197 of file USBRequests.c.
◆ USBSetAddressRequest_GetAddress()
| 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.
Definition at line 172 of file USBRequests.c.
◆ USBSetConfigurationRequest_GetConfiguration()
| 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.
Definition at line 184 of file USBRequests.c.