drivers/net/sfc/sfc_rx.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_RX_H
  31 #define _SFC_RX_H
  32
  33 #include <rte_mbuf.h>
  34 #include <rte_mempool.h>
  35 #include <rte_ethdev.h>
  36
  37 #include "efx.h"
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 struct sfc_adapter;
  44 struct sfc_evq;
  45
  46 /**
  47  * Software Rx descriptor information associated with hardware Rx
  48  * descriptor.
  49  */
  50 struct sfc_rx_sw_desc {
  51         struct rte_mbuf         *mbuf;
  52         unsigned int            flags;
  53         unsigned int            size;
  54 };
  55
  56 /** Receive queue state bits */
  57 enum sfc_rxq_state_bit {
  58         SFC_RXQ_INITIALIZED_BIT = 0,
  59 #define SFC_RXQ_INITIALIZED     (1 << SFC_RXQ_INITIALIZED_BIT)
  60         SFC_RXQ_STARTED_BIT,
  61 #define SFC_RXQ_STARTED         (1 << SFC_RXQ_STARTED_BIT)
  62         SFC_RXQ_RUNNING_BIT,
  63 #define SFC_RXQ_RUNNING         (1 << SFC_RXQ_RUNNING_BIT)
  64         SFC_RXQ_FLUSHING_BIT,
  65 #define SFC_RXQ_FLUSHING        (1 << SFC_RXQ_FLUSHING_BIT)
  66         SFC_RXQ_FLUSHED_BIT,
  67 #define SFC_RXQ_FLUSHED         (1 << SFC_RXQ_FLUSHED_BIT)
  68         SFC_RXQ_FLUSH_FAILED_BIT,
  69 #define SFC_RXQ_FLUSH_FAILED    (1 << SFC_RXQ_FLUSH_FAILED_BIT)
  70 };
  71
  72 /**
  73  * Receive queue information used on data path.
  74  * Allocated on the socket specified on the queue setup.
  75  */
  76 struct sfc_rxq {
  77         /* Used on data path */
  78         struct sfc_evq          *evq;
  79         struct sfc_rx_sw_desc   *sw_desc;
  80         unsigned int            state;
  81         unsigned int            ptr_mask;
  82         unsigned int            pending;
  83         unsigned int            completed;
  84         uint16_t                batch_max;
  85         uint16_t                prefix_size;
  86
  87         /* Used on refill */
  88         unsigned int            added;
  89         unsigned int            pushed;
  90         unsigned int            refill_threshold;
  91         uint8_t                 port_id;
  92         uint16_t                buf_size;
  93         struct rte_mempool      *refill_mb_pool;
  94         efx_rxq_t               *common;
  95         efsys_mem_t             mem;
  96
  97         /* Not used on data path */
  98         unsigned int            hw_index;
  99 };
 100
 101 static inline unsigned int
 102 sfc_rxq_sw_index_by_hw_index(unsigned int hw_index)
 103 {
 104         return hw_index;
 105 }
 106
 107 static inline unsigned int
 108 sfc_rxq_sw_index(const struct sfc_rxq *rxq)
 109 {
 110         return sfc_rxq_sw_index_by_hw_index(rxq->hw_index);
 111 }
 112
 113 /**
 114  * Receive queue information used during setup/release only.
 115  * Allocated on the same socket as adapter data.
 116  */
 117 struct sfc_rxq_info {
 118         unsigned int            max_entries;
 119         unsigned int            entries;
 120         efx_rxq_type_t          type;
 121         struct sfc_rxq          *rxq;
 122 };
 123
 124 int sfc_rx_init(struct sfc_adapter *sa);
 125 void sfc_rx_fini(struct sfc_adapter *sa);
 126 int sfc_rx_start(struct sfc_adapter *sa);
 127 void sfc_rx_stop(struct sfc_adapter *sa);
 128
 129 int sfc_rx_qinit(struct sfc_adapter *sa, unsigned int rx_queue_id,
 130                  uint16_t nb_rx_desc, unsigned int socket_id,
 131                  const struct rte_eth_rxconf *rx_conf,
 132                  struct rte_mempool *mb_pool);
 133 void sfc_rx_qfini(struct sfc_adapter *sa, unsigned int sw_index);
 134 int sfc_rx_qstart(struct sfc_adapter *sa, unsigned int sw_index);
 135 void sfc_rx_qstop(struct sfc_adapter *sa, unsigned int sw_index);
 136
 137 void sfc_rx_qflush_done(struct sfc_rxq *rxq);
 138 void sfc_rx_qflush_failed(struct sfc_rxq *rxq);
 139
 140 uint16_t sfc_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 141                        uint16_t nb_pkts);
 142
 143 #ifdef __cplusplus
 144 }
 145 #endif
 146 #endif  /* _SFC_RX_H */