Pipe data stream transmission and reception management for the Atmel AVR8 architecture. More...

Stream functions for null data
uint8_t	Pipe_Discard_Stream (uint16_t Length, uint16_t *const BytesProcessed)
uint8_t	Pipe_Null_Stream (uint16_t Length, uint16_t *const BytesProcessed)
Stream functions for RAM source/destination data
uint8_t	Pipe_Write_Stream_LE (const void const Buffer, uint16_t Length, uint16_t const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1)
uint8_t	Pipe_Write_Stream_BE (const void const Buffer, uint16_t Length, uint16_t const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1)
uint8_t	Pipe_Read_Stream_LE (void const Buffer, uint16_t Length, uint16_t const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1)
uint8_t	Pipe_Read_Stream_BE (void const Buffer, uint16_t Length, uint16_t const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1)
Stream functions for EEPROM source/destination data
uint8_t	Pipe_Write_EStream_LE (const void const Buffer, uint16_t Length, uint16_t const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1)
uint8_t	Pipe_Write_EStream_BE (const void const Buffer, uint16_t Length, uint16_t const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1)
uint8_t	Pipe_Read_EStream_LE (void const Buffer, uint16_t Length, uint16_t const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1)
uint8_t	Pipe_Read_EStream_BE (void const Buffer, uint16_t Length, uint16_t const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1)
Stream functions for PROGMEM source/destination data
uint8_t	Pipe_Write_PStream_LE (const void const Buffer, uint16_t Length, uint16_t const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1)
uint8_t	Pipe_Write_PStream_BE (const void const Buffer, uint16_t Length, uint16_t const BytesProcessed) 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

uint8_t Pipe_Discard_Stream	(	uint16_t	Length,
		uint16_t *const	BytesProcessed
	)

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.

If the BytesProcessed parameter is NULL, the entire stream transfer is attempted at once, failing or succeeding as a single unit. If the BytesProcessed parameter points to a valid storage location, the transfer will instead be performed as a series of chunks. Each time the pipe bank becomes empty while there is still data to process (and after the current packet has been acknowledged) the BytesProcessed location will be updated with the total number of bytes processed in the stream, and the function will exit with an error code of PIPE_RWSTREAM_IncompleteTransfer. This allows for any abort checking to be performed in the user code - to continue the transfer, call the function again with identical parameters and it will resume until the BytesProcessed value reaches the total transfer length.

Single Stream Transfer Example:

  uint8_t ErrorCode;

  if ((ErrorCode = Pipe_Discard_Stream(512, NULL)) != PIPE_RWSTREAM_NoError)
  {
       // Stream failed to complete - check ErrorCode here
  }

Partial Stream Transfers Example:

  uint8_t  ErrorCode;
  uint16_t BytesProcessed;

  BytesProcessed = 0;
  while ((ErrorCode = Pipe_Discard_Stream(512, &BytesProcessed)) == PIPE_RWSTREAM_IncompleteTransfer)
  {
      // Stream not yet complete - do other actions here, abort if required
  }

  if (ErrorCode != PIPE_RWSTREAM_NoError)
  {
      // Stream failed to complete - check ErrorCode here
  }

Note:: 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 discard via the currently selected pipe.
[in]	BytesProcessed	Pointer to a location where the total number of bytes already processed should updated, `NULL` if the entire stream should be processed at once.

Returns:: A value from the Pipe_Stream_RW_ErrorCodes_t enum.

uint8_t Pipe_Null_Stream	(	uint16_t	Length,
		uint16_t *const	BytesProcessed
	)

Writes a given number of zeroed bytes to the pipe, sending full pipe packets from the host to the device as needed. The last packet is not automatically sent once the remaining bytes has been written; the user is responsible for manually discarding the last packet from the device via the Pipe_ClearOUT() macro.

If the BytesProcessed parameter is NULL, the entire stream transfer is attempted at once, failing or succeeding as a single unit. If the BytesProcessed parameter points to a valid storage location, the transfer will instead be performed as a series of chunks. Each time the pipe bank becomes full while there is still data to process (and after the current packet transmission has been initiated) the BytesProcessed location will be updated with the total number of bytes processed in the stream, and the function will exit with an error code of PIPE_RWSTREAM_IncompleteTransfer. This allows for any abort checking to be performed in the user code - to continue the transfer, call the function again with identical parameters and it will resume until the BytesProcessed value reaches the total transfer length.

