Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1#ifndef _LINUX_VIRTIO_NET_H
2#define _LINUX_VIRTIO_NET_H
3/* This header is BSD licensed so anyone can use the definitions to implement
4 * compatible drivers/servers. */
5#include <linux/types.h>
6#include <linux/virtio_config.h>
7#include <linux/if_ether.h>
8
9/* The ID for virtio_net */
10#define VIRTIO_ID_NET 1
11
12/* The feature bitmap for virtio net */
13#define VIRTIO_NET_F_CSUM 0 /* Host handles pkts w/ partial csum */
14#define VIRTIO_NET_F_GUEST_CSUM 1 /* Guest handles pkts w/ partial csum */
15#define VIRTIO_NET_F_MAC 5 /* Host has given MAC address. */
16#define VIRTIO_NET_F_GSO 6 /* Host handles pkts w/ any GSO type */
17#define VIRTIO_NET_F_GUEST_TSO4 7 /* Guest can handle TSOv4 in. */
18#define VIRTIO_NET_F_GUEST_TSO6 8 /* Guest can handle TSOv6 in. */
19#define VIRTIO_NET_F_GUEST_ECN 9 /* Guest can handle TSO[6] w/ ECN in. */
20#define VIRTIO_NET_F_GUEST_UFO 10 /* Guest can handle UFO in. */
21#define VIRTIO_NET_F_HOST_TSO4 11 /* Host can handle TSOv4 in. */
22#define VIRTIO_NET_F_HOST_TSO6 12 /* Host can handle TSOv6 in. */
23#define VIRTIO_NET_F_HOST_ECN 13 /* Host can handle TSO[6] w/ ECN in. */
24#define VIRTIO_NET_F_HOST_UFO 14 /* Host can handle UFO in. */
25#define VIRTIO_NET_F_MRG_RXBUF 15 /* Host can merge receive buffers. */
26#define VIRTIO_NET_F_STATUS 16 /* virtio_net_config.status available */
27#define VIRTIO_NET_F_CTRL_VQ 17 /* Control channel available */
28#define VIRTIO_NET_F_CTRL_RX 18 /* Control channel RX mode support */
29#define VIRTIO_NET_F_CTRL_VLAN 19 /* Control channel VLAN filtering */
30
31#define VIRTIO_NET_S_LINK_UP 1 /* Link is up */
32
33struct virtio_net_config
34{
35 /* The config defining mac address (if VIRTIO_NET_F_MAC) */
36 __u8 mac[6];
37 /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
38 __u16 status;
39} __attribute__((packed));
40
41/* This is the first element of the scatter-gather list. If you don't
42 * specify GSO or CSUM features, you can simply ignore the header. */
43struct virtio_net_hdr
44{
45#define VIRTIO_NET_HDR_F_NEEDS_CSUM 1 // Use csum_start, csum_offset
46 __u8 flags;
47#define VIRTIO_NET_HDR_GSO_NONE 0 // Not a GSO frame
48#define VIRTIO_NET_HDR_GSO_TCPV4 1 // GSO frame, IPv4 TCP (TSO)
49#define VIRTIO_NET_HDR_GSO_UDP 3 // GSO frame, IPv4 UDP (UFO)
50#define VIRTIO_NET_HDR_GSO_TCPV6 4 // GSO frame, IPv6 TCP
51#define VIRTIO_NET_HDR_GSO_ECN 0x80 // TCP has ECN set
52 __u8 gso_type;
53 __u16 hdr_len; /* Ethernet + IP + tcp/udp hdrs */
54 __u16 gso_size; /* Bytes to append to hdr_len per frame */
55 __u16 csum_start; /* Position to start checksumming from */
56 __u16 csum_offset; /* Offset after that to place checksum */
57};
58
59/* This is the version of the header to use when the MRG_RXBUF
60 * feature has been negotiated. */
61struct virtio_net_hdr_mrg_rxbuf {
62 struct virtio_net_hdr hdr;
63 __u16 num_buffers; /* Number of merged rx buffers */
64};
65
66/*
67 * Control virtqueue data structures
68 *
69 * The control virtqueue expects a header in the first sg entry
70 * and an ack/status response in the last entry. Data for the
71 * command goes in between.
72 */
73struct virtio_net_ctrl_hdr {
74 __u8 class;
75 __u8 cmd;
76} __attribute__((packed));
77
78typedef __u8 virtio_net_ctrl_ack;
79
80#define VIRTIO_NET_OK 0
81#define VIRTIO_NET_ERR 1
82
83/*
84 * Control the RX mode, ie. promisucous and allmulti. PROMISC and
85 * ALLMULTI commands require an "out" sg entry containing a 1 byte
86 * state value, zero = disable, non-zero = enable. These commands
87 * are supported with the VIRTIO_NET_F_CTRL_RX feature.
88 */
89#define VIRTIO_NET_CTRL_RX 0
90 #define VIRTIO_NET_CTRL_RX_PROMISC 0
91 #define VIRTIO_NET_CTRL_RX_ALLMULTI 1
92
93/*
94 * Control the MAC filter table.
95 *
96 * The MAC filter table is managed by the hypervisor, the guest should
97 * assume the size is infinite. Filtering should be considered
98 * non-perfect, ie. based on hypervisor resources, the guest may
99 * received packets from sources not specified in the filter list.
100 *
101 * In addition to the class/cmd header, the TABLE_SET command requires
102 * two out scatterlists. Each contains a 4 byte count of entries followed
103 * by a concatenated byte stream of the ETH_ALEN MAC addresses. The
104 * first sg list contains unicast addresses, the second is for multicast.
105 * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature
106 * is available.
107 */
108struct virtio_net_ctrl_mac {
109 __u32 entries;
110 __u8 macs[][ETH_ALEN];
111} __attribute__((packed));
112
113#define VIRTIO_NET_CTRL_MAC 1
114 #define VIRTIO_NET_CTRL_MAC_TABLE_SET 0
115
116/*
117 * Control VLAN filtering
118 *
119 * The VLAN filter table is controlled via a simple ADD/DEL interface.
120 * VLAN IDs not added may be filterd by the hypervisor. Del is the
121 * opposite of add. Both commands expect an out entry containing a 2
122 * byte VLAN ID. VLAN filterting is available with the
123 * VIRTIO_NET_F_CTRL_VLAN feature bit.
124 */
125#define VIRTIO_NET_CTRL_VLAN 2
126 #define VIRTIO_NET_CTRL_VLAN_ADD 0
127 #define VIRTIO_NET_CTRL_VLAN_DEL 1
128
129#endif /* _LINUX_VIRTIO_NET_H */