src/vnet/devices/virtio/virtio_std.h

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 #ifndef __VIRTIO_STD_H__
  16 #define __VIRTIO_STD_H__
  17
  18 #define foreach_virtio_net_features      \
  19   _ (VIRTIO_NET_F_CSUM, 0)      /* Host handles pkts w/ partial csum */ \
  20   _ (VIRTIO_NET_F_GUEST_CSUM, 1) /* Guest handles pkts w/ partial csum */ \
  21   _ (VIRTIO_NET_F_CTRL_GUEST_OFFLOADS, 2) /* Dynamic offload configuration. */ \
  22   _ (VIRTIO_NET_F_MTU, 3)       /* Initial MTU advice. */ \
  23   _ (VIRTIO_NET_F_MAC, 5)       /* Host has given MAC address. */ \
  24   _ (VIRTIO_NET_F_GSO, 6)       /* Host handles pkts w/ any GSO. */ \
  25   _ (VIRTIO_NET_F_GUEST_TSO4, 7)        /* Guest can handle TSOv4 in. */ \
  26   _ (VIRTIO_NET_F_GUEST_TSO6, 8)        /* Guest can handle TSOv6 in. */ \
  27   _ (VIRTIO_NET_F_GUEST_ECN, 9) /* Guest can handle TSO[6] w/ ECN in. */ \
  28   _ (VIRTIO_NET_F_GUEST_UFO, 10)        /* Guest can handle UFO in. */ \
  29   _ (VIRTIO_NET_F_HOST_TSO4, 11)        /* Host can handle TSOv4 in. */ \
  30   _ (VIRTIO_NET_F_HOST_TSO6, 12)        /* Host can handle TSOv6 in. */ \
  31   _ (VIRTIO_NET_F_HOST_ECN, 13) /* Host can handle TSO[6] w/ ECN in. */ \
  32   _ (VIRTIO_NET_F_HOST_UFO, 14) /* Host can handle UFO in. */ \
  33   _ (VIRTIO_NET_F_MRG_RXBUF, 15)        /* Host can merge receive buffers. */ \
  34   _ (VIRTIO_NET_F_STATUS, 16)   /* virtio_net_config.status available */ \
  35   _ (VIRTIO_NET_F_CTRL_VQ, 17)  /* Control channel available */ \
  36   _ (VIRTIO_NET_F_CTRL_RX, 18)  /* Control channel RX mode support */ \
  37   _ (VIRTIO_NET_F_CTRL_VLAN, 19)        /* Control channel VLAN filtering */ \
  38   _ (VIRTIO_NET_F_CTRL_RX_EXTRA, 20)    /* Extra RX mode control support */ \
  39   _ (VIRTIO_NET_F_GUEST_ANNOUNCE, 21)   /* Guest can announce device on the network */ \
  40   _ (VIRTIO_NET_F_MQ, 22)               /* Device supports Receive Flow Steering */ \
  41   _ (VIRTIO_NET_F_CTRL_MAC_ADDR, 23)    /* Set MAC address */ \
  42   _ (VIRTIO_F_NOTIFY_ON_EMPTY, 24) \
  43   _ (VHOST_F_LOG_ALL, 26)      /* Log all write descriptors */ \
  44   _ (VIRTIO_F_ANY_LAYOUT, 27)  /* Can the device handle any descriptor layout */ \
  45   _ (VIRTIO_RING_F_INDIRECT_DESC, 28)   /* Support indirect buffer descriptors */ \
  46   _ (VIRTIO_RING_F_EVENT_IDX, 29)       /* The Guest publishes the used index for which it expects an interrupt \
  47  * at the end of the avail ring. Host should ignore the avail->flags field. */ \
  48 /* The Host publishes the avail index for which it expects a kick \
  49  * at the end of the used ring. Guest should ignore the used->flags field. */ \
  50   _ (VHOST_USER_F_PROTOCOL_FEATURES, 30) \
  51   _ (VIRTIO_F_VERSION_1, 32)  /* v1.0 compliant. */           \
  52   _ (VIRTIO_F_IOMMU_PLATFORM, 33) \
  53   _ (VIRTIO_F_RING_PACKED, 34) \
  54   _ (VIRTIO_F_IN_ORDER, 35)  /* all buffers are used by the device in the */ \
  55                          /* same order in which they have been made available */ \
  56   _ (VIRTIO_F_ORDER_PLATFORM, 36) /* memory accesses by the driver and the */ \
  57                       /* device are ordered in a way described by the platfor */ \
  58   _ (VIRTIO_F_NOTIFICATION_DATA, 38) /* the driver passes extra data (besides */ \
  59                       /* identifying the virtqueue) in its device notifications. */ \
  60   _ (VIRTIO_NET_F_SPEED_DUPLEX, 63)     /* Device set linkspeed and duplex */
  61
  62 typedef enum
  63 {
  64 #define _(f,n) f = n,
  65   foreach_virtio_net_features
  66 #undef _
  67 } virtio_net_feature_t;
  68
  69 #define VIRTIO_FEATURE(X) (1ULL << X)
  70
  71 #define VRING_MAX_SIZE            32768
  72
  73 #define VRING_DESC_F_NEXT               1
  74 #define VRING_DESC_F_WRITE              2
  75 #define VRING_DESC_F_INDIRECT           4
  76
  77 #define VRING_DESC_F_AVAIL              (1 << 7)
  78 #define VRING_DESC_F_USED               (1 << 15)
  79
  80 #define VRING_EVENT_F_ENABLE            0x0
  81 #define VRING_EVENT_F_DISABLE           0x1
  82 #define VRING_EVENT_F_DESC              0x2
  83
  84 #define VRING_USED_F_NO_NOTIFY  1
  85 #define VRING_AVAIL_F_NO_INTERRUPT 1
  86
  87 typedef struct
  88 {
  89   u64 addr;
  90   u32 len;
  91   u16 flags;
  92   u16 next;
  93 } vring_desc_t;
  94
  95 typedef struct
  96 {
  97   u16 flags;
  98   u16 idx;
  99   u16 ring[0];
 100   /*  u16 used_event; */
 101 } vring_avail_t;
 102
 103 typedef struct
 104 {
 105   u32 id;
 106   u32 len;
 107 } vring_used_elem_t;
 108
 109 typedef struct
 110 {
 111   u16 flags;
 112   u16 idx;
 113   vring_used_elem_t ring[0];
 114   /* u16 avail_event; */
 115 } vring_used_t;
 116
 117 /* *INDENT-OFF* */
 118 typedef CLIB_PACKED (struct
 119 {
 120    u64 addr;    // packet data buffer address
 121    u32 len;     // packet data buffer size
 122    u16 id;      // buffer id
 123    u16 flags;   // flags
 124 }) vring_packed_desc_t;
 125
 126 STATIC_ASSERT_SIZEOF (vring_packed_desc_t, 16);
 127
 128 typedef CLIB_PACKED (struct
 129 {
 130   u16 off_wrap;
 131   u16 flags;
 132 }) vring_desc_event_t;
 133
 134 #define VIRTIO_NET_HDR_F_NEEDS_CSUM     1       /* Use csum_start, csum_offset */
 135 #define VIRTIO_NET_HDR_F_DATA_VALID     2       /* Csum is valid */
 136
 137 #define VIRTIO_NET_HDR_GSO_NONE         0       /* Not a GSO frame */
 138 #define VIRTIO_NET_HDR_GSO_TCPV4        1       /* GSO frame, IPv4 TCP (TSO) */
 139 #define VIRTIO_NET_HDR_GSO_UDP          3       /* GSO frame, IPv4 UDP (UFO) */
 140 #define VIRTIO_NET_HDR_GSO_TCPV6        4       /* GSO frame, IPv6 TCP */
 141 #define VIRTIO_NET_HDR_GSO_ECN          0x80    /* TCP has ECN set */
 142
 143 typedef CLIB_PACKED (struct
 144 {
 145   u8 flags;
 146   u8 gso_type;
 147   u16 hdr_len;                  /* Ethernet + IP + tcp/udp hdrs */
 148   u16 gso_size;                 /* Bytes to append to hdr_len per frame */
 149   u16 csum_start;               /* Position to start checksumming from */
 150   u16 csum_offset;              /* Offset after that to place checksum */
 151   u16 num_buffers;              /* Number of merged rx buffers */
 152 }) virtio_net_hdr_v1_t;
 153
 154 typedef CLIB_PACKED (struct
 155 {
 156   u8 flags;
 157   u8 gso_type;
 158   u16 hdr_len;
 159   u16 gso_size;
 160   u16 csum_start;
 161   u16 csum_offset;
 162 }) virtio_net_hdr_t;
 163
 164 typedef CLIB_PACKED (struct
 165 {
 166   virtio_net_hdr_t hdr;
 167   u16 num_buffers;
 168 }) virtio_net_hdr_mrg_rxbuf_t;
 169
 170 /* *INDENT-ON* */
 171
 172 typedef struct
 173 {
 174   u16 num;
 175   vring_desc_t *desc;
 176   vring_avail_t *avail;
 177   vring_used_t *used;
 178 } vring_t;
 179
 180 static_always_inline void
 181 vring_init (vring_t * vr, u32 num, void *p, u32 align)
 182 {
 183   vr->num = num;
 184   vr->desc = p;
 185   vr->avail = (vring_avail_t *) ((char *) p + num * sizeof (vring_desc_t));
 186   vr->used =
 187     (vring_used_t *) ((char *) p +
 188                       ((sizeof (vring_desc_t) * num +
 189                         sizeof (u16) * (3 + num) + align - 1) & ~(align -
 190                                                                   1)));
 191 }
 192
 193 static_always_inline u16
 194 vring_size (u32 num, u32 align)
 195 {
 196   return ((sizeof (vring_desc_t) * num + sizeof (u16) * (3 + num)
 197            + align - 1) & ~(align - 1))
 198     + sizeof (u16) * 3 + sizeof (vring_used_elem_t) * num;
 199 }
 200 #endif
 201
 202 /*
 203  * fd.io coding-style-patch-verification: ON
 204  *
 205  * Local Variables:
 206  * eval: (c-set-style "gnu")
 207  * End:
 208  */