Single Stream Transfer Example:

  uint8_t ErrorCode;

  if ((ErrorCode = Pipe_Null_Stream(512, NULL)) != PIPE_RWSTREAM_NoError)
  {
       // Stream failed to complete - check ErrorCode here
  }

Partial Stream Transfers Example:

  uint8_t  ErrorCode;
  uint16_t BytesProcessed;

  BytesProcessed = 0;
  while ((ErrorCode = Pipe_Null_Stream(512, &BytesProcessed)) == PIPE_RWSTREAM_IncompleteTransfer)
  {
      // Stream not yet complete - do other actions here, abort if required
  }

  if (ErrorCode != PIPE_RWSTREAM_NoError)
  {
      // Stream failed to complete - check ErrorCode here
  }

Note:: 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 zero bytes to write via the currently selected pipe.
[in]	BytesProcessed	Pointer to a location where the total number of bytes already processed should updated, `NULL` if the entire stream should be processed at once.

Returns:: A value from the Pipe_Stream_RW_ErrorCodes_t enum.

uint8_t Pipe_Read_EStream_BE	(	void *const	Buffer,
		uint16_t	Length,
		uint16_t *const	BytesProcessed
	)

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]	BytesProcessed	Pointer to a location where the total number of bytes already processed should updated, `NULL` if the entire stream should be read at once.

Returns:: A value from the Pipe_Stream_RW_ErrorCodes_t enum.

uint8_t Pipe_Read_EStream_LE	(	void *const	Buffer,
		uint16_t	Length,
		uint16_t *const	BytesProcessed
	)

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]	BytesProcessed	Pointer to a location where the total number of bytes already processed should updated, `NULL` if the entire stream should be read at once.

Returns:: A value from the Pipe_Stream_RW_ErrorCodes_t enum.

uint8_t Pipe_Read_Stream_BE	(	void *const	Buffer,
		uint16_t	Length,
		uint16_t *const	BytesProcessed
	)

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.

Note:: 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]	BytesProcessed	Pointer to a location where the total number of bytes already processed should updated, `NULL` if the entire stream should be read at once.

Returns:: A value from the Pipe_Stream_RW_ErrorCodes_t enum.

uint8_t Pipe_Read_Stream_LE	(	void *const	Buffer,
		uint16_t	Length,
		uint16_t *const	BytesProcessed
	)

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.

If the BytesProcessed parameter is NULL, the entire stream transfer is attempted at once, failing or succeeding as a single unit. If the BytesProcessed parameter points to a valid storage location, the transfer will instead be performed as a series of chunks. Each time the pipe bank becomes empty while there is still data to process (and after the current packet has been acknowledged) the BytesProcessed location will be updated with the total number of bytes processed in the stream, and the function will exit with an error code of PIPE_RWSTREAM_IncompleteTransfer. This allows for any abort checking to be performed in the user code - to continue the transfer, call the function again with identical parameters and it will resume until the BytesProcessed value reaches the total transfer length.

Single Stream Transfer Example:

  uint8_t DataStream[512];
  uint8_t ErrorCode;

  if ((ErrorCode = Pipe_Read_Stream_LE(DataStream, sizeof(DataStream),
                                       NULL)) != PIPE_RWSTREAM_NoError)
  {
       // Stream failed to complete - check ErrorCode here
  }

Partial Stream Transfers Example:

  uint8_t  DataStream[512];
  uint8_t  ErrorCode;
  uint16_t BytesProcessed;

  BytesProcessed = 0;
  while ((ErrorCode = Pipe_Read_Stream_LE(DataStream, sizeof(DataStream),
                                          &BytesProcessed)) == PIPE_RWSTREAM_IncompleteTransfer)
  {
      // Stream not yet complete - do other actions here, abort if required
  }

  if (ErrorCode != PIPE_RWSTREAM_NoError)
  {
      // Stream failed to complete - check ErrorCode here
  }

