Sync with trunk (r48545)
[reactos.git] / include / psdk / 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_
24 #define _NTDDNDIS_
25
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29
30 typedef enum _NDIS_WAN_QUALITY {
31 NdisWanRaw,
32 NdisWanErrorControl,
33 NdisWanReliable
34 } NDIS_WAN_QUALITY, *PNDIS_WAN_QUALITY;
35
36 typedef enum _NDIS_DEVICE_POWER_STATE {
37 NdisDeviceStateUnspecified = 0,
38 NdisDeviceStateD0,
39 NdisDeviceStateD1,
40 NdisDeviceStateD2,
41 NdisDeviceStateD3,
42 NdisDeviceStateMaximum
43 } NDIS_DEVICE_POWER_STATE, *PNDIS_DEVICE_POWER_STATE;
44
45 typedef enum _NDIS_802_11_NETWORK_INFRASTRUCTURE
46 {
47 Ndis802_11IBSS,
48 Ndis802_11Infrastructure,
49 Ndis802_11AutoUnknown,
50 Ndis802_11InfrastructureMax
51 } NDIS_802_11_NETWORK_INFRASTRUCTURE, *PNDIS_802_11_NETWORK_INFRASTRUCTURE;
52
53 typedef enum _NDIS_802_11_NETWORK_TYPE
54 {
55 Ndis802_11FH,
56 Ndis802_11DS,
57 Ndis802_11OFDM5,
58 Ndis802_11OFDM24,
59 Ndis802_11Automode,
60 Ndis802_11NetworkTypeMax
61 } NDIS_802_11_NETWORK_TYPE, *PNDIS_802_11_NETWORK_TYPE;
62
63 typedef struct _NDIS_OBJECT_HEADER
64 {
65 UCHAR Type;
66 UCHAR Revision;
67 USHORT Size;
68 } NDIS_OBJECT_HEADER, *PNDIS_OBJECT_HEADER;
69
70 #define NDIS_802_11_LENGTH_SSID 32
71 #define NDIS_802_11_LENGTH_RATES 8
72
73 typedef UCHAR NDIS_802_11_MAC_ADDRESS[6];
74 typedef LONG NDIS_802_11_RSSI;
75 typedef UCHAR NDIS_802_11_RATES[NDIS_802_11_LENGTH_RATES];
76
77 typedef struct _NDIS_802_11_SSID
78 {
79 ULONG SsidLength;
80 UCHAR Ssid[NDIS_802_11_LENGTH_SSID];
81 } NDIS_802_11_SSID, *PNDIS_802_11_SSID;
82
83 typedef struct _NDIS_802_11_CONFIGURATION_FH
84 {
85 ULONG Length;
86 ULONG HopPattern;
87 ULONG HopSet;
88 ULONG DwellTime;
89 } NDIS_802_11_CONFIGURATION_FH, *PNDIS_802_11_CONFIGURATION_FH;
90
91 typedef struct _NDIS_802_11_CONFIGURATION
92 {
93 ULONG Length;
94 ULONG BeaconPeriod;
95 ULONG ATIMWindow;
96 ULONG DSConfig;
97 NDIS_802_11_CONFIGURATION_FH FHConfig;
98 } NDIS_802_11_CONFIGURATION, *PNDIS_802_11_CONFIGURATION;
99
100 typedef struct _NDIS_WLAN_BSSID
101 {
102 ULONG Length;
103 NDIS_802_11_MAC_ADDRESS MacAddress;
104 UCHAR Reserved[2];
105 NDIS_802_11_SSID Ssid;
106 ULONG Privacy;
107 NDIS_802_11_RSSI Rssi;
108 NDIS_802_11_NETWORK_TYPE NetworkTypeInUse;
109 NDIS_802_11_CONFIGURATION Configuration;
110 NDIS_802_11_NETWORK_INFRASTRUCTURE InfrastructureMode;
111 NDIS_802_11_RATES SupportedRates;
112 } NDIS_WLAN_BSSID, *PNDIS_WLAN_BSSID;
113
114 typedef struct _NDIS_802_11_BSSID_LIST
115 {
116 ULONG NumberOfItems;
117 NDIS_WLAN_BSSID Bssid[1];
118 } NDIS_802_11_BSSID_LIST, *PNDIS_802_11_BSSID_LIST;
119
120 typedef struct _NDIS_PM_WAKE_UP_CAPABILITIES {
121 NDIS_DEVICE_POWER_STATE MinMagicPacketWakeUp;
122 NDIS_DEVICE_POWER_STATE MinPatternWakeUp;
123 NDIS_DEVICE_POWER_STATE MinLinkChangeWakeUp;
124 } NDIS_PM_WAKE_UP_CAPABILITIES, *PNDIS_PM_WAKE_UP_CAPABILITIES;
125
126 /* NDIS_PNP_CAPABILITIES.Flags constants */
127 #define NDIS_DEVICE_WAKE_UP_ENABLE 0x00000001
128 #define NDIS_DEVICE_WAKE_ON_PATTERN_MATCH_ENABLE 0x00000002
129 #define NDIS_DEVICE_WAKE_ON_MAGIC_PACKET_ENABLE 0x00000004
130
131 typedef struct _NDIS_PNP_CAPABILITIES {
132 ULONG Flags;
133 NDIS_PM_WAKE_UP_CAPABILITIES WakeUpCapabilities;
134 } NDIS_PNP_CAPABILITIES, *PNDIS_PNP_CAPABILITIES;
135
136 /* NDIS driver medium (OID_GEN_MEDIA_SUPPORTED / OID_GEN_MEDIA_IN_USE) */
137 typedef enum _NDIS_MEDIUM {
138 NdisMedium802_3,
139 NdisMedium802_5,
140 NdisMediumFddi,
141 NdisMediumWan,
142 NdisMediumLocalTalk,
143 NdisMediumDix,
144 NdisMediumArcnetRaw,
145 NdisMediumArcnet878_2,
146 NdisMediumAtm,
147 NdisMediumWirelessWan,
148 NdisMediumIrda,
149 NdisMediumBpc,
150 NdisMediumCoWan,
151 NdisMedium1394,
152 NdisMediumMax
153 } NDIS_MEDIUM, *PNDIS_MEDIUM;
154
155 typedef enum _NDIS_PHYSICAL_MEDIUM
156 {
157 NdisPhysicalMediumUnspecified,
158 NdisPhysicalMediumWirelessLan,
159 NdisPhysicalMediumCableModem,
160 NdisPhysicalMediumPhoneLine,
161 NdisPhysicalMediumPowerLine,
162 NdisPhysicalMediumDSL,
163 NdisPhysicalMediumFibreChannel,
164 NdisPhysicalMedium1394,
165 NdisPhysicalMediumWirelessWan,
166 NdisPhysicalMediumNative802_11,
167 NdisPhysicalMediumBluetooth,
168 NdisPhysicalMediumInfiniband,
169 NdisPhysicalMediumWiMax,
170 NdisPhysicalMediumUWB,
171 NdisPhysicalMedium802_3,
172 NdisPhysicalMedium802_5,
173 NdisPhysicalMediumIrda,
174 NdisPhysicalMediumWiredWAN,
175 NdisPhysicalMediumWiredCoWan,
176 NdisPhysicalMediumOther,
177 NdisPhysicalMediumMax
178 } NDIS_PHYSICAL_MEDIUM, *PNDIS_PHYSICAL_MEDIUM;
179
180 typedef ULONG NDIS_OID, *PNDIS_OID;
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 /* Hardware status codes (OID_GEN_HARDWARE_STATUS) */
304 typedef enum _NDIS_HARDWARE_STATUS {
305 NdisHardwareStatusReady,
306 NdisHardwareStatusInitializing,
307 NdisHardwareStatusReset,
308 NdisHardwareStatusClosing,
309 NdisHardwareStatusNotReady
310 } NDIS_HARDWARE_STATUS, *PNDIS_HARDWARE_STATUS;
311
312 /* OID_GEN_GET_TIME_CAPS */
313 typedef struct _GEN_GET_TIME_CAPS {
314 ULONG Flags;
315 ULONG ClockPrecision;
316 } GEN_GET_TIME_CAPS, *PGEN_GET_TIME_CAPS;
317
318 /* OID_GEN_GET_NETCARD_TIME */
319 typedef struct _GEN_GET_NETCARD_TIME {
320 ULONGLONG ReadTime;
321 } GEN_GET_NETCARD_TIME, *PGEN_GET_NETCARD_TIME;
322
323 /* State of the LAN media (OID_GEN_MEDIA_CONNECT_STATUS) */
324 typedef enum _NDIS_MEDIA_STATE {
325 NdisMediaStateConnected,
326 NdisMediaStateDisconnected
327 } NDIS_MEDIA_STATE, *PNDIS_MEDIA_STATE;
328
329 #ifndef _NDIS_
330 typedef int NDIS_STATUS, *PNDIS_STATUS;
331 #endif
332
333 /* OID_GEN_SUPPORTED_GUIDS */
334 typedef struct _NDIS_GUID {
335 GUID Guid;
336 union {
337 NDIS_OID Oid;
338 NDIS_STATUS Status;
339 } u;
340 ULONG Size;
341 ULONG Flags;
342 } NDIS_GUID, *PNDIS_GUID;
343
344 typedef struct _NDIS_PM_PACKET_PATTERN {
345 ULONG Priority;
346 ULONG Reserved;
347 ULONG MaskSize;
348 ULONG PatternOffset;
349 ULONG PatternSize;
350 ULONG PatternFlags;
351 } NDIS_PM_PACKET_PATTERN, *PNDIS_PM_PACKET_PATTERN;
352
353 /* OID_GEN_NETWORK_LAYER_ADDRESSES */
354 typedef struct _NETWORK_ADDRESS {
355 USHORT AddressLength;
356 USHORT AddressType;
357 UCHAR Address[1];
358 } NETWORK_ADDRESS, *PNETWORK_ADDRESS;
359
360 typedef struct _NETWORK_ADDRESS_LIST {
361 LONG AddressCount;
362 USHORT AddressType;
363 NETWORK_ADDRESS Address[1];
364 } NETWORK_ADDRESS_LIST, *PNETWORK_ADDRESS_LIST;
365
366 /* OID_GEN_TRANSPORT_HEADER_OFFSET */
367 typedef struct _TRANSPORT_HEADER_OFFSET {
368 USHORT ProtocolType;
369 USHORT HeaderOffset;
370 } TRANSPORT_HEADER_OFFSET, *PTRANSPORT_HEADER_OFFSET;
371
372 /* OID_GEN_CO_LINK_SPEED / OID_GEN_CO_MINIMUM_LINK_SPEED */
373 typedef struct _NDIS_CO_LINK_SPEED {
374 ULONG Outbound;
375 ULONG Inbound;
376 } NDIS_CO_LINK_SPEED, *PNDIS_CO_LINK_SPEED;
377
378 #ifdef __cplusplus
379 }
380 #endif
381
382 #endif /* _NTDDNDIS_ */