LUFA/Drivers/USB/HighLevel/StreamCallbacks.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all 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. Each callback
  36  *  should take no arguments, and return a value from the \ref StreamCallback_Return_ErrorCodes_t enum.
  37  *
  38  *  @{
  39  */
  40
  41 #ifndef __STREAMCALLBACK_H__
  42 #define __STREAMCALLBACK_H__
  43
  44         /* Preprocessor Checks: */
  45                 #if !defined(__INCLUDE_FROM_USB_DRIVER)
  46                         #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
  47                 #endif
  48
  49         /* Public Interface - May be used in end-application: */
  50                 /* Macros: */
  51                         /** Used with the Endpoint and Pipe stream functions as the callback function parameter, indicating that the stream
  52                          *  call has no callback function to be called between USB packets.
  53                          */
  54                         #define NO_STREAM_CALLBACK    NULL
  55
  56                 /* Enums: */
  57                         /** Enum for the possible error return codes of a stream callback function */
  58                         enum StreamCallback_Return_ErrorCodes_t
  59                         {
  60                                 STREAMCALLBACK_Continue            = 0, /**< Continue sending or receiving the stream. */
  61                                 STREAMCALLBACK_Abort               = 1, /**< Abort the stream send or receiving process. */
  62                         };
  63
  64                 /* Type Defines: */
  65                         /** Type define for a Stream Callback function (function taking no arguments and retuning a
  66                          *  uint8_t value). Stream callback functions should have an identical function signature if they
  67                          *  are to be used as the callback parameter of the stream functions.
  68                          */
  69                         typedef uint8_t (* const StreamCallbackPtr_t)(void);
  70
  71 #endif
  72
  73 /** @} */