3 * Copyright (c) 2011, Microsoft Corporation.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16 * Place - Suite 330, Boston, MA 02111-1307 USA.
19 * Haiyang Zhang <haiyangz@microsoft.com>
20 * Hank Janssen <hjanssen@microsoft.com>
21 * K. Y. Srinivasan <kys@microsoft.com>
28 #include <linux/list.h>
29 #include <linux/hyperv.h>
32 struct hv_netvsc_packet;
34 /* Represent the xfer page packet which contains 1 or more netvsc packet */
35 struct xferpage_packet {
36 struct list_head list_ent;
38 /* # of netvsc packets this xfer packet contains */
43 * Represent netvsc packet which contains 1 RNDIS and 1 ethernet frame
46 struct hv_netvsc_packet {
47 /* Bookkeeping stuff */
48 struct list_head list_ent;
50 struct hv_device *device;
54 * Valid only for receives when we break a xfer page packet
55 * into multiple netvsc packets
57 struct xferpage_packet *xfer_page_pkt;
61 u64 recv_completion_tid;
62 void *recv_completion_ctx;
63 void (*recv_completion)(void *context);
66 u64 send_completion_tid;
67 void *send_completion_ctx;
68 void (*send_completion)(void *context);
72 /* This points to the memory after page_buf */
75 u32 total_data_buflen;
76 /* Points to the send/receive buffer where the ethernet frame is */
79 struct hv_page_buffer page_buf[0];
82 struct netvsc_device_info {
83 unsigned char mac_adr[6];
84 bool link_state; /* 0 - link up, 1 - link down */
88 enum rndis_device_state {
89 RNDIS_DEV_UNINITIALIZED = 0,
90 RNDIS_DEV_INITIALIZING,
91 RNDIS_DEV_INITIALIZED,
92 RNDIS_DEV_DATAINITIALIZED,
96 struct netvsc_device *net_dev;
98 enum rndis_device_state state;
102 spinlock_t request_lock;
103 struct list_head req_list;
105 unsigned char hw_mac_adr[ETH_ALEN];
110 int netvsc_device_add(struct hv_device *device, void *additional_info);
111 int netvsc_device_remove(struct hv_device *device);
112 int netvsc_send(struct hv_device *device,
113 struct hv_netvsc_packet *packet);
114 void netvsc_linkstatus_callback(struct hv_device *device_obj,
115 unsigned int status);
116 int netvsc_recv_callback(struct hv_device *device_obj,
117 struct hv_netvsc_packet *packet);
118 int rndis_filter_open(struct hv_device *dev);
119 int rndis_filter_close(struct hv_device *dev);
120 int rndis_filter_device_add(struct hv_device *dev,
121 void *additional_info);
122 void rndis_filter_device_remove(struct hv_device *dev);
123 int rndis_filter_receive(struct hv_device *dev,
124 struct hv_netvsc_packet *pkt);
128 int rndis_filter_send(struct hv_device *dev,
129 struct hv_netvsc_packet *pkt);
131 int rndis_filter_set_packet_filter(struct rndis_device *dev, u32 new_filter);
134 #define NVSP_INVALID_PROTOCOL_VERSION ((u32)0xFFFFFFFF)
136 #define NVSP_PROTOCOL_VERSION_1 2
137 #define NVSP_PROTOCOL_VERSION_2 0x30002
140 NVSP_MSG_TYPE_NONE = 0,
143 NVSP_MSG_TYPE_INIT = 1,
144 NVSP_MSG_TYPE_INIT_COMPLETE = 2,
146 NVSP_VERSION_MSG_START = 100,
148 /* Version 1 Messages */
149 NVSP_MSG1_TYPE_SEND_NDIS_VER = NVSP_VERSION_MSG_START,
151 NVSP_MSG1_TYPE_SEND_RECV_BUF,
152 NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE,
153 NVSP_MSG1_TYPE_REVOKE_RECV_BUF,
155 NVSP_MSG1_TYPE_SEND_SEND_BUF,
156 NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE,
157 NVSP_MSG1_TYPE_REVOKE_SEND_BUF,
159 NVSP_MSG1_TYPE_SEND_RNDIS_PKT,
160 NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE,
162 /* Version 2 messages */
163 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF,
164 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP,
165 NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF,
167 NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION,
169 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY,
170 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP,
172 NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT,
174 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT,
175 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP,
177 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ,
178 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP,
180 NVSP_MSG2_TYPE_ALLOC_RXBUF,
181 NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP,
183 NVSP_MSG2_TYPE_FREE_RXBUF,
185 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT,
186 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP,
188 NVSP_MSG2_TYPE_SEND_NDIS_CONFIG,
190 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE,
191 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
198 NVSP_STAT_PROTOCOL_TOO_NEW,
199 NVSP_STAT_PROTOCOL_TOO_OLD,
200 NVSP_STAT_INVALID_RNDIS_PKT,
202 NVSP_STAT_PROTOCOL_UNSUPPORTED,
206 struct nvsp_message_header {
213 * This message is used by the VSC to initialize the channel after the channels
214 * has been opened. This message should never include anything other then
215 * versioning (i.e. this message will be the same for ever).
217 struct nvsp_message_init {
218 u32 min_protocol_ver;
219 u32 max_protocol_ver;
223 * This message is used by the VSP to complete the initialization of the
224 * channel. This message should never include anything other then versioning
225 * (i.e. this message will be the same for ever).
227 struct nvsp_message_init_complete {
228 u32 negotiated_protocol_ver;
229 u32 max_mdl_chain_len;
233 union nvsp_message_init_uber {
234 struct nvsp_message_init init;
235 struct nvsp_message_init_complete init_complete;
238 /* Version 1 Messages */
241 * This message is used by the VSC to send the NDIS version to the VSP. The VSP
242 * can use this information when handling OIDs sent by the VSC.
244 struct nvsp_1_message_send_ndis_version {
250 * This message is used by the VSC to send a receive buffer to the VSP. The VSP
251 * can then use the receive buffer to send data to the VSC.
253 struct nvsp_1_message_send_receive_buffer {
258 struct nvsp_1_receive_buffer_section {
266 * This message is used by the VSP to acknowledge a receive buffer send by the
267 * VSC. This message must be sent by the VSP before the VSP uses the receive
270 struct nvsp_1_message_send_receive_buffer_complete {
275 * The receive buffer is split into two parts, a large suballocation
276 * section and a small suballocation section. These sections are then
277 * suballocated by a certain size.
281 * For example, the following break up of the receive buffer has 6
282 * large suballocations and 10 small suballocations.
286 * | Large Section | | Small Section |
287 * ------------------------------------------------------------
288 * | | | | | | | | | | | | | | | | | |
290 * LargeOffset SmallOffset
293 struct nvsp_1_receive_buffer_section sections[1];
297 * This message is sent by the VSC to revoke the receive buffer. After the VSP
298 * completes this transaction, the vsp should never use the receive buffer
301 struct nvsp_1_message_revoke_receive_buffer {
306 * This message is used by the VSC to send a send buffer to the VSP. The VSC
307 * can then use the send buffer to send data to the VSP.
309 struct nvsp_1_message_send_send_buffer {
315 * This message is used by the VSP to acknowledge a send buffer sent by the
316 * VSC. This message must be sent by the VSP before the VSP uses the sent
319 struct nvsp_1_message_send_send_buffer_complete {
323 * The VSC gets to choose the size of the send buffer and the VSP gets
324 * to choose the sections size of the buffer. This was done to enable
325 * dynamic reconfigurations when the cost of GPA-direct buffers
332 * This message is sent by the VSC to revoke the send buffer. After the VSP
333 * completes this transaction, the vsp should never use the send buffer again.
335 struct nvsp_1_message_revoke_send_buffer {
340 * This message is used by both the VSP and the VSC to send a RNDIS message to
341 * the opposite channel endpoint.
343 struct nvsp_1_message_send_rndis_packet {
345 * This field is specified by RNIDS. They assume there's two different
346 * channels of communication. However, the Network VSP only has one.
347 * Therefore, the channel travels with the RNDIS packet.
352 * This field is used to send part or all of the data through a send
353 * buffer. This values specifies an index into the send buffer. If the
354 * index is 0xFFFFFFFF, then the send buffer is not being used and all
355 * of the data was sent through other VMBus mechanisms.
357 u32 send_buf_section_index;
358 u32 send_buf_section_size;
362 * This message is used by both the VSP and the VSC to complete a RNDIS message
363 * to the opposite channel endpoint. At this point, the initiator of this
364 * message cannot use any resources associated with the original RNDIS packet.
366 struct nvsp_1_message_send_rndis_packet_complete {
370 union nvsp_1_message_uber {
371 struct nvsp_1_message_send_ndis_version send_ndis_ver;
373 struct nvsp_1_message_send_receive_buffer send_recv_buf;
374 struct nvsp_1_message_send_receive_buffer_complete
375 send_recv_buf_complete;
376 struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf;
378 struct nvsp_1_message_send_send_buffer send_send_buf;
379 struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete;
380 struct nvsp_1_message_revoke_send_buffer revoke_send_buf;
382 struct nvsp_1_message_send_rndis_packet send_rndis_pkt;
383 struct nvsp_1_message_send_rndis_packet_complete
384 send_rndis_pkt_complete;
389 * Network VSP protocol version 2 messages:
391 struct nvsp_2_vsc_capability {
399 u64 correlation_id:1;
404 struct nvsp_2_send_ndis_config {
407 struct nvsp_2_vsc_capability capability;
410 /* Allocate receive buffer */
411 struct nvsp_2_alloc_rxbuf {
412 /* Allocation ID to match the allocation request and response */
415 /* Length of the VM shared memory receive buffer that needs to
421 /* Allocate receive buffer complete */
422 struct nvsp_2_alloc_rxbuf_comp {
423 /* The NDIS_STATUS code for buffer allocation */
428 /* GPADL handle for the allocated receive buffer */
431 /* Receive buffer ID */
435 struct nvsp_2_free_rxbuf {
439 union nvsp_2_message_uber {
440 struct nvsp_2_send_ndis_config send_ndis_config;
441 struct nvsp_2_alloc_rxbuf alloc_rxbuf;
442 struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp;
443 struct nvsp_2_free_rxbuf free_rxbuf;
446 union nvsp_all_messages {
447 union nvsp_message_init_uber init_msg;
448 union nvsp_1_message_uber v1_msg;
449 union nvsp_2_message_uber v2_msg;
453 struct nvsp_message {
454 struct nvsp_message_header hdr;
455 union nvsp_all_messages msg;
461 /* #define NVSC_MIN_PROTOCOL_VERSION 1 */
462 /* #define NVSC_MAX_PROTOCOL_VERSION 1 */
464 #define NETVSC_RECEIVE_BUFFER_SIZE (1024*1024) /* 1MB */
466 #define NETVSC_RECEIVE_BUFFER_ID 0xcafe
468 #define NETVSC_RECEIVE_SG_COUNT 1
470 /* Preallocated receive packets */
471 #define NETVSC_RECEIVE_PACKETLIST_COUNT 256
473 #define NETVSC_PACKET_SIZE 2048
475 /* Per netvsc channel-specific */
476 struct netvsc_device {
477 struct hv_device *dev;
481 atomic_t num_outstanding_sends;
484 * List of free preallocated hv_netvsc_packet to represent receive
487 struct list_head recv_pkt_list;
488 spinlock_t recv_pkt_list_lock;
490 /* Receive buffer allocated by us but manages by NetVSP */
493 u32 recv_buf_gpadl_handle;
494 u32 recv_section_cnt;
495 struct nvsp_1_receive_buffer_section *recv_section;
497 /* Used for NetVSP initialization protocol */
498 struct completion channel_init_wait;
499 struct nvsp_message channel_init_pkt;
501 struct nvsp_message revoke_packet;
502 /* unsigned char HwMacAddr[HW_MACADDR_LEN]; */
504 struct net_device *ndev;
506 /* Holds rndis device info */
514 #ifndef STATUS_SUCCESS
515 #define STATUS_SUCCESS (0x00000000L)
518 #ifndef STATUS_UNSUCCESSFUL
519 #define STATUS_UNSUCCESSFUL (0xC0000001L)
522 #ifndef STATUS_PENDING
523 #define STATUS_PENDING (0x00000103L)
526 #ifndef STATUS_INSUFFICIENT_RESOURCES
527 #define STATUS_INSUFFICIENT_RESOURCES (0xC000009AL)
530 #ifndef STATUS_BUFFER_OVERFLOW
531 #define STATUS_BUFFER_OVERFLOW (0x80000005L)
534 #ifndef STATUS_NOT_SUPPORTED
535 #define STATUS_NOT_SUPPORTED (0xC00000BBL)
538 #define RNDIS_STATUS_SUCCESS (STATUS_SUCCESS)
539 #define RNDIS_STATUS_PENDING (STATUS_PENDING)
540 #define RNDIS_STATUS_NOT_RECOGNIZED (0x00010001L)
541 #define RNDIS_STATUS_NOT_COPIED (0x00010002L)
542 #define RNDIS_STATUS_NOT_ACCEPTED (0x00010003L)
543 #define RNDIS_STATUS_CALL_ACTIVE (0x00010007L)
545 #define RNDIS_STATUS_ONLINE (0x40010003L)
546 #define RNDIS_STATUS_RESET_START (0x40010004L)
547 #define RNDIS_STATUS_RESET_END (0x40010005L)
548 #define RNDIS_STATUS_RING_STATUS (0x40010006L)
549 #define RNDIS_STATUS_CLOSED (0x40010007L)
550 #define RNDIS_STATUS_WAN_LINE_UP (0x40010008L)
551 #define RNDIS_STATUS_WAN_LINE_DOWN (0x40010009L)
552 #define RNDIS_STATUS_WAN_FRAGMENT (0x4001000AL)
553 #define RNDIS_STATUS_MEDIA_CONNECT (0x4001000BL)
554 #define RNDIS_STATUS_MEDIA_DISCONNECT (0x4001000CL)
555 #define RNDIS_STATUS_HARDWARE_LINE_UP (0x4001000DL)
556 #define RNDIS_STATUS_HARDWARE_LINE_DOWN (0x4001000EL)
557 #define RNDIS_STATUS_INTERFACE_UP (0x4001000FL)
558 #define RNDIS_STATUS_INTERFACE_DOWN (0x40010010L)
559 #define RNDIS_STATUS_MEDIA_BUSY (0x40010011L)
560 #define RNDIS_STATUS_MEDIA_SPECIFIC_INDICATION (0x40010012L)
561 #define RNDIS_STATUS_WW_INDICATION RDIA_SPECIFIC_INDICATION
562 #define RNDIS_STATUS_LINK_SPEED_CHANGE (0x40010013L)
564 #define RNDIS_STATUS_NOT_RESETTABLE (0x80010001L)
565 #define RNDIS_STATUS_SOFT_ERRORS (0x80010003L)
566 #define RNDIS_STATUS_HARD_ERRORS (0x80010004L)
567 #define RNDIS_STATUS_BUFFER_OVERFLOW (STATUS_BUFFER_OVERFLOW)
569 #define RNDIS_STATUS_FAILURE (STATUS_UNSUCCESSFUL)
570 #define RNDIS_STATUS_RESOURCES (STATUS_INSUFFICIENT_RESOURCES)
571 #define RNDIS_STATUS_CLOSING (0xC0010002L)
572 #define RNDIS_STATUS_BAD_VERSION (0xC0010004L)
573 #define RNDIS_STATUS_BAD_CHARACTERISTICS (0xC0010005L)
574 #define RNDIS_STATUS_ADAPTER_NOT_FOUND (0xC0010006L)
575 #define RNDIS_STATUS_OPEN_FAILED (0xC0010007L)
576 #define RNDIS_STATUS_DEVICE_FAILED (0xC0010008L)
577 #define RNDIS_STATUS_MULTICAST_FULL (0xC0010009L)
578 #define RNDIS_STATUS_MULTICAST_EXISTS (0xC001000AL)
579 #define RNDIS_STATUS_MULTICAST_NOT_FOUND (0xC001000BL)
580 #define RNDIS_STATUS_REQUEST_ABORTED (0xC001000CL)
581 #define RNDIS_STATUS_RESET_IN_PROGRESS (0xC001000DL)
582 #define RNDIS_STATUS_CLOSING_INDICATING (0xC001000EL)
583 #define RNDIS_STATUS_NOT_SUPPORTED (STATUS_NOT_SUPPORTED)
584 #define RNDIS_STATUS_INVALID_PACKET (0xC001000FL)
585 #define RNDIS_STATUS_OPEN_LIST_FULL (0xC0010010L)
586 #define RNDIS_STATUS_ADAPTER_NOT_READY (0xC0010011L)
587 #define RNDIS_STATUS_ADAPTER_NOT_OPEN (0xC0010012L)
588 #define RNDIS_STATUS_NOT_INDICATING (0xC0010013L)
589 #define RNDIS_STATUS_INVALID_LENGTH (0xC0010014L)
590 #define RNDIS_STATUS_INVALID_DATA (0xC0010015L)
591 #define RNDIS_STATUS_BUFFER_TOO_SHORT (0xC0010016L)
592 #define RNDIS_STATUS_INVALID_OID (0xC0010017L)
593 #define RNDIS_STATUS_ADAPTER_REMOVED (0xC0010018L)
594 #define RNDIS_STATUS_UNSUPPORTED_MEDIA (0xC0010019L)
595 #define RNDIS_STATUS_GROUP_ADDRESS_IN_USE (0xC001001AL)
596 #define RNDIS_STATUS_FILE_NOT_FOUND (0xC001001BL)
597 #define RNDIS_STATUS_ERROR_READING_FILE (0xC001001CL)
598 #define RNDIS_STATUS_ALREADY_MAPPED (0xC001001DL)
599 #define RNDIS_STATUS_RESOURCE_CONFLICT (0xC001001EL)
600 #define RNDIS_STATUS_NO_CABLE (0xC001001FL)
602 #define RNDIS_STATUS_INVALID_SAP (0xC0010020L)
603 #define RNDIS_STATUS_SAP_IN_USE (0xC0010021L)
604 #define RNDIS_STATUS_INVALID_ADDRESS (0xC0010022L)
605 #define RNDIS_STATUS_VC_NOT_ACTIVATED (0xC0010023L)
606 #define RNDIS_STATUS_DEST_OUT_OF_ORDER (0xC0010024L)
607 #define RNDIS_STATUS_VC_NOT_AVAILABLE (0xC0010025L)
608 #define RNDIS_STATUS_CELLRATE_NOT_AVAILABLE (0xC0010026L)
609 #define RNDIS_STATUS_INCOMPATABLE_QOS (0xC0010027L)
610 #define RNDIS_STATUS_AAL_PARAMS_UNSUPPORTED (0xC0010028L)
611 #define RNDIS_STATUS_NO_ROUTE_TO_DESTINATION (0xC0010029L)
613 #define RNDIS_STATUS_TOKEN_RING_OPEN_ERROR (0xC0011000L)
615 /* Object Identifiers used by NdisRequest Query/Set Information */
616 /* General Objects */
617 #define RNDIS_OID_GEN_SUPPORTED_LIST 0x00010101
618 #define RNDIS_OID_GEN_HARDWARE_STATUS 0x00010102
619 #define RNDIS_OID_GEN_MEDIA_SUPPORTED 0x00010103
620 #define RNDIS_OID_GEN_MEDIA_IN_USE 0x00010104
621 #define RNDIS_OID_GEN_MAXIMUM_LOOKAHEAD 0x00010105
622 #define RNDIS_OID_GEN_MAXIMUM_FRAME_SIZE 0x00010106
623 #define RNDIS_OID_GEN_LINK_SPEED 0x00010107
624 #define RNDIS_OID_GEN_TRANSMIT_BUFFER_SPACE 0x00010108
625 #define RNDIS_OID_GEN_RECEIVE_BUFFER_SPACE 0x00010109
626 #define RNDIS_OID_GEN_TRANSMIT_BLOCK_SIZE 0x0001010A
627 #define RNDIS_OID_GEN_RECEIVE_BLOCK_SIZE 0x0001010B
628 #define RNDIS_OID_GEN_VENDOR_ID 0x0001010C
629 #define RNDIS_OID_GEN_VENDOR_DESCRIPTION 0x0001010D
630 #define RNDIS_OID_GEN_CURRENT_PACKET_FILTER 0x0001010E
631 #define RNDIS_OID_GEN_CURRENT_LOOKAHEAD 0x0001010F
632 #define RNDIS_OID_GEN_DRIVER_VERSION 0x00010110
633 #define RNDIS_OID_GEN_MAXIMUM_TOTAL_SIZE 0x00010111
634 #define RNDIS_OID_GEN_PROTOCOL_OPTIONS 0x00010112
635 #define RNDIS_OID_GEN_MAC_OPTIONS 0x00010113
636 #define RNDIS_OID_GEN_MEDIA_CONNECT_STATUS 0x00010114
637 #define RNDIS_OID_GEN_MAXIMUM_SEND_PACKETS 0x00010115
638 #define RNDIS_OID_GEN_VENDOR_DRIVER_VERSION 0x00010116
639 #define RNDIS_OID_GEN_NETWORK_LAYER_ADDRESSES 0x00010118
640 #define RNDIS_OID_GEN_TRANSPORT_HEADER_OFFSET 0x00010119
641 #define RNDIS_OID_GEN_MACHINE_NAME 0x0001021A
642 #define RNDIS_OID_GEN_RNDIS_CONFIG_PARAMETER 0x0001021B
644 #define RNDIS_OID_GEN_XMIT_OK 0x00020101
645 #define RNDIS_OID_GEN_RCV_OK 0x00020102
646 #define RNDIS_OID_GEN_XMIT_ERROR 0x00020103
647 #define RNDIS_OID_GEN_RCV_ERROR 0x00020104
648 #define RNDIS_OID_GEN_RCV_NO_BUFFER 0x00020105
650 #define RNDIS_OID_GEN_DIRECTED_BYTES_XMIT 0x00020201
651 #define RNDIS_OID_GEN_DIRECTED_FRAMES_XMIT 0x00020202
652 #define RNDIS_OID_GEN_MULTICAST_BYTES_XMIT 0x00020203
653 #define RNDIS_OID_GEN_MULTICAST_FRAMES_XMIT 0x00020204
654 #define RNDIS_OID_GEN_BROADCAST_BYTES_XMIT 0x00020205
655 #define RNDIS_OID_GEN_BROADCAST_FRAMES_XMIT 0x00020206
656 #define RNDIS_OID_GEN_DIRECTED_BYTES_RCV 0x00020207
657 #define RNDIS_OID_GEN_DIRECTED_FRAMES_RCV 0x00020208
658 #define RNDIS_OID_GEN_MULTICAST_BYTES_RCV 0x00020209
659 #define RNDIS_OID_GEN_MULTICAST_FRAMES_RCV 0x0002020A
660 #define RNDIS_OID_GEN_BROADCAST_BYTES_RCV 0x0002020B
661 #define RNDIS_OID_GEN_BROADCAST_FRAMES_RCV 0x0002020C
663 #define RNDIS_OID_GEN_RCV_CRC_ERROR 0x0002020D
664 #define RNDIS_OID_GEN_TRANSMIT_QUEUE_LENGTH 0x0002020E
666 #define RNDIS_OID_GEN_GET_TIME_CAPS 0x0002020F
667 #define RNDIS_OID_GEN_GET_NETCARD_TIME 0x00020210
669 /* These are connection-oriented general OIDs. */
670 /* These replace the above OIDs for connection-oriented media. */
671 #define RNDIS_OID_GEN_CO_SUPPORTED_LIST 0x00010101
672 #define RNDIS_OID_GEN_CO_HARDWARE_STATUS 0x00010102
673 #define RNDIS_OID_GEN_CO_MEDIA_SUPPORTED 0x00010103
674 #define RNDIS_OID_GEN_CO_MEDIA_IN_USE 0x00010104
675 #define RNDIS_OID_GEN_CO_LINK_SPEED 0x00010105
676 #define RNDIS_OID_GEN_CO_VENDOR_ID 0x00010106
677 #define RNDIS_OID_GEN_CO_VENDOR_DESCRIPTION 0x00010107
678 #define RNDIS_OID_GEN_CO_DRIVER_VERSION 0x00010108
679 #define RNDIS_OID_GEN_CO_PROTOCOL_OPTIONS 0x00010109
680 #define RNDIS_OID_GEN_CO_MAC_OPTIONS 0x0001010A
681 #define RNDIS_OID_GEN_CO_MEDIA_CONNECT_STATUS 0x0001010B
682 #define RNDIS_OID_GEN_CO_VENDOR_DRIVER_VERSION 0x0001010C
683 #define RNDIS_OID_GEN_CO_MINIMUM_LINK_SPEED 0x0001010D
685 #define RNDIS_OID_GEN_CO_GET_TIME_CAPS 0x00010201
686 #define RNDIS_OID_GEN_CO_GET_NETCARD_TIME 0x00010202
688 /* These are connection-oriented statistics OIDs. */
689 #define RNDIS_OID_GEN_CO_XMIT_PDUS_OK 0x00020101
690 #define RNDIS_OID_GEN_CO_RCV_PDUS_OK 0x00020102
691 #define RNDIS_OID_GEN_CO_XMIT_PDUS_ERROR 0x00020103
692 #define RNDIS_OID_GEN_CO_RCV_PDUS_ERROR 0x00020104
693 #define RNDIS_OID_GEN_CO_RCV_PDUS_NO_BUFFER 0x00020105
696 #define RNDIS_OID_GEN_CO_RCV_CRC_ERROR 0x00020201
697 #define RNDIS_OID_GEN_CO_TRANSMIT_QUEUE_LENGTH 0x00020202
698 #define RNDIS_OID_GEN_CO_BYTES_XMIT 0x00020203
699 #define RNDIS_OID_GEN_CO_BYTES_RCV 0x00020204
700 #define RNDIS_OID_GEN_CO_BYTES_XMIT_OUTSTANDING 0x00020205
701 #define RNDIS_OID_GEN_CO_NETCARD_LOAD 0x00020206
703 /* These are objects for Connection-oriented media call-managers. */
704 #define RNDIS_OID_CO_ADD_PVC 0xFF000001
705 #define RNDIS_OID_CO_DELETE_PVC 0xFF000002
706 #define RNDIS_OID_CO_GET_CALL_INFORMATION 0xFF000003
707 #define RNDIS_OID_CO_ADD_ADDRESS 0xFF000004
708 #define RNDIS_OID_CO_DELETE_ADDRESS 0xFF000005
709 #define RNDIS_OID_CO_GET_ADDRESSES 0xFF000006
710 #define RNDIS_OID_CO_ADDRESS_CHANGE 0xFF000007
711 #define RNDIS_OID_CO_SIGNALING_ENABLED 0xFF000008
712 #define RNDIS_OID_CO_SIGNALING_DISABLED 0xFF000009
714 /* 802.3 Objects (Ethernet) */
715 #define RNDIS_OID_802_3_PERMANENT_ADDRESS 0x01010101
716 #define RNDIS_OID_802_3_CURRENT_ADDRESS 0x01010102
717 #define RNDIS_OID_802_3_MULTICAST_LIST 0x01010103
718 #define RNDIS_OID_802_3_MAXIMUM_LIST_SIZE 0x01010104
719 #define RNDIS_OID_802_3_MAC_OPTIONS 0x01010105
721 #define NDIS_802_3_MAC_OPTION_PRIORITY 0x00000001
723 #define RNDIS_OID_802_3_RCV_ERROR_ALIGNMENT 0x01020101
724 #define RNDIS_OID_802_3_XMIT_ONE_COLLISION 0x01020102
725 #define RNDIS_OID_802_3_XMIT_MORE_COLLISIONS 0x01020103
727 #define RNDIS_OID_802_3_XMIT_DEFERRED 0x01020201
728 #define RNDIS_OID_802_3_XMIT_MAX_COLLISIONS 0x01020202
729 #define RNDIS_OID_802_3_RCV_OVERRUN 0x01020203
730 #define RNDIS_OID_802_3_XMIT_UNDERRUN 0x01020204
731 #define RNDIS_OID_802_3_XMIT_HEARTBEAT_FAILURE 0x01020205
732 #define RNDIS_OID_802_3_XMIT_TIMES_CRS_LOST 0x01020206
733 #define RNDIS_OID_802_3_XMIT_LATE_COLLISIONS 0x01020207
735 /* Remote NDIS message types */
736 #define REMOTE_NDIS_PACKET_MSG 0x00000001
737 #define REMOTE_NDIS_INITIALIZE_MSG 0x00000002
738 #define REMOTE_NDIS_HALT_MSG 0x00000003
739 #define REMOTE_NDIS_QUERY_MSG 0x00000004
740 #define REMOTE_NDIS_SET_MSG 0x00000005
741 #define REMOTE_NDIS_RESET_MSG 0x00000006
742 #define REMOTE_NDIS_INDICATE_STATUS_MSG 0x00000007
743 #define REMOTE_NDIS_KEEPALIVE_MSG 0x00000008
745 #define REMOTE_CONDIS_MP_CREATE_VC_MSG 0x00008001
746 #define REMOTE_CONDIS_MP_DELETE_VC_MSG 0x00008002
747 #define REMOTE_CONDIS_MP_ACTIVATE_VC_MSG 0x00008005
748 #define REMOTE_CONDIS_MP_DEACTIVATE_VC_MSG 0x00008006
749 #define REMOTE_CONDIS_INDICATE_STATUS_MSG 0x00008007
751 /* Remote NDIS message completion types */
752 #define REMOTE_NDIS_INITIALIZE_CMPLT 0x80000002
753 #define REMOTE_NDIS_QUERY_CMPLT 0x80000004
754 #define REMOTE_NDIS_SET_CMPLT 0x80000005
755 #define REMOTE_NDIS_RESET_CMPLT 0x80000006
756 #define REMOTE_NDIS_KEEPALIVE_CMPLT 0x80000008
758 #define REMOTE_CONDIS_MP_CREATE_VC_CMPLT 0x80008001
759 #define REMOTE_CONDIS_MP_DELETE_VC_CMPLT 0x80008002
760 #define REMOTE_CONDIS_MP_ACTIVATE_VC_CMPLT 0x80008005
761 #define REMOTE_CONDIS_MP_DEACTIVATE_VC_CMPLT 0x80008006
764 * Reserved message type for private communication between lower-layer host
765 * driver and remote device, if necessary.
767 #define REMOTE_NDIS_BUS_MSG 0xff000001
769 /* Defines for DeviceFlags in struct rndis_initialize_complete */
770 #define RNDIS_DF_CONNECTIONLESS 0x00000001
771 #define RNDIS_DF_CONNECTION_ORIENTED 0x00000002
772 #define RNDIS_DF_RAW_DATA 0x00000004
774 /* Remote NDIS medium types. */
775 #define RNDIS_MEDIUM_802_3 0x00000000
776 #define RNDIS_MEDIUM_802_5 0x00000001
777 #define RNDIS_MEDIUM_FDDI 0x00000002
778 #define RNDIS_MEDIUM_WAN 0x00000003
779 #define RNDIS_MEDIUM_LOCAL_TALK 0x00000004
780 #define RNDIS_MEDIUM_ARCNET_RAW 0x00000006
781 #define RNDIS_MEDIUM_ARCNET_878_2 0x00000007
782 #define RNDIS_MEDIUM_ATM 0x00000008
783 #define RNDIS_MEDIUM_WIRELESS_WAN 0x00000009
784 #define RNDIS_MEDIUM_IRDA 0x0000000a
785 #define RNDIS_MEDIUM_CO_WAN 0x0000000b
786 /* Not a real medium, defined as an upper-bound */
787 #define RNDIS_MEDIUM_MAX 0x0000000d
790 /* Remote NDIS medium connection states. */
791 #define RNDIS_MEDIA_STATE_CONNECTED 0x00000000
792 #define RNDIS_MEDIA_STATE_DISCONNECTED 0x00000001
794 /* Remote NDIS version numbers */
795 #define RNDIS_MAJOR_VERSION 0x00000001
796 #define RNDIS_MINOR_VERSION 0x00000000
799 /* NdisInitialize message */
800 struct rndis_initialize_request {
807 /* Response to NdisInitialize */
808 struct rndis_initialize_complete {
817 u32 pkt_alignment_factor;
822 /* Call manager devices only: Information about an address family */
823 /* supported by the device is appended to the response to NdisInitialize. */
824 struct rndis_co_address_family {
830 /* NdisHalt message */
831 struct rndis_halt_request {
835 /* NdisQueryRequest message */
836 struct rndis_query_request {
844 /* Response to NdisQueryRequest */
845 struct rndis_query_complete {
852 /* NdisSetRequest message */
853 struct rndis_set_request {
861 /* Response to NdisSetRequest */
862 struct rndis_set_complete {
867 /* NdisReset message */
868 struct rndis_reset_request {
872 /* Response to NdisReset */
873 struct rndis_reset_complete {
875 u32 addressing_reset;
878 /* NdisMIndicateStatus message */
879 struct rndis_indicate_status {
882 u32 status_buf_offset;
885 /* Diagnostic information passed as the status buffer in */
886 /* struct rndis_indicate_status messages signifying error conditions. */
887 struct rndis_diagnostic_info {
892 /* NdisKeepAlive message */
893 struct rndis_keepalive_request {
897 /* Response to NdisKeepAlive */
898 struct rndis_keepalive_complete {
904 * Data message. All Offset fields contain byte offsets from the beginning of
905 * struct rndis_packet. All Length fields are in bytes. VcHandle is set
906 * to 0 for connectionless data, otherwise it contains the VC handle.
908 struct rndis_packet {
913 u32 num_oob_data_elements;
914 u32 per_pkt_info_offset;
915 u32 per_pkt_info_len;
920 /* Optional Out of Band data associated with a Data message. */
924 u32 class_info_offset;
927 /* Packet extension field contents associated with a Data message. */
928 struct rndis_per_packet_info {
931 u32 per_pkt_info_offset;
934 /* Format of Information buffer passed in a SetRequest for the OID */
935 /* OID_GEN_RNDIS_CONFIG_PARAMETER. */
936 struct rndis_config_parameter_info {
937 u32 parameter_name_offset;
938 u32 parameter_name_length;
940 u32 parameter_value_offset;
941 u32 parameter_value_length;
944 /* Values for ParameterType in struct rndis_config_parameter_info */
945 #define RNDIS_CONFIG_PARAM_TYPE_INTEGER 0
946 #define RNDIS_CONFIG_PARAM_TYPE_STRING 2
948 /* CONDIS Miniport messages for connection oriented devices */
949 /* that do not implement a call manager. */
951 /* CoNdisMiniportCreateVc message */
952 struct rcondis_mp_create_vc {
957 /* Response to CoNdisMiniportCreateVc */
958 struct rcondis_mp_create_vc_complete {
964 /* CoNdisMiniportDeleteVc message */
965 struct rcondis_mp_delete_vc {
970 /* Response to CoNdisMiniportDeleteVc */
971 struct rcondis_mp_delete_vc_complete {
976 /* CoNdisMiniportQueryRequest message */
977 struct rcondis_mp_query_request {
986 /* CoNdisMiniportSetRequest message */
987 struct rcondis_mp_set_request {
996 /* CoNdisIndicateStatus message */
997 struct rcondis_indicate_status {
1001 u32 status_buf_offset;
1004 /* CONDIS Call/VC parameters */
1005 struct rcondis_specific_parameters {
1007 u32 parameter_length;
1008 u32 parameter_lffset;
1011 struct rcondis_media_parameters {
1015 struct rcondis_specific_parameters media_specific;
1018 struct rndis_flowspec {
1020 u32 token_bucket_size;
1023 u32 delay_variation;
1026 u32 minimum_policed_size;
1029 struct rcondis_call_manager_parameters {
1030 struct rndis_flowspec transmit;
1031 struct rndis_flowspec receive;
1032 struct rcondis_specific_parameters call_mgr_specific;
1035 /* CoNdisMiniportActivateVc message */
1036 struct rcondis_mp_activate_vc_request {
1040 u32 media_params_offset;
1041 u32 media_params_length;
1042 u32 call_mgr_params_offset;
1043 u32 call_mgr_params_length;
1046 /* Response to CoNdisMiniportActivateVc */
1047 struct rcondis_mp_activate_vc_complete {
1052 /* CoNdisMiniportDeactivateVc message */
1053 struct rcondis_mp_deactivate_vc_request {
1059 /* Response to CoNdisMiniportDeactivateVc */
1060 struct rcondis_mp_deactivate_vc_complete {
1066 /* union with all of the RNDIS messages */
1067 union rndis_message_container {
1068 struct rndis_packet pkt;
1069 struct rndis_initialize_request init_req;
1070 struct rndis_halt_request halt_req;
1071 struct rndis_query_request query_req;
1072 struct rndis_set_request set_req;
1073 struct rndis_reset_request reset_req;
1074 struct rndis_keepalive_request keep_alive_req;
1075 struct rndis_indicate_status indicate_status;
1076 struct rndis_initialize_complete init_complete;
1077 struct rndis_query_complete query_complete;
1078 struct rndis_set_complete set_complete;
1079 struct rndis_reset_complete reset_complete;
1080 struct rndis_keepalive_complete keep_alive_complete;
1081 struct rcondis_mp_create_vc co_miniport_create_vc;
1082 struct rcondis_mp_delete_vc co_miniport_delete_vc;
1083 struct rcondis_indicate_status co_indicate_status;
1084 struct rcondis_mp_activate_vc_request co_miniport_activate_vc;
1085 struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc;
1086 struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete;
1087 struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete;
1088 struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete;
1089 struct rcondis_mp_deactivate_vc_complete
1090 co_miniport_deactivate_vc_complete;
1093 /* Remote NDIS message format */
1094 struct rndis_message {
1097 /* Total length of this message, from the beginning */
1098 /* of the sruct rndis_message, in bytes. */
1101 /* Actual message */
1102 union rndis_message_container msg;
1106 struct rndis_filter_packet {
1107 void *completion_ctx;
1108 void (*completion)(void *context);
1109 struct rndis_message msg;
1114 /* get the size of an RNDIS message. Pass in the message type, */
1115 /* struct rndis_set_request, struct rndis_packet for example */
1116 #define RNDIS_MESSAGE_SIZE(msg) \
1117 (sizeof(msg) + (sizeof(struct rndis_message) - \
1118 sizeof(union rndis_message_container)))
1120 /* get pointer to info buffer with message pointer */
1121 #define MESSAGE_TO_INFO_BUFFER(msg) \
1122 (((unsigned char *)(msg)) + msg->info_buf_offset)
1124 /* get pointer to status buffer with message pointer */
1125 #define MESSAGE_TO_STATUS_BUFFER(msg) \
1126 (((unsigned char *)(msg)) + msg->status_buf_offset)
1128 /* get pointer to OOBD buffer with message pointer */
1129 #define MESSAGE_TO_OOBD_BUFFER(msg) \
1130 (((unsigned char *)(msg)) + msg->oob_data_offset)
1132 /* get pointer to data buffer with message pointer */
1133 #define MESSAGE_TO_DATA_BUFFER(msg) \
1134 (((unsigned char *)(msg)) + msg->per_pkt_info_offset)
1136 /* get pointer to contained message from NDIS_MESSAGE pointer */
1137 #define RNDIS_MESSAGE_PTR_TO_MESSAGE_PTR(rndis_msg) \
1138 ((void *) &rndis_msg->msg)
1140 /* get pointer to contained message from NDIS_MESSAGE pointer */
1141 #define RNDIS_MESSAGE_RAW_PTR_TO_MESSAGE_PTR(rndis_msg) \
1142 ((void *) rndis_msg)
1145 #define __struct_bcount(x)
1149 #define RNDIS_HEADER_SIZE (sizeof(struct rndis_message) - \
1150 sizeof(union rndis_message_container))
1152 #define NDIS_PACKET_TYPE_DIRECTED 0x00000001
1153 #define NDIS_PACKET_TYPE_MULTICAST 0x00000002
1154 #define NDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004
1155 #define NDIS_PACKET_TYPE_BROADCAST 0x00000008
1156 #define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
1157 #define NDIS_PACKET_TYPE_PROMISCUOUS 0x00000020
1158 #define NDIS_PACKET_TYPE_SMT 0x00000040
1159 #define NDIS_PACKET_TYPE_ALL_LOCAL 0x00000080
1160 #define NDIS_PACKET_TYPE_GROUP 0x00000100
1161 #define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
1162 #define NDIS_PACKET_TYPE_FUNCTIONAL 0x00000400
1163 #define NDIS_PACKET_TYPE_MAC_FRAME 0x00000800
1167 #endif /* _HYPERV_NET_H */