LUFA/Drivers/USB/Class/Common/RNDIS.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *  \brief Common definitions and declarations for the library USB RNDIS Class driver.
  33  *
  34  *  Common definitions and declarations for the library USB RNDIS Class driver.
  35  *
  36  *  \note This file should not be included directly. It is automatically included as needed by the class driver
  37  *        dispatch header located in LUFA/Drivers/USB/Class/RNDIS.h.
  38  */
  39
  40 /** \ingroup Group_USBClassRNDIS
  41  *  @defgroup Group_USBClassRNDISCommon  Common Class Definitions
  42  *
  43  *  \section Module Description
  44  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  45  *  RNDIS Class.
  46  *
  47  *  @{
  48  */
  49
  50 #ifndef _RNDIS_CLASS_COMMON_H_
  51 #define _RNDIS_CLASS_COMMON_H_
  52
  53         /* Macros: */
  54                 #define __INCLUDE_FROM_CDC_DRIVER
  55
  56         /* Includes: */
  57                 #include "../../USB.h"
  58                 #include "RNDISConstants.h"
  59                 #include "CDC.h"
  60
  61                 #include <string.h>
  62
  63         /* Enable C linkage for C++ Compilers: */
  64                 #if defined(__cplusplus)
  65                         extern "C" {
  66                 #endif
  67
  68         /* Preprocessor Checks: */
  69                 #if !defined(__INCLUDE_FROM_RNDIS_DRIVER)
  70                         #error Do not include this file directly. Include LUFA/Drivers/Class/RNDIS.h instead.
  71                 #endif
  72
  73         /* Macros: */
  74                 /** Implemented RNDIS Version Major. */
  75                 #define REMOTE_NDIS_VERSION_MAJOR             0x01
  76
  77                 /** Implemented RNDIS Version Minor. */
  78                 #define REMOTE_NDIS_VERSION_MINOR             0x00
  79
  80                 /** Maximum size in bytes of a RNDIS control message which can be sent or received. */
  81                 #define RNDIS_MESSAGE_BUFFER_SIZE             128
  82
  83                 /** Maximum size in bytes of an Ethernet frame according to the Ethernet standard. */
  84                 #define ETHERNET_FRAME_SIZE_MAX               1500
  85
  86                 /** Notification request value for a RNDIS Response Available notification. */
  87                 #define NOTIF_ResponseAvailable               1
  88
  89         /* Enums: */
  90                 /** Enum for the RNDIS class specific control requests that can be issued by the USB bus host. */
  91                 enum RNDIS_ClassRequests_t
  92                 {
  93                         RNDIS_REQ_SendEncapsulatedCommand = 0x00, /**< RNDIS request to issue a host-to-device NDIS command. */
  94                         RNDIS_REQ_GetEncapsulatedResponse = 0x01, /**< RNDIS request to issue a device-to-host NDIS response. */
  95                 };
  96
  97                 /** Enum for the possible NDIS adapter states. */
  98                 enum RNDIS_States_t
  99                 {
 100                         RNDIS_Uninitialized    = 0, /**< Adapter currently uninitialized. */
 101                         RNDIS_Initialized      = 1, /**< Adapter currently initialized but not ready for data transfers. */
 102                         RNDIS_Data_Initialized = 2, /**< Adapter currently initialized and ready for data transfers. */
 103                 };
 104
 105                 /** Enum for the NDIS hardware states. */
 106                 enum NDIS_Hardware_Status_t
 107                 {
 108                         NDIS_HardwareStatus_Ready, /**< Hardware Ready to accept commands from the host. */
 109                         NDIS_HardwareStatus_Initializing, /**< Hardware busy initializing. */
 110                         NDIS_HardwareStatus_Reset, /**< Hardware reset. */
 111                         NDIS_HardwareStatus_Closing, /**< Hardware currently closing. */
 112                         NDIS_HardwareStatus_NotReady /**< Hardware not ready to accept commands from the host. */
 113                 };
 114
 115         /* Type Defines: */
 116                 /** \brief MAC Address Structure.
 117                  *
 118                  *  Type define for a physical MAC address of a device on a network.
 119                  */
 120                 typedef struct
 121                 {
 122                         uint8_t       Octets[6]; /**< Individual bytes of a MAC address */
 123                 } MAC_Address_t;
 124
 125                 /** \brief RNDIS Ethernet Frame Packet Information Structure.
 126                  *
 127                  *  Type define for an Ethernet frame buffer data and information structure.
 128                  */
 129                 typedef struct
 130                 {
 131                         uint8_t       FrameData[ETHERNET_FRAME_SIZE_MAX]; /**< Ethernet frame contents. */
 132                         uint16_t      FrameLength; /**< Length in bytes of the Ethernet frame stored in the buffer. */
 133                         bool          FrameInBuffer; /**< Indicates if a frame is currently stored in the buffer. */
 134                 } Ethernet_Frame_Info_t;
 135
 136                 /** \brief RNDIS Common Message Header Structure.
 137                  *
 138                  *  Type define for a RNDIS message header, sent before RNDIS messages.
 139                  */
 140                 typedef struct
 141                 {
 142                         uint32_t MessageType; /**< RNDIS message type, a REMOTE_NDIS_*_MSG constant */
 143                         uint32_t MessageLength; /**< Total length of the RNDIS message, in bytes */
 144                 } RNDIS_Message_Header_t;
 145
 146                 /** \brief RNDIS Message Structure.
 147                  *
 148                  *  Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter.
 149                  */
 150                 typedef struct
 151                 {
 152                         uint32_t MessageType;
 153                         uint32_t MessageLength;
 154                         uint32_t DataOffset;
 155                         uint32_t DataLength;
 156                         uint32_t OOBDataOffset;
 157                         uint32_t OOBDataLength;
 158                         uint32_t NumOOBDataElements;
 159                         uint32_t PerPacketInfoOffset;
 160                         uint32_t PerPacketInfoLength;
 161                         uint32_t VcHandle;
 162                         uint32_t Reserved;
 163                 } RNDIS_Packet_Message_t;
 164
 165                 /** \brief RNDIS Initialization Message Structure.
 166                  *
 167                  *  Type define for a RNDIS Initialize command message.
 168                  */
 169                 typedef struct
 170                 {
 171                         uint32_t MessageType;
 172                         uint32_t MessageLength;
 173                         uint32_t RequestId;
 174
 175                         uint32_t MajorVersion;
 176                         uint32_t MinorVersion;
 177                         uint32_t MaxTransferSize;
 178                 } RNDIS_Initialize_Message_t;
 179
 180                 /** \brief RNDIS Initialize Complete Message Structure.
 181                  *
 182                  *  Type define for a RNDIS Initialize Complete response message.
 183                  */
 184                 typedef struct
 185                 {
 186                         uint32_t MessageType;
 187                         uint32_t MessageLength;
 188                         uint32_t RequestId;
 189                         uint32_t Status;
 190
 191                         uint32_t MajorVersion;
 192                         uint32_t MinorVersion;
 193                         uint32_t DeviceFlags;
 194                         uint32_t Medium;
 195                         uint32_t MaxPacketsPerTransfer;
 196                         uint32_t MaxTransferSize;
 197                         uint32_t PacketAlignmentFactor;
 198                         uint32_t AFListOffset;
 199                         uint32_t AFListSize;
 200                 } RNDIS_Initialize_Complete_t;
 201
 202                 /** \brief RNDIS Keep Alive Message Structure.
 203                  *
 204                  *  Type define for a RNDIS Keep Alive command message.
 205                  */
 206                 typedef struct
 207                 {
 208                         uint32_t MessageType;
 209                         uint32_t MessageLength;
 210                         uint32_t RequestId;
 211                 } RNDIS_KeepAlive_Message_t;
 212
 213                 /** \brief RNDIS Keep Alive Complete Message Structure.
 214                  *
 215                  *  Type define for a RNDIS Keep Alive Complete response message.
 216                  */
 217                 typedef struct
 218                 {
 219                         uint32_t MessageType;
 220                         uint32_t MessageLength;
 221                         uint32_t RequestId;
 222                         uint32_t Status;
 223                 } RNDIS_KeepAlive_Complete_t;
 224
 225                 /** \brief RNDIS Reset Complete Message Structure.
 226                  *
 227                  *  Type define for a RNDIS Reset Complete response message.
 228                  */
 229                 typedef struct
 230                 {
 231                         uint32_t MessageType;
 232                         uint32_t MessageLength;
 233                         uint32_t Status;
 234
 235                         uint32_t AddressingReset;
 236                 } RNDIS_Reset_Complete_t;
 237
 238                 /** \brief RNDIS OID Property Set Message Structure.
 239                  *
 240                  *  Type define for a RNDIS OID Property Set command message.
 241                  */
 242                 typedef struct
 243                 {
 244                         uint32_t MessageType;
 245                         uint32_t MessageLength;
 246                         uint32_t RequestId;
 247
 248                         uint32_t Oid;
 249                         uint32_t InformationBufferLength;
 250                         uint32_t InformationBufferOffset;
 251                         uint32_t DeviceVcHandle;
 252                 } RNDIS_Set_Message_t;
 253
 254                 /** \brief RNDIS OID Property Set Complete Message Structure.
 255                  *
 256                  *  Type define for a RNDIS OID Property Set Complete response message.
 257                  */
 258                 typedef struct
 259                 {
 260                         uint32_t MessageType;
 261                         uint32_t MessageLength;
 262                         uint32_t RequestId;
 263                         uint32_t Status;
 264                 } RNDIS_Set_Complete_t;
 265
 266                 /** \brief RNDIS OID Property Query Message Structure.
 267                  *
 268                  *  Type define for a RNDIS OID Property Query command message.
 269                  */
 270                 typedef struct
 271                 {
 272                         uint32_t MessageType;
 273                         uint32_t MessageLength;
 274                         uint32_t RequestId;
 275
 276                         uint32_t Oid;
 277                         uint32_t InformationBufferLength;
 278                         uint32_t InformationBufferOffset;
 279                         uint32_t DeviceVcHandle;
 280                 } RNDIS_Query_Message_t;
 281
 282                 /** \brief RNDIS OID Property Query Complete Message Structure.
 283                  *
 284                  *  Type define for a RNDIS OID Property Query Complete response message.
 285                  */
 286                 typedef struct
 287                 {
 288                         uint32_t MessageType;
 289                         uint32_t MessageLength;
 290                         uint32_t RequestId;
 291                         uint32_t Status;
 292
 293                         uint32_t InformationBufferLength;
 294                         uint32_t InformationBufferOffset;
 295                 } RNDIS_Query_Complete_t;
 296
 297         /* Disable C linkage for C++ Compilers: */
 298                 #if defined(__cplusplus)
 299                         }
 300                 #endif
 301
 302 #endif
 303
 304 /** @} */