root / hw / virtio-net.h @ 5e22c276
History | View | Annotate | Download (6.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 | a2cb15b0 | Michael S. Tsirkin | #include "pci/pci.h" |
19 | fbe78f4f | aliguori | |
20 | 79674068 | aliguori | #define ETH_ALEN 6 |
21 | 79674068 | aliguori | |
22 | fbe78f4f | aliguori | /* from Linux's virtio_net.h */
|
23 | fbe78f4f | aliguori | |
24 | fbe78f4f | aliguori | /* The ID for virtio_net */
|
25 | fbe78f4f | aliguori | #define VIRTIO_ID_NET 1 |
26 | fbe78f4f | aliguori | |
27 | fbe78f4f | aliguori | /* The feature bitmap for virtio net */
|
28 | fbe78f4f | aliguori | #define VIRTIO_NET_F_CSUM 0 /* Host handles pkts w/ partial csum */ |
29 | fbe78f4f | aliguori | #define VIRTIO_NET_F_GUEST_CSUM 1 /* Guest handles pkts w/ partial csum */ |
30 | fbe78f4f | aliguori | #define VIRTIO_NET_F_MAC 5 /* Host has given MAC address. */ |
31 | fbe78f4f | aliguori | #define VIRTIO_NET_F_GSO 6 /* Host handles pkts w/ any GSO type */ |
32 | fbe78f4f | aliguori | #define VIRTIO_NET_F_GUEST_TSO4 7 /* Guest can handle TSOv4 in. */ |
33 | fbe78f4f | aliguori | #define VIRTIO_NET_F_GUEST_TSO6 8 /* Guest can handle TSOv6 in. */ |
34 | fbe78f4f | aliguori | #define VIRTIO_NET_F_GUEST_ECN 9 /* Guest can handle TSO[6] w/ ECN in. */ |
35 | fbe78f4f | aliguori | #define VIRTIO_NET_F_GUEST_UFO 10 /* Guest can handle UFO in. */ |
36 | fbe78f4f | aliguori | #define VIRTIO_NET_F_HOST_TSO4 11 /* Host can handle TSOv4 in. */ |
37 | fbe78f4f | aliguori | #define VIRTIO_NET_F_HOST_TSO6 12 /* Host can handle TSOv6 in. */ |
38 | fbe78f4f | aliguori | #define VIRTIO_NET_F_HOST_ECN 13 /* Host can handle TSO[6] w/ ECN in. */ |
39 | fbe78f4f | aliguori | #define VIRTIO_NET_F_HOST_UFO 14 /* Host can handle UFO in. */ |
40 | fbe78f4f | aliguori | #define VIRTIO_NET_F_MRG_RXBUF 15 /* Host can merge receive buffers. */ |
41 | 554c97dd | aliguori | #define VIRTIO_NET_F_STATUS 16 /* virtio_net_config.status available */ |
42 | 3d11d36c | aliguori | #define VIRTIO_NET_F_CTRL_VQ 17 /* Control channel available */ |
43 | 002437cd | aliguori | #define VIRTIO_NET_F_CTRL_RX 18 /* Control channel RX mode support */ |
44 | f21c0ed9 | aliguori | #define VIRTIO_NET_F_CTRL_VLAN 19 /* Control channel VLAN filtering */ |
45 | 015cb166 | Alex Williamson | #define VIRTIO_NET_F_CTRL_RX_EXTRA 20 /* Extra RX mode control support */ |
46 | 554c97dd | aliguori | |
47 | 554c97dd | aliguori | #define VIRTIO_NET_S_LINK_UP 1 /* Link is up */ |
48 | fbe78f4f | aliguori | |
49 | fbe78f4f | aliguori | #define TX_TIMER_INTERVAL 150000 /* 150 us */ |
50 | fbe78f4f | aliguori | |
51 | e3f30488 | Alex Williamson | /* Limit the number of packets that can be sent via a single flush
|
52 | e3f30488 | Alex Williamson | * of the TX queue. This gives us a guaranteed exit condition and
|
53 | e3f30488 | Alex Williamson | * ensures fairness in the io path. 256 conveniently matches the
|
54 | e3f30488 | Alex Williamson | * length of the TX queue and shows a good balance of performance
|
55 | e3f30488 | Alex Williamson | * and latency. */
|
56 | e3f30488 | Alex Williamson | #define TX_BURST 256 |
57 | e3f30488 | Alex Williamson | |
58 | f0c07c7c | Alex Williamson | typedef struct virtio_net_conf |
59 | f0c07c7c | Alex Williamson | { |
60 | f0c07c7c | Alex Williamson | uint32_t txtimer; |
61 | e3f30488 | Alex Williamson | int32_t txburst; |
62 | a697a334 | Alex Williamson | char *tx;
|
63 | f0c07c7c | Alex Williamson | } virtio_net_conf; |
64 | f0c07c7c | Alex Williamson | |
65 | fbe78f4f | aliguori | /* Maximum packet size we can receive from tap device: header + 64k */
|
66 | fbe78f4f | aliguori | #define VIRTIO_NET_MAX_BUFSIZE (sizeof(struct virtio_net_hdr) + (64 << 10)) |
67 | fbe78f4f | aliguori | |
68 | fbe78f4f | aliguori | struct virtio_net_config
|
69 | fbe78f4f | aliguori | { |
70 | ebbeb789 | Amos Kong | /* The config defining mac address ($ETH_ALEN bytes) */
|
71 | ebbeb789 | Amos Kong | uint8_t mac[ETH_ALEN]; |
72 | 554c97dd | aliguori | /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
|
73 | 554c97dd | aliguori | uint16_t status; |
74 | 541dc0d4 | Stefan Weil | } QEMU_PACKED; |
75 | fbe78f4f | aliguori | |
76 | 3d11d36c | aliguori | /*
|
77 | 3d11d36c | aliguori | * Control virtqueue data structures
|
78 | 3d11d36c | aliguori | *
|
79 | 3d11d36c | aliguori | * The control virtqueue expects a header in the first sg entry
|
80 | 3d11d36c | aliguori | * and an ack/status response in the last entry. Data for the
|
81 | 3d11d36c | aliguori | * command goes in between.
|
82 | 3d11d36c | aliguori | */
|
83 | 3d11d36c | aliguori | struct virtio_net_ctrl_hdr {
|
84 | 3d11d36c | aliguori | uint8_t class; |
85 | 3d11d36c | aliguori | uint8_t cmd; |
86 | 3d11d36c | aliguori | }; |
87 | 3d11d36c | aliguori | |
88 | 3d11d36c | aliguori | typedef uint8_t virtio_net_ctrl_ack;
|
89 | 3d11d36c | aliguori | |
90 | 3d11d36c | aliguori | #define VIRTIO_NET_OK 0 |
91 | 3d11d36c | aliguori | #define VIRTIO_NET_ERR 1 |
92 | 3d11d36c | aliguori | |
93 | 002437cd | aliguori | /*
|
94 | 015cb166 | Alex Williamson | * Control the RX mode, ie. promisucous, allmulti, etc...
|
95 | 015cb166 | Alex Williamson | * All commands require an "out" sg entry containing a 1 byte
|
96 | 015cb166 | Alex Williamson | * state value, zero = disable, non-zero = enable. Commands
|
97 | 015cb166 | Alex Williamson | * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature.
|
98 | 015cb166 | Alex Williamson | * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA.
|
99 | 002437cd | aliguori | */
|
100 | 002437cd | aliguori | #define VIRTIO_NET_CTRL_RX_MODE 0 |
101 | 002437cd | aliguori | #define VIRTIO_NET_CTRL_RX_MODE_PROMISC 0 |
102 | 002437cd | aliguori | #define VIRTIO_NET_CTRL_RX_MODE_ALLMULTI 1 |
103 | 015cb166 | Alex Williamson | #define VIRTIO_NET_CTRL_RX_MODE_ALLUNI 2 |
104 | 015cb166 | Alex Williamson | #define VIRTIO_NET_CTRL_RX_MODE_NOMULTI 3 |
105 | 015cb166 | Alex Williamson | #define VIRTIO_NET_CTRL_RX_MODE_NOUNI 4 |
106 | 015cb166 | Alex Williamson | #define VIRTIO_NET_CTRL_RX_MODE_NOBCAST 5 |
107 | 002437cd | aliguori | |
108 | b6503ed9 | aliguori | /*
|
109 | b6503ed9 | aliguori | * Control the MAC filter table.
|
110 | b6503ed9 | aliguori | *
|
111 | b6503ed9 | aliguori | * The MAC filter table is managed by the hypervisor, the guest should
|
112 | b6503ed9 | aliguori | * assume the size is infinite. Filtering should be considered
|
113 | b6503ed9 | aliguori | * non-perfect, ie. based on hypervisor resources, the guest may
|
114 | b6503ed9 | aliguori | * received packets from sources not specified in the filter list.
|
115 | b6503ed9 | aliguori | *
|
116 | b6503ed9 | aliguori | * In addition to the class/cmd header, the TABLE_SET command requires
|
117 | b6503ed9 | aliguori | * two out scatterlists. Each contains a 4 byte count of entries followed
|
118 | b6503ed9 | aliguori | * by a concatenated byte stream of the ETH_ALEN MAC addresses. The
|
119 | b6503ed9 | aliguori | * first sg list contains unicast addresses, the second is for multicast.
|
120 | b6503ed9 | aliguori | * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature
|
121 | b6503ed9 | aliguori | * is available.
|
122 | b6503ed9 | aliguori | */
|
123 | b6503ed9 | aliguori | struct virtio_net_ctrl_mac {
|
124 | b6503ed9 | aliguori | uint32_t entries; |
125 | b6503ed9 | aliguori | uint8_t macs[][ETH_ALEN]; |
126 | b6503ed9 | aliguori | }; |
127 | b6503ed9 | aliguori | #define VIRTIO_NET_CTRL_MAC 1 |
128 | b6503ed9 | aliguori | #define VIRTIO_NET_CTRL_MAC_TABLE_SET 0 |
129 | b6503ed9 | aliguori | |
130 | f21c0ed9 | aliguori | /*
|
131 | f21c0ed9 | aliguori | * Control VLAN filtering
|
132 | f21c0ed9 | aliguori | *
|
133 | f21c0ed9 | aliguori | * The VLAN filter table is controlled via a simple ADD/DEL interface.
|
134 | f21c0ed9 | aliguori | * VLAN IDs not added may be filterd by the hypervisor. Del is the
|
135 | f21c0ed9 | aliguori | * opposite of add. Both commands expect an out entry containing a 2
|
136 | f21c0ed9 | aliguori | * byte VLAN ID. VLAN filterting is available with the
|
137 | f21c0ed9 | aliguori | * VIRTIO_NET_F_CTRL_VLAN feature bit.
|
138 | f21c0ed9 | aliguori | */
|
139 | f21c0ed9 | aliguori | #define VIRTIO_NET_CTRL_VLAN 2 |
140 | f21c0ed9 | aliguori | #define VIRTIO_NET_CTRL_VLAN_ADD 0 |
141 | f21c0ed9 | aliguori | #define VIRTIO_NET_CTRL_VLAN_DEL 1 |
142 | f21c0ed9 | aliguori | |
143 | 8172539d | Michael S. Tsirkin | #define DEFINE_VIRTIO_NET_FEATURES(_state, _field) \
|
144 | 8172539d | Michael S. Tsirkin | DEFINE_VIRTIO_COMMON_FEATURES(_state, _field), \ |
145 | 8172539d | Michael S. Tsirkin | DEFINE_PROP_BIT("csum", _state, _field, VIRTIO_NET_F_CSUM, true), \ |
146 | 8172539d | Michael S. Tsirkin | DEFINE_PROP_BIT("guest_csum", _state, _field, VIRTIO_NET_F_GUEST_CSUM, true), \ |
147 | 8172539d | Michael S. Tsirkin | DEFINE_PROP_BIT("gso", _state, _field, VIRTIO_NET_F_GSO, true), \ |
148 | 8172539d | Michael S. Tsirkin | DEFINE_PROP_BIT("guest_tso4", _state, _field, VIRTIO_NET_F_GUEST_TSO4, true), \ |
149 | 8172539d | Michael S. Tsirkin | DEFINE_PROP_BIT("guest_tso6", _state, _field, VIRTIO_NET_F_GUEST_TSO6, true), \ |
150 | 8172539d | Michael S. Tsirkin | DEFINE_PROP_BIT("guest_ecn", _state, _field, VIRTIO_NET_F_GUEST_ECN, true), \ |
151 | 8172539d | Michael S. Tsirkin | DEFINE_PROP_BIT("guest_ufo", _state, _field, VIRTIO_NET_F_GUEST_UFO, true), \ |
152 | 8172539d | Michael S. Tsirkin | DEFINE_PROP_BIT("host_tso4", _state, _field, VIRTIO_NET_F_HOST_TSO4, true), \ |
153 | 8172539d | Michael S. Tsirkin | DEFINE_PROP_BIT("host_tso6", _state, _field, VIRTIO_NET_F_HOST_TSO6, true), \ |
154 | 8172539d | Michael S. Tsirkin | DEFINE_PROP_BIT("host_ecn", _state, _field, VIRTIO_NET_F_HOST_ECN, true), \ |
155 | 8172539d | Michael S. Tsirkin | DEFINE_PROP_BIT("host_ufo", _state, _field, VIRTIO_NET_F_HOST_UFO, true), \ |
156 | 8172539d | Michael S. Tsirkin | DEFINE_PROP_BIT("mrg_rxbuf", _state, _field, VIRTIO_NET_F_MRG_RXBUF, true), \ |
157 | 8172539d | Michael S. Tsirkin | DEFINE_PROP_BIT("status", _state, _field, VIRTIO_NET_F_STATUS, true), \ |
158 | 8172539d | Michael S. Tsirkin | DEFINE_PROP_BIT("ctrl_vq", _state, _field, VIRTIO_NET_F_CTRL_VQ, true), \ |
159 | 8172539d | Michael S. Tsirkin | DEFINE_PROP_BIT("ctrl_rx", _state, _field, VIRTIO_NET_F_CTRL_RX, true), \ |
160 | 8172539d | Michael S. Tsirkin | DEFINE_PROP_BIT("ctrl_vlan", _state, _field, VIRTIO_NET_F_CTRL_VLAN, true), \ |
161 | 8172539d | Michael S. Tsirkin | DEFINE_PROP_BIT("ctrl_rx_extra", _state, _field, VIRTIO_NET_F_CTRL_RX_EXTRA, true) |
162 | fbe78f4f | aliguori | #endif |