virtio: refactor pci device code
[vpp.git] / src / vnet / devices / virtio / pci.h
index b08e40e..dfc0711 100644 (file)
 #define VIRTIO_PCI_ABI_VERSION 0
 
 /*
- * VirtIO Header, located in BAR 0.
- */
-#define VIRTIO_PCI_HOST_FEATURES  0    /* host's supported features (32bit, RO) */
-#define VIRTIO_PCI_GUEST_FEATURES 4    /* guest's supported features (32, RW) */
-#define VIRTIO_PCI_QUEUE_PFN      8    /* physical address of VQ (32, RW) */
-#define VIRTIO_PCI_QUEUE_NUM      12   /* number of ring entries (16, RO) */
-#define VIRTIO_PCI_QUEUE_SEL      14   /* current VQ selection (16, RW) */
-#define VIRTIO_PCI_QUEUE_NOTIFY   16   /* notify host regarding VQ (16, RW) */
-#define VIRTIO_PCI_STATUS         18   /* device status register (8, RW) */
-#define VIRTIO_PCI_ISR            19   /* interrupt status register, reading
-                                        * also clears the register (8, RO) */
-/* Only if MSIX is enabled: */
-#define VIRTIO_MSI_CONFIG_VECTOR  20   /* configuration change vector (16, RW) */
-#define VIRTIO_MSI_QUEUE_VECTOR   22   /* vector for selected VQ notifications
-                                          (16, RW) */
-
-/*
+ * Vector value used to disable MSI for queue.
  * define in include/linux/virtio_pci.h
  * #define VIRTIO_MSI_NO_VECTOR 0xFFFF
  */
@@ -45,7 +29,6 @@
 #define VIRTIO_PCI_ISR_INTR   0x1
 /* The bit of the ISR which indicates a device configuration change. */
 #define VIRTIO_PCI_ISR_CONFIG 0x2
-/* Vector value used to disable MSI for queue. */
 
 /* VirtIO device IDs. */
 #define VIRTIO_ID_NETWORK  0x01
@@ -101,10 +84,22 @@ typedef enum
  * at the end of the used ring. Guest should ignore the used->flags field. */ \
   _ (VHOST_USER_F_PROTOCOL_FEATURES, 30)
 
+#define VIRTIO_NET_F_CTRL_GUEST_OFFLOADS 2
 #define VIRTIO_NET_F_MTU 3
 #define VIRTIO_NET_S_LINK_UP    1      /* Link is up */
 #define VIRTIO_NET_S_ANNOUNCE   2      /* Announcement is needed */
 
+/*
+ * Control network offloads
+ * Reconfigures the network offloads that Guest can handle.
+ * Available with the VIRTIO_NET_F_CTRL_GUEST_OFFLOADS feature bit.
+ * Command data format matches the feature bit mask exactly.
+ * See VIRTIO_NET_F_GUEST_* for the list of offloads
+ * that can be enabled/disabled.
+ */
+#define VIRTIO_NET_CTRL_GUEST_OFFLOADS 5
+#define VIRTIO_NET_CTRL_GUEST_OFFLOADS_SET 0
+
 /* Common configuration */
 #define VIRTIO_PCI_CAP_COMMON_CFG       1
 /* Notifications */
@@ -120,27 +115,6 @@ typedef enum
 
 #define VIRTIO_PCI_VRING_ALIGN 4096
 
