1/* $OpenBSD: if_urndisreg.h,v 1.19 2013/11/21 14:08:05 mpi Exp $ */ 2 3/* 4 * Copyright (c) 2010 Jonathan Armani <armani@openbsd.org> 5 * Copyright (c) 2010 Fabien Romano <fabien@openbsd.org> 6 * Copyright (c) 2010 Michael Knudsen <mk@openbsd.org> 7 * All rights reserved. 8 * 9 * Permission to use, copy, modify, and distribute this software for any 10 * purpose with or without fee is hereby granted, provided that the above 11 * copyright notice and this permission notice appear in all copies. 12 * 13 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 14 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 15 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 16 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 17 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 18 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 19 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 20 */ 21 22#ifndef _IF_URNDISREG_H_ 23#define _IF_URNDISREG_H_ 24 25#include "implementation/global_implementation.h" 26#include "usb_ethernet.h" 27 28#define RNDIS_RESPONSE_LEN 1024 /* bytes */ 29#define RNDIS_RX_MAXLEN (16 * 1024) 30#define RNDIS_TX_FRAMES_MAX 8 31#define RNDIS_TX_MAXLEN MCLBYTES 32#define ETHER_ALIGN 2 /* driver adjust for IP hdr alignment */ 33 34/* 35 * Structure of a DEC/Intel/Xerox or 802.3 Ethernet header. 36 */ 37struct ether_header { 38 uint8_t ether_dhost[NETIF_MAX_HWADDR_LEN]; 39 uint8_t ether_shost[NETIF_MAX_HWADDR_LEN]; 40 uint16_t ether_type; 41}; 42 43enum { 44 URNDIS_BULK_RX, 45 URNDIS_BULK_TX, 46 URNDIS_INTR_RX, 47 URNDIS_N_TRANSFER, 48}; 49 50struct urndis_softc { 51 struct usb_ether sc_ue; 52 struct mtx sc_mtx; 53 54 /* RNDIS device info */ 55 uint32_t sc_lim_pktsz; 56 uint32_t sc_filter; 57 58 struct usb_device *sc_udev; 59 struct usb_xfer *sc_xfer[URNDIS_N_TRANSFER]; 60 61 uint8_t sc_ifaceno_ctl; 62 uint8_t sc_response_buf[RNDIS_RESPONSE_LEN] __aligned(4); 63}; 64 65#define URNDIS_LOCK(sc) mtx_lock(&(sc)->sc_mtx) 66#define URNDIS_UNLOCK(sc) mtx_unlock(&(sc)->sc_mtx) 67#define URNDIS_LOCK_ASSERT(sc, what) mtx_assert(&(sc)->sc_mtx, (what)) 68 69#define RNDIS_STATUS_BUFFER_OVERFLOW 0x80000005L 70#define RNDIS_STATUS_FAILURE 0xC0000001L 71#define RNDIS_STATUS_INVALID_DATA 0xC0010015L 72#define RNDIS_STATUS_MEDIA_CONNECT 0x4001000BL 73#define RNDIS_STATUS_MEDIA_DISCONNECT 0x4001000CL 74#define RNDIS_STATUS_NOT_SUPPORTED 0xC00000BBL 75#define RNDIS_STATUS_PENDING STATUS_PENDING /* XXX */ 76#define RNDIS_STATUS_RESOURCES 0xC000009AL 77#define RNDIS_STATUS_SUCCESS 0x00000000L 78 79#define OID_GEN_SUPPORTED_LIST 0x00010101 80#define OID_GEN_HARDWARE_STATUS 0x00010102 81#define OID_GEN_MEDIA_SUPPORTED 0x00010103 82#define OID_GEN_MEDIA_IN_USE 0x00010104 83#define OID_GEN_MAXIMUM_LOOKAHEAD 0x00010105 84#define OID_GEN_MAXIMUM_FRAME_SIZE 0x00010106 85#define OID_GEN_LINK_SPEED 0x00010107 86#define OID_GEN_TRANSMIT_BUFFER_SPACE 0x00010108 87#define OID_GEN_RECEIVE_BUFFER_SPACE 0x00010109 88#define OID_GEN_TRANSMIT_BLOCK_SIZE 0x0001010A 89#define OID_GEN_RECEIVE_BLOCK_SIZE 0x0001010B 90#define OID_GEN_VENDOR_ID 0x0001010C 91#define OID_GEN_VENDOR_DESCRIPTION 0x0001010D 92#define OID_GEN_CURRENT_PACKET_FILTER 0x0001010E 93#define OID_GEN_CURRENT_LOOKAHEAD 0x0001010F 94#define OID_GEN_DRIVER_VERSION 0x00010110 95#define OID_GEN_MAXIMUM_TOTAL_SIZE 0x00010111 96#define OID_GEN_PROTOCOL_OPTIONS 0x00010112 97#define OID_GEN_MAC_OPTIONS 0x00010113 98#define OID_GEN_MEDIA_CONNECT_STATUS 0x00010114 99#define OID_GEN_MAXIMUM_SEND_PACKETS 0x00010115 100#define OID_GEN_VENDOR_DRIVER_VERSION 0x00010116 101#define OID_GEN_SUPPORTED_GUIDS 0x00010117 102#define OID_GEN_NETWORK_LAYER_ADDRESSES 0x00010118 103#define OID_GEN_TRANSPORT_HEADER_OFFSET 0x00010119 104#define OID_GEN_MACHINE_NAME 0x0001021A 105#define OID_GEN_RNDIS_CONFIG_PARAMETER 0x0001021B 106#define OID_GEN_VLAN_ID 0x0001021C 107 108#define OID_802_3_PERMANENT_ADDRESS 0x01010101 109#define OID_802_3_CURRENT_ADDRESS 0x01010102 110#define OID_802_3_MULTICAST_LIST 0x01010103 111#define OID_802_3_MAXIMUM_LIST_SIZE 0x01010104 112#define OID_802_3_MAC_OPTIONS 0x01010105 113#define OID_802_3_RCV_ERROR_ALIGNMENT 0x01020101 114#define OID_802_3_XMIT_ONE_COLLISION 0x01020102 115#define OID_802_3_XMIT_MORE_COLLISIONS 0x01020103 116#define OID_802_3_XMIT_DEFERRED 0x01020201 117#define OID_802_3_XMIT_MAX_COLLISIONS 0x01020202 118#define OID_802_3_RCV_OVERRUN 0x01020203 119#define OID_802_3_XMIT_UNDERRUN 0x01020204 120#define OID_802_3_XMIT_HEARTBEAT_FAILURE 0x01020205 121#define OID_802_3_XMIT_TIMES_CRS_LOST 0x01020206 122#define OID_802_3_XMIT_LATE_COLLISIONS 0x01020207 123 124#define RNDIS_MEDIUM_802_3 0x00000000 125 126/* Device flags */ 127#define RNDIS_DF_CONNECTIONLESS 0x00000001 128#define RNDIS_DF_CONNECTION_ORIENTED 0x00000002 129 130/* 131 * RNDIS data message 132 */ 133#define REMOTE_NDIS_PACKET_MSG 0x00000001 134 135struct urndis_packet_msg { 136 uint32_t rm_type; 137 uint32_t rm_len; 138 uint32_t rm_dataoffset; 139 uint32_t rm_datalen; 140 uint32_t rm_oobdataoffset; 141 uint32_t rm_oobdatalen; 142 uint32_t rm_oobdataelements; 143 uint32_t rm_pktinfooffset; 144 uint32_t rm_pktinfolen; 145 uint32_t rm_vchandle; 146 uint32_t rm_reserved; 147}; 148 149/* 150 * RNDIS control messages 151 */ 152struct urndis_comp_hdr { 153 uint32_t rm_type; 154 uint32_t rm_len; 155 uint32_t rm_rid; 156 uint32_t rm_status; 157}; 158 159/* Initialize the device. */ 160#define REMOTE_NDIS_INITIALIZE_MSG 0x00000002 161#define REMOTE_NDIS_INITIALIZE_CMPLT 0x80000002 162 163struct urndis_init_req { 164 uint32_t rm_type; 165 uint32_t rm_len; 166 uint32_t rm_rid; 167 uint32_t rm_ver_major; 168 uint32_t rm_ver_minor; 169 uint32_t rm_max_xfersz; 170}; 171 172struct urndis_init_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_ver_major; 178 uint32_t rm_ver_minor; 179 uint32_t rm_devflags; 180 uint32_t rm_medium; 181 uint32_t rm_pktmaxcnt; 182 uint32_t rm_pktmaxsz; 183 uint32_t rm_align; 184 uint32_t rm_aflistoffset; 185 uint32_t rm_aflistsz; 186}; 187 188/* Halt the device. No response sent. */ 189#define REMOTE_NDIS_HALT_MSG 0x00000003 190 191struct urndis_halt_req { 192 uint32_t rm_type; 193 uint32_t rm_len; 194 uint32_t rm_rid; 195}; 196 197/* Send a query object. */ 198#define REMOTE_NDIS_QUERY_MSG 0x00000004 199#define REMOTE_NDIS_QUERY_CMPLT 0x80000004 200 201struct urndis_query_req { 202 uint32_t rm_type; 203 uint32_t rm_len; 204 uint32_t rm_rid; 205 uint32_t rm_oid; 206 uint32_t rm_infobuflen; 207 uint32_t rm_infobufoffset; 208 uint32_t rm_devicevchdl; 209}; 210 211struct urndis_query_comp { 212 uint32_t rm_type; 213 uint32_t rm_len; 214 uint32_t rm_rid; 215 uint32_t rm_status; 216 uint32_t rm_infobuflen; 217 uint32_t rm_infobufoffset; 218}; 219 220/* Send a set object request. */ 221#define REMOTE_NDIS_SET_MSG 0x00000005 222#define REMOTE_NDIS_SET_CMPLT 0x80000005 223 224struct urndis_set_req { 225 uint32_t rm_type; 226 uint32_t rm_len; 227 uint32_t rm_rid; 228 uint32_t rm_oid; 229 uint32_t rm_infobuflen; 230 uint32_t rm_infobufoffset; 231 uint32_t rm_devicevchdl; 232}; 233 234struct urndis_set_comp { 235 uint32_t rm_type; 236 uint32_t rm_len; 237 uint32_t rm_rid; 238 uint32_t rm_status; 239}; 240 241#define REMOTE_NDIS_SET_PARAM_NUMERIC 0x00000000 242#define REMOTE_NDIS_SET_PARAM_STRING 0x00000002 243 244struct urndis_set_parameter { 245 uint32_t rm_nameoffset; 246 uint32_t rm_namelen; 247 uint32_t rm_type; 248 uint32_t rm_valueoffset; 249 uint32_t rm_valuelen; 250}; 251 252/* Perform a soft reset on the device. */ 253#define REMOTE_NDIS_RESET_MSG 0x00000006 254#define REMOTE_NDIS_RESET_CMPLT 0x80000006 255 256struct urndis_reset_req { 257 uint32_t rm_type; 258 uint32_t rm_len; 259 uint32_t rm_rid; 260}; 261 262struct urndis_reset_comp { 263 uint32_t rm_type; 264 uint32_t rm_len; 265 uint32_t rm_status; 266 uint32_t rm_adrreset; 267}; 268 269/* 802.3 link-state or undefined message error. */ 270#define REMOTE_NDIS_INDICATE_STATUS_MSG 0x00000007 271 272/* Keepalive messsage. May be sent by device. */ 273#define REMOTE_NDIS_KEEPALIVE_MSG 0x00000008 274#define REMOTE_NDIS_KEEPALIVE_CMPLT 0x80000008 275 276struct urndis_keepalive_req { 277 uint32_t rm_type; 278 uint32_t rm_len; 279 uint32_t rm_rid; 280}; 281 282struct urndis_keepalive_comp { 283 uint32_t rm_type; 284 uint32_t rm_len; 285 uint32_t rm_rid; 286 uint32_t rm_status; 287}; 288 289/* packet filter bits used by OID_GEN_CURRENT_PACKET_FILTER */ 290#define RNDIS_PACKET_TYPE_DIRECTED 0x00000001 291#define RNDIS_PACKET_TYPE_MULTICAST 0x00000002 292#define RNDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004 293#define RNDIS_PACKET_TYPE_BROADCAST 0x00000008 294#define RNDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010 295#define RNDIS_PACKET_TYPE_PROMISCUOUS 0x00000020 296#define RNDIS_PACKET_TYPE_SMT 0x00000040 297#define RNDIS_PACKET_TYPE_ALL_LOCAL 0x00000080 298#define RNDIS_PACKET_TYPE_GROUP 0x00001000 299#define RNDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00002000 300#define RNDIS_PACKET_TYPE_FUNCTIONAL 0x00004000 301#define RNDIS_PACKET_TYPE_MAC_FRAME 0x00008000 302 303/* RNDIS offsets */ 304#define RNDIS_HEADER_OFFSET 8 /* bytes */ 305#define RNDIS_DATA_OFFSET ((uint32_t)(sizeof(struct urndis_packet_msg) - RNDIS_HEADER_OFFSET)) 306 307#endif /* _IF_URNDISREG_H_ */ 308