1 /* SPDX-License-Identifier: BSD-3-Clause
3 * Copyright (c) 2016-2018 Solarflare Communications Inc.
6 * This software was jointly developed between OKTET Labs (under contract
7 * for Solarflare) and Solarflare Communications, Inc.
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>
24 #include "sfc_filter.h"
32 * | UNINITIALIZED |<-----------+
34 * |.eth_dev_init |.eth_dev_uninit
36 * +---------------+------------+
38 * +---------------+<-----------<---------------+
41 * +---------------+------------+ |
43 * +---------------+----+ |
45 * | | +---------------+
47 * | | +---------------+
50 * +---------------+----+ |.dev_close
51 * | CONFIGURED |----------------------------+
52 * +---------------+<-----------+
56 * | STARTING |------------^
57 * +---------------+ failed |
64 * +---------------+------------+
68 enum sfc_adapter_state {
69 SFC_ADAPTER_UNINITIALIZED = 0,
70 SFC_ADAPTER_INITIALIZED,
71 SFC_ADAPTER_CONFIGURING,
72 SFC_ADAPTER_CONFIGURED,
81 enum sfc_dev_filter_mode {
82 SFC_DEV_FILTER_MODE_PROMISC = 0,
83 SFC_DEV_FILTER_MODE_ALLMULTI,
89 SFC_MCDI_UNINITIALIZED = 0,
100 enum sfc_mcdi_state state;
101 efx_mcdi_transport_t transport;
103 uint32_t proxy_handle;
104 efx_rc_t proxy_result;
108 efx_intr_type_t type;
109 rte_intr_callback_fn handler;
121 unsigned int lsc_seq;
123 uint32_t phy_adv_cap_mask;
124 uint32_t phy_adv_cap;
126 unsigned int flow_ctrl;
127 boolean_t flow_ctrl_autoneg;
131 * Flow API isolated mode overrides promisc and allmulti settings;
132 * they won't be applied if isolated mode is active
137 struct ether_addr default_mac_addr;
139 unsigned int max_mcast_addrs;
140 unsigned int nb_mcast_addrs;
141 uint8_t *mcast_addrs;
143 rte_spinlock_t mac_stats_lock;
144 uint64_t *mac_stats_buf;
145 unsigned int mac_stats_nb_supported;
146 efsys_mem_t mac_stats_dma_mem;
147 boolean_t mac_stats_reset_pending;
148 uint16_t mac_stats_update_period_ms;
149 uint32_t mac_stats_update_generation;
150 boolean_t mac_stats_periodic_dma_supported;
151 uint64_t mac_stats_last_request_timestamp;
153 uint32_t mac_stats_mask[EFX_MAC_STATS_MASK_NPAGES];
158 struct sfc_rss_hf_rte_to_efx {
160 efx_rx_hash_type_t efx;
164 unsigned int channels;
165 efx_rx_scale_context_type_t context_type;
166 efx_rx_hash_support_t hash_support;
167 efx_rx_hash_alg_t hash_alg;
168 unsigned int hf_map_nb_entries;
169 struct sfc_rss_hf_rte_to_efx *hf_map;
171 efx_rx_hash_type_t hash_types;
172 unsigned int tbl[EFX_RSS_TBL_SIZE];
173 uint8_t key[EFX_RSS_KEY_SIZE];
176 /* Adapter private data shared by primary and secondary processes */
177 struct sfc_adapter_shared {
178 unsigned int rxq_count;
179 struct sfc_rxq_info *rxq_info;
181 unsigned int txq_count;
182 struct sfc_txq_info *txq_info;
187 uint32_t tunnel_encaps;
189 struct rte_pci_addr pci_addr;
196 /* Adapter process private data */
197 struct sfc_adapter_priv {
198 struct sfc_adapter_shared *shared;
199 const struct sfc_dp_rx *dp_rx;
200 const struct sfc_dp_tx *dp_tx;
201 uint32_t logtype_main;
204 static inline struct sfc_adapter_priv *
205 sfc_adapter_priv_by_eth_dev(struct rte_eth_dev *eth_dev)
207 struct sfc_adapter_priv *sap = eth_dev->process_private;
209 SFC_ASSERT(sap != NULL);
213 /* Adapter private data */
216 * It must be the first field of the sfc_adapter structure since
217 * sfc_adapter is the primary process private data (i.e. process
218 * private data plus additional primary process specific data).
220 struct sfc_adapter_priv priv;
223 * PMD setup and configuration is not thread safe. Since it is not
224 * performance sensitive, it is better to guarantee thread-safety
225 * and add device level lock. Adapter control operations which
226 * change its state should acquire the lock.
229 enum sfc_adapter_state state;
230 struct rte_eth_dev *eth_dev;
231 struct rte_kvargs *kvargs;
236 rte_spinlock_t nic_lock;
237 rte_atomic32_t restart_required;
239 struct sfc_mcdi mcdi;
240 struct sfc_intr intr;
241 struct sfc_port port;
242 struct sfc_filter filter;
244 unsigned int rxq_max;
245 unsigned int txq_max;
247 unsigned int rxq_max_entries;
248 unsigned int rxq_min_entries;
250 unsigned int txq_max_entries;
251 unsigned int txq_min_entries;
253 unsigned int evq_max_entries;
254 unsigned int evq_min_entries;
257 unsigned int evq_count;
259 unsigned int mgmt_evq_index;
261 * The lock is used to serialise management event queue polling
262 * which can be done from different context. Also the lock
263 * guarantees that mgmt_evq_running is preserved while the lock
264 * is held. It is used to serialise polling and start/stop
267 * Locks which may be held when the lock is acquired:
268 * - adapter lock, when:
269 * - device start/stop to change mgmt_evq_running
270 * - any control operations in client side MCDI proxy handling to
271 * poll management event queue waiting for proxy response
273 * - any control operations in client side MCDI proxy handling to
274 * poll management event queue waiting for proxy response
276 * Locks which are acquired with the lock held:
278 * - MC event processing on management event queue polling
279 * (e.g. MC REBOOT or BADASSERT events)
281 rte_spinlock_t mgmt_evq_lock;
282 bool mgmt_evq_running;
283 struct sfc_evq *mgmt_evq;
285 struct sfc_rxq *rxq_ctrl;
286 struct sfc_txq *txq_ctrl;
290 uint32_t rxd_wait_timeout_ns;
293 static inline struct sfc_adapter_shared *
294 sfc_adapter_shared_by_eth_dev(struct rte_eth_dev *eth_dev)
296 struct sfc_adapter_shared *sas = eth_dev->data->dev_private;
301 static inline struct sfc_adapter *
302 sfc_adapter_by_eth_dev(struct rte_eth_dev *eth_dev)
304 struct sfc_adapter_priv *sap = sfc_adapter_priv_by_eth_dev(eth_dev);
306 SFC_ASSERT(rte_eal_process_type() == RTE_PROC_PRIMARY);
308 return container_of(sap, struct sfc_adapter, priv);
311 static inline struct sfc_adapter_shared *
312 sfc_sa2shared(struct sfc_adapter *sa)
314 return sa->priv.shared;
318 * Add wrapper functions to acquire/release lock to be able to remove or
319 * change the lock in one place.
323 sfc_adapter_lock_init(struct sfc_adapter *sa)
325 rte_spinlock_init(&sa->lock);
329 sfc_adapter_is_locked(struct sfc_adapter *sa)
331 return rte_spinlock_is_locked(&sa->lock);
335 sfc_adapter_lock(struct sfc_adapter *sa)
337 rte_spinlock_lock(&sa->lock);
341 sfc_adapter_trylock(struct sfc_adapter *sa)
343 return rte_spinlock_trylock(&sa->lock);
347 sfc_adapter_unlock(struct sfc_adapter *sa)
349 rte_spinlock_unlock(&sa->lock);
353 sfc_adapter_lock_fini(__rte_unused struct sfc_adapter *sa)
355 /* Just for symmetry of the API */
358 /** Get the number of milliseconds since boot from the default timer */
359 static inline uint64_t
360 sfc_get_system_msecs(void)
362 return rte_get_timer_cycles() * MS_PER_S / rte_get_timer_hz();
365 int sfc_dma_alloc(const struct sfc_adapter *sa, const char *name, uint16_t id,
366 size_t len, int socket_id, efsys_mem_t *esmp);
367 void sfc_dma_free(const struct sfc_adapter *sa, efsys_mem_t *esmp);
369 uint32_t sfc_register_logtype(const struct rte_pci_addr *pci_addr,
370 const char *lt_prefix_str,
371 uint32_t ll_default);
373 int sfc_probe(struct sfc_adapter *sa);
374 void sfc_unprobe(struct sfc_adapter *sa);
375 int sfc_attach(struct sfc_adapter *sa);
376 void sfc_detach(struct sfc_adapter *sa);
377 int sfc_start(struct sfc_adapter *sa);
378 void sfc_stop(struct sfc_adapter *sa);
380 void sfc_schedule_restart(struct sfc_adapter *sa);
382 int sfc_mcdi_init(struct sfc_adapter *sa);
383 void sfc_mcdi_fini(struct sfc_adapter *sa);
385 int sfc_configure(struct sfc_adapter *sa);
386 void sfc_close(struct sfc_adapter *sa);
388 int sfc_intr_attach(struct sfc_adapter *sa);
389 void sfc_intr_detach(struct sfc_adapter *sa);
390 int sfc_intr_configure(struct sfc_adapter *sa);
391 void sfc_intr_close(struct sfc_adapter *sa);
392 int sfc_intr_start(struct sfc_adapter *sa);
393 void sfc_intr_stop(struct sfc_adapter *sa);
395 int sfc_port_attach(struct sfc_adapter *sa);
396 void sfc_port_detach(struct sfc_adapter *sa);
397 int sfc_port_configure(struct sfc_adapter *sa);
398 void sfc_port_close(struct sfc_adapter *sa);
399 int sfc_port_start(struct sfc_adapter *sa);
400 void sfc_port_stop(struct sfc_adapter *sa);
401 void sfc_port_link_mode_to_info(efx_link_mode_t link_mode,
402 struct rte_eth_link *link_info);
403 int sfc_port_update_mac_stats(struct sfc_adapter *sa);
404 int sfc_port_reset_mac_stats(struct sfc_adapter *sa);
405 int sfc_set_rx_mode(struct sfc_adapter *sa);