1219820Sjeff/* $FreeBSD: stable/10/sys/net/rndis.h 321760 2017-07-31 06:40:09Z sephe $ */ 2219820Sjeff/* $OpenBSD: if_urndisreg.h,v 1.19 2013/11/21 14:08:05 mpi Exp $ */ 3219820Sjeff 4219820Sjeff/* 5219820Sjeff * Copyright (c) 2010 Jonathan Armani <armani@openbsd.org> 6219820Sjeff * Copyright (c) 2010 Fabien Romano <fabien@openbsd.org> 7219820Sjeff * Copyright (c) 2010 Michael Knudsen <mk@openbsd.org> 8309378Sjhb * All rights reserved. 9219820Sjeff * 10219820Sjeff * Permission to use, copy, modify, and distribute this software for any 11219820Sjeff * purpose with or without fee is hereby granted, provided that the above 12219820Sjeff * copyright notice and this permission notice appear in all copies. 13219820Sjeff * 14219820Sjeff * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 15219820Sjeff * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 16219820Sjeff * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 17219820Sjeff * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 18219820Sjeff * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 19219820Sjeff * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 20219820Sjeff * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 21219820Sjeff */ 22219820Sjeff 23219820Sjeff#ifndef _NET_RNDIS_H_ 24219820Sjeff#define _NET_RNDIS_H_ 25219820Sjeff 26219820Sjeff/* Canonical major/minor version as of 22th Aug. 2016. */ 27219820Sjeff#define RNDIS_VERSION_MAJOR 0x00000001 28219820Sjeff#define RNDIS_VERSION_MINOR 0x00000000 29219820Sjeff 30219820Sjeff#define RNDIS_STATUS_SUCCESS 0x00000000L 31219820Sjeff#define RNDIS_STATUS_PENDING 0x00000103L 32219820Sjeff#define RNDIS_STATUS_MEDIA_CONNECT 0x4001000BL 33219820Sjeff#define RNDIS_STATUS_MEDIA_DISCONNECT 0x4001000CL 34219820Sjeff#define RNDIS_STATUS_LINK_SPEED_CHANGE 0x40010013L 35219820Sjeff#define RNDIS_STATUS_NETWORK_CHANGE 0x40010018L 36219820Sjeff#define RNDIS_STATUS_TASK_OFFLOAD_CURRENT_CONFIG 0x40020006L 37219820Sjeff#define RNDIS_STATUS_BUFFER_OVERFLOW 0x80000005L 38219820Sjeff#define RNDIS_STATUS_FAILURE 0xC0000001L 39309378Sjhb#define RNDIS_STATUS_NOT_SUPPORTED 0xC00000BBL 40309378Sjhb#define RNDIS_STATUS_RESOURCES 0xC000009AL 41219820Sjeff#define RNDIS_STATUS_INVALID_DATA 0xC0010015L 42219820Sjeff 43219820Sjeff#define OID_GEN_SUPPORTED_LIST 0x00010101 44219820Sjeff#define OID_GEN_HARDWARE_STATUS 0x00010102 45219820Sjeff#define OID_GEN_MEDIA_SUPPORTED 0x00010103 46219820Sjeff#define OID_GEN_MEDIA_IN_USE 0x00010104 47219820Sjeff#define OID_GEN_MAXIMUM_LOOKAHEAD 0x00010105 48219820Sjeff#define OID_GEN_MAXIMUM_FRAME_SIZE 0x00010106 49271127Shselasky#define OID_GEN_LINK_SPEED 0x00010107 50309378Sjhb#define OID_GEN_TRANSMIT_BUFFER_SPACE 0x00010108 51309378Sjhb#define OID_GEN_RECEIVE_BUFFER_SPACE 0x00010109 52219820Sjeff#define OID_GEN_TRANSMIT_BLOCK_SIZE 0x0001010A 53309378Sjhb#define OID_GEN_RECEIVE_BLOCK_SIZE 0x0001010B 54219820Sjeff#define OID_GEN_VENDOR_ID 0x0001010C 55219820Sjeff#define OID_GEN_VENDOR_DESCRIPTION 0x0001010D 56219820Sjeff#define OID_GEN_CURRENT_PACKET_FILTER 0x0001010E 57219820Sjeff#define OID_GEN_CURRENT_LOOKAHEAD 0x0001010F 58219820Sjeff#define OID_GEN_DRIVER_VERSION 0x00010110 59219820Sjeff#define OID_GEN_MAXIMUM_TOTAL_SIZE 0x00010111 60219820Sjeff#define OID_GEN_PROTOCOL_OPTIONS 0x00010112 61219820Sjeff#define OID_GEN_MAC_OPTIONS 0x00010113 62219820Sjeff#define OID_GEN_MEDIA_CONNECT_STATUS 0x00010114 63219820Sjeff#define OID_GEN_MAXIMUM_SEND_PACKETS 0x00010115 64219820Sjeff#define OID_GEN_VENDOR_DRIVER_VERSION 0x00010116 65219820Sjeff#define OID_GEN_SUPPORTED_GUIDS 0x00010117 66219820Sjeff#define OID_GEN_NETWORK_LAYER_ADDRESSES 0x00010118 67219820Sjeff#define OID_GEN_TRANSPORT_HEADER_OFFSET 0x00010119 68219820Sjeff#define OID_GEN_RECEIVE_SCALE_CAPABILITIES 0x00010203 69219820Sjeff#define OID_GEN_RECEIVE_SCALE_PARAMETERS 0x00010204 70219820Sjeff#define OID_GEN_MACHINE_NAME 0x0001021A 71309378Sjhb#define OID_GEN_RNDIS_CONFIG_PARAMETER 0x0001021B 72309378Sjhb#define OID_GEN_VLAN_ID 0x0001021C 73309378Sjhb 74309378Sjhb#define OID_802_3_PERMANENT_ADDRESS 0x01010101 75219820Sjeff#define OID_802_3_CURRENT_ADDRESS 0x01010102 76309378Sjhb#define OID_802_3_MULTICAST_LIST 0x01010103 77309378Sjhb#define OID_802_3_MAXIMUM_LIST_SIZE 0x01010104 78309378Sjhb#define OID_802_3_MAC_OPTIONS 0x01010105 79309378Sjhb#define OID_802_3_RCV_ERROR_ALIGNMENT 0x01020101 80309378Sjhb#define OID_802_3_XMIT_ONE_COLLISION 0x01020102 81309378Sjhb#define OID_802_3_XMIT_MORE_COLLISIONS 0x01020103 82309378Sjhb#define OID_802_3_XMIT_DEFERRED 0x01020201 83309378Sjhb#define OID_802_3_XMIT_MAX_COLLISIONS 0x01020202 84309378Sjhb#define OID_802_3_RCV_OVERRUN 0x01020203 85309378Sjhb#define OID_802_3_XMIT_UNDERRUN 0x01020204 86309378Sjhb#define OID_802_3_XMIT_HEARTBEAT_FAILURE 0x01020205 87309378Sjhb#define OID_802_3_XMIT_TIMES_CRS_LOST 0x01020206 88309378Sjhb#define OID_802_3_XMIT_LATE_COLLISIONS 0x01020207 89309378Sjhb 90309378Sjhb#define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C 91309378Sjhb#define OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020D 92309378Sjhb 93309378Sjhb#define RNDIS_MEDIUM_802_3 0x00000000 94309378Sjhb 95309378Sjhb/* Device flags */ 96309378Sjhb#define RNDIS_DF_CONNECTIONLESS 0x00000001 97309378Sjhb#define RNDIS_DF_CONNECTION_ORIENTED 0x00000002 98309378Sjhb 99309378Sjhb/* 100309378Sjhb * Common RNDIS message header. 101309378Sjhb */ 102309378Sjhbstruct rndis_msghdr { 103309378Sjhb uint32_t rm_type; 104309378Sjhb uint32_t rm_len; 105309378Sjhb}; 106309378Sjhb 107309378Sjhb/* 108309378Sjhb * RNDIS data message 109309378Sjhb */ 110309378Sjhb#define REMOTE_NDIS_PACKET_MSG 0x00000001 111309378Sjhb 112309378Sjhbstruct rndis_packet_msg { 113309378Sjhb uint32_t rm_type; 114309378Sjhb uint32_t rm_len; 115309378Sjhb uint32_t rm_dataoffset; 116309378Sjhb uint32_t rm_datalen; 117309378Sjhb uint32_t rm_oobdataoffset; 118309378Sjhb uint32_t rm_oobdatalen; 119309378Sjhb uint32_t rm_oobdataelements; 120309378Sjhb uint32_t rm_pktinfooffset; 121309378Sjhb uint32_t rm_pktinfolen; 122309378Sjhb uint32_t rm_vchandle; 123309378Sjhb uint32_t rm_reserved; 124309378Sjhb}; 125309378Sjhb 126309378Sjhb/* 127309378Sjhb * Minimum value for rm_dataoffset, rm_oobdataoffset, and 128309378Sjhb * rm_pktinfooffset. 129309378Sjhb */ 130309378Sjhb#define RNDIS_PACKET_MSG_OFFSET_MIN \ 131309378Sjhb (sizeof(struct rndis_packet_msg) - \ 132309378Sjhb __offsetof(struct rndis_packet_msg, rm_dataoffset)) 133309378Sjhb 134309378Sjhb/* Offset from the beginning of rndis_packet_msg. */ 135309378Sjhb#define RNDIS_PACKET_MSG_OFFSET_ABS(ofs) \ 136309378Sjhb ((ofs) + __offsetof(struct rndis_packet_msg, rm_dataoffset)) 137309378Sjhb 138309378Sjhb#define RNDIS_PACKET_MSG_OFFSET_ALIGN 4 139309378Sjhb#define RNDIS_PACKET_MSG_OFFSET_ALIGNMASK \ 140309378Sjhb (RNDIS_PACKET_MSG_OFFSET_ALIGN - 1) 141309378Sjhb 142309378Sjhb/* Per-packet-info for RNDIS data message */ 143309378Sjhbstruct rndis_pktinfo { 144309378Sjhb uint32_t rm_size; 145309378Sjhb uint32_t rm_type; /* NDIS_PKTINFO_TYPE_ */ 146309378Sjhb uint32_t rm_pktinfooffset; 147309378Sjhb uint8_t rm_data[]; 148309378Sjhb}; 149309378Sjhb 150219820Sjeff#define RNDIS_PKTINFO_OFFSET \ 151219820Sjeff __offsetof(struct rndis_pktinfo, rm_data[0]) 152219820Sjeff#define RNDIS_PKTINFO_SIZE_ALIGN 4 153219820Sjeff#define RNDIS_PKTINFO_SIZE_ALIGNMASK (RNDIS_PKTINFO_SIZE_ALIGN - 1) 154219820Sjeff 155219820Sjeff#define NDIS_PKTINFO_TYPE_CSUM 0 156219820Sjeff#define NDIS_PKTINFO_TYPE_IPSEC 1 157219820Sjeff#define NDIS_PKTINFO_TYPE_LSO 2 158219820Sjeff#define NDIS_PKTINFO_TYPE_CLASSIFY 3 159219820Sjeff/* reserved 4 */ 160219820Sjeff#define NDIS_PKTINFO_TYPE_SGLIST 5 161219820Sjeff#define NDIS_PKTINFO_TYPE_VLAN 6 162219820Sjeff#define NDIS_PKTINFO_TYPE_ORIG 7 163219820Sjeff#define NDIS_PKTINFO_TYPE_PKT_CANCELID 8 164219820Sjeff#define NDIS_PKTINFO_TYPE_ORIG_NBLIST 9 165219820Sjeff#define NDIS_PKTINFO_TYPE_CACHE_NBLIST 10 166219820Sjeff#define NDIS_PKTINFO_TYPE_PKT_PAD 11 167219820Sjeff 168219820Sjeff/* 169219820Sjeff * RNDIS control messages 170219820Sjeff */ 171219820Sjeff 172219820Sjeff/* 173219820Sjeff * Common header for RNDIS completion messages. 174219820Sjeff * 175219820Sjeff * NOTE: It does not apply to REMOTE_NDIS_RESET_CMPLT. 176219820Sjeff */ 177219820Sjeffstruct rndis_comp_hdr { 178219820Sjeff uint32_t rm_type; 179219820Sjeff uint32_t rm_len; 180219820Sjeff uint32_t rm_rid; 181219820Sjeff uint32_t rm_status; 182219820Sjeff}; 183219820Sjeff 184219820Sjeff/* Initialize the device. */ 185219820Sjeff#define REMOTE_NDIS_INITIALIZE_MSG 0x00000002 186219820Sjeff#define REMOTE_NDIS_INITIALIZE_CMPLT 0x80000002 187219820Sjeff 188219820Sjeffstruct rndis_init_req { 189219820Sjeff uint32_t rm_type; 190219820Sjeff uint32_t rm_len; 191219820Sjeff uint32_t rm_rid; 192219820Sjeff uint32_t rm_ver_major; 193219820Sjeff uint32_t rm_ver_minor; 194219820Sjeff uint32_t rm_max_xfersz; 195219820Sjeff}; 196219820Sjeff 197219820Sjeffstruct rndis_init_comp { 198219820Sjeff uint32_t rm_type; 199219820Sjeff uint32_t rm_len; 200219820Sjeff uint32_t rm_rid; 201219820Sjeff uint32_t rm_status; 202219820Sjeff uint32_t rm_ver_major; 203219820Sjeff uint32_t rm_ver_minor; 204219820Sjeff uint32_t rm_devflags; 205219820Sjeff uint32_t rm_medium; 206219820Sjeff uint32_t rm_pktmaxcnt; 207219820Sjeff uint32_t rm_pktmaxsz; 208219820Sjeff uint32_t rm_align; 209219820Sjeff uint32_t rm_aflistoffset; 210219820Sjeff uint32_t rm_aflistsz; 211219820Sjeff}; 212219820Sjeff 213219820Sjeff#define RNDIS_INIT_COMP_SIZE_MIN \ 214219820Sjeff __offsetof(struct rndis_init_comp, rm_aflistsz) 215219820Sjeff 216219820Sjeff/* Halt the device. No response sent. */ 217219820Sjeff#define REMOTE_NDIS_HALT_MSG 0x00000003 218219820Sjeff 219219820Sjeffstruct rndis_halt_req { 220219820Sjeff uint32_t rm_type; 221219820Sjeff uint32_t rm_len; 222219820Sjeff uint32_t rm_rid; 223219820Sjeff}; 224219820Sjeff 225219820Sjeff/* Send a query object. */ 226219820Sjeff#define REMOTE_NDIS_QUERY_MSG 0x00000004 227219820Sjeff#define REMOTE_NDIS_QUERY_CMPLT 0x80000004 228219820Sjeff 229219820Sjeffstruct rndis_query_req { 230219820Sjeff uint32_t rm_type; 231219820Sjeff uint32_t rm_len; 232219820Sjeff uint32_t rm_rid; 233219820Sjeff uint32_t rm_oid; 234219820Sjeff uint32_t rm_infobuflen; 235219820Sjeff uint32_t rm_infobufoffset; 236219820Sjeff uint32_t rm_devicevchdl; 237219820Sjeff}; 238219820Sjeff 239219820Sjeff#define RNDIS_QUERY_REQ_INFOBUFOFFSET \ 240219820Sjeff (sizeof(struct rndis_query_req) - \ 241219820Sjeff __offsetof(struct rndis_query_req, rm_rid)) 242219820Sjeff 243219820Sjeffstruct rndis_query_comp { 244219820Sjeff uint32_t rm_type; 245219820Sjeff uint32_t rm_len; 246219820Sjeff uint32_t rm_rid; 247219820Sjeff uint32_t rm_status; 248219820Sjeff uint32_t rm_infobuflen; 249219820Sjeff uint32_t rm_infobufoffset; 250219820Sjeff}; 251219820Sjeff 252219820Sjeff/* infobuf offset from the beginning of rndis_query_comp. */ 253219820Sjeff#define RNDIS_QUERY_COMP_INFOBUFOFFSET_ABS(ofs) \ 254219820Sjeff ((ofs) + __offsetof(struct rndis_query_req, rm_rid)) 255219820Sjeff 256219820Sjeff/* Send a set object request. */ 257219820Sjeff#define REMOTE_NDIS_SET_MSG 0x00000005 258219820Sjeff#define REMOTE_NDIS_SET_CMPLT 0x80000005 259219820Sjeff 260219820Sjeffstruct rndis_set_req { 261219820Sjeff uint32_t rm_type; 262219820Sjeff uint32_t rm_len; 263219820Sjeff uint32_t rm_rid; 264219820Sjeff uint32_t rm_oid; 265219820Sjeff uint32_t rm_infobuflen; 266309378Sjhb uint32_t rm_infobufoffset; 267309378Sjhb uint32_t rm_devicevchdl; 268219820Sjeff}; 269309378Sjhb 270309378Sjhb#define RNDIS_SET_REQ_INFOBUFOFFSET \ 271309378Sjhb (sizeof(struct rndis_set_req) - \ 272309378Sjhb __offsetof(struct rndis_set_req, rm_rid)) 273309378Sjhb 274309378Sjhbstruct rndis_set_comp { 275309378Sjhb uint32_t rm_type; 276219820Sjeff uint32_t rm_len; 277219820Sjeff uint32_t rm_rid; 278219820Sjeff uint32_t rm_status; 279219820Sjeff}; 280219820Sjeff 281219820Sjeff/* 282219820Sjeff * Parameter used by OID_GEN_RNDIS_CONFIG_PARAMETER. 283219820Sjeff */ 284237263Snp#define REMOTE_NDIS_SET_PARAM_NUMERIC 0x00000000 285219820Sjeff#define REMOTE_NDIS_SET_PARAM_STRING 0x00000002 286219820Sjeff 287219820Sjeffstruct rndis_set_parameter { 288219820Sjeff uint32_t rm_nameoffset; 289219820Sjeff uint32_t rm_namelen; 290219820Sjeff uint32_t rm_type; 291219820Sjeff uint32_t rm_valueoffset; 292219820Sjeff uint32_t rm_valuelen; 293219820Sjeff}; 294219820Sjeff 295219820Sjeff/* Perform a soft reset on the device. */ 296219820Sjeff#define REMOTE_NDIS_RESET_MSG 0x00000006 297219820Sjeff#define REMOTE_NDIS_RESET_CMPLT 0x80000006 298219820Sjeff 299219820Sjeffstruct rndis_reset_req { 300219820Sjeff uint32_t rm_type; 301237263Snp uint32_t rm_len; 302219820Sjeff uint32_t rm_rid; 303219820Sjeff}; 304219820Sjeff 305219820Sjeffstruct rndis_reset_comp { 306219820Sjeff uint32_t rm_type; 307219820Sjeff uint32_t rm_len; 308219820Sjeff uint32_t rm_status; 309219820Sjeff uint32_t rm_adrreset; 310219820Sjeff}; 311219820Sjeff 312219820Sjeff/* 802.3 link-state or undefined message error. Sent by device. */ 313219820Sjeff#define REMOTE_NDIS_INDICATE_STATUS_MSG 0x00000007 314219820Sjeff 315219820Sjeffstruct rndis_status_msg { 316219820Sjeff uint32_t rm_type; 317219820Sjeff uint32_t rm_len; 318219820Sjeff uint32_t rm_status; 319219820Sjeff uint32_t rm_stbuflen; 320219820Sjeff uint32_t rm_stbufoffset; 321219820Sjeff /* rndis_diag_info */ 322219820Sjeff}; 323219820Sjeff 324219820Sjeff/* stbuf offset from the beginning of rndis_status_msg. */ 325219820Sjeff#define RNDIS_STBUFOFFSET_ABS(ofs) \ 326219820Sjeff ((ofs) + __offsetof(struct rndis_status_msg, rm_status)) 327219820Sjeff 328219820Sjeff/* 329219820Sjeff * Immediately after rndis_status_msg.rm_stbufoffset, if a control 330219820Sjeff * message is malformatted, or a packet message contains inappropriate 331219820Sjeff * content. 332219820Sjeff */ 333219820Sjeffstruct rndis_diag_info { 334219820Sjeff uint32_t rm_diagstatus; 335219820Sjeff uint32_t rm_erroffset; 336219820Sjeff}; 337219820Sjeff 338219820Sjeff/* Keepalive messsage. May be sent by device. */ 339219820Sjeff#define REMOTE_NDIS_KEEPALIVE_MSG 0x00000008 340219820Sjeff#define REMOTE_NDIS_KEEPALIVE_CMPLT 0x80000008 341219820Sjeff 342219820Sjeffstruct rndis_keepalive_req { 343219820Sjeff uint32_t rm_type; 344219820Sjeff uint32_t rm_len; 345219820Sjeff uint32_t rm_rid; 346219820Sjeff}; 347219820Sjeff 348219820Sjeffstruct rndis_keepalive_comp { 349219820Sjeff uint32_t rm_type; 350219820Sjeff uint32_t rm_len; 351219820Sjeff uint32_t rm_rid; 352219820Sjeff uint32_t rm_status; 353219820Sjeff}; 354219820Sjeff 355219820Sjeff/* Packet filter bits used by OID_GEN_CURRENT_PACKET_FILTER */ 356219820Sjeff#define NDIS_PACKET_TYPE_NONE 0x00000000 357219820Sjeff#define NDIS_PACKET_TYPE_DIRECTED 0x00000001 358219820Sjeff#define NDIS_PACKET_TYPE_MULTICAST 0x00000002 359219820Sjeff#define NDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004 360219820Sjeff#define NDIS_PACKET_TYPE_BROADCAST 0x00000008 361219820Sjeff#define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010 362219820Sjeff#define NDIS_PACKET_TYPE_PROMISCUOUS 0x00000020 363219820Sjeff#define NDIS_PACKET_TYPE_SMT 0x00000040 364219820Sjeff#define NDIS_PACKET_TYPE_ALL_LOCAL 0x00000080 365219820Sjeff#define NDIS_PACKET_TYPE_GROUP 0x00001000 366219820Sjeff#define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00002000 367219820Sjeff#define NDIS_PACKET_TYPE_FUNCTIONAL 0x00004000 368219820Sjeff#define NDIS_PACKET_TYPE_MAC_FRAME 0x00008000 369219820Sjeff 370219820Sjeff/* 371219820Sjeff * Packet filter description for use with printf(9) %b identifier. 372219820Sjeff */ 373219820Sjeff#define NDIS_PACKET_TYPES \ 374219820Sjeff "\20\1DIRECT\2MULTICAST\3ALLMULTI\4BROADCAST" \ 375219820Sjeff "\5SRCROUTE\6PROMISC\7SMT\10ALLLOCAL" \ 376219820Sjeff "\11GROUP\12ALLFUNC\13FUNC\14MACFRAME" 377219820Sjeff 378219820Sjeff/* RNDIS offsets */ 379219820Sjeff#define RNDIS_HEADER_OFFSET ((uint32_t)sizeof(struct rndis_msghdr)) 380219820Sjeff#define RNDIS_DATA_OFFSET \ 381219820Sjeff ((uint32_t)(sizeof(struct rndis_packet_msg) - RNDIS_HEADER_OFFSET)) 382219820Sjeff 383219820Sjeff#endif /* !_NET_RNDIS_H_ */ 384219820Sjeff