Fix spelling of the MissileLauncher project directory.

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

diff --git a/LUFA/Drivers/USB/Class/Device/RNDIS.h b/LUFA/Drivers/USB/Class/Device/RNDIS.h
index d0d66f8..49700a1 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/RNDIS.h
+++ b/LUFA/Drivers/USB/Class/Device/RNDIS.h
@@ -28,287 +28,126 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

-/** \ingroup Group_USBDeviceClassDrivers\r
- *  @defgroup Group_USBClassRNDISDevice RNDIS Device Class Driver - LUFA/Drivers/Class/Device/RNDIS.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
- *    - LUFA/Drivers/USB/Class/Device/RNDIS.c\r
+/** \ingroup Group_USBClassRNDIS\r
+ *  @defgroup Group_USBClassRNDISDevice RNDIS Class Device Mode Driver\r

  *\r
  *  \section Module Description\r
  *\r
  *  \section Module Description\r

- *  Functions, macros, variables, enums and types related to the management of USB RNDIS Ethernet\r
- *  interfaces within a USB device.\r
+ *  Device Mode USB Class driver framework interface, for the RNDIS USB Class driver.\r

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

-#ifndef _RNDIS_CLASS_H_\r
-#define _RNDIS_CLASS_H_\r
+#ifndef _RNDIS_CLASS_DEVICE_H_\r
+#define _RNDIS_CLASS_DEVICE_H_\r

 \r
        /* Includes: */\r
 \r
        /* Includes: */\r

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

                #include "../../USB.h"\r
                #include "../../USB.h"\r

