LUFA/Drivers/USB/Core/Pipe.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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 /** \file
  32  *  \brief USB host pipe management definitions.
  33  *
  34  *  This file contains structures, function prototypes and macros related to the management of the device's
  35  *  data pipes when the library is initialized in USB host mode.
  36  *
  37  *  \note This file should not be included directly. It is automatically included as needed by the USB driver
  38  *        dispatch header located in LUFA/Drivers/USB/USB.h.
  39  */
  40
  41 /** \ingroup Group_PipeManagement
  42  *  \defgroup Group_PipeRW Pipe Data Reading and Writing
  43  *
  44  *  Functions, macros, variables, enums and types related to data reading and writing from and to pipes.
  45  */
  46
  47 /** \ingroup Group_PipeRW
  48  *  \defgroup Group_PipePrimitiveRW Read/Write of Primitive Data Types
  49  *
  50  *  Functions, macros, variables, enums and types related to data reading and writing of primitive data types
  51  *  from and to pipes.
  52  */
  53
  54 /** \ingroup Group_PipeManagement
  55  *  \defgroup Group_PipePacketManagement Pipe Packet Management
  56  *
  57  *  Functions, macros, variables, enums and types related to packet management of pipes.
  58  */
  59
  60 /** \ingroup Group_PipeManagement
  61  *  \defgroup Group_PipeControlReq Pipe Control Request Management
  62  *
  63  *  Module for host mode request processing. This module allows for the transmission of standard, class and
  64  *  vendor control requests to the default control endpoint of an attached device while in host mode.
  65  *
  66  *  \see Chapter 9 of the USB 2.0 specification.
  67  */
  68
  69 /** \ingroup Group_USB
  70  *  \defgroup Group_PipeManagement Pipe Management
  71  *
  72  *  This module contains functions, macros and enums related to pipe management when in USB Host mode. This
  73  *  module contains the pipe management macros, as well as pipe interrupt and data send/receive functions
  74  *  for various data types.
  75  *
  76  *  @{
  77  */
  78
  79 #ifndef __PIPE_H__
  80 #define __PIPE_H__
  81
  82         /* Includes: */
  83                 #include "../../../Common/Common.h"
  84
  85                 #if (ARCH == ARCH_AVR8)
  86                         #include "AVR8/Pipe.h"
  87                 #endif
  88
  89         /* Preprocessor Checks: */
  90                 #if !defined(__INCLUDE_FROM_USB_DRIVER)
  91                         #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
  92                 #endif
  93
  94 #endif
  95
  96 /** @} */
  97