protocol/lufa/LUFA-120730/LUFA/Drivers/USB/Class/CDCClass.h

   1 /*\r
   2              LUFA Library\r
   3      Copyright (C) Dean Camera, 2012.\r
   4 \r
   5   dean [at] fourwalledcubicle [dot] com\r
   6            www.lufa-lib.org\r
   7 */\r
   8 \r
   9 /*\r
  10   Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
  11 \r
  12   Permission to use, copy, modify, distribute, and sell this\r
  13   software and its documentation for any purpose is hereby granted\r
  14   without fee, provided that the above copyright notice appear in\r
  15   all copies and that both that the copyright notice and this\r
  16   permission notice and warranty disclaimer appear in supporting\r
  17   documentation, and that the name of the author not be used in\r
  18   advertising or publicity pertaining to distribution of the\r
  19   software without specific, written prior permission.\r
  20 \r
  21   The author disclaim all warranties with regard to this\r
  22   software, including all implied warranties of merchantability\r
  23   and fitness.  In no event shall the author be liable for any\r
  24   special, indirect or consequential damages or any damages\r
  25   whatsoever resulting from loss of use, data or profits, whether\r
  26   in an action of contract, negligence or other tortious action,\r
  27   arising out of or in connection with the use or performance of\r
  28   this software.\r
  29 */\r
  30 \r
  31 /** \file\r
  32  *  \brief Master include file for the library USB CDC-ACM Class driver.\r
  33  *\r
  34  *  Master include file for the library USB CDC Class driver, for both host and device modes, where available.\r
  35  *\r
  36  *  This file should be included in all user projects making use of this optional class driver, instead of\r
  37  *  including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.\r
  38  */\r
  39 \r
  40 /** \ingroup Group_USBClassDrivers\r
  41  *  \defgroup Group_USBClassCDC CDC-ACM (Virtual Serial) Class Driver\r
  42  *\r
  43  *  \section Sec_Dependencies Module Source Dependencies\r
  44  *  The following files must be built with any user project that uses this module:\r
  45  *    - LUFA/Drivers/USB/Class/Device/CDCClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>\r
  46  *    - LUFA/Drivers/USB/Class/Host/CDCClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>\r
  47  *\r
  48  *  \section Sec_ModDescription Module Description\r
  49  *  CDC Class Driver module. This module contains an internal implementation of the USB CDC-ACM class Virtual Serial\r
  50  *  Ports, for both Device and Host USB modes. User applications can use this class driver instead of implementing the\r
  51  *  CDC class manually via the low-level LUFA APIs.\r
  52  *\r
  53  *  This module is designed to simplify the user code by exposing only the required interface needed to interface with\r
  54  *  Hosts or Devices using the USB CDC Class.\r
  55  *\r
  56  *  @{\r
  57  */\r
  58 \r
  59 #ifndef _CDC_CLASS_H_\r
  60 #define _CDC_CLASS_H_\r
  61 \r
  62         /* Macros: */\r
  63                 #define __INCLUDE_FROM_USB_DRIVER\r
  64                 #define __INCLUDE_FROM_CDC_DRIVER\r
  65 \r
  66         /* Includes: */\r
  67                 #include "../Core/USBMode.h"\r
  68 \r
  69                 #if defined(USB_CAN_BE_DEVICE)\r
  70                         #include "Device/CDCClassDevice.h"\r
  71                 #endif\r
  72 \r
  73                 #if defined(USB_CAN_BE_HOST)\r
  74                         #include "Host/CDCClassHost.h"\r
  75                 #endif\r
  76 \r
  77 #endif\r
  78 \r
  79 /** @} */\r
  80 \r