Pipe Data Reading and Writing
[Pipe Management]


Enumerations

enum  Pipe_WaitUntilReady_ErrorCodes_t {
  PIPE_READYWAIT_NoError = 0,
  PIPE_READYWAIT_PipeStalled = 1,
  PIPE_READYWAIT_DeviceDisconnected = 2,
  PIPE_READYWAIT_Timeout = 3
}
enum  Pipe_Stream_RW_ErrorCodes_t {
  PIPE_RWSTREAM_NoError = 0,
  PIPE_RWSTREAM_PipeStalled = 1,
  PIPE_RWSTREAM_DeviceDisconnected = 2,
  PIPE_RWSTREAM_Timeout = 3,
  PIPE_RWSTREAM_CallbackAborted = 4
}

Functions

static uint16_t Pipe_BytesInPipe (void)
static uint8_t Pipe_Read_Byte (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE
static void Pipe_Write_Byte (const uint8_t Byte) ATTR_ALWAYS_INLINE
static void Pipe_Discard_Byte (void) ATTR_ALWAYS_INLINE
static uint16_t Pipe_Read_Word_LE (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE
static uint16_t Pipe_Read_Word_BE (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE
static void Pipe_Write_Word_LE (const uint16_t Word) ATTR_ALWAYS_INLINE
static void Pipe_Write_Word_BE (const uint16_t Word) ATTR_ALWAYS_INLINE
static void Pipe_Discard_Word (void) ATTR_ALWAYS_INLINE
static uint32_t Pipe_Read_DWord_LE (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE
static uint32_t Pipe_Read_DWord_BE (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE
static void Pipe_Write_DWord_LE (const uint32_t DWord) ATTR_ALWAYS_INLINE
static void Pipe_Write_DWord_BE (const uint32_t DWord) ATTR_ALWAYS_INLINE
static void Pipe_Discard_DWord (void) ATTR_ALWAYS_INLINE
uint8_t Pipe_WaitUntilReady (void)
uint8_t Pipe_Write_Stream_LE (const void *Buffer, uint16_t Length, uint8_t(*const Callback)(void)) ATTR_NON_NULL_PTR_ARG(1)
uint8_t Pipe_Write_Stream_BE (const void *Buffer, uint16_t Length, uint8_t(*const Callback)(void)) ATTR_NON_NULL_PTR_ARG(1)
uint8_t Pipe_Discard_Stream (uint16_t Length, uint8_t(*const Callback)(void))
uint8_t Pipe_Read_Stream_LE (void *Buffer, uint16_t Length, uint8_t(*const Callback)(void)) ATTR_NON_NULL_PTR_ARG(1)
uint8_t Pipe_Read_Stream_BE (void *Buffer, uint16_t Length, uint8_t(*const Callback)(void)) ATTR_NON_NULL_PTR_ARG(1)

Detailed Description

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

Enumeration Type Documentation

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

Enumerator:
PIPE_RWSTREAM_NoError  Command completed successfully, no error.
PIPE_RWSTREAM_PipeStalled  The device stalled the pipe during the transfer.
PIPE_RWSTREAM_DeviceDisconnected  Device was disconnected from the host during the transfer.
PIPE_RWSTREAM_Timeout  The device failed to accept or send the next packet within the software timeout period set by the USB_STREAM_TIMEOUT_MS macro.
PIPE_RWSTREAM_CallbackAborted  Indicates that the stream's callback function aborted the transfer early.

Enum for the possible error return codes of the Pipe_WaitUntilReady function

Enumerator:
PIPE_READYWAIT_NoError  Pipe ready for next packet, no error
PIPE_READYWAIT_PipeStalled  The device stalled the pipe while waiting.
PIPE_READYWAIT_DeviceDisconnected  Device was disconnected from the host while waiting.
PIPE_READYWAIT_Timeout  The device 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 Pipe_BytesInPipe ( void   )  [inline, static]

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

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

static void Pipe_Discard_Byte ( void   )  [inline, static]

Discards one byte from the currently selected pipe's bank, for OUT direction pipes.

static void Pipe_Discard_DWord ( void   )  [inline, static]

Discards four bytes from the currently selected pipe's bank, for OUT direction pipes.

uint8_t Pipe_Discard_Stream ( uint16_t  Length,
uint8_t(*)(void)  Callback 
)

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 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.

Parameters:
Length Number of bytes to send via the currently selected pipe.
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.

static void Pipe_Discard_Word ( void   )  [inline, static]

Discards two bytes from the currently selected pipe's bank, for OUT direction pipes.

static uint8_t Pipe_Read_Byte ( void   )  [inline, static]

Reads one byte from the currently selected pipe's bank, for OUT direction pipes.

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

static uint32_t Pipe_Read_DWord_BE ( void   )  [inline, static]

Reads four bytes from the currently selected pipe's bank in big endian format, for OUT direction pipes.

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

static uint32_t Pipe_Read_DWord_LE ( void   )  [inline, static]

Reads four bytes from the currently selected pipe's bank in little endian format, for OUT direction pipes.

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

uint8_t Pipe_Read_Stream_BE ( void *  Buffer,
uint16_t  Length,
uint8_t(*)(void)  Callback 
)

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 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.

Parameters:
Buffer Pointer to the source data buffer to write to.
Length Number of bytes to read for the currently selected pipe to read from.
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_Read_Stream_LE ( void *  Buffer,
uint16_t  Length,
uint8_t(*)(void)  Callback 
)

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 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.

Parameters:
Buffer Pointer to the source data buffer to write to.
Length Number of bytes to read for the currently selected pipe to read from.
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.

static uint16_t Pipe_Read_Word_BE ( void   )  [inline, static]

Reads two bytes from the currently selected pipe's bank in big endian format, for OUT direction pipes.

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

static uint16_t Pipe_Read_Word_LE ( void   )  [inline, static]

Reads two bytes from the currently selected pipe's bank in little endian format, for OUT direction pipes.

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

uint8_t Pipe_WaitUntilReady ( void   ) 

Spinloops until the currently selected non-control pipe is ready for the next packed of data to be read or written to it.

Returns:
A value from the Pipe_WaitUntilReady_ErrorCodes_t enum.

static void Pipe_Write_Byte ( const uint8_t  Byte  )  [inline, static]

Writes one byte from the currently selected pipe's bank, for IN direction pipes.

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

static void Pipe_Write_DWord_BE ( const uint32_t  DWord  )  [inline, static]

Writes four bytes to the currently selected pipe's bank in big endian format, for IN direction pipes.

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

static void Pipe_Write_DWord_LE ( const uint32_t  DWord  )  [inline, static]

Writes four bytes to the currently selected pipe's bank in little endian format, for IN direction pipes.

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

uint8_t Pipe_Write_Stream_BE ( const void *  Buffer,
uint16_t  Length,
uint8_t(*)(void)  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 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.

Parameters:
Buffer Pointer to the source data buffer to read from.
Length Number of bytes to read for the currently selected pipe 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 Pipe_Stream_RW_ErrorCodes_t enum.

uint8_t Pipe_Write_Stream_LE ( const void *  Buffer,
uint16_t  Length,
uint8_t(*)(void)  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 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.

Parameters:
Buffer Pointer to the source data buffer to read from.
Length Number of bytes to read for the currently selected pipe 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 Pipe_Stream_RW_ErrorCodes_t enum.

static void Pipe_Write_Word_BE ( const uint16_t  Word  )  [inline, static]

Writes two bytes to the currently selected pipe's bank in big endian format, for IN direction pipes.

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

static void Pipe_Write_Word_LE ( const uint16_t  Word  )  [inline, static]

Writes two bytes to the currently selected pipe's bank in little endian format, for IN direction pipes.

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


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