net/iavf/base: move to drivers common directory
[dpdk.git] / drivers / net / iavf / iavf.h
index dcf8d1c..fe25d80 100644 (file)
@@ -2,82 +2,92 @@
  * Copyright(c) 2017 Intel Corporation
  */
 
-#ifndef _AVF_ETHDEV_H_
-#define _AVF_ETHDEV_H_
+#ifndef _IAVF_ETHDEV_H_
+#define _IAVF_ETHDEV_H_
 
 #include <rte_kvargs.h>
+#include <iavf_prototype.h>
+#include <iavf_adminq_cmd.h>
+#include <iavf_type.h>
 
-#define AVF_AQ_LEN               32
-#define AVF_AQ_BUF_SZ            4096
-#define AVF_RESET_WAIT_CNT       50
-#define AVF_BUF_SIZE_MIN         1024
-#define AVF_FRAME_SIZE_MAX       9728
-#define AVF_QUEUE_BASE_ADDR_UNIT 128
+#include "iavf_log.h"
 
-#define AVF_MAX_NUM_QUEUES       16
+#define IAVF_AQ_LEN               32
+#define IAVF_AQ_BUF_SZ            4096
+#define IAVF_RESET_WAIT_CNT       50
+#define IAVF_BUF_SIZE_MIN         1024
+#define IAVF_FRAME_SIZE_MAX       9728
+#define IAVF_QUEUE_BASE_ADDR_UNIT 128
 
-#define AVF_NUM_MACADDR_MAX      64
+#define IAVF_MAX_NUM_QUEUES       16
 
-#define AVF_DEFAULT_RX_PTHRESH      8
-#define AVF_DEFAULT_RX_HTHRESH      8
-#define AVF_DEFAULT_RX_WTHRESH      0
+#define IAVF_NUM_MACADDR_MAX      64
 
-#define AVF_DEFAULT_RX_FREE_THRESH  32
+#define IAVF_DEFAULT_RX_PTHRESH      8
+#define IAVF_DEFAULT_RX_HTHRESH      8
+#define IAVF_DEFAULT_RX_WTHRESH      0
 
-#define AVF_DEFAULT_TX_PTHRESH      32
-#define AVF_DEFAULT_TX_HTHRESH      0
-#define AVF_DEFAULT_TX_WTHRESH      0
+#define IAVF_DEFAULT_RX_FREE_THRESH  32
 
-#define AVF_DEFAULT_TX_FREE_THRESH  32
-#define AVF_DEFAULT_TX_RS_THRESH 32
+#define IAVF_DEFAULT_TX_PTHRESH      32
+#define IAVF_DEFAULT_TX_HTHRESH      0
+#define IAVF_DEFAULT_TX_WTHRESH      0
 
-#define AVF_BASIC_OFFLOAD_CAPS  ( \
+#define IAVF_DEFAULT_TX_FREE_THRESH  32
+#define IAVF_DEFAULT_TX_RS_THRESH 32
+
+#define IAVF_BASIC_OFFLOAD_CAPS  ( \
        VF_BASE_MODE_OFFLOADS | \
        VIRTCHNL_VF_OFFLOAD_WB_ON_ITR | \
        VIRTCHNL_VF_OFFLOAD_RX_POLLING)
 
-#define AVF_RSS_OFFLOAD_ALL ( \
+#define IAVF_RSS_OFFLOAD_ALL ( \
        ETH_RSS_FRAG_IPV4 |         \
        ETH_RSS_NONFRAG_IPV4_TCP |  \
        ETH_RSS_NONFRAG_IPV4_UDP |  \
        ETH_RSS_NONFRAG_IPV4_SCTP | \
        ETH_RSS_NONFRAG_IPV4_OTHER)
 
-#define AVF_MISC_VEC_ID                RTE_INTR_VEC_ZERO_OFFSET
-#define AVF_RX_VEC_START               RTE_INTR_VEC_RXTX_OFFSET
+#define IAVF_MISC_VEC_ID                RTE_INTR_VEC_ZERO_OFFSET
+#define IAVF_RX_VEC_START               RTE_INTR_VEC_RXTX_OFFSET
 
 /* Default queue interrupt throttling time in microseconds */
