blob: 7dcd90ac35391f3aec22334bba687af7894eb632 [file] [log] [blame]
Damjan Marion8389fb92017-10-13 18:29:53 +02001/*
2 *------------------------------------------------------------------
3 * Copyright (c) 2017 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
16 */
17
18#ifndef _VNET_DEVICES_VIRTIO_VIRTIO_H_
19#define _VNET_DEVICES_VIRTIO_VIRTIO_H_
20
21#define foreach_virtio_net_features \
22 _ (VIRTIO_NET_F_CSUM, 0) /* Host handles pkts w/ partial csum */ \
23 _ (VIRTIO_NET_F_GUEST_CSUM, 1) /* Guest handles pkts w/ partial csum */ \
24 _ (VIRTIO_NET_F_CTRL_GUEST_OFFLOADS, 2) /* Dynamic offload configuration. */ \
25 _ (VIRTIO_NET_F_MTU, 3) /* Initial MTU advice. */ \
26 _ (VIRTIO_NET_F_MAC, 5) /* Host has given MAC address. */ \
27 _ (VIRTIO_NET_F_GSO, 6) /* Host handles pkts w/ any GSO. */ \
28 _ (VIRTIO_NET_F_GUEST_TSO4, 7) /* Guest can handle TSOv4 in. */ \
29 _ (VIRTIO_NET_F_GUEST_TSO6, 8) /* Guest can handle TSOv6 in. */ \
30 _ (VIRTIO_NET_F_GUEST_ECN, 9) /* Guest can handle TSO[6] w/ ECN in. */ \
31 _ (VIRTIO_NET_F_GUEST_UFO, 10) /* Guest can handle UFO in. */ \
32 _ (VIRTIO_NET_F_HOST_TSO4, 11) /* Host can handle TSOv4 in. */ \
33 _ (VIRTIO_NET_F_HOST_TSO6, 12) /* Host can handle TSOv6 in. */ \
34 _ (VIRTIO_NET_F_HOST_ECN, 13) /* Host can handle TSO[6] w/ ECN in. */ \
35 _ (VIRTIO_NET_F_HOST_UFO, 14) /* Host can handle UFO in. */ \
36 _ (VIRTIO_NET_F_MRG_RXBUF, 15) /* Host can merge receive buffers. */ \
37 _ (VIRTIO_NET_F_STATUS, 16) /* virtio_net_config.status available */ \
38 _ (VIRTIO_NET_F_CTRL_VQ, 17) /* Control channel available */ \
39 _ (VIRTIO_NET_F_CTRL_RX, 18) /* Control channel RX mode support */ \
40 _ (VIRTIO_NET_F_CTRL_VLAN, 19) /* Control channel VLAN filtering */ \
41 _ (VIRTIO_NET_F_CTRL_RX_EXTRA, 20) /* Extra RX mode control support */ \
42 _ (VIRTIO_NET_F_GUEST_ANNOUNCE, 21) /* Guest can announce device on the network */ \
43 _ (VIRTIO_NET_F_MQ, 22) /* Device supports Receive Flow Steering */ \
44 _ (VIRTIO_NET_F_CTRL_MAC_ADDR, 23) /* Set MAC address */ \
45 _ (VIRTIO_F_NOTIFY_ON_EMPTY, 24) \
46 _ (VHOST_F_LOG_ALL, 26) /* Log all write descriptors */ \
47 _ (VIRTIO_F_ANY_LAYOUT, 27) /* Can the device handle any descripor layout */ \
48 _ (VIRTIO_RING_F_INDIRECT_DESC, 28) /* Support indirect buffer descriptors */ \
49 _ (VIRTIO_RING_F_EVENT_IDX, 29) /* The Guest publishes the used index for which it expects an interrupt \
50 * at the end of the avail ring. Host should ignore the avail->flags field. */ \
51/* The Host publishes the avail index for which it expects a kick \
52 * at the end of the used ring. Guest should ignore the used->flags field. */ \
53 _ (VHOST_USER_F_PROTOCOL_FEATURES, 30) \
54 _ (VIRTIO_F_VERSION_1, 32)
55
56#define foreach_virtio_if_flag \
57 _(0, ADMIN_UP, "admin-up") \
58 _(1, DELETING, "deleting")
59
60typedef enum
61{
62#define _(a, b, c) VIRTIO_IF_FLAG_##b = (1 << a),
63 foreach_virtio_if_flag
64#undef _
65} virtio_if_flag_t;
66
67typedef enum
68{
69 VIRTIO_IF_TYPE_TAP,
70 VIRTIO_IF_N_TYPES,
71} virtio_if_type_t;
72
73
74typedef struct
75{
76 struct vring_desc *desc;
77 struct vring_used *used;
78 struct vring_avail *avail;
79 u16 desc_in_use;
80 u16 desc_next;
81 int kick_fd;
82 int call_fd;
83 u16 size;
84#define VIRTIO_RING_FLAG_MASK_INT 1
85 u32 flags;
86 u32 call_file_index;
87 u32 *buffers;
88 u16 last_used_idx;
89} virtio_vring_t;
90
91typedef struct
92{
93 u32 flags;
94 u32 dev_instance;
95 u32 hw_if_index;
96 u32 sw_if_index;
97 u32 per_interface_next_index;
98 int fd;
99 int tap_fd;
100 virtio_vring_t *vrings;
101
102 u64 features, remote_features;
103
104 virtio_if_type_t type;
105 u8 *name;
106 u8 *net_ns;
107 int ifindex;
108} virtio_if_t;
109
110typedef struct
111{
112 virtio_if_t *interfaces;
113} virtio_main_t;
114
115extern virtio_main_t virtio_main;
116extern vnet_device_class_t virtio_device_class;
117extern vlib_node_registration_t virtio_input_node;
118
119clib_error_t *virtio_vring_init (vlib_main_t * vm, virtio_if_t * vif, u16 idx,
120 u16 sz);
121clib_error_t *virtio_vring_free (virtio_if_t * vif, u32 idx);
122
123#endif /* _VNET_DEVICES_VIRTIO_VIRTIO_H_ */
124
125/*
126 * fd.io coding-style-patch-verification: ON
127 *
128 * Local Variables:
129 * eval: (c-set-style "gnu")
130 * End:
131 */