Minor updates to the Benito programmer - remove redundant PORT register manipulations.

[pub/USBasp.git] / LUFA / Drivers / USB / HighLevel / StreamCallbacks.h

diff --git a/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h b/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h
index 6a18920..0d432e7 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h
+++ b/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h
@@ -32,7 +32,8 @@
  *  @defgroup Group_StreamCallbacks Endpoint and Pipe Stream Callbacks\r
  *\r
  *  Macros and enums for the stream callback routines. This module contains the code required to easily set up\r
  *  @defgroup Group_StreamCallbacks Endpoint and Pipe Stream Callbacks\r
  *\r
  *  Macros and enums for the stream callback routines. This module contains the code required to easily set up\r

- *  stream callback functions which can be used to force early abort of a stream read/write process.\r
+ *  stream callback functions which can be used to force early abort of a stream read/write process. Each callback\r
+ *  should take no arguments, and return a value from the \ref StreamCallback_Return_ErrorCodes_t enum.\r

  *\r
  *  @{\r
  */\r
  *\r
  *  @{\r
  */\r


@@ -42,37 +43,6 @@
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\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 \ref 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
                        /** 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


@@ -85,7 +55,14 @@
                                STREAMCALLBACK_Continue            = 0, /**< Continue sending or receiving the stream. */\r
                                STREAMCALLBACK_Abort               = 1, /**< Abort the stream send or receiving process. */\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
+\r
+               /* Type Defines: */\r
+                       /** Type define for a Stream Callback function (function taking no arguments and retuning a\r
+                        *  uint8_t value). Stream callback functions should have an identical function signature if they\r
+                        *  are to be used as the callback parameter of the stream functions.\r
+                        */\r
+                       typedef uint8_t (* const StreamCallbackPtr_t)(void);\r
+               \r

 #endif\r
 \r
 /** @} */\r
 #endif\r
 \r
 /** @} */\r