projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Fixed incorrect buffer size check in the USBtoSerial project (thanks to Yuri A Nikifo...
[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 ead3051..05ab13b 100644 (file)
--- a/LUFA/Drivers/USB/Class/Common/RNDIS.h
+++ b/LUFA/Drivers/USB/Class/Common/RNDIS.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
+     Copyright (C) Dean Camera, 2011.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
@@ -38,7 +38,7 @@
  */
 
 /** \ingroup Group_USBClassRNDIS
  */
 
 /** \ingroup Group_USBClassRNDIS
- *  @defgroup Group_USBClassRNDISCommon  Common Class Definitions
+ *  \defgroup Group_USBClassRNDISCommon  Common Class Definitions
  *
  *  \section Sec_ModDescription Module Description
  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  *
  *  \section Sec_ModDescription Module Description
  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
@@ -54,11 +54,9 @@
                #define __INCLUDE_FROM_CDC_DRIVER
 
        /* Includes: */
                #define __INCLUDE_FROM_CDC_DRIVER
 
        /* Includes: */
-               #include "../../HighLevel/StdDescriptors.h"
+               #include "../../Core/StdDescriptors.h"
                #include "CDC.h"
 
                #include "CDC.h"
 
-               #include <string.h>
-
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        extern "C" {
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        extern "C" {
@@ -70,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
 
@@ -193,7 +194,7 @@
                /** Enum for the RNDIS class specific notification requests that can be issued by a RNDIS device to a host. */
                enum RNDIS_ClassNotifications_t
                {
                /** 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. */
+                       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. */
@@ -213,33 +214,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
                {
                 */
                typedef struct
                {
-                       uint32_t MessageType; /**< RNDIS message type, a REMOTE_NDIS_*_MSG constant */
+                       uint32_t MessageType; /**< RNDIS message type, a \c REMOTE_NDIS_*_MSG constant */
                        uint32_t MessageLength; /**< Total length of the RNDIS message, in bytes */
                        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
                {
@@ -254,11 +248,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
                {
@@ -269,11 +265,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
                {
@@ -291,22 +289,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
                {
@@ -314,11 +316,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
                {
@@ -327,11 +331,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
                {
@@ -343,11 +349,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
                {
@@ -355,11 +363,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
                {
@@ -371,11 +381,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
                {
@@ -386,7 +398,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)
USB isp AVR programmer