diff options
author | Dean Camera <dean@fourwalledcubicle.com> | 2010-06-03 15:32:45 +0000 |
---|---|---|
committer | Dean Camera <dean@fourwalledcubicle.com> | 2010-06-03 15:32:45 +0000 |
commit | fc92f9969c1fcc2f952f0bd6d09a309a9b3ce02f (patch) | |
tree | 1dc0ae98a98bb0a0efa0a7d122b3e1ee63e9e7b2 /Demos/Host/LowLevel/RNDISEthernetHost | |
parent | 9293de249151fb974325ebf8f39b28e0f32524ea (diff) | |
download | lufa-fc92f9969c1fcc2f952f0bd6d09a309a9b3ce02f.tar.gz lufa-fc92f9969c1fcc2f952f0bd6d09a309a9b3ce02f.tar.bz2 lufa-fc92f9969c1fcc2f952f0bd6d09a309a9b3ce02f.zip |
Minor documentation cleanups.
Diffstat (limited to 'Demos/Host/LowLevel/RNDISEthernetHost')
-rw-r--r-- | Demos/Host/LowLevel/RNDISEthernetHost/ConfigDescriptor.h | 12 | ||||
-rw-r--r-- | Demos/Host/LowLevel/RNDISEthernetHost/Lib/RNDISCommands.h | 38 |
2 files changed, 25 insertions, 25 deletions
diff --git a/Demos/Host/LowLevel/RNDISEthernetHost/ConfigDescriptor.h b/Demos/Host/LowLevel/RNDISEthernetHost/ConfigDescriptor.h index 02bfca2c0..149d81bf7 100644 --- a/Demos/Host/LowLevel/RNDISEthernetHost/ConfigDescriptor.h +++ b/Demos/Host/LowLevel/RNDISEthernetHost/ConfigDescriptor.h @@ -42,22 +42,22 @@ #include "RNDISEthernetHost.h" /* Macros: */ - /** Interface Class value for the CDC class */ + /** Interface Class value for the CDC class. */ #define CDC_CONTROL_CLASS 0x02 - /** Interface Class value for the CDC Communication Interface subclass */ + /** Interface Class value for the CDC Communication Interface subclass. */ #define CDC_CONTROL_SUBCLASS 0x02 - /** Interface Class value for the CDC RNDIS vendor specific protocol */ + /** Interface Class value for the CDC RNDIS vendor specific protocol. */ #define CDC_CONTROL_PROTOCOL 0xFF - /** Interface Class value for the CDC data class */ + /** Interface Class value for the CDC data class. */ #define CDC_DATA_CLASS 0x0A - /** Interface Class value for the CDC data subclass */ + /** Interface Class value for the CDC data subclass. */ #define CDC_DATA_SUBCLASS 0x00 - /** Interface Class value for the CDC data protocol */ + /** Interface Class value for the CDC data protocol. */ #define CDC_DATA_PROTOCOL 0x00 /* Enums: */ diff --git a/Demos/Host/LowLevel/RNDISEthernetHost/Lib/RNDISCommands.h b/Demos/Host/LowLevel/RNDISEthernetHost/Lib/RNDISCommands.h index 62d1c0893..a2f15c5a7 100644 --- a/Demos/Host/LowLevel/RNDISEthernetHost/Lib/RNDISCommands.h +++ b/Demos/Host/LowLevel/RNDISEthernetHost/Lib/RNDISCommands.h @@ -46,14 +46,14 @@ #include "RNDISConstants.h" /* Type Defines: */ - /** Type define for a RNDIS message header, sent before RNDIS messages */ + /** Type define for a RNDIS message header, sent before RNDIS messages. */ typedef struct { uint32_t MessageType; /**< RNDIS message type, a REMOTE_NDIS_*_MSG constant */ uint32_t MessageLength; /**< Total length of the RNDIS message, in bytes */ } RNDIS_Message_Header_t; - /** Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter */ + /** Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter. */ typedef struct { uint32_t MessageType; @@ -69,7 +69,7 @@ uint32_t Reserved; } RNDIS_Packet_Message_t; - /** Type define for a RNDIS Initialize command message */ + /** Type define for a RNDIS Initialize command message. */ typedef struct { uint32_t MessageType; @@ -81,7 +81,7 @@ uint32_t MaxTransferSize; } RNDIS_Initialize_Message_t; - /** Type define for a RNDIS Initialize complete response message */ + /** Type define for a RNDIS Initialize complete response message. */ typedef struct { uint32_t MessageType; @@ -100,7 +100,7 @@ uint32_t AFListSize; } RNDIS_Initialize_Complete_t; - /** Type define for a RNDIS Keepalive command message */ + /** Type define for a RNDIS Keepalive command message. */ typedef struct { uint32_t MessageType; @@ -108,7 +108,7 @@ uint32_t RequestId; } RNDIS_KeepAlive_Message_t; - /** Type define for a RNDIS Keepalive complete message */ + /** Type define for a RNDIS Keepalive complete message. */ typedef struct { uint32_t MessageType; @@ -117,7 +117,7 @@ uint32_t Status; } RNDIS_KeepAlive_Complete_t; - /** Type define for a RNDIS Reset complete message */ + /** Type define for a RNDIS Reset complete message. */ typedef struct { uint32_t MessageType; @@ -127,7 +127,7 @@ uint32_t AddressingReset; } RNDIS_Reset_Complete_t; - /** Type define for a RNDIS Set command message */ + /** Type define for a RNDIS Set command message. */ typedef struct { uint32_t MessageType; @@ -140,7 +140,7 @@ uint32_t DeviceVcHandle; } RNDIS_Set_Message_t; - /** Type define for a RNDIS Set complete response message */ + /** Type define for a RNDIS Set complete response message. */ typedef struct { uint32_t MessageType; @@ -149,7 +149,7 @@ uint32_t Status; } RNDIS_Set_Complete_t; - /** Type define for a RNDIS Query command message */ + /** Type define for a RNDIS Query command message. */ typedef struct { uint32_t MessageType; @@ -162,7 +162,7 @@ uint32_t DeviceVcHandle; } RNDIS_Query_Message_t; - /** Type define for a RNDIS Query complete response message */ + /** Type define for a RNDIS Query complete response message. */ typedef struct { uint32_t MessageType; @@ -175,28 +175,28 @@ } RNDIS_Query_Complete_t; /* Macros: */ - /** RNDIS request to issue a host-to-device NDIS command */ + /** RNDIS request to issue a host-to-device NDIS command. */ #define REQ_SendEncapsulatedCommand 0x00 - /** RNDIS request to issue a device-to-host NDIS response */ + /** RNDIS request to issue a device-to-host NDIS response. */ #define REQ_GetEncapsulatedResponse 0x01 - /** 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 - /** Pipe number for the RNDIS data IN pipe */ + /** Pipe number for the RNDIS data IN pipe. */ #define RNDIS_DATAPIPE_IN 1 - /** Pipe number for the RNDIS data OUT pipe */ + /** Pipe number for the RNDIS data OUT pipe. */ #define RNDIS_DATAPIPE_OUT 2 - /** Pipe number for the RNDIS notification pipe */ + /** Pipe number for the RNDIS notification pipe. */ #define RNDIS_NOTIFICATIONPIPE 3 - /** Additional error code for RNDIS functions when a device returns a logical command failure */ + /** Additional error code for RNDIS functions when a device returns a logical command failure. */ #define RNDIS_COMMAND_FAILED 0xC0 /* Function Prototypes: */ |