LUFA/Drivers/USB/HighLevel/StreamCallbacks.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \ingroup Group_USB
  32  *  @defgroup Group_StreamCallbacks Endpoint and Pipe Stream Callbacks
  33  *
  34  *  Macros and enums for the stream callback routines. This module contains the code required to easily set up
  35  *  stream callback functions which can be used to force early abort of a stream read/write process.
  36  *
  37  *  @{
  38  */
  39
  40 #ifndef __STREAMCALLBACK_H__
  41 #define __STREAMCALLBACK_H__
  42
  43         /* Public Interface - May be used in end-application: */
  44                 /* Macros: */
  45                         /** Creates a prototype for or begins a stream callback routine. Stream callback routines are small
  46                          *  routines which are executed during stream read or writes (if the callback-enabled versions of
  47                          *  these functions are used) which allow the user application to abort the transfer when certain
  48                          *  arbitrary conditions are met.
  49                          *
  50                          *  Stream callback functions should return a value from the StreamCallback_Return_ErrorCodes_t
  51                          *  enum.
  52                          *
  53                          *  Usage Example (Device Endpoint, but applicable for Host Pipes also):
  54                          *  \code
  55                          *  STREAM_CALLBACK(GlobalNotSet); // Callback Prototype
  56                          *
  57                          *  STREAM_CALLBACK(GlobalNotSet)
  58                          *  {
  59                          *     if (MyGlobal == false)
  60                          *         return ENDPOINT_STREAMCALLBACK_Continue;
  61                          *     else
  62                          *         return ENDPOINT_STREAMCALLBACK_Abort;
  63                          *  }
  64                          *
  65                          *  //...
  66                          *  // Inside some routine:
  67                          *  if (Endpoint_Write_Stream_LE(DataBuffer, sizeof(DataBuffer), GlobalNotSet) ==
  68                          *                               ENDPOINT_RWSTREAM_ERROR_CallbackAborted)
  69                          *  {
  70                          *      // Do something when the callback aborted the transfer early
  71                          *  }
  72                          *  \endcode
  73                          */
  74                         #define STREAM_CALLBACK(name) uint8_t name (void)
  75
  76                         /** Used with the Endpoint and Pipe stream functions as the callback function parameter, indicating that the stream
  77                          *  call has no callback function to be called between USB packets.
  78                          */
  79                         #define NO_STREAM_CALLBACK    NULL
  80
  81                 /* Enums: */
  82                         /** Enum for the possible error return codes of a stream callback function */
  83                         enum StreamCallback_Return_ErrorCodes_t
  84                         {
  85                                 STREAMCALLBACK_Continue            = 0, /**< Continue sending or receiving the stream. */
  86                                 STREAMCALLBACK_Abort               = 1, /**< Abort the stream send or receiving process. */
  87                         };
  88
  89 #endif
  90
  91 /** @} */