Add FatFS library to the Webserver project, extend the HTTP server so that it now...

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

diff --git a/LUFA/Drivers/USB/Class/Common/RNDIS.h b/LUFA/Drivers/USB/Class/Common/RNDIS.h
index abc1733..ef98ccd 100644 (file)
--- a/LUFA/Drivers/USB/Class/Common/RNDIS.h
+++ b/LUFA/Drivers/USB/Class/Common/RNDIS.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


@@ -29,6 +29,12 @@
 */\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
  *  @{\r
  */\r
 \r


@@ -37,6 +43,8 @@
 \r
        /* Includes: */\r
                #include "../../USB.h"\r
 \r
        /* Includes: */\r
                #include "../../USB.h"\r

+               #include "CDC.h"\r
+               #include "RNDISConstants.h"\r

                \r
                #include <string.h>\r
        \r
                \r
                #include <string.h>\r
        \r


@@ -61,7 +69,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


@@ -93,13 +101,6 @@
                        uint8_t       Octets[6]; /**< Individual bytes of a MAC address */\r
                } MAC_Address_t;\r
 \r
                        uint8_t       Octets[6]; /**< Individual bytes of a MAC address */\r
                } MAC_Address_t;\r
 \r

-               /** Type define for a RNDIS message header, sent before RNDIS messages */\r
-               typedef struct\r
-               {\r
-                       uint32_t MessageType; /**< RNDIS message type, a REMOTE_NDIS_*_MSG constant */\r
-                       uint32_t MessageLength; /**< Total length of the RNDIS message, in bytes */\r
-               } RNDIS_Message_Header_t;\r
-\r

                /** Type define for an Ethernet frame buffer. */\r
                typedef struct\r
                {\r
                /** Type define for an Ethernet frame buffer. */\r
                typedef struct\r
                {\r


@@ -108,6 +109,13 @@
                        bool          FrameInBuffer; /**< Indicates if a frame is currently stored in the buffer */\r
                } Ethernet_Frame_Info_t;\r
 \r
                        bool          FrameInBuffer; /**< Indicates if a frame is currently stored in the buffer */\r
                } Ethernet_Frame_Info_t;\r
 \r

+               /** Type define for a RNDIS message header, sent before RNDIS messages */\r
+               typedef struct\r
+               {\r
+                       uint32_t MessageType; /**< RNDIS message type, a REMOTE_NDIS_*_MSG constant */\r
+                       uint32_t MessageLength; /**< Total length of the RNDIS message, in bytes */\r
+               } RNDIS_Message_Header_t;\r
+\r

                /** Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter */\r
                typedef struct\r
                {\r
                /** Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter */\r
                typedef struct\r
                {\r


@@ -122,7 +130,7 @@
                        uint32_t PerPacketInfoLength;\r
                        uint32_t VcHandle;\r
                        uint32_t Reserved;\r
                        uint32_t PerPacketInfoLength;\r
                        uint32_t VcHandle;\r
                        uint32_t Reserved;\r

-               } RNDIS_PACKET_MSG_t;\r
+               } RNDIS_Packet_Message_t;\r

 \r
                /** Type define for a RNDIS Initialize command message */\r
                typedef struct\r
 \r
                /** Type define for a RNDIS Initialize command message */\r
                typedef struct\r


@@ -134,7 +142,7 @@
                        uint32_t MajorVersion;\r
                        uint32_t MinorVersion;\r
                        uint32_t MaxTransferSize;\r
                        uint32_t MajorVersion;\r
                        uint32_t MinorVersion;\r
                        uint32_t MaxTransferSize;\r

-               } RNDIS_INITIALIZE_MSG_t;\r
+               } RNDIS_Initialize_Message_t;\r

                \r
                /** Type define for a RNDIS Initialize complete response message */\r
                typedef struct\r
                \r
                /** Type define for a RNDIS Initialize complete response message */\r
                typedef struct\r


@@ -153,7 +161,7 @@
                        uint32_t PacketAlignmentFactor;\r
                        uint32_t AFListOffset;\r
                        uint32_t AFListSize;\r
                        uint32_t PacketAlignmentFactor;\r
                        uint32_t AFListOffset;\r
                        uint32_t AFListSize;\r

-               } RNDIS_INITIALIZE_CMPLT_t;\r
+               } RNDIS_Initialize_Complete_t;\r

                \r
                /** Type define for a RNDIS Keepalive command message */\r
                typedef struct\r
                \r
                /** Type define for a RNDIS Keepalive command message */\r
                typedef struct\r


@@ -161,7 +169,7 @@
                        uint32_t MessageType;\r
                        uint32_t MessageLength;\r
                        uint32_t RequestId;\r
                        uint32_t MessageType;\r
                        uint32_t MessageLength;\r
                        uint32_t RequestId;\r

-               } RNDIS_KEEPALIVE_MSG_t;\r
+               } RNDIS_KeepAlive_Message_t;\r

 \r
                /** Type define for a RNDIS Keepalive complete message */\r
                typedef struct\r
 \r
                /** Type define for a RNDIS Keepalive complete message */\r
                typedef struct\r


