You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
86 lines
3.3 KiB
86 lines
3.3 KiB
/* |
|
LUFA Library |
|
Copyright (C) Dean Camera, 2010. |
|
|
|
dean [at] fourwalledcubicle [dot] com |
|
www.fourwalledcubicle.com |
|
*/ |
|
|
|
/* |
|
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 |
|
|
|
/** @} */
|
|
|