Pipe management definitions for the Atmel AVR32 UC3 architecture.
More...
Detailed Description
This module contains functions, macros and enums related to pipe management when in USB Host mode. This module contains the pipe management macros, as well as pipe interrupt and data send/receive functions for various data types.
Define Documentation
Mask for the bank mode selection for the Pipe_ConfigurePipe() macro. This indicates that the pipe should have two banks, which requires more USB FIFO memory but results in faster transfers as one USB device (the AVR or the attached device) can access one bank while the other accesses the second bank.
Mask for the bank mode selection for the Pipe_ConfigurePipe() macro. This indicates that the pipe 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 attached device) can access the pipe's bank at the one time.
Mask for the bank mode selection for the Pipe_ConfigurePipe() macro. This indicates that the pipe should have three banks, which requires more USB FIFO memory but results in faster transfers as one USB device (the AVR or the attached device) can access one bank while the other accesses the remaining banks.
- Note:
- Not available on all AVR models.
Default size of the default control pipe's bank, until altered by the Endpoint0Size value in the device descriptor of the attached device.
Mask for Pipe_GetErrorFlags(), indicating that a CRC error occurred in the pipe on the received data.
Mask for Pipe_GetErrorFlags(), indicating that an overflow error occurred in the pipe on the received data.
Size in bytes of the largest pipe bank size possible in the device. Not all banks on each AVR model supports the largest bank size possible on the device; different pipe numbers support different maximum bank sizes. This value reflects the largest possible bank of any pipe on the currently selected UC3 AVR model.
Token mask for Pipe_ConfigurePipe(). This sets the pipe as a IN token (for non-CONTROL type pipes), indicating that the pipe data will flow from device to host.
Token mask for Pipe_ConfigurePipe(). This sets the pipe as a OUT token (for non-CONTROL type pipes), indicating that the pipe data will flow from host to device.
Token mask for Pipe_ConfigurePipe(). This sets the pipe as a SETUP token (for CONTROL type pipes), which will trigger a control request on the attached device when data is written to the pipe.
Total number of pipes (including the default control pipe at address 0) which may be used in the device.
Function Documentation
Clears the error flags for the currently selected pipe.
bool Pipe_ConfigurePipe |
( |
const uint8_t |
Number, |
|
|
const uint8_t |
Type, |
|
|
const uint8_t |
Token, |
|
|
const uint8_t |
EndpointNumber, |
|
|
const uint16_t |
Size, |
|
|
const uint8_t |
Banks |
|
) |
| |
Configures the specified pipe number with the given pipe type, token, target endpoint number in the attached device, bank size and banking mode.
A newly configured pipe is frozen by default, and must be unfrozen before use via the Pipe_Unfreeze() before being used. Pipes should be kept frozen unless waiting for data from a device while in IN mode, or sending data to the device in OUT mode. IN type pipes are also automatically configured to accept infinite numbers of IN requests without automatic freezing - this can be overridden by a call to Pipe_SetFiniteINRequests().
- Parameters:
-
[in] | Number | Pipe number to configure. This must be more than 0 and less than PIPE_TOTAL_PIPES. |
[in] | Type | Type of pipe to configure, an EP_TYPE_* mask. Not all pipe types are available on Low Speed USB devices - refer to the USB 2.0 specification. |
[in] | Token | Pipe data token, either PIPE_TOKEN_SETUP, PIPE_TOKEN_OUT or PIPE_TOKEN_IN. All pipes (except Control type) are unidirectional - data may only be read from or written to the pipe bank based on its direction, not both. |
[in] | EndpointNumber | Endpoint index within the attached device that the pipe should interface to. |
[in] | Size | Size of the pipe's bank, where packets are stored before they are transmitted to the USB device, or after they have been received from the USB device (depending on the pipe's data direction). The bank size must indicate the maximum packet size that the pipe can handle. |
[in] | Banks | Number of banks to use for the pipe being configured, a PIPE_BANK_* mask. More banks uses more USB DPRAM, but offers better performance. Isochronous type pipes must have at least two banks. |
- Note:
- When the
ORDERED_EP_CONFIG
compile time option is used, Pipes must be configured in ascending order, or bank corruption will occur.
-
Certain microcontroller model's pipes may have different maximum packet sizes based on the pipe's index - refer to the chosen microcontroller's datasheet to determine the maximum bank size for each pipe.
-
The default control pipe 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 pipe upon success. Upon failure, the pipe which failed to reconfigure correctly will be selected.
- Returns:
- Boolean
true
if the configuration succeeded, false
otherwise.
Disables the currently selected pipe so that data cannot be sent and received through it to and from an attached device.
Enables the currently selected pipe so that data can be sent and received through it to and from an attached device.
- Precondition:
- The currently selected pipe must first be configured properly via Pipe_ConfigurePipe().
Freezes the selected pipe, preventing it from communicating with an attached device.
Retrieves the endpoint address of the endpoint within the attached device that the currently selected pipe is bound to.
- Returns:
- Endpoint address the currently selected pipe is bound to.
Returns the pipe address of the currently selected pipe. This is typically used to save the currently selected pipe number so that it can be restored after another pipe has been manipulated.
- Returns:
- Index of the currently selected pipe.
Gets a mask of the hardware error flags which have occurred on the currently selected pipe. This value can then be masked against the PIPE_ERRORFLAG_*
masks to determine what error has occurred.
- Returns:
- Mask comprising of
PIPE_ERRORFLAG_*
bits indicating what error has occurred on the selected pipe.
Returns a mask indicating which pipe's interrupt periods have elapsed, indicating that the pipe should be serviced.
- Returns:
- Mask whose bits indicate which pipes have interrupted.
Gets the current pipe token, indicating the pipe's data direction and type.
- Returns:
- The current pipe token, as a
PIPE_TOKEN_*
mask.
Determines if the specified pipe number has interrupted (valid only for INTERRUPT type pipes).
- Parameters:
-
[in] | PipeNumber | Index of the pipe whose interrupt flag should be tested. |
- Returns:
- Boolean
true
if the specified pipe has interrupted, false
otherwise.
Determines if the currently selected pipe is configured.
- Returns:
- Boolean
true
if the selected pipe is configured, false
otherwise.
Determines if the currently selected pipe is enabled, but not necessarily configured.
- Returns:
- Boolean
true
if the currently selected pipe is enabled, false
otherwise.
Determines if a pipe has been bound to the given device endpoint address. If a pipe which is bound to the given endpoint is found, it is automatically selected.
- Parameters:
-
[in] | EndpointAddress | Address and direction mask of the endpoint within the attached device to check. |
- Returns:
- Boolean
true
if a pipe bound to the given endpoint address of the specified direction is found, false
otherwise.
Determines if the master pipe error flag is set for the currently selected pipe, indicating that some sort of hardware error has occurred on the pipe.
- See also:
- Pipe_GetErrorFlags() macro for information on retrieving the exact error flag.
- Returns:
- Boolean
true
if an error has occurred on the selected pipe, false
otherwise.
Determines if the currently selected pipe is frozen, and not able to accept data.
- Returns:
- Boolean
true
if the currently selected pipe is frozen, false
otherwise.
static void Pipe_ResetPipe |
( |
const uint8_t |
PipeNumber | ) |
[inline, static] |
Resets the desired pipe, including the pipe banks and flags.
- Parameters:
-
[in] | PipeNumber | Index of the pipe to reset. |
Selects the given pipe number. Any pipe operations which do not require the pipe number to be indicated will operate on the currently selected pipe.
- Parameters:
-
[in] | PipeNumber | Index of the pipe to select. |
Configures the currently selected pipe to only allow the specified number of IN requests to be accepted by the pipe before it is automatically frozen.
- Parameters:
-
[in] | TotalINRequests | Total number of IN requests that the pipe may receive before freezing. |
Configures the currently selected pipe to allow for an unlimited number of IN requests.
Sets the period between interrupts for an INTERRUPT type pipe to a specified number of milliseconds.
- Parameters:
-
[in] | Milliseconds | Number of milliseconds between each pipe poll. |
Sets the token for the currently selected pipe to one of the tokens specified by the PIPE_TOKEN_*
masks. This can be used on CONTROL type pipes, to allow for bidirectional transfer of data during control requests, or on regular pipes to allow for half-duplex bidirectional data transfer to devices which have two endpoints of opposite direction sharing the same endpoint address within the device.
- Parameters:
-
[in] | Token | New pipe token to set the selected pipe to, as a PIPE_TOKEN_* mask. |
Unfreezes the selected pipe, allowing it to communicate with an attached device.
Variable Documentation
Global indicating the maximum packet size of the default control pipe located at address 0 in the device. This value is set to the value indicated in the attached device's device descriptor once the USB interface is initialized into host mode and a device is attached to the USB bus.
- Note:
- This variable should be treated as read-only in the user application, and never manually changed in value.