LUFA/Drivers/USB/Class/CDC.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 /** \file
  32  *  \brief Master include file for the library USB CDC-ACM Class driver.
  33  *
  34  *  This file should be included in all user projects making use of this optional class driver, instead of
  35  *  including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.
  36  */
  37
  38 /** \ingroup Group_USBClassDrivers
  39  *  @defgroup Group_USBClassCDC CDC-ACM (Virtual Serial) Class Driver - LUFA/Drivers/Class/CDC.h
  40  *
  41  *  \section Sec_Dependencies Module Source Dependencies
  42  *  The following files must be built with any user project that uses this module:
  43  *    - LUFA/Drivers/USB/Class/Device/CDC.c
  44  *    - LUFA/Drivers/USB/Class/Host/CDC.c
  45  *
  46  *  \section Module Description
  47  *  CDC Class Driver module. This module contains an internal implementation of the USB CDC-ACM class Virtual Serial
  48  *  Ports, for both Device and Host USB modes. User applications can use this class driver instead of implementing the
  49  *  CDC class manually via the low-level LUFA APIs.
  50  *
  51  *  This module is designed to simplify the user code by exposing only the required interface needed to interface with
  52  *  Hosts or Devices using the USB CDC Class.
  53  *
  54  *  @{
  55  */
  56
  57 #ifndef _CDC_CLASS_H_
  58 #define _CDC_CLASS_H_
  59
  60         /* Macros: */
  61                 #define __INCLUDE_FROM_CDC_DRIVER
  62                 #define __INCLUDE_FROM_USB_DRIVER
  63
  64         /* Includes: */
  65                 #include "../HighLevel/USBMode.h"
  66
  67                 #if defined(NO_STREAM_CALLBACKS)
  68                         #error The NO_STREAM_CALLBACKS compile time option cannot be used in projects using the library Class drivers.
  69                 #endif
  70
  71                 #if defined(USB_CAN_BE_DEVICE)
  72                         #include "Device/CDC.h"
  73                 #endif
  74
  75                 #if defined(USB_CAN_BE_HOST)
  76                         #include "Host/CDC.h"
  77                 #endif
  78
  79 #endif
  80
  81 /** @} */