@@ -170,7 +178,7 @@
                        uint32_t MessageLength;\r
                        uint32_t RequestId;\r
                        uint32_t Status;\r
                        uint32_t MessageLength;\r
                        uint32_t RequestId;\r
                        uint32_t Status;\r

-               } RNDIS_KEEPALIVE_CMPLT_t;\r
+               } RNDIS_KeepAlive_Complete_t;\r

 \r
                /** Type define for a RNDIS Reset complete message */\r
                typedef struct\r
 \r
                /** Type define for a RNDIS Reset complete message */\r
                typedef struct\r


@@ -180,7 +188,7 @@
                        uint32_t Status;\r
 \r
                        uint32_t AddressingReset;\r
                        uint32_t Status;\r
 \r
                        uint32_t AddressingReset;\r

-               } RNDIS_RESET_CMPLT_t;\r
+               } RNDIS_Reset_Complete_t;\r

                \r
                /** Type define for a RNDIS Set command message */\r
                typedef struct\r
                \r
                /** Type define for a RNDIS Set command message */\r
                typedef struct\r


@@ -193,7 +201,7 @@
                        uint32_t InformationBufferLength;\r
                        uint32_t InformationBufferOffset;\r
                        uint32_t DeviceVcHandle;\r
                        uint32_t InformationBufferLength;\r
                        uint32_t InformationBufferOffset;\r
                        uint32_t DeviceVcHandle;\r

-               } RNDIS_SET_MSG_t;\r
+               } RNDIS_Set_Message_t;\r

 \r
                /** Type define for a RNDIS Set complete response message */\r
                typedef struct\r
 \r
                /** Type define for a RNDIS Set complete response message */\r
                typedef struct\r


@@ -202,7 +210,7 @@
                        uint32_t MessageLength;\r
                        uint32_t RequestId;\r
                        uint32_t Status;\r
                        uint32_t MessageLength;\r
                        uint32_t RequestId;\r
                        uint32_t Status;\r

-               } RNDIS_SET_CMPLT_t;\r
+               } RNDIS_Set_Complete_t;\r

                \r
                /** Type define for a RNDIS Query command message */\r
                typedef struct\r
                \r
                /** Type define for a RNDIS Query command message */\r
                typedef struct\r


@@ -215,7 +223,7 @@
                        uint32_t InformationBufferLength;\r
                        uint32_t InformationBufferOffset;\r
                        uint32_t DeviceVcHandle;\r
                        uint32_t InformationBufferLength;\r
                        uint32_t InformationBufferOffset;\r
                        uint32_t DeviceVcHandle;\r

-               } RNDIS_QUERY_MSG_t;\r
+               } RNDIS_Query_Message_t;\r

                \r
                /** Type define for a RNDIS Query complete response message */\r
                typedef struct\r
                \r
                /** Type define for a RNDIS Query complete response message */\r
                typedef struct\r


@@ -227,42 +235,7 @@
                        \r
                        uint32_t InformationBufferLength;\r
                        uint32_t InformationBufferOffset;\r
                        \r
                        uint32_t InformationBufferLength;\r
                        uint32_t InformationBufferOffset;\r

-               } RNDIS_QUERY_CMPLT_t;\r
-\r
-               /** Class state structure. An instance of this structure should be made for each RNDIS interface\r
-                *  within the user application, and passed to each of the RNDIS class driver functions as the\r
-                *  RNDISInterfaceInfo parameter. The contents of this structure should be set to their correct\r
-                *  values when used, or ommitted to force the library to use default values.\r
-                */\r
-               typedef struct\r
-               {\r
-                       uint8_t  ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */\r
-\r
-                       uint8_t  DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint */\r
-                       uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint */\r
-\r
-                       uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint */\r
-                       uint16_t DataOUTEndpointSize;  /**< Size in bytes of the CDC interface's OUT data endpoint */\r
-\r
-                       uint8_t  NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used */\r
-                       uint16_t NotificationEndpointSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used */\r
-                       \r
-                       char*         AdapterVendorDescription; /**< String description of the adapter vendor */\r
-                       MAC_Address_t AdapterMACAddress; /**< MAC address of the adapter */\r
-\r
-                       uint8_t  RNDISMessageBuffer[RNDIS_MESSAGE_BUFFER_SIZE]; /**< Buffer to hold RNDIS messages to and from the host,\r
-                                                                                *   managed by the class driver\r
-                                                                                */\r
-                       bool     ResponseReady; /**< Internal flag indicating if a RNDIS message is waiting to be returned to the host */\r
-                       uint8_t  CurrRNDISState; /**< Current RNDIS state of the adapter, a value from the RNDIS_States_t enum */\r
-                       uint32_t CurrPacketFilter; /**< Current packet filter mode, used internally by the class driver */\r
-                       Ethernet_Frame_Info_t FrameIN; /**< Structure holding the last received Ethernet frame from the host, for user\r
-                                                       *   processing\r
-                                                       */\r
-                       Ethernet_Frame_Info_t FrameOUT; /**< Structure holding the next Ethernet frame to send to the host, populated by the\r
-                                                        *   user application\r
-                                                        */\r
-               } USB_ClassInfo_RNDIS_t;\r
+               } RNDIS_Query_Complete_t;\r

                                \r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                                \r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r