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_MACHINE_NAME 0x0001021A 66 #define OID_GEN_RNDIS_CONFIG_PARAMETER 0x0001021B 67 #define OID_GEN_VLAN_ID 0x0001021C 68 69 #define OID_802_3_PERMANENT_ADDRESS 0x01010101 70 #define OID_802_3_CURRENT_ADDRESS 0x01010102 71 #define OID_802_3_MULTICAST_LIST 0x01010103 72 #define OID_802_3_MAXIMUM_LIST_SIZE 0x01010104 73 #define OID_802_3_MAC_OPTIONS 0x01010105 74 #define OID_802_3_RCV_ERROR_ALIGNMENT 0x01020101 75 #define OID_802_3_XMIT_ONE_COLLISION 0x01020102 76 #define OID_802_3_XMIT_MORE_COLLISIONS 0x01020103 77 #define OID_802_3_XMIT_DEFERRED 0x01020201 78 #define OID_802_3_XMIT_MAX_COLLISIONS 0x01020202 79 #define OID_802_3_RCV_OVERRUN 0x01020203 80 #define OID_802_3_XMIT_UNDERRUN 0x01020204 81 #define OID_802_3_XMIT_HEARTBEAT_FAILURE 0x01020205 82 #define OID_802_3_XMIT_TIMES_CRS_LOST 0x01020206 83 #define OID_802_3_XMIT_LATE_COLLISIONS 0x01020207 84 85 #define RNDIS_MEDIUM_802_3 0x00000000 86 87 /* Device flags */ 88 #define RNDIS_DF_CONNECTIONLESS 0x00000001 89 #define RNDIS_DF_CONNECTION_ORIENTED 0x00000002 90 91 /* 92 * RNDIS data message 93 */ 94 #define REMOTE_NDIS_PACKET_MSG 0x00000001 95 96 struct rndis_packet_msg { 97 uint32_t rm_type; 98 uint32_t rm_len; 99 uint32_t rm_dataoffset; 100 uint32_t rm_datalen; 101 uint32_t rm_oobdataoffset; 102 uint32_t rm_oobdatalen; 103 uint32_t rm_oobdataelements; 104 uint32_t rm_pktinfooffset; 105 uint32_t rm_pktinfolen; 106 uint32_t rm_vchandle; 107 uint32_t rm_reserved; 108 }; 109 110 /* 111 * RNDIS control messages 112 */ 113 struct rndis_comp_hdr { 114 uint32_t rm_type; 115 uint32_t rm_len; 116 uint32_t rm_rid; 117 uint32_t rm_status; 118 }; 119 120 /* Initialize the device. */ 121 #define REMOTE_NDIS_INITIALIZE_MSG 0x00000002 122 #define REMOTE_NDIS_INITIALIZE_CMPLT 0x80000002 123 124 struct rndis_init_req { 125 uint32_t rm_type; 126 uint32_t rm_len; 127 uint32_t rm_rid; 128 uint32_t rm_ver_major; 129 uint32_t rm_ver_minor; 130 uint32_t rm_max_xfersz; 131 }; 132 133 struct rndis_init_comp { 134 uint32_t rm_type; 135 uint32_t rm_len; 136 uint32_t rm_rid; 137 uint32_t rm_status; 138 uint32_t rm_ver_major; 139 uint32_t rm_ver_minor; 140 uint32_t rm_devflags; 141 uint32_t rm_medium; 142 uint32_t rm_pktmaxcnt; 143 uint32_t rm_pktmaxsz; 144 uint32_t rm_align; 145 uint32_t rm_aflistoffset; 146 uint32_t rm_aflistsz; 147 }; 148 149 /* Halt the device. No response sent. */ 150 #define REMOTE_NDIS_HALT_MSG 0x00000003 151 152 struct rndis_halt_req { 153 uint32_t rm_type; 154 uint32_t rm_len; 155 uint32_t rm_rid; 156 }; 157 158 /* Send a query object. */ 159 #define REMOTE_NDIS_QUERY_MSG 0x00000004 160 #define REMOTE_NDIS_QUERY_CMPLT 0x80000004 161 162 struct rndis_query_req { 163 uint32_t rm_type; 164 uint32_t rm_len; 165 uint32_t rm_rid; 166 uint32_t rm_oid; 167 uint32_t rm_infobuflen; 168 uint32_t rm_infobufoffset; 169 uint32_t rm_devicevchdl; 170 }; 171 172 struct rndis_query_comp { 173 uint32_t rm_type; 174 uint32_t rm_len; 175 uint32_t rm_rid; 176 uint32_t rm_status; 177 uint32_t rm_infobuflen; 178 uint32_t rm_infobufoffset; 179 }; 180 181 /* Send a set object request. */ 182 #define REMOTE_NDIS_SET_MSG 0x00000005 183 #define REMOTE_NDIS_SET_CMPLT 0x80000005 184 185 struct rndis_set_req { 186 uint32_t rm_type; 187 uint32_t rm_len; 188 uint32_t rm_rid; 189 uint32_t rm_oid; 190 uint32_t rm_infobuflen; 191 uint32_t rm_infobufoffset; 192 uint32_t rm_devicevchdl; 193 }; 194 195 struct rndis_set_comp { 196 uint32_t rm_type; 197 uint32_t rm_len; 198 uint32_t rm_rid; 199 uint32_t rm_status; 200 }; 201 202 #define REMOTE_NDIS_SET_PARAM_NUMERIC 0x00000000 203 #define REMOTE_NDIS_SET_PARAM_STRING 0x00000002 204 205 struct rndis_set_parameter { 206 uint32_t rm_nameoffset; 207 uint32_t rm_namelen; 208 uint32_t rm_type; 209 uint32_t rm_valueoffset; 210 uint32_t rm_valuelen; 211 }; 212 213 /* Perform a soft reset on the device. */ 214 #define REMOTE_NDIS_RESET_MSG 0x00000006 215 #define REMOTE_NDIS_RESET_CMPLT 0x80000006 216 217 struct rndis_reset_req { 218 uint32_t rm_type; 219 uint32_t rm_len; 220 uint32_t rm_rid; 221 }; 222 223 struct rndis_reset_comp { 224 uint32_t rm_type; 225 uint32_t rm_len; 226 uint32_t rm_status; 227 uint32_t rm_adrreset; 228 }; 229 230 /* 802.3 link-state or undefined message error. */ 231 #define REMOTE_NDIS_INDICATE_STATUS_MSG 0x00000007 232 233 /* Keepalive messsage. May be sent by device. */ 234 #define REMOTE_NDIS_KEEPALIVE_MSG 0x00000008 235 #define REMOTE_NDIS_KEEPALIVE_CMPLT 0x80000008 236 237 struct rndis_keepalive_req { 238 uint32_t rm_type; 239 uint32_t rm_len; 240 uint32_t rm_rid; 241 }; 242 243 struct rndis_keepalive_comp { 244 uint32_t rm_type; 245 uint32_t rm_len; 246 uint32_t rm_rid; 247 uint32_t rm_status; 248 }; 249 250 /* packet filter bits used by OID_GEN_CURRENT_PACKET_FILTER */ 251 #define RNDIS_PACKET_TYPE_DIRECTED 0x00000001 252 #define RNDIS_PACKET_TYPE_MULTICAST 0x00000002 253 #define RNDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004 254 #define RNDIS_PACKET_TYPE_BROADCAST 0x00000008 255 #define RNDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010 256 #define RNDIS_PACKET_TYPE_PROMISCUOUS 0x00000020 257 #define RNDIS_PACKET_TYPE_SMT 0x00000040 258 #define RNDIS_PACKET_TYPE_ALL_LOCAL 0x00000080 259 #define RNDIS_PACKET_TYPE_GROUP 0x00001000 260 #define RNDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00002000 261 #define RNDIS_PACKET_TYPE_FUNCTIONAL 0x00004000 262 #define RNDIS_PACKET_TYPE_MAC_FRAME 0x00008000 263 264 /* RNDIS offsets */ 265 #define RNDIS_HEADER_OFFSET 8 /* bytes */ 266 #define RNDIS_DATA_OFFSET \ 267 ((uint32_t)(sizeof(struct rndis_packet_msg) - RNDIS_HEADER_OFFSET)) 268 269 #endif /* !_NET_RNDIS_H_ */ 270