Enumerations | Functions

Read/Write of Multi-Byte Streams
[Endpoint ManagementEndpoint Data Reading and Writing]

Enumerations

enum  Endpoint_Stream_RW_ErrorCodes_t {
  ENDPOINT_RWSTREAM_NoError = 0,
  ENDPOINT_RWSTREAM_EndpointStalled = 1,
  ENDPOINT_RWSTREAM_DeviceDisconnected = 2,
  ENDPOINT_RWSTREAM_BusSuspended = 3,
  ENDPOINT_RWSTREAM_Timeout = 4,
  ENDPOINT_RWSTREAM_CallbackAborted = 5
}
enum  Endpoint_ControlStream_RW_ErrorCodes_t {
  ENDPOINT_RWCSTREAM_NoError = 0,
  ENDPOINT_RWCSTREAM_HostAborted = 1,
  ENDPOINT_RWCSTREAM_DeviceDisconnected = 2,
  ENDPOINT_RWCSTREAM_BusSuspended = 3
}

Functions

uint8_t Endpoint_Discard_Stream (uint16_t Length, StreamCallbackPtr_t Callback)
uint8_t Endpoint_Write_Stream_LE (const void *Buffer, uint16_t Length, StreamCallbackPtr_t Callback) ATTR_NON_NULL_PTR_ARG(1)
uint8_t Endpoint_Write_EStream_LE (const void *Buffer, uint16_t Length, StreamCallbackPtr_t Callback) ATTR_NON_NULL_PTR_ARG(1)
uint8_t Endpoint_Write_PStream_LE (const void *Buffer, uint16_t Length, StreamCallbackPtr_t Callback) ATTR_NON_NULL_PTR_ARG(1)
uint8_t Endpoint_Write_Stream_BE (const void *Buffer, uint16_t Length, StreamCallbackPtr_t Callback) ATTR_NON_NULL_PTR_ARG(1)
uint8_t Endpoint_Write_EStream_BE (const void *Buffer, uint16_t Length, StreamCallbackPtr_t Callback) ATTR_NON_NULL_PTR_ARG(1)
uint8_t Endpoint_Write_PStream_BE (const void *Buffer, uint16_t Length, StreamCallbackPtr_t Callback) ATTR_NON_NULL_PTR_ARG(1)
uint8_t Endpoint_Read_Stream_LE (void *Buffer, uint16_t Length, StreamCallbackPtr_t Callback) ATTR_NON_NULL_PTR_ARG(1)
uint8_t Endpoint_Read_EStream_LE (void *Buffer, uint16_t Length, StreamCallbackPtr_t Callback) ATTR_NON_NULL_PTR_ARG(1)
uint8_t Endpoint_Read_Stream_BE (void *Buffer, uint16_t Length, StreamCallbackPtr_t Callback) ATTR_NON_NULL_PTR_ARG(1)
uint8_t Endpoint_Read_EStream_BE (void *Buffer, uint16_t Length, StreamCallbackPtr_t Callback) 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_EStream_LE (const void *Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1)
uint8_t Endpoint_Write_Control_PStream_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_Write_Control_EStream_BE (const void *Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1)
uint8_t Endpoint_Write_Control_PStream_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_EStream_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)
uint8_t Endpoint_Read_Control_EStream_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 of data streams 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.

ENDPOINT_RWCSTREAM_DeviceDisconnected 

Device was disconnected from the host during the transfer.

ENDPOINT_RWCSTREAM_BusSuspended 

The USB bus has been suspended by the host and no USB endpoint traffic can occur until the bus has resumed.

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_BusSuspended 

The USB bus has been suspended by the host and no USB endpoint traffic can occur until the bus has resumed.

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.


Function Documentation

