Imported Upstream version 17.05
[deb_dpdk.git] / drivers / net / sfc / sfc_rx.h
diff --git a/drivers/net/sfc/sfc_rx.h b/drivers/net/sfc/sfc_rx.h
new file mode 100644 (file)
index 0000000..9e6282e
--- /dev/null
@@ -0,0 +1,180 @@
+/*-
+ *   BSD LICENSE
+ *
+ * Copyright (c) 2016-2017 Solarflare Communications Inc.
+ * All rights reserved.
+ *
+ * This software was jointly developed between OKTET Labs (under contract
+ * for Solarflare) and Solarflare Communications, Inc.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+ * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+ * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+ * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef _SFC_RX_H
+#define _SFC_RX_H
+
+#include <rte_mbuf.h>
+#include <rte_mempool.h>
+#include <rte_ethdev.h>
+
+#include "efx.h"
+
+#include "sfc_dp_rx.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct sfc_adapter;
+struct sfc_evq;
+
+/**
+ * Software Rx descriptor information associated with hardware Rx
+ * descriptor.
+ */
+struct sfc_efx_rx_sw_desc {
+       struct rte_mbuf         *mbuf;
+       unsigned int            flags;
+       unsigned int            size;
+};
+
+/** Receive queue state bits */
+enum sfc_rxq_state_bit {
+       SFC_RXQ_INITIALIZED_BIT = 0,
+#define SFC_RXQ_INITIALIZED    (1 << SFC_RXQ_INITIALIZED_BIT)
+       SFC_RXQ_STARTED_BIT,
+#define SFC_RXQ_STARTED                (1 << SFC_RXQ_STARTED_BIT)
+       SFC_RXQ_FLUSHING_BIT,
+#define SFC_RXQ_FLUSHING       (1 << SFC_RXQ_FLUSHING_BIT)
+       SFC_RXQ_FLUSHED_BIT,
+#define SFC_RXQ_FLUSHED                (1 << SFC_RXQ_FLUSHED_BIT)
+       SFC_RXQ_FLUSH_FAILED_BIT,
+#define SFC_RXQ_FLUSH_FAILED   (1 << SFC_RXQ_FLUSH_FAILED_BIT)
+};
+
+/**
+ * Receive queue control information.
+ * Allocated on the socket specified on the queue setup.
+ */
+struct sfc_rxq {
+       struct sfc_evq          *evq;
+       efx_rxq_t               *common;
+       efsys_mem_t             mem;
+       unsigned int            hw_index;
+       unsigned int            refill_threshold;
+       struct rte_mempool      *refill_mb_pool;
+       struct sfc_dp_rxq       *dp;
+       unsigned int            state;
+};
+
+static inline unsigned int
+sfc_rxq_sw_index_by_hw_index(unsigned int hw_index)
+{
+       return hw_index;
+}
+
+static inline unsigned int
+sfc_rxq_sw_index(const struct sfc_rxq *rxq)
+{
+       return sfc_rxq_sw_index_by_hw_index(rxq->hw_index);
+}
+
+struct sfc_rxq *sfc_rxq_by_dp_rxq(const struct sfc_dp_rxq *dp_rxq);
+
+/**
+ * Receive queue information used on libefx-based data path.
+ * Allocated on the socket specified on the queue setup.
+ */
+struct sfc_efx_rxq {
+       /* Used on data path */
+       struct sfc_evq                  *evq;
+       unsigned int                    flags;
+#define SFC_EFX_RXQ_FLAG_STARTED       0x1
+#define SFC_EFX_RXQ_FLAG_RUNNING       0x2
+#define SFC_EFX_RXQ_FLAG_RSS_HASH      0x4
+       unsigned int                    ptr_mask;
+       unsigned int                    pending;
+       unsigned int                    completed;
+       uint16_t                        batch_max;
+       uint16_t                        prefix_size;
+       struct sfc_efx_rx_sw_desc       *sw_desc;
+
+       /* Used on refill */
+       unsigned int                    added;
+       unsigned int                    pushed;
+       unsigned int                    refill_threshold;
+       uint16_t                        buf_size;
+       struct rte_mempool              *refill_mb_pool;
+       efx_rxq_t                       *common;
+
+       /* Datapath receive queue anchor */
+       struct sfc_dp_rxq               dp;
+};
+
+static inline struct sfc_efx_rxq *
+sfc_efx_rxq_by_dp_rxq(struct sfc_dp_rxq *dp_rxq)
+{
+       return container_of(dp_rxq, struct sfc_efx_rxq, dp);
+}
+
+/**
+ * Receive queue information used during setup/release only.
+ * Allocated on the same socket as adapter data.
+ */
+struct sfc_rxq_info {
+       unsigned int            max_entries;
+       unsigned int            entries;
+       efx_rxq_type_t          type;
+       struct sfc_rxq          *rxq;
+       boolean_t               deferred_start;
+       boolean_t               deferred_started;
+};
+
+int sfc_rx_configure(struct sfc_adapter *sa);
+void sfc_rx_close(struct sfc_adapter *sa);
+int sfc_rx_start(struct sfc_adapter *sa);
+void sfc_rx_stop(struct sfc_adapter *sa);
+
+int sfc_rx_qinit(struct sfc_adapter *sa, unsigned int rx_queue_id,
+                uint16_t nb_rx_desc, unsigned int socket_id,
+                const struct rte_eth_rxconf *rx_conf,
+                struct rte_mempool *mb_pool);
+void sfc_rx_qfini(struct sfc_adapter *sa, unsigned int sw_index);
+int sfc_rx_qstart(struct sfc_adapter *sa, unsigned int sw_index);
+void sfc_rx_qstop(struct sfc_adapter *sa, unsigned int sw_index);
+
+void sfc_rx_qflush_done(struct sfc_rxq *rxq);
+void sfc_rx_qflush_failed(struct sfc_rxq *rxq);
+
+unsigned int sfc_rx_qdesc_npending(struct sfc_adapter *sa,
+                                  unsigned int sw_index);
+int sfc_rx_qdesc_done(struct sfc_dp_rxq *dp_rxq, unsigned int offset);
+
+#if EFSYS_OPT_RX_SCALE
+efx_rx_hash_type_t sfc_rte_to_efx_hash_type(uint64_t rss_hf);
+uint64_t sfc_efx_to_rte_hash_type(efx_rx_hash_type_t efx_hash_types);
+#endif
+
+#ifdef __cplusplus
+}
+#endif
+#endif  /* _SFC_RX_H */