X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/071e02c6b6b4837fa9cf0b6d4c749994e02638d7..accadba2dda2614d6a6669cb7eba9d8357274bfe:/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 ecbff5122..b9d50f93c 100644
--- a/LUFA/Drivers/USB/Class/Common/RNDIS.h
+++ b/LUFA/Drivers/USB/Class/Common/RNDIS.h
@@ -71,50 +71,54 @@
 		#endif
 		
 	/* Macros: */
-		/** Implemented RNDIS Version Major */
+		/** Implemented RNDIS Version Major. */
 		#define REMOTE_NDIS_VERSION_MAJOR             0x01
 
-		/** Implemented RNDIS Version Minor */
+		/** Implemented RNDIS Version Minor. */
 		#define REMOTE_NDIS_VERSION_MINOR             0x00
-	
-		/** RNDIS request to issue a host-to-device NDIS command */
-		#define REQ_SendEncapsulatedCommand           0x00
-
-		/** RNDIS request to issue a device-to-host NDIS response */
-		#define REQ_GetEncapsulatedResponse           0x01
-		
-		/** Maximum size in bytes of a RNDIS control message which can be sent or received */
+			
+		/** Maximum size in bytes of a RNDIS control message which can be sent or received. */
 		#define RNDIS_MESSAGE_BUFFER_SIZE             128
 
-		/** Maximum size in bytes of an Ethernet frame according to the Ethernet standard */
+		/** Maximum size in bytes of an Ethernet frame according to the Ethernet standard. */
 		#define ETHERNET_FRAME_SIZE_MAX               1500
 		
-		/** Notification request value for a RNDIS Response Available notification */
-		#define NOTIF_ResponseAvailable               1
-		
 	/* Enums: */
+		/** Enum for the RNDIS class specific control requests that can be issued by the USB bus host. */
+		enum RNDIS_ClassRequests_t
+		{
+			RNDIS_REQ_SendEncapsulatedCommand = 0x00, /**< RNDIS request to issue a host-to-device NDIS command. */
+			RNDIS_REQ_GetEncapsulatedResponse = 0x01, /**< RNDIS request to issue a device-to-host NDIS response. */
+		};
+		
 		/** Enum for the possible NDIS adapter states. */
 		enum RNDIS_States_t
 		{
-			RNDIS_Uninitialized    = 0, /**< Adapter currently uninitialized */
-			RNDIS_Initialized      = 1, /**< Adapter currently initialized but not ready for data transfers */
-			RNDIS_Data_Initialized = 2, /**< Adapter currently initialized and ready for data transfers */
+			RNDIS_Uninitialized    = 0, /**< Adapter currently uninitialized. */
+			RNDIS_Initialized      = 1, /**< Adapter currently initialized but not ready for data transfers. */
+			RNDIS_Data_Initialized = 2, /**< Adapter currently initialized and ready for data transfers. */
+		};
+
+		/** Enum for the RNDIS class specific notification requests that can be issued by a RNDIS device to a host. */
+		enum RNDIS_ClassNotifications_t
+		{
+			RNDIS_NOTIF_ResponseAvailable             = 0x01, /**< Notification request value for a RNDIS Response Available notification. */
 		};
 
-		/** Enum for the NDIS hardware states */
+		/** Enum for the NDIS hardware states. */
 		enum NDIS_Hardware_Status_t
 		{
-			NDIS_HardwareStatus_Ready, /**< Hardware Ready to accept commands from the host */
-			NDIS_HardwareStatus_Initializing, /**< Hardware busy initializing */
-			NDIS_HardwareStatus_Reset, /**< Hardware reset */
-			NDIS_HardwareStatus_Closing, /**< Hardware currently closing */
-			NDIS_HardwareStatus_NotReady /**< Hardware not ready to accept commands from the host */
+			NDIS_HardwareStatus_Ready, /**< Hardware Ready to accept commands from the host. */
+			NDIS_HardwareStatus_Initializing, /**< Hardware busy initializing. */
+			NDIS_HardwareStatus_Reset, /**< Hardware reset. */
+			NDIS_HardwareStatus_Closing, /**< Hardware currently closing. */
+			NDIS_HardwareStatus_NotReady /**< Hardware not ready to accept commands from the host. */
 		};
 		
 	/* Type Defines: */
 		/** \brief MAC Address Structure.
 		 *
-		 *  Type define for a physical MAC address of a device on a network
+		 *  Type define for a physical MAC address of a device on a network.
 		 */
 		typedef struct
 		{
@@ -127,9 +131,9 @@
 		 */
 		typedef struct
 		{
-			uint8_t       FrameData[ETHERNET_FRAME_SIZE_MAX]; /**< Ethernet frame contents */
-			uint16_t      FrameLength; /**< Length in bytes of the Ethernet frame stored in the buffer */
-			bool          FrameInBuffer; /**< Indicates if a frame is currently stored in the buffer */
+			uint8_t       FrameData[ETHERNET_FRAME_SIZE_MAX]; /**< Ethernet frame contents. */
+			uint16_t      FrameLength; /**< Length in bytes of the Ethernet frame stored in the buffer. */
+			bool          FrameInBuffer; /**< Indicates if a frame is currently stored in the buffer. */
 		} Ethernet_Frame_Info_t;
 
 		/** \brief RNDIS Common Message Header Structure.