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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  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 disclaims 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 Master include file for the library USB CDC-ACM Class driver.
  33  *
  34  *  Master include file for the library USB CDC Class driver, for both host and device modes, where available.
  35  *
  36  *  This file should be included in all user projects making use of this optional class driver, instead of
  37  *  including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.
  38  */
  39
  40 /** \ingroup Group_USBClassDrivers
  41  *  \defgroup Group_USBClassCDC CDC-ACM (Virtual Serial) Class Driver
  42  *  \brief USB class driver for the USB-IF CDC-ACM (Virtual Serial) class standard.
  43  *
  44  *  \section Sec_USBClassCDC_Dependencies Module Source Dependencies
  45  *  The following files must be built with any user project that uses this module:
  46  *    - LUFA/Drivers/USB/Class/Device/CDCClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  47  *    - LUFA/Drivers/USB/Class/Host/CDCClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  48  *
  49  *  \section Sec_USBClassCDC_ModDescription Module Description
  50  *  CDC Class Driver module. This module contains an internal implementation of the USB CDC-ACM class Virtual Serial
  51  *  Ports, for both Device and Host USB modes. User applications can use this class driver instead of implementing the
  52  *  CDC class manually via the low-level LUFA APIs.
  53  *
  54  *  This module is designed to simplify the user code by exposing only the required interface needed to interface with
  55  *  Hosts or Devices using the USB CDC Class.
  56  *
  57  *  @{
  58  */
  59
  60 #ifndef _CDC_CLASS_H_
  61 #define _CDC_CLASS_H_
  62
  63         /* Macros: */
  64                 #define __INCLUDE_FROM_USB_DRIVER
  65                 #define __INCLUDE_FROM_CDC_DRIVER
  66
  67         /* Includes: */
  68                 #include "../Core/USBMode.h"
  69
  70                 #if defined(USB_CAN_BE_DEVICE)
  71                         #include "Device/CDCClassDevice.h"
  72                 #endif
  73
  74                 #if defined(USB_CAN_BE_HOST)
  75                         #include "Host/CDCClassHost.h"
  76                 #endif
  77
  78 #endif
  79
  80 /** @} */
  81