Bluetooth demo can now create and maintain logical channels - need to determine why...

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

diff --git a/LUFA/Drivers/USB/Class/Common/CDC.h b/LUFA/Drivers/USB/Class/Common/CDC.h
index 5138032..cef7a4c 100644 (file)
--- a/LUFA/Drivers/USB/Class/Common/CDC.h
+++ b/LUFA/Drivers/USB/Class/Common/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,7 +28,22 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

+/** \file\r
+ *  \brief Common definitions and declarations for the library USB CDC Class driver.\r
+ *\r
+ *  Common definitions and declarations for the library USB CDC Class driver.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ *        dispatch header located in LUFA/Drivers/USB/Class/CDC.h.\r
+ */\r
+\r

 /** \ingroup Group_USBClassCDC\r
 /** \ingroup Group_USBClassCDC\r

+ *  @defgroup Group_USBClassCDCCommon  Common Class Definitions\r
+ *\r
+ *  \section Module Description\r
+ *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB\r
+ *  CDC Class.\r
+ *\r

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


@@ -45,6 +60,11 @@
                        extern "C" {\r
                #endif\r
 \r
                        extern "C" {\r
                #endif\r
 \r

+       /* Preprocessor Checks: */\r
+               #if !defined(__INCLUDE_FROM_CDC_DRIVER)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/Class/CDC.h instead.\r
+               #endif\r
+               \r

        /* Macros: */\r
                /** CDC Class specific request to get the current virtual serial port configuration settings. */\r
                #define REQ_GetLineEncoding              0x21\r
        /* Macros: */\r
                /** CDC Class specific request to get the current virtual serial port configuration settings. */\r
                #define REQ_GetLineEncoding              0x21\r


@@ -111,7 +131,7 @@
                 *  a single typedef struct. A macro is used instead so that functional descriptors can be created\r
                 *  easily by specifying the size of the payload. This allows sizeof() to work correctly.\r
                 *\r
                 *  a single typedef struct. A macro is used instead so that functional descriptors can be created\r
                 *  easily by specifying the size of the payload. This allows sizeof() to work correctly.\r
                 *\r

-                *  \param DataSize  Size in bytes of the CDC functional descriptor's data payload\r
+                *  \param[in] DataSize  Size in bytes of the CDC functional descriptor's data payload\r

                 */\r
                #define CDC_FUNCTIONAL_DESCRIPTOR(DataSize)        \\r
                     struct                                        \\r
                 */\r
                #define CDC_FUNCTIONAL_DESCRIPTOR(DataSize)        \\r
                     struct                                        \\r