reactos/include/ddk/ntddndis.h

   1 /*
   2  * ntddndis.h
   3  *
   4  * NDIS device driver interface
   5  *
   6  * This file is part of the w32api package.
   7  *
   8  * Contributors:
   9  *   Created by Casper S. Hornstrup <chorns@users.sourceforge.net>
  10  *
  11  * THIS SOFTWARE IS NOT COPYRIGHTED
  12  *
  13  * This source code is offered for use in the public domain. You may
  14  * use, modify or distribute it freely.
  15  *
  16  * This code is distributed in the hope that it will be useful but
  17  * WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY
  18  * DISCLAIMED. This includes but is not limited to warranties of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  20  *
  21  */
  22
  23 #ifndef __NTDDNDIS_H
  24 #define __NTDDNDIS_H
  25
  26 #pragma pack(push,4)
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 typedef enum _NDIS_WAN_QUALITY {
  33         NdisWanRaw,
  34         NdisWanErrorControl,
  35         NdisWanReliable
  36 } NDIS_WAN_QUALITY, *PNDIS_WAN_QUALITY;
  37
  38 typedef enum _NDIS_DEVICE_POWER_STATE {
  39   NdisDeviceStateUnspecified = 0,
  40   NdisDeviceStateD0,
  41   NdisDeviceStateD1,
  42   NdisDeviceStateD2,
  43   NdisDeviceStateD3,
  44   NdisDeviceStateMaximum
  45 } NDIS_DEVICE_POWER_STATE, *PNDIS_DEVICE_POWER_STATE;
  46
  47 typedef enum _NDIS_802_11_NETWORK_INFRASTRUCTURE
  48 {
  49     Ndis802_11IBSS,
  50     Ndis802_11Infrastructure,
  51     Ndis802_11AutoUnknown,
  52     Ndis802_11InfrastructureMax
  53 } NDIS_802_11_NETWORK_INFRASTRUCTURE, *PNDIS_802_11_NETWORK_INFRASTRUCTURE;
  54
  55 typedef enum _NDIS_802_11_NETWORK_TYPE
  56 {
  57     Ndis802_11FH,
  58     Ndis802_11DS,
  59     Ndis802_11OFDM5,
  60     Ndis802_11OFDM24,
  61     Ndis802_11Automode,
  62     Ndis802_11NetworkTypeMax
  63 } NDIS_802_11_NETWORK_TYPE, *PNDIS_802_11_NETWORK_TYPE;
  64
  65 typedef struct _NDIS_OBJECT_HEADER
  66 {
  67     UCHAR Type;
  68     UCHAR Revision;
  69     USHORT Size;
  70 } NDIS_OBJECT_HEADER, *PNDIS_OBJECT_HEADER;
  71
  72 #define NDIS_802_11_LENGTH_SSID  32
  73 #define NDIS_802_11_LENGTH_RATES 8
  74
  75 typedef UCHAR NDIS_802_11_MAC_ADDRESS[6];
  76 typedef LONG NDIS_802_11_RSSI;
  77 typedef UCHAR NDIS_802_11_RATES[NDIS_802_11_LENGTH_RATES];
  78
  79 typedef struct _NDIS_802_11_SSID
  80 {
  81     ULONG SsidLength;
  82     UCHAR Ssid[NDIS_802_11_LENGTH_SSID];
  83 } NDIS_802_11_SSID, *PNDIS_802_11_SSID;
  84
  85 typedef struct _NDIS_802_11_CONFIGURATION_FH
  86 {
  87     ULONG Length;
  88     ULONG HopPattern;
  89     ULONG HopSet;
  90     ULONG DwellTime;
  91 } NDIS_802_11_CONFIGURATION_FH, *PNDIS_802_11_CONFIGURATION_FH;
  92
  93 typedef struct _NDIS_802_11_CONFIGURATION
  94 {
  95     ULONG Length;
  96     ULONG BeaconPeriod;
  97     ULONG ATIMWindow;
  98     ULONG DSConfig;
  99     NDIS_802_11_CONFIGURATION_FH FHConfig;
 100 } NDIS_802_11_CONFIGURATION, *PNDIS_802_11_CONFIGURATION;
 101
 102 typedef struct _NDIS_WLAN_BSSID
 103 {
 104     ULONG Length;
 105     NDIS_802_11_MAC_ADDRESS MacAddress;
 106     UCHAR Reserved[2];
 107     NDIS_802_11_SSID Ssid;
 108     ULONG Privacy;
 109     NDIS_802_11_RSSI Rssi;
 110     NDIS_802_11_NETWORK_TYPE NetworkTypeInUse;
 111     NDIS_802_11_CONFIGURATION Configuration;
 112     NDIS_802_11_NETWORK_INFRASTRUCTURE InfrastructureMode;
 113     NDIS_802_11_RATES SupportedRates;
 114 } NDIS_WLAN_BSSID, *PNDIS_WLAN_BSSID;
 115
 116 typedef struct _NDIS_802_11_BSSID_LIST
 117 {
 118     ULONG NumberOfItems;
 119     NDIS_WLAN_BSSID Bssid[1];
 120 } NDIS_802_11_BSSID_LIST, *PNDIS_802_11_BSSID_LIST;
 121
 122 typedef struct _NDIS_PM_WAKE_UP_CAPABILITIES {
 123   NDIS_DEVICE_POWER_STATE  MinMagicPacketWakeUp;
 124   NDIS_DEVICE_POWER_STATE  MinPatternWakeUp;
 125   NDIS_DEVICE_POWER_STATE  MinLinkChangeWakeUp;
 126 } NDIS_PM_WAKE_UP_CAPABILITIES, *PNDIS_PM_WAKE_UP_CAPABILITIES;
 127
 128 /* NDIS_PNP_CAPABILITIES.Flags constants */
 129 #define NDIS_DEVICE_WAKE_UP_ENABLE                0x00000001
 130 #define NDIS_DEVICE_WAKE_ON_PATTERN_MATCH_ENABLE  0x00000002
 131 #define NDIS_DEVICE_WAKE_ON_MAGIC_PACKET_ENABLE   0x00000004
 132
 133 typedef struct _NDIS_PNP_CAPABILITIES {
 134   ULONG  Flags;
 135   NDIS_PM_WAKE_UP_CAPABILITIES  WakeUpCapabilities;
 136 } NDIS_PNP_CAPABILITIES, *PNDIS_PNP_CAPABILITIES;
 137
 138 /* NDIS driver medium (OID_GEN_MEDIA_SUPPORTED / OID_GEN_MEDIA_IN_USE) */
 139 typedef enum _NDIS_MEDIUM {
 140   NdisMedium802_3,
 141   NdisMedium802_5,
 142   NdisMediumFddi,
 143   NdisMediumWan,
 144   NdisMediumLocalTalk,
 145   NdisMediumDix,
 146   NdisMediumArcnetRaw,
 147   NdisMediumArcnet878_2,
 148   NdisMediumAtm,
 149   NdisMediumWirelessWan,
 150   NdisMediumIrda,
 151   NdisMediumBpc,
 152   NdisMediumCoWan,
 153   NdisMedium1394,
 154   NdisMediumMax
 155 } NDIS_MEDIUM, *PNDIS_MEDIUM;
 156
 157 typedef enum _NDIS_PHYSICAL_MEDIUM
 158 {
 159     NdisPhysicalMediumUnspecified,
 160     NdisPhysicalMediumWirelessLan,
 161     NdisPhysicalMediumCableModem,
 162     NdisPhysicalMediumPhoneLine,
 163     NdisPhysicalMediumPowerLine,
 164     NdisPhysicalMediumDSL,
 165     NdisPhysicalMediumFibreChannel,
 166     NdisPhysicalMedium1394,
 167     NdisPhysicalMediumWirelessWan,
 168     NdisPhysicalMediumNative802_11,
 169     NdisPhysicalMediumBluetooth,
 170     NdisPhysicalMediumInfiniband,
 171     NdisPhysicalMediumWiMax,
 172     NdisPhysicalMediumUWB,
 173     NdisPhysicalMedium802_3,
 174     NdisPhysicalMedium802_5,
 175     NdisPhysicalMediumIrda,
 176     NdisPhysicalMediumWiredWAN,
 177     NdisPhysicalMediumWiredCoWan,
 178     NdisPhysicalMediumOther,
 179     NdisPhysicalMediumMax
 180 } NDIS_PHYSICAL_MEDIUM, *PNDIS_PHYSICAL_MEDIUM;
 181
 182 /* Required Object IDs (OIDs) */
 183 #define OID_GEN_SUPPORTED_LIST            0x00010101
 184 #define OID_GEN_HARDWARE_STATUS           0x00010102
 185 #define OID_GEN_MEDIA_SUPPORTED           0x00010103
 186 #define OID_GEN_MEDIA_IN_USE              0x00010104
 187 #define OID_GEN_MAXIMUM_LOOKAHEAD         0x00010105
 188 #define OID_GEN_MAXIMUM_FRAME_SIZE        0x00010106
 189 #define OID_GEN_LINK_SPEED                0x00010107
 190 #define OID_GEN_TRANSMIT_BUFFER_SPACE     0x00010108
 191 #define OID_GEN_RECEIVE_BUFFER_SPACE      0x00010109
 192 #define OID_GEN_TRANSMIT_BLOCK_SIZE       0x0001010A
 193 #define OID_GEN_RECEIVE_BLOCK_SIZE        0x0001010B
 194 #define OID_GEN_VENDOR_ID                 0x0001010C
 195 #define OID_GEN_VENDOR_DESCRIPTION        0x0001010D
 196 #define OID_GEN_CURRENT_PACKET_FILTER     0x0001010E
 197 #define OID_GEN_CURRENT_LOOKAHEAD         0x0001010F
 198 #define OID_GEN_DRIVER_VERSION            0x00010110
 199 #define OID_GEN_MAXIMUM_TOTAL_SIZE        0x00010111
 200 #define OID_GEN_PROTOCOL_OPTIONS          0x00010112
 201 #define OID_GEN_MAC_OPTIONS               0x00010113
 202 #define OID_GEN_MEDIA_CONNECT_STATUS      0x00010114
 203 #define OID_GEN_MAXIMUM_SEND_PACKETS      0x00010115
 204 #define OID_GEN_VENDOR_DRIVER_VERSION     0x00010116
 205 #define OID_GEN_SUPPORTED_GUIDS           0x00010117
 206 #define OID_GEN_NETWORK_LAYER_ADDRESSES   0x00010118
 207 #define OID_GEN_TRANSPORT_HEADER_OFFSET   0x00010119
 208 #define OID_GEN_MACHINE_NAME              0x0001021A
 209 #define OID_GEN_RNDIS_CONFIG_PARAMETER    0x0001021B
 210 #define OID_GEN_VLAN_ID                   0x0001021C
 211
 212 /* Optional OIDs */
 213 #define OID_GEN_MEDIA_CAPABILITIES        0x00010201
 214 #define OID_GEN_PHYSICAL_MEDIUM           0x00010202
 215
 216 /* Required statistics OIDs */
 217 #define OID_GEN_XMIT_OK                   0x00020101
 218 #define OID_GEN_RCV_OK                    0x00020102
 219 #define OID_GEN_XMIT_ERROR                0x00020103
 220 #define OID_GEN_RCV_ERROR                 0x00020104
 221 #define OID_GEN_RCV_NO_BUFFER             0x00020105
 222
 223 /* Optional statistics OIDs */
 224 #define OID_GEN_DIRECTED_BYTES_XMIT       0x00020201
 225 #define OID_GEN_DIRECTED_FRAMES_XMIT      0x00020202
 226 #define OID_GEN_MULTICAST_BYTES_XMIT      0x00020203
 227 #define OID_GEN_MULTICAST_FRAMES_XMIT     0x00020204
 228 #define OID_GEN_BROADCAST_BYTES_XMIT      0x00020205
 229 #define OID_GEN_BROADCAST_FRAMES_XMIT     0x00020206
 230 #define OID_GEN_DIRECTED_BYTES_RCV        0x00020207
 231 #define OID_GEN_DIRECTED_FRAMES_RCV       0x00020208
 232 #define OID_GEN_MULTICAST_BYTES_RCV       0x00020209
 233 #define OID_GEN_MULTICAST_FRAMES_RCV      0x0002020A
 234 #define OID_GEN_BROADCAST_BYTES_RCV       0x0002020B
 235 #define OID_GEN_BROADCAST_FRAMES_RCV      0x0002020C
 236 #define OID_GEN_RCV_CRC_ERROR             0x0002020D
 237 #define OID_GEN_TRANSMIT_QUEUE_LENGTH     0x0002020E
 238 #define OID_GEN_GET_TIME_CAPS             0x0002020F
 239 #define OID_GEN_GET_NETCARD_TIME          0x00020210
 240 #define OID_GEN_NETCARD_LOAD              0x00020211
 241 #define OID_GEN_DEVICE_PROFILE            0x00020212
 242 #define OID_GEN_INIT_TIME_MS              0x00020213
 243 #define OID_GEN_RESET_COUNTS              0x00020214
 244 #define OID_GEN_MEDIA_SENSE_COUNTS        0x00020215
 245 #define OID_GEN_FRIENDLY_NAME             0x00020216
 246 #define OID_GEN_MINIPORT_INFO             0x00020217
 247 #define OID_GEN_RESET_VERIFY_PARAMETERS   0x00020218
 248
 249 /* IEEE 802.3 (Ethernet) OIDs */
 250 #define NDIS_802_3_MAC_OPTION_PRIORITY    0x00000001
 251
 252 #define OID_802_3_PERMANENT_ADDRESS       0x01010101
 253 #define OID_802_3_CURRENT_ADDRESS         0x01010102
 254 #define OID_802_3_MULTICAST_LIST          0x01010103
 255 #define OID_802_3_MAXIMUM_LIST_SIZE       0x01010104
 256 #define OID_802_3_MAC_OPTIONS             0x01010105
 257 #define OID_802_3_RCV_ERROR_ALIGNMENT     0x01020101
 258 #define OID_802_3_XMIT_ONE_COLLISION      0x01020102
 259 #define OID_802_3_XMIT_MORE_COLLISIONS    0x01020103
 260 #define OID_802_3_XMIT_DEFERRED           0x01020201
 261 #define OID_802_3_XMIT_MAX_COLLISIONS     0x01020202
 262 #define OID_802_3_RCV_OVERRUN             0x01020203
 263 #define OID_802_3_XMIT_UNDERRUN           0x01020204
 264 #define OID_802_3_XMIT_HEARTBEAT_FAILURE  0x01020205
 265 #define OID_802_3_XMIT_TIMES_CRS_LOST     0x01020206
 266 #define OID_802_3_XMIT_LATE_COLLISIONS    0x01020207
 267
 268 #define OID_802_11_BSSID_LIST      0x0D010217
 269 #define OID_802_11_BSSID_LIST_SCAN 0x0D01011A
 270
 271 /* OID_GEN_MINIPORT_INFO constants */
 272 #define NDIS_MINIPORT_BUS_MASTER                      0x00000001
 273 #define NDIS_MINIPORT_WDM_DRIVER                      0x00000002
 274 #define NDIS_MINIPORT_SG_LIST                         0x00000004
 275 #define NDIS_MINIPORT_SUPPORTS_MEDIA_QUERY            0x00000008
 276 #define NDIS_MINIPORT_INDICATES_PACKETS               0x00000010
 277 #define NDIS_MINIPORT_IGNORE_PACKET_QUEUE             0x00000020
 278 #define NDIS_MINIPORT_IGNORE_REQUEST_QUEUE            0x00000040
 279 #define NDIS_MINIPORT_IGNORE_TOKEN_RING_ERRORS        0x00000080
 280 #define NDIS_MINIPORT_INTERMEDIATE_DRIVER             0x00000100
 281 #define NDIS_MINIPORT_IS_NDIS_5                       0x00000200
 282 #define NDIS_MINIPORT_IS_CO                           0x00000400
 283 #define NDIS_MINIPORT_DESERIALIZE                     0x00000800
 284 #define NDIS_MINIPORT_REQUIRES_MEDIA_POLLING          0x00001000
 285 #define NDIS_MINIPORT_SUPPORTS_MEDIA_SENSE            0x00002000
 286 #define NDIS_MINIPORT_NETBOOT_CARD                    0x00004000
 287 #define NDIS_MINIPORT_PM_SUPPORTED                    0x00008000
 288 #define NDIS_MINIPORT_SUPPORTS_MAC_ADDRESS_OVERWRITE  0x00010000
 289 #define NDIS_MINIPORT_USES_SAFE_BUFFER_APIS           0x00020000
 290 #define NDIS_MINIPORT_HIDDEN                          0x00040000
 291 #define NDIS_MINIPORT_SWENUM                          0x00080000
 292 #define NDIS_MINIPORT_SURPRISE_REMOVE_OK              0x00100000
 293 #define NDIS_MINIPORT_NO_HALT_ON_SUSPEND              0x00200000
 294 #define NDIS_MINIPORT_HARDWARE_DEVICE                 0x00400000
 295 #define NDIS_MINIPORT_SUPPORTS_CANCEL_SEND_PACKETS    0x00800000
 296 #define NDIS_MINIPORT_64BITS_DMA                      0x01000000
 297
 298 #define IOCTL_NDIS_QUERY_GLOBAL_STATS CTL_CODE(FILE_DEVICE_PHYSICAL_NETCARD, \
 299                                                0,                            \
 300                                                METHOD_OUT_DIRECT,            \
 301                                                FILE_ANY_ACCESS)
 302
 303 #pragma pack(pop)
 304
 305 #ifdef __cplusplus
 306 }
 307 #endif
 308
 309 #endif /* __NTDDNDIS_H */