drivers/net/sfc/sfc_tx.h

   1 /*-
   2  * Copyright (c) 2016 Solarflare Communications Inc.
   3  * All rights reserved.
   4  *
   5  * This software was jointly developed between OKTET Labs (under contract
   6  * for Solarflare) and Solarflare Communications, Inc.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright notice,
  12  *    this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright notice,
  14  *    this list of conditions and the following disclaimer in the documentation
  15  *    and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  19  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  24  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  25  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  26  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  27  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef _SFC_TX_H
  31 #define _SFC_TX_H
  32
  33 #include <rte_mbuf.h>
  34 #include <rte_ethdev.h>
  35
  36 #include "efx.h"
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 /**
  43  * Estimated maximum number of segments that transmit packet consists of;
  44  * it is determined with respect to the expectation of a packet to consist
  45  * of a header plus a couple of data segments one of those crossing 4K page;
  46  * it is used by transmit path to avoid redundant reaping and, thus,
  47  * to avoid increase of latency
  48  */
  49 #define SFC_TX_MAX_PKT_DESC     4
  50
  51 /**
  52  * A segment must not cross 4K boundary
  53  * (this is a requirement of NIC TX descriptors)
  54  */
  55 #define SFC_TX_SEG_BOUNDARY     4096
  56
  57 struct sfc_adapter;
  58 struct sfc_evq;
  59
  60 struct sfc_tx_sw_desc {
  61         struct rte_mbuf         *mbuf;
  62 };
  63
  64 enum sfc_txq_state_bit {
  65         SFC_TXQ_INITIALIZED_BIT = 0,
  66 #define SFC_TXQ_INITIALIZED     (1 << SFC_TXQ_INITIALIZED_BIT)
  67         SFC_TXQ_STARTED_BIT,
  68 #define SFC_TXQ_STARTED         (1 << SFC_TXQ_STARTED_BIT)
  69         SFC_TXQ_RUNNING_BIT,
  70 #define SFC_TXQ_RUNNING         (1 << SFC_TXQ_RUNNING_BIT)
  71         SFC_TXQ_FLUSHING_BIT,
  72 #define SFC_TXQ_FLUSHING        (1 << SFC_TXQ_FLUSHING_BIT)
  73         SFC_TXQ_FLUSHED_BIT,
  74 #define SFC_TXQ_FLUSHED         (1 << SFC_TXQ_FLUSHED_BIT)
  75 };
  76
  77 struct sfc_txq {
  78         struct sfc_evq          *evq;
  79         struct sfc_tx_sw_desc   *sw_ring;
  80         unsigned int            state;
  81         unsigned int            ptr_mask;
  82         efx_desc_t              *pend_desc;
  83         efx_txq_t               *common;
  84         efsys_mem_t             mem;
  85         unsigned int            added;
  86         unsigned int            pending;
  87         unsigned int            completed;
  88
  89         unsigned int            hw_index;
  90         unsigned int            flags;
  91 };
  92
  93 static inline unsigned int
  94 sfc_txq_sw_index(const struct sfc_txq *txq)
  95 {
  96         return txq->hw_index;
  97 }
  98
  99 struct sfc_txq_info {
 100         unsigned int            entries;
 101         struct sfc_txq          *txq;
 102 };
 103
 104 int sfc_tx_init(struct sfc_adapter *sa);
 105 void sfc_tx_fini(struct sfc_adapter *sa);
 106
 107 int sfc_tx_qinit(struct sfc_adapter *sa, unsigned int sw_index,
 108                  uint16_t nb_tx_desc, unsigned int socket_id,
 109                  const struct rte_eth_txconf *tx_conf);
 110 void sfc_tx_qfini(struct sfc_adapter *sa, unsigned int sw_index);
 111
 112 void sfc_tx_qflush_done(struct sfc_txq *txq);
 113 int sfc_tx_qstart(struct sfc_adapter *sa, unsigned int sw_index);
 114 void sfc_tx_qstop(struct sfc_adapter *sa, unsigned int sw_index);
 115 int sfc_tx_start(struct sfc_adapter *sa);
 116 void sfc_tx_stop(struct sfc_adapter *sa);
 117
 118 uint16_t sfc_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 119                        uint16_t nb_pkts);
 120
 121 #ifdef __cplusplus
 122 }
 123 #endif
 124 #endif  /* _SFC_TX_H */