![]() |
LUFA Library
111009
|
Pipe management definitions for the Atmel AVR32 UC3 architecture. More...
Defines | |
#define | PIPE_CONTROLPIPE_DEFAULT_SIZE 64 |
#define | PIPE_TOTAL_PIPES 8 |
#define | PIPE_MAX_SIZE 256 |
Functions | |
static uint8_t | Pipe_GetCurrentPipe (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE |
static void | Pipe_SelectPipe (const uint8_t PipeNumber) ATTR_ALWAYS_INLINE |
static void | Pipe_ResetPipe (const uint8_t PipeNumber) ATTR_ALWAYS_INLINE |
static void | Pipe_EnablePipe (void) ATTR_ALWAYS_INLINE |
static void | Pipe_DisablePipe (void) ATTR_ALWAYS_INLINE |
static bool | Pipe_IsEnabled (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE |
static uint8_t | Pipe_GetPipeToken (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE |
static void | Pipe_SetPipeToken (const uint8_t Token) ATTR_ALWAYS_INLINE |
static void | Pipe_SetInfiniteINRequests (void) ATTR_ALWAYS_INLINE |
static void | Pipe_SetFiniteINRequests (const uint8_t TotalINRequests) ATTR_ALWAYS_INLINE |
static bool | Pipe_IsConfigured (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE |
static uint8_t | Pipe_GetBoundEndpointAddress (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE |
static void | Pipe_SetInterruptPeriod (const uint8_t Milliseconds) ATTR_ALWAYS_INLINE |
static uint8_t | Pipe_GetPipeInterrupts (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE |
static bool | Pipe_HasPipeInterrupted (const uint8_t PipeNumber) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE |
static void | Pipe_Unfreeze (void) ATTR_ALWAYS_INLINE |
static void | Pipe_Freeze (void) ATTR_ALWAYS_INLINE |
static bool | Pipe_IsFrozen (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE |
static void | Pipe_ClearError (void) ATTR_ALWAYS_INLINE |
static bool | Pipe_IsError (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE |
static uint8_t | Pipe_GetErrorFlags (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE |
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) |
bool | Pipe_IsEndpointBound (const uint8_t EndpointAddress) ATTR_WARN_UNUSED_RESULT |
Variables | |
uint8_t | USB_Host_ControlPipeSize |
Pipe Error Flag Masks | |
#define | PIPE_ERRORFLAG_OVERFLOW (AVR32_USBB_UPSTA0_OVERFI_MASK << 8) |
#define | PIPE_ERRORFLAG_CRC16 AVR32_USBB_UPERR0_CRC16_MASK |
#define | PIPE_ERRORFLAG_TIMEOUT AVR32_USBB_UPERR0_TIMEOUT_MASK |
#define | PIPE_ERRORFLAG_PID AVR32_USBB_UPERR0_PID_MASK |
#define | PIPE_ERRORFLAG_DATAPID AVR32_USBB_UPERR0_DATAPID_MASK |
#define | PIPE_ERRORFLAG_DATATGL AVR32_USBB_UPERR0_DATATGL_MASK |
Pipe Token Masks | |
#define | PIPE_TOKEN_SETUP AVR32_USBB_UPCFG0_PTOKEN_SETUP |
#define | PIPE_TOKEN_IN AVR32_USBB_UPCFG0_PTOKEN_IN |
#define | PIPE_TOKEN_OUT AVR32_USBB_UPCFG0_PTOKEN_OUT |
Pipe Bank Mode Masks | |
#define | PIPE_BANK_SINGLE AVR32_USBB_UPCFG0_PBK_SINGLE |
#define | PIPE_BANK_DOUBLE AVR32_USBB_UPCFG0_PBK_DOUBLE |
#define | PIPE_BANK_TRIPLE AVR32_USBB_UPCFG0_PBK_TRIPLE |
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 PIPE_BANK_DOUBLE AVR32_USBB_UPCFG0_PBK_DOUBLE |
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.
#define PIPE_BANK_SINGLE AVR32_USBB_UPCFG0_PBK_SINGLE |
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.
#define PIPE_BANK_TRIPLE AVR32_USBB_UPCFG0_PBK_TRIPLE |
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.
#define PIPE_CONTROLPIPE_DEFAULT_SIZE 64 |
Default size of the default control pipe's bank, until altered by the Endpoint0Size value in the device descriptor of the attached device.
#define PIPE_ERRORFLAG_CRC16 AVR32_USBB_UPERR0_CRC16_MASK |
Mask for Pipe_GetErrorFlags(), indicating that a CRC error occurred in the pipe on the received data.
#define PIPE_ERRORFLAG_DATAPID AVR32_USBB_UPERR0_DATAPID_MASK |
Mask for Pipe_GetErrorFlags(), indicating that a hardware data PID error occurred in the pipe.
#define PIPE_ERRORFLAG_DATATGL AVR32_USBB_UPERR0_DATATGL_MASK |
Mask for Pipe_GetErrorFlags(), indicating that a hardware data toggle error occurred in the pipe.
#define PIPE_ERRORFLAG_OVERFLOW (AVR32_USBB_UPSTA0_OVERFI_MASK << 8) |
Mask for Pipe_GetErrorFlags(), indicating that an overflow error occurred in the pipe on the received data.
#define PIPE_ERRORFLAG_PID AVR32_USBB_UPERR0_PID_MASK |
Mask for Pipe_GetErrorFlags(), indicating that a hardware PID error occurred in the pipe.
#define PIPE_ERRORFLAG_TIMEOUT AVR32_USBB_UPERR0_TIMEOUT_MASK |
Mask for Pipe_GetErrorFlags(), indicating that a hardware timeout error occurred in the pipe.
#define PIPE_MAX_SIZE 256 |
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.
#define PIPE_TOKEN_IN AVR32_USBB_UPCFG0_PTOKEN_IN |
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.
#define PIPE_TOKEN_OUT AVR32_USBB_UPCFG0_PTOKEN_OUT |
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.
#define PIPE_TOKEN_SETUP AVR32_USBB_UPCFG0_PTOKEN_SETUP |
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.
#define PIPE_TOTAL_PIPES 8 |
Total number of pipes (including the default control pipe at address 0) which may be used in the device.
static void Pipe_ClearError | ( | void | ) | [inline, static] |
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().
[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. |
ORDERED_EP_CONFIG
compile time option is used, Pipes must be configured in ascending order, or bank corruption will occur. true
if the configuration succeeded, false
otherwise. static void Pipe_DisablePipe | ( | void | ) | [inline, static] |
Disables the currently selected pipe so that data cannot be sent and received through it to and from an attached device.
static void Pipe_EnablePipe | ( | void | ) | [inline, static] |
Enables the currently selected pipe so that data can be sent and received through it to and from an attached device.
static void Pipe_Freeze | ( | void | ) | [inline, static] |
Freezes the selected pipe, preventing it from communicating with an attached device.
static uint8_t Pipe_GetBoundEndpointAddress | ( | void | ) | [inline, static] |
Retrieves the endpoint address of the endpoint within the attached device that the currently selected pipe is bound to.
static uint8_t Pipe_GetCurrentPipe | ( | void | ) | [inline, static] |
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.
static uint8_t Pipe_GetErrorFlags | ( | void | ) | [inline, static] |
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.
PIPE_ERRORFLAG_*
bits indicating what error has occurred on the selected pipe. static uint8_t Pipe_GetPipeInterrupts | ( | void | ) | [inline, static] |
Returns a mask indicating which pipe's interrupt periods have elapsed, indicating that the pipe should be serviced.
static uint8_t Pipe_GetPipeToken | ( | void | ) | [inline, static] |
Gets the current pipe token, indicating the pipe's data direction and type.
PIPE_TOKEN_*
mask. static bool Pipe_HasPipeInterrupted | ( | const uint8_t | PipeNumber | ) | [inline, static] |
Determines if the specified pipe number has interrupted (valid only for INTERRUPT type pipes).
[in] | PipeNumber | Index of the pipe whose interrupt flag should be tested. |
true
if the specified pipe has interrupted, false
otherwise. static bool Pipe_IsConfigured | ( | void | ) | [inline, static] |
Determines if the currently selected pipe is configured.
true
if the selected pipe is configured, false
otherwise. static bool Pipe_IsEnabled | ( | void | ) | [inline, static] |
Determines if the currently selected pipe is enabled, but not necessarily configured.
true
if the currently selected pipe is enabled, false
otherwise. bool Pipe_IsEndpointBound | ( | const uint8_t | EndpointAddress | ) |
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.
[in] | EndpointAddress | Address and direction mask of the endpoint within the attached device to check. |
true
if a pipe bound to the given endpoint address of the specified direction is found, false
otherwise. static bool Pipe_IsError | ( | void | ) | [inline, static] |
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.
true
if an error has occurred on the selected pipe, false
otherwise. static bool Pipe_IsFrozen | ( | void | ) | [inline, static] |
Determines if the currently selected pipe is frozen, and not able to accept data.
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.
[in] | PipeNumber | Index of the pipe to reset. |
static void Pipe_SelectPipe | ( | const uint8_t | PipeNumber | ) | [inline, static] |
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.
[in] | PipeNumber | Index of the pipe to select. |
static void Pipe_SetFiniteINRequests | ( | const uint8_t | TotalINRequests | ) | [inline, static] |
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.
[in] | TotalINRequests | Total number of IN requests that the pipe may receive before freezing. |
static void Pipe_SetInfiniteINRequests | ( | void | ) | [inline, static] |
Configures the currently selected pipe to allow for an unlimited number of IN requests.
static void Pipe_SetInterruptPeriod | ( | const uint8_t | Milliseconds | ) | [inline, static] |
Sets the period between interrupts for an INTERRUPT type pipe to a specified number of milliseconds.
[in] | Milliseconds | Number of milliseconds between each pipe poll. |
static void Pipe_SetPipeToken | ( | const uint8_t | Token | ) | [inline, static] |
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.
[in] | Token | New pipe token to set the selected pipe to, as a PIPE_TOKEN_* mask. |
static void Pipe_Unfreeze | ( | void | ) | [inline, static] |
Unfreezes the selected pipe, allowing it to communicate with an attached device.
uint8_t USB_Host_ControlPipeSize |
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.