LUFA Library 110528
PipeStream.h File Reference

Pipe data stream transmission and reception management. More...

#include "../../../Common/Common.h"
#include "USBMode.h"
#include "USBTask.h"

Enumerations

enum  Pipe_Stream_RW_ErrorCodes_t {
  PIPE_RWSTREAM_NoError = 0,
  PIPE_RWSTREAM_PipeStalled = 1,
  PIPE_RWSTREAM_DeviceDisconnected = 2,
  PIPE_RWSTREAM_Timeout = 3,
  PIPE_RWSTREAM_IncompleteTransfer = 4
}

Functions

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.

Note:
This file should not be included directly. It is automatically included as needed by the USB driver dispatch header located in LUFA/Drivers/USB/USB.h.