Imported Upstream version 16.04
[deb_dpdk.git] / drivers / net / vmxnet3 / vmxnet3_ring.h
diff --git a/drivers/net/vmxnet3/vmxnet3_ring.h b/drivers/net/vmxnet3/vmxnet3_ring.h
new file mode 100644 (file)
index 0000000..69ff2de
--- /dev/null
@@ -0,0 +1,169 @@
+/*-
+ *   BSD LICENSE
+ *
+ *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
+ *   All rights reserved.
+ *
+ *   Redistribution and use in source and binary forms, with or without
+ *   modification, are permitted provided that the following conditions
+ *   are met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * 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.
+ *     * Neither the name of Intel Corporation nor the names of its
+ *       contributors may be used to endorse or promote products derived
+ *       from this software without specific prior written permission.
+ *
+ *   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 _VMXNET3_RING_H_
+#define _VMXNET3_RING_H_
+
+#define VMXNET3_RX_CMDRING_SIZE 2
+
+#define VMXNET3_DRIVER_VERSION_NUM 0x01012000
+
+/* Default ring size */
+#define VMXNET3_DEF_TX_RING_SIZE 512
+#define VMXNET3_DEF_RX_RING_SIZE 128
+
+#define VMXNET3_SUCCESS 0
+#define VMXNET3_FAIL   -1
+
+#define TRUE  1
+#define FALSE 0
+
+
+typedef struct vmxnet3_buf_info {
+       uint16_t               len;
+       struct rte_mbuf        *m;
+       uint64_t               bufPA;
+} vmxnet3_buf_info_t;
+
+typedef struct vmxnet3_cmd_ring {
+       vmxnet3_buf_info_t     *buf_info;
+       uint32_t               size;
+       uint32_t               next2fill;
+       uint32_t               next2comp;
+       uint8_t                gen;
+       uint8_t                rid;
+       Vmxnet3_GenericDesc    *base;
+       uint64_t               basePA;
+} vmxnet3_cmd_ring_t;
+
+static inline void
+vmxnet3_cmd_ring_adv_next2fill(struct vmxnet3_cmd_ring *ring)
+{
+       ring->next2fill++;
+       if (unlikely(ring->next2fill == ring->size)) {
+               ring->next2fill = 0;
+               ring->gen = (uint8_t)(ring->gen ^ 1);
+       }
+}
+
+static inline void
+vmxnet3_cmd_ring_adv_next2comp(struct vmxnet3_cmd_ring *ring)
+{
+       VMXNET3_INC_RING_IDX_ONLY(ring->next2comp, ring->size);
+}
+
+static inline uint32_t
+vmxnet3_cmd_ring_desc_avail(struct vmxnet3_cmd_ring *ring)
+{
+       return (ring->next2comp > ring->next2fill ? 0 : ring->size) +
+                  ring->next2comp - ring->next2fill - 1;
+}
+
+static inline bool
+vmxnet3_cmd_ring_desc_empty(struct vmxnet3_cmd_ring *ring)
+{
+       return ring->next2comp == ring->next2fill;
+}
+
+typedef struct vmxnet3_comp_ring {
+       uint32_t               size;
+       uint32_t               next2proc;
+       uint8_t                gen;
+       uint8_t                intr_idx;
+       Vmxnet3_GenericDesc    *base;
+       uint64_t               basePA;
+} vmxnet3_comp_ring_t;
+
+struct vmxnet3_data_ring {
+       struct Vmxnet3_TxDataDesc *base;
+       uint32_t                  size;
+       uint64_t                  basePA;
+};
+
+static inline void
+vmxnet3_comp_ring_adv_next2proc(struct vmxnet3_comp_ring *ring)
+{
+       ring->next2proc++;
+       if (unlikely(ring->next2proc == ring->size)) {
+               ring->next2proc = 0;
+               ring->gen = (uint8_t)(ring->gen ^ 1);
+       }
+}
+
+struct vmxnet3_txq_stats {
+       uint64_t        drop_total; /* # of pkts dropped by the driver,
+                                    * the counters below track droppings due to
+                                    * different reasons
+                                    */
+       uint64_t        drop_too_many_segs;
+       uint64_t        drop_tso;
+       uint64_t        tx_ring_full;
+};
+
+typedef struct vmxnet3_tx_queue {
+       struct vmxnet3_hw            *hw;
+       struct vmxnet3_cmd_ring      cmd_ring;
+       struct vmxnet3_comp_ring     comp_ring;
+       struct vmxnet3_data_ring     data_ring;
+       uint32_t                     qid;
+       struct Vmxnet3_TxQueueDesc   *shared;
+       struct vmxnet3_txq_stats     stats;
+       bool                         stopped;
+       uint16_t                     queue_id;      /**< Device TX queue index. */
+       uint8_t                      port_id;       /**< Device port identifier. */
+} vmxnet3_tx_queue_t;
+
+struct vmxnet3_rxq_stats {
+       uint64_t                     drop_total;
+       uint64_t                     drop_err;
+       uint64_t                     drop_fcs;
+       uint64_t                     rx_buf_alloc_failure;
+};
+
+typedef struct vmxnet3_rx_queue {
+       struct rte_mempool          *mp;
+       struct vmxnet3_hw           *hw;
+       struct vmxnet3_cmd_ring     cmd_ring[VMXNET3_RX_CMDRING_SIZE];
+       struct vmxnet3_comp_ring    comp_ring;
+       uint32_t                    qid1;
+       uint32_t                    qid2;
+       Vmxnet3_RxQueueDesc         *shared;
+       struct rte_mbuf             *start_seg;
+       struct rte_mbuf             *last_seg;
+       struct vmxnet3_rxq_stats    stats;
+       bool                        stopped;
+       uint16_t                    queue_id;      /**< Device RX queue index. */
+       uint8_t                     port_id;       /**< Device port identifier. */
+} vmxnet3_rx_queue_t;
+
+#endif /* _VMXNET3_RING_H_ */