/*++ BUILD Version: 0001                // Increment this if a change has global effects
   Copyright (c) 1990-1993  Microsoft Corporation
   Module Name:
   ntddndis.h
   Abstract:
   This is the include file that defines all constants and types for
   accessing the Network driver interface device.
   Author:
   Steve Wood (stevewo) 27-May-1990
   Revision History:
   Adam Barr (adamba)           04-Nov-1992             added the correct values for NDIS 3.0.
   Jameel Hyder (jameelh)       01-Aug-95               added Pnp IoCTLs and structures
   Kyle Brandon (kyleb) 09/24/96                added general co ndis oids.
   -- */
#ifndef _NTDDNDIS_
#define _NTDDNDIS_
//
// Device Name - this string is the name of the device.  It is the name
// that should be passed to NtOpenFile when accessing the device.
//
// Note:  For devices that support multiple units, it should be suffixed
//                with the Ascii representation of the unit number.
//
#define DD_NDIS_DEVICE_NAME "\\Device\\UNKNOWN"
//
// NtDeviceIoControlFile IoControlCode values for this device.
//
// Warning:  Remember that the low two bits of the code specify how the
//                       buffers are passed to the driver!
//
#define _NDIS_CONTROL_CODE(request,method) \
			CTL_CODE(FILE_DEVICE_PHYSICAL_NETCARD, request, method, FILE_ANY_ACCESS)
#define IOCTL_NDIS_QUERY_GLOBAL_STATS	_NDIS_CONTROL_CODE( 0, METHOD_OUT_DIRECT )
#define IOCTL_NDIS_QUERY_ALL_STATS		_NDIS_CONTROL_CODE( 1, METHOD_OUT_DIRECT )
#define IOCTL_NDIS_ADD_DEVICE			_NDIS_CONTROL_CODE( 2, METHOD_BUFFERED )
#define IOCTL_NDIS_DELETE_DEVICE		_NDIS_CONTROL_CODE( 3, METHOD_BUFFERED )
#define IOCTL_NDIS_TRANSLATE_NAME		_NDIS_CONTROL_CODE( 4, METHOD_BUFFERED )
#define IOCTL_NDIS_ADD_TDI_DEVICE		_NDIS_CONTROL_CODE( 5, METHOD_BUFFERED )
#define IOCTL_NDIS_NOTIFY_PROTOCOL		_NDIS_CONTROL_CODE( 6, METHOD_BUFFERED )
#define	IOCTL_NDIS_GET_LOG_DATA			_NDIS_CONTROL_CODE( 7, METHOD_OUT_DIRECT )
//
// NtDeviceIoControlFile InputBuffer/OutputBuffer record structures for
// this device.
//
//
// This is the type of an NDIS OID value.
//
typedef ULONG NDIS_OID, *PNDIS_OID;
//
// IOCTL_NDIS_QUERY_ALL_STATS returns a sequence of these, packed
// together (no padding is required since statistics all have
// four or eight bytes of data).
//
typedef struct _NDIS_STATISTICS_VALUE {
    NDIS_OID Oid;
    ULONG DataLength;
    UCHAR Data[1];		// variable length

} NDIS_STATISTICS_VALUE, *PNDIS_STATISTICS_VALUE;

//
// Structure used by TRANSLATE_NAME IOCTL
//
typedef struct _NET_PNP_ID {
    ULONG ClassId;
    ULONG Token;
} NET_PNP_ID, *PNET_PNP_ID;

typedef struct _NET_PNP_TRANSLATE_LIST {
    ULONG BytesNeeded;
    NET_PNP_ID IdArray[ANYSIZE_ARRAY];
} NET_PNP_TRANSLATE_LIST, *PNET_PNP_TRANSLATE_LIST;

//
// Structure used to define a self-contained variable data structure
//
typedef struct _NDIS_VAR_DATA_DESC {
    USHORT Length;		// # of octects of data

    USHORT MaximumLength;	// # of octects available

    LONG Offset;		// Offset of data relative to the descriptor

} NDIS_VAR_DATA_DESC, *PNDIS_VAR_DATA_DESC;

