#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
#include "../HighLevel/USBTask.h"
#include "StreamCallbacks.h"
#include "../HighLevel/USBTask.h"
Defines | |
#define | ENDPOINT_DIR_OUT (0 << EPDIR) |
#define | ENDPOINT_DIR_IN (1 << EPDIR) |
#define | ENDPOINT_BANK_SINGLE (0 << EPBK0) |
#define | ENDPOINT_BANK_DOUBLE (1 << EPBK0) |
#define | ENDPOINT_CONTROLEP 0 |
#define | ENDPOINT_CONTROLEP_DEFAULT_SIZE 8 |
#define | ENDPOINT_EPNUM_MASK 0b111 |
#define | ENDPOINT_EPSIZE_MASK 0x7FF |
#define | ENDPOINT_MAX_SIZE(n) _ENDPOINT_GET_MAXSIZE(n) |
#define | ENDPOINT_DOUBLEBANK_SUPPORTED(n) _ENDPOINT_GET_DOUBLEBANK(n) |
#define | ENDPOINT_TOTAL_ENDPOINTS 7 |
#define | ENDPOINT_INT_SETUP UEIENX, (1 << RXSTPE), UEINTX, (1 << RXSTPI) |
#define | ENDPOINT_INT_IN UEIENX, (1 << TXINE) , UEINTX, (1 << TXINI) |
#define | ENDPOINT_INT_OUT UEIENX, (1 << RXOUTE), UEINTX, (1 << RXOUTI) |
#define | Endpoint_BytesInEndpoint() UEBCX |
#define | Endpoint_GetCurrentEndpoint() (UENUM & ENDPOINT_EPNUM_MASK) |
#define | Endpoint_SelectEndpoint(epnum) MACROS{ UENUM = epnum; }MACROE |
#define | Endpoint_ResetFIFO(epnum) MACROS{ UERST = (1 << epnum); UERST = 0; }MACROE |
#define | Endpoint_EnableEndpoint() MACROS{ UECONX |= (1 << EPEN); }MACROE |
#define | Endpoint_DisableEndpoint() MACROS{ UECONX &= ~(1 << EPEN); }MACROE |
#define | Endpoint_IsEnabled() ((UECONX & (1 << EPEN)) ? true : false) |
#define | Endpoint_ReadWriteAllowed() ((UEINTX & (1 << RWAL)) ? true : false) |
#define | Endpoint_IsConfigured() ((UESTA0X & (1 << CFGOK)) ? true : false) |
#define | Endpoint_GetEndpointInterrupts() UEINT |
#define | Endpoint_ClearEndpointInterrupt(n) MACROS{ UEINT &= ~(1 << n); }MACROE |
#define | Endpoint_HasEndpointInterrupted(n) ((UEINT & (1 << n)) ? true : false) |
#define | Endpoint_ClearCurrentBank() MACROS{ UEINTX &= ~(1 << FIFOCON); }MACROE |
#define | Endpoint_IsSetupINReady() ((UEINTX & (1 << TXINI)) ? true : false) |
#define | Endpoint_IsSetupOUTReceived() ((UEINTX & (1 << RXOUTI)) ? true : false) |
#define | Endpoint_IsSetupReceived() ((UEINTX & (1 << RXSTPI)) ? true : false) |
#define | Endpoint_ClearSetupReceived() MACROS{ UEINTX &= ~(1 << RXSTPI); }MACROE |
#define | Endpoint_ClearSetupIN() MACROS{ UEINTX &= ~(1 << TXINI); }MACROE |
#define | Endpoint_ClearSetupOUT() MACROS{ UEINTX &= ~(1 << RXOUTI); }MACROE |
#define | Endpoint_StallTransaction() MACROS{ UECONX |= (1 << STALLRQ); }MACROE |
#define | Endpoint_ClearStall() MACROS{ UECONX |= (1 << STALLRQC); }MACROE |
#define | Endpoint_IsStalled() ((UECONX & (1 << STALLRQ)) ? true : false) |
#define | Endpoint_ResetDataToggle() MACROS{ UECONX |= (1 << RSTDT); }MACROE |
#define | Endpoint_Ignore_Byte() Endpoint_Discard_Byte() |
#define | Endpoint_Ignore_Word() Endpoint_Discard_Word() |
#define | Endpoint_Ignore_DWord() Endpoint_Discard_DWord() |
#define | Endpoint_Read_Word() Endpoint_Read_Word_LE() |
#define | Endpoint_Write_Word(Word) Endpoint_Write_Word_LE(Word) |
#define | Endpoint_Read_DWord() Endpoint_Read_DWord_LE() |
#define | Endpoint_Write_DWord(DWord) Endpoint_Write_DWord_LE(DWord) |
#define | Endpoint_Read_Stream(Buffer, Length, Callback) Endpoint_Read_Stream_LE(Buffer, Length, Callback) |
#define | Endpoint_Write_Stream(Buffer, Length, Callback) Endpoint_Write_Stream_LE(Buffer, Length, Callback) |
#define | Endpoint_Read_Control_Stream(Data, Length) Endpoint_Read_Control_Stream_LE(Data, Length) |
#define | Endpoint_Write_Control_Stream(Data, Length) Endpoint_Write_Control_Stream_LE(Data, Length) |
Enumerations | |
enum | Endpoint_WaitUntilReady_ErrorCodes_t { ENDPOINT_READYWAIT_NoError = 0, ENDPOINT_READYWAIT_EndpointStalled = 1, ENDPOINT_READYWAIT_DeviceDisconnected = 2, ENDPOINT_READYWAIT_Timeout = 3 } |
enum | Endpoint_Stream_RW_ErrorCodes_t { ENDPOINT_RWSTREAM_ERROR_NoError = 0, ENDPOINT_RWSTREAM_ERROR_EndpointStalled = 1, ENDPOINT_RWSTREAM_ERROR_DeviceDisconnected = 1, ENDPOINT_RWSTREAM_ERROR_Timeout = 2, ENDPOINT_RWSTREAM_ERROR_CallbackAborted = 3 } |
enum | Endpoint_ControlStream_RW_ErrorCodes_t { ENDPOINT_RWCSTREAM_ERROR_NoError = 0, ENDPOINT_RWCSTREAM_ERROR_HostAborted = 1 } |
Functions | |
static uint8_t | Endpoint_Read_Byte (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE |
static void | Endpoint_Write_Byte (const uint8_t Byte) ATTR_ALWAYS_INLINE |
static void | Endpoint_Discard_Byte (void) ATTR_ALWAYS_INLINE |
static uint16_t | Endpoint_Read_Word_LE (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE |
static uint16_t | Endpoint_Read_Word_BE (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE |
static void | Endpoint_Write_Word_LE (const uint16_t Word) ATTR_ALWAYS_INLINE |
static void | Endpoint_Write_Word_BE (const uint16_t Word) ATTR_ALWAYS_INLINE |
static void | Endpoint_Discard_Word (void) ATTR_ALWAYS_INLINE |
static uint32_t | Endpoint_Read_DWord_LE (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE |
static uint32_t | Endpoint_Read_DWord_BE (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE |
static void | Endpoint_Write_DWord_LE (const uint32_t DWord) ATTR_ALWAYS_INLINE |
static void | Endpoint_Write_DWord_BE (const uint32_t DWord) ATTR_ALWAYS_INLINE |
static void | Endpoint_Discard_DWord (void) ATTR_ALWAYS_INLINE |
bool | Endpoint_ConfigureEndpoint (const uint8_t Number, const uint8_t Type, const uint8_t Direction, const uint16_t Size, const uint8_t Banks) |
uint8_t | Endpoint_WaitUntilReady (void) |
uint8_t | Endpoint_Discard_Stream (uint16_t Length, uint8_t(*const Callback)(void)) |
uint8_t | Endpoint_Write_Stream_LE (const void *Buffer, uint16_t Length, uint8_t(*const Callback)(void)) ATTR_NON_NULL_PTR_ARG(1) |
uint8_t | Endpoint_Write_Stream_BE (const void *Buffer, uint16_t Length, uint8_t(*const Callback)(void)) ATTR_NON_NULL_PTR_ARG(1) |
uint8_t | Endpoint_Read_Stream_LE (void *Buffer, uint16_t Length, uint8_t(*const Callback)(void)) ATTR_NON_NULL_PTR_ARG(1) |
uint8_t | Endpoint_Read_Stream_BE (void *Buffer, uint16_t Length, uint8_t(*const Callback)(void)) ATTR_NON_NULL_PTR_ARG(1) |
uint8_t | Endpoint_Write_Control_Stream_LE (const void *Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) |
uint8_t | Endpoint_Write_Control_Stream_BE (const void *Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) |
uint8_t | Endpoint_Read_Control_Stream_LE (void *Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) |
uint8_t | Endpoint_Read_Control_Stream_BE (void *Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) |
Variables | |
uint8_t | USB_ControlEndpointSize |
#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_BytesInEndpoint | ( | ) | UEBCX |
Indicates the number of bytes currently stored in the current endpoint's selected bank.
#define Endpoint_ClearCurrentBank | ( | ) | MACROS{ UEINTX &= ~(1 << FIFOCON); }MACROE |
Clears the currently selected endpoint bank, and switches to the alternate bank if the currently selected endpoint is dual-banked. When cleared, this either frees the bank up for the next packet from the host (if the endpoint is of the OUT direction) or sends the packet contents to the host (if the endpoint is of the IN direction).
#define Endpoint_ClearEndpointInterrupt | ( | n | ) | MACROS{ UEINT &= ~(1 << n); }MACROE |
Clears the endpoint interrupt flag. This clears the specified endpoint number's interrupt mask in the endpoint interrupt flag register.
#define Endpoint_ClearSetupIN | ( | ) | MACROS{ UEINTX &= ~(1 << TXINI); }MACROE |
Sends an IN packet to the host on the currently selected CONTROL type endpoint.
#define Endpoint_ClearSetupOUT | ( | ) | MACROS{ UEINTX &= ~(1 << RXOUTI); }MACROE |
Acknowledges an OUT packet to the host on the currently selected CONTROL type endpoint, freeing up the endpoint for the next packet.
#define Endpoint_ClearSetupReceived | ( | ) | MACROS{ UEINTX &= ~(1 << RXSTPI); }MACROE |
Clears a received SETUP packet on the currently selected CONTROL type endpoint.
#define Endpoint_ClearStall | ( | ) | MACROS{ UECONX |= (1 << STALLRQC); }MACROE |
Clears the stall on the currently selected endpoint.
#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 Endpoint0Size 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_DisableEndpoint | ( | ) | MACROS{ UECONX &= ~(1 << EPEN); }MACROE |
Disables the currently selected endpoint so that data cannot be sent and received through it to and from a host.
#define ENDPOINT_DOUBLEBANK_SUPPORTED | ( | n | ) | _ENDPOINT_GET_DOUBLEBANK(n) |
Indicates if the given endpoint supports double banking.
n | Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1) |
#define Endpoint_EnableEndpoint | ( | ) | MACROS{ UECONX |= (1 << EPEN); }MACROE |
Enables the currently selected endpoint so that data can be sent and received through it to and from a host.
#define ENDPOINT_EPNUM_MASK 0b111 |
Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's numerical address in the device.
#define ENDPOINT_EPSIZE_MASK 0x7FF |
Endpoint bank size mask, for masking against endpoint addresses to retrieve the endpoint's bank size in the device.
#define Endpoint_GetCurrentEndpoint | ( | ) | (UENUM & ENDPOINT_EPNUM_MASK) |
Returns 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.
#define Endpoint_GetEndpointInterrupts | ( | ) | UEINT |
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}).
#define Endpoint_HasEndpointInterrupted | ( | n | ) | ((UEINT & (1 << n)) ? true : false) |
Returns true if the specified endpoint number has interrupted (valid only for INTERRUPT type endpoints), false otherwise.
#define Endpoint_Ignore_Byte | ( | ) | Endpoint_Discard_Byte() |
Alias for Endpoint_Discard_Byte().
#define Endpoint_Ignore_DWord | ( | ) | Endpoint_Discard_DWord() |
Alias for Endpoint_Discard_DWord().
#define Endpoint_Ignore_Word | ( | ) | Endpoint_Discard_Word() |
Alias for Endpoint_Discard_Word().
#define ENDPOINT_INT_IN UEIENX, (1 << TXINE) , UEINTX, (1 << TXINI) |
Interrupt definition for the endpoint IN interrupt (for INTERRUPT type endpoints). Should be used with the USB_INT_* macros located in USBInterrupt.h.
This interrupt will fire if enabled on an INTERRUPT type endpoint if a the endpoint interrupt period has elapsed and the endpoint is ready for a new packet to be written to its FIFO buffer (if required).
#define ENDPOINT_INT_OUT UEIENX, (1 << RXOUTE), UEINTX, (1 << RXOUTI) |
Interrupt definition for the endpoint OUT interrupt (for INTERRUPT type endpoints). Should be used with the USB_INT_* macros located in USBInterrupt.h.
This interrupt will fire if enabled on an INTERRUPT type endpoint if a the endpoint interrupt period has elapsed and the endpoint is ready for a packet from the host to be read from its FIFO buffer (if received).
#define ENDPOINT_INT_SETUP UEIENX, (1 << RXSTPE), UEINTX, (1 << RXSTPI) |
Interrupt definition for the endpoint SETUP interrupt (for CONTROL type endpoints). Should be used with the USB_INT_* macros located in USBInterrupt.h.
This interrupt will fire if enabled on a CONTROL type endpoint if a new control packet is received from the host.
#define Endpoint_IsConfigured | ( | ) | ((UESTA0X & (1 << CFGOK)) ? true : false) |
Returns true if the currently selected endpoint is configured, false otherwise.
#define Endpoint_IsEnabled | ( | ) | ((UECONX & (1 << EPEN)) ? true : false) |
Returns true if the currently selected endpoint is enabled, false otherwise.
#define Endpoint_IsSetupINReady | ( | ) | ((UEINTX & (1 << TXINI)) ? true : false) |
Returns true if the current CONTROL type endpoint is ready for an IN packet, false otherwise.
#define Endpoint_IsSetupOUTReceived | ( | ) | ((UEINTX & (1 << RXOUTI)) ? true : false) |
Returns true if the current CONTROL type endpoint is ready for an OUT packet, false otherwise.
#define Endpoint_IsSetupReceived | ( | ) | ((UEINTX & (1 << RXSTPI)) ? true : false) |
Returns true if the current CONTROL type endpoint is ready for a SETUP packet, false otherwise.
#define Endpoint_IsStalled | ( | ) | ((UECONX & (1 << STALLRQ)) ? true : false) |
Returns true if the currently selected endpoint is stalled, false othewise.
#define ENDPOINT_MAX_SIZE | ( | n | ) | _ENDPOINT_GET_MAXSIZE(n) |
Maximum size in bytes of a given endpoint.
n | Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1) |
#define Endpoint_Read_Control_Stream | ( | Data, | |||
Length | ) | Endpoint_Read_Control_Stream_LE(Data, Length) |
Alias for Endpoint_Read_Control_Stream_LE(). By default USB transfers use little endian format, thus the command with no endianness specifier indicates little endian mode.
#define Endpoint_Read_DWord | ( | ) | Endpoint_Read_DWord_LE() |
Alias for Endpoint_Read_DWord_LE(). By default USB transfers use little endian format, thus the command with no endianness specifier indicates little endian mode.
#define Endpoint_Read_Stream | ( | Buffer, | |||
Length, | |||||
Callback | ) | Endpoint_Read_Stream_LE(Buffer, Length, Callback) |
Alias for Endpoint_Read_Stream_LE(). By default USB transfers use little endian format, thus the command with no endianness specifier indicates little endian mode.
#define Endpoint_Read_Word | ( | ) | Endpoint_Read_Word_LE() |
Alias for Endpoint_Read_Word_LE(). By default USB transfers use little endian format, thus the command with no endianness specifier indicates little endian mode.
#define Endpoint_ReadWriteAllowed | ( | ) | ((UEINTX & (1 << RWAL)) ? true : false) |
Returns true if the currently selected endpoint may be read from (if data is waiting in the endpoint bank and the endpoint is an OUT direction, or if the bank is not yet full if the endpoint is an IN direction). This function will return false if an error has occured in the endpoint, or if the endpoint is an OUT direction and no packet has been received, or if the endpoint is an IN direction and the endpoint bank is full.
#define Endpoint_ResetDataToggle | ( | ) | MACROS{ UECONX |= (1 << RSTDT); }MACROE |
Resets the data toggle of the currently selected endpoint.
#define Endpoint_ResetFIFO | ( | epnum | ) | MACROS{ UERST = (1 << epnum); UERST = 0; }MACROE |
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.
#define Endpoint_SelectEndpoint | ( | epnum | ) | MACROS{ UENUM = epnum; }MACROE |
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.
#define Endpoint_StallTransaction | ( | ) | MACROS{ UECONX |= (1 << STALLRQ); }MACROE |
Stalls the current endpoint, indicating to the host that a logical problem occured with the indicated endpoint and that the current transfer sequence should be aborted. This provides a way for devices to indicate invalid commands to the host so that the current transfer can be aborted and the host can begin its own recovery seqeuence.
The currently selected endpoint remains stalled until either the Endpoint_ClearStall() macro is called, or the host issues a CLEAR FEATURE request to the device for the currently selected endpoint.
#define ENDPOINT_TOTAL_ENDPOINTS 7 |
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.
#define Endpoint_Write_Control_Stream | ( | Data, | |||
Length | ) | Endpoint_Write_Control_Stream_LE(Data, Length) |
Alias for Endpoint_Write_Control_Stream_LE(). By default USB transfers use little endian format, thus the command with no endianness specifier indicates little endian mode.
#define Endpoint_Write_DWord | ( | DWord | ) | Endpoint_Write_DWord_LE(DWord) |
Alias for Endpoint_Write_DWord_LE(). By default USB transfers use little endian format, thus the command with no endianness specifier indicates little endian mode.
#define Endpoint_Write_Stream | ( | Buffer, | |||
Length, | |||||
Callback | ) | Endpoint_Write_Stream_LE(Buffer, Length, Callback) |
Alias for Endpoint_Write_Stream_LE(). By default USB transfers use little endian format, thus the command with no endianness specifier indicates little endian mode.
#define Endpoint_Write_Word | ( | Word | ) | Endpoint_Write_Word_LE(Word) |
Alias for Endpoint_Write_Word_LE(). By default USB transfers use little endian format, thus the command with no endianness specifier indicates little endian mode.
Enum for the possible error return codes of the Endpoint_*_Stream_* functions.
Enum for the possible error return codes of the Endpoint_WaitUntilReady function
bool Endpoint_ConfigureEndpoint | ( | const uint8_t | Number, | |
const uint8_t | Type, | |||
const uint8_t | Direction, | |||
const uint16_t | Size, | |||
const uint8_t | Banks | |||
) |
Configures the specified endpoint number with the given endpoint type, direction, bank size and banking mode. Endpoints should be allocated in ascending order by their address in the device (i.e. endpoint 1 should be configured before endpoint 2 and so on).
The endpoint type may be one of the EP_TYPE_* macros listed in LowLevel.h and the direction may be either ENDPOINT_DIR_OUT or ENDPOINT_DIR_IN.
The bank size must indicate the maximum packet size that the endpoint can handle. Different endpoint numbers can handle different maximum packet sizes - refer to the chosen USB AVR's datasheet to determine the maximum bank size for each endpoint.
The banking mode may be either ENDPOINT_BANK_SINGLE or ENDPOINT_BANK_DOUBLE.
The success of this routine can be determined via the Endpoint_IsConfigured() macro.
By default, the routine is entirely dynamic, and will accept both constant and variable inputs. If dynamic configuration is unused, a small space savings can be made by defining the STATIC_ENDPOINT_CONFIGURATION macro via the -D switch to the compiler, to optimize for constant input values.
static void Endpoint_Discard_Byte | ( | void | ) | [inline, static] |
Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
static void Endpoint_Discard_DWord | ( | void | ) | [inline, static] |
Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.
uint8_t Endpoint_Discard_Stream | ( | uint16_t | Length, | |
uint8_t(*)(void) | Callback | |||
) |
Reads and discards the given number of bytes from the endpoint from the given buffer, discarding fully read packets from the host as needed. The last packet is not automatically discarded once the remaining bytes has been read; the user is responsible for manually discarding the last packet from the host via the Endpoint_ClearCurrentBank() macro. Between each USB packet, the given stream callback function is executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
The callback routine should be created using the STREAM_CALLBACK() macro. If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled and this function has the Callback parameter ommitted.
Length | Number of bytes to send via the currently selected endpoint. | |
Callback | Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback |
static void Endpoint_Discard_Word | ( | void | ) | [inline, static] |
Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
static uint8_t Endpoint_Read_Byte | ( | void | ) | [inline, static] |
Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.
uint8_t Endpoint_Read_Control_Stream_BE | ( | void * | Buffer, | |
uint16_t | Length | |||
) |
Reads the given number of bytes from the CONTROL endpoint from the given buffer in big endian, discarding fully read packets from the host as needed. The device IN acknowledgement is not automatically sent after success or failure states; the user is responsible for manually sending the setup IN to finalize the transfer via the Endpoint_ClearSetupIN() macro.
Buffer | Pointer to the destination data buffer to write to. | |
Length | Number of bytes to send via the currently selected endpoint. |
uint8_t Endpoint_Read_Control_Stream_LE | ( | void * | Buffer, | |
uint16_t | Length | |||
) |
Reads the given number of bytes from the CONTROL endpoint from the given buffer in little endian, discarding fully read packets from the host as needed. The device IN acknowledgement is not automatically sent after success or failure states; the user is responsible for manually sending the setup IN to finalize the transfer via the Endpoint_ClearSetupIN() macro.
Buffer | Pointer to the destination data buffer to write to. | |
Length | Number of bytes to send via the currently selected endpoint. |
static uint32_t Endpoint_Read_DWord_BE | ( | void | ) | [inline, static] |
Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT direction endpoints.
static uint32_t Endpoint_Read_DWord_LE | ( | void | ) | [inline, static] |
Reads four bytes from the currently selected endpoint's bank in little endian format, for OUT direction endpoints.
uint8_t Endpoint_Read_Stream_BE | ( | void * | Buffer, | |
uint16_t | Length, | |||
uint8_t(*)(void) | Callback | |||
) |
Reads the given number of bytes from the endpoint from the given buffer in big endian, discarding fully read packets from the host as needed. The last packet is not automatically discarded once the remaining bytes has been read; the user is responsible for manually discarding the last packet from the host via the Endpoint_ClearCurrentBank() macro. Between each USB packet, the given stream callback function is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early aborts of stream transfers.
The callback routine should be created using the STREAM_CALLBACK() macro. If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled and this function has the Callback parameter ommitted.
Buffer | Pointer to the destination data buffer to write to. | |
Length | Number of bytes to send via the currently selected endpoint. | |
Callback | Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback |
uint8_t Endpoint_Read_Stream_LE | ( | void * | Buffer, | |
uint16_t | Length, | |||
uint8_t(*)(void) | Callback | |||
) |
Reads the given number of bytes from the endpoint from the given buffer in little endian, discarding fully read packets from the host as needed. The last packet is not automatically discarded once the remaining bytes has been read; the user is responsible for manually discarding the last packet from the host via the Endpoint_ClearCurrentBank() macro. Between each USB packet, the given stream callback function is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early aborts of stream transfers.
The callback routine should be created using the STREAM_CALLBACK() macro. If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled and this function has the Callback parameter ommitted.
Buffer | Pointer to the destination data buffer to write to. | |
Length | Number of bytes to send via the currently selected endpoint. | |
Callback | Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback |
static uint16_t Endpoint_Read_Word_BE | ( | void | ) | [inline, static] |
Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT direction endpoints.
static uint16_t Endpoint_Read_Word_LE | ( | void | ) | [inline, static] |
Reads two bytes from the currently selected endpoint's bank in little endian format, for OUT direction endpoints.
uint8_t Endpoint_WaitUntilReady | ( | void | ) |
Spinloops until the currently selected non-control endpoint is ready for the next packet of data to be read or written to it.
static void Endpoint_Write_Byte | ( | const uint8_t | Byte | ) | [inline, static] |
Writes one byte from the currently selected endpoint's bank, for IN direction endpoints.
uint8_t Endpoint_Write_Control_Stream_BE | ( | const void * | Buffer, | |
uint16_t | Length | |||
) |
Writes the given number of bytes to the CONTROL type endpoint from the given buffer in big endian, sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared in both failure and success states; the user is responsible for manually clearing the setup OUT to finalize the transfer via the Endpoint_ClearSetupOUT() macro.
Buffer | Pointer to the source data buffer to read from. | |
Length | Number of bytes to read for the currently selected endpoint into the buffer. |
uint8_t Endpoint_Write_Control_Stream_LE | ( | const void * | Buffer, | |
uint16_t | Length | |||
) |
Writes the given number of bytes to the CONTROL type endpoint from the given buffer in little endian, sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared in both failure and success states; the user is responsible for manually clearing the setup OUT to finalize the transfer via the Endpoint_ClearSetupOUT() macro.
Buffer | Pointer to the source data buffer to read from. | |
Length | Number of bytes to read for the currently selected endpoint into the buffer. |
static void Endpoint_Write_DWord_BE | ( | const uint32_t | DWord | ) | [inline, static] |
Writes four bytes to the currently selected endpoint's bank in big endian format, for IN direction endpoints.
static void Endpoint_Write_DWord_LE | ( | const uint32_t | DWord | ) | [inline, static] |
Writes four bytes to the currently selected endpoint's bank in little endian format, for IN direction endpoints.
uint8_t Endpoint_Write_Stream_BE | ( | const void * | Buffer, | |
uint16_t | Length, | |||
uint8_t(*)(void) | Callback | |||
) |
Writes the given number of bytes to the endpoint from the given buffer in big endian, sending full packets to the host as needed. The last packet filled is not automatically sent; the user is responsible for manually sending the last written packet to the host via the Endpoint_ClearCurrentBank() macro. Between each USB packet, the given stream callback function is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early aborts of stream transfers.
The callback routine should be created using the STREAM_CALLBACK() macro. If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled and this function has the Callback parameter ommitted.
Buffer | Pointer to the source data buffer to read from. | |
Length | Number of bytes to read for the currently selected endpoint into the buffer. | |
Callback | Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback |
uint8_t Endpoint_Write_Stream_LE | ( | const void * | Buffer, | |
uint16_t | Length, | |||
uint8_t(*)(void) | Callback | |||
) |
Writes the given number of bytes to the endpoint from the given buffer in little endian, sending full packets to the host as needed. The last packet filled is not automatically sent; the user is responsible for manually sending the last written packet to the host via the Endpoint_ClearCurrentBank() macro. Between each USB packet, the given stream callback function is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early aborts of stream transfers.
The callback routine should be created using the STREAM_CALLBACK() macro. If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled and this function has the Callback parameter ommitted.
Buffer | Pointer to the source data buffer to read from. | |
Length | Number of bytes to read for the currently selected endpoint into the buffer. | |
Callback | Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback |
static void Endpoint_Write_Word_BE | ( | const uint16_t | Word | ) | [inline, static] |
Writes two bytes to the currently selected endpoint's bank in big endian format, for IN direction endpoints.
static void Endpoint_Write_Word_LE | ( | const uint16_t | Word | ) | [inline, static] |
Writes two bytes to the currently selected endpoint's bank in little endian format, for IN direction endpoints.
uint8_t USB_ControlEndpointSize |
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.