ndis_var.h revision 131953
1/*
2 * Copyright (c) 2003
3 *	Bill Paul <wpaul@windriver.com>.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *	This product includes software developed by Bill Paul.
16 * 4. Neither the name of the author nor the names of any co-contributors
17 *    may be used to endorse or promote products derived from this software
18 *    without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30 * THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 * $FreeBSD: head/sys/compat/ndis/ndis_var.h 131953 2004-07-11 00:19:30Z wpaul $
33 */
34
35#ifndef _NDIS_VAR_H_
36#define _NDIS_VAR_H_
37
38/* Forward declarations */
39struct ndis_miniport_block;
40struct ndis_mdriver_block;
41typedef struct ndis_miniport_block ndis_miniport_block;
42typedef struct ndis_mdriver_block ndis_mdriver_block;
43
44/* Base types */
45typedef uint32_t ndis_status;
46typedef void *ndis_handle;
47typedef uint32_t ndis_oid;
48typedef uint32_t ndis_error_code;
49typedef register_t ndis_kspin_lock;
50typedef uint8_t ndis_kirql;
51
52/*
53 * NDIS status codes (there are lots of them). The ones that
54 * don't seem to fit the pattern are actually mapped to generic
55 * NT status codes.
56 */
57
58#define NDIS_STATUS_SUCCESS		0
59#define NDIS_STATUS_PENDING		0x00000103
60#define NDIS_STATUS_NOT_RECOGNIZED	0x00010001
61#define NDIS_STATUS_NOT_COPIED		0x00010002
62#define NDIS_STATUS_NOT_ACCEPTED	0x00010003
63#define NDIS_STATUS_CALL_ACTIVE		0x00010007
64#define NDIS_STATUS_ONLINE		0x40010003
65#define NDIS_STATUS_RESET_START		0x40010004
66#define NDIS_STATUS_RESET_END		0x40010005
67#define NDIS_STATUS_RING_STATUS		0x40010006
68#define NDIS_STATUS_CLOSED		0x40010007
69#define NDIS_STATUS_WAN_LINE_UP		0x40010008
70#define NDIS_STATUS_WAN_LINE_DOWN	0x40010009
71#define NDIS_STATUS_WAN_FRAGMENT	0x4001000A
72#define NDIS_STATUS_MEDIA_CONNECT	0x4001000B
73#define NDIS_STATUS_MEDIA_DISCONNECT	0x4001000C
74#define NDIS_STATUS_HARDWARE_LINE_UP	0x4001000D
75#define NDIS_STATUS_HARDWARE_LINE_DOWN	0x4001000E
76#define NDIS_STATUS_INTERFACE_UP	0x4001000F
77#define NDIS_STATUS_INTERFACE_DOWN	0x40010010
78#define NDIS_STATUS_MEDIA_BUSY		0x40010011
79#define NDIS_STATUS_MEDIA_SPECIFIC_INDICATION	0x40010012
80#define NDIS_STATUS_WW_INDICATION NDIS_STATUS_MEDIA_SPECIFIC_INDICATION
81#define NDIS_STATUS_LINK_SPEED_CHANGE	0x40010013
82#define NDIS_STATUS_WAN_GET_STATS	0x40010014
83#define NDIS_STATUS_WAN_CO_FRAGMENT	0x40010015
84#define NDIS_STATUS_WAN_CO_LINKPARAMS	0x40010016
85#define NDIS_STATUS_NOT_RESETTABLE	0x80010001
86#define NDIS_STATUS_SOFT_ERRORS		0x80010003
87#define NDIS_STATUS_HARD_ERRORS		0x80010004
88#define NDIS_STATUS_BUFFER_OVERFLOW	0x80000005
89#define NDIS_STATUS_FAILURE		0xC0000001
90#define NDIS_STATUS_RESOURCES		0xC000009A
91#define NDIS_STATUS_CLOSING		0xC0010002
92#define NDIS_STATUS_BAD_VERSION		0xC0010004
93#define NDIS_STATUS_BAD_CHARACTERISTICS	0xC0010005
94#define NDIS_STATUS_ADAPTER_NOT_FOUND	0xC0010006
95#define NDIS_STATUS_OPEN_FAILED		0xC0010007
96#define NDIS_STATUS_DEVICE_FAILED	0xC0010008
97#define NDIS_STATUS_MULTICAST_FULL	0xC0010009
98#define NDIS_STATUS_MULTICAST_EXISTS	0xC001000A
99#define NDIS_STATUS_MULTICAST_NOT_FOUND	0xC001000B
100#define NDIS_STATUS_REQUEST_ABORTED	0xC001000C
101#define NDIS_STATUS_RESET_IN_PROGRESS	0xC001000D
102#define NDIS_STATUS_CLOSING_INDICATING	0xC001000E
103#define NDIS_STATUS_NOT_SUPPORTED	0xC00000BB
104#define NDIS_STATUS_INVALID_PACKET	0xC001000F
105#define NDIS_STATUS_OPEN_LIST_FULL	0xC0010010
106#define NDIS_STATUS_ADAPTER_NOT_READY	0xC0010011
107#define NDIS_STATUS_ADAPTER_NOT_OPEN	0xC0010012
108#define NDIS_STATUS_NOT_INDICATING	0xC0010013
109#define NDIS_STATUS_INVALID_LENGTH	0xC0010014
110#define NDIS_STATUS_INVALID_DATA	0xC0010015
111#define NDIS_STATUS_BUFFER_TOO_SHORT	0xC0010016
112#define NDIS_STATUS_INVALID_OID		0xC0010017
113#define NDIS_STATUS_ADAPTER_REMOVED	0xC0010018
114#define NDIS_STATUS_UNSUPPORTED_MEDIA	0xC0010019
115#define NDIS_STATUS_GROUP_ADDRESS_IN_USE	0xC001001A
116#define NDIS_STATUS_FILE_NOT_FOUND	0xC001001B
117#define NDIS_STATUS_ERROR_READING_FILE	0xC001001C
118#define NDIS_STATUS_ALREADY_MAPPED	0xC001001D
119#define NDIS_STATUS_RESOURCE_CONFLICT	0xC001001E
120#define NDIS_STATUS_NO_CABLE		0xC001001F
121#define NDIS_STATUS_INVALID_SAP		0xC0010020
122#define NDIS_STATUS_SAP_IN_USE		0xC0010021
123#define NDIS_STATUS_INVALID_ADDRESS	0xC0010022
124#define NDIS_STATUS_VC_NOT_ACTIVATED	0xC0010023
125#define NDIS_STATUS_DEST_OUT_OF_ORDER	0xC0010024
126#define NDIS_STATUS_VC_NOT_AVAILABLE	0xC0010025
127#define NDIS_STATUS_CELLRATE_NOT_AVAILABLE	0xC0010026
128#define NDIS_STATUS_INCOMPATABLE_QOS	0xC0010027
129#define NDIS_STATUS_AAL_PARAMS_UNSUPPORTED	0xC0010028
130#define NDIS_STATUS_NO_ROUTE_TO_DESTINATION	0xC0010029
131#define NDIS_STATUS_TOKEN_RING_OPEN_ERROR	0xC0011000
132#define NDIS_STATUS_INVALID_DEVICE_REQUEST	0xC0000010
133#define NDIS_STATUS_NETWORK_UNREACHABLE         0xC000023C
134
135/*
136 * NDIS event codes. They are usually reported to NdisWriteErrorLogEntry().
137 */
138
139#define EVENT_NDIS_RESOURCE_CONFLICT	0xC0001388
140#define EVENT_NDIS_OUT_OF_RESOURCE	0xC0001389
141#define EVENT_NDIS_HARDWARE_FAILURE	0xC000138A
142#define EVENT_NDIS_ADAPTER_NOT_FOUND	0xC000138B
143#define EVENT_NDIS_INTERRUPT_CONNECT	0xC000138C
144#define EVENT_NDIS_DRIVER_FAILURE	0xC000138D
145#define EVENT_NDIS_BAD_VERSION		0xC000138E
146#define EVENT_NDIS_TIMEOUT		0x8000138F
147#define EVENT_NDIS_NETWORK_ADDRESS	0xC0001390
148#define EVENT_NDIS_UNSUPPORTED_CONFIGURATION	0xC0001391
149#define EVENT_NDIS_INVALID_VALUE_FROM_ADAPTER	0xC0001392
150#define EVENT_NDIS_MISSING_CONFIGURATION_PARAMETER	0xC0001393
151#define EVENT_NDIS_BAD_IO_BASE_ADDRESS	0xC0001394
152#define EVENT_NDIS_RECEIVE_SPACE_SMALL	0x40001395
153#define EVENT_NDIS_ADAPTER_DISABLED	0x80001396
154#define EVENT_NDIS_IO_PORT_CONFLICT	0x80001397
155#define EVENT_NDIS_PORT_OR_DMA_CONFLICT	0x80001398
156#define EVENT_NDIS_MEMORY_CONFLICT	0x80001399
157#define EVENT_NDIS_INTERRUPT_CONFLICT	0x8000139A
158#define EVENT_NDIS_DMA_CONFLICT		0x8000139B
159#define EVENT_NDIS_INVALID_DOWNLOAD_FILE_ERROR	0xC000139C
160#define EVENT_NDIS_MAXRECEIVES_ERROR	0x8000139D
161#define EVENT_NDIS_MAXTRANSMITS_ERROR	0x8000139E
162#define EVENT_NDIS_MAXFRAMESIZE_ERROR	0x8000139F
163#define EVENT_NDIS_MAXINTERNALBUFS_ERROR	0x800013A0
164#define EVENT_NDIS_MAXMULTICAST_ERROR	0x800013A1
165#define EVENT_NDIS_PRODUCTID_ERROR	0x800013A2
166#define EVENT_NDIS_LOBE_FAILUE_ERROR	0x800013A3
167#define EVENT_NDIS_SIGNAL_LOSS_ERROR	0x800013A4
168#define EVENT_NDIS_REMOVE_RECEIVED_ERROR	0x800013A5
169#define EVENT_NDIS_TOKEN_RING_CORRECTION	0x400013A6
170#define EVENT_NDIS_ADAPTER_CHECK_ERROR	0xC00013A7
171#define EVENT_NDIS_RESET_FAILURE_ERROR	0x800013A8
172#define EVENT_NDIS_CABLE_DISCONNECTED_ERROR	0x800013A9
173#define EVENT_NDIS_RESET_FAILURE_CORRECTION	0x800013AA
174
175/*
176 * NDIS OIDs used by the queryinfo/setinfo routines.
177 * Some are required by all NDIS drivers, some are specific to
178 * a particular type of device, and some are purely optional.
179 * Unfortunately, one of the purely optional OIDs is the one
180 * that lets us set the MAC address of the device.
181 */
182
183/* Required OIDs */
184#define OID_GEN_SUPPORTED_LIST			0x00010101
185#define OID_GEN_HARDWARE_STATUS			0x00010102
186#define OID_GEN_MEDIA_SUPPORTED			0x00010103
187#define OID_GEN_MEDIA_IN_USE			0x00010104
188#define OID_GEN_MAXIMUM_LOOKAHEAD		0x00010105
189#define OID_GEN_MAXIMUM_FRAME_SIZE		0x00010106
190#define OID_GEN_LINK_SPEED			0x00010107
191#define OID_GEN_TRANSMIT_BUFFER_SPACE		0x00010108
192#define OID_GEN_RECEIVE_BUFFER_SPACE		0x00010109
193#define OID_GEN_TRANSMIT_BLOCK_SIZE		0x0001010A
194#define OID_GEN_RECEIVE_BLOCK_SIZE		0x0001010B
195#define OID_GEN_VENDOR_ID			0x0001010C
196#define OID_GEN_VENDOR_DESCRIPTION		0x0001010D
197#define OID_GEN_CURRENT_PACKET_FILTER		0x0001010E
198#define OID_GEN_CURRENT_LOOKAHEAD		0x0001010F
199#define OID_GEN_DRIVER_VERSION			0x00010110
200#define OID_GEN_MAXIMUM_TOTAL_SIZE		0x00010111
201#define OID_GEN_PROTOCOL_OPTIONS		0x00010112
202#define OID_GEN_MAC_OPTIONS			0x00010113
203#define OID_GEN_MEDIA_CONNECT_STATUS		0x00010114
204#define OID_GEN_MAXIMUM_SEND_PACKETS		0x00010115
205#define OID_GEN_VENDOR_DRIVER_VERSION		0x00010116
206#define OID_GEN_SUPPORTED_GUIDS			0x00010117
207#define OID_GEN_NETWORK_LAYER_ADDRESSES		0x00010118	/* Set only */
208#define OID_GEN_TRANSPORT_HEADER_OFFSET		0x00010119	/* Set only */
209#define OID_GEN_MACHINE_NAME			0x0001021A
210#define OID_GEN_RNDIS_CONFIG_PARAMETER		0x0001021B	/* Set only */
211#define OID_GEN_VLAN_ID				0x0001021C
212
213/* Optional OIDs. */
214#define OID_GEN_MEDIA_CAPABILITIES		0x00010201
215#define OID_GEN_PHYSICAL_MEDIUM			0x00010202
216
217/* Required statistics OIDs. */
218#define OID_GEN_XMIT_OK				0x00020101
219#define OID_GEN_RCV_OK				0x00020102
220#define OID_GEN_XMIT_ERROR			0x00020103
221#define OID_GEN_RCV_ERROR			0x00020104
222#define OID_GEN_RCV_NO_BUFFER			0x00020105
223
224/* Optional OID statistics */
225#define OID_GEN_DIRECTED_BYTES_XMIT		0x00020201
226#define OID_GEN_DIRECTED_FRAMES_XMIT		0x00020202
227#define OID_GEN_MULTICAST_BYTES_XMIT		0x00020203
228#define OID_GEN_MULTICAST_FRAMES_XMIT		0x00020204
229#define OID_GEN_BROADCAST_BYTES_XMIT		0x00020205
230#define OID_GEN_BROADCAST_FRAMES_XMIT		0x00020206
231#define OID_GEN_DIRECTED_BYTES_RCV		0x00020207
232#define OID_GEN_DIRECTED_FRAMES_RCV		0x00020208
233#define OID_GEN_MULTICAST_BYTES_RCV		0x00020209
234#define OID_GEN_MULTICAST_FRAMES_RCV		0x0002020A
235#define OID_GEN_BROADCAST_BYTES_RCV		0x0002020B
236#define OID_GEN_BROADCAST_FRAMES_RCV		0x0002020C
237#define OID_GEN_RCV_CRC_ERROR			0x0002020D
238#define OID_GEN_TRANSMIT_QUEUE_LENGTH		0x0002020E
239#define OID_GEN_GET_TIME_CAPS			0x0002020F
240#define OID_GEN_GET_NETCARD_TIME		0x00020210
241#define OID_GEN_NETCARD_LOAD			0x00020211
242#define OID_GEN_DEVICE_PROFILE			0x00020212
243
244/* 802.3 (ethernet) OIDs */
245#define OID_802_3_PERMANENT_ADDRESS		0x01010101
246#define OID_802_3_CURRENT_ADDRESS		0x01010102
247#define OID_802_3_MULTICAST_LIST		0x01010103
248#define OID_802_3_MAXIMUM_LIST_SIZE		0x01010104
249#define OID_802_3_MAC_OPTIONS			0x01010105
250#define NDIS_802_3_MAC_OPTION_PRIORITY		0x00000001
251#define OID_802_3_RCV_ERROR_ALIGNMENT		0x01020101
252#define OID_802_3_XMIT_ONE_COLLISION		0x01020102
253#define OID_802_3_XMIT_MORE_COLLISIONS		0x01020103
254#define OID_802_3_XMIT_DEFERRED			0x01020201
255#define OID_802_3_XMIT_MAX_COLLISIONS		0x01020202
256#define OID_802_3_RCV_OVERRUN			0x01020203
257#define OID_802_3_XMIT_UNDERRUN			0x01020204
258#define OID_802_3_XMIT_HEARTBEAT_FAILURE	0x01020205
259#define OID_802_3_XMIT_TIMES_CRS_LOST		0x01020206
260#define OID_802_3_XMIT_LATE_COLLISIONS		0x01020207
261
262/* PnP and power management OIDs */
263#define OID_PNP_CAPABILITIES			0xFD010100
264#define OID_PNP_SET_POWER			0xFD010101
265#define OID_PNP_QUERY_POWER			0xFD010102
266#define OID_PNP_ADD_WAKE_UP_PATTERN		0xFD010103
267#define OID_PNP_REMOVE_WAKE_UP_PATTERN		0xFD010104
268#define OID_PNP_WAKE_UP_PATTERN_LIST		0xFD010105
269#define OID_PNP_ENABLE_WAKE_UP			0xFD010106
270
271/* PnP/PM Statistics (Optional). */
272#define OID_PNP_WAKE_UP_OK			0xFD020200
273#define OID_PNP_WAKE_UP_ERROR			0xFD020201
274
275/* The following bits are defined for OID_PNP_ENABLE_WAKE_UP */
276#define NDIS_PNP_WAKE_UP_MAGIC_PACKET		0x00000001
277#define NDIS_PNP_WAKE_UP_PATTERN_MATCH		0x00000002
278#define NDIS_PNP_WAKE_UP_LINK_CHANGE		0x00000004
279
280/* 802.11 OIDs */
281#define OID_802_11_BSSID			0x0D010101
282#define OID_802_11_SSID				0x0D010102
283#define OID_802_11_NETWORK_TYPES_SUPPORTED	0x0D010203
284#define OID_802_11_NETWORK_TYPE_IN_USE		0x0D010204
285#define OID_802_11_TX_POWER_LEVEL		0x0D010205
286#define OID_802_11_RSSI				0x0D010206
287#define OID_802_11_RSSI_TRIGGER			0x0D010207
288#define OID_802_11_INFRASTRUCTURE_MODE		0x0D010108
289#define OID_802_11_FRAGMENTATION_THRESHOLD	0x0D010209
290#define OID_802_11_RTS_THRESHOLD		0x0D01020A
291#define OID_802_11_NUMBER_OF_ANTENNAS		0x0D01020B
292#define OID_802_11_RX_ANTENNA_SELECTED		0x0D01020C
293#define OID_802_11_TX_ANTENNA_SELECTED		0x0D01020D
294#define OID_802_11_SUPPORTED_RATES		0x0D01020E
295#define OID_802_11_DESIRED_RATES		0x0D010210
296#define OID_802_11_CONFIGURATION		0x0D010211
297#define OID_802_11_STATISTICS			0x0D020212
298#define OID_802_11_ADD_WEP			0x0D010113
299#define OID_802_11_REMOVE_WEP			0x0D010114
300#define OID_802_11_DISASSOCIATE			0x0D010115
301#define OID_802_11_POWER_MODE			0x0D010216
302#define OID_802_11_BSSID_LIST			0x0D010217
303#define OID_802_11_AUTHENTICATION_MODE		0x0D010118
304#define OID_802_11_PRIVACY_FILTER		0x0D010119
305#define OID_802_11_BSSID_LIST_SCAN		0x0D01011A
306#define OID_802_11_WEP_STATUS			0x0D01011B
307#define OID_802_11_ENCRYPTION_STATUS		OID_802_11_WEP_STATUS
308#define OID_802_11_RELOAD_DEFAULTS		0x0D01011C
309#define OID_802_11_ADD_KEY			0x0D01011D
310#define OID_802_11_REMOVE_KEY			0x0D01011E
311#define OID_802_11_ASSOCIATION_INFORMATION	0x0D01011F
312#define OID_802_11_TEST				0x0D010120
313
314/* structures/definitions for 802.11 */
315#define NDIS_80211_NETTYPE_11FH		0x00000000
316#define NDIS_80211_NETTYPE_11DS		0x00000001
317#define NDIS_80211_NETTYPE_11OFDM5	0x00000002
318#define NDIS_80211_NETTYPE_11OFDM24	0x00000003
319
320struct ndis_80211_nettype_list {
321	uint32_t		ntl_items;
322	uint32_t		ntl_type[1];
323};
324
325#define NDIS_80211_POWERMODE_CAM	0x00000000
326#define NDIS_80211_POWERMODE_MAX_PSP	0x00000001
327#define NDIS_80211_POWERMODE_FAST_PSP	0x00000002
328
329typedef uint32_t ndis_80211_power;	/* Power in milliwatts */
330typedef uint32_t ndis_80211_rssi;	/* Signal strength in dBm */
331
332struct ndis_80211_config_fh {
333	uint32_t		ncf_length;
334	uint32_t		ncf_hoppatterh;
335	uint32_t		ncf_hopset;
336	uint32_t		ncf_dwelltime;
337};
338
339typedef struct ndis_80211_config_fh ndis_80211_config_fh;
340
341struct ndis_80211_config {
342	uint32_t		nc_length;
343	uint32_t		nc_beaconperiod;
344	uint32_t		nc_atimwin;
345	uint32_t		nc_dsconfig;
346	ndis_80211_config_fh	nc_fhconfig;
347};
348
349typedef struct ndis_80211_config ndis_80211_config;
350
351struct ndis_80211_stats {
352	uint32_t		ns_length;
353	uint64_t		ns_txfragcnt;
354	uint64_t		ns_txmcastcnt;
355	uint64_t		ns_failedcnt;
356	uint64_t		ns_retrycnt;
357	uint64_t		ns_multiretrycnt;
358	uint64_t		ns_rtssuccesscnt;
359	uint64_t		ns_rtsfailcnt;
360	uint64_t		ns_ackfailcnt;
361	uint64_t		ns_dupeframecnt;
362	uint64_t		ns_rxfragcnt;
363	uint64_t		ns_rxmcastcnt;
364	uint64_t		ns_fcserrcnt;
365};
366
367typedef struct ndis_80211_stats ndis_80211_stats;
368
369typedef uint32_t ndis_80211_key_idx;
370
371struct ndis_80211_wep {
372	uint32_t		nw_length;
373	uint32_t		nw_keyidx;
374	uint32_t		nw_keylen;
375	uint8_t			nw_keydata[256];
376};
377
378typedef struct ndis_80211_wep ndis_80211_wep;
379
380#define NDIS_80211_WEPKEY_TX		0x80000000
381#define NDIS_80211_WEPKEY_PERCLIENT	0x40000000
382
383#define NDIS_80211_NET_INFRA_IBSS	0x00000000
384#define NDIS_80211_NET_INFRA_BSS	0x00000001
385#define NDIS_80211_NET_INFRA_AUTO	0x00000002
386
387#define NDIS_80211_AUTHMODE_OPEN	0x00000000
388#define NDIS_80211_AUTHMODE_SHARED	0x00000001
389#define NDIS_80211_AUTHMODE_AUTO	0x00000002
390#define NDIS_80211_AUTHMODE_WPA		0x00000003
391#define NDIS_80211_AUTHMODE_WPAPSK	0x00000004
392#define NDIS_80211_AUTHMODE_WPANONE	0x00000005
393
394typedef uint8_t ndis_80211_rates[8];
395typedef uint8_t ndis_80211_rates_ex[16];
396typedef uint8_t ndis_80211_macaddr[6];
397
398struct ndis_80211_ssid {
399	uint32_t		ns_ssidlen;
400	uint8_t			ns_ssid[32];
401};
402
403typedef struct ndis_80211_ssid ndis_80211_ssid;
404
405struct ndis_wlan_bssid {
406	uint32_t		nwb_length;
407	ndis_80211_macaddr	nwb_macaddr;
408	uint8_t			nwb_rsvd[2];
409	ndis_80211_ssid		nwb_ssid;
410	uint32_t		nwb_privacy;
411	ndis_80211_rssi		nwb_rssi;
412	uint32_t		nwb_nettype;
413	ndis_80211_config	nwb_config;
414	uint32_t		nwb_netinfra;
415	ndis_80211_rates	nwb_supportedrates;
416};
417
418typedef struct ndis_wlan_bssid ndis_wlan_bssid;
419
420struct ndis_80211_bssid_list {
421	uint32_t		nbl_items;
422	ndis_wlan_bssid		nbl_bssid[1];
423};
424
425typedef struct ndis_80211_bssid_list ndis_80211_bssid_list;
426
427struct ndis_wlan_bssid_ex {
428	uint32_t		nwbx_len;
429	ndis_80211_macaddr	nwbx_macaddr;
430	uint8_t			nwbx_rsvd[2];
431	ndis_80211_ssid		nwbx_ssid;
432	uint32_t		nwbx_privacy;
433	ndis_80211_rssi		nwbx_rssi;
434	uint32_t		nwbx_nettype;
435	ndis_80211_config	nwbx_config;
436	uint32_t		nwbx_netinfra;
437	ndis_80211_rates_ex	nwbx_supportedrates;
438	uint32_t		nwbx_ielen;
439	uint32_t		nwbx_ies[1];
440};
441
442typedef struct ndis_wlan_bssid_ex ndis_wlan_bssid_ex;
443
444struct ndis_80211_bssid_list_ex {
445	uint32_t		nblx_items;
446	ndis_wlan_bssid_ex	nblx_bssid[1];
447};
448
449typedef struct ndis_80211_bssid_list_ex ndis_80211_bssid_list_ex;
450
451struct ndis_80211_fixed_ies {
452	uint8_t			nfi_tstamp[8];
453	uint16_t		nfi_beaconint;
454	uint16_t		nfi_caps;
455};
456
457struct ndis_80211_variable_ies {
458	uint8_t			nvi_elemid;
459	uint8_t			nvi_len;
460	uint8_t			nvi_data[1];
461};
462
463typedef uint32_t ndis_80211_fragthresh;
464typedef uint32_t ndis_80211_rtsthresh;
465typedef uint32_t ndis_80211_antenna;
466
467#define NDIS_80211_PRIVFILT_ACCEPTALL	0x00000000
468#define NDIS_80211_PRIVFILT_8021XWEP	0x00000001
469
470#define NDIS_80211_WEPSTAT_ENABLED	0x00000000
471#define NDIS_80211_WEPSTAT_ENC1ENABLED	NDIS_80211_WEPSTAT_ENABLED
472#define NDIS_80211_WEPSTAT_DISABLED	0x00000001
473#define NDIS_80211_WEPSTAT_ENCDISABLED	NDIS_80211_WEPSTAT_DISABLED
474#define NDIS_80211_WEPSTAT_KEYABSENT	0x00000002
475#define NDIS_80211_WEPSTAT_ENC1KEYABSENT	NDIS_80211_WEPSTAT_KEYABSENT
476#define NDIS_80211_WEPSTAT_NOTSUPPORTED	0x00000003
477#define NDIS_80211_WEPSTAT_ENCNOTSUPPORTED	NDIS_80211_WEPSTAT_NOTSUPPORTED
478#define NDIS_80211_WEPSTAT_ENC2ENABLED	0x00000004
479#define NDIS_80211_WEPSTAT_ENC2KEYABSENT	0x00000005
480#define NDIS_80211_WEPSTAT_ENC3ENABLED	0x00000006
481#define NDIS_80211_WEPSTAT_ENC3KEYABSENT	0x00000007
482
483#define NDIS_80211_RELOADDEFAULT_WEP	0x00000000
484
485#define NDIS_80211_STATUSTYPE_AUTH	0x00000000
486
487struct ndis_80211_status_indication {
488	uint32_t		nsi_type;
489};
490
491typedef struct ndis_80211_status_indication ndis_80211_status_indication;
492
493struct ndis_80211_auth_request {
494	uint32_t		nar_len;
495	ndis_80211_macaddr	nar_bssid;
496	uint32_t		nar_flags;
497};
498
499typedef struct ndis_80211_auth_request ndis_80211_auth_request;
500
501struct ndis_80211_key {
502	uint32_t		nk_len;
503	uint32_t		nk_keyidx;
504	uint32_t		nk_keylen;
505	ndis_80211_macaddr	nk_bssid;
506	uint64_t		nk_keyrsc;
507	uint8_t			nk_keydata[256];
508};
509
510typedef struct ndis_80211_key ndis_80211_key;
511
512struct ndis_80211_remove_key {
513	uint32_t		nk_len;
514	uint32_t		nk_keyidx;
515	ndis_80211_macaddr	nk_bssid;
516};
517
518typedef struct ndis_80211_remove_key ndis_80211_remove_key;
519
520#define NDIS_80211_AI_REQFI_CAPABILITIES	0x00000001
521#define NDIS_80211_AI_REQFI_LISTENINTERVAL	0x00000002
522#define NDIS_80211_AI_REQFI_CURRENTAPADDRESS	0x00000004
523
524#define NDIS_80211_AI_RESFI_CAPABILITIES	0x00000001
525#define NDIS_80211_AI_RESFI_STATUSCODE		0x00000002
526#define NDIS_80211_AI_RESFI_ASSOCIATIONID	0x00000004
527
528struct ndis_80211_ai_reqfi {
529	uint16_t		naq_caps;
530	uint16_t		naq_listentint;
531	ndis_80211_macaddr	naq_currentapaddr;
532};
533
534typedef struct ndis_80211_ai_reqfi ndis_80211_ai_reqfi;
535
536struct ndis_80211_ai_resfi {
537	uint16_t		nas_caps;
538	uint16_t		nas_statuscode;
539	uint16_t		nas_associd;
540};
541
542typedef struct ndis_80211_ai_resfi ndis_80211_ai_resfi;
543
544struct ndis_80211_assoc_info {
545	uint32_t		nai_len;
546	uint16_t		nai_avail_req_fixed_ies;
547	ndis_80211_ai_reqfi	nai_req_fixed_ies;
548	uint32_t		nai_req_ielen;
549	uint32_t		nai_offset_req_ies;
550	uint16_t		nai_avail_resp_fixed_ies;
551	ndis_80211_ai_resfi	nai_resp_fixed_iex;
552	uint32_t		nai_resp_ielen;
553	uint32_t		nai_offset_resp_ies;
554};
555
556typedef struct ndis_80211_assoc_info ndis_80211_assoc_info;
557
558struct ndis_80211_auth_event {
559	ndis_80211_status_indication	nae_status;
560	ndis_80211_auth_request		nae_request[1];
561};
562
563typedef struct ndis_80211_auth_event ndis_80211_auth_event;
564
565struct ndis_80211_test {
566	uint32_t		nt_len;
567	uint32_t		nt_type;
568	union {
569		ndis_80211_auth_event	nt_authevent;
570		uint32_t		nt_rssitrigger;
571	} u;
572};
573
574typedef struct ndis_80211_test ndis_80211_test;
575
576/* TCP OIDs. */
577
578#define OID_TCP_TASK_OFFLOAD			0xFC010201
579#define OID_TCP_TASK_IPSEC_ADD_SA		0xFC010202
580#define OID_TCP_TASK_IPSEC_DELETE_SA		0xFC010203
581#define OID_TCP_SAN_SUPPORT			0xFC010204
582
583
584#define NDIS_TASK_OFFLOAD_VERSION 1
585
586#define NDIS_TASK_TCPIP_CSUM			0x00000000
587#define NDIS_TASK_IPSEC				0x00000001
588#define NDIS_TASK_TCP_LARGESEND			0x00000002
589
590#define NDIS_ENCAP_UNSPEC			0x00000000
591#define NDIS_ENCAP_NULL				0x00000001
592#define NDIS_ENCAP_IEEE802_3			0x00000002
593#define NDIS_ENCAP_IEEE802_5			0x00000003
594#define NDIS_ENCAP_SNAP_ROUTED			0x00000004
595#define NDIS_ENCAP_SNAP_BRIDGED			0x00000005
596
597#define NDIS_ENCAPFLAG_FIXEDHDRLEN		0x00000001
598
599struct ndis_encap_fmt {
600	uint32_t		nef_encap;
601	uint32_t		nef_flags;
602	uint32_t		nef_encaphdrlen;
603};
604
605typedef struct ndis_encap_fmt ndis_encap_fmt;
606
607struct ndis_task_offload_hdr {
608	uint32_t		ntoh_vers;
609	uint32_t		ntoh_len;
610	uint32_t		ntoh_rsvd;
611	uint32_t		ntoh_offset_firsttask;
612	ndis_encap_fmt		ntoh_encapfmt;
613};
614
615typedef struct ndis_task_offload_hdr ndis_task_offload_hdr;
616
617struct ndis_task_offload {
618	uint32_t		nto_vers;
619	uint32_t		nto_len;
620	uint32_t		nto_task;
621	uint32_t		nto_offset_nexttask;
622	uint32_t		nto_taskbuflen;
623	uint8_t			nto_taskbuf[1];
624};
625
626typedef struct ndis_task_offload ndis_task_offload;
627
628#define NDIS_TCPSUM_FLAGS_IP_OPTS	0x00000001
629#define NDIS_TCPSUM_FLAGS_TCP_OPTS	0x00000002
630#define NDIS_TCPSUM_FLAGS_TCP_CSUM	0x00000004
631#define NDIS_TCPSUM_FLAGS_UDP_CSUM	0x00000008
632#define NDIS_TCPSUM_FLAGS_IP_CSUM	0x00000010
633
634struct ndis_task_tcpip_csum {
635	uint32_t		nttc_v4tx;
636	uint32_t		nttc_v4rx;
637	uint32_t		nttc_v6tx;
638	uint32_t		nttc_v6rx;
639};
640
641typedef struct ndis_task_tcpip_csum ndis_task_tcpip_csum;
642
643struct ndis_task_tcp_largesend {
644	uint32_t		nttl_vers;
645	uint32_t		nttl_maxofflen;
646	uint32_t		nttl_minsegcnt;
647	uint8_t			nttl_tcpopt;
648	uint8_t			nttl_ipopt;
649};
650
651typedef struct ndis_task_tcp_largesend ndis_task_tcp_largesend;
652
653#define NDIS_IPSEC_AH_MD5		0x00000001
654#define NDIS_IPSEC_AH_SHA1		0x00000002
655#define NDIS_IPSEC_AH_TRANSPORT		0x00000004
656#define NDIS_IPSEC_AH_TUNNEL		0x00000008
657#define NDIS_IPSEC_AH_SEND		0x00000010
658#define NDIS_IPSEC_AH_RECEIVE		0x00000020
659
660#define NDIS_IPSEC_ESP_DES		0x00000001
661#define NDIS_IPSEC_ESP_RSVD		0x00000002
662#define NDIS_IPSEC_ESP_3DES		0x00000004
663#define NDIS_IPSEC_ESP_NULL		0x00000008
664#define NDIS_IPSEC_ESP_TRANSPORT	0x00000010
665#define NDIS_IPSEC_ESP_TUNNEL		0x00000020
666#define NDIS_IPSEC_ESP_SEND		0x00000040
667#define NDIS_IPSEC_ESP_RECEIVE		0x00000080
668
669struct ndis_task_ipsec {
670	uint32_t		nti_ah_esp_combined;
671	uint32_t		nti_ah_transport_tunnel_combined;
672	uint32_t		nti_v4_options;
673	uint32_t		nti_rsvd;
674	uint32_t		nti_v4ah;
675	uint32_t		nti_v4esp;
676};
677
678typedef struct ndis_task_ipsec ndis_task_ipsec;
679
680/*
681 * Attribures of NDIS drivers. Not all drivers support
682 * all attributes.
683 */
684
685#define NDIS_ATTRIBUTE_IGNORE_REQUEST_TIMEOUT		0x00000002
686#define NDIS_ATTRIBUTE_IGNORE_TOKEN_RING_ERRORS		0x00000004
687#define NDIS_ATTRIBUTE_BUS_MASTER			0x00000008
688#define NDIS_ATTRIBUTE_INTERMEDIATE_DRIVER		0x00000010
689#define NDIS_ATTRIBUTE_DESERIALIZE			0x00000020
690#define NDIS_ATTRIBUTE_NO_HALT_ON_SUSPEND		0x00000040
691#define NDIS_ATTRIBUTE_SURPRISE_REMOVE_OK		0x00000080
692#define NDIS_ATTRIBUTE_NOT_CO_NDIS			0x00000100
693#define NDIS_ATTRIBUTE_USES_SAFE_BUFFER_APIS		0x00000200
694
695enum ndis_media_state {
696	nmc_connected,
697	nmc_disconnected
698};
699
700typedef enum ndis_media_state ndis_media_state;
701
702/* Ndis Packet Filter Bits (OID_GEN_CURRENT_PACKET_FILTER). */
703
704#define NDIS_PACKET_TYPE_DIRECTED               0x00000001
705#define NDIS_PACKET_TYPE_MULTICAST              0x00000002
706#define NDIS_PACKET_TYPE_ALL_MULTICAST          0x00000004
707#define NDIS_PACKET_TYPE_BROADCAST              0x00000008
708#define NDIS_PACKET_TYPE_SOURCE_ROUTING         0x00000010
709#define NDIS_PACKET_TYPE_PROMISCUOUS            0x00000020
710#define NDIS_PACKET_TYPE_SMT                    0x00000040
711#define NDIS_PACKET_TYPE_ALL_LOCAL              0x00000080
712#define NDIS_PACKET_TYPE_GROUP                  0x00001000
713#define NDIS_PACKET_TYPE_ALL_FUNCTIONAL         0x00002000
714#define NDIS_PACKET_TYPE_FUNCTIONAL             0x00004000
715#define NDIS_PACKET_TYPE_MAC_FRAME              0x00008000
716
717
718/* Ndis MAC option bits (OID_GEN_MAC_OPTIONS). */
719
720#define NDIS_MAC_OPTION_COPY_LOOKAHEAD_DATA             0x00000001
721#define NDIS_MAC_OPTION_RECEIVE_SERIALIZED              0x00000002
722#define NDIS_MAC_OPTION_TRANSFERS_NOT_PEND              0x00000004
723#define NDIS_MAC_OPTION_NO_LOOPBACK                     0x00000008
724#define NDIS_MAC_OPTION_FULL_DUPLEX                     0x00000010
725#define NDIS_MAC_OPTION_EOTX_INDICATION                 0x00000020
726#define NDIS_MAC_OPTION_8021P_PRIORITY                  0x00000040
727#define NDIS_MAC_OPTION_SUPPORTS_MAC_ADDRESS_OVERWRITE  0x00000080
728#define NDIS_MAC_OPTION_RECEIVE_AT_DPC                  0x00000100
729#define NDIS_MAC_OPTION_8021Q_VLAN                      0x00000200
730#define NDIS_MAC_OPTION_RESERVED                        0x80000000
731
732#define NDIS_DMA_24BITS		0x00
733#define NDIS_DMA_32BITS		0x01
734#define NDIS_DMA_64BITS		0x02
735
736struct ndis_physaddr {
737	uint64_t		np_quad;
738#ifdef notdef
739	uint32_t		np_low;
740	uint32_t		np_high;
741#endif
742};
743
744typedef struct ndis_physaddr ndis_physaddr;
745
746struct ndis_ansi_string {
747	uint16_t		nas_len;
748	uint16_t		nas_maxlen;
749	char			*nas_buf;
750};
751
752typedef struct ndis_ansi_string ndis_ansi_string;
753
754/*
755 * nus_buf is really a wchar_t *, but it's inconvenient to include
756 * all the necessary header goop needed to define it, and it's a
757 * pointer anyway, so for now, just make it a uint16_t *.
758 */
759struct ndis_unicode_string {
760	uint16_t		nus_len;
761	uint16_t		nus_maxlen;
762	uint16_t		*nus_buf;
763};
764
765typedef struct ndis_unicode_string ndis_unicode_string;
766
767
768enum ndis_parm_type {
769	ndis_parm_int,
770	ndis_parm_hexint,
771	ndis_parm_string,
772	ndis_parm_multistring,
773	ndis_parm_binary
774};
775
776typedef enum ndis_parm_type ndis_parm_type;
777
778struct ndis_binary_data {
779	uint16_t		nbd_len;
780	void			*nbd_buf;
781};
782
783typedef struct ndis_binary_data ndis_binary_data;
784
785struct ndis_config_parm {
786	ndis_parm_type		ncp_type;
787	union {
788		uint32_t		ncp_intdata;
789		ndis_unicode_string	ncp_stringdata;
790		ndis_binary_data	ncp_binarydata;
791	} ncp_parmdata;
792};
793
794typedef struct ndis_config_parm ndis_config_parm;
795
796#ifdef notdef
797struct ndis_list_entry {
798	struct ndis_list_entry *nle_flink;
799	struct ndis_list_entry *nle_blink;
800};
801
802typedef struct ndis_list_entry ndis_list_entry;
803#endif
804
805struct ndis_bind_paths {
806	uint32_t		nbp_number;
807	ndis_unicode_string	nbp_paths[1];
808};
809
810typedef struct ndis_bind_paths ndis_bind_paths;
811
812#ifdef notdef
813struct dispatch_header {
814	uint8_t			dh_type;
815	uint8_t			dh_abs;
816	uint8_t			dh_size;
817	uint8_t			dh_inserted;
818	uint32_t		dh_sigstate;
819	list_entry		dh_waitlisthead;
820};
821#endif
822
823#define dispatch_header nt_dispatch_header
824
825struct ndis_ktimer {
826	struct dispatch_header	nk_header;
827	uint64_t		nk_duetime;
828	list_entry		nk_timerlistentry;
829	void			*nk_dpc;
830	uint32_t		nk_period;
831};
832
833struct ndis_kevent {
834	struct dispatch_header	nk_header;
835};
836
837struct ndis_event {
838	struct nt_kevent	ne_event;
839};
840
841typedef struct ndis_event ndis_event;
842
843/* Kernel defered procedure call (i.e. timer callback) */
844
845struct ndis_kdpc;
846typedef void (*ndis_kdpc_func)(struct ndis_kdpc *, void *, void *, void *);
847
848struct ndis_kdpc {
849	uint16_t		nk_type;
850	uint8_t			nk_num;
851	uint8_t			nk_importance;
852	list_entry		nk_dpclistentry;
853	ndis_kdpc_func		nk_deferedfunc;
854	void			*nk_deferredctx;
855	void			*nk_sysarg1;
856	void			*nk_sysarg2;
857	uint32_t		*nk_lock;
858};
859
860struct ndis_timer {
861	struct ktimer		nt_ktimer;
862	struct kdpc		nt_kdpc;
863};
864
865typedef struct ndis_timer ndis_timer;
866
867typedef void (*ndis_timer_function)(void *, void *, void *, void *);
868
869struct ndis_miniport_timer {
870	struct ktimer		nmt_ktimer;
871	struct kdpc		nmt_kdpc;
872	ndis_timer_function	nmt_timerfunc;
873	void			*nmt_timerctx;
874	ndis_miniport_block	*nmt_block;
875	struct ndis_miniport_timer	*nmt_nexttimer;
876};
877
878typedef struct ndis_miniport_timer ndis_miniport_timer;
879
880struct ndis_spin_lock {
881	ndis_kspin_lock		nsl_spinlock;
882	ndis_kirql		nsl_kirql;
883};
884
885typedef struct ndis_spin_lock ndis_spin_lock;
886
887struct ndis_request {
888	uint8_t			nr_macreserved[4*sizeof(void *)];
889	uint32_t		nr_requesttype;
890	union _ndis_data {
891		struct _ndis_query_information {
892			ndis_oid	nr_oid;
893			void		*nr_infobuf;
894			uint32_t	nr_infobuflen;
895			uint32_t	nr_byteswritten;
896			uint32_t	nr_bytesneeded;
897		} ndis_query_information;
898		struct _ndis_set_information {
899			ndis_oid	nr_oid;
900			void		*nr_infobuf;
901			uint32_t	nr_infobuflen;
902			uint32_t	nr_byteswritten;
903			uint32_t	nr_bytesneeded;
904		} ndis_set_information;
905	} ndis_data;
906	/* NDIS 5.0 extentions */
907	uint8_t			nr_ndis_rsvd[9 * sizeof(void *)];
908	union {
909		uint8_t		nr_callmgr_rsvd[2 * sizeof(void *)];
910		uint8_t		nr_protocol_rsvd[2 * sizeof(void *)];
911	} u;
912	uint8_t			nr_miniport_rsvd[2 * sizeof(void *)];
913};
914
915typedef struct ndis_request ndis_request;
916
917/*
918 * Filler, not used.
919 */
920struct ndis_miniport_interrupt {
921	void			*ni_introbj;
922	ndis_kspin_lock		ni_dpccountlock;
923	void			*ni_rsvd;
924	void			*ni_isrfunc;
925	void			*ni_dpcfunc;
926	struct ndis_kdpc	ni_dpc;
927	ndis_miniport_block	*ni_block;
928	uint8_t			ni_dpccnt;
929	uint8_t			ni_filler1;
930	struct ndis_kevent	ni_dpcsdoneevent;
931	uint8_t			ni_shared;
932	uint8_t			ni_isrreq;
933};
934
935typedef struct ndis_miniport_interrupt ndis_miniport_interrupt;
936
937enum ndis_interrupt_mode {
938	nim_level,
939	nim_latched
940};
941
942typedef enum ndis_interrupt_mode ndis_interrupt_mode;
943
944struct ndis_work_item;
945
946typedef void (*ndis_proc)(struct ndis_work_item *, void *);
947
948struct ndis_work_item {
949	void			*nwi_ctx;
950	ndis_proc		nwi_func;
951	uint8_t			nwi_wraprsvd[sizeof(void *) * 8];
952};
953
954typedef struct ndis_work_item ndis_work_item;
955
956struct ndis_buffer {
957	struct ndis_buffer	*nb_next;
958	uint16_t		nb_size;
959	uint16_t		nb_flags;
960	void			*nb_process;
961	void			*nb_mappedsystemva;
962	void			*nb_startva;
963	uint32_t		nb_bytecount;
964	uint32_t		nb_byteoffset;
965};
966
967typedef struct ndis_buffer ndis_buffer;
968
969struct ndis_sc_element {
970	ndis_physaddr		nse_addr;
971	uint32_t		nse_len;
972	uint32_t		*nse_rsvd;
973};
974
975typedef struct ndis_sc_element ndis_sc_element;
976
977#define NDIS_MAXSEG		32
978#define NDIS_BUS_SPACE_SHARED_MAXADDR	0x3E7FFFFF
979
980struct ndis_sc_list {
981	uint32_t		nsl_frags;
982	uint32_t		*nsl_rsvd;
983	ndis_sc_element		nsl_elements[NDIS_MAXSEG];
984};
985
986typedef struct ndis_sc_list ndis_sc_list;
987
988struct ndis_tcpip_csum {
989	union {
990		uint32_t		ntc_txflags;
991		uint32_t		ntc_rxflags;
992		uint32_t		ntc_val;
993	} u;
994};
995
996typedef struct ndis_tcpip_csum ndis_tcpip_csum;
997
998#define NDIS_TXCSUM_DO_IPV4		0x00000001
999#define NDIS_TXCSUM_DO_IPV6		0x00000002
1000#define NDIS_TXCSUM_DO_TCP		0x00000004
1001#define NDIS_TXCSUM_DO_UDP		0x00000008
1002#define NDIS_TXCSUM_DO_IP		0x00000010
1003
1004#define NDIS_RXCSUM_TCP_FAILED		0x00000001
1005#define NDIS_RXCSUM_UDP_FAILED		0x00000002
1006#define NDIS_RXCSUM_IP_FAILED		0x00000004
1007#define NDIS_RXCSUM_TCP_PASSED		0x00000008
1008#define NDIS_RXCSUM_UDP_PASSED		0x00000010
1009#define NDIS_RXCSUM_IP_PASSED		0x00000020
1010#define NDIS_RXCSUM_LOOPBACK		0x00000040
1011
1012struct ndis_vlan {
1013	union {
1014		struct {
1015			uint32_t			nvt_userprio:3;
1016			uint32_t			nvt_canformatid:1;
1017			uint32_t			nvt_vlanid:12;
1018			uint32_t			nvt_rsvd:16;
1019		} nv_taghdr;
1020	} u;
1021};
1022
1023typedef struct ndis_vlan ndis_vlan;
1024
1025enum ndis_perpkt_info {
1026	ndis_tcpipcsum_info,
1027	ndis_ipsec_info,
1028	ndis_largesend_info,
1029	ndis_classhandle_info,
1030	ndis_rsvd,
1031	ndis_sclist_info,
1032	ndis_ieee8021q_info,
1033	ndis_originalpkt_info,
1034        ndis_packetcancelid,
1035	ndis_maxpkt_info
1036};
1037
1038typedef enum ndis_perpkt_info ndis_perpkt_info;
1039
1040struct ndis_packet_extension {
1041	void			*npe_info[ndis_maxpkt_info];
1042};
1043
1044typedef struct ndis_packet_extension ndis_packet_extension;
1045
1046struct ndis_packet_private {
1047	uint32_t		npp_physcnt;
1048	uint32_t		npp_totlen;
1049	ndis_buffer		*npp_head;
1050	ndis_buffer		*npp_tail;
1051
1052	void			*npp_pool;
1053	uint32_t		npp_count;
1054	uint32_t		npp_flags;
1055	uint8_t			npp_validcounts;
1056	uint8_t			npp_ndispktflags;
1057	uint16_t		npp_packetooboffset;
1058};
1059
1060#define NDIS_FLAGS_PROTOCOL_ID_MASK             0x0000000F
1061#define NDIS_FLAGS_MULTICAST_PACKET             0x00000010
1062#define NDIS_FLAGS_RESERVED2                    0x00000020
1063#define NDIS_FLAGS_RESERVED3                    0x00000040
1064#define NDIS_FLAGS_DONT_LOOPBACK                0x00000080
1065#define NDIS_FLAGS_IS_LOOPBACK_PACKET           0x00000100
1066#define NDIS_FLAGS_LOOPBACK_ONLY                0x00000200
1067#define NDIS_FLAGS_RESERVED4                    0x00000400
1068#define NDIS_FLAGS_DOUBLE_BUFFERED              0x00000800
1069#define NDIS_FLAGS_SENT_AT_DPC                  0x00001000
1070#define NDIS_FLAGS_USES_SG_BUFFER_LIST          0x00002000
1071
1072#define NDIS_PACKET_WRAPPER_RESERVED			0x3F
1073#define NDIS_PACKET_CONTAINS_MEDIA_SPECIFIC_INFO	0x40
1074#define NDIS_PACKET_ALLOCATED_BY_NDIS			0x80
1075
1076#define NDIS_PROTOCOL_ID_DEFAULT        0x00
1077#define NDIS_PROTOCOL_ID_TCP_IP         0x02
1078#define NDIS_PROTOCOL_ID_IPX            0x06
1079#define NDIS_PROTOCOL_ID_NBF            0x07
1080#define NDIS_PROTOCOL_ID_MAX            0x0F
1081#define NDIS_PROTOCOL_ID_MASK           0x0F
1082
1083typedef struct ndis_packet_private ndis_packet_private;
1084
1085enum ndis_classid {
1086	ndis_class_802_3prio,
1087	ndis_class_wirelesswan_mbx,
1088	ndis_class_irda_packetinfo,
1089	ndis_class_atm_aainfo
1090};
1091
1092typedef enum ndis_classid ndis_classid;
1093
1094struct ndis_mediaspecific_info {
1095	uint32_t		nmi_nextentoffset;
1096	ndis_classid		nmi_classid;
1097	uint32_t		nmi_size;
1098	uint8_t			nmi_classinfo[1];
1099};
1100
1101typedef struct ndis_mediaspecific_info ndis_mediaspecific_info;
1102
1103struct ndis_packet_oob {
1104	union {
1105		uint64_t		npo_timetotx;
1106		uint64_t		npo_timetxed;
1107	} u;
1108	uint64_t			npo_timerxed;
1109	uint32_t			npo_hdrlen;
1110	uint32_t			npo_mediaspecific_len;
1111	void				*npo_mediaspecific;
1112	ndis_status			npo_status;
1113};
1114
1115typedef struct ndis_packet_oob ndis_packet_oob;
1116
1117struct ndis_packet {
1118	ndis_packet_private	np_private;
1119	union {
1120		/* For connectionless miniports. */
1121		struct {
1122			uint8_t		np_miniport_rsvd[2 * sizeof(void *)];
1123			uint8_t		np_wrapper_rsvd[2 * sizeof(void *)];
1124		} np_clrsvd;
1125		/* For de-serialized miniports */
1126		struct {
1127			uint8_t		np_miniport_rsvdex[3 * sizeof(void *)];
1128			uint8_t		np_wrapper_rsvdex[sizeof(void *)];
1129		} np_dsrsvd;
1130		struct {
1131			uint8_t		np_mac_rsvd[4 * sizeof(void *)];
1132		} np_macrsvd;
1133	} u;
1134	uint32_t		*np_rsvd[2];
1135
1136	/*
1137	 * This next part is probably wrong, but we need some place
1138	 * to put the out of band data structure...
1139	 */
1140	ndis_packet_oob		np_oob;
1141	ndis_packet_extension	np_ext;
1142	ndis_sc_list		np_sclist;
1143
1144	/* BSD-specific stuff which should be invisible to drivers. */
1145
1146	uint32_t		np_refcnt;
1147	void			*np_softc;
1148	void			*np_m0;
1149	int			np_txidx;
1150};
1151
1152typedef struct ndis_packet ndis_packet;
1153
1154/* mbuf ext type for NDIS */
1155#define EXT_NDIS		0x999
1156
1157/* mtx type for NDIS */
1158#define MTX_NDIS_LOCK "NDIS lock"
1159
1160struct ndis_filterdbs {
1161	union {
1162		void			*nf_ethdb;
1163		void			*nf_nulldb;
1164	} u;
1165	void			*nf_trdb;
1166	void			*nf_fddidb;
1167	void			*nf_arcdb;
1168};
1169
1170typedef struct ndis_filterdbs ndis_filterdbs;
1171
1172enum ndis_medium {
1173    NdisMedium802_3,
1174    NdisMedium802_5,
1175    NdisMediumFddi,
1176    NdisMediumWan,
1177    NdisMediumLocalTalk,
1178    NdisMediumDix,              /* defined for convenience, not a real medium */
1179    NdisMediumArcnetRaw,
1180    NdisMediumArcnet878_2,
1181    NdisMediumAtm,
1182    NdisMediumWirelessWan,
1183    NdisMediumIrda,
1184    NdisMediumBpc,
1185    NdisMediumCoWan,
1186    NdisMedium1394,
1187    NdisMediumMax
1188};
1189
1190typedef enum ndis_medium ndis_medium;
1191/*
1192enum interface_type {
1193	InterfaceTypeUndefined = -1,
1194	Internal,
1195	Isa,
1196	Eisa,
1197	MicroChannel,
1198	TurboChannel,
1199	PCIBus,
1200	VMEBus,
1201	NuBus,
1202	PCMCIABus,
1203	CBus,
1204	MPIBus,
1205	MPSABus,
1206	ProcessorInternal,
1207	InternalPowerBus,
1208	PNPISABus,
1209	PNPBus,
1210	MaximumInterfaceType
1211};
1212*/
1213enum ndis_interface_type {
1214	NdisInterfaceInternal = Internal,
1215	NdisInterfaceIsa = Isa,
1216	NdisInterfaceEisa = Eisa,
1217	NdisInterfaceMca = MicroChannel,
1218	NdisInterfaceTurboChannel = TurboChannel,
1219	NdisInterfacePci = PCIBus,
1220	NdisInterfacePcMcia = PCMCIABus
1221};
1222
1223typedef enum ndis_interface_type ndis_interface_type;
1224
1225struct ndis_paddr_unit {
1226	ndis_physaddr		npu_physaddr;
1227	uint32_t		npu_len;
1228};
1229
1230typedef struct ndis_paddr_unit ndis_paddr_unit;
1231
1232struct ndis_map_arg {
1233	ndis_paddr_unit		*nma_fraglist;
1234	int			nma_cnt;
1235	int			nma_max;
1236};
1237
1238/*
1239 * Miniport characteristics were originally defined in the NDIS 3.0
1240 * spec and then extended twice, in NDIS 4.0 and 5.0.
1241 */
1242
1243struct ndis_miniport_characteristics {
1244
1245	/* NDIS 3.0 */
1246
1247	uint8_t			nmc_version_major;
1248	uint8_t			nmc_version_minor;
1249	uint16_t		nmc_pad;
1250	uint32_t		nmc_rsvd;
1251	void *			nmc_checkhang_func;
1252	void *			nmc_disable_interrupts_func;
1253	void *			nmc_enable_interrupts_func;
1254	void *			nmc_halt_func;
1255	void *			nmc_interrupt_func;
1256	void *			nmc_init_func;
1257	void *			nmc_isr_func;
1258	void *			nmc_queryinfo_func;
1259	void *			nmc_reconfig_func;
1260	void *			nmc_reset_func;
1261	void *			nmc_sendsingle_func;
1262	void *			nmc_setinfo_func;
1263	void *			nmc_transferdata_func;
1264
1265	/* NDIS 4.0 extentions */
1266
1267	void *			nmc_return_packet_func;
1268	void *			nmc_sendmulti_func;
1269	void *			nmc_allocate_complete_func;
1270
1271	/* NDIS 5.0 extensions */
1272
1273	void *			nmc_cocreatevc_func;
1274	void *			nmc_codeletevc_func;
1275	void *			nmc_coactivatevc_func;
1276	void *			nmc_codeactivatevc_func;
1277	void *			nmc_comultisend_func;
1278	void *			nmc_corequest_func;
1279
1280	/* NDIS 5.1 extentions */
1281
1282	void *			nmc_canceltxpkts_handler;
1283	void *			nmc_pnpevent_handler;
1284	void *			nmc_shutdown_handler;
1285	void *			nmc_rsvd0;
1286	void *			nmc_rsvd1;
1287	void *			nmc_rsvd2;
1288	void *			nmc_rsvd3;
1289};
1290
1291typedef struct ndis_miniport_characteristics ndis_miniport_characteristics;
1292
1293struct ndis_driver_object {
1294	char			*ndo_ifname;
1295	void			*ndo_softc;
1296	ndis_miniport_characteristics ndo_chars;
1297};
1298
1299typedef struct ndis_driver_object ndis_driver_object;
1300
1301struct ndis_reference {
1302	ndis_kspin_lock		nr_spinlock;
1303	uint16_t		nr_refcnt;
1304	uint8_t			nr_closing;
1305};
1306
1307typedef struct ndis_reference ndis_reference;
1308
1309struct ndis_timer_entry {
1310	struct callout		nte_ch;
1311	ndis_miniport_timer	*nte_timer;
1312	TAILQ_ENTRY(ndis_timer_entry)	link;
1313};
1314
1315TAILQ_HEAD(nte_head, ndis_timer_entry);
1316
1317struct ndis_fh {
1318	void			*nf_vp;
1319	void			*nf_map;
1320	uint32_t		nf_maplen;
1321};
1322
1323typedef struct ndis_fh ndis_fh;
1324
1325/*
1326 * The miniport block is basically the internal NDIS handle. We need
1327 * to define this because, unfortunately, it is not entirely opaque
1328 * to NDIS drivers. For one thing, it contains the function pointer
1329 * to the NDIS packet receive handler, which is invoked out of the
1330 * NDIS block via a macro rather than a function pointer. (The
1331 * NdisMIndicateReceivePacket() routine is a macro rather than
1332 * a function.) For another, the driver maintains a pointer to the
1333 * miniport block and passes it as a handle to various NDIS functions.
1334 * (The driver never really knows this because it's hidden behind
1335 * an ndis_handle though.)
1336 *
1337 * The miniport block has two parts: the first part contains fields
1338 * that must never change, since they are referenced by driver
1339 * binaries through macros. The second part is ignored by the driver,
1340 * but contains various things used internaly by NDIS.SYS. In our
1341 * case, we define the first 'immutable' part exactly as it appears
1342 * in Windows, but don't bother duplicating the Windows definitions
1343 * for the second part. Instead, we replace them with a few BSD-specific
1344 * things.
1345 */
1346
1347struct ndis_miniport_block {
1348	/*
1349	 * Windows-specific portion -- DO NOT MODIFY OR NDIS
1350	 * DRIVERS WILL NOT WORK.
1351	 */
1352	void			*nmb_signature;	/* magic number */
1353	ndis_miniport_block	*nmb_nextminiport;
1354	ndis_mdriver_block	*nmb_driverhandle;
1355	ndis_handle		nmb_miniportadapterctx;
1356	ndis_unicode_string	nmb_name;
1357	ndis_bind_paths		*nmb_bindpaths;
1358	ndis_handle		nmb_openqueue;
1359	ndis_reference		nmb_ref;
1360	ndis_handle		nmb_devicectx;
1361	uint8_t			nmb_padding;
1362	uint8_t			nmb_lockacquired;
1363	uint8_t			nmb_pmodeopens;
1364	uint8_t			nmb_assignedcpu;
1365	ndis_kspin_lock		nmb_lock;
1366	ndis_request		*nmb_mediarequest;
1367	ndis_miniport_interrupt	*nmb_interrupt;
1368	uint32_t		nmb_flags;
1369	uint32_t		nmb_pnpflags;
1370	list_entry		nmb_packetlist;
1371	ndis_packet		*nmb_firstpendingtxpacket;
1372	ndis_packet		*nmb_returnpacketqueue;
1373	uint32_t		nmb_requestbuffer;
1374	void			*nmb_setmcastbuf;
1375	ndis_miniport_block	*nmb_primaryminiport;
1376	void			*nmb_wrapperctx;
1377	void			*nmb_busdatactx;
1378	uint32_t		nmb_pnpcaps;
1379	cm_resource_list	*nmb_resources;
1380	ndis_timer		nmb_wkupdpctimer;
1381	ndis_unicode_string	nmb_basename;
1382	ndis_unicode_string	nmb_symlinkname;
1383	uint32_t		nmb_checkforhangsecs;
1384	uint16_t		nmb_cfhticks;
1385	uint16_t		nmb_cfhcurrticks;
1386	ndis_status		nmb_resetstatus;
1387	ndis_handle		nmb_resetopen;
1388	ndis_filterdbs		nmb_filterdbs;
1389	void			*nmb_pktind_func;
1390	void			*nmb_senddone_func;
1391	void			*nmb_sendrsrc_func;
1392	void			*nmb_resetdone_func;
1393	ndis_medium		nmb_medium;
1394	uint32_t		nmb_busnum;
1395	uint32_t		nmb_bustye;
1396	uint32_t		nmb_adaptertype;
1397	void			*nmb_deviceobj;
1398	void			*nmb_physdeviceobj;
1399	void			*nmb_nextdeviceobj;
1400	void			*nmb_mapreg;
1401	void			*nmb_callmgraflist;
1402	void			*nmb_miniportthread;
1403	void			*nmb_setinfobuf;
1404	uint16_t		nmb_setinfobuflen;
1405	uint16_t		nmb_maxsendpkts;
1406	ndis_status		nmb_fakestatus;
1407	void			*nmb_lockhandler;
1408	ndis_unicode_string	*nmb_adapterinstancename;
1409	void			*nmb_timerqueue;
1410	uint32_t		nmb_mactoptions;
1411	ndis_request		*nmb_pendingreq;
1412	uint32_t		nmb_maxlongaddrs;
1413	uint32_t		nmb_maxshortaddrs;
1414	uint32_t		nmb_currlookahead;
1415	uint32_t		nmb_maxlookahead;
1416	void			*nmb_interrupt_func;
1417	void			*nmb_disableintr_func;
1418	void			*nmb_enableintr_func;
1419	void			*nmb_sendpkts_func;
1420	void			*nmb_deferredsend_func;
1421	void			*nmb_ethrxindicate_func;
1422	void			*nmb_txrxindicate_func;
1423	void			*nmb_fddirxindicate_func;
1424	void			*nmb_ethrxdone_func;
1425	void			*nmb_txrxdone_func;
1426	void			*nmb_fddirxcond_func;
1427	void			*nmb_status_func;
1428	void			*nmb_statusdone_func;
1429	void			*nmb_tdcond_func;
1430	void			*nmb_querydone_func;
1431	void			*nmb_setdone_func;
1432	void			*nmb_wantxdone_func;
1433	void			*nmb_wanrx_func;
1434	void			*nmb_wanrxdone_func;
1435	/*
1436	 * End of windows-specific portion of miniport block. Everything
1437	 * below is BSD-specific.
1438	 */
1439	struct ifnet		*nmb_ifp;
1440	uint8_t			nmb_dummybuf[128];
1441	device_object		nmb_devobj;
1442	ndis_config_parm	nmb_replyparm;
1443	int			nmb_pciidx;
1444	device_t		nmb_dev;
1445	ndis_resource_list	*nmb_rlist;
1446	ndis_status		nmb_getstat;
1447	ndis_status		nmb_setstat;
1448	struct nte_head		nmb_timerlist;
1449	vm_offset_t		nmb_img;
1450	TAILQ_ENTRY(ndis_miniport_block)	link;
1451};
1452
1453TAILQ_HEAD(nd_head, ndis_miniport_block);
1454
1455typedef ndis_status (*ndis_init_handler)(ndis_status *, uint32_t *,
1456		ndis_medium *, uint32_t, ndis_handle, ndis_handle);
1457typedef ndis_status (*ndis_queryinfo_handler)(ndis_handle, ndis_oid,
1458		void *, uint32_t, uint32_t *, uint32_t *);
1459typedef ndis_status (*ndis_setinfo_handler)(ndis_handle, ndis_oid,
1460		void *, uint32_t, uint32_t *, uint32_t *);
1461typedef ndis_status (*ndis_sendsingle_handler)(ndis_handle,
1462		ndis_packet *, uint32_t);
1463typedef ndis_status (*ndis_sendmulti_handler)(ndis_handle,
1464		ndis_packet **, uint32_t);
1465typedef void (*ndis_isr_handler)(uint8_t *, uint8_t *, ndis_handle);
1466typedef void (*ndis_interrupt_handler)(ndis_handle);
1467typedef int (*ndis_reset_handler)(uint8_t *, ndis_handle);
1468typedef void (*ndis_halt_handler)(ndis_handle);
1469typedef void (*ndis_return_handler)(ndis_handle, ndis_packet *);
1470typedef void (*ndis_enable_interrupts_handler)(ndis_handle);
1471typedef void (*ndis_disable_interrupts_handler)(ndis_handle);
1472typedef void (*ndis_shutdown_handler)(void *);
1473typedef void (*ndis_allocdone_handler)(ndis_handle, void *,
1474		ndis_physaddr *, uint32_t, void *);
1475typedef uint8_t (*ndis_checkforhang_handler)(ndis_handle);
1476
1477typedef ndis_status (*driver_entry)(void *, ndis_unicode_string *);
1478
1479extern image_patch_table ndis_functbl[];
1480
1481#define NDIS_TASKQUEUE	1
1482#define NDIS_SWI	2
1483
1484#define NDIS_PSTATE_RUNNING	1
1485#define NDIS_PSTATE_SLEEPING	2
1486
1487__BEGIN_DECLS
1488extern int ndis_libinit(void);
1489extern int ndis_libfini(void);
1490extern int ndis_ascii_to_unicode(char *, uint16_t **);
1491extern int ndis_unicode_to_ascii(uint16_t *, int, char **);
1492extern int ndis_load_driver(vm_offset_t, void *);
1493extern int ndis_unload_driver(void *);
1494extern int ndis_mtop(struct mbuf *, ndis_packet **);
1495extern int ndis_ptom(struct mbuf **, ndis_packet *);
1496extern int ndis_get_info(void *, ndis_oid, void *, int *);
1497extern int ndis_set_info(void *, ndis_oid, void *, int *);
1498extern int ndis_get_supported_oids(void *, ndis_oid **, int *);
1499extern int ndis_send_packets(void *, ndis_packet **, int);
1500extern int ndis_send_packet(void *, ndis_packet *);
1501extern int ndis_convert_res(void *);
1502extern int ndis_alloc_amem(void *);
1503extern void ndis_free_amem(void *);
1504extern void ndis_free_packet(ndis_packet *);
1505extern void ndis_free_bufs(ndis_buffer *);
1506extern int ndis_reset_nic(void *);
1507extern int ndis_halt_nic(void *);
1508extern int ndis_shutdown_nic(void *);
1509extern int ndis_init_nic(void *);
1510extern int ndis_isr(void *, int *, int *);
1511extern int ndis_intrhand(void *);
1512extern void ndis_return_packet(void *, void *);
1513extern void ndis_enable_intr(void *);
1514extern void ndis_disable_intr(void *);
1515extern int ndis_init_dma(void *);
1516extern int ndis_destroy_dma(void *);
1517extern int ndis_create_sysctls(void *);
1518extern int ndis_add_sysctl(void *, char *, char *, char *, int);
1519extern int ndis_flush_sysctls(void *);
1520extern int ndis_sched(void (*)(void *), void *, int);
1521extern int ndis_unsched(void (*)(void *), void *, int);
1522extern int ndis_thsuspend(struct proc *, int);
1523extern void ndis_thresume(struct proc *);
1524extern int ndis_strcasecmp(const char *, const char *);
1525__END_DECLS
1526
1527#endif /* _NDIS_VAR_H_ */
1528