-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2009.\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
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- * Macros and enums for the stream callback routines in Endpoint.h and Pipe.c. This module contains the\r
- * code required to easily set up stream callback functions which can be used to force early abort of a\r
- * stream read/write process.\r
- */\r
- \r
-#ifndef __STREAMCALLBACK_H__\r
-#define __STREAMCALLBACK_H__\r
-\r
- /* Public Interface - May be used in end-application: */\r
- /* Macros: */\r
- /** Creates a prototype for or begins a stream callback routine. Stream callback routines are small\r
- * routines which are executed during stream read or writes (if the callback-enabled versions of\r
- * these functions are used) which allow the user application to abort the transfer when certain\r
- * arbitrary conditions are met.\r
- *\r
- * Stream callback functions should return a value from the StreamCallback_Return_ErrorCodes_t\r
- * enum.\r
- *\r
- * Usage Example (Device Endpoint, but applicable for Host Pipes also):\r
- * \code\r
- * STREAM_CALLBACK(GlobalNotSet); // Callback Prototype\r
- *\r
- * STREAM_CALLBACK(GlobalNotSet)\r
- * {\r
- * if (MyGlobal == false)\r
- * return ENDPOINT_STREAMCALLBACK_Continue;\r
- * else\r
- * return ENDPOINT_STREAMCALLBACK_Abort;\r
- * }\r
- *\r
- * //...\r
- * // Inside some routine:\r
- * if (Endpoint_Write_Stream_LE(DataBuffer, sizeof(DataBuffer), GlobalNotSet) == \r
- * ENDPOINT_RWSTREAM_ERROR_CallbackAborted)\r
- * {\r
- * // Do something when the callback aborted the transfer early\r
- * }\r
- * \endcode\r
- */\r
- #define STREAM_CALLBACK(name) uint8_t name (void)\r
-\r
- /** Used with the Endpoint and Pipe stream functions as the callback function parameter, indicating that the stream\r
- * call has no callback function to be called between USB packets.\r
- */\r
- #define NO_STREAM_CALLBACK NULL\r
- \r
- /* Enums: */\r
- /** Enum for the possible error return codes of a stream callback function */\r
- enum StreamCallback_Return_ErrorCodes_t\r
- {\r
- STREAMCALLBACK_Continue = 0, /**< Continue sending or receiving the stream. */\r
- STREAMCALLBACK_Abort = 1, /**< Abort the stream send or receiving process. */\r
- };\r
- \r
-#endif\r
+/*
+ LUFA Library
+ Copyright (C) Dean Camera, 2010.
+
+ dean [at] fourwalledcubicle [dot] com
+ www.lufa-lib.org
+*/
+
+/*
+ Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+ Permission to use, copy, modify, distribute, and sell this
+ software and its documentation for any purpose is hereby granted
+ without fee, provided that the above copyright notice appear in
+ all copies and that both that the copyright notice and this
+ permission notice and warranty disclaimer appear in supporting
+ documentation, and that the name of the author not be used in
+ advertising or publicity pertaining to distribution of the
+ software without specific, written prior permission.
+
+ The author disclaim all warranties with regard to this
+ software, including all implied warranties of merchantability
+ and fitness. In no event shall the author be liable for any
+ special, indirect or consequential damages or any damages
+ whatsoever resulting from loss of use, data or profits, whether
+ in an action of contract, negligence or other tortious action,
+ arising out of or in connection with the use or performance of
+ this software.
+*/
+
+/** \file
+ * \brief USB endpoint/pipe stream callback management.
+ *
+ * This file contains definitions for the creation of optional callback routines which can be passed to the
+ * endpoint and/or pipe stream APIs, to abort the transfer currently in progress when a condition is met.
+ *
+ * \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.
+ */
+
+/** \ingroup Group_USB
+ * @defgroup Group_StreamCallbacks Endpoint and Pipe Stream Callbacks
+ *
+ * Macros and enums for the stream callback routines. This module contains the code required to easily set up
+ * stream callback functions which can be used to force early abort of a stream read/write process. Each callback
+ * should take no arguments, and return a value from the \ref StreamCallback_Return_ErrorCodes_t enum.
+ *
+ * @{
+ */
+
+#ifndef __STREAMCALLBACK_H__
+#define __STREAMCALLBACK_H__
+
+ /* Includes: */
+ #include <stdint.h>
+
+ /* Preprocessor Checks: */
+ #if !defined(__INCLUDE_FROM_USB_DRIVER)
+ #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
+ #endif
+
+ /* Public Interface - May be used in end-application: */
+ /* Macros: */
+ /** Used with the Endpoint and Pipe stream functions as the callback function parameter, indicating that the stream
+ * call has no callback function to be called between USB packets.
+ */
+ #define NO_STREAM_CALLBACK NULL
+
+ /* Enums: */
+ /** Enum for the possible error return codes of a stream callback function. */
+ enum StreamCallback_Return_ErrorCodes_t
+ {
+ STREAMCALLBACK_Continue = 0, /**< Continue sending or receiving the stream. */
+ STREAMCALLBACK_Abort = 1, /**< Abort the stream send or receiving process. */
+ };
+
+ /* Type Defines: */
+ /** Type define for a Stream Callback function (function taking no arguments and retuning a
+ * uint8_t value). Stream callback functions should have an identical function signature if they
+ * are to be used as the callback parameter of the stream functions.
+ */
+ typedef uint8_t (* const StreamCallbackPtr_t)(void);
+
+#endif
+
+/** @} */
+
projects / pub / USBasp.git / blobdiff