-#define AVF_ITR_INDEX_DEFAULT          0
-#define AVF_QUEUE_ITR_INTERVAL_DEFAULT 32 /* 32 us */
-#define AVF_QUEUE_ITR_INTERVAL_MAX     8160 /* 8160 us */
+#define IAVF_ITR_INDEX_DEFAULT          0
+#define IAVF_QUEUE_ITR_INTERVAL_DEFAULT 32 /* 32 us */
+#define IAVF_QUEUE_ITR_INTERVAL_MAX     8160 /* 8160 us */
 
 /* The overhead from MTU to max frame size.
  * Considering QinQ packet, the VLAN tag needs to be counted twice.
  */
-#define AVF_VLAN_TAG_SIZE               4
-#define AVF_ETH_OVERHEAD \
-       (ETHER_HDR_LEN + ETHER_CRC_LEN + AVF_VLAN_TAG_SIZE * 2)
+#define IAVF_VLAN_TAG_SIZE               4
+#define IAVF_ETH_OVERHEAD \
+       (RTE_ETHER_HDR_LEN + RTE_ETHER_CRC_LEN + IAVF_VLAN_TAG_SIZE * 2)
+
+#define IAVF_32_BIT_WIDTH (CHAR_BIT * 4)
+#define IAVF_48_BIT_WIDTH (CHAR_BIT * 6)
+#define IAVF_48_BIT_MASK  RTE_LEN2MASK(IAVF_48_BIT_WIDTH, uint64_t)
 
-struct avf_adapter;
-struct avf_rx_queue;
-struct avf_tx_queue;
+struct iavf_adapter;
+struct iavf_rx_queue;
+struct iavf_tx_queue;
 
 /* Structure that defines a VSI, associated with a adapter. */
