net/hyperv: Remove unnecessary kmap_atomic in netvsc driver
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / net / hyperv / hyperv_net.h
blobff1b5209b45fda5406538dca98071be52e9a2e0f
1 /*
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
12 * more details.
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.
18 * Authors:
19 * Haiyang Zhang <haiyangz@microsoft.com>
20 * Hank Janssen <hjanssen@microsoft.com>
21 * K. Y. Srinivasan <kys@microsoft.com>
25 #ifndef _HYPERV_NET_H
26 #define _HYPERV_NET_H
28 #include <linux/list.h>
29 #include <linux/hyperv.h>
31 /* Fwd declaration */
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 */
39 u32 count;
43 * Represent netvsc packet which contains 1 RNDIS and 1 ethernet frame
44 * within the RNDIS
46 struct hv_netvsc_packet {
47 /* Bookkeeping stuff */
48 struct list_head list_ent;
50 struct hv_device *device;
51 bool is_data_pkt;
54 * Valid only for receives when we break a xfer page packet
55 * into multiple netvsc packets
57 struct xferpage_packet *xfer_page_pkt;
59 union {
60 struct {
61 u64 recv_completion_tid;
62 void *recv_completion_ctx;
63 void (*recv_completion)(void *context);
64 } recv;
65 struct {
66 u64 send_completion_tid;
67 void *send_completion_ctx;
68 void (*send_completion)(void *context);
69 } send;
70 } completion;
72 /* This points to the memory after page_buf */
73 void *extension;
75 u32 total_data_buflen;
76 /* Points to the send/receive buffer where the ethernet frame is */
77 void *data;
78 u32 page_buf_cnt;
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 */
85 int ring_size;
88 enum rndis_device_state {
89 RNDIS_DEV_UNINITIALIZED = 0,
90 RNDIS_DEV_INITIALIZING,
91 RNDIS_DEV_INITIALIZED,
92 RNDIS_DEV_DATAINITIALIZED,
95 struct rndis_device {
96 struct netvsc_device *net_dev;
98 enum rndis_device_state state;
99 bool link_state;
100 atomic_t new_req_id;
102 spinlock_t request_lock;
103 struct list_head req_list;
105 unsigned char hw_mac_adr[ETH_ALEN];
109 /* Interface */
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_MIN_PROTOCOL_VERSION NVSP_PROTOCOL_VERSION_1
138 #define NVSP_MAX_PROTOCOL_VERSION NVSP_PROTOCOL_VERSION_1
140 enum {
141 NVSP_MSG_TYPE_NONE = 0,
143 /* Init Messages */
144 NVSP_MSG_TYPE_INIT = 1,
145 NVSP_MSG_TYPE_INIT_COMPLETE = 2,
147 NVSP_VERSION_MSG_START = 100,
149 /* Version 1 Messages */
150 NVSP_MSG1_TYPE_SEND_NDIS_VER = NVSP_VERSION_MSG_START,
152 NVSP_MSG1_TYPE_SEND_RECV_BUF,
153 NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE,
154 NVSP_MSG1_TYPE_REVOKE_RECV_BUF,
156 NVSP_MSG1_TYPE_SEND_SEND_BUF,
157 NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE,
158 NVSP_MSG1_TYPE_REVOKE_SEND_BUF,
160 NVSP_MSG1_TYPE_SEND_RNDIS_PKT,
161 NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE,
164 * This should be set to the number of messages for the version with
165 * the maximum number of messages.
167 NVSP_NUM_MSG_PER_VERSION = 9,
170 enum {
171 NVSP_STAT_NONE = 0,
172 NVSP_STAT_SUCCESS,
173 NVSP_STAT_FAIL,
174 NVSP_STAT_PROTOCOL_TOO_NEW,
175 NVSP_STAT_PROTOCOL_TOO_OLD,
176 NVSP_STAT_INVALID_RNDIS_PKT,
177 NVSP_STAT_BUSY,
178 NVSP_STAT_MAX,
181 struct nvsp_message_header {
182 u32 msg_type;
185 /* Init Messages */
188 * This message is used by the VSC to initialize the channel after the channels
189 * has been opened. This message should never include anything other then
190 * versioning (i.e. this message will be the same for ever).
192 struct nvsp_message_init {
193 u32 min_protocol_ver;
194 u32 max_protocol_ver;
195 } __packed;
198 * This message is used by the VSP to complete the initialization of the
199 * channel. This message should never include anything other then versioning
200 * (i.e. this message will be the same for ever).
202 struct nvsp_message_init_complete {
203 u32 negotiated_protocol_ver;
204 u32 max_mdl_chain_len;
205 u32 status;
206 } __packed;
208 union nvsp_message_init_uber {
209 struct nvsp_message_init init;
210 struct nvsp_message_init_complete init_complete;
211 } __packed;
213 /* Version 1 Messages */
216 * This message is used by the VSC to send the NDIS version to the VSP. The VSP
217 * can use this information when handling OIDs sent by the VSC.
219 struct nvsp_1_message_send_ndis_version {
220 u32 ndis_major_ver;
221 u32 ndis_minor_ver;
222 } __packed;
225 * This message is used by the VSC to send a receive buffer to the VSP. The VSP
226 * can then use the receive buffer to send data to the VSC.
228 struct nvsp_1_message_send_receive_buffer {
229 u32 gpadl_handle;
230 u16 id;
231 } __packed;
233 struct nvsp_1_receive_buffer_section {
234 u32 offset;
235 u32 sub_alloc_size;
236 u32 num_sub_allocs;
237 u32 end_offset;
238 } __packed;
241 * This message is used by the VSP to acknowledge a receive buffer send by the
242 * VSC. This message must be sent by the VSP before the VSP uses the receive
243 * buffer.
245 struct nvsp_1_message_send_receive_buffer_complete {
246 u32 status;
247 u32 num_sections;
250 * The receive buffer is split into two parts, a large suballocation
251 * section and a small suballocation section. These sections are then
252 * suballocated by a certain size.
256 * For example, the following break up of the receive buffer has 6
257 * large suballocations and 10 small suballocations.
261 * | Large Section | | Small Section |
262 * ------------------------------------------------------------
263 * | | | | | | | | | | | | | | | | | |
264 * | |
265 * LargeOffset SmallOffset
268 struct nvsp_1_receive_buffer_section sections[1];
269 } __packed;
272 * This message is sent by the VSC to revoke the receive buffer. After the VSP
273 * completes this transaction, the vsp should never use the receive buffer
274 * again.
276 struct nvsp_1_message_revoke_receive_buffer {
277 u16 id;
281 * This message is used by the VSC to send a send buffer to the VSP. The VSC
282 * can then use the send buffer to send data to the VSP.
284 struct nvsp_1_message_send_send_buffer {
285 u32 gpadl_handle;
286 u16 id;
287 } __packed;
290 * This message is used by the VSP to acknowledge a send buffer sent by the
291 * VSC. This message must be sent by the VSP before the VSP uses the sent
292 * buffer.
294 struct nvsp_1_message_send_send_buffer_complete {
295 u32 status;
298 * The VSC gets to choose the size of the send buffer and the VSP gets
299 * to choose the sections size of the buffer. This was done to enable
300 * dynamic reconfigurations when the cost of GPA-direct buffers
301 * decreases.
303 u32 section_size;
304 } __packed;
307 * This message is sent by the VSC to revoke the send buffer. After the VSP
308 * completes this transaction, the vsp should never use the send buffer again.
310 struct nvsp_1_message_revoke_send_buffer {
311 u16 id;
315 * This message is used by both the VSP and the VSC to send a RNDIS message to
316 * the opposite channel endpoint.
318 struct nvsp_1_message_send_rndis_packet {
320 * This field is specified by RNIDS. They assume there's two different
321 * channels of communication. However, the Network VSP only has one.
322 * Therefore, the channel travels with the RNDIS packet.
324 u32 channel_type;
327 * This field is used to send part or all of the data through a send
328 * buffer. This values specifies an index into the send buffer. If the
329 * index is 0xFFFFFFFF, then the send buffer is not being used and all
330 * of the data was sent through other VMBus mechanisms.
332 u32 send_buf_section_index;
333 u32 send_buf_section_size;
334 } __packed;
337 * This message is used by both the VSP and the VSC to complete a RNDIS message
338 * to the opposite channel endpoint. At this point, the initiator of this
339 * message cannot use any resources associated with the original RNDIS packet.
341 struct nvsp_1_message_send_rndis_packet_complete {
342 u32 status;
345 union nvsp_1_message_uber {
346 struct nvsp_1_message_send_ndis_version send_ndis_ver;
348 struct nvsp_1_message_send_receive_buffer send_recv_buf;
349 struct nvsp_1_message_send_receive_buffer_complete
350 send_recv_buf_complete;
351 struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf;
353 struct nvsp_1_message_send_send_buffer send_send_buf;
354 struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete;
355 struct nvsp_1_message_revoke_send_buffer revoke_send_buf;
357 struct nvsp_1_message_send_rndis_packet send_rndis_pkt;
358 struct nvsp_1_message_send_rndis_packet_complete
359 send_rndis_pkt_complete;
360 } __packed;
362 union nvsp_all_messages {
363 union nvsp_message_init_uber init_msg;
364 union nvsp_1_message_uber v1_msg;
365 } __packed;
367 /* ALL Messages */
368 struct nvsp_message {
369 struct nvsp_message_header hdr;
370 union nvsp_all_messages msg;
371 } __packed;
376 /* #define NVSC_MIN_PROTOCOL_VERSION 1 */
377 /* #define NVSC_MAX_PROTOCOL_VERSION 1 */
379 #define NETVSC_RECEIVE_BUFFER_SIZE (1024*1024) /* 1MB */
381 #define NETVSC_RECEIVE_BUFFER_ID 0xcafe
383 #define NETVSC_RECEIVE_SG_COUNT 1
385 /* Preallocated receive packets */
386 #define NETVSC_RECEIVE_PACKETLIST_COUNT 256
388 #define NETVSC_PACKET_SIZE 2048
390 /* Per netvsc channel-specific */
391 struct netvsc_device {
392 struct hv_device *dev;
394 atomic_t num_outstanding_sends;
395 bool destroy;
397 * List of free preallocated hv_netvsc_packet to represent receive
398 * packet
400 struct list_head recv_pkt_list;
401 spinlock_t recv_pkt_list_lock;
403 /* Receive buffer allocated by us but manages by NetVSP */
404 void *recv_buf;
405 u32 recv_buf_size;
406 u32 recv_buf_gpadl_handle;
407 u32 recv_section_cnt;
408 struct nvsp_1_receive_buffer_section *recv_section;
410 /* Used for NetVSP initialization protocol */
411 struct completion channel_init_wait;
412 struct nvsp_message channel_init_pkt;
414 struct nvsp_message revoke_packet;
415 /* unsigned char HwMacAddr[HW_MACADDR_LEN]; */
417 struct net_device *ndev;
419 /* Holds rndis device info */
420 void *extension;
424 /* Status codes */
427 #ifndef STATUS_SUCCESS
428 #define STATUS_SUCCESS (0x00000000L)
429 #endif
431 #ifndef STATUS_UNSUCCESSFUL
432 #define STATUS_UNSUCCESSFUL (0xC0000001L)
433 #endif
435 #ifndef STATUS_PENDING
436 #define STATUS_PENDING (0x00000103L)
437 #endif
439 #ifndef STATUS_INSUFFICIENT_RESOURCES
440 #define STATUS_INSUFFICIENT_RESOURCES (0xC000009AL)
441 #endif
443 #ifndef STATUS_BUFFER_OVERFLOW
444 #define STATUS_BUFFER_OVERFLOW (0x80000005L)
445 #endif
447 #ifndef STATUS_NOT_SUPPORTED
448 #define STATUS_NOT_SUPPORTED (0xC00000BBL)
449 #endif
451 #define RNDIS_STATUS_SUCCESS (STATUS_SUCCESS)
452 #define RNDIS_STATUS_PENDING (STATUS_PENDING)
453 #define RNDIS_STATUS_NOT_RECOGNIZED (0x00010001L)
454 #define RNDIS_STATUS_NOT_COPIED (0x00010002L)
455 #define RNDIS_STATUS_NOT_ACCEPTED (0x00010003L)
456 #define RNDIS_STATUS_CALL_ACTIVE (0x00010007L)
458 #define RNDIS_STATUS_ONLINE (0x40010003L)
459 #define RNDIS_STATUS_RESET_START (0x40010004L)
460 #define RNDIS_STATUS_RESET_END (0x40010005L)
461 #define RNDIS_STATUS_RING_STATUS (0x40010006L)
462 #define RNDIS_STATUS_CLOSED (0x40010007L)
463 #define RNDIS_STATUS_WAN_LINE_UP (0x40010008L)
464 #define RNDIS_STATUS_WAN_LINE_DOWN (0x40010009L)
465 #define RNDIS_STATUS_WAN_FRAGMENT (0x4001000AL)
466 #define RNDIS_STATUS_MEDIA_CONNECT (0x4001000BL)
467 #define RNDIS_STATUS_MEDIA_DISCONNECT (0x4001000CL)
468 #define RNDIS_STATUS_HARDWARE_LINE_UP (0x4001000DL)
469 #define RNDIS_STATUS_HARDWARE_LINE_DOWN (0x4001000EL)
470 #define RNDIS_STATUS_INTERFACE_UP (0x4001000FL)
471 #define RNDIS_STATUS_INTERFACE_DOWN (0x40010010L)
472 #define RNDIS_STATUS_MEDIA_BUSY (0x40010011L)
473 #define RNDIS_STATUS_MEDIA_SPECIFIC_INDICATION (0x40010012L)
474 #define RNDIS_STATUS_WW_INDICATION RDIA_SPECIFIC_INDICATION
475 #define RNDIS_STATUS_LINK_SPEED_CHANGE (0x40010013L)
477 #define RNDIS_STATUS_NOT_RESETTABLE (0x80010001L)
478 #define RNDIS_STATUS_SOFT_ERRORS (0x80010003L)
479 #define RNDIS_STATUS_HARD_ERRORS (0x80010004L)
480 #define RNDIS_STATUS_BUFFER_OVERFLOW (STATUS_BUFFER_OVERFLOW)
482 #define RNDIS_STATUS_FAILURE (STATUS_UNSUCCESSFUL)
483 #define RNDIS_STATUS_RESOURCES (STATUS_INSUFFICIENT_RESOURCES)
484 #define RNDIS_STATUS_CLOSING (0xC0010002L)
485 #define RNDIS_STATUS_BAD_VERSION (0xC0010004L)
486 #define RNDIS_STATUS_BAD_CHARACTERISTICS (0xC0010005L)
487 #define RNDIS_STATUS_ADAPTER_NOT_FOUND (0xC0010006L)
488 #define RNDIS_STATUS_OPEN_FAILED (0xC0010007L)
489 #define RNDIS_STATUS_DEVICE_FAILED (0xC0010008L)
490 #define RNDIS_STATUS_MULTICAST_FULL (0xC0010009L)
491 #define RNDIS_STATUS_MULTICAST_EXISTS (0xC001000AL)
492 #define RNDIS_STATUS_MULTICAST_NOT_FOUND (0xC001000BL)
493 #define RNDIS_STATUS_REQUEST_ABORTED (0xC001000CL)
494 #define RNDIS_STATUS_RESET_IN_PROGRESS (0xC001000DL)
495 #define RNDIS_STATUS_CLOSING_INDICATING (0xC001000EL)
496 #define RNDIS_STATUS_NOT_SUPPORTED (STATUS_NOT_SUPPORTED)
497 #define RNDIS_STATUS_INVALID_PACKET (0xC001000FL)
498 #define RNDIS_STATUS_OPEN_LIST_FULL (0xC0010010L)
499 #define RNDIS_STATUS_ADAPTER_NOT_READY (0xC0010011L)
500 #define RNDIS_STATUS_ADAPTER_NOT_OPEN (0xC0010012L)
501 #define RNDIS_STATUS_NOT_INDICATING (0xC0010013L)
502 #define RNDIS_STATUS_INVALID_LENGTH (0xC0010014L)
503 #define RNDIS_STATUS_INVALID_DATA (0xC0010015L)
504 #define RNDIS_STATUS_BUFFER_TOO_SHORT (0xC0010016L)
505 #define RNDIS_STATUS_INVALID_OID (0xC0010017L)
506 #define RNDIS_STATUS_ADAPTER_REMOVED (0xC0010018L)
507 #define RNDIS_STATUS_UNSUPPORTED_MEDIA (0xC0010019L)
508 #define RNDIS_STATUS_GROUP_ADDRESS_IN_USE (0xC001001AL)
509 #define RNDIS_STATUS_FILE_NOT_FOUND (0xC001001BL)
510 #define RNDIS_STATUS_ERROR_READING_FILE (0xC001001CL)
511 #define RNDIS_STATUS_ALREADY_MAPPED (0xC001001DL)
512 #define RNDIS_STATUS_RESOURCE_CONFLICT (0xC001001EL)
513 #define RNDIS_STATUS_NO_CABLE (0xC001001FL)
515 #define RNDIS_STATUS_INVALID_SAP (0xC0010020L)
516 #define RNDIS_STATUS_SAP_IN_USE (0xC0010021L)
517 #define RNDIS_STATUS_INVALID_ADDRESS (0xC0010022L)
518 #define RNDIS_STATUS_VC_NOT_ACTIVATED (0xC0010023L)
519 #define RNDIS_STATUS_DEST_OUT_OF_ORDER (0xC0010024L)
520 #define RNDIS_STATUS_VC_NOT_AVAILABLE (0xC0010025L)
521 #define RNDIS_STATUS_CELLRATE_NOT_AVAILABLE (0xC0010026L)
522 #define RNDIS_STATUS_INCOMPATABLE_QOS (0xC0010027L)
523 #define RNDIS_STATUS_AAL_PARAMS_UNSUPPORTED (0xC0010028L)
524 #define RNDIS_STATUS_NO_ROUTE_TO_DESTINATION (0xC0010029L)
526 #define RNDIS_STATUS_TOKEN_RING_OPEN_ERROR (0xC0011000L)
528 /* Object Identifiers used by NdisRequest Query/Set Information */
529 /* General Objects */
530 #define RNDIS_OID_GEN_SUPPORTED_LIST 0x00010101
531 #define RNDIS_OID_GEN_HARDWARE_STATUS 0x00010102
532 #define RNDIS_OID_GEN_MEDIA_SUPPORTED 0x00010103
533 #define RNDIS_OID_GEN_MEDIA_IN_USE 0x00010104
534 #define RNDIS_OID_GEN_MAXIMUM_LOOKAHEAD 0x00010105
535 #define RNDIS_OID_GEN_MAXIMUM_FRAME_SIZE 0x00010106
536 #define RNDIS_OID_GEN_LINK_SPEED 0x00010107
537 #define RNDIS_OID_GEN_TRANSMIT_BUFFER_SPACE 0x00010108
538 #define RNDIS_OID_GEN_RECEIVE_BUFFER_SPACE 0x00010109
539 #define RNDIS_OID_GEN_TRANSMIT_BLOCK_SIZE 0x0001010A
540 #define RNDIS_OID_GEN_RECEIVE_BLOCK_SIZE 0x0001010B
541 #define RNDIS_OID_GEN_VENDOR_ID 0x0001010C
542 #define RNDIS_OID_GEN_VENDOR_DESCRIPTION 0x0001010D
543 #define RNDIS_OID_GEN_CURRENT_PACKET_FILTER 0x0001010E
544 #define RNDIS_OID_GEN_CURRENT_LOOKAHEAD 0x0001010F
545 #define RNDIS_OID_GEN_DRIVER_VERSION 0x00010110
546 #define RNDIS_OID_GEN_MAXIMUM_TOTAL_SIZE 0x00010111
547 #define RNDIS_OID_GEN_PROTOCOL_OPTIONS 0x00010112
548 #define RNDIS_OID_GEN_MAC_OPTIONS 0x00010113
549 #define RNDIS_OID_GEN_MEDIA_CONNECT_STATUS 0x00010114
550 #define RNDIS_OID_GEN_MAXIMUM_SEND_PACKETS 0x00010115
551 #define RNDIS_OID_GEN_VENDOR_DRIVER_VERSION 0x00010116
552 #define RNDIS_OID_GEN_NETWORK_LAYER_ADDRESSES 0x00010118
553 #define RNDIS_OID_GEN_TRANSPORT_HEADER_OFFSET 0x00010119
554 #define RNDIS_OID_GEN_MACHINE_NAME 0x0001021A
555 #define RNDIS_OID_GEN_RNDIS_CONFIG_PARAMETER 0x0001021B
557 #define RNDIS_OID_GEN_XMIT_OK 0x00020101
558 #define RNDIS_OID_GEN_RCV_OK 0x00020102
559 #define RNDIS_OID_GEN_XMIT_ERROR 0x00020103
560 #define RNDIS_OID_GEN_RCV_ERROR 0x00020104
561 #define RNDIS_OID_GEN_RCV_NO_BUFFER 0x00020105
563 #define RNDIS_OID_GEN_DIRECTED_BYTES_XMIT 0x00020201
564 #define RNDIS_OID_GEN_DIRECTED_FRAMES_XMIT 0x00020202
565 #define RNDIS_OID_GEN_MULTICAST_BYTES_XMIT 0x00020203
566 #define RNDIS_OID_GEN_MULTICAST_FRAMES_XMIT 0x00020204
567 #define RNDIS_OID_GEN_BROADCAST_BYTES_XMIT 0x00020205
568 #define RNDIS_OID_GEN_BROADCAST_FRAMES_XMIT 0x00020206
569 #define RNDIS_OID_GEN_DIRECTED_BYTES_RCV 0x00020207
570 #define RNDIS_OID_GEN_DIRECTED_FRAMES_RCV 0x00020208
571 #define RNDIS_OID_GEN_MULTICAST_BYTES_RCV 0x00020209
572 #define RNDIS_OID_GEN_MULTICAST_FRAMES_RCV 0x0002020A
573 #define RNDIS_OID_GEN_BROADCAST_BYTES_RCV 0x0002020B
574 #define RNDIS_OID_GEN_BROADCAST_FRAMES_RCV 0x0002020C
576 #define RNDIS_OID_GEN_RCV_CRC_ERROR 0x0002020D
577 #define RNDIS_OID_GEN_TRANSMIT_QUEUE_LENGTH 0x0002020E
579 #define RNDIS_OID_GEN_GET_TIME_CAPS 0x0002020F
580 #define RNDIS_OID_GEN_GET_NETCARD_TIME 0x00020210
582 /* These are connection-oriented general OIDs. */
583 /* These replace the above OIDs for connection-oriented media. */
584 #define RNDIS_OID_GEN_CO_SUPPORTED_LIST 0x00010101
585 #define RNDIS_OID_GEN_CO_HARDWARE_STATUS 0x00010102
586 #define RNDIS_OID_GEN_CO_MEDIA_SUPPORTED 0x00010103
587 #define RNDIS_OID_GEN_CO_MEDIA_IN_USE 0x00010104
588 #define RNDIS_OID_GEN_CO_LINK_SPEED 0x00010105
589 #define RNDIS_OID_GEN_CO_VENDOR_ID 0x00010106
590 #define RNDIS_OID_GEN_CO_VENDOR_DESCRIPTION 0x00010107
591 #define RNDIS_OID_GEN_CO_DRIVER_VERSION 0x00010108
592 #define RNDIS_OID_GEN_CO_PROTOCOL_OPTIONS 0x00010109
593 #define RNDIS_OID_GEN_CO_MAC_OPTIONS 0x0001010A
594 #define RNDIS_OID_GEN_CO_MEDIA_CONNECT_STATUS 0x0001010B
595 #define RNDIS_OID_GEN_CO_VENDOR_DRIVER_VERSION 0x0001010C
596 #define RNDIS_OID_GEN_CO_MINIMUM_LINK_SPEED 0x0001010D
598 #define RNDIS_OID_GEN_CO_GET_TIME_CAPS 0x00010201
599 #define RNDIS_OID_GEN_CO_GET_NETCARD_TIME 0x00010202
601 /* These are connection-oriented statistics OIDs. */
602 #define RNDIS_OID_GEN_CO_XMIT_PDUS_OK 0x00020101
603 #define RNDIS_OID_GEN_CO_RCV_PDUS_OK 0x00020102
604 #define RNDIS_OID_GEN_CO_XMIT_PDUS_ERROR 0x00020103
605 #define RNDIS_OID_GEN_CO_RCV_PDUS_ERROR 0x00020104
606 #define RNDIS_OID_GEN_CO_RCV_PDUS_NO_BUFFER 0x00020105
609 #define RNDIS_OID_GEN_CO_RCV_CRC_ERROR 0x00020201
610 #define RNDIS_OID_GEN_CO_TRANSMIT_QUEUE_LENGTH 0x00020202
611 #define RNDIS_OID_GEN_CO_BYTES_XMIT 0x00020203
612 #define RNDIS_OID_GEN_CO_BYTES_RCV 0x00020204
613 #define RNDIS_OID_GEN_CO_BYTES_XMIT_OUTSTANDING 0x00020205
614 #define RNDIS_OID_GEN_CO_NETCARD_LOAD 0x00020206
616 /* These are objects for Connection-oriented media call-managers. */
617 #define RNDIS_OID_CO_ADD_PVC 0xFF000001
618 #define RNDIS_OID_CO_DELETE_PVC 0xFF000002
619 #define RNDIS_OID_CO_GET_CALL_INFORMATION 0xFF000003
620 #define RNDIS_OID_CO_ADD_ADDRESS 0xFF000004
621 #define RNDIS_OID_CO_DELETE_ADDRESS 0xFF000005
622 #define RNDIS_OID_CO_GET_ADDRESSES 0xFF000006
623 #define RNDIS_OID_CO_ADDRESS_CHANGE 0xFF000007
624 #define RNDIS_OID_CO_SIGNALING_ENABLED 0xFF000008
625 #define RNDIS_OID_CO_SIGNALING_DISABLED 0xFF000009
627 /* 802.3 Objects (Ethernet) */
628 #define RNDIS_OID_802_3_PERMANENT_ADDRESS 0x01010101
629 #define RNDIS_OID_802_3_CURRENT_ADDRESS 0x01010102
630 #define RNDIS_OID_802_3_MULTICAST_LIST 0x01010103
631 #define RNDIS_OID_802_3_MAXIMUM_LIST_SIZE 0x01010104
632 #define RNDIS_OID_802_3_MAC_OPTIONS 0x01010105
634 #define NDIS_802_3_MAC_OPTION_PRIORITY 0x00000001
636 #define RNDIS_OID_802_3_RCV_ERROR_ALIGNMENT 0x01020101
637 #define RNDIS_OID_802_3_XMIT_ONE_COLLISION 0x01020102
638 #define RNDIS_OID_802_3_XMIT_MORE_COLLISIONS 0x01020103
640 #define RNDIS_OID_802_3_XMIT_DEFERRED 0x01020201
641 #define RNDIS_OID_802_3_XMIT_MAX_COLLISIONS 0x01020202
642 #define RNDIS_OID_802_3_RCV_OVERRUN 0x01020203
643 #define RNDIS_OID_802_3_XMIT_UNDERRUN 0x01020204
644 #define RNDIS_OID_802_3_XMIT_HEARTBEAT_FAILURE 0x01020205
645 #define RNDIS_OID_802_3_XMIT_TIMES_CRS_LOST 0x01020206
646 #define RNDIS_OID_802_3_XMIT_LATE_COLLISIONS 0x01020207
648 /* Remote NDIS message types */
649 #define REMOTE_NDIS_PACKET_MSG 0x00000001
650 #define REMOTE_NDIS_INITIALIZE_MSG 0x00000002
651 #define REMOTE_NDIS_HALT_MSG 0x00000003
652 #define REMOTE_NDIS_QUERY_MSG 0x00000004
653 #define REMOTE_NDIS_SET_MSG 0x00000005
654 #define REMOTE_NDIS_RESET_MSG 0x00000006
655 #define REMOTE_NDIS_INDICATE_STATUS_MSG 0x00000007
656 #define REMOTE_NDIS_KEEPALIVE_MSG 0x00000008
658 #define REMOTE_CONDIS_MP_CREATE_VC_MSG 0x00008001
659 #define REMOTE_CONDIS_MP_DELETE_VC_MSG 0x00008002
660 #define REMOTE_CONDIS_MP_ACTIVATE_VC_MSG 0x00008005
661 #define REMOTE_CONDIS_MP_DEACTIVATE_VC_MSG 0x00008006
662 #define REMOTE_CONDIS_INDICATE_STATUS_MSG 0x00008007
664 /* Remote NDIS message completion types */
665 #define REMOTE_NDIS_INITIALIZE_CMPLT 0x80000002
666 #define REMOTE_NDIS_QUERY_CMPLT 0x80000004
667 #define REMOTE_NDIS_SET_CMPLT 0x80000005
668 #define REMOTE_NDIS_RESET_CMPLT 0x80000006
669 #define REMOTE_NDIS_KEEPALIVE_CMPLT 0x80000008
671 #define REMOTE_CONDIS_MP_CREATE_VC_CMPLT 0x80008001
672 #define REMOTE_CONDIS_MP_DELETE_VC_CMPLT 0x80008002
673 #define REMOTE_CONDIS_MP_ACTIVATE_VC_CMPLT 0x80008005
674 #define REMOTE_CONDIS_MP_DEACTIVATE_VC_CMPLT 0x80008006
677 * Reserved message type for private communication between lower-layer host
678 * driver and remote device, if necessary.
680 #define REMOTE_NDIS_BUS_MSG 0xff000001
682 /* Defines for DeviceFlags in struct rndis_initialize_complete */
683 #define RNDIS_DF_CONNECTIONLESS 0x00000001
684 #define RNDIS_DF_CONNECTION_ORIENTED 0x00000002
685 #define RNDIS_DF_RAW_DATA 0x00000004
687 /* Remote NDIS medium types. */
688 #define RNDIS_MEDIUM_802_3 0x00000000
689 #define RNDIS_MEDIUM_802_5 0x00000001
690 #define RNDIS_MEDIUM_FDDI 0x00000002
691 #define RNDIS_MEDIUM_WAN 0x00000003
692 #define RNDIS_MEDIUM_LOCAL_TALK 0x00000004
693 #define RNDIS_MEDIUM_ARCNET_RAW 0x00000006
694 #define RNDIS_MEDIUM_ARCNET_878_2 0x00000007
695 #define RNDIS_MEDIUM_ATM 0x00000008
696 #define RNDIS_MEDIUM_WIRELESS_WAN 0x00000009
697 #define RNDIS_MEDIUM_IRDA 0x0000000a
698 #define RNDIS_MEDIUM_CO_WAN 0x0000000b
699 /* Not a real medium, defined as an upper-bound */
700 #define RNDIS_MEDIUM_MAX 0x0000000d
703 /* Remote NDIS medium connection states. */
704 #define RNDIS_MEDIA_STATE_CONNECTED 0x00000000
705 #define RNDIS_MEDIA_STATE_DISCONNECTED 0x00000001
707 /* Remote NDIS version numbers */
708 #define RNDIS_MAJOR_VERSION 0x00000001
709 #define RNDIS_MINOR_VERSION 0x00000000
712 /* NdisInitialize message */
713 struct rndis_initialize_request {
714 u32 req_id;
715 u32 major_ver;
716 u32 minor_ver;
717 u32 max_xfer_size;
720 /* Response to NdisInitialize */
721 struct rndis_initialize_complete {
722 u32 req_id;
723 u32 status;
724 u32 major_ver;
725 u32 minor_ver;
726 u32 dev_flags;
727 u32 medium;
728 u32 max_pkt_per_msg;
729 u32 max_xfer_size;
730 u32 pkt_alignment_factor;
731 u32 af_list_offset;
732 u32 af_list_size;
735 /* Call manager devices only: Information about an address family */
736 /* supported by the device is appended to the response to NdisInitialize. */
737 struct rndis_co_address_family {
738 u32 address_family;
739 u32 major_ver;
740 u32 minor_ver;
743 /* NdisHalt message */
744 struct rndis_halt_request {
745 u32 req_id;
748 /* NdisQueryRequest message */
749 struct rndis_query_request {
750 u32 req_id;
751 u32 oid;
752 u32 info_buflen;
753 u32 info_buf_offset;
754 u32 dev_vc_handle;
757 /* Response to NdisQueryRequest */
758 struct rndis_query_complete {
759 u32 req_id;
760 u32 status;
761 u32 info_buflen;
762 u32 info_buf_offset;
765 /* NdisSetRequest message */
766 struct rndis_set_request {
767 u32 req_id;
768 u32 oid;
769 u32 info_buflen;
770 u32 info_buf_offset;
771 u32 dev_vc_handle;
774 /* Response to NdisSetRequest */
775 struct rndis_set_complete {
776 u32 req_id;
777 u32 status;
780 /* NdisReset message */
781 struct rndis_reset_request {
782 u32 reserved;
785 /* Response to NdisReset */
786 struct rndis_reset_complete {
787 u32 status;
788 u32 addressing_reset;
791 /* NdisMIndicateStatus message */
792 struct rndis_indicate_status {
793 u32 status;
794 u32 status_buflen;
795 u32 status_buf_offset;
798 /* Diagnostic information passed as the status buffer in */
799 /* struct rndis_indicate_status messages signifying error conditions. */
800 struct rndis_diagnostic_info {
801 u32 diag_status;
802 u32 error_offset;
805 /* NdisKeepAlive message */
806 struct rndis_keepalive_request {
807 u32 req_id;
810 /* Response to NdisKeepAlive */
811 struct rndis_keepalive_complete {
812 u32 req_id;
813 u32 status;
817 * Data message. All Offset fields contain byte offsets from the beginning of
818 * struct rndis_packet. All Length fields are in bytes. VcHandle is set
819 * to 0 for connectionless data, otherwise it contains the VC handle.
821 struct rndis_packet {
822 u32 data_offset;
823 u32 data_len;
824 u32 oob_data_offset;
825 u32 oob_data_len;
826 u32 num_oob_data_elements;
827 u32 per_pkt_info_offset;
828 u32 per_pkt_info_len;
829 u32 vc_handle;
830 u32 reserved;
833 /* Optional Out of Band data associated with a Data message. */
834 struct rndis_oobd {
835 u32 size;
836 u32 type;
837 u32 class_info_offset;
840 /* Packet extension field contents associated with a Data message. */
841 struct rndis_per_packet_info {
842 u32 size;
843 u32 type;
844 u32 per_pkt_info_offset;
847 /* Format of Information buffer passed in a SetRequest for the OID */
848 /* OID_GEN_RNDIS_CONFIG_PARAMETER. */
849 struct rndis_config_parameter_info {
850 u32 parameter_name_offset;
851 u32 parameter_name_length;
852 u32 parameter_type;
853 u32 parameter_value_offset;
854 u32 parameter_value_length;
857 /* Values for ParameterType in struct rndis_config_parameter_info */
858 #define RNDIS_CONFIG_PARAM_TYPE_INTEGER 0
859 #define RNDIS_CONFIG_PARAM_TYPE_STRING 2
861 /* CONDIS Miniport messages for connection oriented devices */
862 /* that do not implement a call manager. */
864 /* CoNdisMiniportCreateVc message */
865 struct rcondis_mp_create_vc {
866 u32 req_id;
867 u32 ndis_vc_handle;
870 /* Response to CoNdisMiniportCreateVc */
871 struct rcondis_mp_create_vc_complete {
872 u32 req_id;
873 u32 dev_vc_handle;
874 u32 status;
877 /* CoNdisMiniportDeleteVc message */
878 struct rcondis_mp_delete_vc {
879 u32 req_id;
880 u32 dev_vc_handle;
883 /* Response to CoNdisMiniportDeleteVc */
884 struct rcondis_mp_delete_vc_complete {
885 u32 req_id;
886 u32 status;
889 /* CoNdisMiniportQueryRequest message */
890 struct rcondis_mp_query_request {
891 u32 req_id;
892 u32 request_type;
893 u32 oid;
894 u32 dev_vc_handle;
895 u32 info_buflen;
896 u32 info_buf_offset;
899 /* CoNdisMiniportSetRequest message */
900 struct rcondis_mp_set_request {
901 u32 req_id;
902 u32 request_type;
903 u32 oid;
904 u32 dev_vc_handle;
905 u32 info_buflen;
906 u32 info_buf_offset;
909 /* CoNdisIndicateStatus message */
910 struct rcondis_indicate_status {
911 u32 ndis_vc_handle;
912 u32 status;
913 u32 status_buflen;
914 u32 status_buf_offset;
917 /* CONDIS Call/VC parameters */
918 struct rcondis_specific_parameters {
919 u32 parameter_type;
920 u32 parameter_length;
921 u32 parameter_lffset;
924 struct rcondis_media_parameters {
925 u32 flags;
926 u32 reserved1;
927 u32 reserved2;
928 struct rcondis_specific_parameters media_specific;
931 struct rndis_flowspec {
932 u32 token_rate;
933 u32 token_bucket_size;
934 u32 peak_bandwidth;
935 u32 latency;
936 u32 delay_variation;
937 u32 service_type;
938 u32 max_sdu_size;
939 u32 minimum_policed_size;
942 struct rcondis_call_manager_parameters {
943 struct rndis_flowspec transmit;
944 struct rndis_flowspec receive;
945 struct rcondis_specific_parameters call_mgr_specific;
948 /* CoNdisMiniportActivateVc message */
949 struct rcondis_mp_activate_vc_request {
950 u32 req_id;
951 u32 flags;
952 u32 dev_vc_handle;
953 u32 media_params_offset;
954 u32 media_params_length;
955 u32 call_mgr_params_offset;
956 u32 call_mgr_params_length;
959 /* Response to CoNdisMiniportActivateVc */
960 struct rcondis_mp_activate_vc_complete {
961 u32 req_id;
962 u32 status;
965 /* CoNdisMiniportDeactivateVc message */
966 struct rcondis_mp_deactivate_vc_request {
967 u32 req_id;
968 u32 flags;
969 u32 dev_vc_handle;
972 /* Response to CoNdisMiniportDeactivateVc */
973 struct rcondis_mp_deactivate_vc_complete {
974 u32 req_id;
975 u32 status;
979 /* union with all of the RNDIS messages */
980 union rndis_message_container {
981 struct rndis_packet pkt;
982 struct rndis_initialize_request init_req;
983 struct rndis_halt_request halt_req;
984 struct rndis_query_request query_req;
985 struct rndis_set_request set_req;
986 struct rndis_reset_request reset_req;
987 struct rndis_keepalive_request keep_alive_req;
988 struct rndis_indicate_status indicate_status;
989 struct rndis_initialize_complete init_complete;
990 struct rndis_query_complete query_complete;
991 struct rndis_set_complete set_complete;
992 struct rndis_reset_complete reset_complete;
993 struct rndis_keepalive_complete keep_alive_complete;
994 struct rcondis_mp_create_vc co_miniport_create_vc;
995 struct rcondis_mp_delete_vc co_miniport_delete_vc;
996 struct rcondis_indicate_status co_indicate_status;
997 struct rcondis_mp_activate_vc_request co_miniport_activate_vc;
998 struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc;
999 struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete;
1000 struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete;
1001 struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete;
1002 struct rcondis_mp_deactivate_vc_complete
1003 co_miniport_deactivate_vc_complete;
1006 /* Remote NDIS message format */
1007 struct rndis_message {
1008 u32 ndis_msg_type;
1010 /* Total length of this message, from the beginning */
1011 /* of the sruct rndis_message, in bytes. */
1012 u32 msg_len;
1014 /* Actual message */
1015 union rndis_message_container msg;
1019 struct rndis_filter_packet {
1020 void *completion_ctx;
1021 void (*completion)(void *context);
1022 struct rndis_message msg;
1025 /* Handy macros */
1027 /* get the size of an RNDIS message. Pass in the message type, */
1028 /* struct rndis_set_request, struct rndis_packet for example */
1029 #define RNDIS_MESSAGE_SIZE(msg) \
1030 (sizeof(msg) + (sizeof(struct rndis_message) - \
1031 sizeof(union rndis_message_container)))
1033 /* get pointer to info buffer with message pointer */
1034 #define MESSAGE_TO_INFO_BUFFER(msg) \
1035 (((unsigned char *)(msg)) + msg->info_buf_offset)
1037 /* get pointer to status buffer with message pointer */
1038 #define MESSAGE_TO_STATUS_BUFFER(msg) \
1039 (((unsigned char *)(msg)) + msg->status_buf_offset)
1041 /* get pointer to OOBD buffer with message pointer */
1042 #define MESSAGE_TO_OOBD_BUFFER(msg) \
1043 (((unsigned char *)(msg)) + msg->oob_data_offset)
1045 /* get pointer to data buffer with message pointer */
1046 #define MESSAGE_TO_DATA_BUFFER(msg) \
1047 (((unsigned char *)(msg)) + msg->per_pkt_info_offset)
1049 /* get pointer to contained message from NDIS_MESSAGE pointer */
1050 #define RNDIS_MESSAGE_PTR_TO_MESSAGE_PTR(rndis_msg) \
1051 ((void *) &rndis_msg->msg)
1053 /* get pointer to contained message from NDIS_MESSAGE pointer */
1054 #define RNDIS_MESSAGE_RAW_PTR_TO_MESSAGE_PTR(rndis_msg) \
1055 ((void *) rndis_msg)
1058 #define __struct_bcount(x)
1062 #define RNDIS_HEADER_SIZE (sizeof(struct rndis_message) - \
1063 sizeof(union rndis_message_container))
1065 #define NDIS_PACKET_TYPE_DIRECTED 0x00000001
1066 #define NDIS_PACKET_TYPE_MULTICAST 0x00000002
1067 #define NDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004
1068 #define NDIS_PACKET_TYPE_BROADCAST 0x00000008
1069 #define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
1070 #define NDIS_PACKET_TYPE_PROMISCUOUS 0x00000020
1071 #define NDIS_PACKET_TYPE_SMT 0x00000040
1072 #define NDIS_PACKET_TYPE_ALL_LOCAL 0x00000080
1073 #define NDIS_PACKET_TYPE_GROUP 0x00000100
1074 #define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
1075 #define NDIS_PACKET_TYPE_FUNCTIONAL 0x00000400
1076 #define NDIS_PACKET_TYPE_MAC_FRAME 0x00000800
1080 #endif /* _HYPERV_NET_H */