Add user callback function to the Bluetooth host demo to filter out connections from...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / CDC.h

diff --git a/LUFA/Drivers/USB/Class/CDC.h b/LUFA/Drivers/USB/Class/CDC.h
index 9cd3bcd..c5205aa 100644 (file)
--- a/LUFA/Drivers/USB/Class/CDC.h
+++ b/LUFA/Drivers/USB/Class/CDC.h
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r

               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r

-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r

   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -28,8 +28,17 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

+/** \file\r
+ *  \brief Master include file for the library USB CDC-ACM Class driver.\r
+ *\r
+ *  Master include file for the library USB CDC Class driver, for both host and device modes, where available.\r
+ *\r
+ *  This file should be included in all user projects making use of this optional class driver, instead of\r
+ *  including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.\r
+ */\r
+\r

 /** \ingroup Group_USBClassDrivers\r
 /** \ingroup Group_USBClassDrivers\r

- *  @defgroup Group_USBClassCDC CDC Device Class Driver - LUFA/Drivers/Class/CDC.h\r
+ *  @defgroup Group_USBClassCDC CDC-ACM (Virtual Serial) Class Driver - LUFA/Drivers/Class/CDC.h\r

  *\r
  *  \section Sec_Dependencies Module Source Dependencies\r
  *  The following files must be built with any user project that uses this module:\r
  *\r
  *  \section Sec_Dependencies Module Source Dependencies\r
  *  The following files must be built with any user project that uses this module:\r


@@ -37,8 +46,12 @@
  *    - LUFA/Drivers/USB/Class/Host/CDC.c\r
  *\r
  *  \section Module Description\r
  *    - LUFA/Drivers/USB/Class/Host/CDC.c\r
  *\r
  *  \section Module Description\r

- *  Functions, macros, variables, enums and types related to the management of USB CDC Class interfaces\r
- *  within a USB device, for the implementation of CDC-ACM virtual serial ports.\r
+ *  CDC Class Driver module. This module contains an internal implementation of the USB CDC-ACM class Virtual Serial\r
+ *  Ports, for both Device and Host USB modes. User applications can use this class driver instead of implementing the\r
+ *  CDC class manually via the low-level LUFA APIs.\r
+ *\r
+ *  This module is designed to simplify the user code by exposing only the required interface needed to interface with\r
+ *  Hosts or Devices using the USB CDC Class.\r

  *\r
  *  @{\r
  */\r
  *\r
  *  @{\r
  */\r


@@ -46,9 +59,17 @@
 #ifndef _CDC_CLASS_H_\r
 #define _CDC_CLASS_H_\r
 \r
 #ifndef _CDC_CLASS_H_\r
 #define _CDC_CLASS_H_\r
 \r

+       /* Macros: */\r
+               #define __INCLUDE_FROM_CDC_DRIVER\r
+               #define __INCLUDE_FROM_USB_DRIVER\r
+\r

        /* Includes: */\r
                #include "../HighLevel/USBMode.h"\r
 \r
        /* Includes: */\r
                #include "../HighLevel/USBMode.h"\r
 \r

+               #if defined(NO_STREAM_CALLBACKS)\r
+                       #error The NO_STREAM_CALLBACKS compile time option cannot be used in projects using the library Class drivers.\r
+               #endif\r
+\r

                #if defined(USB_CAN_BE_DEVICE)\r
                        #include "Device/CDC.h"\r
                #endif\r
                #if defined(USB_CAN_BE_DEVICE)\r
                        #include "Device/CDC.h"\r
                #endif\r