1 /* $FreeBSD$ */ 2 /* $OpenBSD: if_urndisreg.h,v 1.19 2013/11/21 14:08:05 mpi Exp $ */ 3 4 /* 5 * Copyright (c) 2010 Jonathan Armani <armani@openbsd.org> 6 * Copyright (c) 2010 Fabien Romano <fabien@openbsd.org> 7 * Copyright (c) 2010 Michael Knudsen <mk@openbsd.org> 8 * All rights reserved. 9 * 10 * Permission to use, copy, modify, and distribute this software for any 11 * purpose with or without fee is hereby granted, provided that the above 12 * copyright notice and this permission notice appear in all copies. 13 * 14 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 15 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 16 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 17 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 18 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 19 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 20 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 21 */ 22 23 #ifndef _NET_RNDIS_H_ 24 #define _NET_RNDIS_H_ 25 26 /* Canonical major/minor version as of 22th Aug. 2016. */ 27 #define RNDIS_VERSION_MAJOR 0x00000001 28 #define RNDIS_VERSION_MINOR 0x00000000 29 30 #define RNDIS_STATUS_SUCCESS 0x00000000L 31 #define RNDIS_STATUS_PENDING 0x00000103L 32 #define RNDIS_STATUS_MEDIA_CONNECT 0x4001000BL 33 #define RNDIS_STATUS_MEDIA_DISCONNECT 0x4001000CL 34 #define RNDIS_STATUS_BUFFER_OVERFLOW 0x80000005L 35 #define RNDIS_STATUS_FAILURE 0xC0000001L 36 #define RNDIS_STATUS_NOT_SUPPORTED 0xC00000BBL 37 #define RNDIS_STATUS_RESOURCES 0xC000009AL 38 #define RNDIS_STATUS_INVALID_DATA 0xC0010015L 39 40 #define OID_GEN_SUPPORTED_LIST 0x00010101 41 #define OID_GEN_HARDWARE_STATUS 0x00010102 42 #define OID_GEN_MEDIA_SUPPORTED 0x00010103 43 #define OID_GEN_MEDIA_IN_USE 0x00010104 44 #define OID_GEN_MAXIMUM_LOOKAHEAD 0x00010105 45 #define OID_GEN_MAXIMUM_FRAME_SIZE 0x00010106 46 #define OID_GEN_LINK_SPEED 0x00010107 47 #define OID_GEN_TRANSMIT_BUFFER_SPACE 0x00010108 48 #define OID_GEN_RECEIVE_BUFFER_SPACE 0x00010109 49 #define OID_GEN_TRANSMIT_BLOCK_SIZE 0x0001010A 50 #define OID_GEN_RECEIVE_BLOCK_SIZE 0x0001010B 51 #define OID_GEN_VENDOR_ID 0x0001010C 52 #define OID_GEN_VENDOR_DESCRIPTION 0x0001010D 53 #define OID_GEN_CURRENT_PACKET_FILTER 0x0001010E 54 #define OID_GEN_CURRENT_LOOKAHEAD 0x0001010F 55 #define OID_GEN_DRIVER_VERSION 0x00010110 56 #define OID_GEN_MAXIMUM_TOTAL_SIZE 0x00010111 57 #define OID_GEN_PROTOCOL_OPTIONS 0x00010112 58 #define OID_GEN_MAC_OPTIONS 0x00010113 59 #define OID_GEN_MEDIA_CONNECT_STATUS 0x00010114 60 #define OID_GEN_MAXIMUM_SEND_PACKETS 0x00010115 61 #define OID_GEN_VENDOR_DRIVER_VERSION 0x00010116 62 #define OID_GEN_SUPPORTED_GUIDS 0x00010117 63 #define OID_GEN_NETWORK_LAYER_ADDRESSES 0x00010118 64 #define OID_GEN_TRANSPORT_HEADER_OFFSET 0x00010119 65 #define OID_GEN_RECEIVE_SCALE_CAPABILITIES 0x00010203 66 #define OID_GEN_RECEIVE_SCALE_PARAMETERS 0x00010204 67 #define OID_GEN_MACHINE_NAME 0x0001021A 68 #define OID_GEN_RNDIS_CONFIG_PARAMETER 0x0001021B 69 #define OID_GEN_VLAN_ID 0x0001021C 70 71 #define OID_802_3_PERMANENT_ADDRESS 0x01010101 72 #define OID_802_3_CURRENT_ADDRESS 0x01010102 73 #define OID_802_3_MULTICAST_LIST 0x01010103 74 #define OID_802_3_MAXIMUM_LIST_SIZE 0x01010104 75 #define OID_802_3_MAC_OPTIONS 0x01010105 76 #define OID_802_3_RCV_ERROR_ALIGNMENT 0x01020101 77 #define OID_802_3_XMIT_ONE_COLLISION 0x01020102 78 #define OID_802_3_XMIT_MORE_COLLISIONS 0x01020103 79 #define OID_802_3_XMIT_DEFERRED 0x01020201 80 #define OID_802_3_XMIT_MAX_COLLISIONS 0x01020202 81 #define OID_802_3_RCV_OVERRUN 0x01020203 82 #define OID_802_3_XMIT_UNDERRUN 0x01020204 83 #define OID_802_3_XMIT_HEARTBEAT_FAILURE 0x01020205 84 #define OID_802_3_XMIT_TIMES_CRS_LOST 0x01020206 85 #define OID_802_3_XMIT_LATE_COLLISIONS 0x01020207 86 87 #define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C 88 89 #define RNDIS_MEDIUM_802_3 0x00000000 90 91 /* Device flags */ 92 #define RNDIS_DF_CONNECTIONLESS 0x00000001 93 #define RNDIS_DF_CONNECTION_ORIENTED 0x00000002 94 95 /* 96 * RNDIS data message 97 */ 98 #define REMOTE_NDIS_PACKET_MSG 0x00000001 99 100 struct rndis_packet_msg { 101 uint32_t rm_type; 102 uint32_t rm_len; 103 uint32_t rm_dataoffset; 104 uint32_t rm_datalen; 105 uint32_t rm_oobdataoffset; 106 uint32_t rm_oobdatalen; 107 uint32_t rm_oobdataelements; 108 uint32_t rm_pktinfooffset; 109 uint32_t rm_pktinfolen; 110 uint32_t rm_vchandle; 111 uint32_t rm_reserved; 112 }; 113 114 /* 115 * Minimum value for rm_dataoffset, rm_oobdataoffset, and 116 * rm_pktinfooffset. 117 */ 118 #define RNDIS_PACKET_MSG_OFFSET_MIN \ 119 (sizeof(struct rndis_packet_msg) - \ 120 __offsetof(struct rndis_packet_msg, rm_dataoffset)) 121 122 /* Per-packet-info for RNDIS data message */ 123 struct rndis_pktinfo { 124 uint32_t rm_size; 125 uint32_t rm_type; /* NDIS_PKTINFO_TYPE_ */ 126 uint32_t rm_pktinfooffset; 127 uint8_t rm_data[]; 128 }; 129 130 #define RNDIS_PKTINFO_OFFSET \ 131 __offsetof(struct rndis_pktinfo, rm_data[0]) 132 #define RNDIS_PKTINFO_ALIGN 4 133 134 #define NDIS_PKTINFO_TYPE_CSUM 0 135 #define NDIS_PKTINFO_TYPE_IPSEC 1 136 #define NDIS_PKTINFO_TYPE_LSO 2 137 #define NDIS_PKTINFO_TYPE_CLASSIFY 3 138 /* reserved 4 */ 139 #define NDIS_PKTINFO_TYPE_SGLIST 5 140 #define NDIS_PKTINFO_TYPE_VLAN 6 141 #define NDIS_PKTINFO_TYPE_ORIG 7 142 #define NDIS_PKTINFO_TYPE_PKT_CANCELID 8 143 #define NDIS_PKTINFO_TYPE_ORIG_NBLIST 9 144 #define NDIS_PKTINFO_TYPE_CACHE_NBLIST 10 145 #define NDIS_PKTINFO_TYPE_PKT_PAD 11 146 147 /* 148 * RNDIS control messages 149 */ 150 struct rndis_comp_hdr { 151 uint32_t rm_type; 152 uint32_t rm_len; 153 uint32_t rm_rid; 154 uint32_t rm_status; 155 }; 156 157 /* Initialize the device. */ 158 #define REMOTE_NDIS_INITIALIZE_MSG 0x00000002 159 #define REMOTE_NDIS_INITIALIZE_CMPLT 0x80000002 160 161 struct rndis_init_req { 162 uint32_t rm_type; 163 uint32_t rm_len; 164 uint32_t rm_rid; 165 uint32_t rm_ver_major; 166 uint32_t rm_ver_minor; 167 uint32_t rm_max_xfersz; 168 }; 169 170 struct rndis_init_comp { 171 uint32_t rm_type; 172 uint32_t rm_len; 173 uint32_t rm_rid; 174 uint32_t rm_status; 175 uint32_t rm_ver_major; 176 uint32_t rm_ver_minor; 177 uint32_t rm_devflags; 178 uint32_t rm_medium; 179 uint32_t rm_pktmaxcnt; 180 uint32_t rm_pktmaxsz; 181 uint32_t rm_align; 182 uint32_t rm_aflistoffset; 183 uint32_t rm_aflistsz; 184 }; 185 186 #define RNDIS_INIT_COMP_SIZE_MIN \ 187 __offsetof(struct rndis_init_comp, rm_aflistsz) 188 189 /* Halt the device. No response sent. */ 190 #define REMOTE_NDIS_HALT_MSG 0x00000003 191 192 struct rndis_halt_req { 193 uint32_t rm_type; 194 uint32_t rm_len; 195 uint32_t rm_rid; 196 }; 197 198 /* Send a query object. */ 199 #define REMOTE_NDIS_QUERY_MSG 0x00000004 200 #define REMOTE_NDIS_QUERY_CMPLT 0x80000004 201 202 struct rndis_query_req { 203 uint32_t rm_type; 204 uint32_t rm_len; 205 uint32_t rm_rid; 206 uint32_t rm_oid; 207 uint32_t rm_infobuflen; 208 uint32_t rm_infobufoffset; 209 uint32_t rm_devicevchdl; 210 }; 211 212 #define RNDIS_QUERY_REQ_INFOBUFOFFSET \ 213 (sizeof(struct rndis_query_req) - \ 214 __offsetof(struct rndis_query_req, rm_rid)) 215 216 struct rndis_query_comp { 217 uint32_t rm_type; 218 uint32_t rm_len; 219 uint32_t rm_rid; 220 uint32_t rm_status; 221 uint32_t rm_infobuflen; 222 uint32_t rm_infobufoffset; 223 }; 224 225 #define RNDIS_QUERY_COMP_INFOBUFABS(ofs) \ 226 ((ofs) + __offsetof(struct rndis_query_req, rm_rid)) 227 228 /* Send a set object request. */ 229 #define REMOTE_NDIS_SET_MSG 0x00000005 230 #define REMOTE_NDIS_SET_CMPLT 0x80000005 231 232 struct rndis_set_req { 233 uint32_t rm_type; 234 uint32_t rm_len; 235 uint32_t rm_rid; 236 uint32_t rm_oid; 237 uint32_t rm_infobuflen; 238 uint32_t rm_infobufoffset; 239 uint32_t rm_devicevchdl; 240 }; 241 242 #define RNDIS_SET_REQ_INFOBUFOFFSET \ 243 (sizeof(struct rndis_set_req) - \ 244 __offsetof(struct rndis_set_req, rm_rid)) 245 246 struct rndis_set_comp { 247 uint32_t rm_type; 248 uint32_t rm_len; 249 uint32_t rm_rid; 250 uint32_t rm_status; 251 }; 252 253 /* 254 * Parameter used by OID_GEN_RNDIS_CONFIG_PARAMETER. 255 */ 256 #define REMOTE_NDIS_SET_PARAM_NUMERIC 0x00000000 257 #define REMOTE_NDIS_SET_PARAM_STRING 0x00000002 258 259 struct rndis_set_parameter { 260 uint32_t rm_nameoffset; 261 uint32_t rm_namelen; 262 uint32_t rm_type; 263 uint32_t rm_valueoffset; 264 uint32_t rm_valuelen; 265 }; 266 267 /* Perform a soft reset on the device. */ 268 #define REMOTE_NDIS_RESET_MSG 0x00000006 269 #define REMOTE_NDIS_RESET_CMPLT 0x80000006 270 271 struct rndis_reset_req { 272 uint32_t rm_type; 273 uint32_t rm_len; 274 uint32_t rm_rid; 275 }; 276 277 struct rndis_reset_comp { 278 uint32_t rm_type; 279 uint32_t rm_len; 280 uint32_t rm_status; 281 uint32_t rm_adrreset; 282 }; 283 284 /* 802.3 link-state or undefined message error. */ 285 #define REMOTE_NDIS_INDICATE_STATUS_MSG 0x00000007 286 287 /* Keepalive messsage. May be sent by device. */ 288 #define REMOTE_NDIS_KEEPALIVE_MSG 0x00000008 289 #define REMOTE_NDIS_KEEPALIVE_CMPLT 0x80000008 290 291 struct rndis_keepalive_req { 292 uint32_t rm_type; 293 uint32_t rm_len; 294 uint32_t rm_rid; 295 }; 296 297 struct rndis_keepalive_comp { 298 uint32_t rm_type; 299 uint32_t rm_len; 300 uint32_t rm_rid; 301 uint32_t rm_status; 302 }; 303 304 /* packet filter bits used by OID_GEN_CURRENT_PACKET_FILTER */ 305 #define NDIS_PACKET_TYPE_DIRECTED 0x00000001 306 #define NDIS_PACKET_TYPE_MULTICAST 0x00000002 307 #define NDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004 308 #define NDIS_PACKET_TYPE_BROADCAST 0x00000008 309 #define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010 310 #define NDIS_PACKET_TYPE_PROMISCUOUS 0x00000020 311 #define NDIS_PACKET_TYPE_SMT 0x00000040 312 #define NDIS_PACKET_TYPE_ALL_LOCAL 0x00000080 313 #define NDIS_PACKET_TYPE_GROUP 0x00001000 314 #define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00002000 315 #define NDIS_PACKET_TYPE_FUNCTIONAL 0x00004000 316 #define NDIS_PACKET_TYPE_MAC_FRAME 0x00008000 317 318 /* RNDIS offsets */ 319 #define RNDIS_HEADER_OFFSET 8 /* bytes */ 320 #define RNDIS_DATA_OFFSET \ 321 ((uint32_t)(sizeof(struct rndis_packet_msg) - RNDIS_HEADER_OFFSET)) 322 323 #endif /* !_NET_RNDIS_H_ */ 324