Note:: 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]	BytesProcessed	Pointer to a location where the total number of bytes already processed should updated, `NULL` if the entire stream should be read at once.

Returns:: A value from the Pipe_Stream_RW_ErrorCodes_t enum.

uint8_t Pipe_Write_EStream_BE	(	const void *const	Buffer,
		uint16_t	Length,
		uint16_t *const	BytesProcessed
	)

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]	BytesProcessed	Pointer to a location where the total number of bytes already processed should updated, `NULL` if the entire stream should be written at once.

Returns:: A value from the Pipe_Stream_RW_ErrorCodes_t enum.

uint8_t Pipe_Write_EStream_LE	(	const void *const	Buffer,
		uint16_t	Length,
		uint16_t *const	BytesProcessed
	)

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]	BytesProcessed	Pointer to a location where the total number of bytes already processed should updated, `NULL` if the entire stream should be written at once.

Returns:: A value from the Pipe_Stream_RW_ErrorCodes_t enum.

uint8_t Pipe_Write_PStream_BE	(	const void *const	Buffer,
		uint16_t	Length,
		uint16_t *const	BytesProcessed
	)

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]	BytesProcessed	Pointer to a location where the total number of bytes already processed should updated, `NULL` if the entire stream should be written at once.

Returns:: A value from the Pipe_Stream_RW_ErrorCodes_t enum.

uint8_t Pipe_Write_PStream_LE	(	const void *const	Buffer,
		uint16_t	Length,
		uint16_t *const	BytesProcessed
	)

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]	BytesProcessed	Pointer to a location where the total number of bytes already processed should updated, `NULL` if the entire stream should be written at once.

Returns:: A value from the Pipe_Stream_RW_ErrorCodes_t enum.

uint8_t Pipe_Write_Stream_BE	(	const void *const	Buffer,
		uint16_t	Length,
		uint16_t *const	BytesProcessed
	)

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.

Note:: 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]	BytesProcessed	Pointer to a location where the total number of bytes already processed should updated, `NULL` if the entire stream should be written at once.

Returns:: A value from the Pipe_Stream_RW_ErrorCodes_t enum.

uint8_t Pipe_Write_Stream_LE	(	const void *const	Buffer,
		uint16_t	Length,
		uint16_t *const	BytesProcessed
	)

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.

If the BytesProcessed parameter is NULL, the entire stream transfer is attempted at once, failing or succeeding as a single unit. If the BytesProcessed parameter points to a valid storage location, the transfer will instead be performed as a series of chunks. Each time the pipe bank becomes full while there is still data to process (and after the current packet transmission has been initiated) the BytesProcessed location will be updated with the total number of bytes processed in the stream, and the function will exit with an error code of PIPE_RWSTREAM_IncompleteTransfer. This allows for any abort checking to be performed in the user code - to continue the transfer, call the function again with identical parameters and it will resume until the BytesProcessed value reaches the total transfer length.

Single Stream Transfer Example:

  uint8_t DataStream[512];
  uint8_t ErrorCode;

  if ((ErrorCode = Pipe_Write_Stream_LE(DataStream, sizeof(DataStream),
                                        NULL)) != PIPE_RWSTREAM_NoError)
  {
       // Stream failed to complete - check ErrorCode here
  }

Partial Stream Transfers Example:

  uint8_t  DataStream[512];
  uint8_t  ErrorCode;
  uint16_t BytesProcessed;

  BytesProcessed = 0;
  while ((ErrorCode = Pipe_Write_Stream_LE(DataStream, sizeof(DataStream),
                                           &BytesProcessed)) == PIPE_RWSTREAM_IncompleteTransfer)
  {
      // Stream not yet complete - do other actions here, abort if required
  }

  if (ErrorCode != PIPE_RWSTREAM_NoError)
  {
      // Stream failed to complete - check ErrorCode here
  }

Note:: 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]	BytesProcessed	Pointer to a location where the total number of bytes already processed should updated, `NULL` if the entire stream should be written at once.

Returns:: A value from the Pipe_Stream_RW_ErrorCodes_t enum.

Stream functions for null data

Stream functions for RAM source/destination data

Stream functions for EEPROM source/destination data

Stream functions for PROGMEM source/destination data

Detailed Description

Function Documentation