1 /* This file has been prepared for Doxygen automatic documentation generation.*/
2 /*! \file ndis.h ***************************************************************
3  *
4  * \brief
5  *      This file contains the possible external configuration of the USB.
6  *
7  * \addtogroup usbstick
8  *
9  *
10  ******************************************************************************/
11 
12 /**
13  \ingroup usbstick
14  \defgroup RNDIS RNDIS Support
15  @{
16  */
17 
18 /*
19  * ndis.h
20  *
21  * Modified by Colin O'Flynn <coflynn@newae.com>
22  * ntddndis.h modified by Benedikt Spranger <b.spranger@pengutronix.de>
23  *
24  * Thanks to the cygwin development team,
25  * espacially to Casper S. Hornstrup <chorns@users.sourceforge.net>
26  *
27  * THIS SOFTWARE IS NOT COPYRIGHTED
28  *
29  * This source code is offered for use in the public domain. You may
30  * use, modify or distribute it freely.
31  *
32  * This code is distributed in the hope that it will be useful but
33  * WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY
34  * DISCLAIMED. This includes but is not limited to warranties of
35  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
36  *
37  */
38 
39 #ifndef _LINUX_NDIS_H
40 #define _LINUX_NDIS_H
41 
42 #define NDIS_STATUS_MULTICAST_FULL      0xC0010009
43 #define NDIS_STATUS_MULTICAST_EXISTS    0xC001000A
44 #define NDIS_STATUS_MULTICAST_NOT_FOUND 0xC001000B
45 
46 /* from drivers/net/sk98lin/h/skgepnmi.h */
47 #define OID_PNP_CAPABILITIES           0xFD010100
48 #define OID_PNP_SET_POWER              0xFD010101
49 #define OID_PNP_QUERY_POWER            0xFD010102
50 #define OID_PNP_ADD_WAKE_UP_PATTERN    0xFD010103
51 #define OID_PNP_REMOVE_WAKE_UP_PATTERN 0xFD010104
52 #define OID_PNP_ENABLE_WAKE_UP         0xFD010106
53 
54 enum NDIS_DEVICE_POWER_STATE {
55     NdisDeviceStateUnspecified = 0,
56     NdisDeviceStateD0,
57     NdisDeviceStateD1,
58     NdisDeviceStateD2,
59     NdisDeviceStateD3,
60     NdisDeviceStateMaximum
61 };
62 
63 struct NDIS_PM_WAKE_UP_CAPABILITIES {
64     enum NDIS_DEVICE_POWER_STATE MinMagicPacketWakeUp;
65     enum NDIS_DEVICE_POWER_STATE MinPatternWakeUp;
66     enum NDIS_DEVICE_POWER_STATE MinLinkChangeWakeUp;
67 };
68 
69 /* NDIS_PNP_CAPABILITIES.Flags constants */
70 #define NDIS_DEVICE_WAKE_UP_ENABLE               0x00000001
71 #define NDIS_DEVICE_WAKE_ON_PATTERN_MATCH_ENABLE 0x00000002
72 #define NDIS_DEVICE_WAKE_ON_MAGIC_PACKET_ENABLE  0x00000004
73 
74 /*
75 struct NDIS_PNP_CAPABILITIES {
76 	__le32					Flags;
77 	struct NDIS_PM_WAKE_UP_CAPABILITIES	WakeUpCapabilities;
78 };
79 
80 struct NDIS_PM_PACKET_PATTERN {
81 	__le32	Priority;
82 	__le32	Reserved;
83 	__le32	MaskSize;
84 	__le32	PatternOffset;
85 	__le32	PatternSize;
86 	__le32	PatternFlags;
87 };
88 */
89 
90 /* Required Object IDs (OIDs) */
91 #define OID_GEN_SUPPORTED_LIST          0x00010101
92 #define OID_GEN_HARDWARE_STATUS         0x00010102
93 #define OID_GEN_MEDIA_SUPPORTED         0x00010103
94 #define OID_GEN_MEDIA_IN_USE            0x00010104
95 #define OID_GEN_MAXIMUM_LOOKAHEAD       0x00010105
96 #define OID_GEN_MAXIMUM_FRAME_SIZE      0x00010106
97 #define OID_GEN_LINK_SPEED              0x00010107
98 #define OID_GEN_TRANSMIT_BUFFER_SPACE   0x00010108
99 #define OID_GEN_RECEIVE_BUFFER_SPACE    0x00010109
100 #define OID_GEN_TRANSMIT_BLOCK_SIZE     0x0001010A
101 #define OID_GEN_RECEIVE_BLOCK_SIZE      0x0001010B
102 #define OID_GEN_VENDOR_ID               0x0001010C
103 #define OID_GEN_VENDOR_DESCRIPTION      0x0001010D
104 #define OID_GEN_CURRENT_PACKET_FILTER   0x0001010E
105 #define OID_GEN_CURRENT_LOOKAHEAD       0x0001010F
106 #define OID_GEN_DRIVER_VERSION          0x00010110
107 #define OID_GEN_MAXIMUM_TOTAL_SIZE      0x00010111
108 #define OID_GEN_PROTOCOL_OPTIONS        0x00010112
109 #define OID_GEN_MAC_OPTIONS             0x00010113
110 #define OID_GEN_MEDIA_CONNECT_STATUS    0x00010114
111 #define OID_GEN_MAXIMUM_SEND_PACKETS    0x00010115
112 #define OID_GEN_VENDOR_DRIVER_VERSION   0x00010116
113 #define OID_GEN_SUPPORTED_GUIDS         0x00010117
114 #define OID_GEN_NETWORK_LAYER_ADDRESSES 0x00010118
115 #define OID_GEN_TRANSPORT_HEADER_OFFSET 0x00010119
116 #define OID_GEN_MACHINE_NAME            0x0001021A
117 #define OID_GEN_RNDIS_CONFIG_PARAMETER  0x0001021B
118 #define OID_GEN_VLAN_ID                 0x0001021C
119 
120 /* Optional OIDs */
121 #define OID_GEN_MEDIA_CAPABILITIES 0x00010201
122 #define OID_GEN_PHYSICAL_MEDIUM    0x00010202
123 
124 /* Required statistics OIDs */
125 #define OID_GEN_XMIT_OK       0x00020101
126 #define OID_GEN_RCV_OK        0x00020102
127 #define OID_GEN_XMIT_ERROR    0x00020103
128 #define OID_GEN_RCV_ERROR     0x00020104
129 #define OID_GEN_RCV_NO_BUFFER 0x00020105
130 
131 /* Optional statistics OIDs */
132 #define OID_GEN_DIRECTED_BYTES_XMIT     0x00020201
133 #define OID_GEN_DIRECTED_FRAMES_XMIT    0x00020202
134 #define OID_GEN_MULTICAST_BYTES_XMIT    0x00020203
135 #define OID_GEN_MULTICAST_FRAMES_XMIT   0x00020204
136 #define OID_GEN_BROADCAST_BYTES_XMIT    0x00020205
137 #define OID_GEN_BROADCAST_FRAMES_XMIT   0x00020206
138 #define OID_GEN_DIRECTED_BYTES_RCV      0x00020207
139 #define OID_GEN_DIRECTED_FRAMES_RCV     0x00020208
140 #define OID_GEN_MULTICAST_BYTES_RCV     0x00020209
141 #define OID_GEN_MULTICAST_FRAMES_RCV    0x0002020A
142 #define OID_GEN_BROADCAST_BYTES_RCV     0x0002020B
143 #define OID_GEN_BROADCAST_FRAMES_RCV    0x0002020C
144 #define OID_GEN_RCV_CRC_ERROR           0x0002020D
145 #define OID_GEN_TRANSMIT_QUEUE_LENGTH   0x0002020E
146 #define OID_GEN_GET_TIME_CAPS           0x0002020F
147 #define OID_GEN_GET_NETCARD_TIME        0x00020210
148 #define OID_GEN_NETCARD_LOAD            0x00020211
149 #define OID_GEN_DEVICE_PROFILE          0x00020212
150 #define OID_GEN_INIT_TIME_MS            0x00020213
151 #define OID_GEN_RESET_COUNTS            0x00020214
152 #define OID_GEN_MEDIA_SENSE_COUNTS      0x00020215
153 #define OID_GEN_FRIENDLY_NAME           0x00020216
154 #define OID_GEN_MINIPORT_INFO           0x00020217
155 #define OID_GEN_RESET_VERIFY_PARAMETERS 0x00020218
156 
157 /* IEEE 802.3 (Ethernet) OIDs */
158 #define NDIS_802_3_MAC_OPTION_PRIORITY 0x00000001
159 
160 #define OID_802_3_PERMANENT_ADDRESS      0x01010101
161 #define OID_802_3_CURRENT_ADDRESS        0x01010102
162 #define OID_802_3_MULTICAST_LIST         0x01010103
163 #define OID_802_3_MAXIMUM_LIST_SIZE      0x01010104
164 #define OID_802_3_MAC_OPTIONS            0x01010105
165 #define OID_802_3_RCV_ERROR_ALIGNMENT    0x01020101
166 #define OID_802_3_XMIT_ONE_COLLISION     0x01020102
167 #define OID_802_3_XMIT_MORE_COLLISIONS   0x01020103
168 #define OID_802_3_XMIT_DEFERRED          0x01020201
169 #define OID_802_3_XMIT_MAX_COLLISIONS    0x01020202
170 #define OID_802_3_RCV_OVERRUN            0x01020203
171 #define OID_802_3_XMIT_UNDERRUN          0x01020204
172 #define OID_802_3_XMIT_HEARTBEAT_FAILURE 0x01020205
173 #define OID_802_3_XMIT_TIMES_CRS_LOST    0x01020206
174 #define OID_802_3_XMIT_LATE_COLLISIONS   0x01020207
175 
176 /* Wireless LAN OIDs */
177 /* Mandatory */
178 #define OID_802_11_BSSID               0x0D010101 /* Q  S     */
179 #define OID_802_11_SSID                0x0D010102 /* Q  S     */
180 #define OID_802_11_NETWORK_TYPE_IN_USE 0x0D010204 /* Q  S     */
181 #define OID_802_11_RSSI                0x0D010206 /* Q      I */
182 #define OID_802_11_BSSID_LIST          0x0D010217 /* Q        */
183 #define OID_802_11_BSSID_LIST_SCAN     0x0D01011A /*    S     */
184 #define OID_802_11_INFRASTRUCTURE_MODE 0x0D010108 /* Q  S     */
185 #define OID_802_11_SUPPORTED_RATES     0x0D01020E /* Q        */
186 #define OID_802_11_CONFIGURATION       0x0D010211 /* Q  S     */
187 #define OID_802_11_ADD_WEP             0x0D010113 /*    S     */
188 #define OID_802_11_WEP_STATUS          0x0D01011B /* Q  S     */
189 #define OID_802_11_REMOVE_WEP          0x0D010114 /*    S     */
190 #define OID_802_11_DISASSOCIATE        0x0D010115 /*    S     */
191 #define OID_802_11_AUTHENTICATION_MODE 0x0D010118 /* Q  S     */
192 #define OID_802_11_RELOAD_DEFAULTS     0x0D01011C /*    S     */
193 
194 /* OID_GEN_MINIPORT_INFO constants */
195 #define NDIS_MINIPORT_BUS_MASTER                     0x00000001
196 #define NDIS_MINIPORT_WDM_DRIVER                     0x00000002
197 #define NDIS_MINIPORT_SG_LIST                        0x00000004
198 #define NDIS_MINIPORT_SUPPORTS_MEDIA_QUERY           0x00000008
199 #define NDIS_MINIPORT_INDICATES_PACKETS              0x00000010
200 #define NDIS_MINIPORT_IGNORE_PACKET_QUEUE            0x00000020
201 #define NDIS_MINIPORT_IGNORE_REQUEST_QUEUE           0x00000040
202 #define NDIS_MINIPORT_IGNORE_TOKEN_RING_ERRORS       0x00000080
203 #define NDIS_MINIPORT_INTERMEDIATE_DRIVER            0x00000100
204 #define NDIS_MINIPORT_IS_NDIS_5                      0x00000200
205 #define NDIS_MINIPORT_IS_CO                          0x00000400
206 #define NDIS_MINIPORT_DESERIALIZE                    0x00000800
207 #define NDIS_MINIPORT_REQUIRES_MEDIA_POLLING         0x00001000
208 #define NDIS_MINIPORT_SUPPORTS_MEDIA_SENSE           0x00002000
209 #define NDIS_MINIPORT_NETBOOT_CARD                   0x00004000
210 #define NDIS_MINIPORT_PM_SUPPORTED                   0x00008000
211 #define NDIS_MINIPORT_SUPPORTS_MAC_ADDRESS_OVERWRITE 0x00010000
212 #define NDIS_MINIPORT_USES_SAFE_BUFFER_APIS          0x00020000
213 #define NDIS_MINIPORT_HIDDEN                         0x00040000
214 #define NDIS_MINIPORT_SWENUM                         0x00080000
215 #define NDIS_MINIPORT_SURPRISE_REMOVE_OK             0x00100000
216 #define NDIS_MINIPORT_NO_HALT_ON_SUSPEND             0x00200000
217 #define NDIS_MINIPORT_HARDWARE_DEVICE                0x00400000
218 #define NDIS_MINIPORT_SUPPORTS_CANCEL_SEND_PACKETS   0x00800000
219 #define NDIS_MINIPORT_64BITS_DMA                     0x01000000
220 
221 #define NDIS_MEDIUM_802_3        0x00000000
222 #define NDIS_MEDIUM_802_5        0x00000001
223 #define NDIS_MEDIUM_FDDI         0x00000002
224 #define NDIS_MEDIUM_WAN          0x00000003
225 #define NDIS_MEDIUM_LOCAL_TALK   0x00000004
226 #define NDIS_MEDIUM_DIX          0x00000005
227 #define NDIS_MEDIUM_ARCENT_RAW   0x00000006
228 #define NDIS_MEDIUM_ARCENT_878_2 0x00000007
229 #define NDIS_MEDIUM_ATM          0x00000008
230 #define NDIS_MEDIUM_WIRELESS_LAN 0x00000009
231 #define NDIS_MEDIUM_IRDA         0x0000000A
232 #define NDIS_MEDIUM_BPC          0x0000000B
233 #define NDIS_MEDIUM_CO_WAN       0x0000000C
234 #define NDIS_MEDIUM_1394         0x0000000D
235 
236 #define NDIS_PACKET_TYPE_DIRECTED       0x00000001
237 #define NDIS_PACKET_TYPE_MULTICAST      0x00000002
238 #define NDIS_PACKET_TYPE_ALL_MULTICAST  0x00000004
239 #define NDIS_PACKET_TYPE_BROADCAST      0x00000008
240 #define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
241 #define NDIS_PACKET_TYPE_PROMISCUOUS    0x00000020
242 #define NDIS_PACKET_TYPE_SMT            0x00000040
243 #define NDIS_PACKET_TYPE_ALL_LOCAL      0x00000080
244 #define NDIS_PACKET_TYPE_GROUP          0x00000100
245 #define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
246 #define NDIS_PACKET_TYPE_FUNCTIONAL     0x00000400
247 #define NDIS_PACKET_TYPE_MAC_FRAME      0x00000800
248 
249 #define NDIS_MEDIA_STATE_CONNECTED    0x00000000
250 #define NDIS_MEDIA_STATE_DISCONNECTED 0x00000001
251 
252 #define NDIS_MAC_OPTION_COPY_LOOKAHEAD_DATA 0x00000001
253 #define NDIS_MAC_OPTION_RECEIVE_SERIALIZED  0x00000002
254 #define NDIS_MAC_OPTION_TRANSFERS_NOT_PEND  0x00000004
255 #define NDIS_MAC_OPTION_NO_LOOPBACK         0x00000008
256 #define NDIS_MAC_OPTION_FULL_DUPLEX         0x00000010
257 #define NDIS_MAC_OPTION_EOTX_INDICATION     0x00000020
258 #define NDIS_MAC_OPTION_8021P_PRIORITY      0x00000040
259 #define NDIS_MAC_OPTION_RESERVED            0x80000000
260 
261 /** Hardware status of the underlying NIC */
262 #define NDIS_HW_STS_READY        0x00000000UL
263 #define NDIS_HW_STS_INITIALIZING 0x00000001UL
264 #define NDIS_HW_STS_RESET        0x00000002UL
265 #define NDIS_HW_STS_CLOSING      0x00000003UL
266 #define NDIS_HW_STS_NOT_READY    0x00000004UL
267 
268 #endif /* _LINUX_NDIS_H */
269 
270 /** @} */
271