+               #include "../Common/RNDIS.h"\r

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

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

        /* Enable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        extern "C" {\r
                #endif\r
 \r
        /* Enable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        extern "C" {\r
                #endif\r
 \r

-       /* Macros: */\r
-               /** Implemented RNDIS Version Major */\r
-               #define REMOTE_NDIS_VERSION_MAJOR             0x01\r
-\r
-               /** Implemented RNDIS Version Minor */\r
-               #define REMOTE_NDIS_VERSION_MINOR             0x00\r
-       \r
-               /** RNDIS request to issue a host-to-device NDIS command */\r
-               #define REQ_SendEncapsulatedCommand           0x00\r
-\r
-               /** RNDIS request to issue a device-to-host NDIS response */\r
-               #define REQ_GetEncapsulatedResponse           0x01\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
-               #define ETHERNET_FRAME_SIZE_MAX               1500\r
-               \r
-               /** Notification request value for a RNDIS Response Available notification */\r
-               #define NOTIF_ResponseAvailable               1\r
-               \r
-       /* Enums: */\r
-               /** Enum for the possible NDIS adapter states. */\r
-               enum RNDIS_States_t\r
-               {\r
-                       RNDIS_Uninitialized    = 0, /**< Adapter currently uninitialized */\r
-                       RNDIS_Initialized      = 1, /**< Adapter currently initialized but not ready for data transfers */\r
-                       RNDIS_Data_Initialized = 2, /**< Adapter currently initialized and ready for data transfers */\r
-               };\r
-\r
-               /** Enum for the NDIS hardware states */\r
-               enum NDIS_Hardware_Status_t\r
-               {\r
-                       NDIS_HardwareStatus_Ready, /**< Hardware Ready to accept commands from the host */\r
-                       NDIS_HardwareStatus_Initializing, /**< Hardware busy initializing */\r
-                       NDIS_HardwareStatus_Reset, /**< Hardware reset */\r
-                       NDIS_HardwareStatus_Closing, /**< Hardware currently closing */\r
-                       NDIS_HardwareStatus_NotReady /**< Hardware not ready to accept commands from the host */\r
-               };\r
-               \r
-       /* Type Defines: */\r
-               /** Type define for a physical MAC address of a device on a network */\r
-               typedef struct\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
+       /* Public Interface - May be used in end-application: */\r
+               /* Type Defines: */\r
+                       /** Configuration information structure for \ref USB_ClassInfo_RNDIS_Device_t RNDIS device interface structures. */\r
+                       typedef struct\r
+                       {\r
+                               uint8_t  ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */\r

 \r
 \r

-               /** Type define for an Ethernet frame buffer. */\r
-               typedef struct\r
-               {\r
-                       uint8_t       FrameData[ETHERNET_FRAME_SIZE_MAX]; /**< Ethernet frame contents */\r
-                       uint16_t      FrameLength; /**< Length in bytes of the Ethernet frame stored in the buffer */\r
-                       bool          FrameInBuffer; /**< Indicates if a frame is currently stored in the buffer */\r
-               } Ethernet_Frame_Info_t;\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
 \r

-               /** Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter */\r
-               typedef struct\r
-               {\r
-                       uint32_t MessageType;\r
-                       uint32_t MessageLength;\r
-                       uint32_t DataOffset;\r
-                       uint32_t DataLength;\r
-                       uint32_t OOBDataOffset;\r
-                       uint32_t OOBDataLength;\r
-                       uint32_t NumOOBDataElements;\r
-                       uint32_t PerPacketInfoOffset;\r
-                       uint32_t PerPacketInfoLength;\r
-                       uint32_t VcHandle;\r
-                       uint32_t Reserved;\r
-               } RNDIS_PACKET_MSG_t;\r
-\r
-               /** Type define for a RNDIS Initialize command message */\r
-               typedef struct\r
-               {\r
-                       uint32_t MessageType;\r
-                       uint32_t MessageLength;\r
-                       uint32_t RequestId;\r
-                       \r
-                       uint32_t MajorVersion;\r
-                       uint32_t MinorVersion;\r
-                       uint32_t MaxTransferSize;\r
-               } RNDIS_INITIALIZE_MSG_t;\r
-               \r
-               /** Type define for a RNDIS Initialize complete response message */\r
-               typedef struct\r
-               {\r
-                       uint32_t MessageType;\r
-                       uint32_t MessageLength;\r
-                       uint32_t RequestId;\r
-                       uint32_t Status;\r
-                       \r
-                       uint32_t MajorVersion;\r
-                       uint32_t MinorVersion;\r
-                       uint32_t DeviceFlags;\r
-                       uint32_t Medium;\r
-                       uint32_t MaxPacketsPerTransfer;\r
-                       uint32_t MaxTransferSize;\r
-                       uint32_t PacketAlignmentFactor;\r
-                       uint32_t AFListOffset;\r
-                       uint32_t AFListSize;\r
-               } RNDIS_INITIALIZE_CMPLT_t;\r
-               \r
-               /** Type define for a RNDIS Keepalive command message */\r
-               typedef struct\r
-               {\r
-                       uint32_t MessageType;\r
-                       uint32_t MessageLength;\r
-                       uint32_t RequestId;\r
-               } RNDIS_KEEPALIVE_MSG_t;\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
 \r

-               /** Type define for a RNDIS Keepalive complete message */\r
-               typedef struct\r
-               {\r
-                       uint32_t MessageType;\r
-                       uint32_t MessageLength;\r
-                       uint32_t RequestId;\r
-                       uint32_t Status;\r
-               } RNDIS_KEEPALIVE_CMPLT_t;\r
-\r
-               /** Type define for a RNDIS Reset complete message */\r
-               typedef struct\r
-               {\r
-                       uint32_t MessageType;\r
-                       uint32_t MessageLength;\r
-                       uint32_t Status;\r
-\r
-                       uint32_t AddressingReset;\r
-               } RNDIS_RESET_CMPLT_t;\r
-               \r
-               /** Type define for a RNDIS Set command message */\r
-               typedef struct\r
-               {\r
-                       uint32_t MessageType;\r
-                       uint32_t MessageLength;\r
-                       uint32_t RequestId;\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
+                       } USB_ClassInfo_MS_Device_Config_t;\r

                        \r
                        \r

-                       uint32_t Oid;\r
-                       uint32_t InformationBufferLength;\r
-                       uint32_t InformationBufferOffset;\r
-                       uint32_t DeviceVcHandle;\r
-               } RNDIS_SET_MSG_t;\r
-\r
-               /** Type define for a RNDIS Set complete response message */\r
-               typedef struct\r
-               {\r
-                       uint32_t MessageType;\r
-                       uint32_t MessageLength;\r
-                       uint32_t RequestId;\r
-                       uint32_t Status;\r
-               } RNDIS_SET_CMPLT_t;\r
-               \r
-               /** Type define for a RNDIS Query command message */\r
-               typedef struct\r
-               {\r
-                       uint32_t MessageType;\r
-                       uint32_t MessageLength;\r
-                       uint32_t RequestId;\r
+                       /** Current State information structure for \ref USB_ClassInfo_RNDIS_Device_t RNDIS device interface structures. */\r
+                       typedef struct\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_MS_Device_State_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. This stores each RNDIS interface's configuration and state information.\r
+                        */\r
+                       typedef struct\r
+                       {\r
+                               const USB_ClassInfo_MS_Device_Config_t Config; /**< Config data for the USB class interface within\r
+                                                                               *   the device. All elements in this section\r
+                                                                               *   <b>must</b> be set or the interface will fail\r
+                                                                               *   to enumerate and operate correctly.\r
+                                                                               */\r
+                                                                                                                        \r
+                               USB_ClassInfo_MS_Device_State_t State; /**< State data for the USB class interface within\r
+                                                                       *   the device. All elements in this section\r
+                                                                       *   <b>may</b> be set to initial values, but may\r
+                                                                       *   also be ignored to default to sane values when\r
+                                                                       *   the interface is enumerated.\r
+                                                                       */\r
+                       } USB_ClassInfo_RNDIS_Device_t;\r
+       \r
+               /* Function Prototypes: */\r
+                       /** Configures the endpoints of a given RNDIS interface, ready for use. This should be linked to the library\r
+                        *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
+                        *  containing the given HID interface is selected.\r
+                        *\r
+                        *  \param RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.\r
+                        *\r
+                        *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
+                        */\r
+                       bool RNDIS_Device_ConfigureEndpoints(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo);\r
+\r
+                       /** Processes incomming control requests from the host, that are directed to the given RNDIS class interface. This should be\r
+                        *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
+                        *\r
+                        *  \param RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.\r
+                        */             \r
+                       void RNDIS_Device_ProcessControlPacket(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo);\r

                        \r
                        \r

-                       uint32_t Oid;\r
-                       uint32_t InformationBufferLength;\r
-                       uint32_t InformationBufferOffset;\r
-                       uint32_t DeviceVcHandle;\r
-               } RNDIS_QUERY_MSG_t;\r
+                       /** General management task for a given HID class interface, required for the correct operation of the interface. This should\r
+                        *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
+                        *\r
+                        *  \param RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.\r
+                        */\r
+                       void RNDIS_Device_USBTask(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo);\r

                \r
                \r

