iotests: Drop readlink -f
[qemu/ar7.git] / hw / usb / dev-network.c
blobcd32f57685abf6a1e4166f66a8b39bda899928e5
1 /*
2 * QEMU USB Net devices
4 * Copyright (c) 2006 Thomas Sailer
5 * Copyright (c) 2008 Andrzej Zaborowski
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
26 #include "qemu/osdep.h"
27 #include "qapi/error.h"
28 #include "hw/qdev-properties.h"
29 #include "hw/usb.h"
30 #include "migration/vmstate.h"
31 #include "desc.h"
32 #include "net/net.h"
33 #include "qemu/error-report.h"
34 #include "qemu/queue.h"
35 #include "qemu/config-file.h"
36 #include "sysemu/sysemu.h"
37 #include "qemu/iov.h"
38 #include "qemu/module.h"
39 #include "qemu/cutils.h"
40 #include "qom/object.h"
42 /*#define TRAFFIC_DEBUG*/
43 /* Thanks to NetChip Technologies for donating this product ID.
44 * It's for devices with only CDC Ethernet configurations.
46 #define CDC_VENDOR_NUM 0x0525 /* NetChip */
47 #define CDC_PRODUCT_NUM 0xa4a1 /* Linux-USB Ethernet Gadget */
48 /* For hardware that can talk RNDIS and either of the above protocols,
49 * use this ID ... the windows INF files will know it.
51 #define RNDIS_VENDOR_NUM 0x0525 /* NetChip */
52 #define RNDIS_PRODUCT_NUM 0xa4a2 /* Ethernet/RNDIS Gadget */
54 enum usbstring_idx {
55 STRING_MANUFACTURER = 1,
56 STRING_PRODUCT,
57 STRING_ETHADDR,
58 STRING_DATA,
59 STRING_CONTROL,
60 STRING_RNDIS_CONTROL,
61 STRING_CDC,
62 STRING_SUBSET,
63 STRING_RNDIS,
64 STRING_SERIALNUMBER,
67 #define DEV_CONFIG_VALUE 1 /* CDC or a subset */
68 #define DEV_RNDIS_CONFIG_VALUE 2 /* RNDIS; optional */
70 #define USB_CDC_SUBCLASS_ACM 0x02
71 #define USB_CDC_SUBCLASS_ETHERNET 0x06
73 #define USB_CDC_PROTO_NONE 0
74 #define USB_CDC_ACM_PROTO_VENDOR 0xff
76 #define USB_CDC_HEADER_TYPE 0x00 /* header_desc */
77 #define USB_CDC_CALL_MANAGEMENT_TYPE 0x01 /* call_mgmt_descriptor */
78 #define USB_CDC_ACM_TYPE 0x02 /* acm_descriptor */
79 #define USB_CDC_UNION_TYPE 0x06 /* union_desc */
80 #define USB_CDC_ETHERNET_TYPE 0x0f /* ether_desc */
82 #define USB_CDC_SEND_ENCAPSULATED_COMMAND 0x00
83 #define USB_CDC_GET_ENCAPSULATED_RESPONSE 0x01
84 #define USB_CDC_REQ_SET_LINE_CODING 0x20
85 #define USB_CDC_REQ_GET_LINE_CODING 0x21
86 #define USB_CDC_REQ_SET_CONTROL_LINE_STATE 0x22
87 #define USB_CDC_REQ_SEND_BREAK 0x23
88 #define USB_CDC_SET_ETHERNET_MULTICAST_FILTERS 0x40
89 #define USB_CDC_SET_ETHERNET_PM_PATTERN_FILTER 0x41
90 #define USB_CDC_GET_ETHERNET_PM_PATTERN_FILTER 0x42
91 #define USB_CDC_SET_ETHERNET_PACKET_FILTER 0x43
92 #define USB_CDC_GET_ETHERNET_STATISTIC 0x44
94 #define LOG2_STATUS_INTERVAL_MSEC 5 /* 1 << 5 == 32 msec */
95 #define STATUS_BYTECOUNT 16 /* 8 byte header + data */
97 #define ETH_FRAME_LEN 1514 /* Max. octets in frame sans FCS */
99 static const USBDescStrings usb_net_stringtable = {
100 [STRING_MANUFACTURER] = "QEMU",
101 [STRING_PRODUCT] = "RNDIS/QEMU USB Network Device",
102 [STRING_ETHADDR] = "400102030405",
103 [STRING_DATA] = "QEMU USB Net Data Interface",
104 [STRING_CONTROL] = "QEMU USB Net Control Interface",
105 [STRING_RNDIS_CONTROL] = "QEMU USB Net RNDIS Control Interface",
106 [STRING_CDC] = "QEMU USB Net CDC",
107 [STRING_SUBSET] = "QEMU USB Net Subset",
108 [STRING_RNDIS] = "QEMU USB Net RNDIS",
109 [STRING_SERIALNUMBER] = "1",
112 static const USBDescIface desc_iface_rndis[] = {
114 /* RNDIS Control Interface */
115 .bInterfaceNumber = 0,
116 .bNumEndpoints = 1,
117 .bInterfaceClass = USB_CLASS_COMM,
118 .bInterfaceSubClass = USB_CDC_SUBCLASS_ACM,
119 .bInterfaceProtocol = USB_CDC_ACM_PROTO_VENDOR,
120 .iInterface = STRING_RNDIS_CONTROL,
121 .ndesc = 4,
122 .descs = (USBDescOther[]) {
124 /* Header Descriptor */
125 .data = (uint8_t[]) {
126 0x05, /* u8 bLength */
127 USB_DT_CS_INTERFACE, /* u8 bDescriptorType */
128 USB_CDC_HEADER_TYPE, /* u8 bDescriptorSubType */
129 0x10, 0x01, /* le16 bcdCDC */
132 /* Call Management Descriptor */
133 .data = (uint8_t[]) {
134 0x05, /* u8 bLength */
135 USB_DT_CS_INTERFACE, /* u8 bDescriptorType */
136 USB_CDC_CALL_MANAGEMENT_TYPE, /* u8 bDescriptorSubType */
137 0x00, /* u8 bmCapabilities */
138 0x01, /* u8 bDataInterface */
141 /* ACM Descriptor */
142 .data = (uint8_t[]) {
143 0x04, /* u8 bLength */
144 USB_DT_CS_INTERFACE, /* u8 bDescriptorType */
145 USB_CDC_ACM_TYPE, /* u8 bDescriptorSubType */
146 0x00, /* u8 bmCapabilities */
149 /* Union Descriptor */
150 .data = (uint8_t[]) {
151 0x05, /* u8 bLength */
152 USB_DT_CS_INTERFACE, /* u8 bDescriptorType */
153 USB_CDC_UNION_TYPE, /* u8 bDescriptorSubType */
154 0x00, /* u8 bMasterInterface0 */
155 0x01, /* u8 bSlaveInterface0 */
159 .eps = (USBDescEndpoint[]) {
161 .bEndpointAddress = USB_DIR_IN | 0x01,
162 .bmAttributes = USB_ENDPOINT_XFER_INT,
163 .wMaxPacketSize = STATUS_BYTECOUNT,
164 .bInterval = 1 << LOG2_STATUS_INTERVAL_MSEC,
168 /* RNDIS Data Interface */
169 .bInterfaceNumber = 1,
170 .bNumEndpoints = 2,
171 .bInterfaceClass = USB_CLASS_CDC_DATA,
172 .iInterface = STRING_DATA,
173 .eps = (USBDescEndpoint[]) {
175 .bEndpointAddress = USB_DIR_IN | 0x02,
176 .bmAttributes = USB_ENDPOINT_XFER_BULK,
177 .wMaxPacketSize = 0x40,
179 .bEndpointAddress = USB_DIR_OUT | 0x02,
180 .bmAttributes = USB_ENDPOINT_XFER_BULK,
181 .wMaxPacketSize = 0x40,
187 static const USBDescIface desc_iface_cdc[] = {
189 /* CDC Control Interface */
190 .bInterfaceNumber = 0,
191 .bNumEndpoints = 1,
192 .bInterfaceClass = USB_CLASS_COMM,
193 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
194 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
195 .iInterface = STRING_CONTROL,
196 .ndesc = 3,
197 .descs = (USBDescOther[]) {
199 /* Header Descriptor */
200 .data = (uint8_t[]) {
201 0x05, /* u8 bLength */
202 USB_DT_CS_INTERFACE, /* u8 bDescriptorType */
203 USB_CDC_HEADER_TYPE, /* u8 bDescriptorSubType */
204 0x10, 0x01, /* le16 bcdCDC */
207 /* Union Descriptor */
208 .data = (uint8_t[]) {
209 0x05, /* u8 bLength */
210 USB_DT_CS_INTERFACE, /* u8 bDescriptorType */
211 USB_CDC_UNION_TYPE, /* u8 bDescriptorSubType */
212 0x00, /* u8 bMasterInterface0 */
213 0x01, /* u8 bSlaveInterface0 */
216 /* Ethernet Descriptor */
217 .data = (uint8_t[]) {
218 0x0d, /* u8 bLength */
219 USB_DT_CS_INTERFACE, /* u8 bDescriptorType */
220 USB_CDC_ETHERNET_TYPE, /* u8 bDescriptorSubType */
221 STRING_ETHADDR, /* u8 iMACAddress */
222 0x00, 0x00, 0x00, 0x00, /* le32 bmEthernetStatistics */
223 ETH_FRAME_LEN & 0xff,
224 ETH_FRAME_LEN >> 8, /* le16 wMaxSegmentSize */
225 0x00, 0x00, /* le16 wNumberMCFilters */
226 0x00, /* u8 bNumberPowerFilters */
230 .eps = (USBDescEndpoint[]) {
232 .bEndpointAddress = USB_DIR_IN | 0x01,
233 .bmAttributes = USB_ENDPOINT_XFER_INT,
234 .wMaxPacketSize = STATUS_BYTECOUNT,
235 .bInterval = 1 << LOG2_STATUS_INTERVAL_MSEC,
239 /* CDC Data Interface (off) */
240 .bInterfaceNumber = 1,
241 .bAlternateSetting = 0,
242 .bNumEndpoints = 0,
243 .bInterfaceClass = USB_CLASS_CDC_DATA,
245 /* CDC Data Interface */
246 .bInterfaceNumber = 1,
247 .bAlternateSetting = 1,
248 .bNumEndpoints = 2,
249 .bInterfaceClass = USB_CLASS_CDC_DATA,
250 .iInterface = STRING_DATA,
251 .eps = (USBDescEndpoint[]) {
253 .bEndpointAddress = USB_DIR_IN | 0x02,
254 .bmAttributes = USB_ENDPOINT_XFER_BULK,
255 .wMaxPacketSize = 0x40,
257 .bEndpointAddress = USB_DIR_OUT | 0x02,
258 .bmAttributes = USB_ENDPOINT_XFER_BULK,
259 .wMaxPacketSize = 0x40,
265 static const USBDescDevice desc_device_net = {
266 .bcdUSB = 0x0200,
267 .bDeviceClass = USB_CLASS_COMM,
268 .bMaxPacketSize0 = 0x40,
269 .bNumConfigurations = 2,
270 .confs = (USBDescConfig[]) {
272 .bNumInterfaces = 2,
273 .bConfigurationValue = DEV_RNDIS_CONFIG_VALUE,
274 .iConfiguration = STRING_RNDIS,
275 .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER,
276 .bMaxPower = 0x32,
277 .nif = ARRAY_SIZE(desc_iface_rndis),
278 .ifs = desc_iface_rndis,
280 .bNumInterfaces = 2,
281 .bConfigurationValue = DEV_CONFIG_VALUE,
282 .iConfiguration = STRING_CDC,
283 .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER,
284 .bMaxPower = 0x32,
285 .nif = ARRAY_SIZE(desc_iface_cdc),
286 .ifs = desc_iface_cdc,
291 static const USBDesc desc_net = {
292 .id = {
293 .idVendor = RNDIS_VENDOR_NUM,
294 .idProduct = RNDIS_PRODUCT_NUM,
295 .bcdDevice = 0,
296 .iManufacturer = STRING_MANUFACTURER,
297 .iProduct = STRING_PRODUCT,
298 .iSerialNumber = STRING_SERIALNUMBER,
300 .full = &desc_device_net,
301 .str = usb_net_stringtable,
305 * RNDIS Definitions - in theory not specific to USB.
307 #define RNDIS_MAXIMUM_FRAME_SIZE 1518
308 #define RNDIS_MAX_TOTAL_SIZE 1558
310 /* Remote NDIS Versions */
311 #define RNDIS_MAJOR_VERSION 1
312 #define RNDIS_MINOR_VERSION 0
314 /* Status Values */
315 #define RNDIS_STATUS_SUCCESS 0x00000000U /* Success */
316 #define RNDIS_STATUS_FAILURE 0xc0000001U /* Unspecified error */
317 #define RNDIS_STATUS_INVALID_DATA 0xc0010015U /* Invalid data */
318 #define RNDIS_STATUS_NOT_SUPPORTED 0xc00000bbU /* Unsupported request */
319 #define RNDIS_STATUS_MEDIA_CONNECT 0x4001000bU /* Device connected */
320 #define RNDIS_STATUS_MEDIA_DISCONNECT 0x4001000cU /* Device disconnected */
322 /* Message Set for Connectionless (802.3) Devices */
323 enum {
324 RNDIS_PACKET_MSG = 1,
325 RNDIS_INITIALIZE_MSG = 2, /* Initialize device */
326 RNDIS_HALT_MSG = 3,
327 RNDIS_QUERY_MSG = 4,
328 RNDIS_SET_MSG = 5,
329 RNDIS_RESET_MSG = 6,
330 RNDIS_INDICATE_STATUS_MSG = 7,
331 RNDIS_KEEPALIVE_MSG = 8,
334 /* Message completion */
335 enum {
336 RNDIS_INITIALIZE_CMPLT = 0x80000002U,
337 RNDIS_QUERY_CMPLT = 0x80000004U,
338 RNDIS_SET_CMPLT = 0x80000005U,
339 RNDIS_RESET_CMPLT = 0x80000006U,
340 RNDIS_KEEPALIVE_CMPLT = 0x80000008U,
343 /* Device Flags */
344 enum {
345 RNDIS_DF_CONNECTIONLESS = 1,
346 RNDIS_DF_CONNECTIONORIENTED = 2,
349 #define RNDIS_MEDIUM_802_3 0x00000000U
351 /* from drivers/net/sk98lin/h/skgepnmi.h */
352 #define OID_PNP_CAPABILITIES 0xfd010100
353 #define OID_PNP_SET_POWER 0xfd010101
354 #define OID_PNP_QUERY_POWER 0xfd010102
355 #define OID_PNP_ADD_WAKE_UP_PATTERN 0xfd010103
356 #define OID_PNP_REMOVE_WAKE_UP_PATTERN 0xfd010104
357 #define OID_PNP_ENABLE_WAKE_UP 0xfd010106
359 typedef uint32_t le32;
361 typedef struct rndis_init_msg_type {
362 le32 MessageType;
363 le32 MessageLength;
364 le32 RequestID;
365 le32 MajorVersion;
366 le32 MinorVersion;
367 le32 MaxTransferSize;
368 } rndis_init_msg_type;
370 typedef struct rndis_init_cmplt_type {
371 le32 MessageType;
372 le32 MessageLength;
373 le32 RequestID;
374 le32 Status;
375 le32 MajorVersion;
376 le32 MinorVersion;
377 le32 DeviceFlags;
378 le32 Medium;
379 le32 MaxPacketsPerTransfer;
380 le32 MaxTransferSize;
381 le32 PacketAlignmentFactor;
382 le32 AFListOffset;
383 le32 AFListSize;
384 } rndis_init_cmplt_type;
386 typedef struct rndis_halt_msg_type {
387 le32 MessageType;
388 le32 MessageLength;
389 le32 RequestID;
390 } rndis_halt_msg_type;
392 typedef struct rndis_query_msg_type {
393 le32 MessageType;
394 le32 MessageLength;
395 le32 RequestID;
396 le32 OID;
397 le32 InformationBufferLength;
398 le32 InformationBufferOffset;
399 le32 DeviceVcHandle;
400 } rndis_query_msg_type;
402 typedef struct rndis_query_cmplt_type {
403 le32 MessageType;
404 le32 MessageLength;
405 le32 RequestID;
406 le32 Status;
407 le32 InformationBufferLength;
408 le32 InformationBufferOffset;
409 } rndis_query_cmplt_type;
411 typedef struct rndis_set_msg_type {
412 le32 MessageType;
413 le32 MessageLength;
414 le32 RequestID;
415 le32 OID;
416 le32 InformationBufferLength;
417 le32 InformationBufferOffset;
418 le32 DeviceVcHandle;
419 } rndis_set_msg_type;
421 typedef struct rndis_set_cmplt_type {
422 le32 MessageType;
423 le32 MessageLength;
424 le32 RequestID;
425 le32 Status;
426 } rndis_set_cmplt_type;
428 typedef struct rndis_reset_msg_type {
429 le32 MessageType;
430 le32 MessageLength;
431 le32 Reserved;
432 } rndis_reset_msg_type;
434 typedef struct rndis_reset_cmplt_type {
435 le32 MessageType;
436 le32 MessageLength;
437 le32 Status;
438 le32 AddressingReset;
439 } rndis_reset_cmplt_type;
441 typedef struct rndis_indicate_status_msg_type {
442 le32 MessageType;
443 le32 MessageLength;
444 le32 Status;
445 le32 StatusBufferLength;
446 le32 StatusBufferOffset;
447 } rndis_indicate_status_msg_type;
449 typedef struct rndis_keepalive_msg_type {
450 le32 MessageType;
451 le32 MessageLength;
452 le32 RequestID;
453 } rndis_keepalive_msg_type;
455 typedef struct rndis_keepalive_cmplt_type {
456 le32 MessageType;
457 le32 MessageLength;
458 le32 RequestID;
459 le32 Status;
460 } rndis_keepalive_cmplt_type;
462 struct rndis_packet_msg_type {
463 le32 MessageType;
464 le32 MessageLength;
465 le32 DataOffset;
466 le32 DataLength;
467 le32 OOBDataOffset;
468 le32 OOBDataLength;
469 le32 NumOOBDataElements;
470 le32 PerPacketInfoOffset;
471 le32 PerPacketInfoLength;
472 le32 VcHandle;
473 le32 Reserved;
476 struct rndis_config_parameter {
477 le32 ParameterNameOffset;
478 le32 ParameterNameLength;
479 le32 ParameterType;
480 le32 ParameterValueOffset;
481 le32 ParameterValueLength;
484 /* implementation specific */
485 enum rndis_state
487 RNDIS_UNINITIALIZED,
488 RNDIS_INITIALIZED,
489 RNDIS_DATA_INITIALIZED,
492 /* from ndis.h */
493 enum ndis_oid {
494 /* Required Object IDs (OIDs) */
495 OID_GEN_SUPPORTED_LIST = 0x00010101,
496 OID_GEN_HARDWARE_STATUS = 0x00010102,
497 OID_GEN_MEDIA_SUPPORTED = 0x00010103,
498 OID_GEN_MEDIA_IN_USE = 0x00010104,
499 OID_GEN_MAXIMUM_LOOKAHEAD = 0x00010105,
500 OID_GEN_MAXIMUM_FRAME_SIZE = 0x00010106,
501 OID_GEN_LINK_SPEED = 0x00010107,
502 OID_GEN_TRANSMIT_BUFFER_SPACE = 0x00010108,
503 OID_GEN_RECEIVE_BUFFER_SPACE = 0x00010109,
504 OID_GEN_TRANSMIT_BLOCK_SIZE = 0x0001010a,
505 OID_GEN_RECEIVE_BLOCK_SIZE = 0x0001010b,
506 OID_GEN_VENDOR_ID = 0x0001010c,
507 OID_GEN_VENDOR_DESCRIPTION = 0x0001010d,
508 OID_GEN_CURRENT_PACKET_FILTER = 0x0001010e,
509 OID_GEN_CURRENT_LOOKAHEAD = 0x0001010f,
510 OID_GEN_DRIVER_VERSION = 0x00010110,
511 OID_GEN_MAXIMUM_TOTAL_SIZE = 0x00010111,
512 OID_GEN_PROTOCOL_OPTIONS = 0x00010112,
513 OID_GEN_MAC_OPTIONS = 0x00010113,
514 OID_GEN_MEDIA_CONNECT_STATUS = 0x00010114,
515 OID_GEN_MAXIMUM_SEND_PACKETS = 0x00010115,
516 OID_GEN_VENDOR_DRIVER_VERSION = 0x00010116,
517 OID_GEN_SUPPORTED_GUIDS = 0x00010117,
518 OID_GEN_NETWORK_LAYER_ADDRESSES = 0x00010118,
519 OID_GEN_TRANSPORT_HEADER_OFFSET = 0x00010119,
520 OID_GEN_MACHINE_NAME = 0x0001021a,
521 OID_GEN_RNDIS_CONFIG_PARAMETER = 0x0001021b,
522 OID_GEN_VLAN_ID = 0x0001021c,
524 /* Optional OIDs */
525 OID_GEN_MEDIA_CAPABILITIES = 0x00010201,
526 OID_GEN_PHYSICAL_MEDIUM = 0x00010202,
528 /* Required statistics OIDs */
529 OID_GEN_XMIT_OK = 0x00020101,
530 OID_GEN_RCV_OK = 0x00020102,
531 OID_GEN_XMIT_ERROR = 0x00020103,
532 OID_GEN_RCV_ERROR = 0x00020104,
533 OID_GEN_RCV_NO_BUFFER = 0x00020105,
535 /* Optional statistics OIDs */
536 OID_GEN_DIRECTED_BYTES_XMIT = 0x00020201,
537 OID_GEN_DIRECTED_FRAMES_XMIT = 0x00020202,
538 OID_GEN_MULTICAST_BYTES_XMIT = 0x00020203,
539 OID_GEN_MULTICAST_FRAMES_XMIT = 0x00020204,
540 OID_GEN_BROADCAST_BYTES_XMIT = 0x00020205,
541 OID_GEN_BROADCAST_FRAMES_XMIT = 0x00020206,
542 OID_GEN_DIRECTED_BYTES_RCV = 0x00020207,
543 OID_GEN_DIRECTED_FRAMES_RCV = 0x00020208,
544 OID_GEN_MULTICAST_BYTES_RCV = 0x00020209,
545 OID_GEN_MULTICAST_FRAMES_RCV = 0x0002020a,
546 OID_GEN_BROADCAST_BYTES_RCV = 0x0002020b,
547 OID_GEN_BROADCAST_FRAMES_RCV = 0x0002020c,
548 OID_GEN_RCV_CRC_ERROR = 0x0002020d,
549 OID_GEN_TRANSMIT_QUEUE_LENGTH = 0x0002020e,
550 OID_GEN_GET_TIME_CAPS = 0x0002020f,
551 OID_GEN_GET_NETCARD_TIME = 0x00020210,
552 OID_GEN_NETCARD_LOAD = 0x00020211,
553 OID_GEN_DEVICE_PROFILE = 0x00020212,
554 OID_GEN_INIT_TIME_MS = 0x00020213,
555 OID_GEN_RESET_COUNTS = 0x00020214,
556 OID_GEN_MEDIA_SENSE_COUNTS = 0x00020215,
557 OID_GEN_FRIENDLY_NAME = 0x00020216,
558 OID_GEN_MINIPORT_INFO = 0x00020217,
559 OID_GEN_RESET_VERIFY_PARAMETERS = 0x00020218,
561 /* IEEE 802.3 (Ethernet) OIDs */
562 OID_802_3_PERMANENT_ADDRESS = 0x01010101,
563 OID_802_3_CURRENT_ADDRESS = 0x01010102,
564 OID_802_3_MULTICAST_LIST = 0x01010103,
565 OID_802_3_MAXIMUM_LIST_SIZE = 0x01010104,
566 OID_802_3_MAC_OPTIONS = 0x01010105,
567 OID_802_3_RCV_ERROR_ALIGNMENT = 0x01020101,
568 OID_802_3_XMIT_ONE_COLLISION = 0x01020102,
569 OID_802_3_XMIT_MORE_COLLISIONS = 0x01020103,
570 OID_802_3_XMIT_DEFERRED = 0x01020201,
571 OID_802_3_XMIT_MAX_COLLISIONS = 0x01020202,
572 OID_802_3_RCV_OVERRUN = 0x01020203,
573 OID_802_3_XMIT_UNDERRUN = 0x01020204,
574 OID_802_3_XMIT_HEARTBEAT_FAILURE = 0x01020205,
575 OID_802_3_XMIT_TIMES_CRS_LOST = 0x01020206,
576 OID_802_3_XMIT_LATE_COLLISIONS = 0x01020207,
579 static const uint32_t oid_supported_list[] =
581 /* the general stuff */
582 OID_GEN_SUPPORTED_LIST,
583 OID_GEN_HARDWARE_STATUS,
584 OID_GEN_MEDIA_SUPPORTED,
585 OID_GEN_MEDIA_IN_USE,
586 OID_GEN_MAXIMUM_FRAME_SIZE,
587 OID_GEN_LINK_SPEED,
588 OID_GEN_TRANSMIT_BLOCK_SIZE,
589 OID_GEN_RECEIVE_BLOCK_SIZE,
590 OID_GEN_VENDOR_ID,
591 OID_GEN_VENDOR_DESCRIPTION,
592 OID_GEN_VENDOR_DRIVER_VERSION,
593 OID_GEN_CURRENT_PACKET_FILTER,
594 OID_GEN_MAXIMUM_TOTAL_SIZE,
595 OID_GEN_MEDIA_CONNECT_STATUS,
596 OID_GEN_PHYSICAL_MEDIUM,
598 /* the statistical stuff */
599 OID_GEN_XMIT_OK,
600 OID_GEN_RCV_OK,
601 OID_GEN_XMIT_ERROR,
602 OID_GEN_RCV_ERROR,
603 OID_GEN_RCV_NO_BUFFER,
605 /* IEEE 802.3 */
606 /* the general stuff */
607 OID_802_3_PERMANENT_ADDRESS,
608 OID_802_3_CURRENT_ADDRESS,
609 OID_802_3_MULTICAST_LIST,
610 OID_802_3_MAC_OPTIONS,
611 OID_802_3_MAXIMUM_LIST_SIZE,
613 /* the statistical stuff */
614 OID_802_3_RCV_ERROR_ALIGNMENT,
615 OID_802_3_XMIT_ONE_COLLISION,
616 OID_802_3_XMIT_MORE_COLLISIONS,
619 #define NDIS_MAC_OPTION_COPY_LOOKAHEAD_DATA (1 << 0)
620 #define NDIS_MAC_OPTION_RECEIVE_SERIALIZED (1 << 1)
621 #define NDIS_MAC_OPTION_TRANSFERS_NOT_PEND (1 << 2)
622 #define NDIS_MAC_OPTION_NO_LOOPBACK (1 << 3)
623 #define NDIS_MAC_OPTION_FULL_DUPLEX (1 << 4)
624 #define NDIS_MAC_OPTION_EOTX_INDICATION (1 << 5)
625 #define NDIS_MAC_OPTION_8021P_PRIORITY (1 << 6)
627 struct rndis_response {
628 QTAILQ_ENTRY(rndis_response) entries;
629 uint32_t length;
630 uint8_t buf[];
633 struct USBNetState {
634 USBDevice dev;
636 enum rndis_state rndis_state;
637 uint32_t medium;
638 uint32_t speed;
639 uint32_t media_state;
640 uint16_t filter;
641 uint32_t vendorid;
643 unsigned int out_ptr;
644 uint8_t out_buf[2048];
646 unsigned int in_ptr, in_len;
647 uint8_t in_buf[2048];
649 USBEndpoint *intr;
651 char usbstring_mac[13];
652 NICState *nic;
653 NICConf conf;
654 QTAILQ_HEAD(, rndis_response) rndis_resp;
656 typedef struct USBNetState USBNetState;
658 #define TYPE_USB_NET "usb-net"
659 DECLARE_INSTANCE_CHECKER(USBNetState, USB_NET,
660 TYPE_USB_NET)
662 static int is_rndis(USBNetState *s)
664 return s->dev.config ?
665 s->dev.config->bConfigurationValue == DEV_RNDIS_CONFIG_VALUE : 0;
668 static int ndis_query(USBNetState *s, uint32_t oid,
669 uint8_t *inbuf, unsigned int inlen, uint8_t *outbuf,
670 size_t outlen)
672 unsigned int i;
674 switch (oid) {
675 /* general oids (table 4-1) */
676 /* mandatory */
677 case OID_GEN_SUPPORTED_LIST:
678 for (i = 0; i < ARRAY_SIZE(oid_supported_list); i++) {
679 stl_le_p(outbuf + (i * sizeof(le32)), oid_supported_list[i]);
681 return sizeof(oid_supported_list);
683 /* mandatory */
684 case OID_GEN_HARDWARE_STATUS:
685 stl_le_p(outbuf, 0);
686 return sizeof(le32);
688 /* mandatory */
689 case OID_GEN_MEDIA_SUPPORTED:
690 stl_le_p(outbuf, s->medium);
691 return sizeof(le32);
693 /* mandatory */
694 case OID_GEN_MEDIA_IN_USE:
695 stl_le_p(outbuf, s->medium);
696 return sizeof(le32);
698 /* mandatory */
699 case OID_GEN_MAXIMUM_FRAME_SIZE:
700 stl_le_p(outbuf, ETH_FRAME_LEN);
701 return sizeof(le32);
703 /* mandatory */
704 case OID_GEN_LINK_SPEED:
705 stl_le_p(outbuf, s->speed);
706 return sizeof(le32);
708 /* mandatory */
709 case OID_GEN_TRANSMIT_BLOCK_SIZE:
710 stl_le_p(outbuf, ETH_FRAME_LEN);
711 return sizeof(le32);
713 /* mandatory */
714 case OID_GEN_RECEIVE_BLOCK_SIZE:
715 stl_le_p(outbuf, ETH_FRAME_LEN);
716 return sizeof(le32);
718 /* mandatory */
719 case OID_GEN_VENDOR_ID:
720 stl_le_p(outbuf, s->vendorid);
721 return sizeof(le32);
723 /* mandatory */
724 case OID_GEN_VENDOR_DESCRIPTION:
725 pstrcpy((char *)outbuf, outlen, "QEMU USB RNDIS Net");
726 return strlen((char *)outbuf) + 1;
728 case OID_GEN_VENDOR_DRIVER_VERSION:
729 stl_le_p(outbuf, 1);
730 return sizeof(le32);
732 /* mandatory */
733 case OID_GEN_CURRENT_PACKET_FILTER:
734 stl_le_p(outbuf, s->filter);
735 return sizeof(le32);
737 /* mandatory */
738 case OID_GEN_MAXIMUM_TOTAL_SIZE:
739 stl_le_p(outbuf, RNDIS_MAX_TOTAL_SIZE);
740 return sizeof(le32);
742 /* mandatory */
743 case OID_GEN_MEDIA_CONNECT_STATUS:
744 stl_le_p(outbuf, s->media_state);
745 return sizeof(le32);
747 case OID_GEN_PHYSICAL_MEDIUM:
748 stl_le_p(outbuf, 0);
749 return sizeof(le32);
751 case OID_GEN_MAC_OPTIONS:
752 stl_le_p(outbuf, NDIS_MAC_OPTION_RECEIVE_SERIALIZED |
753 NDIS_MAC_OPTION_FULL_DUPLEX);
754 return sizeof(le32);
756 /* statistics OIDs (table 4-2) */
757 /* mandatory */
758 case OID_GEN_XMIT_OK:
759 stl_le_p(outbuf, 0);
760 return sizeof(le32);
762 /* mandatory */
763 case OID_GEN_RCV_OK:
764 stl_le_p(outbuf, 0);
765 return sizeof(le32);
767 /* mandatory */
768 case OID_GEN_XMIT_ERROR:
769 stl_le_p(outbuf, 0);
770 return sizeof(le32);
772 /* mandatory */
773 case OID_GEN_RCV_ERROR:
774 stl_le_p(outbuf, 0);
775 return sizeof(le32);
777 /* mandatory */
778 case OID_GEN_RCV_NO_BUFFER:
779 stl_le_p(outbuf, 0);
780 return sizeof(le32);
782 /* ieee802.3 OIDs (table 4-3) */
783 /* mandatory */
784 case OID_802_3_PERMANENT_ADDRESS:
785 memcpy(outbuf, s->conf.macaddr.a, 6);
786 return 6;
788 /* mandatory */
789 case OID_802_3_CURRENT_ADDRESS:
790 memcpy(outbuf, s->conf.macaddr.a, 6);
791 return 6;
793 /* mandatory */
794 case OID_802_3_MULTICAST_LIST:
795 stl_le_p(outbuf, 0xe0000000);
796 return sizeof(le32);
798 /* mandatory */
799 case OID_802_3_MAXIMUM_LIST_SIZE:
800 stl_le_p(outbuf, 1);
801 return sizeof(le32);
803 case OID_802_3_MAC_OPTIONS:
804 return 0;
806 /* ieee802.3 statistics OIDs (table 4-4) */
807 /* mandatory */
808 case OID_802_3_RCV_ERROR_ALIGNMENT:
809 stl_le_p(outbuf, 0);
810 return sizeof(le32);
812 /* mandatory */
813 case OID_802_3_XMIT_ONE_COLLISION:
814 stl_le_p(outbuf, 0);
815 return sizeof(le32);
817 /* mandatory */
818 case OID_802_3_XMIT_MORE_COLLISIONS:
819 stl_le_p(outbuf, 0);
820 return sizeof(le32);
822 default:
823 fprintf(stderr, "usbnet: unknown OID 0x%08x\n", oid);
824 return 0;
826 return -1;
829 static int ndis_set(USBNetState *s, uint32_t oid,
830 uint8_t *inbuf, unsigned int inlen)
832 switch (oid) {
833 case OID_GEN_CURRENT_PACKET_FILTER:
834 s->filter = ldl_le_p(inbuf);
835 if (s->filter) {
836 s->rndis_state = RNDIS_DATA_INITIALIZED;
837 } else {
838 s->rndis_state = RNDIS_INITIALIZED;
840 return 0;
842 case OID_802_3_MULTICAST_LIST:
843 return 0;
845 return -1;
848 static int rndis_get_response(USBNetState *s, uint8_t *buf)
850 int ret = 0;
851 struct rndis_response *r = s->rndis_resp.tqh_first;
853 if (!r)
854 return ret;
856 QTAILQ_REMOVE(&s->rndis_resp, r, entries);
857 ret = r->length;
858 memcpy(buf, r->buf, r->length);
859 g_free(r);
861 return ret;
864 static void *rndis_queue_response(USBNetState *s, unsigned int length)
866 struct rndis_response *r =
867 g_malloc0(sizeof(struct rndis_response) + length);
869 if (QTAILQ_EMPTY(&s->rndis_resp)) {
870 usb_wakeup(s->intr, 0);
873 QTAILQ_INSERT_TAIL(&s->rndis_resp, r, entries);
874 r->length = length;
876 return &r->buf[0];
879 static void rndis_clear_responsequeue(USBNetState *s)
881 struct rndis_response *r;
883 while ((r = s->rndis_resp.tqh_first)) {
884 QTAILQ_REMOVE(&s->rndis_resp, r, entries);
885 g_free(r);
889 static int rndis_init_response(USBNetState *s, rndis_init_msg_type *buf)
891 rndis_init_cmplt_type *resp =
892 rndis_queue_response(s, sizeof(rndis_init_cmplt_type));
894 if (!resp)
895 return USB_RET_STALL;
897 resp->MessageType = cpu_to_le32(RNDIS_INITIALIZE_CMPLT);
898 resp->MessageLength = cpu_to_le32(sizeof(rndis_init_cmplt_type));
899 resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
900 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
901 resp->MajorVersion = cpu_to_le32(RNDIS_MAJOR_VERSION);
902 resp->MinorVersion = cpu_to_le32(RNDIS_MINOR_VERSION);
903 resp->DeviceFlags = cpu_to_le32(RNDIS_DF_CONNECTIONLESS);
904 resp->Medium = cpu_to_le32(RNDIS_MEDIUM_802_3);
905 resp->MaxPacketsPerTransfer = cpu_to_le32(1);
906 resp->MaxTransferSize = cpu_to_le32(ETH_FRAME_LEN +
907 sizeof(struct rndis_packet_msg_type) + 22);
908 resp->PacketAlignmentFactor = cpu_to_le32(0);
909 resp->AFListOffset = cpu_to_le32(0);
910 resp->AFListSize = cpu_to_le32(0);
911 return 0;
914 static int rndis_query_response(USBNetState *s,
915 rndis_query_msg_type *buf, unsigned int length)
917 rndis_query_cmplt_type *resp;
918 /* oid_supported_list is the largest data reply */
919 uint8_t infobuf[sizeof(oid_supported_list)];
920 uint32_t bufoffs, buflen;
921 int infobuflen;
922 unsigned int resplen;
924 bufoffs = le32_to_cpu(buf->InformationBufferOffset) + 8;
925 buflen = le32_to_cpu(buf->InformationBufferLength);
926 if (buflen > length || bufoffs >= length || bufoffs + buflen > length) {
927 return USB_RET_STALL;
930 infobuflen = ndis_query(s, le32_to_cpu(buf->OID),
931 bufoffs + (uint8_t *) buf, buflen, infobuf,
932 sizeof(infobuf));
933 resplen = sizeof(rndis_query_cmplt_type) +
934 ((infobuflen < 0) ? 0 : infobuflen);
935 resp = rndis_queue_response(s, resplen);
936 if (!resp)
937 return USB_RET_STALL;
939 resp->MessageType = cpu_to_le32(RNDIS_QUERY_CMPLT);
940 resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
941 resp->MessageLength = cpu_to_le32(resplen);
943 if (infobuflen < 0) {
944 /* OID not supported */
945 resp->Status = cpu_to_le32(RNDIS_STATUS_NOT_SUPPORTED);
946 resp->InformationBufferLength = cpu_to_le32(0);
947 resp->InformationBufferOffset = cpu_to_le32(0);
948 return 0;
951 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
952 resp->InformationBufferOffset =
953 cpu_to_le32(infobuflen ? sizeof(rndis_query_cmplt_type) - 8 : 0);
954 resp->InformationBufferLength = cpu_to_le32(infobuflen);
955 memcpy(resp + 1, infobuf, infobuflen);
957 return 0;
960 static int rndis_set_response(USBNetState *s,
961 rndis_set_msg_type *buf, unsigned int length)
963 rndis_set_cmplt_type *resp =
964 rndis_queue_response(s, sizeof(rndis_set_cmplt_type));
965 uint32_t bufoffs, buflen;
966 int ret;
968 if (!resp)
969 return USB_RET_STALL;
971 bufoffs = le32_to_cpu(buf->InformationBufferOffset) + 8;
972 buflen = le32_to_cpu(buf->InformationBufferLength);
973 if (buflen > length || bufoffs >= length || bufoffs + buflen > length) {
974 return USB_RET_STALL;
977 ret = ndis_set(s, le32_to_cpu(buf->OID),
978 bufoffs + (uint8_t *) buf, buflen);
979 resp->MessageType = cpu_to_le32(RNDIS_SET_CMPLT);
980 resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
981 resp->MessageLength = cpu_to_le32(sizeof(rndis_set_cmplt_type));
982 if (ret < 0) {
983 /* OID not supported */
984 resp->Status = cpu_to_le32(RNDIS_STATUS_NOT_SUPPORTED);
985 return 0;
987 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
989 return 0;
992 static int rndis_reset_response(USBNetState *s, rndis_reset_msg_type *buf)
994 rndis_reset_cmplt_type *resp =
995 rndis_queue_response(s, sizeof(rndis_reset_cmplt_type));
997 if (!resp)
998 return USB_RET_STALL;
1000 resp->MessageType = cpu_to_le32(RNDIS_RESET_CMPLT);
1001 resp->MessageLength = cpu_to_le32(sizeof(rndis_reset_cmplt_type));
1002 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
1003 resp->AddressingReset = cpu_to_le32(1); /* reset information */
1005 return 0;
1008 static int rndis_keepalive_response(USBNetState *s,
1009 rndis_keepalive_msg_type *buf)
1011 rndis_keepalive_cmplt_type *resp =
1012 rndis_queue_response(s, sizeof(rndis_keepalive_cmplt_type));
1014 if (!resp)
1015 return USB_RET_STALL;
1017 resp->MessageType = cpu_to_le32(RNDIS_KEEPALIVE_CMPLT);
1018 resp->MessageLength = cpu_to_le32(sizeof(rndis_keepalive_cmplt_type));
1019 resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
1020 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
1022 return 0;
1025 /* Prepare to receive the next packet */
1026 static void usb_net_reset_in_buf(USBNetState *s)
1028 s->in_ptr = s->in_len = 0;
1029 qemu_flush_queued_packets(qemu_get_queue(s->nic));
1032 static int rndis_parse(USBNetState *s, uint8_t *data, int length)
1034 uint32_t msg_type = ldl_le_p(data);
1036 switch (msg_type) {
1037 case RNDIS_INITIALIZE_MSG:
1038 s->rndis_state = RNDIS_INITIALIZED;
1039 return rndis_init_response(s, (rndis_init_msg_type *) data);
1041 case RNDIS_HALT_MSG:
1042 s->rndis_state = RNDIS_UNINITIALIZED;
1043 return 0;
1045 case RNDIS_QUERY_MSG:
1046 return rndis_query_response(s, (rndis_query_msg_type *) data, length);
1048 case RNDIS_SET_MSG:
1049 return rndis_set_response(s, (rndis_set_msg_type *) data, length);
1051 case RNDIS_RESET_MSG:
1052 rndis_clear_responsequeue(s);
1053 s->out_ptr = 0;
1054 usb_net_reset_in_buf(s);
1055 return rndis_reset_response(s, (rndis_reset_msg_type *) data);
1057 case RNDIS_KEEPALIVE_MSG:
1058 /* For USB: host does this every 5 seconds */
1059 return rndis_keepalive_response(s, (rndis_keepalive_msg_type *) data);
1062 return USB_RET_STALL;
1065 static void usb_net_handle_reset(USBDevice *dev)
1069 static void usb_net_handle_control(USBDevice *dev, USBPacket *p,
1070 int request, int value, int index, int length, uint8_t *data)
1072 USBNetState *s = (USBNetState *) dev;
1073 int ret;
1075 ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
1076 if (ret >= 0) {
1077 return;
1080 switch(request) {
1081 case ClassInterfaceOutRequest | USB_CDC_SEND_ENCAPSULATED_COMMAND:
1082 if (!is_rndis(s) || value || index != 0) {
1083 goto fail;
1085 #ifdef TRAFFIC_DEBUG
1087 unsigned int i;
1088 fprintf(stderr, "SEND_ENCAPSULATED_COMMAND:");
1089 for (i = 0; i < length; i++) {
1090 if (!(i & 15))
1091 fprintf(stderr, "\n%04x:", i);
1092 fprintf(stderr, " %02x", data[i]);
1094 fprintf(stderr, "\n\n");
1096 #endif
1097 ret = rndis_parse(s, data, length);
1098 if (ret < 0) {
1099 p->status = ret;
1101 break;
1103 case ClassInterfaceRequest | USB_CDC_GET_ENCAPSULATED_RESPONSE:
1104 if (!is_rndis(s) || value || index != 0) {
1105 goto fail;
1107 p->actual_length = rndis_get_response(s, data);
1108 if (p->actual_length == 0) {
1109 data[0] = 0;
1110 p->actual_length = 1;
1112 #ifdef TRAFFIC_DEBUG
1114 unsigned int i;
1115 fprintf(stderr, "GET_ENCAPSULATED_RESPONSE:");
1116 for (i = 0; i < p->actual_length; i++) {
1117 if (!(i & 15))
1118 fprintf(stderr, "\n%04x:", i);
1119 fprintf(stderr, " %02x", data[i]);
1121 fprintf(stderr, "\n\n");
1123 #endif
1124 break;
1126 default:
1127 fail:
1128 fprintf(stderr, "usbnet: failed control transaction: "
1129 "request 0x%x value 0x%x index 0x%x length 0x%x\n",
1130 request, value, index, length);
1131 p->status = USB_RET_STALL;
1132 break;
1136 static void usb_net_handle_statusin(USBNetState *s, USBPacket *p)
1138 le32 buf[2];
1140 if (p->iov.size < 8) {
1141 p->status = USB_RET_STALL;
1142 return;
1145 buf[0] = cpu_to_le32(1);
1146 buf[1] = cpu_to_le32(0);
1147 usb_packet_copy(p, buf, 8);
1148 if (!s->rndis_resp.tqh_first) {
1149 p->status = USB_RET_NAK;
1152 #ifdef TRAFFIC_DEBUG
1153 fprintf(stderr, "usbnet: interrupt poll len %zu return %d",
1154 p->iov.size, p->status);
1155 iov_hexdump(p->iov.iov, p->iov.niov, stderr, "usbnet", p->status);
1156 #endif
1159 static void usb_net_handle_datain(USBNetState *s, USBPacket *p)
1161 int len;
1163 if (s->in_ptr > s->in_len) {
1164 usb_net_reset_in_buf(s);
1165 p->status = USB_RET_NAK;
1166 return;
1168 if (!s->in_len) {
1169 p->status = USB_RET_NAK;
1170 return;
1172 len = s->in_len - s->in_ptr;
1173 if (len > p->iov.size) {
1174 len = p->iov.size;
1176 usb_packet_copy(p, &s->in_buf[s->in_ptr], len);
1177 s->in_ptr += len;
1178 if (s->in_ptr >= s->in_len &&
1179 (is_rndis(s) || (s->in_len & (64 - 1)) || !len)) {
1180 /* no short packet necessary */
1181 usb_net_reset_in_buf(s);
1184 #ifdef TRAFFIC_DEBUG
1185 fprintf(stderr, "usbnet: data in len %zu return %d", p->iov.size, len);
1186 iov_hexdump(p->iov.iov, p->iov.niov, stderr, "usbnet", len);
1187 #endif
1190 static void usb_net_handle_dataout(USBNetState *s, USBPacket *p)
1192 int sz = sizeof(s->out_buf) - s->out_ptr;
1193 struct rndis_packet_msg_type *msg =
1194 (struct rndis_packet_msg_type *) s->out_buf;
1195 uint32_t len;
1197 #ifdef TRAFFIC_DEBUG
1198 fprintf(stderr, "usbnet: data out len %zu\n", p->iov.size);
1199 iov_hexdump(p->iov.iov, p->iov.niov, stderr, "usbnet", p->iov.size);
1200 #endif
1202 if (sz > p->iov.size) {
1203 sz = p->iov.size;
1205 usb_packet_copy(p, &s->out_buf[s->out_ptr], sz);
1206 s->out_ptr += sz;
1208 if (!is_rndis(s)) {
1209 if (p->iov.size < 64) {
1210 qemu_send_packet(qemu_get_queue(s->nic), s->out_buf, s->out_ptr);
1211 s->out_ptr = 0;
1213 return;
1215 len = le32_to_cpu(msg->MessageLength);
1216 if (s->out_ptr < 8 || s->out_ptr < len) {
1217 return;
1219 if (le32_to_cpu(msg->MessageType) == RNDIS_PACKET_MSG) {
1220 uint32_t offs = 8 + le32_to_cpu(msg->DataOffset);
1221 uint32_t size = le32_to_cpu(msg->DataLength);
1222 if (offs < len && size < len && offs + size <= len) {
1223 qemu_send_packet(qemu_get_queue(s->nic), s->out_buf + offs, size);
1226 s->out_ptr -= len;
1227 memmove(s->out_buf, &s->out_buf[len], s->out_ptr);
1230 static void usb_net_handle_data(USBDevice *dev, USBPacket *p)
1232 USBNetState *s = (USBNetState *) dev;
1234 switch(p->pid) {
1235 case USB_TOKEN_IN:
1236 switch (p->ep->nr) {
1237 case 1:
1238 usb_net_handle_statusin(s, p);
1239 break;
1241 case 2:
1242 usb_net_handle_datain(s, p);
1243 break;
1245 default:
1246 goto fail;
1248 break;
1250 case USB_TOKEN_OUT:
1251 switch (p->ep->nr) {
1252 case 2:
1253 usb_net_handle_dataout(s, p);
1254 break;
1256 default:
1257 goto fail;
1259 break;
1261 default:
1262 fail:
1263 p->status = USB_RET_STALL;
1264 break;
1267 if (p->status == USB_RET_STALL) {
1268 fprintf(stderr, "usbnet: failed data transaction: "
1269 "pid 0x%x ep 0x%x len 0x%zx\n",
1270 p->pid, p->ep->nr, p->iov.size);
1274 static ssize_t usbnet_receive(NetClientState *nc, const uint8_t *buf, size_t size)
1276 USBNetState *s = qemu_get_nic_opaque(nc);
1277 uint8_t *in_buf = s->in_buf;
1278 size_t total_size = size;
1280 if (!s->dev.config) {
1281 return -1;
1284 if (is_rndis(s)) {
1285 if (s->rndis_state != RNDIS_DATA_INITIALIZED) {
1286 return -1;
1288 total_size += sizeof(struct rndis_packet_msg_type);
1290 if (total_size > sizeof(s->in_buf)) {
1291 return -1;
1294 /* Only accept packet if input buffer is empty */
1295 if (s->in_len > 0) {
1296 return 0;
1299 if (is_rndis(s)) {
1300 struct rndis_packet_msg_type *msg;
1302 msg = (struct rndis_packet_msg_type *)in_buf;
1303 memset(msg, 0, sizeof(struct rndis_packet_msg_type));
1304 msg->MessageType = cpu_to_le32(RNDIS_PACKET_MSG);
1305 msg->MessageLength = cpu_to_le32(size + sizeof(*msg));
1306 msg->DataOffset = cpu_to_le32(sizeof(*msg) - 8);
1307 msg->DataLength = cpu_to_le32(size);
1308 /* msg->OOBDataOffset;
1309 * msg->OOBDataLength;
1310 * msg->NumOOBDataElements;
1311 * msg->PerPacketInfoOffset;
1312 * msg->PerPacketInfoLength;
1313 * msg->VcHandle;
1314 * msg->Reserved;
1316 in_buf += sizeof(*msg);
1319 memcpy(in_buf, buf, size);
1320 s->in_len = total_size;
1321 s->in_ptr = 0;
1322 return size;
1325 static void usbnet_cleanup(NetClientState *nc)
1327 USBNetState *s = qemu_get_nic_opaque(nc);
1329 s->nic = NULL;
1332 static void usb_net_unrealize(USBDevice *dev)
1334 USBNetState *s = (USBNetState *) dev;
1336 /* TODO: remove the nd_table[] entry */
1337 rndis_clear_responsequeue(s);
1338 qemu_del_nic(s->nic);
1341 static NetClientInfo net_usbnet_info = {
1342 .type = NET_CLIENT_DRIVER_NIC,
1343 .size = sizeof(NICState),
1344 .receive = usbnet_receive,
1345 .cleanup = usbnet_cleanup,
1348 static void usb_net_realize(USBDevice *dev, Error **errp)
1350 USBNetState *s = USB_NET(dev);
1352 usb_desc_create_serial(dev);
1353 usb_desc_init(dev);
1355 s->rndis_state = RNDIS_UNINITIALIZED;
1356 QTAILQ_INIT(&s->rndis_resp);
1358 s->medium = 0; /* NDIS_MEDIUM_802_3 */
1359 s->speed = 1000000; /* 100MBps, in 100Bps units */
1360 s->media_state = 0; /* NDIS_MEDIA_STATE_CONNECTED */;
1361 s->filter = 0;
1362 s->vendorid = 0x1234;
1363 s->intr = usb_ep_get(dev, USB_TOKEN_IN, 1);
1365 qemu_macaddr_default_if_unset(&s->conf.macaddr);
1366 s->nic = qemu_new_nic(&net_usbnet_info, &s->conf,
1367 object_get_typename(OBJECT(s)), s->dev.qdev.id, s);
1368 qemu_format_nic_info_str(qemu_get_queue(s->nic), s->conf.macaddr.a);
1369 snprintf(s->usbstring_mac, sizeof(s->usbstring_mac),
1370 "%02x%02x%02x%02x%02x%02x",
1371 0x40,
1372 s->conf.macaddr.a[1],
1373 s->conf.macaddr.a[2],
1374 s->conf.macaddr.a[3],
1375 s->conf.macaddr.a[4],
1376 s->conf.macaddr.a[5]);
1377 usb_desc_set_string(dev, STRING_ETHADDR, s->usbstring_mac);
1380 static void usb_net_instance_init(Object *obj)
1382 USBDevice *dev = USB_DEVICE(obj);
1383 USBNetState *s = USB_NET(dev);
1385 device_add_bootindex_property(obj, &s->conf.bootindex,
1386 "bootindex", "/ethernet-phy@0",
1387 &dev->qdev);
1390 static const VMStateDescription vmstate_usb_net = {
1391 .name = "usb-net",
1392 .unmigratable = 1,
1395 static Property net_properties[] = {
1396 DEFINE_NIC_PROPERTIES(USBNetState, conf),
1397 DEFINE_PROP_END_OF_LIST(),
1400 static void usb_net_class_initfn(ObjectClass *klass, void *data)
1402 DeviceClass *dc = DEVICE_CLASS(klass);
1403 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
1405 uc->realize = usb_net_realize;
1406 uc->product_desc = "QEMU USB Network Interface";
1407 uc->usb_desc = &desc_net;
1408 uc->handle_reset = usb_net_handle_reset;
1409 uc->handle_control = usb_net_handle_control;
1410 uc->handle_data = usb_net_handle_data;
1411 uc->unrealize = usb_net_unrealize;
1412 set_bit(DEVICE_CATEGORY_NETWORK, dc->categories);
1413 dc->fw_name = "network";
1414 dc->vmsd = &vmstate_usb_net;
1415 device_class_set_props(dc, net_properties);
1418 static const TypeInfo net_info = {
1419 .name = TYPE_USB_NET,
1420 .parent = TYPE_USB_DEVICE,
1421 .instance_size = sizeof(USBNetState),
1422 .class_init = usb_net_class_initfn,
1423 .instance_init = usb_net_instance_init,
1426 static void usb_net_register_types(void)
1428 type_register_static(&net_info);
1431 type_init(usb_net_register_types)