X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/e611b250c170c9e830f8212ca5d49e505e3f4af1..6a5a37d7d141f109dc02d0bb6d8f4757b533408d:/LUFA/Drivers/USB/LowLevel/Pipe.h diff --git a/LUFA/Drivers/USB/LowLevel/Pipe.h b/LUFA/Drivers/USB/LowLevel/Pipe.h index 3b7783a5d..46a10e493 100644 --- a/LUFA/Drivers/USB/LowLevel/Pipe.h +++ b/LUFA/Drivers/USB/LowLevel/Pipe.h @@ -32,7 +32,7 @@ * * Functions, macros and enums related to pipe management when in USB Host mode. This * module contains the pipe management macros, as well as pipe interrupt and data - * send/recieve functions for various datatypes. + * send/recieve functions for various data types. */ #ifndef __PIPE_H__ @@ -46,8 +46,9 @@ #include "../HighLevel/USBTask.h" #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__) - #include "StreamCallbacks.h" + #include "../HighLevel/StreamCallbacks.h" #endif + /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { @@ -73,17 +74,17 @@ /** Token mask for Pipe_ConfigurePipe(). This sets the pipe as a SETUP token (for CONTROL type pipes), * which will trigger a control request on the attached device when data is written to the pipe. */ - #define PIPE_TOKEN_SETUP (0b00 << PTOKEN0) + #define PIPE_TOKEN_SETUP (0 << PTOKEN0) /** Token mask for Pipe_ConfigurePipe(). This sets the pipe as a IN token (for non-CONTROL type pipes), * indicating that the pipe data will flow from device to host. */ - #define PIPE_TOKEN_IN (0b01 << PTOKEN0) + #define PIPE_TOKEN_IN (1 << PTOKEN0) /** Token mask for Pipe_ConfigurePipe(). This sets the pipe as a IN token (for non-CONTROL type pipes), * indicating that the pipe data will flow from host to device. */ - #define PIPE_TOKEN_OUT (0b10 << PTOKEN0) + #define PIPE_TOKEN_OUT (2 << PTOKEN0) /** Mask for the bank mode selection for the Pipe_ConfigurePipe() macro. This indicates that the pipe * should have one single bank, which requires less USB FIFO memory but results in slower transfers as @@ -302,7 +303,7 @@ /** Returns true if the master pipe error flag is set for the currently selected pipe, indicating that * some sort of hardware error has occurred on the pipe. * - * \see Pipe_GetErrorFlags() macro for information on retreiving the exact error flag. + * \see Pipe_GetErrorFlags() macro for information on retrieving the exact error flag. */ #define Pipe_IsError() ((UPINTX & (1 << PERRI)) ? true : false) @@ -310,14 +311,14 @@ * flag for the pipe. */ #define Pipe_ClearErrorFlags() MACROS{ UPERRX = 0; }MACROE - /** Returns a mask of the hardware error flags which have occured on the currently selected pipe. This + /** Returns a mask of the hardware error flags which have occurred on the currently selected pipe. This * value can then be masked against the PIPE_ERRORFLAG_* masks to determine what error has occurred. */ #define Pipe_GetErrorFlags() UPERRX /** Returns true if the currently selected pipe may be read from (if data is waiting in the pipe * bank and the pipe is an IN direction, or if the bank is not yet full if the pipe is an OUT - * direction). This function will return false if an error has occured in the pipe, or if the pipe + * direction). This function will return false if an error has occurred in the pipe, or if the pipe * is an IN direction and no packet has been received, or if the pipe is an OUT direction and the * pipe bank is full. */ @@ -357,9 +358,9 @@ #define Pipe_ClearSetupOUT() MACROS{ UPINTX &= ~(1 << TXOUTI); UPINTX &= ~(1 << FIFOCON); }MACROE /** Returns true if the device sent a NAK (Negative Acknowledge) in response to the last sent packet on - * the currently selected pipe. This ocurrs when the host sends a packet to the device, but the device + * the currently selected pipe. This occurs when the host sends a packet to the device, but the device * is not currently ready to handle the packet (i.e. its endpoint banks are full). Once a NAK has been - * received, it must be cleard using Pipe_ClearNAKReceived() before the previous (or any other) packet + * received, it must be cleared using Pipe_ClearNAKReceived() before the previous (or any other) packet * can be re-sent. */ #define Pipe_IsNAKReceived() ((UPINTX & (1 << NAKEDI)) ? true : false) @@ -606,11 +607,11 @@ * * 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 ommitted. + * and this function has the Callback parameter omitted. * * \param Buffer Pointer to the source data buffer to read from. * \param Length Number of bytes to read for the currently selected pipe into the buffer. - * \param Callback Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback + * \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback * * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum. */ @@ -628,11 +629,11 @@ * * 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 ommitted. + * and this function has the Callback parameter omitted. * * \param Buffer Pointer to the source data buffer to read from. * \param Length Number of bytes to read for the currently selected pipe into the buffer. - * \param Callback Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback + * \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback * * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum. */ @@ -650,10 +651,10 @@ * * 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 ommitted. + * and this function has the Callback parameter omitted. * * \param Length Number of bytes to send via the currently selected pipe. - * \param Callback Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback + * \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback * * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum. */ @@ -671,11 +672,11 @@ * * 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 ommitted. + * and this function has the Callback parameter omitted. * * \param Buffer Pointer to the source data buffer to write to. * \param Length Number of bytes to read for the currently selected pipe to read from. - * \param Callback Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback + * \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback * * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum. */ @@ -693,11 +694,11 @@ * * 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 ommitted. + * and this function has the Callback parameter omitted. * * \param Buffer Pointer to the source data buffer to write to. * \param Length Number of bytes to read for the currently selected pipe to read from. - * \param Callback Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback + * \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback * * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum. */ @@ -721,27 +722,27 @@ #define Pipe_Ignore_DWord() Pipe_Discard_DWord() /** Alias for Pipe_Read_Word_LE(). By default USB transfers use little endian format, thus - * the command with no endianness specifier indicates little endian mode. + * the command with no endianness specified indicates little endian mode. */ #define Pipe_Read_Word() Pipe_Read_Word_LE() /** Alias for Pipe_Write_Word_LE(). By default USB transfers use little endian format, thus - * the command with no endianness specifier indicates little endian mode. + * the command with no endianness specified indicates little endian mode. */ #define Pipe_Write_Word(Word) Pipe_Write_Word_LE(Word) /** Alias for Pipe_Read_DWord_LE(). By default USB transfers use little endian format, thus - * the command with no endianness specifier indicates little endian mode. + * the command with no endianness specified indicates little endian mode. */ #define Pipe_Read_DWord() Pipe_Read_DWord_LE() /** Alias for Pipe_Write_DWord_LE(). By default USB transfers use little endian format, thus - * the command with no endianness specifier indicates little endian mode. + * the command with no endianness specified indicates little endian mode. */ #define Pipe_Write_DWord(DWord) Pipe_Write_DWord_LE(DWord) /** Alias for Pipe_Read_Stream_LE(). By default USB transfers use little endian format, thus - * the command with no endianness specifier indicates little endian mode. + * the command with no endianness specified indicates little endian mode. */ #if !defined(NO_STREAM_CALLBACKS) #define Pipe_Read_Stream(Buffer, Length, Callback) Pipe_Read_Stream_LE(Buffer, Length, Callback) @@ -750,7 +751,7 @@ #endif /** Alias for Pipe_Write_Stream_LE(). By default USB transfers use little endian format, thus - * the command with no endianness specifier indicates little endian mode. + * the command with no endianness specified indicates little endian mode. */ #if !defined(NO_STREAM_CALLBACKS) #define Pipe_Write_Stream(Buffer, Length, Callback) Pipe_Read_Stream_LE(Buffer, Length, Callback)