root / hw / virtio-net.h @ dd4239d6
History | View | Annotate | Download (5.5 kB)
1 | fbe78f4f | aliguori | /*
|
---|---|---|---|
2 | fbe78f4f | aliguori | * Virtio Network Device
|
3 | fbe78f4f | aliguori | *
|
4 | fbe78f4f | aliguori | * Copyright IBM, Corp. 2007
|
5 | fbe78f4f | aliguori | *
|
6 | fbe78f4f | aliguori | * Authors:
|
7 | fbe78f4f | aliguori | * Anthony Liguori <aliguori@us.ibm.com>
|
8 | fbe78f4f | aliguori | *
|
9 | fbe78f4f | aliguori | * This work is licensed under the terms of the GNU GPL, version 2. See
|
10 | fbe78f4f | aliguori | * the COPYING file in the top-level directory.
|
11 | fbe78f4f | aliguori | *
|
12 | fbe78f4f | aliguori | */
|
13 | fbe78f4f | aliguori | |
14 | fbe78f4f | aliguori | #ifndef _QEMU_VIRTIO_NET_H
|
15 | fbe78f4f | aliguori | #define _QEMU_VIRTIO_NET_H
|
16 | fbe78f4f | aliguori | |
17 | fbe78f4f | aliguori | #include "virtio.h" |
18 | fbe78f4f | aliguori | #include "net.h" |
19 | fbe78f4f | aliguori | #include "pci.h" |
20 | fbe78f4f | aliguori | |
21 | 79674068 | aliguori | #define ETH_ALEN 6 |
22 | 79674068 | aliguori | |
23 | fbe78f4f | aliguori | /* from Linux's virtio_net.h */
|
24 | fbe78f4f | aliguori | |
25 | fbe78f4f | aliguori | /* The ID for virtio_net */
|
26 | fbe78f4f | aliguori | #define VIRTIO_ID_NET 1 |
27 | fbe78f4f | aliguori | |
28 | fbe78f4f | aliguori | /* The feature bitmap for virtio net */
|
29 | fbe78f4f | aliguori | #define VIRTIO_NET_F_CSUM 0 /* Host handles pkts w/ partial csum */ |
30 | fbe78f4f | aliguori | #define VIRTIO_NET_F_GUEST_CSUM 1 /* Guest handles pkts w/ partial csum */ |
31 | fbe78f4f | aliguori | #define VIRTIO_NET_F_MAC 5 /* Host has given MAC address. */ |
32 | fbe78f4f | aliguori | #define VIRTIO_NET_F_GSO 6 /* Host handles pkts w/ any GSO type */ |
33 | fbe78f4f | aliguori | #define VIRTIO_NET_F_GUEST_TSO4 7 /* Guest can handle TSOv4 in. */ |
34 | fbe78f4f | aliguori | #define VIRTIO_NET_F_GUEST_TSO6 8 /* Guest can handle TSOv6 in. */ |
35 | fbe78f4f | aliguori | #define VIRTIO_NET_F_GUEST_ECN 9 /* Guest can handle TSO[6] w/ ECN in. */ |
36 | fbe78f4f | aliguori | #define VIRTIO_NET_F_GUEST_UFO 10 /* Guest can handle UFO in. */ |
37 | fbe78f4f | aliguori | #define VIRTIO_NET_F_HOST_TSO4 11 /* Host can handle TSOv4 in. */ |
38 | fbe78f4f | aliguori | #define VIRTIO_NET_F_HOST_TSO6 12 /* Host can handle TSOv6 in. */ |
39 | fbe78f4f | aliguori | #define VIRTIO_NET_F_HOST_ECN 13 /* Host can handle TSO[6] w/ ECN in. */ |
40 | fbe78f4f | aliguori | #define VIRTIO_NET_F_HOST_UFO 14 /* Host can handle UFO in. */ |
41 | fbe78f4f | aliguori | #define VIRTIO_NET_F_MRG_RXBUF 15 /* Host can merge receive buffers. */ |
42 | 554c97dd | aliguori | #define VIRTIO_NET_F_STATUS 16 /* virtio_net_config.status available */ |
43 | 3d11d36c | aliguori | #define VIRTIO_NET_F_CTRL_VQ 17 /* Control channel available */ |
44 | 002437cd | aliguori | #define VIRTIO_NET_F_CTRL_RX 18 /* Control channel RX mode support */ |
45 | f21c0ed9 | aliguori | #define VIRTIO_NET_F_CTRL_VLAN 19 /* Control channel VLAN filtering */ |
46 | 015cb166 | Alex Williamson | #define VIRTIO_NET_F_CTRL_RX_EXTRA 20 /* Extra RX mode control support */ |
47 | 554c97dd | aliguori | |
48 | 554c97dd | aliguori | #define VIRTIO_NET_S_LINK_UP 1 /* Link is up */ |
49 | fbe78f4f | aliguori | |
50 | fbe78f4f | aliguori | #define TX_TIMER_INTERVAL 150000 /* 150 us */ |
51 | fbe78f4f | aliguori | |
52 | fbe78f4f | aliguori | /* Maximum packet size we can receive from tap device: header + 64k */
|
53 | fbe78f4f | aliguori | #define VIRTIO_NET_MAX_BUFSIZE (sizeof(struct virtio_net_hdr) + (64 << 10)) |
54 | fbe78f4f | aliguori | |
55 | fbe78f4f | aliguori | struct virtio_net_config
|
56 | fbe78f4f | aliguori | { |
57 | 554c97dd | aliguori | /* The config defining mac address (6 bytes) */
|
58 | fbe78f4f | aliguori | uint8_t mac[6];
|
59 | 554c97dd | aliguori | /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
|
60 | 554c97dd | aliguori | uint16_t status; |
61 | fbe78f4f | aliguori | } __attribute__((packed)); |
62 | fbe78f4f | aliguori | |
63 | fbe78f4f | aliguori | /* This is the first element of the scatter-gather list. If you don't
|
64 | fbe78f4f | aliguori | * specify GSO or CSUM features, you can simply ignore the header. */
|
65 | fbe78f4f | aliguori | struct virtio_net_hdr
|
66 | fbe78f4f | aliguori | { |
67 | fbe78f4f | aliguori | #define VIRTIO_NET_HDR_F_NEEDS_CSUM 1 // Use csum_start, csum_offset |
68 | fbe78f4f | aliguori | uint8_t flags; |
69 | fbe78f4f | aliguori | #define VIRTIO_NET_HDR_GSO_NONE 0 // Not a GSO frame |
70 | fbe78f4f | aliguori | #define VIRTIO_NET_HDR_GSO_TCPV4 1 // GSO frame, IPv4 TCP (TSO) |
71 | fbe78f4f | aliguori | #define VIRTIO_NET_HDR_GSO_UDP 3 // GSO frame, IPv4 UDP (UFO) |
72 | fbe78f4f | aliguori | #define VIRTIO_NET_HDR_GSO_TCPV6 4 // GSO frame, IPv6 TCP |
73 | fbe78f4f | aliguori | #define VIRTIO_NET_HDR_GSO_ECN 0x80 // TCP has ECN set |
74 | fbe78f4f | aliguori | uint8_t gso_type; |
75 | fbe78f4f | aliguori | uint16_t hdr_len; |
76 | fbe78f4f | aliguori | uint16_t gso_size; |
77 | fbe78f4f | aliguori | uint16_t csum_start; |
78 | fbe78f4f | aliguori | uint16_t csum_offset; |
79 | fbe78f4f | aliguori | }; |
80 | fbe78f4f | aliguori | |
81 | fbe78f4f | aliguori | /* This is the version of the header to use when the MRG_RXBUF
|
82 | fbe78f4f | aliguori | * feature has been negotiated. */
|
83 | fbe78f4f | aliguori | struct virtio_net_hdr_mrg_rxbuf
|
84 | fbe78f4f | aliguori | { |
85 | fbe78f4f | aliguori | struct virtio_net_hdr hdr;
|
86 | fbe78f4f | aliguori | uint16_t num_buffers; /* Number of merged rx buffers */
|
87 | fbe78f4f | aliguori | }; |
88 | fbe78f4f | aliguori | |
89 | 3d11d36c | aliguori | /*
|
90 | 3d11d36c | aliguori | * Control virtqueue data structures
|
91 | 3d11d36c | aliguori | *
|
92 | 3d11d36c | aliguori | * The control virtqueue expects a header in the first sg entry
|
93 | 3d11d36c | aliguori | * and an ack/status response in the last entry. Data for the
|
94 | 3d11d36c | aliguori | * command goes in between.
|
95 | 3d11d36c | aliguori | */
|
96 | 3d11d36c | aliguori | struct virtio_net_ctrl_hdr {
|
97 | 3d11d36c | aliguori | uint8_t class; |
98 | 3d11d36c | aliguori | uint8_t cmd; |
99 | 3d11d36c | aliguori | }; |
100 | 3d11d36c | aliguori | |
101 | 3d11d36c | aliguori | typedef uint8_t virtio_net_ctrl_ack;
|
102 | 3d11d36c | aliguori | |
103 | 3d11d36c | aliguori | #define VIRTIO_NET_OK 0 |
104 | 3d11d36c | aliguori | #define VIRTIO_NET_ERR 1 |
105 | 3d11d36c | aliguori | |
106 | 002437cd | aliguori | /*
|
107 | 015cb166 | Alex Williamson | * Control the RX mode, ie. promisucous, allmulti, etc...
|
108 | 015cb166 | Alex Williamson | * All commands require an "out" sg entry containing a 1 byte
|
109 | 015cb166 | Alex Williamson | * state value, zero = disable, non-zero = enable. Commands
|
110 | 015cb166 | Alex Williamson | * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature.
|
111 | 015cb166 | Alex Williamson | * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA.
|
112 | 002437cd | aliguori | */
|
113 | 002437cd | aliguori | #define VIRTIO_NET_CTRL_RX_MODE 0 |
114 | 002437cd | aliguori | #define VIRTIO_NET_CTRL_RX_MODE_PROMISC 0 |
115 | 002437cd | aliguori | #define VIRTIO_NET_CTRL_RX_MODE_ALLMULTI 1 |
116 | 015cb166 | Alex Williamson | #define VIRTIO_NET_CTRL_RX_MODE_ALLUNI 2 |
117 | 015cb166 | Alex Williamson | #define VIRTIO_NET_CTRL_RX_MODE_NOMULTI 3 |
118 | 015cb166 | Alex Williamson | #define VIRTIO_NET_CTRL_RX_MODE_NOUNI 4 |
119 | 015cb166 | Alex Williamson | #define VIRTIO_NET_CTRL_RX_MODE_NOBCAST 5 |
120 | 002437cd | aliguori | |
121 | b6503ed9 | aliguori | /*
|
122 | b6503ed9 | aliguori | * Control the MAC filter table.
|
123 | b6503ed9 | aliguori | *
|
124 | b6503ed9 | aliguori | * The MAC filter table is managed by the hypervisor, the guest should
|
125 | b6503ed9 | aliguori | * assume the size is infinite. Filtering should be considered
|
126 | b6503ed9 | aliguori | * non-perfect, ie. based on hypervisor resources, the guest may
|
127 | b6503ed9 | aliguori | * received packets from sources not specified in the filter list.
|
128 | b6503ed9 | aliguori | *
|
129 | b6503ed9 | aliguori | * In addition to the class/cmd header, the TABLE_SET command requires
|
130 | b6503ed9 | aliguori | * two out scatterlists. Each contains a 4 byte count of entries followed
|
131 | b6503ed9 | aliguori | * by a concatenated byte stream of the ETH_ALEN MAC addresses. The
|
132 | b6503ed9 | aliguori | * first sg list contains unicast addresses, the second is for multicast.
|
133 | b6503ed9 | aliguori | * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature
|
134 | b6503ed9 | aliguori | * is available.
|
135 | b6503ed9 | aliguori | */
|
136 | b6503ed9 | aliguori | struct virtio_net_ctrl_mac {
|
137 | b6503ed9 | aliguori | uint32_t entries; |
138 | b6503ed9 | aliguori | uint8_t macs[][ETH_ALEN]; |
139 | b6503ed9 | aliguori | }; |
140 | b6503ed9 | aliguori | #define VIRTIO_NET_CTRL_MAC 1 |
141 | b6503ed9 | aliguori | #define VIRTIO_NET_CTRL_MAC_TABLE_SET 0 |
142 | b6503ed9 | aliguori | |
143 | f21c0ed9 | aliguori | /*
|
144 | f21c0ed9 | aliguori | * Control VLAN filtering
|
145 | f21c0ed9 | aliguori | *
|
146 | f21c0ed9 | aliguori | * The VLAN filter table is controlled via a simple ADD/DEL interface.
|
147 | f21c0ed9 | aliguori | * VLAN IDs not added may be filterd by the hypervisor. Del is the
|
148 | f21c0ed9 | aliguori | * opposite of add. Both commands expect an out entry containing a 2
|
149 | f21c0ed9 | aliguori | * byte VLAN ID. VLAN filterting is available with the
|
150 | f21c0ed9 | aliguori | * VIRTIO_NET_F_CTRL_VLAN feature bit.
|
151 | f21c0ed9 | aliguori | */
|
152 | f21c0ed9 | aliguori | #define VIRTIO_NET_CTRL_VLAN 2 |
153 | f21c0ed9 | aliguori | #define VIRTIO_NET_CTRL_VLAN_ADD 0 |
154 | f21c0ed9 | aliguori | #define VIRTIO_NET_CTRL_VLAN_DEL 1 |
155 | f21c0ed9 | aliguori | |
156 | fbe78f4f | aliguori | #endif |