uint8_t Endpoint_Discard_Stream ( uint16_t  Length,
StreamCallbackPtr_t  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 according to the information in Endpoint and Pipe Stream Callbacks. 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:
[in] Length Number of bytes to send via the currently selected endpoint.
[in] 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_Control_EStream_BE ( void *  Buffer,
uint16_t  Length 
)

EEPROM buffer source version of Endpoint_Read_Control_Stream_BE().

Note:
This function automatically clears the control transfer's status stage. Do not manually attempt to clear the status stage when using this routine in a control transaction.

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:
[out] Buffer Pointer to the destination data buffer to write to.
[in] 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_EStream_LE ( void *  Buffer,
uint16_t  Length 
)

EEPROM buffer source version of Endpoint_Read_Control_Stream_LE().

Note:
This function automatically clears the control transfer's status stage. Do not manually attempt to clear the status stage when using this routine in a control transaction.

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:
[out] Buffer Pointer to the destination data buffer to write to.
[in] 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_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 function automatically clears the control transfer's status stage. Do not manually attempt to clear the status stage when using this routine in a control transaction.

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:
[out] Buffer Pointer to the destination data buffer to write to.
[in] 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 function automatically clears the control transfer's status stage. Do not manually attempt to clear the status stage when using this routine in a control transaction.

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:
[out] Buffer Pointer to the destination data buffer to write to.
[in] 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_EStream_BE ( void *  Buffer,
uint16_t  Length,
StreamCallbackPtr_t  Callback 
)

EEPROM buffer source version of Endpoint_Read_Stream_BE().

Parameters:
[out] Buffer Pointer to the destination data buffer to write to, located in EEPROM memory space.
[in] Length Number of bytes to send via the currently selected endpoint.
[in] 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_EStream_LE ( void *  Buffer,
uint16_t  Length,
StreamCallbackPtr_t  Callback 
)

EEPROM buffer source version of Endpoint_Read_Stream_LE().

Parameters:
[out] Buffer Pointer to the destination data buffer to write to, located in EEPROM memory space.
[in] Length Number of bytes to send via the currently selected endpoint.
[in] 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_BE ( void *  Buffer,
uint16_t  Length,
StreamCallbackPtr_t  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 according to the information in Endpoint and Pipe Stream Callbacks. 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:
[out] Buffer Pointer to the destination data buffer to write to.
[in] Length Number of bytes to send via the currently selected endpoint.
[in] 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,
StreamCallbackPtr_t  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 according to the information in Endpoint and Pipe Stream Callbacks. 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:
[out] Buffer Pointer to the destination data buffer to write to.
[in] Length Number of bytes to send via the currently selected endpoint.
[in] 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_Control_EStream_BE ( const void *  Buffer,
uint16_t  Length 
)

EEPROM buffer source version of Endpoint_Write_Control_Stream_BE().

Note:
This function automatically clears the control transfer's status stage. Do not manually attempt to clear the status stage when using this routine in a control transaction.

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:
[in] Buffer Pointer to the source data buffer to read from.
[in] 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_EStream_LE ( const void *  Buffer,
uint16_t  Length 
)

EEPROM buffer source version of Endpoint_Write_Control_Stream_LE.

Note:
This function automatically clears the control transfer's status stage. Do not manually attempt to clear the status stage when using this routine in a control transaction.

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:
[in] Buffer Pointer to the source data buffer to read from.
[in] 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_PStream_BE ( const void *  Buffer,
uint16_t  Length 
)

FLASH buffer source version of Endpoint_Write_Control_Stream_BE().

Precondition:
The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
Note:
This function automatically clears the control transfer's status stage. Do not manually attempt to clear the status stage when using this routine in a control transaction.

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:
[in] Buffer Pointer to the source data buffer to read from.
[in] 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_PStream_LE ( const void *  Buffer,
uint16_t  Length 
)

FLASH buffer source version of Endpoint_Write_Control_Stream_LE().

Precondition:
The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
Note:
This function automatically clears the control transfer's status stage. Do not manually attempt to clear the status stage when using this routine in a control transaction.

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:
[in] Buffer Pointer to the source data buffer to read from.
[in] 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_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 function automatically clears the control transfer's status stage. Do not manually attempt to clear the status stage when using this routine in a control transaction.

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:
[in] Buffer Pointer to the source data buffer to read from.
[in] 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 function automatically clears the control transfer's status stage. Do not manually attempt to clear the status stage when using this routine in a control transaction.

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:
[in] Buffer Pointer to the source data buffer to read from.
[in] 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_EStream_BE ( const void *  Buffer,
uint16_t  Length,
StreamCallbackPtr_t  Callback 
)

EEPROM buffer source version of Endpoint_Write_Stream_BE().

Parameters:
[in] Buffer Pointer to the source data buffer to read from.
[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
[in] 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_EStream_LE ( const void *  Buffer,
uint16_t  Length,
StreamCallbackPtr_t  Callback 
)

EEPROM buffer source version of Endpoint_Write_Stream_LE().

Parameters:
[in] Buffer Pointer to the source data buffer to read from.
[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
[in] 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_PStream_BE ( const void *  Buffer,
uint16_t  Length,
StreamCallbackPtr_t  Callback 
)

FLASH buffer source version of Endpoint_Write_Stream_BE().

Precondition:
The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
Parameters:
[in] Buffer Pointer to the source data buffer to read from.
[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
[in] 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_PStream_LE ( const void *  Buffer,
uint16_t  Length,
StreamCallbackPtr_t  Callback 
)

FLASH buffer source version of Endpoint_Write_Stream_LE().

Precondition:
The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
Parameters:
[in] Buffer Pointer to the source data buffer to read from.
[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
[in] 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_BE ( const void *  Buffer,
uint16_t  Length,
StreamCallbackPtr_t  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 according to the information in Endpoint and Pipe Stream Callbacks. 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:
[in] Buffer Pointer to the source data buffer to read from.
[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
[in] 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,
StreamCallbackPtr_t  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 according to the information in Endpoint and Pipe Stream Callbacks. 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:
[in] Buffer Pointer to the source data buffer to read from.
[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
[in] 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.