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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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 USB module driver
  37  *        dispatch header located in LUFA/Drivers/USB.h.
  38  */
  39
  40 /** \ingroup Group_USBClassRNDIS
  41  *  \defgroup Group_USBClassRNDISCommon  Common Class Definitions
  42  *
  43  *  \section Sec_ModDescription 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 "../../HighLevel/StdDescriptors.h"
  58                 #include "CDC.h"
  59
  60                 #include <string.h>
  61
  62         /* Enable C linkage for C++ Compilers: */
  63                 #if defined(__cplusplus)
  64                         extern "C" {
  65                 #endif
  66
  67         /* Preprocessor Checks: */
  68                 #if !defined(__INCLUDE_FROM_RNDIS_DRIVER)
  69                         #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
  70                 #endif
  71
  72         /* Macros: */
  73                 /** Implemented RNDIS Version Major. */
  74                 #define REMOTE_NDIS_VERSION_MAJOR             0x01
  75
  76                 /** Implemented RNDIS Version Minor. */
  77                 #define REMOTE_NDIS_VERSION_MINOR             0x00
  78
  79                 /** \name RNDIS Message Values */
  80                 //@{
  81                 #define REMOTE_NDIS_PACKET_MSG                0x00000001UL
  82                 #define REMOTE_NDIS_INITIALIZE_MSG            0x00000002UL
  83                 #define REMOTE_NDIS_HALT_MSG                  0x00000003UL
  84                 #define REMOTE_NDIS_QUERY_MSG                 0x00000004UL
  85                 #define REMOTE_NDIS_SET_MSG                   0x00000005UL
  86                 #define REMOTE_NDIS_RESET_MSG                 0x00000006UL
  87                 #define REMOTE_NDIS_INDICATE_STATUS_MSG       0x00000007UL
  88                 #define REMOTE_NDIS_KEEPALIVE_MSG             0x00000008UL
  89                 //@}
  90
  91                 /** \name RNDIS Response Values */
  92                 //@{
  93                 #define REMOTE_NDIS_INITIALIZE_CMPLT          0x80000002UL
  94                 #define REMOTE_NDIS_QUERY_CMPLT               0x80000004UL
  95                 #define REMOTE_NDIS_SET_CMPLT                 0x80000005UL
  96                 #define REMOTE_NDIS_RESET_CMPLT               0x80000006UL
  97                 #define REMOTE_NDIS_KEEPALIVE_CMPLT           0x80000008UL
  98                 //@}
  99
 100                 /** \name RNDIS Status Values */
 101                 //@{
 102                 #define REMOTE_NDIS_STATUS_SUCCESS            0x00000000UL
 103                 #define REMOTE_NDIS_STATUS_FAILURE            0xC0000001UL
 104                 #define REMOTE_NDIS_STATUS_INVALID_DATA       0xC0010015UL
 105                 #define REMOTE_NDIS_STATUS_NOT_SUPPORTED      0xC00000BBUL
 106                 #define REMOTE_NDIS_STATUS_MEDIA_CONNECT      0x4001000BUL
 107                 #define REMOTE_NDIS_STATUS_MEDIA_DISCONNECT   0x4001000CUL
 108                 //@}
 109
 110                 /** \name RNDIS Media States */
 111                 //@{
 112                 #define REMOTE_NDIS_MEDIA_STATE_CONNECTED     0x00000000UL
 113                 #define REMOTE_NDIS_MEDIA_STATE_DISCONNECTED  0x00000001UL
 114                 //@}
 115
 116                 #define REMOTE_NDIS_MEDIUM_802_3              0x00000000UL
 117
 118                 /** \name RNDIS Connection Types */
 119                 //@{
 120                 #define REMOTE_NDIS_DF_CONNECTIONLESS         0x00000001UL
 121                 #define REMOTE_NDIS_DF_CONNECTION_ORIENTED    0x00000002UL
 122                 //@}
 123
 124                 /** \name RNDIS Packet Types */
 125                 //@{
 126                 #define REMOTE_NDIS_PACKET_DIRECTED           0x00000001UL
 127                 #define REMOTE_NDIS_PACKET_MULTICAST          0x00000002UL
 128                 #define REMOTE_NDIS_PACKET_ALL_MULTICAST      0x00000004UL
 129                 #define REMOTE_NDIS_PACKET_BROADCAST          0x00000008UL
 130                 #define REMOTE_NDIS_PACKET_SOURCE_ROUTING     0x00000010UL
 131                 #define REMOTE_NDIS_PACKET_PROMISCUOUS        0x00000020UL
 132                 #define REMOTE_NDIS_PACKET_SMT                0x00000040UL
 133                 #define REMOTE_NDIS_PACKET_ALL_LOCAL          0x00000080UL
 134                 #define REMOTE_NDIS_PACKET_GROUP              0x00001000UL
 135                 #define REMOTE_NDIS_PACKET_ALL_FUNCTIONAL     0x00002000UL
 136                 #define REMOTE_NDIS_PACKET_FUNCTIONAL         0x00004000UL
 137                 #define REMOTE_NDIS_PACKET_MAC_FRAME          0x00008000UL
 138                 //@}
 139
 140                 /** \name RNDIS OID Values */
 141                 //@{
 142                 #define OID_GEN_SUPPORTED_LIST                0x00010101UL
 143                 #define OID_GEN_HARDWARE_STATUS               0x00010102UL
 144                 #define OID_GEN_MEDIA_SUPPORTED               0x00010103UL
 145                 #define OID_GEN_MEDIA_IN_USE                  0x00010104UL
 146                 #define OID_GEN_MAXIMUM_FRAME_SIZE            0x00010106UL
 147                 #define OID_GEN_MAXIMUM_TOTAL_SIZE            0x00010111UL
 148                 #define OID_GEN_LINK_SPEED                    0x00010107UL
 149                 #define OID_GEN_TRANSMIT_BLOCK_SIZE           0x0001010AUL
 150                 #define OID_GEN_RECEIVE_BLOCK_SIZE            0x0001010BUL
 151                 #define OID_GEN_VENDOR_ID                     0x0001010CUL
 152                 #define OID_GEN_VENDOR_DESCRIPTION            0x0001010DUL
 153                 #define OID_GEN_CURRENT_PACKET_FILTER         0x0001010EUL
 154                 #define OID_GEN_MAXIMUM_TOTAL_SIZE            0x00010111UL
 155                 #define OID_GEN_MEDIA_CONNECT_STATUS          0x00010114UL
 156                 #define OID_GEN_PHYSICAL_MEDIUM               0x00010202UL
 157                 #define OID_GEN_XMIT_OK                       0x00020101UL
 158                 #define OID_GEN_RCV_OK                        0x00020102UL
 159                 #define OID_GEN_XMIT_ERROR                    0x00020103UL
 160                 #define OID_GEN_RCV_ERROR                     0x00020104UL
 161                 #define OID_GEN_RCV_NO_BUFFER                 0x00020105UL
 162                 #define OID_802_3_PERMANENT_ADDRESS           0x01010101UL
 163                 #define OID_802_3_CURRENT_ADDRESS             0x01010102UL
 164                 #define OID_802_3_MULTICAST_LIST              0x01010103UL
 165                 #define OID_802_3_MAXIMUM_LIST_SIZE           0x01010104UL
 166                 #define OID_802_3_RCV_ERROR_ALIGNMENT         0x01020101UL
 167                 #define OID_802_3_XMIT_ONE_COLLISION          0x01020102UL
 168                 #define OID_802_3_XMIT_MORE_COLLISIONS        0x01020103UL
 169                 //@}
 170
 171                 /** Maximum size in bytes of a RNDIS control message which can be sent or received. */
 172                 #define RNDIS_MESSAGE_BUFFER_SIZE             128
 173
 174                 /** Maximum size in bytes of an Ethernet frame according to the Ethernet standard. */
 175                 #define ETHERNET_FRAME_SIZE_MAX               1500
 176
 177         /* Enums: */
 178                 /** Enum for the RNDIS class specific control requests that can be issued by the USB bus host. */
 179                 enum RNDIS_ClassRequests_t
 180                 {
 181                         RNDIS_REQ_SendEncapsulatedCommand = 0x00, /**< RNDIS request to issue a host-to-device NDIS command. */
 182                         RNDIS_REQ_GetEncapsulatedResponse = 0x01, /**< RNDIS request to issue a device-to-host NDIS response. */
 183                 };
 184
 185                 /** Enum for the possible NDIS adapter states. */
 186                 enum RNDIS_States_t
 187                 {
 188                         RNDIS_Uninitialized    = 0, /**< Adapter currently uninitialized. */
 189                         RNDIS_Initialized      = 1, /**< Adapter currently initialized but not ready for data transfers. */
 190                         RNDIS_Data_Initialized = 2, /**< Adapter currently initialized and ready for data transfers. */
 191                 };
 192
 193                 /** Enum for the RNDIS class specific notification requests that can be issued by a RNDIS device to a host. */
 194                 enum RNDIS_ClassNotifications_t
 195                 {
 196                         RNDIS_NOTIF_ResponseAvailable = 0x01, /**< Notification request value for a RNDIS Response Available notification. */
 197                 };
 198
 199                 /** Enum for the NDIS hardware states. */
 200                 enum NDIS_Hardware_Status_t
 201                 {
 202                         NDIS_HardwareStatus_Ready, /**< Hardware Ready to accept commands from the host. */
 203                         NDIS_HardwareStatus_Initializing, /**< Hardware busy initializing. */
 204                         NDIS_HardwareStatus_Reset, /**< Hardware reset. */
 205                         NDIS_HardwareStatus_Closing, /**< Hardware currently closing. */
 206                         NDIS_HardwareStatus_NotReady /**< Hardware not ready to accept commands from the host. */
 207                 };
 208
 209         /* Type Defines: */
 210                 /** \brief MAC Address Structure.
 211                  *
 212                  *  Type define for a physical MAC address of a device on a network.
 213                  */
 214                 typedef struct
 215                 {
 216                         uint8_t       Octets[6]; /**< Individual bytes of a MAC address */
 217                 } MAC_Address_t;
 218
 219                 /** \brief RNDIS Ethernet Frame Packet Information Structure.
 220                  *
 221                  *  Type define for an Ethernet frame buffer data and information structure.
 222                  */
 223                 typedef struct
 224                 {
 225                         uint8_t       FrameData[ETHERNET_FRAME_SIZE_MAX]; /**< Ethernet frame contents. */
 226                         uint16_t      FrameLength; /**< Length in bytes of the Ethernet frame stored in the buffer. */
 227                         bool          FrameInBuffer; /**< Indicates if a frame is currently stored in the buffer. */
 228                 } Ethernet_Frame_Info_t;
 229
 230                 /** \brief RNDIS Common Message Header Structure.
 231                  *
 232                  *  Type define for a RNDIS message header, sent before RNDIS messages.
 233                  */
 234                 typedef struct
 235                 {
 236                         uint32_t MessageType; /**< RNDIS message type, a \c REMOTE_NDIS_*_MSG constant */
 237                         uint32_t MessageLength; /**< Total length of the RNDIS message, in bytes */
 238                 } RNDIS_Message_Header_t;
 239
 240                 /** \brief RNDIS Message Structure.
 241                  *
 242                  *  Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter.
 243                  */
 244                 typedef struct
 245                 {
 246                         uint32_t MessageType;
 247                         uint32_t MessageLength;
 248                         uint32_t DataOffset;
 249                         uint32_t DataLength;
 250                         uint32_t OOBDataOffset;
 251                         uint32_t OOBDataLength;
 252                         uint32_t NumOOBDataElements;
 253                         uint32_t PerPacketInfoOffset;
 254                         uint32_t PerPacketInfoLength;
 255                         uint32_t VcHandle;
 256                         uint32_t Reserved;
 257                 } RNDIS_Packet_Message_t;
 258
 259                 /** \brief RNDIS Initialization Message Structure.
 260                  *
 261                  *  Type define for a RNDIS Initialize command message.
 262                  */
 263                 typedef struct
 264                 {
 265                         uint32_t MessageType;
 266                         uint32_t MessageLength;
 267                         uint32_t RequestId;
 268
 269                         uint32_t MajorVersion;
 270                         uint32_t MinorVersion;
 271                         uint32_t MaxTransferSize;
 272                 } RNDIS_Initialize_Message_t;
 273
 274                 /** \brief RNDIS Initialize Complete Message Structure.
 275                  *
 276                  *  Type define for a RNDIS Initialize Complete response message.
 277                  */
 278                 typedef struct
 279                 {
 280                         uint32_t MessageType;
 281                         uint32_t MessageLength;
 282                         uint32_t RequestId;
 283                         uint32_t Status;
 284
 285                         uint32_t MajorVersion;
 286                         uint32_t MinorVersion;
 287                         uint32_t DeviceFlags;
 288                         uint32_t Medium;
 289                         uint32_t MaxPacketsPerTransfer;
 290                         uint32_t MaxTransferSize;
 291                         uint32_t PacketAlignmentFactor;
 292                         uint32_t AFListOffset;
 293                         uint32_t AFListSize;
 294                 } RNDIS_Initialize_Complete_t;
 295
 296                 /** \brief RNDIS Keep Alive Message Structure.
 297                  *
 298                  *  Type define for a RNDIS Keep Alive command message.
 299                  */
 300                 typedef struct
 301                 {
 302                         uint32_t MessageType;
 303                         uint32_t MessageLength;
 304                         uint32_t RequestId;
 305                 } RNDIS_KeepAlive_Message_t;
 306
 307                 /** \brief RNDIS Keep Alive Complete Message Structure.
 308                  *
 309                  *  Type define for a RNDIS Keep Alive Complete response message.
 310                  */
 311                 typedef struct
 312                 {
 313                         uint32_t MessageType;
 314                         uint32_t MessageLength;
 315                         uint32_t RequestId;
 316                         uint32_t Status;
 317                 } RNDIS_KeepAlive_Complete_t;
 318
 319                 /** \brief RNDIS Reset Complete Message Structure.
 320                  *
 321                  *  Type define for a RNDIS Reset Complete response message.
 322                  */
 323                 typedef struct
 324                 {
 325                         uint32_t MessageType;
 326                         uint32_t MessageLength;
 327                         uint32_t Status;
 328
 329                         uint32_t AddressingReset;
 330                 } RNDIS_Reset_Complete_t;
 331
 332                 /** \brief RNDIS OID Property Set Message Structure.
 333                  *
 334                  *  Type define for a RNDIS OID Property Set command message.
 335                  */
 336                 typedef struct
 337                 {
 338                         uint32_t MessageType;
 339                         uint32_t MessageLength;
 340                         uint32_t RequestId;
 341
 342                         uint32_t Oid;
 343                         uint32_t InformationBufferLength;
 344                         uint32_t InformationBufferOffset;
 345                         uint32_t DeviceVcHandle;
 346                 } RNDIS_Set_Message_t;
 347
 348                 /** \brief RNDIS OID Property Set Complete Message Structure.
 349                  *
 350                  *  Type define for a RNDIS OID Property Set Complete response message.
 351                  */
 352                 typedef struct
 353                 {
 354                         uint32_t MessageType;
 355                         uint32_t MessageLength;
 356                         uint32_t RequestId;
 357                         uint32_t Status;
 358                 } RNDIS_Set_Complete_t;
 359
 360                 /** \brief RNDIS OID Property Query Message Structure.
 361                  *
 362                  *  Type define for a RNDIS OID Property Query command message.
 363                  */
 364                 typedef struct
 365                 {
 366                         uint32_t MessageType;
 367                         uint32_t MessageLength;
 368                         uint32_t RequestId;
 369
 370                         uint32_t Oid;
 371                         uint32_t InformationBufferLength;
 372                         uint32_t InformationBufferOffset;
 373                         uint32_t DeviceVcHandle;
 374                 } RNDIS_Query_Message_t;
 375
 376                 /** \brief RNDIS OID Property Query Complete Message Structure.
 377                  *
 378                  *  Type define for a RNDIS OID Property Query Complete response message.
 379                  */
 380                 typedef struct
 381                 {
 382                         uint32_t MessageType;
 383                         uint32_t MessageLength;
 384                         uint32_t RequestId;
 385                         uint32_t Status;
 386
 387                         uint32_t InformationBufferLength;
 388                         uint32_t InformationBufferOffset;
 389                 } RNDIS_Query_Complete_t;
 390
 391         /* Disable C linkage for C++ Compilers: */
 392                 #if defined(__cplusplus)
 393                         }
 394                 #endif
 395
 396 #endif
 397
 398 /** @} */
 399