Detailed Description
Functions, macros and enums related to endpoint management when in USB Device mode. This module contains the endpoint management macros, as well as endpoint interrupt and data send/receive functions for various data types.
Define Documentation
#define ENDPOINT_BANK_DOUBLE (1 << EPBK0) |
Mask for the bank mode selection for the Endpoint_ConfigureEndpoint() macro. This indicates that the endpoint should have two banks, which requires more USB FIFO memory but results in faster transfers as one USB device (the AVR or the host) can access one bank while the other accesses the second bank.
#define ENDPOINT_BANK_SINGLE (0 << EPBK0) |
Mask for the bank mode selection for the Endpoint_ConfigureEndpoint() macro. This indicates that the endpoint should have one single bank, which requires less USB FIFO memory but results in slower transfers as only one USB device (the AVR or the host) can access the endpoint's bank at the one time.
#define ENDPOINT_BANKS_SUPPORTED |
( |
|
EPIndex ) |
_ENDPOINT_GET_BANKS(EPIndex) |
Indicates the total number of banks supported by the given endpoint.
- Parameters:
-
[in] | EPIndex | Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1) |
#define ENDPOINT_CONTROLEP 0 |
Endpoint address for the default control endpoint, which always resides in address 0. This is defined for convenience to give more readable code when used with the endpoint macros.
#define ENDPOINT_CONTROLEP_DEFAULT_SIZE 8 |
Default size of the default control endpoint's bank, until altered by the control endpoint bank size value in the device descriptor. Not available if the FIXED_CONTROL_ENDPOINT_SIZE token is defined.
#define ENDPOINT_DIR_IN (1 << EPDIR) |
Endpoint data direction mask for Endpoint_ConfigureEndpoint(). This indicates that the endpoint should be initialized in the IN direction - i.e. data flows from device to host.
#define ENDPOINT_DIR_OUT (0 << EPDIR) |
Endpoint data direction mask for Endpoint_ConfigureEndpoint(). This indicates that the endpoint should be initialized in the OUT direction - i.e. data flows from host to device.
#define ENDPOINT_EPDIR_MASK 0x80 |
Endpoint direction mask, for masking against endpoint addresses to retrieve the endpoint's direction for comparing with the ENDPOINT_DESCRIPTOR_DIR_* masks.
#define ENDPOINT_EPNUM_MASK 0x07 |
Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's numerical address in the device.
#define ENDPOINT_EPSIZE_MASK 0x7F |
Endpoint bank size mask, for masking against endpoint addresses to retrieve the endpoint's bank size in the device.
#define ENDPOINT_MAX_SIZE |
( |
|
EPIndex ) |
_ENDPOINT_GET_MAXSIZE(EPIndex) |
Maximum size in bytes of a given endpoint.
- Parameters:
-
[in] | EPIndex | Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1) |
#define ENDPOINT_TOTAL_ENDPOINTS ENDPOINT_DETAILS_MAXEP |
Total number of endpoints (including the default control endpoint at address 0) which may be used in the device. Different USB AVR models support different amounts of endpoints, this value reflects the maximum number of endpoints for the currently selected AVR model.
Function Documentation
void Endpoint_ClearStatusStage |
( |
void |
) |
|
Completes the status stage of a control transfer on a CONTROL type endpoint automatically, with respect to the data direction. This is a convenience function which can be used to simplify user control request handling.
static bool Endpoint_ConfigureEndpoint |
( |
const uint8_t |
Number, |
|
|
const uint8_t |
Type, |
|
|
const uint8_t |
Direction, |
|
|
const uint16_t |
Size, |
|
|
const uint8_t |
Banks |
|
) |
| [inline, static] |
Configures the specified endpoint number with the given endpoint type, direction, bank size and banking mode. Once configured, the endpoint may be read from or written to, depending on its direction.
- Parameters:
-
[in] | Number | Endpoint number to configure. This must be more than 0 and less than ENDPOINT_TOTAL_ENDPOINTS. |
[in] | Type | Type of endpoint to configure, a EP_TYPE_* mask. Not all endpoint types are available on Low Speed USB devices - refer to the USB 2.0 specification. |
[in] | Direction | Endpoint data direction, either ENDPOINT_DIR_OUT or ENDPOINT_DIR_IN. All endpoints (except Control type) are unidirectional - data may only be read from or written to the endpoint bank based on its direction, not both. |
[in] | Size | Size of the endpoint's bank, where packets are stored before they are transmitted to the USB host, or after they have been received from the USB host (depending on the endpoint's data direction). The bank size must indicate the maximum packet size that the endpoint can handle. |
[in] | Banks | Number of banks to use for the endpoint being configured, an ENDPOINT_BANK_* mask. More banks uses more USB DPRAM, but offers better performance. Isochronous type endpoints must have at least two banks. |
- Note:
- Endpoints must be configured in ascending order, or bank corruption will occur.
-
Certain models of USB AVR's endpoints may have different maximum packet sizes based on the endpoint's index - refer to the chosen USB AVR's datasheet to determine the maximum bank size for each endpoint.
-
The default control endpoint should not be manually configured by the user application, as it is automatically configured by the library internally.
-
This routine will automatically select the specified endpoint upon success. Upon failure, the endpoint which failed to reconfigure correctly will be selected.
- Returns:
- Boolean true if the configuration succeeded, false otherwise.
static void Endpoint_DisableEndpoint |
( |
void |
) |
[inline, static] |
Disables the currently selected endpoint so that data cannot be sent and received through it to and from a host.
static void Endpoint_EnableEndpoint |
( |
void |
) |
[inline, static] |
Enables the currently selected endpoint so that data can be sent and received through it to and from a host.
- Note:
- Endpoints must first be configured properly via Endpoint_ConfigureEndpoint().
static uint8_t Endpoint_GetCurrentEndpoint |
( |
void |
) |
[inline, static] |
Get the endpoint address of the currently selected endpoint. This is typically used to save the currently selected endpoint number so that it can be restored after another endpoint has been manipulated.
- Returns:
- Index of the currently selected endpoint.
static uint8_t Endpoint_GetEndpointDirection |
( |
void |
) |
[inline, static] |
Determines the currently selected endpoint's direction.
- Returns:
- The currently selected endpoint's direction, as a ENDPOINT_DIR_* mask.
static uint8_t Endpoint_GetEndpointInterrupts |
( |
void |
) |
[inline, static] |
Returns a mask indicating which INTERRUPT type endpoints have interrupted - i.e. their interrupt duration has elapsed. Which endpoints have interrupted can be determined by masking the return value against (1 << {Endpoint Number}).
- Returns:
- Mask whose bits indicate which endpoints have interrupted.
static bool Endpoint_HasEndpointInterrupted |
( |
const uint8_t |
EndpointNumber ) |
[inline, static] |
Determines if the specified endpoint number has interrupted (valid only for INTERRUPT type endpoints).
- Parameters:
-
[in] | EndpointNumber | Index of the endpoint whose interrupt flag should be tested. |
- Returns:
- Boolean true if the specified endpoint has interrupted, false otherwise.
static bool Endpoint_IsConfigured |
( |
void |
) |
[inline, static] |
Determines if the currently selected endpoint is configured.
- Returns:
- Boolean true if the currently selected endpoint has been configured, false otherwise.
static bool Endpoint_IsEnabled |
( |
void |
) |
[inline, static] |
Determines if the currently selected endpoint is enabled, but not necessarily configured.
- Returns:
- Boolean True if the currently selected endpoint is enabled, false otherwise.
static void Endpoint_ResetDataToggle |
( |
void |
) |
[inline, static] |
Resets the data toggle of the currently selected endpoint.
static void Endpoint_ResetFIFO |
( |
const uint8_t |
EndpointNumber ) |
[inline, static] |
Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's In and Out pointers to the bank's contents.
- Parameters:
-
[in] | EndpointNumber | Endpoint number whose FIFO buffers are to be reset. |
static void Endpoint_SelectEndpoint |
( |
const uint8_t |
EndpointNumber ) |
[inline, static] |
Selects the given endpoint number. If the address from the device descriptors is used, the value should be masked with the ENDPOINT_EPNUM_MASK constant to extract only the endpoint number (and discarding the endpoint direction bit).
Any endpoint operations which do not require the endpoint number to be indicated will operate on the currently selected endpoint.
- Parameters:
-
[in] | EndpointNumber | Endpoint number to select. |
static void Endpoint_SetEndpointDirection |
( |
const uint8_t |
DirectionMask ) |
[inline, static] |
Sets the direction of the currently selected endpoint.
- Parameters:
-
[in] | DirectionMask | New endpoint direction, as a ENDPOINT_DIR_* mask. |
Variable Documentation
Global indicating the maximum packet size of the default control endpoint located at address 0 in the device. This value is set to the value indicated in the device descriptor in the user project once the USB interface is initialized into device mode.
If space is an issue, it is possible to fix this to a static value by defining the control endpoint size in the FIXED_CONTROL_ENDPOINT_SIZE token passed to the compiler in the makefile via the -D switch. When a fixed control endpoint size is used, the size is no longer dynamically read from the descriptors at runtime and instead fixed to the given value. When used, it is important that the descriptor control endpoint size value matches the size given as the FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the FIXED_CONTROL_ENDPOINT_SIZE token be used in the descriptors to ensure this.
- Note:
- This variable should be treated as read-only in the user application, and never manually changed in value.