//
// Object Identifiers used by NdisRequest Query/Set Information
//
//
// General Objects
//
#define OID_GEN_SUPPORTED_LIST			  		0x00010101
#define OID_GEN_HARDWARE_STATUS			 		0x00010102
#define OID_GEN_MEDIA_SUPPORTED			 		0x00010103
#define OID_GEN_MEDIA_IN_USE					0x00010104
#define OID_GEN_MAXIMUM_LOOKAHEAD		   		0x00010105
#define OID_GEN_MAXIMUM_FRAME_SIZE		  		0x00010106
#define OID_GEN_LINK_SPEED				  		0x00010107
#define OID_GEN_TRANSMIT_BUFFER_SPACE	   		0x00010108
#define OID_GEN_RECEIVE_BUFFER_SPACE			0x00010109
#define OID_GEN_TRANSMIT_BLOCK_SIZE		 		0x0001010A
#define OID_GEN_RECEIVE_BLOCK_SIZE		  		0x0001010B
#define OID_GEN_VENDOR_ID				   		0x0001010C
#define OID_GEN_VENDOR_DESCRIPTION		  		0x0001010D
#define OID_GEN_CURRENT_PACKET_FILTER	   		0x0001010E
#define OID_GEN_CURRENT_LOOKAHEAD		   		0x0001010F
#define OID_GEN_DRIVER_VERSION			  		0x00010110
#define OID_GEN_MAXIMUM_TOTAL_SIZE		  		0x00010111
#define OID_GEN_PROTOCOL_OPTIONS				0x00010112
#define OID_GEN_MAC_OPTIONS				 		0x00010113
#define OID_GEN_MEDIA_CONNECT_STATUS			0x00010114
#define OID_GEN_MAXIMUM_SEND_PACKETS			0x00010115
#define OID_GEN_VENDOR_DRIVER_VERSION			0x00010116
#define OID_GEN_XMIT_OK					 		0x00020101
#define OID_GEN_RCV_OK					  		0x00020102
#define OID_GEN_XMIT_ERROR				  		0x00020103
#define OID_GEN_RCV_ERROR				   		0x00020104
#define OID_GEN_RCV_NO_BUFFER			   		0x00020105
#define OID_GEN_DIRECTED_BYTES_XMIT		 		0x00020201
#define OID_GEN_DIRECTED_FRAMES_XMIT			0x00020202
#define OID_GEN_MULTICAST_BYTES_XMIT			0x00020203
#define OID_GEN_MULTICAST_FRAMES_XMIT	   		0x00020204
#define OID_GEN_BROADCAST_BYTES_XMIT			0x00020205
#define OID_GEN_BROADCAST_FRAMES_XMIT	   		0x00020206
#define OID_GEN_DIRECTED_BYTES_RCV		  		0x00020207
#define OID_GEN_DIRECTED_FRAMES_RCV		 		0x00020208
#define OID_GEN_MULTICAST_BYTES_RCV		 		0x00020209
#define OID_GEN_MULTICAST_FRAMES_RCV			0x0002020A
#define OID_GEN_BROADCAST_BYTES_RCV		 		0x0002020B
#define OID_GEN_BROADCAST_FRAMES_RCV			0x0002020C
#define OID_GEN_RCV_CRC_ERROR			   		0x0002020D
#define OID_GEN_TRANSMIT_QUEUE_LENGTH	   		0x0002020E
#define OID_GEN_GET_TIME_CAPS					0x0002020F
#define OID_GEN_GET_NETCARD_TIME				0x00020210
//
//      These are connection-oriented general OIDs.
//      These replace the above OIDs for connection-oriented media.
//
#define OID_GEN_CO_SUPPORTED_LIST			  	0x00010101
#define OID_GEN_CO_HARDWARE_STATUS			 	0x00010102
#define OID_GEN_CO_MEDIA_SUPPORTED			 	0x00010103
#define OID_GEN_CO_MEDIA_IN_USE					0x00010104
#define OID_GEN_CO_LINK_SPEED				  	0x00010105
#define OID_GEN_CO_VENDOR_ID				   	0x00010106
#define OID_GEN_CO_VENDOR_DESCRIPTION		  	0x00010107
#define OID_GEN_CO_DRIVER_VERSION			  	0x00010108
#define OID_GEN_CO_PROTOCOL_OPTIONS				0x00010109
#define OID_GEN_CO_MAC_OPTIONS				 	0x0001010A
#define OID_GEN_CO_MEDIA_CONNECT_STATUS			0x0001010B
#define OID_GEN_CO_VENDOR_DRIVER_VERSION		0x0001010C
#define OID_GEN_CO_MINIMUM_LINK_SPEED			0x0001010D
#define OID_GEN_CO_GET_TIME_CAPS				0x00010201
#define OID_GEN_CO_GET_NETCARD_TIME				0x00010202
//
//      These are connection-oriented statistics OIDs.
//
#define	OID_GEN_CO_XMIT_PDUS_OK					0x00020101
#define	OID_GEN_CO_RCV_PDUS_OK					0x00020102
#define	OID_GEN_CO_XMIT_PDUS_ERROR				0x00020103
#define	OID_GEN_CO_RCV_PDUS_ERROR				0x00020104
#define	OID_GEN_CO_RCV_PDUS_NO_BUFFER			0x00020105
#define	OID_GEN_CO_RCV_CRC_ERROR				0x00020201
#define OID_GEN_CO_TRANSMIT_QUEUE_LENGTH		0x00020202
#define	OID_GEN_CO_BYTES_XMIT					0x00020203
#define OID_GEN_CO_BYTES_RCV					0x00020204
#define	OID_GEN_CO_BYTES_XMIT_OUTSTANDING		0x00020205
#define	OID_GEN_CO_NETCARD_LOAD					0x00020206
//
// These are objects for Connection-oriented media call-managers and are not
// valid for ndis drivers. Under construction.
//
#define OID_CO_ADD_PVC							0xFF000001
#define OID_CO_DELETE_PVC						0xFF000002
#define OID_CO_GET_CALL_INFORMATION				0xFF000003
#define OID_CO_ADD_ADDRESS						0xFF000004
#define OID_CO_DELETE_ADDRESS					0xFF000005
#define OID_CO_GET_ADDRESSES					0xFF000006
#define OID_CO_ADDRESS_CHANGE					0xFF000007
#define OID_CO_SIGNALING_ENABLED				0xFF000008
#define OID_CO_SIGNALING_DISABLED				0xFF000009
//
// 802.3 Objects (Ethernet)
//
#define OID_802_3_PERMANENT_ADDRESS		 		0x01010101
#define OID_802_3_CURRENT_ADDRESS		   		0x01010102
#define OID_802_3_MULTICAST_LIST				0x01010103
#define OID_802_3_MAXIMUM_LIST_SIZE		 		0x01010104
#define OID_802_3_MAC_OPTIONS				 	0x01010105
//
//
#define	NDIS_802_3_MAC_OPTION_PRIORITY			0x00000001
#define OID_802_3_RCV_ERROR_ALIGNMENT	   		0x01020101
#define OID_802_3_XMIT_ONE_COLLISION			0x01020102
#define OID_802_3_XMIT_MORE_COLLISIONS	  		0x01020103
#define OID_802_3_XMIT_DEFERRED			 		0x01020201
#define OID_802_3_XMIT_MAX_COLLISIONS	   		0x01020202
#define OID_802_3_RCV_OVERRUN			   		0x01020203
#define OID_802_3_XMIT_UNDERRUN			 		0x01020204
#define OID_802_3_XMIT_HEARTBEAT_FAILURE		0x01020205
#define OID_802_3_XMIT_TIMES_CRS_LOST	   		0x01020206
#define OID_802_3_XMIT_LATE_COLLISIONS	  		0x01020207
//
// 802.5 Objects (Token-Ring)
//
#define OID_802_5_PERMANENT_ADDRESS		 		0x02010101
#define OID_802_5_CURRENT_ADDRESS		   		0x02010102
#define OID_802_5_CURRENT_FUNCTIONAL			0x02010103
#define OID_802_5_CURRENT_GROUP			 		0x02010104
#define OID_802_5_LAST_OPEN_STATUS		  		0x02010105
#define OID_802_5_CURRENT_RING_STATUS	   		0x02010106
#define OID_802_5_CURRENT_RING_STATE			0x02010107
#define OID_802_5_LINE_ERRORS			   		0x02020101
#define OID_802_5_LOST_FRAMES			   		0x02020102
#define OID_802_5_BURST_ERRORS			  		0x02020201
#define OID_802_5_AC_ERRORS				 		0x02020202
#define OID_802_5_ABORT_DELIMETERS		  		0x02020203
#define OID_802_5_FRAME_COPIED_ERRORS	   		0x02020204
#define OID_802_5_FREQUENCY_ERRORS		  		0x02020205
#define OID_802_5_TOKEN_ERRORS			  		0x02020206
#define OID_802_5_INTERNAL_ERRORS		   		0x02020207
//
// FDDI Objects
//
#define OID_FDDI_LONG_PERMANENT_ADDR			0x03010101
#define OID_FDDI_LONG_CURRENT_ADDR		  		0x03010102
#define OID_FDDI_LONG_MULTICAST_LIST			0x03010103
#define OID_FDDI_LONG_MAX_LIST_SIZE		 		0x03010104
#define OID_FDDI_SHORT_PERMANENT_ADDR	   		0x03010105
#define OID_FDDI_SHORT_CURRENT_ADDR		 		0x03010106
#define OID_FDDI_SHORT_MULTICAST_LIST	   		0x03010107
#define OID_FDDI_SHORT_MAX_LIST_SIZE			0x03010108
#define OID_FDDI_ATTACHMENT_TYPE				0x03020101
#define OID_FDDI_UPSTREAM_NODE_LONG		 		0x03020102
#define OID_FDDI_DOWNSTREAM_NODE_LONG	   		0x03020103
#define OID_FDDI_FRAME_ERRORS			   		0x03020104
#define OID_FDDI_FRAMES_LOST					0x03020105
#define OID_FDDI_RING_MGT_STATE			 		0x03020106
#define OID_FDDI_LCT_FAILURES			   		0x03020107
#define OID_FDDI_LEM_REJECTS					0x03020108
#define OID_FDDI_LCONNECTION_STATE		  		0x03020109
#define OID_FDDI_SMT_STATION_ID			 		0x03030201
#define OID_FDDI_SMT_OP_VERSION_ID		  		0x03030202
#define OID_FDDI_SMT_HI_VERSION_ID		  		0x03030203
#define OID_FDDI_SMT_LO_VERSION_ID		  		0x03030204
#define OID_FDDI_SMT_MANUFACTURER_DATA	  		0x03030205
#define OID_FDDI_SMT_USER_DATA			  		0x03030206
#define OID_FDDI_SMT_MIB_VERSION_ID		 		0x03030207
#define OID_FDDI_SMT_MAC_CT				 		0x03030208
#define OID_FDDI_SMT_NON_MASTER_CT		  		0x03030209
#define OID_FDDI_SMT_MASTER_CT			  		0x0303020A
#define OID_FDDI_SMT_AVAILABLE_PATHS			0x0303020B
#define OID_FDDI_SMT_CONFIG_CAPABILITIES		0x0303020C
#define OID_FDDI_SMT_CONFIG_POLICY		  		0x0303020D
#define OID_FDDI_SMT_CONNECTION_POLICY	  		0x0303020E
#define OID_FDDI_SMT_T_NOTIFY			   		0x0303020F
#define OID_FDDI_SMT_STAT_RPT_POLICY			0x03030210
#define OID_FDDI_SMT_TRACE_MAX_EXPIRATION   	0x03030211
#define OID_FDDI_SMT_PORT_INDEXES		   		0x03030212
#define OID_FDDI_SMT_MAC_INDEXES				0x03030213
#define OID_FDDI_SMT_BYPASS_PRESENT		 		0x03030214
#define OID_FDDI_SMT_ECM_STATE			  		0x03030215
#define OID_FDDI_SMT_CF_STATE			   		0x03030216
#define OID_FDDI_SMT_HOLD_STATE			 		0x03030217
#define OID_FDDI_SMT_REMOTE_DISCONNECT_FLAG 	0x03030218
#define OID_FDDI_SMT_STATION_STATUS		 		0x03030219
#define OID_FDDI_SMT_PEER_WRAP_FLAG		 		0x0303021A
#define OID_FDDI_SMT_MSG_TIME_STAMP		 		0x0303021B
#define OID_FDDI_SMT_TRANSITION_TIME_STAMP  	0x0303021C
#define OID_FDDI_SMT_SET_COUNT			  		0x0303021D
#define OID_FDDI_SMT_LAST_SET_STATION_ID		0x0303021E
#define OID_FDDI_MAC_FRAME_STATUS_FUNCTIONS 	0x0303021F
#define OID_FDDI_MAC_BRIDGE_FUNCTIONS	   		0x03030220
#define OID_FDDI_MAC_T_MAX_CAPABILITY	   		0x03030221
#define OID_FDDI_MAC_TVX_CAPABILITY		 		0x03030222
#define OID_FDDI_MAC_AVAILABLE_PATHS			0x03030223
#define OID_FDDI_MAC_CURRENT_PATH		   		0x03030224
#define OID_FDDI_MAC_UPSTREAM_NBR		   		0x03030225
#define OID_FDDI_MAC_DOWNSTREAM_NBR		 		0x03030226
#define OID_FDDI_MAC_OLD_UPSTREAM_NBR	   		0x03030227
#define OID_FDDI_MAC_OLD_DOWNSTREAM_NBR	 		0x03030228
#define OID_FDDI_MAC_DUP_ADDRESS_TEST	   		0x03030229
#define OID_FDDI_MAC_REQUESTED_PATHS			0x0303022A
#define OID_FDDI_MAC_DOWNSTREAM_PORT_TYPE   	0x0303022B
#define OID_FDDI_MAC_INDEX				  		0x0303022C
#define OID_FDDI_MAC_SMT_ADDRESS				0x0303022D
#define OID_FDDI_MAC_LONG_GRP_ADDRESS	   		0x0303022E
#define OID_FDDI_MAC_SHORT_GRP_ADDRESS	  		0x0303022F
#define OID_FDDI_MAC_T_REQ				  		0x03030230
#define OID_FDDI_MAC_T_NEG				  		0x03030231
#define OID_FDDI_MAC_T_MAX				  		0x03030232
#define OID_FDDI_MAC_TVX_VALUE			  		0x03030233
#define OID_FDDI_MAC_T_PRI0				 		0x03030234
#define OID_FDDI_MAC_T_PRI1				 		0x03030235
#define OID_FDDI_MAC_T_PRI2				 		0x03030236
#define OID_FDDI_MAC_T_PRI3				 		0x03030237
#define OID_FDDI_MAC_T_PRI4				 		0x03030238
#define OID_FDDI_MAC_T_PRI5				 		0x03030239
#define OID_FDDI_MAC_T_PRI6				 		0x0303023A
#define OID_FDDI_MAC_FRAME_CT			   		0x0303023B
#define OID_FDDI_MAC_COPIED_CT			  		0x0303023C
#define OID_FDDI_MAC_TRANSMIT_CT				0x0303023D
#define OID_FDDI_MAC_TOKEN_CT			   		0x0303023E
#define OID_FDDI_MAC_ERROR_CT			   		0x0303023F
#define OID_FDDI_MAC_LOST_CT					0x03030240
#define OID_FDDI_MAC_TVX_EXPIRED_CT		 		0x03030241
#define OID_FDDI_MAC_NOT_COPIED_CT		  		0x03030242
#define OID_FDDI_MAC_LATE_CT					0x03030243
#define OID_FDDI_MAC_RING_OP_CT			 		0x03030244
#define OID_FDDI_MAC_FRAME_ERROR_THRESHOLD  	0x03030245
#define OID_FDDI_MAC_FRAME_ERROR_RATIO	  		0x03030246
#define OID_FDDI_MAC_NOT_COPIED_THRESHOLD   	0x03030247
#define OID_FDDI_MAC_NOT_COPIED_RATIO	   		0x03030248
#define OID_FDDI_MAC_RMT_STATE			  		0x03030249
#define OID_FDDI_MAC_DA_FLAG					0x0303024A
#define OID_FDDI_MAC_UNDA_FLAG			  		0x0303024B
#define OID_FDDI_MAC_FRAME_ERROR_FLAG	   		0x0303024C
#define OID_FDDI_MAC_NOT_COPIED_FLAG			0x0303024D
#define OID_FDDI_MAC_MA_UNITDATA_AVAILABLE  	0x0303024E
#define OID_FDDI_MAC_HARDWARE_PRESENT	   		0x0303024F
#define OID_FDDI_MAC_MA_UNITDATA_ENABLE	 		0x03030250
#define OID_FDDI_PATH_INDEX				 		0x03030251
#define OID_FDDI_PATH_RING_LATENCY		  		0x03030252
#define OID_FDDI_PATH_TRACE_STATUS		  		0x03030253
#define OID_FDDI_PATH_SBA_PAYLOAD		   		0x03030254
#define OID_FDDI_PATH_SBA_OVERHEAD		  		0x03030255
#define OID_FDDI_PATH_CONFIGURATION		 		0x03030256
#define OID_FDDI_PATH_T_R_MODE			  		0x03030257
#define OID_FDDI_PATH_SBA_AVAILABLE		 		0x03030258
#define OID_FDDI_PATH_TVX_LOWER_BOUND	   		0x03030259
#define OID_FDDI_PATH_T_MAX_LOWER_BOUND	 		0x0303025A
#define OID_FDDI_PATH_MAX_T_REQ			 		0x0303025B
#define OID_FDDI_PORT_MY_TYPE			   		0x0303025C
#define OID_FDDI_PORT_NEIGHBOR_TYPE		 		0x0303025D
#define OID_FDDI_PORT_CONNECTION_POLICIES   	0x0303025E
#define OID_FDDI_PORT_MAC_INDICATED		 		0x0303025F
#define OID_FDDI_PORT_CURRENT_PATH		  		0x03030260
#define OID_FDDI_PORT_REQUESTED_PATHS	   		0x03030261
#define OID_FDDI_PORT_MAC_PLACEMENT		 		0x03030262
#define OID_FDDI_PORT_AVAILABLE_PATHS	   		0x03030263
#define OID_FDDI_PORT_MAC_LOOP_TIME		 		0x03030264
#define OID_FDDI_PORT_PMD_CLASS			 		0x03030265
#define OID_FDDI_PORT_CONNECTION_CAPABILITIES	0x03030266
#define OID_FDDI_PORT_INDEX				 		0x03030267
#define OID_FDDI_PORT_MAINT_LS			  		0x03030268
#define OID_FDDI_PORT_BS_FLAG			   		0x03030269
#define OID_FDDI_PORT_PC_LS				 		0x0303026A
#define OID_FDDI_PORT_EB_ERROR_CT		   		0x0303026B
#define OID_FDDI_PORT_LCT_FAIL_CT		   		0x0303026C
#define OID_FDDI_PORT_LER_ESTIMATE		  		0x0303026D
#define OID_FDDI_PORT_LEM_REJECT_CT		 		0x0303026E
#define OID_FDDI_PORT_LEM_CT					0x0303026F