-#define virtio_log_debug(vim, vif, f, ...)                     \
-{                                                              \
-  vlib_log(VLIB_LOG_LEVEL_DEBUG, vim->log_default, "%U: " f,   \
-           format_vlib_pci_addr, &vif->pci_addr,               \
-           ##__VA_ARGS__);                                     \
-};
-
-#define virtio_log_warning(vim, vif, f, ...)                   \
-{                                                              \
-  vlib_log(VLIB_LOG_LEVEL_WARNING, vim->log_default, "%U: " f, \
-           format_vlib_pci_addr, &vif->pci_addr,               \
-           ##__VA_ARGS__);                                     \
-};
-
-#define virtio_log_error(vim, vif, f, ...)                     \
-{                                                              \
-  vlib_log(VLIB_LOG_LEVEL_ERR, vim->log_default, "%U: " f,     \
-           format_vlib_pci_addr, &vif->pci_addr,               \
-           ##__VA_ARGS__);                                     \
-};
-
 typedef enum
 {
   VIRTIO_MSIX_NONE = 0,
@@ -194,6 +168,14 @@ typedef struct
   u32 queue_used_hi;           /* read-write */
 } virtio_pci_common_cfg_t;
 
+typedef struct
+{
+  u8 mac[6];
+  u16 status;
+  u16 max_virtqueue_pairs;
+  u16 mtu;
+} virtio_net_config_t;
+
 typedef struct
 {
   u64 addr;
@@ -224,26 +206,68 @@ typedef struct
   /* u16 avail_event; */
 } vring_used_t;
 
+typedef struct _virtio_pci_func
+{
+  void (*read_config) (vlib_main_t * vm, virtio_if_t * vif, void *dst,
+                      int len, u32 addr);
+  void (*write_config) (vlib_main_t * vm, virtio_if_t * vif, void *src,
+                       int len, u32 addr);
+
+    u64 (*get_device_features) (vlib_main_t * vm, virtio_if_t * vif);
+    u64 (*get_driver_features) (vlib_main_t * vm, virtio_if_t * vif);
+  void (*set_driver_features) (vlib_main_t * vm, virtio_if_t * vif,
+                              u64 features);
+
+    u8 (*get_status) (vlib_main_t * vm, virtio_if_t * vif);
+  void (*set_status) (vlib_main_t * vm, virtio_if_t * vif, u8 status);
+    u8 (*device_reset) (vlib_main_t * vm, virtio_if_t * vif);
+
+    u8 (*get_isr) (vlib_main_t * vm, virtio_if_t * vif);
+
+    u16 (*get_queue_size) (vlib_main_t * vm, virtio_if_t * vif, u16 queue_id);
+  void (*set_queue_size) (vlib_main_t * vm, virtio_if_t * vif, u16 queue_id,
+                         u16 queue_size);
+    u8 (*setup_queue) (vlib_main_t * vm, virtio_if_t * vif, u16 queue_id,
+                      void *p);
+  void (*del_queue) (vlib_main_t * vm, virtio_if_t * vif, u16 queue_id);
+  void (*notify_queue) (vlib_main_t * vm, virtio_if_t * vif, u16 queue_id);
+
+    u16 (*set_config_irq) (vlib_main_t * vm, virtio_if_t * vif, u16 vec);
+    u16 (*set_queue_irq) (vlib_main_t * vm, virtio_if_t * vif, u16 vec,
+                         u16 queue_id);
+
+  void (*get_mac) (vlib_main_t * vm, virtio_if_t * vif);
+  void (*set_mac) (vlib_main_t * vm, virtio_if_t * vif);
+    u16 (*get_device_status) (vlib_main_t * vm, virtio_if_t * vif);
+    u16 (*get_max_queue_pairs) (vlib_main_t * vm, virtio_if_t * vif);
+    u16 (*get_mtu) (vlib_main_t * vm, virtio_if_t * vif);
+  void (*device_debug_config_space) (vlib_main_t * vm, virtio_if_t * vif);
+} virtio_pci_func_t;
+
 typedef struct
 {
   u32 addr;
-  u16 rxq_size;
-  u16 txq_size;
   /* return */
   i32 rv;
   u32 sw_if_index;
   u8 mac_addr_set;
   u8 mac_addr[6];
   u64 features;
+  u8 gso_enabled;
+  u8 checksum_offload_enabled;
   clib_error_t *error;
 } virtio_pci_create_if_args_t;
 
-extern void debug_device_config_space (vlib_main_t * vm, virtio_if_t * vif);
+extern const virtio_pci_func_t virtio_pci_legacy_func;
+
 extern void device_status (vlib_main_t * vm, virtio_if_t * vif);
 void virtio_pci_create_if (vlib_main_t * vm,
                           virtio_pci_create_if_args_t * args);
 int virtio_pci_delete_if (vlib_main_t * vm, virtio_if_t * ad);
-
+int virtio_pci_enable_disable_offloads (vlib_main_t * vm, virtio_if_t * vif,
+                                       int gso_enabled,
+                                       int checksum_offload_enabled,
+                                       int offloads_disabled);
 #endif /* __included_virtio_pci_h__ */
 /*
  * fd.io coding-style-patch-verification: ON