-struct avf_vsi {
-       struct avf_adapter *adapter; /* Backreference to associated adapter */
+struct iavf_vsi {
+       struct iavf_adapter *adapter; /* Backreference to associated adapter */
        uint16_t vsi_id;
        uint16_t nb_qps;         /* Number of queue pairs VSI can occupy */
        uint16_t nb_used_qps;    /* Number of queue pairs VSI uses */
        uint16_t max_macaddrs;   /* Maximum number of MAC addresses */
        uint16_t base_vector;
        uint16_t msix_intr;      /* The MSIX interrupt binds to VSI */
+       struct virtchnl_eth_stats eth_stats_offset;
 };
 
 /* TODO: is that correct to assume the max number to be 16 ?*/
-#define AVF_MAX_MSIX_VECTORS   16
+#define IAVF_MAX_MSIX_VECTORS   16
 
 /* Structure to store private data specific for VF instance. */
-struct avf_info {
+struct iavf_info {
        uint16_t num_queue_pairs;
        uint16_t max_pkt_len; /* Maximum packet length */
        uint16_t mac_num;     /* Number of MAC addresses */
@@ -95,9 +105,9 @@ struct avf_info {
        /* Event from pf */
        bool dev_closed;
        bool link_up;
-       enum virtchnl_link_speed link_speed;
+       uint32_t link_speed;
 
-       struct avf_vsi vsi;
+       struct iavf_vsi vsi;
        bool vf_reset;
        uint64_t flags;
 
@@ -106,60 +116,61 @@ struct avf_info {
        uint16_t nb_msix;   /* number of MSI-X interrupts on Rx */
        uint16_t msix_base; /* msix vector base from */
        /* queue bitmask for each vector */
-       uint16_t rxq_map[AVF_MAX_MSIX_VECTORS];
+       uint16_t rxq_map[IAVF_MAX_MSIX_VECTORS];
 };
 
-#define AVF_MAX_PKT_TYPE 256
+#define IAVF_MAX_PKT_TYPE 256
 
 /* Structure to store private data for each VF instance. */
-struct avf_adapter {
-       struct avf_hw hw;
+struct iavf_adapter {
+       struct iavf_hw hw;
        struct rte_eth_dev *eth_dev;
-       struct avf_info vf;
+       struct iavf_info vf;
 
        bool rx_bulk_alloc_allowed;
        /* For vector PMD */
        bool rx_vec_allowed;
        bool tx_vec_allowed;
+       bool stopped;
 };
 
-/* AVF_DEV_PRIVATE_TO */
-#define AVF_DEV_PRIVATE_TO_ADAPTER(adapter) \
-       ((struct avf_adapter *)adapter)
-#define AVF_DEV_PRIVATE_TO_VF(adapter) \
-       (&((struct avf_adapter *)adapter)->vf)
-#define AVF_DEV_PRIVATE_TO_HW(adapter) \
-       (&((struct avf_adapter *)adapter)->hw)
-
-/* AVF_VSI_TO */
-#define AVF_VSI_TO_HW(vsi) \
-       (&(((struct avf_vsi *)vsi)->adapter->hw))
-#define AVF_VSI_TO_VF(vsi) \
-       (&(((struct avf_vsi *)vsi)->adapter->vf))
-#define AVF_VSI_TO_ETH_DEV(vsi) \
-       (((struct avf_vsi *)vsi)->adapter->eth_dev)
+/* IAVF_DEV_PRIVATE_TO */
+#define IAVF_DEV_PRIVATE_TO_ADAPTER(adapter) \
+       ((struct iavf_adapter *)adapter)
+#define IAVF_DEV_PRIVATE_TO_VF(adapter) \
+       (&((struct iavf_adapter *)adapter)->vf)
+#define IAVF_DEV_PRIVATE_TO_HW(adapter) \
+       (&((struct iavf_adapter *)adapter)->hw)
+
+/* IAVF_VSI_TO */
+#define IAVF_VSI_TO_HW(vsi) \
+       (&(((struct iavf_vsi *)vsi)->adapter->hw))
+#define IAVF_VSI_TO_VF(vsi) \
+       (&(((struct iavf_vsi *)vsi)->adapter->vf))
+#define IAVF_VSI_TO_ETH_DEV(vsi) \
+       (((struct iavf_vsi *)vsi)->adapter->eth_dev)
 
 static inline void
-avf_init_adminq_parameter(struct avf_hw *hw)
+iavf_init_adminq_parameter(struct iavf_hw *hw)
 {
-       hw->aq.num_arq_entries = AVF_AQ_LEN;
-       hw->aq.num_asq_entries = AVF_AQ_LEN;
-       hw->aq.arq_buf_size = AVF_AQ_BUF_SZ;
-       hw->aq.asq_buf_size = AVF_AQ_BUF_SZ;
+       hw->aq.num_arq_entries = IAVF_AQ_LEN;
+       hw->aq.num_asq_entries = IAVF_AQ_LEN;
+       hw->aq.arq_buf_size = IAVF_AQ_BUF_SZ;
+       hw->aq.asq_buf_size = IAVF_AQ_BUF_SZ;
 }
 
 static inline uint16_t
-avf_calc_itr_interval(int16_t interval)
+iavf_calc_itr_interval(int16_t interval)
 {
-       if (interval < 0 || interval > AVF_QUEUE_ITR_INTERVAL_MAX)
-               interval = AVF_QUEUE_ITR_INTERVAL_DEFAULT;
+       if (interval < 0 || interval > IAVF_QUEUE_ITR_INTERVAL_MAX)
+               interval = IAVF_QUEUE_ITR_INTERVAL_DEFAULT;
 
        /* Convert to hardware count, as writing each 1 represents 2 us */
        return interval / 2;
 }
 
 /* structure used for sending and checking response of virtchnl ops */
-struct avf_cmd_info {
+struct iavf_cmd_info {
        enum virtchnl_ops ops;
        uint8_t *in_args;       /* buffer for sending */
        uint32_t in_args_size;  /* buffer size for sending */
@@ -167,11 +178,22 @@ struct avf_cmd_info {
        uint32_t out_size;      /* buffer size for response */
 };
 
+/* notify current command done. Only call in case execute
+ * _atomic_set_cmd successfully.
+ */
+static inline void
+_notify_cmd(struct iavf_info *vf, uint32_t msg_ret)
+{
+       vf->cmd_retval = msg_ret;
+       rte_wmb();
+       vf->pend_cmd = VIRTCHNL_OP_UNKNOWN;
+}
+
 /* clear current command. Only call in case execute
  * _atomic_set_cmd successfully.
  */
 static inline void
-_clear_cmd(struct avf_info *vf)
+_clear_cmd(struct iavf_info *vf)
 {
        rte_wmb();
        vf->pend_cmd = VIRTCHNL_OP_UNKNOWN;
@@ -180,7 +202,7 @@ _clear_cmd(struct avf_info *vf)
 
 /* Check there is pending cmd in execution. If none, set new command. */
 static inline int
-_atomic_set_cmd(struct avf_info *vf, enum virtchnl_ops ops)
+_atomic_set_cmd(struct iavf_info *vf, enum virtchnl_ops ops)
 {
        int ret = rte_atomic32_cmpset(&vf->pend_cmd, VIRTCHNL_OP_UNKNOWN, ops);
 
@@ -190,27 +212,27 @@ _atomic_set_cmd(struct avf_info *vf, enum virtchnl_ops ops)
        return !ret;
 }
 
-int avf_check_api_version(struct avf_adapter *adapter);
-int avf_get_vf_resource(struct avf_adapter *adapter);
-void avf_handle_virtchnl_msg(struct rte_eth_dev *dev);
-int avf_enable_vlan_strip(struct avf_adapter *adapter);
-int avf_disable_vlan_strip(struct avf_adapter *adapter);
-int avf_switch_queue(struct avf_adapter *adapter, uint16_t qid,
+int iavf_check_api_version(struct iavf_adapter *adapter);
+int iavf_get_vf_resource(struct iavf_adapter *adapter);
+void iavf_handle_virtchnl_msg(struct rte_eth_dev *dev);
+int iavf_enable_vlan_strip(struct iavf_adapter *adapter);
+int iavf_disable_vlan_strip(struct iavf_adapter *adapter);
+int iavf_switch_queue(struct iavf_adapter *adapter, uint16_t qid,
                     bool rx, bool on);
-int avf_enable_queues(struct avf_adapter *adapter);
-int avf_disable_queues(struct avf_adapter *adapter);
-int avf_configure_rss_lut(struct avf_adapter *adapter);
-int avf_configure_rss_key(struct avf_adapter *adapter);
-int avf_configure_queues(struct avf_adapter *adapter);
-int avf_config_irq_map(struct avf_adapter *adapter);
-void avf_add_del_all_mac_addr(struct avf_adapter *adapter, bool add);
-int avf_dev_link_update(struct rte_eth_dev *dev,
+int iavf_enable_queues(struct iavf_adapter *adapter);
+int iavf_disable_queues(struct iavf_adapter *adapter);
+int iavf_configure_rss_lut(struct iavf_adapter *adapter);
+int iavf_configure_rss_key(struct iavf_adapter *adapter);
+int iavf_configure_queues(struct iavf_adapter *adapter);
+int iavf_config_irq_map(struct iavf_adapter *adapter);
+void iavf_add_del_all_mac_addr(struct iavf_adapter *adapter, bool add);
+int iavf_dev_link_update(struct rte_eth_dev *dev,
                        __rte_unused int wait_to_complete);
-int avf_query_stats(struct avf_adapter *adapter,
+int iavf_query_stats(struct iavf_adapter *adapter,
                    struct virtchnl_eth_stats **pstats);
-int avf_config_promisc(struct avf_adapter *adapter, bool enable_unicast,
+int iavf_config_promisc(struct iavf_adapter *adapter, bool enable_unicast,
                       bool enable_multicast);
-int avf_add_del_eth_addr(struct avf_adapter *adapter,
-                        struct ether_addr *addr, bool add);
-int avf_add_del_vlan(struct avf_adapter *adapter, uint16_t vlanid, bool add);
-#endif /* _AVF_ETHDEV_H_ */
+int iavf_add_del_eth_addr(struct iavf_adapter *adapter,
+                        struct rte_ether_addr *addr, bool add);
+int iavf_add_del_vlan(struct iavf_adapter *adapter, uint16_t vlanid, bool add);
+#endif /* _IAVF_ETHDEV_H_ */