/*\r
LUFA Library\r
- Copyright (C) Dean Camera, 2009.\r
+ Copyright (C) Dean Camera, 2010.\r
\r
dean [at] fourwalledcubicle [dot] com\r
www.fourwalledcubicle.com\r
*/\r
\r
/*\r
- Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, and distribute this software\r
- and its documentation for any purpose and without fee is hereby\r
- granted, provided that the above copyright notice appear in all\r
- copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting\r
- documentation, and that the name of the author not be used in\r
- advertising or publicity pertaining to distribution of the\r
+ Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+ Permission to use, copy, modify, distribute, and sell this \r
+ software and its documentation for any purpose is hereby granted\r
+ without fee, provided that the above copyright notice appear in \r
+ all copies and that both that the copyright notice and this\r
+ permission notice and warranty disclaimer appear in supporting \r
+ documentation, and that the name of the author not be used in \r
+ advertising or publicity pertaining to distribution of the \r
software without specific, written prior permission.\r
\r
The author disclaim all warranties with regard to this\r
arising out of or in connection with the use or performance of\r
this software.\r
*/\r
-\r
-/** \file\r
- *\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 data types.\r
- */\r
\r
/** \ingroup Group_USB\r
* @defgroup Group_PipeManagement Pipe Management\r
*\r
- * Functions, macros, variables, enums and types related to the setup and management of pipes while in USB Device mode.\r
+ * This module contains 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 send/receive functions\r
+ * for various data types.\r
*\r
* @{\r
*/\r
* Functions, macros, variables, enums and types related to data reading and writing from and to pipes.\r
*/\r
\r
+/** \ingroup Group_PipeRW \r
+ * @defgroup Group_PipePrimitiveRW Read/Write of Primitive Data Types\r
+ *\r
+ * Functions, macros, variables, enums and types related to data reading and writing of primitive data types\r
+ * from and to pipes.\r
+ */ \r
+\r
+/** \ingroup Group_PipeRW \r
+ * @defgroup Group_PipeStreamRW Read/Write of Multi-Byte Streams\r
+ *\r
+ * Functions, macros, variables, enums and types related to data reading and writing of data streams from\r
+ * and to pipes.\r
+ */ \r
+ \r
/** @defgroup Group_PipePacketManagement Pipe Packet Management\r
*\r
* Functions, macros, variables, enums and types related to packet management of pipes.\r
\r
/** @defgroup Group_PipeControlReq Pipe Control Request Management\r
*\r
- * Functions, macros, variables, enums and types related to control request management of pipes.\r
- */\r
+ * Module for host mode request processing. This module allows for the transmission of standard, class and\r
+ * vendor control requests to the default control endpoint of an attached device while in host mode.\r
+ *\r
+ * \see Chapter 9 of the USB 2.0 specification.\r
+ */ \r
\r
#ifndef __PIPE_H__\r
#define __PIPE_H__\r
\r
/* Includes: */\r
#include <avr/io.h>\r
+ #include <avr/pgmspace.h>\r
+ #include <avr/eeprom.h>\r
#include <stdbool.h>\r
\r
#include "../../../Common/Common.h"\r
extern "C" {\r
#endif\r
\r
+ /* Preprocessor Checks: */\r
+ #if !defined(__INCLUDE_FROM_USB_DRIVER)\r
+ #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.\r
+ #endif\r
+ \r
/* Public Interface - May be used in end-application: */\r
/* Macros: */\r
- /** Mask for Pipe_GetErrorFlags(), indicating that a CRC error occurred in the pipe on the received data. */\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
- /** Mask for Pipe_GetErrorFlags(), indicating that a hardware timeout error occurred in the pipe. */\r
+ /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware timeout error occurred in the pipe. */\r
#define PIPE_ERRORFLAG_TIMEOUT (1 << 3)\r
\r
- /** Mask for Pipe_GetErrorFlags(), indicating that a hardware PID error occurred in the pipe. */\r
+ /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware PID error occurred in the pipe. */\r
#define PIPE_ERRORFLAG_PID (1 << 2)\r
\r
- /** Mask for Pipe_GetErrorFlags(), indicating that a hardware data PID error occurred in the pipe. */\r
+ /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware data PID error occurred in the pipe. */\r
#define PIPE_ERRORFLAG_DATAPID (1 << 1)\r
\r
- /** Mask for Pipe_GetErrorFlags(), indicating that a hardware data toggle error occurred in the pipe. */\r
+ /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware data toggle error occurred in the pipe. */\r
#define PIPE_ERRORFLAG_DATATGL (1 << 0)\r
\r
- /** Token mask for Pipe_ConfigurePipe(). This sets the pipe as a SETUP token (for CONTROL type pipes),\r
+ /** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a SETUP token (for CONTROL type pipes),\r
* which will trigger a control request on the attached device when data is written to the pipe.\r
*/\r
#define PIPE_TOKEN_SETUP (0 << PTOKEN0)\r
\r
- /** Token mask for Pipe_ConfigurePipe(). This sets the pipe as a IN token (for non-CONTROL type pipes),\r
+ /** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a IN token (for non-CONTROL type pipes),\r
* indicating that the pipe data will flow from device to host.\r
*/\r
#define PIPE_TOKEN_IN (1 << PTOKEN0)\r
\r
- /** Token mask for Pipe_ConfigurePipe(). This sets the pipe as a IN token (for non-CONTROL type pipes),\r
+ /** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a OUT token (for non-CONTROL type pipes),\r
* indicating that the pipe data will flow from host to device.\r
*/\r
#define PIPE_TOKEN_OUT (2 << PTOKEN0)\r
\r
- /** Mask for the bank mode selection for the Pipe_ConfigurePipe() macro. This indicates that the pipe\r
+ /** Mask for the bank mode selection for the \ref Pipe_ConfigurePipe() macro. This indicates that the pipe\r
* should have one single bank, which requires less USB FIFO memory but results in slower transfers as\r
* only one USB device (the AVR or the attached device) can access the pipe's bank at the one time.\r
*/\r
#define PIPE_BANK_SINGLE (0 << EPBK0)\r
\r
- /** Mask for the bank mode selection for the Pipe_ConfigurePipe() macro. This indicates that the pipe\r
+ /** Mask for the bank mode selection for the \ref Pipe_ConfigurePipe() macro. This indicates that the pipe\r
* should have two banks, which requires more USB FIFO memory but results in faster transfers as one\r
* USB device (the AVR or the attached device) can access one bank while the other accesses the second\r
* bank.\r
/** Default size of the default control pipe's bank, until altered by the Endpoint0Size value \r
* in the device descriptor of the attached device.\r
*/\r
- #define PIPE_CONTROLPIPE_DEFAULT_SIZE 8\r
+ #define PIPE_CONTROLPIPE_DEFAULT_SIZE 64\r
\r
/** Pipe number mask, for masking against pipe addresses to retrieve the pipe's numerical address\r
* in the device.\r
/** Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's\r
* numerical address in the attached device.\r
*/\r
- #define PIPE_EPNUM_MASK 0x07\r
-\r
- /** Endpoint bank size mask, for masking against endpoint addresses to retrieve the endpoint's\r
- * bank size in the attached device.\r
- */\r
- #define PIPE_EPSIZE_MASK 0x7FF\r
+ #define PIPE_EPNUM_MASK 0x0F\r
\r
- /** Interrupt definition for the pipe IN interrupt (for INTERRUPT type pipes). Should be used with\r
- * the USB_INT_* macros located in USBInterrupt.h.\r
- *\r
- * This interrupt will fire if enabled on an INTERRUPT type pipe if the pipe interrupt period has\r
- * elapsed and the pipe is ready for the next packet from the attached device to be read out from its\r
- * FIFO buffer (if received).\r
- *\r
- * \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
- * is selected), and will fire the common pipe interrupt vector.\r
- *\r
- * \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
+ /** Endpoint direction mask, for masking against endpoint addresses to retrieve the endpoint's\r
+ * direction for comparing with the ENDPOINT_DESCRIPTOR_DIR_* masks.\r
*/\r
- #define PIPE_INT_IN UPIENX, (1 << RXINE) , UPINTX, (1 << RXINI)\r
+ #define PIPE_EPDIR_MASK 0x80\r
\r
- /** Interrupt definition for the pipe OUT interrupt (for INTERRUPT type pipes). Should be used with\r
- * the USB_INT_* macros located in USBInterrupt.h.\r
- *\r
- * This interrupt will fire if enabled on an INTERRUPT type endpoint if a the pipe interrupt period\r
- * has elapsed and the pipe is ready for a packet to be written to the pipe's FIFO buffer and sent\r
- * to the attached device (if required).\r
- * \r
- * \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
- * is selected), and will fire the common pipe interrupt vector.\r
- *\r
- * \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
- */\r
- #define PIPE_INT_OUT UPIENX, (1 << TXOUTE), UPINTX, (1 << TXOUTI)\r
-\r
- /** Interrupt definition for the pipe SETUP bank ready interrupt (for CONTROL type pipes). Should be\r
- * used with the USB_INT_* macros located in USBInterrupt.h.\r
- *\r
- * This interrupt will fire if enabled on an CONTROL type pipe when the pipe is ready for a new\r
- * control request.\r
- *\r
- * \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
- * is selected), and will fire the common pipe interrupt vector.\r
- *\r
- * \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
- */\r
- #define PIPE_INT_SETUP UPIENX, (1 << TXSTPE) , UPINTX, (1 << TXSTPI)\r
-\r
- /** Interrupt definition for the pipe error interrupt. Should be used with the USB_INT_* macros\r
- * located in USBInterrupt.h.\r
- *\r
- * This interrupt will fire if enabled on a particular pipe if an error occurs on that pipe, such\r
- * as a CRC mismatch error.\r
- *\r
- * \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
- * is selected), and will fire the common pipe interrupt vector.\r
- *\r
- * \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
- *\r
- * \see Pipe_GetErrorFlags() for more information on the pipe errors.\r
- */\r
- #define PIPE_INT_ERROR UPIENX, (1 << PERRE), UPINTX, (1 << PERRI)\r
-\r
- /** Interrupt definition for the pipe NAK received interrupt. Should be used with the USB_INT_* macros\r
- * located in USBInterrupt.h.\r
- *\r
- * This interrupt will fire if enabled on a particular pipe if an attached device returns a NAK in\r
- * response to a sent packet.\r
- *\r
- * \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
- * is selected), and will fire the common pipe interrupt vector.\r
- *\r
- * \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
- *\r
- * \see Pipe_IsNAKReceived() for more information on pipe NAKs.\r
- */\r
- #define PIPE_INT_NAK UPIENX, (1 << NAKEDE), UPINTX, (1 << NAKEDI)\r
-\r
- /** Interrupt definition for the pipe STALL received interrupt. Should be used with the USB_INT_* macros\r
- * located in USBInterrupt.h.\r
- *\r
- * This interrupt will fire if enabled on a particular pipe if an attached device returns a STALL on the\r
- * currently selected pipe. This will also fire if the pipe is an isochronous pipe and a CRC error occurs.\r
- *\r
- * \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
- * is selected), and will fire the common pipe interrupt vector.\r
- *\r
- * \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
- */\r
- #define PIPE_INT_STALL UPIENX, (1 << RXSTALLE), UPINTX, (1 << RXSTALLI)\r
-\r
- /* Psuedo-Function Macros: */\r
+ /* Pseudo-Function Macros: */\r
#if defined(__DOXYGEN__)\r
/** Indicates the number of bytes currently stored in the current pipes's selected bank.\r
*\r
/** Selects the given pipe number. Any pipe operations which do not require the pipe number to be\r
* indicated will operate on the currently selected pipe.\r
*\r
- * \param PipeNumber Index of the pipe to select\r
+ * \param[in] PipeNumber Index of the pipe to select\r
*/\r
static inline void Pipe_SelectPipe(uint8_t PipeNumber);\r
\r
/** Resets the desired pipe, including the pipe banks and flags.\r
*\r
- * \param PipeNumber Index of the pipe to reset\r
+ * \param[in] PipeNumber Index of the pipe to reset\r
*/\r
static inline void Pipe_ResetPipe(uint8_t PipeNumber);\r
\r
/** Enables the currently selected pipe so that data can be sent and received through it to and from\r
* an attached device.\r
*\r
- * \note Pipes must first be configured properly rather than just being enabled via the\r
- * Pipe_ConfigurePipe() macro, which calls Pipe_EnablePipe() automatically.\r
+ * \note Pipes must first be configured properly via \ref Pipe_ConfigurePipe().\r
*/\r
static inline void Pipe_EnablePipe(void);\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
* control requests, or on regular pipes to allow for half-duplex bidirectional data transfer to devices\r
* which have two endpoints of opposite direction sharing the same endpoint address within the device.\r
*\r
- * \param Token New pipe token to set the selected pipe to, as a PIPE_TOKEN_* mask\r
+ * \param[in] Token New pipe token to set the selected pipe to, as a PIPE_TOKEN_* mask\r
*/\r
static inline void Pipe_SetPipeToken(uint8_t Token);\r
\r
/** Configures the currently selected pipe to only allow the specified number of IN requests to be\r
* accepted by the pipe before it is automatically frozen.\r
*\r
- * \param TotalINRequests Total number of IN requests that the pipe may receive before freezing\r
+ * \param[in] TotalINRequests Total number of IN requests that the pipe may receive before freezing\r
*/\r
static inline void Pipe_SetFiniteINRequests(uint8_t TotalINRequests);\r
\r
*/\r
static inline bool Pipe_IsConfigured(void);\r
\r
+ /** Retrieves the endpoint number of the endpoint within the attached device that the currently selected\r
+ * pipe is bound to.\r
+ *\r
+ * \return Endpoint number the currently selected pipe is bound to\r
+ */\r
+ static inline uint8_t Pipe_BoundEndpointNumber(void);\r
+\r
/** Sets the period between interrupts for an INTERRUPT type pipe to a specified number of milliseconds.\r
*\r
- * \param Milliseconds Number of milliseconds between each pipe poll\r
+ * \param[in] Milliseconds Number of milliseconds between each pipe poll\r
*/\r
static inline void Pipe_SetInterruptPeriod(uint8_t Milliseconds);\r
\r
*/\r
static inline uint8_t Pipe_GetPipeInterrupts(void);\r
\r
- /** Clears the interrupt flag for the specified pipe number.\r
- *\r
- * \param PipeNumber Index of the pipe whose interrupt flag is to be cleared\r
- */\r
- static inline void Pipe_ClearPipeInterrupt(uint8_t PipeNumber);\r
- \r
/** Determines if the specified pipe number has interrupted (valid only for INTERRUPT type\r
* pipes).\r
*\r
- * \param PipeNumber Index of the pipe whose interrupt flag should be tested\r
+ * \param[in] PipeNumber Index of the pipe whose interrupt flag should be tested\r
*\r
* \return Boolean true if the specified pipe has interrupted, false otherwise\r
*/\r
/** Freezes the selected pipe, preventing it from communicating with an attached device. */\r
static inline void Pipe_Freeze(void);\r
\r
+ /** Determines if the currently selected pipe is frozen, and not able to accept data.\r
+ *\r
+ * \return Boolean true if the currently selected pipe is frozen, false otherwise\r
+ */\r
+ static inline bool Pipe_IsFrozen(void);\r
+ \r
/** Clears the master pipe error flag. */\r
static inline void Pipe_ClearError(void);\r
\r
/** Determines 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 retrieving the exact error flag.\r
+ * \see \ref Pipe_GetErrorFlags() macro for information on retrieving the exact error flag.\r
*\r
- * \return Boolean true if an error has ocurred on the selected pipe, false otherwise\r
+ * \return Boolean true if an error has occurred on the selected pipe, false otherwise\r
*/\r
static inline bool Pipe_IsError(void);\r
\r
/** Gets 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
- * \return Mask comprising of PIPE_ERRORFLAG_* bits indicating what error has ocurred on the selected pipe\r
+ * \return Mask comprising of PIPE_ERRORFLAG_* bits indicating what error has occurred on the selected pipe\r
*/\r
static inline uint8_t Pipe_GetErrorFlags(void);\r
\r
* is an IN direction and no packet (or an empty packet) has been received, or if the pipe is an OUT\r
* direction and the pipe bank is full.\r
*\r
+ * \note This function is not valid on CONTROL type pipes.\r
+ *\r
* \ingroup Group_PipePacketManagement\r
* \r
* \return Boolean true if the currently selected pipe may be read from or written to, depending on its direction\r
*/\r
static inline bool Pipe_IsSETUPSent(void);\r
\r
- /** Acknowledges the reception of a setup IN request from the attached device on the currently selected\r
- * CONTROL type pipe, freeing the bank ready for the next packet.\r
- *\r
- * \ingroup Group_PipePacketManagement\r
- *\r
- * \note For non CONTROL type pipes, use Pipe_ClearIN() instead. \r
- */\r
- static inline void Pipe_ClearControlIN(void);\r
-\r
- /** Sends the currently selected pipe's contents to the device as an OUT packet on the selected pipe, freeing\r
- * the bank ready for the next packet.\r
- *\r
- * \ingroup Group_PipePacketManagement\r
- *\r
- * \note For non CONTROL type pipes, use Pipe_ClearOUT() instead. \r
- */\r
- static inline void Pipe_ClearControlOUT(void);\r
-\r
/** Sends the currently selected CONTROL type pipe's contents to the device as a SETUP packet.\r
*\r
- * \ingroup Group_PipePacketManagement\r
- *\r
- * \note This is not applicable for non CONTROL type pipes. \r
+ * \ingroup Group_PipePacketManagement \r
*/\r
- static inline void Pipe_ClearControlSETUP(void);\r
+ static inline void Pipe_ClearSETUP(void);\r
\r
/** Acknowledges the reception of a setup IN request from the attached device on the currently selected\r
* pipe, freeing the bank ready for the next packet.\r
*\r
* \ingroup Group_PipePacketManagement\r
- *\r
- * \note For CONTROL type pipes, use Pipe_ClearControlIN() instead. \r
*/\r
static inline void Pipe_ClearIN(void);\r
\r
* the bank ready for the next packet.\r
*\r
* \ingroup Group_PipePacketManagement\r
- *\r
- * \note For CONTROL type pipes, use Pipe_ClearControlOUT() instead. \r
*/\r
static inline void Pipe_ClearOUT(void);\r
\r
/** Determines if the device sent a NAK (Negative Acknowledge) in response to the last sent packet on\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 cleared using Pipe_ClearNAKReceived() before the previous (or any other) packet\r
+ * received, it must be cleared using \ref Pipe_ClearNAKReceived() before the previous (or any other) packet\r
* can be re-sent.\r
*\r
* \ingroup Group_PipePacketManagement\r
*\r
* \ingroup Group_PipePacketManagement\r
*\r
- * \see Pipe_IsNAKReceived() for more details.\r
+ * \see \ref Pipe_IsNAKReceived() for more details.\r
*/\r
static inline void Pipe_ClearNAKReceived(void);\r
\r
\r
#define Pipe_GetCurrentPipe() (UPNUM & PIPE_PIPENUM_MASK)\r
\r
- #define Pipe_SelectPipe(pipenum) MACROS{ UPNUM = pipenum; }MACROE\r
+ #define Pipe_SelectPipe(pipenum) MACROS{ UPNUM = (pipenum); }MACROE\r
\r
- #define Pipe_ResetPipe(pipenum) MACROS{ UPRST = (1 << pipenum); UPRST = 0; }MACROE\r
+ #define Pipe_ResetPipe(pipenum) MACROS{ UPRST = (1 << (pipenum)); UPRST = 0; }MACROE\r
\r
#define Pipe_EnablePipe() MACROS{ UPCONX |= (1 << PEN); }MACROE\r
\r
\r
#define Pipe_GetPipeToken() (UPCFG0X & PIPE_TOKEN_MASK)\r
\r
- #define Pipe_SetToken(token) MACROS{ UPCFG0X = ((UPCFG0X & ~PIPE_TOKEN_MASK) | token); }MACROE\r
+ #define Pipe_SetPipeToken(token) MACROS{ UPCFG0X = ((UPCFG0X & ~PIPE_TOKEN_MASK) | (token)); }MACROE\r
\r
#define Pipe_SetInfiniteINRequests() MACROS{ UPCONX |= (1 << INMODE); }MACROE\r
\r
- #define Pipe_SetFiniteINRequests(n) MACROS{ UPCONX &= ~(1 << INMODE); UPINRQX = n; }MACROE\r
+ #define Pipe_SetFiniteINRequests(n) MACROS{ UPCONX &= ~(1 << INMODE); UPINRQX = (n); }MACROE\r
\r
#define Pipe_IsConfigured() ((UPSTAX & (1 << CFGOK)) ? true : false)\r
\r
- #define Pipe_SetInterruptPeriod(ms) MACROS{ UPCFG2X = ms; }MACROE\r
+ #define Pipe_BoundEndpointNumber() ((UPCFG0X >> PEPNUM0) & PIPE_EPNUM_MASK)\r
+ \r
+ #define Pipe_SetInterruptPeriod(ms) MACROS{ UPCFG2X = (ms); }MACROE\r
\r
#define Pipe_GetPipeInterrupts() UPINT\r
\r
- #define Pipe_ClearPipeInterrupt(n) MACROS{ UPINT &= ~(1 << n); }MACROE\r
-\r
- #define Pipe_HasPipeInterrupted(n) ((UPINT & (1 << n)) ? true : false)\r
+ #define Pipe_HasPipeInterrupted(n) ((UPINT & (1 << (n))) ? true : false)\r
\r
#define Pipe_Unfreeze() MACROS{ UPCONX &= ~(1 << PFREEZE); }MACROE\r
\r
#define Pipe_Freeze() MACROS{ UPCONX |= (1 << PFREEZE); }MACROE\r
+ \r
+ #define Pipe_IsFrozen() ((UPCONX & (1 << PFREEZE)) ? true : false)\r
\r
#define Pipe_ClearError() MACROS{ UPINTX &= ~(1 << PERRI); }MACROE\r
\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
#define Pipe_ClearIN() MACROS{ uint8_t Temp = UPINTX; UPINTX = (Temp & ~(1 << RXINI)); \\r
UPINTX = (Temp & ~(1 << FIFOCON)); }MACROE\r
\r
- #define Pipe_ClearControlIN() MACROS{ uint8_t Temp = UPINTX; UPINTX = (Temp & ~(1 << RXINI)); \\r
- UPINTX = (Temp & ~(1 << FIFOCON)); }MACROE\r
-\r
#define Pipe_ClearOUT() MACROS{ uint8_t Temp = UPINTX; UPINTX = (Temp & ~(1 << TXOUTI)); \\r
UPINTX = (Temp & ~(1 << FIFOCON)); }MACROE\r
\r
- #define Pipe_ClearControlOUT() MACROS{ uint8_t Temp = UPINTX; UPINTX = (Temp & ~(1 << TXOUTI)); \\r
- UPINTX = (Temp & ~(1 << FIFOCON)); }MACROE\r
-\r
- #define Pipe_ClearControlSETUP() MACROS{ uint8_t Temp = UPINTX; UPINTX = (Temp & ~(1 << TXSTPI)); \\r
+ #define Pipe_ClearSETUP() MACROS{ uint8_t Temp = UPINTX; UPINTX = (Temp & ~(1 << TXSTPI)); \\r
UPINTX = (Temp & ~(1 << FIFOCON)); }MACROE\r
\r
#define Pipe_IsNAKReceived() ((UPINTX & (1 << NAKEDI)) ? true : false)\r
PIPE_READYWAIT_DeviceDisconnected = 2, /**< Device was disconnected from the host while waiting. */\r
PIPE_READYWAIT_Timeout = 3, /**< The device failed to accept or send the next packet\r
* within the software timeout period set by the\r
- * USB_STREAM_TIMEOUT_MS macro.\r
+ * \ref USB_STREAM_TIMEOUT_MS macro.\r
*/\r
};\r
\r
*/\r
enum Pipe_Stream_RW_ErrorCodes_t\r
{\r
- PIPE_RWSTREAM_ERROR_NoError = 0, /**< Command completed successfully, no error. */\r
- PIPE_RWSTREAM_ERROR_PipeStalled = 1, /**< The device stalled the pipe during the transfer. */ \r
- PIPE_RWSTREAM_ERROR_DeviceDisconnected = 2, /**< Device was disconnected from the host during\r
- * the transfer.\r
- */ \r
- PIPE_RWSTREAM_ERROR_Timeout = 3, /**< The device failed to accept or send the next packet\r
- * within the software timeout period set by the\r
- * USB_STREAM_TIMEOUT_MS macro.\r
- */\r
- PIPE_RWSTREAM_ERROR_CallbackAborted = 4, /**< Indicates that the stream's callback function aborted\r
- * the transfer early.\r
- */\r
+ PIPE_RWSTREAM_NoError = 0, /**< Command completed successfully, no error. */\r
+ PIPE_RWSTREAM_PipeStalled = 1, /**< The device stalled the pipe during the transfer. */ \r
+ PIPE_RWSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during\r
+ * the transfer.\r
+ */ \r
+ PIPE_RWSTREAM_Timeout = 3, /**< The device failed to accept or send the next packet\r
+ * within the software timeout period set by the\r
+ * \ref USB_STREAM_TIMEOUT_MS macro.\r
+ */\r
+ PIPE_RWSTREAM_CallbackAborted = 4, /**< Indicates that the stream's callback function aborted\r
+ * the transfer early.\r
+ */\r
};\r
\r
/* Inline Functions: */\r
/** Reads one byte from the currently selected pipe's bank, for OUT direction pipes.\r
*\r
- * \ingroup Group_PipeRW\r
+ * \ingroup Group_PipePrimitiveRW\r
*\r
* \return Next byte in the currently selected pipe's FIFO buffer\r
*/\r
\r
/** Writes one byte from the currently selected pipe's bank, for IN direction pipes.\r
*\r
- * \ingroup Group_PipeRW\r
+ * \ingroup Group_PipePrimitiveRW\r
*\r
- * \param Byte Next byte to write into the the currently selected pipe's FIFO buffer\r
+ * \param[in] Byte Next byte to write into the the currently selected pipe's FIFO buffer\r
*/\r
static inline void Pipe_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;\r
static inline void Pipe_Write_Byte(const uint8_t Byte)\r
\r
/** Discards one byte from the currently selected pipe's bank, for OUT direction pipes.\r
*\r
- * \ingroup Group_PipeRW\r
+ * \ingroup Group_PipePrimitiveRW\r
*/\r
static inline void Pipe_Discard_Byte(void) ATTR_ALWAYS_INLINE;\r
static inline void Pipe_Discard_Byte(void)\r
/** Reads two bytes from the currently selected pipe's bank in little endian format, for OUT\r
* direction pipes.\r
*\r
- * \ingroup Group_PipeRW\r
+ * \ingroup Group_PipePrimitiveRW\r
*\r
* \return Next word in the currently selected pipe's FIFO buffer\r
*/\r
static inline uint16_t Pipe_Read_Word_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
static inline uint16_t Pipe_Read_Word_LE(void)\r
{\r
- uint16_t Data;\r
+ union\r
+ {\r
+ uint16_t Word;\r
+ uint8_t Bytes[2];\r
+ } Data;\r
\r
- Data = UPDATX;\r
- Data |= (((uint16_t)UPDATX) << 8);\r
+ Data.Bytes[0] = UPDATX;\r
+ Data.Bytes[1] = UPDATX;\r
\r
- return Data;\r
+ return Data.Word;\r
}\r
\r
/** Reads two bytes from the currently selected pipe's bank in big endian format, for OUT\r
* direction pipes.\r
*\r
- * \ingroup Group_PipeRW\r
+ * \ingroup Group_PipePrimitiveRW\r
*\r
* \return Next word in the currently selected pipe's FIFO buffer\r
*/\r
static inline uint16_t Pipe_Read_Word_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
static inline uint16_t Pipe_Read_Word_BE(void)\r
{\r
- uint16_t Data;\r
+ union\r
+ {\r
+ uint16_t Word;\r
+ uint8_t Bytes[2];\r
+ } Data;\r
\r
- Data = (((uint16_t)UPDATX) << 8);\r
- Data |= UPDATX;\r
+ Data.Bytes[1] = UPDATX;\r
+ Data.Bytes[0] = UPDATX;\r
\r
- return Data;\r
+ return Data.Word;\r
}\r
\r
/** Writes two bytes to the currently selected pipe's bank in little endian format, for IN\r
* direction pipes.\r
*\r
- * \ingroup Group_PipeRW\r
+ * \ingroup Group_PipePrimitiveRW\r
*\r
- * \param Word Next word to write to the currently selected pipe's FIFO buffer\r
+ * \param[in] Word Next word to write to the currently selected pipe's FIFO buffer\r
*/\r
static inline void Pipe_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;\r
static inline void Pipe_Write_Word_LE(const uint16_t Word)\r
/** Writes two bytes to the currently selected pipe's bank in big endian format, for IN\r
* direction pipes.\r
*\r
- * \ingroup Group_PipeRW\r
+ * \ingroup Group_PipePrimitiveRW\r
*\r
- * \param Word Next word to write to the currently selected pipe's FIFO buffer\r
+ * \param[in] Word Next word to write to the currently selected pipe's FIFO buffer\r
*/\r
static inline void Pipe_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;\r
static inline void Pipe_Write_Word_BE(const uint16_t Word)\r
\r
/** Discards two bytes from the currently selected pipe's bank, for OUT direction pipes.\r
*\r
- * \ingroup Group_PipeRW\r
+ * \ingroup Group_PipePrimitiveRW\r
*/\r
static inline void Pipe_Discard_Word(void) ATTR_ALWAYS_INLINE;\r
static inline void Pipe_Discard_Word(void)\r
/** Reads four bytes from the currently selected pipe's bank in little endian format, for OUT\r
* direction pipes.\r
*\r
- * \ingroup Group_PipeRW\r
+ * \ingroup Group_PipePrimitiveRW\r
*\r
* \return Next double word in the currently selected pipe's FIFO buffer\r
*/\r
/** Reads four bytes from the currently selected pipe's bank in big endian format, for OUT\r
* direction pipes.\r
*\r
- * \ingroup Group_PipeRW\r
+ * \ingroup Group_PipePrimitiveRW\r
*\r
* \return Next double word in the currently selected pipe's FIFO buffer\r
*/\r
/** Writes four bytes to the currently selected pipe's bank in little endian format, for IN\r
* direction pipes.\r
*\r
- * \ingroup Group_PipeRW\r
+ * \ingroup Group_PipePrimitiveRW\r
*\r
- * \param DWord Next double word to write to the currently selected pipe's FIFO buffer\r
+ * \param[in] DWord Next double word to write to the currently selected pipe's FIFO buffer\r
*/\r
static inline void Pipe_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;\r
static inline void Pipe_Write_DWord_LE(const uint32_t DWord)\r
{\r
- Pipe_Write_Word_LE(DWord);\r
- Pipe_Write_Word_LE(DWord >> 16);\r
+ UPDATX = (DWord & 0xFF);\r
+ UPDATX = (DWord >> 8);\r
+ UPDATX = (DWord >> 16);\r
+ UPDATX = (DWord >> 24);\r
}\r
\r
/** Writes four bytes to the currently selected pipe's bank in big endian format, for IN\r
* direction pipes.\r
*\r
- * \ingroup Group_PipeRW\r
+ * \ingroup Group_PipePrimitiveRW\r
*\r
- * \param DWord Next double word to write to the currently selected pipe's FIFO buffer\r
+ * \param[in] DWord Next double word to write to the currently selected pipe's FIFO buffer\r
*/\r
static inline void Pipe_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;\r
static inline void Pipe_Write_DWord_BE(const uint32_t DWord)\r
{\r
- Pipe_Write_Word_BE(DWord >> 16);\r
- Pipe_Write_Word_BE(DWord);\r
+ UPDATX = (DWord >> 24);\r
+ UPDATX = (DWord >> 16);\r
+ UPDATX = (DWord >> 8);\r
+ UPDATX = (DWord & 0xFF);\r
} \r
\r
/** Discards four bytes from the currently selected pipe's bank, for OUT direction pipes. \r
*\r
- * \ingroup Group_PipeRW\r
+ * \ingroup Group_PipePrimitiveRW\r
*/\r
- static inline void Pipe_Ignore_DWord(void) ATTR_ALWAYS_INLINE;\r
- static inline void Pipe_Ignore_DWord(void)\r
+ static inline void Pipe_Discard_DWord(void) ATTR_ALWAYS_INLINE;\r
+ static inline void Pipe_Discard_DWord(void)\r
{\r
uint8_t Dummy;\r
\r
extern uint8_t USB_ControlPipeSize;\r
\r
/* Function Prototypes: */\r
+ #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
+ #define __CALLBACK_PARAM , StreamCallbackPtr_t Callback\r
+ #else\r
+ #define __CALLBACK_PARAM \r
+ #endif\r
+\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
* numbers can handle different maximum packet sizes - refer to the chosen USB AVR's datasheet to\r
* determine the maximum bank size for each pipe.\r
*\r
- * The banking mode may be either PIPE_BANK_SINGLE or PIPE_BANK_DOUBLE.\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()\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
- * A newly configured pipe is frozen by default, and must be unfrozen before use via the Pipe_Unfreeze() macro.\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
bool Pipe_ConfigurePipe(const uint8_t Number, const uint8_t Type, const uint8_t Token, const uint8_t EndpointNumber,\r
const uint16_t Size, const uint8_t Banks);\r
\r
- /** Spinloops until the currently selected non-control pipe is ready for the next packed of data\r
- * to be read or written to it.\r
- *\r
- * \note This routine should not be called on CONTROL type pipes.\r
+ /** Spin-loops until the currently selected non-control pipe is ready for the next packed of data to be read \r
+ * or written to it, aborting in the case of an error condition (such as a timeout or device disconnect).\r
*\r
* \ingroup Group_PipeRW\r
*\r
* \return A value from the Pipe_WaitUntilReady_ErrorCodes_t enum.\r
*/\r
- uint8_t Pipe_WaitUntilReady(void); \r
+ uint8_t Pipe_WaitUntilReady(void);\r
+ \r
+ /** Determines if a pipe has been bound to the given device endpoint address. If a pipe which is bound to the given\r
+ * endpoint is found, it is automatically selected.\r
+ *\r
+ * \param[in] EndpointAddress Address and direction mask of the endpoint within the attached device to check\r
+ *\r
+ * \return Boolean true if a pipe bound to the given endpoint address of the specified direction is found, false\r
+ * otherwise\r
+ */\r
+ bool Pipe_IsEndpointBound(const uint8_t EndpointAddress);\r
\r
+ /** Reads and discards the given number of bytes from the pipe, discarding fully read packets from the host\r
+ * as needed. The last packet is not automatically discarded once the remaining bytes has been read; the\r
+ * user is responsible for manually discarding the last packet from the device via the \ref Pipe_ClearIN() macro.\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 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_PipeStreamRW\r
+ *\r
+ * \param[in] Length Number of bytes to send via the currently selected pipe.\r
+ * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
+ *\r
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
+ */\r
+ uint8_t Pipe_Discard_Stream(uint16_t Length __CALLBACK_PARAM);\r
+\r
/** Writes the given number of bytes to the pipe from the given buffer in little endian,\r
* sending full packets to the device as needed. The last packet filled is not automatically sent;\r
* the user is responsible for manually sending the last written packet to the host via the\r
- * Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is\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 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
- * \ingroup Group_PipeRW\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_PipeStreamRW\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 successive USB packet transfers, NULL if no callback\r
+ * \param[in] Buffer Pointer to the source data buffer to read from.\r
+ * \param[in] Length Number of bytes to read for the currently selected pipe into the buffer.\r
+ * \param[in] 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
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
*/\r
- uint8_t Pipe_Write_Stream_LE(const void* Buffer, uint16_t Length\r
- #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
- , uint8_t (* const Callback)(void)\r
- #endif\r
- ) ATTR_NON_NULL_PTR_ARG(1); \r
+ uint8_t Pipe_Write_Stream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1); \r
\r
+ /** EEPROM buffer source version of \ref Pipe_Write_Stream_LE().\r
+ *\r
+ * \ingroup Group_PipeStreamRW\r
+ *\r
+ * \param[in] Buffer Pointer to the source data buffer to read from.\r
+ * \param[in] Length Number of bytes to read for the currently selected pipe into the buffer.\r
+ * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
+ *\r
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
+ */\r
+ uint8_t Pipe_Write_EStream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
+ \r
+ /** FLASH buffer source version of \ref Pipe_Write_Stream_LE().\r
+ *\r
+ * \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.\r
+ *\r
+ * \ingroup Group_PipeStreamRW\r
+ *\r
+ * \param[in] Buffer Pointer to the source data buffer to read from.\r
+ * \param[in] Length Number of bytes to read for the currently selected pipe into the buffer.\r
+ * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
+ *\r
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
+ */\r
+ uint8_t Pipe_Write_PStream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
+ \r
/** Writes the given number of bytes to the pipe from the given buffer in big endian,\r
* sending full packets to the device as needed. The last packet filled is not automatically sent;\r
* the user is responsible for manually sending the last written packet to the host via the\r
- * Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is\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 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
- * \ingroup Group_PipeRW\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_PipeStreamRW\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 successive USB packet transfers, NULL if no callback\r
+ * \param[in] Buffer Pointer to the source data buffer to read from.\r
+ * \param[in] Length Number of bytes to read for the currently selected pipe into the buffer.\r
+ * \param[in] 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
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
*/\r
- uint8_t Pipe_Write_Stream_BE(const void* Buffer, uint16_t Length\r
- #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
- , uint8_t (* const Callback)(void)\r
- #endif\r
- ) ATTR_NON_NULL_PTR_ARG(1);\r
+ uint8_t Pipe_Write_Stream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
\r
- /** Reads and discards the given number of bytes from the pipe, discarding fully read packets from the host\r
- * as needed. The last packet is not automatically discarded once the remaining bytes has been read; the\r
- * user is responsible for manually discarding the last packet from the device via the Pipe_ClearIN() macro.\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
+ /** EEPROM buffer source version of \ref Pipe_Write_Stream_BE().\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 omitted.\r
+ * \ingroup Group_PipeStreamRW\r
*\r
- * \ingroup Group_PipeRW\r
+ * \param[in] Buffer Pointer to the source data buffer to read from.\r
+ * \param[in] Length Number of bytes to read for the currently selected pipe into the buffer.\r
+ * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\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 successive USB packet transfers, NULL if no callback\r
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
+ */\r
+ uint8_t Pipe_Write_EStream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
+ \r
+ /** FLASH buffer source version of \ref Pipe_Write_Stream_BE().\r
*\r
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum.\r
+ * \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.\r
+ *\r
+ * \ingroup Group_PipeStreamRW\r
+ *\r
+ * \param[in] Buffer Pointer to the source data buffer to read from.\r
+ * \param[in] Length Number of bytes to read for the currently selected pipe into the buffer.\r
+ * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
+ *\r
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
*/\r
- uint8_t Pipe_Discard_Stream(uint16_t Length\r
- #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
- , uint8_t (* const Callback)(void)\r
- #endif\r
- );\r
+ uint8_t Pipe_Write_PStream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** Reads the given number of bytes from the pipe into the given buffer in little endian,\r
* sending full packets to the device as needed. The last packet filled is not automatically sent;\r
* the user is responsible for manually sending the last written packet to the host via the\r
- * Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is\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 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
- * \ingroup Group_PipeRW\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_PipeStreamRW\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 successive USB packet transfers, NULL if no callback\r
+ * \param[out] Buffer Pointer to the source data buffer to write to.\r
+ * \param[in] Length Number of bytes to read for the currently selected pipe to read from.\r
+ * \param[in] 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
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
*/\r
- uint8_t Pipe_Read_Stream_LE(void* Buffer, uint16_t Length\r
- #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
- , uint8_t (* const Callback)(void)\r
- #endif\r
- ) ATTR_NON_NULL_PTR_ARG(1);\r
+ uint8_t Pipe_Read_Stream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+ /** EEPROM buffer source version of \ref Pipe_Read_Stream_LE().\r
+ *\r
+ * \ingroup Group_PipeStreamRW\r
+ *\r
+ * \param[out] Buffer Pointer to the source data buffer to write to.\r
+ * \param[in] Length Number of bytes to read for the currently selected pipe to read from.\r
+ * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
+ *\r
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
+ */\r
+ uint8_t Pipe_Read_EStream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** Reads the given number of bytes from the pipe into the given buffer in big endian,\r
* sending full packets to the device as needed. The last packet filled is not automatically sent;\r
* the user is responsible for manually sending the last written packet to the host via the\r
- * Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is\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 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
- * \ingroup Group_PipeRW\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_PipeStreamRW\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 successive USB packet transfers, NULL if no callback\r
+ * \param[out] Buffer Pointer to the source data buffer to write to.\r
+ * \param[in] Length Number of bytes to read for the currently selected pipe to read from.\r
+ * \param[in] 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
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
*/\r
- uint8_t Pipe_Read_Stream_BE(void* Buffer, uint16_t Length\r
- #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
- , uint8_t (* const Callback)(void)\r
- #endif\r
- ) ATTR_NON_NULL_PTR_ARG(1);\r
+ uint8_t Pipe_Read_Stream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
\r
+ /** EEPROM buffer source version of \ref Pipe_Read_Stream_BE().\r
+ *\r
+ * \ingroup Group_PipeStreamRW\r
+ *\r
+ * \param[out] Buffer Pointer to the source data buffer to write to.\r
+ * \param[in] Length Number of bytes to read for the currently selected pipe to read from.\r
+ * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
+ *\r
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
+ */\r
+ uint8_t Pipe_Read_EStream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
/* Private Interface - For use in library only: */\r
#if !defined(__DOXYGEN__)\r
/* Macros: */\r
#define PIPE_TOKEN_MASK (0x03 << PTOKEN0)\r
\r
+ #if !defined(ENDPOINT_CONTROLEP)\r
+ #define ENDPOINT_CONTROLEP 0\r
+ #endif\r
+ \r
#define Pipe_AllocateMemory() MACROS{ UPCFG1X |= (1 << ALLOC); }MACROE\r
#define Pipe_DeallocateMemory() MACROS{ UPCFG1X &= ~(1 << ALLOC); }MACROE\r
\r
return (4 << EPSIZE0);\r
else\r
return (5 << EPSIZE0);\r
- };\r
+ }\r
\r
#endif\r
\r
projects / pub / USBasp.git / blobdiff