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_FLUSHING_BIT,
  63 #define SFC_RXQ_FLUSHING        (1 << SFC_RXQ_FLUSHING_BIT)
  64         SFC_RXQ_FLUSHED_BIT,
  65 #define SFC_RXQ_FLUSHED         (1 << SFC_RXQ_FLUSHED_BIT)
  66         SFC_RXQ_FLUSH_FAILED_BIT,
  67 #define SFC_RXQ_FLUSH_FAILED    (1 << SFC_RXQ_FLUSH_FAILED_BIT)
  68 };
  69
  70 /**
  71  * Receive queue information used on data path.
  72  * Allocated on the socket specified on the queue setup.
  73  */
  74 struct sfc_rxq {
  75         /* Used on data path */
  76         struct sfc_evq          *evq;
  77         struct sfc_rx_sw_desc   *sw_desc;
  78         unsigned int            state;
  79         unsigned int            ptr_mask;
  80         unsigned int            pending;
  81         unsigned int            completed;
  82
  83         /* Used on refill */
  84         unsigned int            added;
  85         unsigned int            pushed;
  86         uint8_t                 port_id;
  87         uint16_t                buf_size;
  88         struct rte_mempool      *refill_mb_pool;
  89         efx_rxq_t               *common;
  90         efsys_mem_t             mem;
  91
  92         /* Not used on data path */
  93         unsigned int            hw_index;
  94 };
  95
  96 static inline unsigned int
  97 sfc_rxq_sw_index_by_hw_index(unsigned int hw_index)
  98 {
  99         return hw_index;
 100 }
 101
 102 static inline unsigned int
 103 sfc_rxq_sw_index(const struct sfc_rxq *rxq)
 104 {
 105         return sfc_rxq_sw_index_by_hw_index(rxq->hw_index);
 106 }
 107
 108 /**
 109  * Receive queue information used during setup/release only.
 110  * Allocated on the same socket as adapter data.
 111  */
 112 struct sfc_rxq_info {
 113         unsigned int            max_entries;
 114         unsigned int            entries;
 115         efx_rxq_type_t          type;
 116         struct sfc_rxq          *rxq;
 117 };
 118
 119 int sfc_rx_init(struct sfc_adapter *sa);
 120 void sfc_rx_fini(struct sfc_adapter *sa);
 121 int sfc_rx_start(struct sfc_adapter *sa);
 122 void sfc_rx_stop(struct sfc_adapter *sa);
 123
 124 int sfc_rx_qinit(struct sfc_adapter *sa, unsigned int rx_queue_id,
 125                  uint16_t nb_rx_desc, unsigned int socket_id,
 126                  const struct rte_eth_rxconf *rx_conf,
 127                  struct rte_mempool *mb_pool);
 128 void sfc_rx_qfini(struct sfc_adapter *sa, unsigned int sw_index);
 129 int sfc_rx_qstart(struct sfc_adapter *sa, unsigned int sw_index);
 130 void sfc_rx_qstop(struct sfc_adapter *sa, unsigned int sw_index);
 131
 132 void sfc_rx_qflush_done(struct sfc_rxq *rxq);
 133 void sfc_rx_qflush_failed(struct sfc_rxq *rxq);
 134
 135 #ifdef __cplusplus
 136 }
 137 #endif
 138 #endif  /* _SFC_RX_H */