Endpoint Data Reading and Writing
[Endpoint Management]


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_NoError = 0,
  ENDPOINT_RWSTREAM_EndpointStalled = 1,
  ENDPOINT_RWSTREAM_DeviceDisconnected = 1,
  ENDPOINT_RWSTREAM_Timeout = 2,
  ENDPOINT_RWSTREAM_CallbackAborted = 3
}
enum  Endpoint_ControlStream_RW_ErrorCodes_t {
  ENDPOINT_RWCSTREAM_NoError = 0,
  ENDPOINT_RWCSTREAM_HostAborted = 1
}

Functions

static uint16_t Endpoint_BytesInEndpoint (void)
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
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)

Detailed Description

Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.

Enumeration Type Documentation

Enum for the possible error return codes of the Endpoint_*_Control_Stream_* functions..

Enumerator:
ENDPOINT_RWCSTREAM_NoError  Command completed successfully, no error.
ENDPOINT_RWCSTREAM_HostAborted  The aborted the transfer prematurely.

Enum for the possible error return codes of the Endpoint_*_Stream_* functions.

Enumerator:
ENDPOINT_RWSTREAM_NoError  Command completed successfully, no error.
ENDPOINT_RWSTREAM_EndpointStalled  The endpoint was stalled during the stream transfer by the host or device.
ENDPOINT_RWSTREAM_DeviceDisconnected  Device was disconnected from the host during the transfer.
ENDPOINT_RWSTREAM_Timeout  The host failed to accept or send the next packet within the software timeout period set by the USB_STREAM_TIMEOUT_MS macro.
ENDPOINT_RWSTREAM_CallbackAborted  Indicates that the stream's callback function aborted the transfer early.

Enum for the possible error return codes of the Endpoint_WaitUntilReady() function.

Enumerator:
ENDPOINT_READYWAIT_NoError  Endpoint is ready for next packet, no error.
ENDPOINT_READYWAIT_EndpointStalled  The endpoint was stalled during the stream transfer by the host or device.
ENDPOINT_READYWAIT_DeviceDisconnected  Device was disconnected from the host while waiting for the endpoint to become ready.
ENDPOINT_READYWAIT_Timeout  The host failed to accept or send the next packet within the software timeout period set by the USB_STREAM_TIMEOUT_MS macro.


Function Documentation

static uint16_t Endpoint_BytesInEndpoint ( void   )  [inline, static]

Indicates the number of bytes currently stored in the current endpoint's selected bank.

Note:
The return width of this function may differ, depending on the maximum endpoint bank size of the selected AVR model.
Returns:
Total number of bytes in the currently selected Endpoint's FIFO buffer

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_ClearOUT() 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 omitted.

Note:
This routine should not be used on CONTROL type endpoints.
Parameters:
Length Number of bytes to send via the currently selected endpoint.
Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
Returns:
A value from the Endpoint_Stream_RW_ErrorCodes_t enum.

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.

Returns:
Next byte in the currently selected endpoint's FIFO buffer

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_ClearIN() macro.

Note:
This routine should only be used on CONTROL type endpoints.
Warning:
Unlike the standard stream read/write commands, the control stream commands cannot be chained together; i.e. the entire stream data must be read or written at the one time.
Parameters:
Buffer Pointer to the destination data buffer to write to.
Length Number of bytes to send via the currently selected endpoint.
Returns:
A value from the Endpoint_ControlStream_RW_ErrorCodes_t enum.

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_ClearIN() macro.

Note:
This routine should only be used on CONTROL type endpoints.
Warning:
Unlike the standard stream read/write commands, the control stream commands cannot be chained together; i.e. the entire stream data must be read or written at the one time.
Parameters:
Buffer Pointer to the destination data buffer to write to.
Length Number of bytes to send via the currently selected endpoint.
Returns:
A value from the Endpoint_ControlStream_RW_ErrorCodes_t enum.

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.

Returns:
Next double word in the currently selected endpoint's FIFO buffer

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.

Returns:
Next double word in the currently selected endpoint's FIFO buffer

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_ClearOUT() 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 omitted.

Note:
This routine should not be used on CONTROL type endpoints.
Parameters:
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 successive USB packet transfers, NULL if no callback
Returns:
A value from the Endpoint_Stream_RW_ErrorCodes_t enum.

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_ClearOUT() 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 omitted.

Note:
This routine should not be used on CONTROL type endpoints.
Parameters:
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 successive USB packet transfers, NULL if no callback
Returns:
A value from the Endpoint_Stream_RW_ErrorCodes_t enum.

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.

Returns:
Next word in the currently selected endpoint's FIFO buffer

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.

Returns:
Next word in the currently selected endpoint's FIFO buffer

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.

Note:
This routine should not be called on CONTROL type endpoints.
Returns:
A value from the Endpoint_WaitUntilReady_ErrorCodes_t enum.

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.

Parameters:
Byte Next byte to write into the the currently selected endpoint's FIFO buffer

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_ClearOUT() macro.

Note:
This routine should only be used on CONTROL type endpoints.
Warning:
Unlike the standard stream read/write commands, the control stream commands cannot be chained together; i.e. the entire stream data must be read or written at the one time.
Parameters:
Buffer Pointer to the source data buffer to read from.
Length Number of bytes to read for the currently selected endpoint into the buffer.
Returns:
A value from the Endpoint_ControlStream_RW_ErrorCodes_t enum.

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_ClearOUT() macro.

Note:
This routine should only be used on CONTROL type endpoints.
Warning:
Unlike the standard stream read/write commands, the control stream commands cannot be chained together; i.e. the entire stream data must be read or written at the one time.
Parameters:
Buffer Pointer to the source data buffer to read from.
Length Number of bytes to read for the currently selected endpoint into the buffer.
Returns:
A value from the Endpoint_ControlStream_RW_ErrorCodes_t enum.

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.

Parameters:
DWord Next double word to write to the currently selected endpoint's FIFO buffer

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.

Parameters:
DWord Next double word to write to the currently selected endpoint's FIFO buffer

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_ClearIN() 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 omitted.

Note:
This routine should not be used on CONTROL type endpoints.
Parameters:
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 successive USB packet transfers, NULL if no callback
Returns:
A value from the Endpoint_Stream_RW_ErrorCodes_t enum.

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_ClearIN() 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 omitted.

Note:
This routine should not be used on CONTROL type endpoints.
Parameters:
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 successive USB packet transfers, NULL if no callback
Returns:
A value from the Endpoint_Stream_RW_ErrorCodes_t enum.

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.

Parameters:
Word Next word to write to the currently selected endpoint's FIFO buffer

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.

Parameters:
Word Next word to write to the currently selected endpoint's FIFO buffer


Generated on Sun May 10 15:26:14 2009 for LUFA Library by  doxygen 1.5.7.1