*\r
* Functions, macros and enums related to pipe management when in USB Host mode. This\r
* module contains the pipe management macros, as well as pipe interrupt and data\r
- * send/recieve functions for various datatypes.\r
+ * send/recieve functions for various data types.\r
*/\r
\r
#ifndef __PIPE_H__\r
/** Returns true if the master pipe error flag is set for the currently selected pipe, indicating that\r
* some sort of hardware error has occurred on the pipe.\r
*\r
- * \see Pipe_GetErrorFlags() macro for information on retreiving the exact error flag.\r
+ * \see Pipe_GetErrorFlags() macro for information on retrieving the exact error flag.\r
*/\r
#define Pipe_IsError() ((UPINTX & (1 << PERRI)) ? true : false)\r
\r
* flag for the pipe. */\r
#define Pipe_ClearErrorFlags() MACROS{ UPERRX = 0; }MACROE\r
\r
- /** Returns a mask of the hardware error flags which have occured on the currently selected pipe. This\r
+ /** Returns a mask of the hardware error flags which have occurred on the currently selected pipe. This\r
* value can then be masked against the PIPE_ERRORFLAG_* masks to determine what error has occurred.\r
*/\r
#define Pipe_GetErrorFlags() UPERRX\r
\r
/** Returns true if the currently selected pipe may be read from (if data is waiting in the pipe\r
* bank and the pipe is an IN direction, or if the bank is not yet full if the pipe is an OUT\r
- * direction). This function will return false if an error has occured in the pipe, or if the pipe\r
+ * direction). This function will return false if an error has occurred in the pipe, or if the pipe\r
* is an IN direction and no packet has been received, or if the pipe is an OUT direction and the\r
* pipe bank is full.\r
*/\r
#define Pipe_ClearSetupOUT() MACROS{ UPINTX &= ~(1 << TXOUTI); UPINTX &= ~(1 << FIFOCON); }MACROE\r
\r
/** Returns true if the device sent a NAK (Negative Acknowledge) in response to the last sent packet on\r
- * the currently selected pipe. This ocurrs when the host sends a packet to the device, but the device\r
+ * the currently selected pipe. This occurs when the host sends a packet to the device, but the device\r
* is not currently ready to handle the packet (i.e. its endpoint banks are full). Once a NAK has been\r
- * received, it must be cleard using Pipe_ClearNAKReceived() before the previous (or any other) packet\r
+ * received, it must be cleared using Pipe_ClearNAKReceived() before the previous (or any other) packet\r
* can be re-sent.\r
*/\r
#define Pipe_IsNAKReceived() ((UPINTX & (1 << NAKEDI)) ? true : false)\r
*\r
* The callback routine should be created using the STREAM_CALLBACK() macro. If the token\r
* NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled\r
- * and this function has the Callback parameter ommitted.\r
+ * and this function has the Callback parameter omitted.\r
*\r
* \param Buffer Pointer to the source data buffer to read from.\r
* \param Length Number of bytes to read for the currently selected pipe into the buffer.\r
- * \param Callback Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback\r
+ * \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
*\r
* \return A value from the Pipe_Stream_RW_ErrorCodes_t enum.\r
*/\r
*\r
* The callback routine should be created using the STREAM_CALLBACK() macro. If the token\r
* NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled\r
- * and this function has the Callback parameter ommitted.\r
+ * and this function has the Callback parameter omitted.\r
*\r
* \param Buffer Pointer to the source data buffer to read from.\r
* \param Length Number of bytes to read for the currently selected pipe into the buffer.\r
- * \param Callback Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback\r
+ * \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
*\r
* \return A value from the Pipe_Stream_RW_ErrorCodes_t enum.\r
*/\r
*\r
* The callback routine should be created using the STREAM_CALLBACK() macro. If the token\r
* NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled\r
- * and this function has the Callback parameter ommitted.\r
+ * and this function has the Callback parameter omitted.\r
*\r
* \param Length Number of bytes to send via the currently selected pipe.\r
- * \param Callback Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback\r
+ * \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
*\r
* \return A value from the Pipe_Stream_RW_ErrorCodes_t enum.\r
*/\r
*\r
* The callback routine should be created using the STREAM_CALLBACK() macro. If the token\r
* NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled\r
- * and this function has the Callback parameter ommitted.\r
+ * and this function has the Callback parameter omitted.\r
*\r
* \param Buffer Pointer to the source data buffer to write to.\r
* \param Length Number of bytes to read for the currently selected pipe to read from.\r
- * \param Callback Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback\r
+ * \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
*\r
* \return A value from the Pipe_Stream_RW_ErrorCodes_t enum.\r
*/\r
*\r
* The callback routine should be created using the STREAM_CALLBACK() macro. If the token\r
* NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled\r
- * and this function has the Callback parameter ommitted.\r
+ * and this function has the Callback parameter omitted.\r
*\r
* \param Buffer Pointer to the source data buffer to write to.\r
* \param Length Number of bytes to read for the currently selected pipe to read from.\r
- * \param Callback Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback\r
+ * \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
*\r
* \return A value from the Pipe_Stream_RW_ErrorCodes_t enum.\r
*/\r
#define Pipe_Ignore_DWord() Pipe_Discard_DWord()\r
\r
/** Alias for Pipe_Read_Word_LE(). By default USB transfers use little endian format, thus\r
- * the command with no endianness specifier indicates little endian mode.\r
+ * the command with no endianness specified indicates little endian mode.\r
*/\r
#define Pipe_Read_Word() Pipe_Read_Word_LE()\r
\r
/** Alias for Pipe_Write_Word_LE(). By default USB transfers use little endian format, thus\r
- * the command with no endianness specifier indicates little endian mode.\r
+ * the command with no endianness specified indicates little endian mode.\r
*/\r
#define Pipe_Write_Word(Word) Pipe_Write_Word_LE(Word)\r
\r
/** Alias for Pipe_Read_DWord_LE(). By default USB transfers use little endian format, thus\r
- * the command with no endianness specifier indicates little endian mode.\r
+ * the command with no endianness specified indicates little endian mode.\r
*/\r
#define Pipe_Read_DWord() Pipe_Read_DWord_LE()\r
\r
/** Alias for Pipe_Write_DWord_LE(). By default USB transfers use little endian format, thus\r
- * the command with no endianness specifier indicates little endian mode.\r
+ * the command with no endianness specified indicates little endian mode.\r
*/\r
#define Pipe_Write_DWord(DWord) Pipe_Write_DWord_LE(DWord)\r
\r
/** Alias for Pipe_Read_Stream_LE(). By default USB transfers use little endian format, thus\r
- * the command with no endianness specifier indicates little endian mode.\r
+ * the command with no endianness specified indicates little endian mode.\r
*/\r
#if !defined(NO_STREAM_CALLBACKS)\r
#define Pipe_Read_Stream(Buffer, Length, Callback) Pipe_Read_Stream_LE(Buffer, Length, Callback)\r
#endif\r
\r
/** Alias for Pipe_Write_Stream_LE(). By default USB transfers use little endian format, thus\r
- * the command with no endianness specifier indicates little endian mode.\r
+ * the command with no endianness specified indicates little endian mode.\r
*/\r
#if !defined(NO_STREAM_CALLBACKS)\r
#define Pipe_Write_Stream(Buffer, Length, Callback) Pipe_Read_Stream_LE(Buffer, Length, Callback)\r
projects / pub / USBasp.git / blobdiff