src/vnet/devices/virtio/pci.h

   1 /*
   2  * Copyright (c) 2018 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
  16 #ifndef __included_virtio_pci_h__
  17 #define __included_virtio_pci_h__
  18
  19 /* VirtIO ABI version, this must match exactly. */
  20 #define VIRTIO_PCI_ABI_VERSION 0
  21
  22 /*
  23  * Vector value used to disable MSI for queue.
  24  * define in include/linux/virtio_pci.h
  25  * #define VIRTIO_MSI_NO_VECTOR 0xFFFF
  26  */
  27
  28 /* The bit of the ISR which indicates a device has an interrupt. */
  29 #define VIRTIO_PCI_ISR_INTR   0x1
  30 /* The bit of the ISR which indicates a device configuration change. */
  31 #define VIRTIO_PCI_ISR_CONFIG 0x2
  32
  33 /* VirtIO device IDs. */
  34 #define VIRTIO_ID_NETWORK  0x01
  35
  36 /* Status byte for guest to report progress. */
  37 #define foreach_virtio_config_status_flags      \
  38   _ (VIRTIO_CONFIG_STATUS_RESET, 0x00)          \
  39   _ (VIRTIO_CONFIG_STATUS_ACK, 0x01)            \
  40   _ (VIRTIO_CONFIG_STATUS_DRIVER, 0x02)         \
  41   _ (VIRTIO_CONFIG_STATUS_DRIVER_OK, 0x04)      \
  42   _ (VIRTIO_CONFIG_STATUS_FEATURES_OK, 0x08)    \
  43   _ (VIRTIO_CONFIG_STATUS_DEVICE_NEEDS_RESET, 0x40) \
  44   _ (VIRTIO_CONFIG_STATUS_FAILED, 0x80)
  45
  46 typedef enum
  47 {
  48 #define _(a, b) a = b,
  49   foreach_virtio_config_status_flags
  50 #undef _
  51 } virtio_config_status_flags_t;
  52
  53 #define foreach_virtio_net_feature_flags      \
  54   _ (VIRTIO_NET_F_CSUM, 0)      /* Host handles pkts w/ partial csum */ \
  55   _ (VIRTIO_NET_F_GUEST_CSUM, 1) /* Guest handles pkts w/ partial csum */ \
  56   _ (VIRTIO_NET_F_CTRL_GUEST_OFFLOADS, 2) /* Dynamic offload configuration. */ \
  57   _ (VIRTIO_NET_F_MTU, 3)       /* Initial MTU advice. */ \
  58   _ (VIRTIO_NET_F_MAC, 5)       /* Host has given MAC address. */ \
  59   _ (VIRTIO_NET_F_GSO, 6)       /* Host handles pkts w/ any GSO. */ \
  60   _ (VIRTIO_NET_F_GUEST_TSO4, 7)        /* Guest can handle TSOv4 in. */ \
  61   _ (VIRTIO_NET_F_GUEST_TSO6, 8)        /* Guest can handle TSOv6 in. */ \
  62   _ (VIRTIO_NET_F_GUEST_ECN, 9) /* Guest can handle TSO[6] w/ ECN in. */ \
  63   _ (VIRTIO_NET_F_GUEST_UFO, 10)        /* Guest can handle UFO in. */ \
  64   _ (VIRTIO_NET_F_HOST_TSO4, 11)        /* Host can handle TSOv4 in. */ \
  65   _ (VIRTIO_NET_F_HOST_TSO6, 12)        /* Host can handle TSOv6 in. */ \
  66   _ (VIRTIO_NET_F_HOST_ECN, 13) /* Host can handle TSO[6] w/ ECN in. */ \
  67   _ (VIRTIO_NET_F_HOST_UFO, 14) /* Host can handle UFO in. */ \
  68   _ (VIRTIO_NET_F_MRG_RXBUF, 15)        /* Host can merge receive buffers. */ \
  69   _ (VIRTIO_NET_F_STATUS, 16)   /* virtio_net_config.status available */ \
  70   _ (VIRTIO_NET_F_CTRL_VQ, 17)  /* Control channel available */ \
  71   _ (VIRTIO_NET_F_CTRL_RX, 18)  /* Control channel RX mode support */ \
  72   _ (VIRTIO_NET_F_CTRL_VLAN, 19)        /* Control channel VLAN filtering */ \
  73   _ (VIRTIO_NET_F_CTRL_RX_EXTRA, 20)    /* Extra RX mode control support */ \
  74   _ (VIRTIO_NET_F_GUEST_ANNOUNCE, 21)   /* Guest can announce device on the network */ \
  75   _ (VIRTIO_NET_F_MQ, 22)               /* Device supports Receive Flow Steering */ \
  76   _ (VIRTIO_NET_F_CTRL_MAC_ADDR, 23)    /* Set MAC address */ \
  77   _ (VIRTIO_F_NOTIFY_ON_EMPTY, 24) \
  78   _ (VHOST_F_LOG_ALL, 26)      /* Log all write descriptors */ \
  79   _ (VIRTIO_F_ANY_LAYOUT, 27)  /* Can the device handle any descripor layout */ \
  80   _ (VIRTIO_RING_F_INDIRECT_DESC, 28)   /* Support indirect buffer descriptors */ \
  81   _ (VIRTIO_RING_F_EVENT_IDX, 29)       /* The Guest publishes the used index for which it expects an interrupt \
  82  * at the end of the avail ring. Host should ignore the avail->flags field. */ \
  83 /* The Host publishes the avail index for which it expects a kick \
  84  * at the end of the used ring. Guest should ignore the used->flags field. */ \
  85   _ (VHOST_USER_F_PROTOCOL_FEATURES, 30)
  86
  87 #define VIRTIO_NET_F_CTRL_GUEST_OFFLOADS 2
  88 #define VIRTIO_NET_F_MTU 3
  89 #define VIRTIO_NET_S_LINK_UP    1       /* Link is up */
  90 #define VIRTIO_NET_S_ANNOUNCE   2       /* Announcement is needed */
  91
  92 /*
  93  * Control network offloads
  94  * Reconfigures the network offloads that Guest can handle.
  95  * Available with the VIRTIO_NET_F_CTRL_GUEST_OFFLOADS feature bit.
  96  * Command data format matches the feature bit mask exactly.
  97  * See VIRTIO_NET_F_GUEST_* for the list of offloads
  98  * that can be enabled/disabled.
  99  */
 100 #define VIRTIO_NET_CTRL_GUEST_OFFLOADS 5
 101 #define VIRTIO_NET_CTRL_GUEST_OFFLOADS_SET 0
 102
 103 /* Common configuration */
 104 #define VIRTIO_PCI_CAP_COMMON_CFG       1
 105 /* Notifications */
 106 #define VIRTIO_PCI_CAP_NOTIFY_CFG       2
 107 /* ISR Status */
 108 #define VIRTIO_PCI_CAP_ISR_CFG          3
 109 /* Device specific configuration */
 110 #define VIRTIO_PCI_CAP_DEVICE_CFG       4
 111 /* PCI configuration access */
 112 #define VIRTIO_PCI_CAP_PCI_CFG          5
 113
 114 #define VIRTIO_PCI_QUEUE_ADDR_SHIFT 12
 115
 116 #define VIRTIO_PCI_VRING_ALIGN 4096
 117
 118 typedef enum
 119 {
 120   VIRTIO_MSIX_NONE = 0,
 121   VIRTIO_MSIX_DISABLED = 1,
 122   VIRTIO_MSIX_ENABLED = 2
 123 } virtio_msix_status_t;
 124
 125 /* This is the PCI capability header: */
 126 typedef struct
 127 {
 128   u8 cap_vndr;                  /* Generic PCI field: PCI_CAP_ID_VNDR */
 129   u8 cap_next;                  /* Generic PCI field: next ptr. */
 130   u8 cap_len;                   /* Generic PCI field: capability length */
 131   u8 cfg_type;                  /* Identifies the structure. */
 132   u8 bar;                       /* Where to find it. */
 133   u8 padding[3];                /* Pad to full dword. */
 134   u32 offset;                   /* Offset within bar. */
 135   u32 length;                   /* Length of the structure, in bytes. */
 136 } virtio_pci_cap_t;
 137
 138 typedef struct
 139 {
 140   struct virtio_pci_cap cap;
 141   u32 notify_off_multiplier;    /* Multiplier for queue_notify_off. */
 142 } virtio_pci_notify_cap_t;
 143
 144 /* Fields in VIRTIO_PCI_CAP_COMMON_CFG: */
 145 typedef struct
 146 {
 147   /* About the whole device. */
 148   u32 device_feature_select;    /* read-write */
 149   u32 device_feature;           /* read-only */
 150   u32 guest_feature_select;     /* read-write */
 151   u32 guest_feature;            /* read-write */
 152   u16 msix_config;              /* read-write */
 153   u16 num_queues;               /* read-only */
 154   u8 device_status;             /* read-write */
 155   u8 config_generation;         /* read-only */
 156
 157   /* About a specific virtqueue. */
 158   u16 queue_select;             /* read-write */
 159   u16 queue_size;               /* read-write, power of 2. */
 160   u16 queue_msix_vector;        /* read-write */
 161   u16 queue_enable;             /* read-write */
 162   u16 queue_notify_off;         /* read-only */
 163   u32 queue_desc_lo;            /* read-write */
 164   u32 queue_desc_hi;            /* read-write */
 165   u32 queue_avail_lo;           /* read-write */
 166   u32 queue_avail_hi;           /* read-write */
 167   u32 queue_used_lo;            /* read-write */
 168   u32 queue_used_hi;            /* read-write */
 169 } virtio_pci_common_cfg_t;
 170
 171 typedef struct
 172 {
 173   u8 mac[6];
 174   u16 status;
 175   u16 max_virtqueue_pairs;
 176   u16 mtu;
 177 } virtio_net_config_t;
 178
 179 typedef struct
 180 {
 181   u64 addr;
 182   u32 len;
 183   u16 flags;
 184   u16 next;
 185 } vring_desc_t;
 186
 187 typedef struct
 188 {
 189   u16 flags;
 190   u16 idx;
 191   u16 ring[0];
 192   /*  u16 used_event; */
 193 } vring_avail_t;
 194
 195 typedef struct
 196 {
 197   u32 id;
 198   u32 len;
 199 } vring_used_elem_t;
 200
 201 typedef struct
 202 {
 203   u16 flags;
 204   u16 idx;
 205   vring_used_elem_t ring[0];
 206   /* u16 avail_event; */
 207 } vring_used_t;
 208
 209 typedef struct _virtio_pci_func
 210 {
 211   void (*read_config) (vlib_main_t * vm, virtio_if_t * vif, void *dst,
 212                        int len, u32 addr);
 213   void (*write_config) (vlib_main_t * vm, virtio_if_t * vif, void *src,
 214                         int len, u32 addr);
 215
 216     u64 (*get_device_features) (vlib_main_t * vm, virtio_if_t * vif);
 217     u64 (*get_driver_features) (vlib_main_t * vm, virtio_if_t * vif);
 218   void (*set_driver_features) (vlib_main_t * vm, virtio_if_t * vif,
 219                                u64 features);
 220
 221     u8 (*get_status) (vlib_main_t * vm, virtio_if_t * vif);
 222   void (*set_status) (vlib_main_t * vm, virtio_if_t * vif, u8 status);
 223     u8 (*device_reset) (vlib_main_t * vm, virtio_if_t * vif);
 224
 225     u8 (*get_isr) (vlib_main_t * vm, virtio_if_t * vif);
 226
 227     u16 (*get_queue_size) (vlib_main_t * vm, virtio_if_t * vif, u16 queue_id);
 228   void (*set_queue_size) (vlib_main_t * vm, virtio_if_t * vif, u16 queue_id,
 229                           u16 queue_size);
 230     u8 (*setup_queue) (vlib_main_t * vm, virtio_if_t * vif, u16 queue_id,
 231                        void *p);
 232   void (*del_queue) (vlib_main_t * vm, virtio_if_t * vif, u16 queue_id);
 233   void (*notify_queue) (vlib_main_t * vm, virtio_if_t * vif, u16 queue_id);
 234
 235     u16 (*set_config_irq) (vlib_main_t * vm, virtio_if_t * vif, u16 vec);
 236     u16 (*set_queue_irq) (vlib_main_t * vm, virtio_if_t * vif, u16 vec,
 237                           u16 queue_id);
 238
 239   void (*get_mac) (vlib_main_t * vm, virtio_if_t * vif);
 240   void (*set_mac) (vlib_main_t * vm, virtio_if_t * vif);
 241     u16 (*get_device_status) (vlib_main_t * vm, virtio_if_t * vif);
 242     u16 (*get_max_queue_pairs) (vlib_main_t * vm, virtio_if_t * vif);
 243     u16 (*get_mtu) (vlib_main_t * vm, virtio_if_t * vif);
 244   void (*device_debug_config_space) (vlib_main_t * vm, virtio_if_t * vif);
 245 } virtio_pci_func_t;
 246
 247 typedef struct
 248 {
 249   u32 addr;
 250   /* return */
 251   i32 rv;
 252   u32 sw_if_index;
 253   u8 mac_addr_set;
 254   u8 mac_addr[6];
 255   u64 features;
 256   u8 gso_enabled;
 257   u8 checksum_offload_enabled;
 258   clib_error_t *error;
 259 } virtio_pci_create_if_args_t;
 260
 261 extern const virtio_pci_func_t virtio_pci_legacy_func;
 262
 263 extern void device_status (vlib_main_t * vm, virtio_if_t * vif);
 264 void virtio_pci_create_if (vlib_main_t * vm,
 265                            virtio_pci_create_if_args_t * args);
 266 int virtio_pci_delete_if (vlib_main_t * vm, virtio_if_t * ad);
 267 int virtio_pci_enable_disable_offloads (vlib_main_t * vm, virtio_if_t * vif,
 268                                         int gso_enabled,
 269                                         int checksum_offload_enabled,
 270                                         int offloads_disabled);
 271 #endif /* __included_virtio_pci_h__ */
 272 /*
 273  * fd.io coding-style-patch-verification: ON
 274  *
 275  * Local Variables:
 276  * eval: (c-set-style "gnu")
 277  * End:
 278  */