Move DHCP negotiation timer into the DHCP connection application state structure...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Common / RNDIS.h
index 88ee04f..258604d 100644 (file)
@@ -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
 */\r
 \r
 /** \ingroup Group_USBClassRNDIS\r
 */\r
 \r
 /** \ingroup Group_USBClassRNDIS\r
+ *  @defgroup Group_USBClassRNDISCommon  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
+ *  RNDIS Class.\r
+ *\r
  *  @{\r
  */\r
 \r
 #ifndef _RNDIS_CLASS_COMMON_H_\r
 #define _RNDIS_CLASS_COMMON_H_\r
 \r
  *  @{\r
  */\r
 \r
 #ifndef _RNDIS_CLASS_COMMON_H_\r
 #define _RNDIS_CLASS_COMMON_H_\r
 \r
+       /* Macros: */\r
+               #define __INCLUDE_FROM_CDC_DRIVER\r
+\r
        /* Includes: */\r
                #include "../../USB.h"\r
        /* Includes: */\r
                #include "../../USB.h"\r
+               #include "RNDISConstants.h"\r
                #include "CDC.h"\r
                \r
                #include <string.h>\r
                #include "CDC.h"\r
                \r
                #include <string.h>\r
                        extern "C" {\r
                #endif\r
 \r
                        extern "C" {\r
                #endif\r
 \r
+       /* Preprocessor Checks: */\r
+               #if !defined(__INCLUDE_FROM_RNDIS_DRIVER)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/Class/RNDIS.h instead.\r
+               #endif\r
+               \r
        /* Macros: */\r
                /** Implemented RNDIS Version Major */\r
                #define REMOTE_NDIS_VERSION_MAJOR             0x01\r
        /* Macros: */\r
                /** Implemented RNDIS Version Major */\r
                #define REMOTE_NDIS_VERSION_MAJOR             0x01\r
@@ -62,7 +77,7 @@
                /** Maximum size in bytes of a RNDIS control message which can be sent or received */\r
                #define RNDIS_MESSAGE_BUFFER_SIZE             128\r
 \r
                /** Maximum size in bytes of a RNDIS control message which can be sent or received */\r
                #define RNDIS_MESSAGE_BUFFER_SIZE             128\r
 \r
-               /** Maximum size in bytes of an Ethernet frame which can be sent or received */\r
+               /** Maximum size in bytes of an Ethernet frame according to the Ethernet standard */\r
                #define ETHERNET_FRAME_SIZE_MAX               1500\r
                \r
                /** Notification request value for a RNDIS Response Available notification */\r
                #define ETHERNET_FRAME_SIZE_MAX               1500\r
                \r
                /** Notification request value for a RNDIS Response Available notification */\r