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