Rename the Doxygen page source directory from ManPages/ to DoxygenPages/ to prevent...

[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 64f080a..f931de8 100644 (file)
--- a/LUFA/Drivers/USB/Class/Common/RNDIS.h
+++ b/LUFA/Drivers/USB/Class/Common/RNDIS.h
@@ -68,6 +68,9 @@
                #endif
 
        /* Macros: */
                #endif
 
        /* Macros: */

+               /** Additional error code for RNDIS functions when a device returns a logical command failure. */
+               #define RNDIS_ERROR_LOGICAL_CMD_FAILED        0x80
+

                /** Implemented RNDIS Version Major. */
                #define REMOTE_NDIS_VERSION_MAJOR             0x01
 
                /** Implemented RNDIS Version Major. */
                #define REMOTE_NDIS_VERSION_MAJOR             0x01
 


@@ -111,7 +114,10 @@
                #define REMOTE_NDIS_MEDIA_STATE_DISCONNECTED  0x00000001UL
                //@}
                
                #define REMOTE_NDIS_MEDIA_STATE_DISCONNECTED  0x00000001UL
                //@}
                

+               /** \name RNDIS Media Types */
+               //@{

                #define REMOTE_NDIS_MEDIUM_802_3              0x00000000UL
                #define REMOTE_NDIS_MEDIUM_802_3              0x00000000UL

+               //@}

 
                /** \name RNDIS Connection Types */
                //@{
 
                /** \name RNDIS Connection Types */
                //@{


@@ -211,33 +217,26 @@
                 */
                typedef struct
                {
                 */
                typedef struct
                {

-                       uint8_t       Octets[6]; /**< Individual bytes of a MAC address */
-               } MAC_Address_t;
-
-               /** \brief RNDIS Ethernet Frame Packet Information Structure.
-                *
-                *  Type define for an Ethernet frame buffer data and information structure.
-                */
-               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. */
-               } Ethernet_Frame_Info_t;
+                       uint8_t Octets[6]; /**< Individual bytes of a MAC address */
+               } ATTR_PACKED MAC_Address_t;

 
                /** \brief RNDIS Common Message Header Structure.
                 *
                 *  Type define for a RNDIS message header, sent before RNDIS messages.
 
                /** \brief RNDIS Common Message Header Structure.
                 *
                 *  Type define for a RNDIS message header, sent before RNDIS messages.

+                *
+                *  \note Regardless of CPU architecture, these values should be stored as little endian.

                 */
                typedef struct
                {
                        uint32_t MessageType; /**< RNDIS message type, a \c REMOTE_NDIS_*_MSG constant */
                        uint32_t MessageLength; /**< Total length of the RNDIS message, in bytes */
                 */
                typedef struct
                {
                        uint32_t MessageType; /**< RNDIS message type, a \c REMOTE_NDIS_*_MSG constant */
                        uint32_t MessageLength; /**< Total length of the RNDIS message, in bytes */

-               } RNDIS_Message_Header_t;
+               } ATTR_PACKED RNDIS_Message_Header_t;

 
                /** \brief RNDIS Message Structure.
                 *
                 *  Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter.
 
                /** \brief RNDIS Message Structure.
                 *
                 *  Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter.

+                *
+                *  \note Regardless of CPU architecture, these values should be stored as little endian.

                 */
                typedef struct
                {
                 */
                typedef struct
                {


@@ -252,11 +251,13 @@
                        uint32_t PerPacketInfoLength;
                        uint32_t VcHandle;
                        uint32_t Reserved;
                        uint32_t PerPacketInfoLength;
                        uint32_t VcHandle;
                        uint32_t Reserved;

-               } RNDIS_Packet_Message_t;
+               } ATTR_PACKED RNDIS_Packet_Message_t;

 
                /** \brief RNDIS Initialization Message Structure.
                 *
                 *  Type define for a RNDIS Initialize command message.
 
                /** \brief RNDIS Initialization Message Structure.
                 *
                 *  Type define for a RNDIS Initialize command message.

+                *
+                *  \note Regardless of CPU architecture, these values should be stored as little endian.

                 */
                typedef struct
                {
                 */
                typedef struct
                {


@@ -267,11 +268,13 @@
                        uint32_t MajorVersion;
                        uint32_t MinorVersion;
                        uint32_t MaxTransferSize;
                        uint32_t MajorVersion;
                        uint32_t MinorVersion;
                        uint32_t MaxTransferSize;

-               } RNDIS_Initialize_Message_t;
+               } ATTR_PACKED RNDIS_Initialize_Message_t;

 
                /** \brief RNDIS Initialize Complete Message Structure.
                 *
                 *  Type define for a RNDIS Initialize Complete response message.
 
                /** \brief RNDIS Initialize Complete Message Structure.
                 *
                 *  Type define for a RNDIS Initialize Complete response message.

+                *
+                *  \note Regardless of CPU architecture, these values should be stored as little endian.

                 */
                typedef struct
                {
                 */
                typedef struct
                {


@@ -289,22 +292,26 @@
                        uint32_t PacketAlignmentFactor;
                        uint32_t AFListOffset;
                        uint32_t AFListSize;
                        uint32_t PacketAlignmentFactor;
                        uint32_t AFListOffset;
                        uint32_t AFListSize;

-               } RNDIS_Initialize_Complete_t;
+               } ATTR_PACKED RNDIS_Initialize_Complete_t;

 
                /** \brief RNDIS Keep Alive Message Structure.
                 *
                 *  Type define for a RNDIS Keep Alive command message.
 
                /** \brief RNDIS Keep Alive Message Structure.
                 *
                 *  Type define for a RNDIS Keep Alive command message.

+                *
+                *  \note Regardless of CPU architecture, these values should be stored as little endian.

                 */
                typedef struct
                {
                        uint32_t MessageType;
                        uint32_t MessageLength;
                        uint32_t RequestId;
                 */
                typedef struct
                {
                        uint32_t MessageType;
                        uint32_t MessageLength;
                        uint32_t RequestId;

-               } RNDIS_KeepAlive_Message_t;
+               } ATTR_PACKED RNDIS_KeepAlive_Message_t;

 
                /** \brief RNDIS Keep Alive Complete Message Structure.
                 *
                 *  Type define for a RNDIS Keep Alive Complete response message.
 
                /** \brief RNDIS Keep Alive Complete Message Structure.
                 *
                 *  Type define for a RNDIS Keep Alive Complete response message.

+                *
+                *  \note Regardless of CPU architecture, these values should be stored as little endian.

                 */
                typedef struct
                {
                 */
                typedef struct
                {


@@ -312,11 +319,13 @@
                        uint32_t MessageLength;
                        uint32_t RequestId;
                        uint32_t Status;
                        uint32_t MessageLength;
                        uint32_t RequestId;
                        uint32_t Status;

-               } RNDIS_KeepAlive_Complete_t;
+               } ATTR_PACKED RNDIS_KeepAlive_Complete_t;

 
                /** \brief RNDIS Reset Complete Message Structure.
                 *
                 *  Type define for a RNDIS Reset Complete response message.
 
                /** \brief RNDIS Reset Complete Message Structure.
                 *
                 *  Type define for a RNDIS Reset Complete response message.

+                *
+                *  \note Regardless of CPU architecture, these values should be stored as little endian.

                 */
                typedef struct
                {
                 */
                typedef struct
                {


@@ -325,11 +334,13 @@
                        uint32_t Status;
 
                        uint32_t AddressingReset;
                        uint32_t Status;
 
                        uint32_t AddressingReset;

-               } RNDIS_Reset_Complete_t;
+               } ATTR_PACKED RNDIS_Reset_Complete_t;

 
                /** \brief RNDIS OID Property Set Message Structure.
                 *
                 *  Type define for a RNDIS OID Property Set command message.
 
                /** \brief RNDIS OID Property Set Message Structure.
                 *
                 *  Type define for a RNDIS OID Property Set command message.

+                *
+                *  \note Regardless of CPU architecture, these values should be stored as little endian.

                 */
                typedef struct
                {
                 */
                typedef struct
                {


@@ -341,11 +352,13 @@
                        uint32_t InformationBufferLength;
                        uint32_t InformationBufferOffset;
                        uint32_t DeviceVcHandle;
                        uint32_t InformationBufferLength;
                        uint32_t InformationBufferOffset;
                        uint32_t DeviceVcHandle;

-               } RNDIS_Set_Message_t;
+               } ATTR_PACKED RNDIS_Set_Message_t;

 
                /** \brief RNDIS OID Property Set Complete Message Structure.
                 *
                 *  Type define for a RNDIS OID Property Set Complete response message.
 
                /** \brief RNDIS OID Property Set Complete Message Structure.
                 *
                 *  Type define for a RNDIS OID Property Set Complete response message.

+                *
+                *  \note Regardless of CPU architecture, these values should be stored as little endian.

                 */
                typedef struct
                {
                 */
                typedef struct
                {


@@ -353,11 +366,13 @@
                        uint32_t MessageLength;
                        uint32_t RequestId;
                        uint32_t Status;
                        uint32_t MessageLength;
                        uint32_t RequestId;
                        uint32_t Status;

-               } RNDIS_Set_Complete_t;
+               } ATTR_PACKED RNDIS_Set_Complete_t;

 
                /** \brief RNDIS OID Property Query Message Structure.
                 *
                 *  Type define for a RNDIS OID Property Query command message.
 
                /** \brief RNDIS OID Property Query Message Structure.
                 *
                 *  Type define for a RNDIS OID Property Query command message.

+                *
+                *  \note Regardless of CPU architecture, these values should be stored as little endian.

                 */
                typedef struct
                {
                 */
                typedef struct
                {


@@ -369,11 +384,13 @@
                        uint32_t InformationBufferLength;
                        uint32_t InformationBufferOffset;
                        uint32_t DeviceVcHandle;
                        uint32_t InformationBufferLength;
                        uint32_t InformationBufferOffset;
                        uint32_t DeviceVcHandle;

-               } RNDIS_Query_Message_t;
+               } ATTR_PACKED RNDIS_Query_Message_t;

 
                /** \brief RNDIS OID Property Query Complete Message Structure.
                 *
                 *  Type define for a RNDIS OID Property Query Complete response message.
 
                /** \brief RNDIS OID Property Query Complete Message Structure.
                 *
                 *  Type define for a RNDIS OID Property Query Complete response message.

+                *
+                *  \note Regardless of CPU architecture, these values should be stored as little endian.

                 */
                typedef struct
                {
                 */
                typedef struct
                {


@@ -384,7 +401,7 @@
 
                        uint32_t InformationBufferLength;
                        uint32_t InformationBufferOffset;
 
                        uint32_t InformationBufferLength;
                        uint32_t InformationBufferOffset;

-               } RNDIS_Query_Complete_t;
+               } ATTR_PACKED RNDIS_Query_Complete_t;

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