\r
/* Public Interface - May be used in end-application: */\r
/* Macros: */\r
+ /** Mask for \ref Pipe_GetErrorFlags(), indicating that an overflow error occurred in the pipe on the received data. */\r
+ #define PIPE_ERRORFLAG_OVERFLOW (1 << 6)\r
+\r
+ /** Mask for \ref Pipe_GetErrorFlags(), indicating that an underflow error occurred in the pipe on the received data. */\r
+ #define PIPE_ERRORFLAG_UNDERFLOW (1 << 5)\r
+\r
/** Mask for \ref Pipe_GetErrorFlags(), indicating that a CRC error occurred in the pipe on the received data. */\r
#define PIPE_ERRORFLAG_CRC16 (1 << 4)\r
\r
*\r
* \return The current pipe token, as a PIPE_TOKEN_* mask\r
*/\r
- static inline uint8_t Pipe_GetCurrentToken(void);\r
+ static inline uint8_t Pipe_GetPipeToken(void);\r
\r
/** Sets the token for the currently selected pipe to one of the tokens specified by the PIPE_TOKEN_*\r
* masks. This can be used on CONTROL type pipes, to allow for bidirectional transfer of data during\r
\r
#define Pipe_ClearErrorFlags() MACROS{ UPERRX = 0; }MACROE\r
\r
- #define Pipe_GetErrorFlags() UPERRX\r
+ #define Pipe_GetErrorFlags() ((UPERRX & (PIPE_ERRORFLAG_CRC16 | PIPE_ERRORFLAG_TIMEOUT | \\r
+ PIPE_ERRORFLAG_PID | PIPE_ERRORFLAG_DATAPID | \\r
+ PIPE_ERRORFLAG_DATATGL)) | \\r
+ (UPSTAX & PIPE_ERRORFLAG_OVERFLOW | PIPE_ERRORFLAG_UNDERFLOW))\r
\r
#define Pipe_IsReadWriteAllowed() ((UPINTX & (1 << RWAL)) ? true : false)\r
\r
/* Function Prototypes: */\r
/** Configures the specified pipe number with the given pipe type, token, target endpoint number in the\r
* attached device, bank size and banking mode. Pipes should be allocated in ascending order by their\r
- * address in the device (i.e. pipe 1 should be configured before pipe 2 and so on).\r
+ * address in the device (i.e. pipe 1 should be configured before pipe 2 and so on) to prevent fragmentation\r
+ * of the USB FIFO memory.\r
*\r
* The pipe type may be one of the EP_TYPE_* macros listed in LowLevel.h, the token may be one of the\r
* PIPE_TOKEN_* masks.\r
*\r
* The banking mode may be either \ref PIPE_BANK_SINGLE or \ref PIPE_BANK_DOUBLE.\r
*\r
- * A newly configured pipe is frozen by default, and must be unfrozen before use via the \ref Pipe_Unfreeze() macro.\r
+ * A newly configured pipe is frozen by default, and must be unfrozen before use via the \ref Pipe_Unfreeze()\r
+ * before being used. Pipes should be kept frozen unless waiting for data from a device while in IN mode, or\r
+ * sending data to the device in OUT mode. IN type pipes are also automatically configured to accept infinite\r
+ * numbers of IN requests without automatic freezing - this can be overridden by a call to\r
+ * \ref Pipe_SetFiniteINRequests().\r
+ *\r
+ * \note The default control pipe does not have to be manually configured, as it is automatically\r
+ * configured by the library internally.\r
*\r
* \note This routine will select the specified pipe, and the pipe will remain selected once the\r
* routine completes regardless of if the pipe configuration succeeds.\r
* \ref Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is\r
* executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.\r
*\r
- * The callback routine should be created using the \ref 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 omitted.\r
+ * The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
+ * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are\r
+ * disabled and this function has the Callback parameter omitted.\r
+ *\r
+ * The pipe token is set automatically, thus this can be used on bi-directional pipes directly without\r
+ * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().\r
*\r
* \ingroup Group_PipeRW\r
*\r
* \ref Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is\r
* executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.\r
*\r
- * The callback routine should be created using the \ref 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 omitted.\r
+ * The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
+ * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are\r
+ * disabled and this function has the Callback parameter omitted.\r
+ *\r
+ * The pipe token is set automatically, thus this can be used on bi-directional pipes directly without\r
+ * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().\r
*\r
* \ingroup Group_PipeRW\r
*\r
* Between each USB packet, the given stream callback function is executed repeatedly until the next packet is ready,\r
* allowing for early aborts of stream transfers.\r
*\r
- * The callback routine should be created using the \ref 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 omitted.\r
+ * The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
+ * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are\r
+ * disabled and this function has the Callback parameter omitted.\r
+ *\r
+ * The pipe token is set automatically, thus this can be used on bi-directional pipes directly without\r
+ * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().\r
*\r
* \ingroup Group_PipeRW\r
*\r
* \ref Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is\r
* executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.\r
*\r
- * The callback routine should be created using the \ref 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 omitted.\r
+ * The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
+ * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are\r
+ * disabled and this function has the Callback parameter omitted.\r
+ *\r
+ * The pipe token is set automatically, thus this can be used on bi-directional pipes directly without\r
+ * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().\r
*\r
* \ingroup Group_PipeRW\r
*\r
* \ref Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is\r
* executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.\r
*\r
- * The callback routine should be created using the \ref 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 omitted.\r
+ * The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
+ * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are\r
+ * disabled and this function has the Callback parameter omitted.\r
+ *\r
+ * The pipe token is set automatically, thus this can be used on bi-directional pipes directly without\r
+ * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().\r
*\r
* \ingroup Group_PipeRW\r
*\r
projects / pub / USBasp.git / blobdiff