Functions |
uint8_t | Pipe_Discard_Stream (uint16_t Length, StreamCallbackPtr_t Callback) |
uint8_t | Pipe_Write_Stream_LE (const void *Buffer, uint16_t Length, StreamCallbackPtr_t Callback) ATTR_NON_NULL_PTR_ARG(1) |
uint8_t | Pipe_Write_EStream_LE (const void *Buffer, uint16_t Length, StreamCallbackPtr_t Callback) ATTR_NON_NULL_PTR_ARG(1) |
uint8_t | Pipe_Write_PStream_LE (const void *Buffer, uint16_t Length, StreamCallbackPtr_t Callback) ATTR_NON_NULL_PTR_ARG(1) |
uint8_t | Pipe_Write_Stream_BE (const void *Buffer, uint16_t Length, StreamCallbackPtr_t Callback) ATTR_NON_NULL_PTR_ARG(1) |
uint8_t | Pipe_Write_EStream_BE (const void *Buffer, uint16_t Length, StreamCallbackPtr_t Callback) ATTR_NON_NULL_PTR_ARG(1) |
uint8_t | Pipe_Write_PStream_BE (const void *Buffer, uint16_t Length, StreamCallbackPtr_t Callback) ATTR_NON_NULL_PTR_ARG(1) |
uint8_t | Pipe_Read_Stream_LE (void *Buffer, uint16_t Length, StreamCallbackPtr_t Callback) ATTR_NON_NULL_PTR_ARG(1) |
uint8_t | Pipe_Read_EStream_LE (void *Buffer, uint16_t Length, StreamCallbackPtr_t Callback) ATTR_NON_NULL_PTR_ARG(1) |
uint8_t | Pipe_Read_Stream_BE (void *Buffer, uint16_t Length, StreamCallbackPtr_t Callback) ATTR_NON_NULL_PTR_ARG(1) |
uint8_t | Pipe_Read_EStream_BE (void *Buffer, uint16_t Length, StreamCallbackPtr_t Callback) 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 pipes.
Function Documentation
Reads and discards the given number of bytes from the pipe, 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 device via the Pipe_ClearIN() 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.
The pipe token is set automatically, thus this can be used on bi-directional pipes directly without having to explicitly change the data direction with a call to Pipe_SetPipeToken().
- Parameters:
-
[in] | Length | Number of bytes to send via the currently selected pipe. |
[in] | Callback | Name of a callback routine to call between successive USB packet transfers, NULL if no callback. |
- Returns:
- A value from the Pipe_Stream_RW_ErrorCodes_t enum.
EEPROM buffer source version of Pipe_Read_Stream_BE().
- Parameters:
-
[out] | Buffer | Pointer to the source data buffer to write to. |
[in] | Length | Number of bytes to read for the currently selected pipe to read from. |
[in] | Callback | Name of a callback routine to call between successive USB packet transfers, NULL if no callback. |
- Returns:
- A value from the Pipe_Stream_RW_ErrorCodes_t enum.
EEPROM buffer source version of Pipe_Read_Stream_LE().
- Parameters:
-
[out] | Buffer | Pointer to the source data buffer to write to. |
[in] | Length | Number of bytes to read for the currently selected pipe to read from. |
[in] | Callback | Name of a callback routine to call between successive USB packet transfers, NULL if no callback. |
- Returns:
- A value from the Pipe_Stream_RW_ErrorCodes_t enum.
Reads the given number of bytes from the pipe into the given buffer in big endian, sending full packets to the device 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 Pipe_ClearIN() 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.
The pipe token is set automatically, thus this can be used on bi-directional pipes directly without having to explicitly change the data direction with a call to Pipe_SetPipeToken().
- Parameters:
-
[out] | Buffer | Pointer to the source data buffer to write to. |
[in] | Length | Number of bytes to read for the currently selected pipe to read from. |
[in] | Callback | Name of a callback routine to call between successive USB packet transfers, NULL if no callback. |
- Returns:
- A value from the Pipe_Stream_RW_ErrorCodes_t enum.
Reads the given number of bytes from the pipe into the given buffer in little endian, sending full packets to the device 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 Pipe_ClearIN() 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.
The pipe token is set automatically, thus this can be used on bi-directional pipes directly without having to explicitly change the data direction with a call to Pipe_SetPipeToken().
- Parameters:
-
[out] | Buffer | Pointer to the source data buffer to write to. |
[in] | Length | Number of bytes to read for the currently selected pipe to read from. |
[in] | Callback | Name of a callback routine to call between successive USB packet transfers, NULL if no callback. |
- Returns:
- A value from the Pipe_Stream_RW_ErrorCodes_t enum.
uint8_t Pipe_Write_EStream_BE |
( |
const void * |
Buffer, |
|
|
uint16_t |
Length, |
|
|
StreamCallbackPtr_t |
Callback | |
|
) |
| | |
EEPROM buffer source version of Pipe_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 pipe 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 Pipe_Stream_RW_ErrorCodes_t enum.
uint8_t Pipe_Write_EStream_LE |
( |
const void * |
Buffer, |
|
|
uint16_t |
Length, |
|
|
StreamCallbackPtr_t |
Callback | |
|
) |
| | |
EEPROM buffer source version of Pipe_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 pipe 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 Pipe_Stream_RW_ErrorCodes_t enum.
uint8_t Pipe_Write_PStream_BE |
( |
const void * |
Buffer, |
|
|
uint16_t |
Length, |
|
|
StreamCallbackPtr_t |
Callback | |
|
) |
| | |
FLASH buffer source version of Pipe_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 pipe 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 Pipe_Stream_RW_ErrorCodes_t enum.
uint8_t Pipe_Write_PStream_LE |
( |
const void * |
Buffer, |
|
|
uint16_t |
Length, |
|
|
StreamCallbackPtr_t |
Callback | |
|
) |
| | |
FLASH buffer source version of Pipe_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 pipe 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 Pipe_Stream_RW_ErrorCodes_t enum.
uint8_t Pipe_Write_Stream_BE |
( |
const void * |
Buffer, |
|
|
uint16_t |
Length, |
|
|
StreamCallbackPtr_t |
Callback | |
|
) |
| | |
Writes the given number of bytes to the pipe from the given buffer in big endian, sending full packets to the device 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 Pipe_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.
The pipe token is set automatically, thus this can be used on bi-directional pipes directly without having to explicitly change the data direction with a call to Pipe_SetPipeToken().
- Parameters:
-
[in] | Buffer | Pointer to the source data buffer to read from. |
[in] | Length | Number of bytes to read for the currently selected pipe 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 Pipe_Stream_RW_ErrorCodes_t enum.
uint8_t Pipe_Write_Stream_LE |
( |
const void * |
Buffer, |
|
|
uint16_t |
Length, |
|
|
StreamCallbackPtr_t |
Callback | |
|
) |
| | |
Writes the given number of bytes to the pipe from the given buffer in little endian, sending full packets to the device 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 Pipe_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.
The pipe token is set automatically, thus this can be used on bi-directional pipes directly without having to explicitly change the data direction with a call to Pipe_SetPipeToken().
- Parameters:
-
[in] | Buffer | Pointer to the source data buffer to read from. |
[in] | Length | Number of bytes to read for the currently selected pipe 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 Pipe_Stream_RW_ErrorCodes_t enum.