-               /** Type define for a RNDIS Query complete response message */\r
-               typedef struct\r
-               {\r
-                       uint32_t MessageType;\r
-                       uint32_t MessageLength;\r
-                       uint32_t RequestId;\r
-                       uint32_t Status;\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
-                               \r
-       /* Function Prototypes: */\r
-               #if defined(INCLUDE_FROM_RNDIS_CLASS_C)\r
-                       static void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo);\r
-                       static bool RNDIS_Device_ProcessNDISQuery(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo, \r
+       /* Private Interface - For use in library only: */\r
+       #if !defined(__DOXYGEN__)\r
+               /* Function Prototypes: */\r
+               #if defined(INCLUDE_FROM_RNDIS_CLASS_DEVICE_C)\r
+                       static void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo);\r
+                       static bool RNDIS_Device_ProcessNDISQuery(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo, \r

                                                                  uint32_t OId, void* QueryData, uint16_t QuerySize,\r
                                                                                              void* ResponseData, uint16_t* ResponseSize);\r
                                                                  uint32_t OId, void* QueryData, uint16_t QuerySize,\r
                                                                                              void* ResponseData, uint16_t* ResponseSize);\r

-                       static bool RNDIS_Device_ProcessNDISSet(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo, uint32_t OId,\r
+                       static bool RNDIS_Device_ProcessNDISSet(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo, uint32_t OId,\r

                                                                void* SetData, uint16_t SetSize);       \r
                #endif\r
                                                                void* SetData, uint16_t SetSize);       \r
                #endif\r

-\r
-               /** Configures the endpoints of a given RNDIS interface, ready for use. This should be linked to the library\r
-                *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
-                *  containing the given HID interface is selected.\r
-                *\r
-                *  \param RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.\r
-                *\r
-                *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
-                */\r
-               bool RNDIS_Device_ConfigureEndpoints(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo);\r
-\r
-               /** Processes incomming control requests from the host, that are directed to the given RNDIS class interface. This should be\r
-                *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
-                *\r
-                *  \param RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.\r
-                */             \r
-               void RNDIS_Device_ProcessControlPacket(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo);\r
-               \r
-               /** General management task for a given HID class interface, required for the correct operation of the interface. This should\r
-                *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
-                *\r
-                *  \param RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.\r
-                */\r
-               void RNDIS_Device_USBTask(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo);\r

                \r
                \r

+       #endif\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
                        }\r