net/failsafe: fix crash on slave queue release
[dpdk.git] / drivers / net / sfc / sfc.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_H
11 #define _SFC_H
12
13 #include <stdbool.h>
14
15 #include <rte_pci.h>
16 #include <rte_bus_pci.h>
17 #include <rte_ethdev_driver.h>
18 #include <rte_kvargs.h>
19 #include <rte_spinlock.h>
20 #include <rte_atomic.h>
21
22 #include "efx.h"
23
24 #include "sfc_filter.h"
25
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29
30 /*
31  * +---------------+
32  * | UNINITIALIZED |<-----------+
33  * +---------------+            |
34  *      |.eth_dev_init          |.eth_dev_uninit
35  *      V                       |
36  * +---------------+------------+
37  * |  INITIALIZED  |
38  * +---------------+<-----------<---------------+
39  *      |.dev_configure         |               |
40  *      V                       |failed         |
41  * +---------------+------------+               |
42  * |  CONFIGURING  |                            |
43  * +---------------+----+                       |
44  *      |success        |                       |
45  *      |               |               +---------------+
46  *      |               |               |    CLOSING    |
47  *      |               |               +---------------+
48  *      |               |                       ^
49  *      V               |.dev_configure         |
50  * +---------------+----+                       |.dev_close
51  * |  CONFIGURED   |----------------------------+
52  * +---------------+<-----------+
53  *      |.dev_start             |
54  *      V                       |
55  * +---------------+            |
56  * |   STARTING    |------------^
57  * +---------------+ failed     |
58  *      |success                |
59  *      |               +---------------+
60  *      |               |   STOPPING    |
61  *      |               +---------------+
62  *      |                       ^
63  *      V                       |.dev_stop
64  * +---------------+------------+
65  * |    STARTED    |
66  * +---------------+
67  */
68 enum sfc_adapter_state {
69         SFC_ADAPTER_UNINITIALIZED = 0,
70         SFC_ADAPTER_INITIALIZED,
71         SFC_ADAPTER_CONFIGURING,
72         SFC_ADAPTER_CONFIGURED,
73         SFC_ADAPTER_CLOSING,
74         SFC_ADAPTER_STARTING,
75         SFC_ADAPTER_STARTED,
76         SFC_ADAPTER_STOPPING,
77
78         SFC_ADAPTER_NSTATES
79 };
80
81 enum sfc_dev_filter_mode {
82         SFC_DEV_FILTER_MODE_PROMISC = 0,
83         SFC_DEV_FILTER_MODE_ALLMULTI,
84
85         SFC_DEV_FILTER_NMODES
86 };
87
88 enum sfc_mcdi_state {
89         SFC_MCDI_UNINITIALIZED = 0,
90         SFC_MCDI_INITIALIZED,
91         SFC_MCDI_BUSY,
92         SFC_MCDI_COMPLETED,
93
94         SFC_MCDI_NSTATES
95 };
96
97 struct sfc_mcdi {
98         rte_spinlock_t                  lock;
99         efsys_mem_t                     mem;
100         enum sfc_mcdi_state             state;
101         efx_mcdi_transport_t            transport;
102         uint32_t                        logtype;
103         uint32_t                        proxy_handle;
104         efx_rc_t                        proxy_result;
105 };
106
107 struct sfc_intr {
108         efx_intr_type_t                 type;
109         rte_intr_callback_fn            handler;
110         boolean_t                       lsc_intr;
111 };
112
113 struct sfc_rxq_info;
114 struct sfc_txq_info;
115 struct sfc_dp_rx;
116
117 struct sfc_port {
118         unsigned int                    lsc_seq;
119
120         uint32_t                        phy_adv_cap_mask;
121         uint32_t                        phy_adv_cap;
122
123         unsigned int                    flow_ctrl;
124         boolean_t                       flow_ctrl_autoneg;
125         size_t                          pdu;
126
127         /*
128          * Flow API isolated mode overrides promisc and allmulti settings;
129          * they won't be applied if isolated mode is active
130          */
131         boolean_t                       isolated;
132         boolean_t                       promisc;
133         boolean_t                       allmulti;
134
135         struct ether_addr               default_mac_addr;
136
137         unsigned int                    max_mcast_addrs;
138         unsigned int                    nb_mcast_addrs;
139         uint8_t                         *mcast_addrs;
140
141         rte_spinlock_t                  mac_stats_lock;
142         uint64_t                        *mac_stats_buf;
143         unsigned int                    mac_stats_nb_supported;
144         efsys_mem_t                     mac_stats_dma_mem;
145         boolean_t                       mac_stats_reset_pending;
146         uint16_t                        mac_stats_update_period_ms;
147         uint32_t                        mac_stats_update_generation;
148         boolean_t                       mac_stats_periodic_dma_supported;
149         uint64_t                        mac_stats_last_request_timestamp;
150
151         uint32_t                mac_stats_mask[EFX_MAC_STATS_MASK_NPAGES];
152 };
153
154 struct sfc_rss_hf_rte_to_efx {
155         uint64_t                        rte;
156         efx_rx_hash_type_t              efx;
157 };
158
159 struct sfc_rss {
160         unsigned int                    channels;
161         efx_rx_scale_context_type_t     context_type;
162         efx_rx_hash_support_t           hash_support;
163         efx_rx_hash_alg_t               hash_alg;
164         unsigned int                    hf_map_nb_entries;
165         struct sfc_rss_hf_rte_to_efx    *hf_map;
166
167         efx_rx_hash_type_t              hash_types;
168         unsigned int                    tbl[EFX_RSS_TBL_SIZE];
169         uint8_t                         key[EFX_RSS_KEY_SIZE];
170 };
171
172 /* Adapter private data */
173 struct sfc_adapter {
174         /*
175          * PMD setup and configuration is not thread safe. Since it is not
176          * performance sensitive, it is better to guarantee thread-safety
177          * and add device level lock. Adapter control operations which
178          * change its state should acquire the lock.
179          */
180         rte_spinlock_t                  lock;
181         enum sfc_adapter_state          state;
182         struct rte_pci_addr             pci_addr;
183         uint16_t                        port_id;
184         struct rte_eth_dev              *eth_dev;
185         struct rte_kvargs               *kvargs;
186         uint32_t                        logtype_main;
187         int                             socket_id;
188         efsys_bar_t                     mem_bar;
189         efx_family_t                    family;
190         efx_nic_t                       *nic;
191         rte_spinlock_t                  nic_lock;
192         rte_atomic32_t                  restart_required;
193
194         struct sfc_mcdi                 mcdi;
195         struct sfc_intr                 intr;
196         struct sfc_port                 port;
197         struct sfc_filter               filter;
198
199         unsigned int                    rxq_max;
200         unsigned int                    txq_max;
201
202         unsigned int                    txq_max_entries;
203
204         uint32_t                        evq_flags;
205         unsigned int                    evq_count;
206
207         unsigned int                    mgmt_evq_index;
208         /*
209          * The lock is used to serialise management event queue polling
210          * which can be done from different context. Also the lock
211          * guarantees that mgmt_evq_running is preserved while the lock
212          * is held. It is used to serialise polling and start/stop
213          * operations.
214          *
215          * Locks which may be held when the lock is acquired:
216          *  - adapter lock, when:
217          *    - device start/stop to change mgmt_evq_running
218          *    - any control operations in client side MCDI proxy handling to
219          *      poll management event queue waiting for proxy response
220          *  - MCDI lock, when:
221          *    - any control operations in client side MCDI proxy handling to
222          *      poll management event queue waiting for proxy response
223          *
224          * Locks which are acquired with the lock held:
225          *  - nic_lock, when:
226          *    - MC event processing on management event queue polling
227          *      (e.g. MC REBOOT or BADASSERT events)
228          */
229         rte_spinlock_t                  mgmt_evq_lock;
230         bool                            mgmt_evq_running;
231         struct sfc_evq                  *mgmt_evq;
232
233         unsigned int                    rxq_count;
234         struct sfc_rxq_info             *rxq_info;
235
236         unsigned int                    txq_count;
237         struct sfc_txq_info             *txq_info;
238
239         boolean_t                       tso;
240
241         uint32_t                        rxd_wait_timeout_ns;
242
243         struct sfc_rss                  rss;
244
245         /*
246          * Shared memory copy of the Rx datapath name to be used by
247          * the secondary process to find Rx datapath to be used.
248          */
249         char                            *dp_rx_name;
250         const struct sfc_dp_rx          *dp_rx;
251
252         /*
253          * Shared memory copy of the Tx datapath name to be used by
254          * the secondary process to find Rx datapath to be used.
255          */
256         char                            *dp_tx_name;
257         const struct sfc_dp_tx          *dp_tx;
258 };
259
260 /*
261  * Add wrapper functions to acquire/release lock to be able to remove or
262  * change the lock in one place.
263  */
264
265 static inline void
266 sfc_adapter_lock_init(struct sfc_adapter *sa)
267 {
268         rte_spinlock_init(&sa->lock);
269 }
270
271 static inline int
272 sfc_adapter_is_locked(struct sfc_adapter *sa)
273 {
274         return rte_spinlock_is_locked(&sa->lock);
275 }
276
277 static inline void
278 sfc_adapter_lock(struct sfc_adapter *sa)
279 {
280         rte_spinlock_lock(&sa->lock);
281 }
282
283 static inline int
284 sfc_adapter_trylock(struct sfc_adapter *sa)
285 {
286         return rte_spinlock_trylock(&sa->lock);
287 }
288
289 static inline void
290 sfc_adapter_unlock(struct sfc_adapter *sa)
291 {
292         rte_spinlock_unlock(&sa->lock);
293 }
294
295 static inline void
296 sfc_adapter_lock_fini(__rte_unused struct sfc_adapter *sa)
297 {
298         /* Just for symmetry of the API */
299 }
300
301 /** Get the number of milliseconds since boot from the default timer */
302 static inline uint64_t
303 sfc_get_system_msecs(void)
304 {
305         return rte_get_timer_cycles() * MS_PER_S / rte_get_timer_hz();
306 }
307
308 int sfc_dma_alloc(const struct sfc_adapter *sa, const char *name, uint16_t id,
309                   size_t len, int socket_id, efsys_mem_t *esmp);
310 void sfc_dma_free(const struct sfc_adapter *sa, efsys_mem_t *esmp);
311
312 uint32_t sfc_register_logtype(struct sfc_adapter *sa,
313                               const char *lt_prefix_str,
314                               uint32_t ll_default);
315
316 int sfc_probe(struct sfc_adapter *sa);
317 void sfc_unprobe(struct sfc_adapter *sa);
318 int sfc_attach(struct sfc_adapter *sa);
319 void sfc_detach(struct sfc_adapter *sa);
320 int sfc_start(struct sfc_adapter *sa);
321 void sfc_stop(struct sfc_adapter *sa);
322
323 void sfc_schedule_restart(struct sfc_adapter *sa);
324
325 int sfc_mcdi_init(struct sfc_adapter *sa);
326 void sfc_mcdi_fini(struct sfc_adapter *sa);
327
328 int sfc_configure(struct sfc_adapter *sa);
329 void sfc_close(struct sfc_adapter *sa);
330
331 int sfc_intr_attach(struct sfc_adapter *sa);
332 void sfc_intr_detach(struct sfc_adapter *sa);
333 int sfc_intr_configure(struct sfc_adapter *sa);
334 void sfc_intr_close(struct sfc_adapter *sa);
335 int sfc_intr_start(struct sfc_adapter *sa);
336 void sfc_intr_stop(struct sfc_adapter *sa);
337
338 int sfc_port_attach(struct sfc_adapter *sa);
339 void sfc_port_detach(struct sfc_adapter *sa);
340 int sfc_port_configure(struct sfc_adapter *sa);
341 void sfc_port_close(struct sfc_adapter *sa);
342 int sfc_port_start(struct sfc_adapter *sa);
343 void sfc_port_stop(struct sfc_adapter *sa);
344 void sfc_port_link_mode_to_info(efx_link_mode_t link_mode,
345                                 struct rte_eth_link *link_info);
346 int sfc_port_update_mac_stats(struct sfc_adapter *sa);
347 int sfc_port_reset_mac_stats(struct sfc_adapter *sa);
348 int sfc_set_rx_mode(struct sfc_adapter *sa);
349
350
351 #ifdef __cplusplus
352 }
353 #endif
354
355 #endif  /* _SFC_H */