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