net/sfc: move datapath RxQ handle to shared RxQ info
[dpdk.git] / drivers / net / sfc / sfc_rx.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  *
3  * Copyright (c) 2016-2018 Solarflare Communications Inc.
4  * All rights reserved.
5  *
6  * This software was jointly developed between OKTET Labs (under contract
7  * for Solarflare) and Solarflare Communications, Inc.
8  */
9
10 #ifndef _SFC_RX_H
11 #define _SFC_RX_H
12
13 #include <rte_mbuf.h>
14 #include <rte_mempool.h>
15 #include <rte_ethdev_driver.h>
16
17 #include "efx.h"
18
19 #include "sfc_dp_rx.h"
20
21 #ifdef __cplusplus
22 extern "C" {
23 #endif
24
25 struct sfc_adapter;
26 struct sfc_evq;
27
28 /**
29  * Software Rx descriptor information associated with hardware Rx
30  * descriptor.
31  */
32 struct sfc_efx_rx_sw_desc {
33         struct rte_mbuf         *mbuf;
34         unsigned int            flags;
35         unsigned int            size;
36 };
37
38 /** Receive queue state bits */
39 enum sfc_rxq_state_bit {
40         SFC_RXQ_INITIALIZED_BIT = 0,
41 #define SFC_RXQ_INITIALIZED     (1 << SFC_RXQ_INITIALIZED_BIT)
42         SFC_RXQ_STARTED_BIT,
43 #define SFC_RXQ_STARTED         (1 << SFC_RXQ_STARTED_BIT)
44         SFC_RXQ_FLUSHING_BIT,
45 #define SFC_RXQ_FLUSHING        (1 << SFC_RXQ_FLUSHING_BIT)
46         SFC_RXQ_FLUSHED_BIT,
47 #define SFC_RXQ_FLUSHED         (1 << SFC_RXQ_FLUSHED_BIT)
48         SFC_RXQ_FLUSH_FAILED_BIT,
49 #define SFC_RXQ_FLUSH_FAILED    (1 << SFC_RXQ_FLUSH_FAILED_BIT)
50 };
51
52 /**
53  * Receive queue control information.
54  * Allocated on the socket specified on the queue setup.
55  */
56 struct sfc_rxq {
57         struct sfc_evq          *evq;
58         efx_rxq_t               *common;
59         efsys_mem_t             mem;
60         unsigned int            hw_index;
61         uint16_t                buf_size;
62 };
63
64 static inline unsigned int
65 sfc_rxq_sw_index_by_hw_index(unsigned int hw_index)
66 {
67         return hw_index;
68 }
69
70 static inline unsigned int
71 sfc_rxq_sw_index(const struct sfc_rxq *rxq)
72 {
73         return sfc_rxq_sw_index_by_hw_index(rxq->hw_index);
74 }
75
76 struct sfc_rxq *sfc_rxq_by_dp_rxq(const struct sfc_dp_rxq *dp_rxq);
77
78 /**
79  * Receive queue information used on libefx-based data path.
80  * Allocated on the socket specified on the queue setup.
81  */
82 struct sfc_efx_rxq {
83         /* Used on data path */
84         struct sfc_evq                  *evq;
85         unsigned int                    flags;
86 #define SFC_EFX_RXQ_FLAG_STARTED        0x1
87 #define SFC_EFX_RXQ_FLAG_RUNNING        0x2
88 #define SFC_EFX_RXQ_FLAG_RSS_HASH       0x4
89         unsigned int                    ptr_mask;
90         unsigned int                    pending;
91         unsigned int                    completed;
92         uint16_t                        batch_max;
93         uint16_t                        prefix_size;
94         struct sfc_efx_rx_sw_desc       *sw_desc;
95
96         /* Used on refill */
97         unsigned int                    added;
98         unsigned int                    pushed;
99         unsigned int                    max_fill_level;
100         unsigned int                    refill_threshold;
101         uint16_t                        buf_size;
102         struct rte_mempool              *refill_mb_pool;
103         efx_rxq_t                       *common;
104
105         /* Datapath receive queue anchor */
106         struct sfc_dp_rxq               dp;
107 };
108
109 static inline struct sfc_efx_rxq *
110 sfc_efx_rxq_by_dp_rxq(struct sfc_dp_rxq *dp_rxq)
111 {
112         return container_of(dp_rxq, struct sfc_efx_rxq, dp);
113 }
114
115 /**
116  * Receive queue information used during setup/release only.
117  * Allocated on the same socket as adapter data.
118  */
119 struct sfc_rxq_info {
120         unsigned int            state;
121         unsigned int            max_entries;
122         unsigned int            entries;
123         efx_rxq_type_t          type;
124         unsigned int            type_flags;
125         struct sfc_rxq          *rxq;
126         struct sfc_dp_rxq       *dp;
127         boolean_t               deferred_start;
128         boolean_t               deferred_started;
129         unsigned int            refill_threshold;
130         struct rte_mempool      *refill_mb_pool;
131 };
132
133 struct sfc_rxq_info *sfc_rxq_info_by_dp_rxq(const struct sfc_dp_rxq *dp_rxq);
134
135 int sfc_rx_configure(struct sfc_adapter *sa);
136 void sfc_rx_close(struct sfc_adapter *sa);
137 int sfc_rx_start(struct sfc_adapter *sa);
138 void sfc_rx_stop(struct sfc_adapter *sa);
139
140 int sfc_rx_qinit(struct sfc_adapter *sa, unsigned int rx_queue_id,
141                  uint16_t nb_rx_desc, unsigned int socket_id,
142                  const struct rte_eth_rxconf *rx_conf,
143                  struct rte_mempool *mb_pool);
144 void sfc_rx_qfini(struct sfc_adapter *sa, unsigned int sw_index);
145 int sfc_rx_qstart(struct sfc_adapter *sa, unsigned int sw_index);
146 void sfc_rx_qstop(struct sfc_adapter *sa, unsigned int sw_index);
147
148 uint64_t sfc_rx_get_dev_offload_caps(struct sfc_adapter *sa);
149 uint64_t sfc_rx_get_queue_offload_caps(struct sfc_adapter *sa);
150
151 void sfc_rx_qflush_done(struct sfc_rxq_info *rxq_info);
152 void sfc_rx_qflush_failed(struct sfc_rxq_info *rxq_info);
153
154 int sfc_rx_hash_init(struct sfc_adapter *sa);
155 void sfc_rx_hash_fini(struct sfc_adapter *sa);
156 int sfc_rx_hf_rte_to_efx(struct sfc_adapter *sa, uint64_t rte,
157                          efx_rx_hash_type_t *efx);
158 uint64_t sfc_rx_hf_efx_to_rte(struct sfc_adapter *sa,
159                               efx_rx_hash_type_t efx);
160
161 #ifdef __cplusplus
162 }
163 #endif
164 #endif  /* _SFC_RX_H */