1 /* SPDX-License-Identifier: BSD-3-Clause
3 * Copyright(c) 2019-2020 Xilinx, Inc.
4 * Copyright(c) 2016-2019 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_efx_mcdi.h"
26 #include "sfc_debug.h"
28 #include "sfc_filter.h"
29 #include "sfc_sriov.h"
38 * | UNINITIALIZED |<-----------+
40 * |.eth_dev_init |.eth_dev_uninit
42 * +---------------+------------+
44 * +---------------+<-----------<---------------+
47 * +---------------+------------+ |
49 * +---------------+----+ |
51 * | | +---------------+
53 * | | +---------------+
56 * +---------------+----+ |.dev_close
57 * | CONFIGURED |----------------------------+
58 * +---------------+<-----------+
62 * | STARTING |------------^
63 * +---------------+ failed |
70 * +---------------+------------+
74 enum sfc_adapter_state {
75 SFC_ADAPTER_UNINITIALIZED = 0,
76 SFC_ADAPTER_INITIALIZED,
77 SFC_ADAPTER_CONFIGURING,
78 SFC_ADAPTER_CONFIGURED,
87 enum sfc_dev_filter_mode {
88 SFC_DEV_FILTER_MODE_PROMISC = 0,
89 SFC_DEV_FILTER_MODE_ALLMULTI,
96 rte_intr_callback_fn handler;
109 unsigned int lsc_seq;
111 uint32_t phy_adv_cap_mask;
112 uint32_t phy_adv_cap;
114 unsigned int flow_ctrl;
115 boolean_t flow_ctrl_autoneg;
119 * Flow API isolated mode overrides promisc and allmulti settings;
120 * they won't be applied if isolated mode is active
125 struct rte_ether_addr default_mac_addr;
127 unsigned int max_mcast_addrs;
128 unsigned int nb_mcast_addrs;
129 uint8_t *mcast_addrs;
131 rte_spinlock_t mac_stats_lock;
132 uint64_t *mac_stats_buf;
133 unsigned int mac_stats_nb_supported;
134 efsys_mem_t mac_stats_dma_mem;
135 boolean_t mac_stats_reset_pending;
136 uint16_t mac_stats_update_period_ms;
137 uint32_t mac_stats_update_generation;
138 boolean_t mac_stats_periodic_dma_supported;
139 uint64_t mac_stats_last_request_timestamp;
141 uint32_t mac_stats_mask[EFX_MAC_STATS_MASK_NPAGES];
146 struct sfc_rss_hf_rte_to_efx {
148 efx_rx_hash_type_t efx;
152 unsigned int channels;
153 efx_rx_scale_context_type_t context_type;
154 efx_rx_hash_support_t hash_support;
155 efx_rx_hash_alg_t hash_alg;
156 unsigned int hf_map_nb_entries;
157 struct sfc_rss_hf_rte_to_efx *hf_map;
159 efx_rx_hash_type_t hash_types;
160 unsigned int tbl[EFX_RSS_TBL_SIZE];
161 uint8_t key[EFX_RSS_KEY_SIZE];
163 uint32_t dummy_rss_context;
166 /* Adapter private data shared by primary and secondary processes */
167 struct sfc_adapter_shared {
168 unsigned int rxq_count;
169 struct sfc_rxq_info *rxq_info;
171 unsigned int txq_count;
172 struct sfc_txq_info *txq_info;
177 uint32_t tunnel_encaps;
179 char log_prefix[SFC_LOG_PREFIX_MAX];
180 struct rte_pci_addr pci_addr;
187 /* Adapter process private data */
188 struct sfc_adapter_priv {
189 struct sfc_adapter_shared *shared;
190 const struct sfc_dp_rx *dp_rx;
191 const struct sfc_dp_tx *dp_tx;
192 uint32_t logtype_main;
195 static inline struct sfc_adapter_priv *
196 sfc_adapter_priv_by_eth_dev(struct rte_eth_dev *eth_dev)
198 struct sfc_adapter_priv *sap = eth_dev->process_private;
200 SFC_ASSERT(sap != NULL);
204 /* Adapter private data */
207 * It must be the first field of the sfc_adapter structure since
208 * sfc_adapter is the primary process private data (i.e. process
209 * private data plus additional primary process specific data).
211 struct sfc_adapter_priv priv;
214 * PMD setup and configuration is not thread safe. Since it is not
215 * performance sensitive, it is better to guarantee thread-safety
216 * and add device level lock. Adapter control operations which
217 * change its state should acquire the lock.
220 enum sfc_adapter_state state;
221 struct rte_eth_dev *eth_dev;
222 struct rte_kvargs *kvargs;
225 /* Function control window offset */
226 efsys_dma_addr_t fcw_offset;
229 rte_spinlock_t nic_lock;
230 rte_atomic32_t restart_required;
232 struct sfc_efx_mcdi mcdi;
233 struct sfc_sriov sriov;
234 struct sfc_intr intr;
235 struct sfc_port port;
236 struct sfc_filter filter;
239 struct sfc_flow_list flow_list;
241 unsigned int rxq_max;
242 unsigned int txq_max;
244 unsigned int rxq_max_entries;
245 unsigned int rxq_min_entries;
247 unsigned int txq_max_entries;
248 unsigned int txq_min_entries;
250 unsigned int evq_max_entries;
251 unsigned int evq_min_entries;
254 unsigned int evq_count;
256 unsigned int mgmt_evq_index;
258 * The lock is used to serialise management event queue polling
259 * which can be done from different context. Also the lock
260 * guarantees that mgmt_evq_running is preserved while the lock
261 * is held. It is used to serialise polling and start/stop
264 * Locks which may be held when the lock is acquired:
265 * - adapter lock, when:
266 * - device start/stop to change mgmt_evq_running
267 * - any control operations in client side MCDI proxy handling to
268 * poll management event queue waiting for proxy response
270 * - any control operations in client side MCDI proxy handling to
271 * poll management event queue waiting for proxy response
273 * Locks which are acquired with the lock held:
275 * - MC event processing on management event queue polling
276 * (e.g. MC REBOOT or BADASSERT events)
278 rte_spinlock_t mgmt_evq_lock;
279 bool mgmt_evq_running;
280 struct sfc_evq *mgmt_evq;
282 struct sfc_rxq *rxq_ctrl;
283 struct sfc_txq *txq_ctrl;
288 uint32_t rxd_wait_timeout_ns;
291 static inline struct sfc_adapter_shared *
292 sfc_adapter_shared_by_eth_dev(struct rte_eth_dev *eth_dev)
294 struct sfc_adapter_shared *sas = eth_dev->data->dev_private;
299 static inline struct sfc_adapter *
300 sfc_adapter_by_eth_dev(struct rte_eth_dev *eth_dev)
302 struct sfc_adapter_priv *sap = sfc_adapter_priv_by_eth_dev(eth_dev);
304 SFC_ASSERT(rte_eal_process_type() == RTE_PROC_PRIMARY);
306 return container_of(sap, struct sfc_adapter, priv);
309 static inline struct sfc_adapter_shared *
310 sfc_sa2shared(struct sfc_adapter *sa)
312 return sa->priv.shared;
316 * Add wrapper functions to acquire/release lock to be able to remove or
317 * change the lock in one place.
321 sfc_adapter_lock_init(struct sfc_adapter *sa)
323 rte_spinlock_init(&sa->lock);
327 sfc_adapter_is_locked(struct sfc_adapter *sa)
329 return rte_spinlock_is_locked(&sa->lock);
333 sfc_adapter_lock(struct sfc_adapter *sa)
335 rte_spinlock_lock(&sa->lock);
339 sfc_adapter_trylock(struct sfc_adapter *sa)
341 return rte_spinlock_trylock(&sa->lock);
345 sfc_adapter_unlock(struct sfc_adapter *sa)
347 rte_spinlock_unlock(&sa->lock);
351 sfc_adapter_lock_fini(__rte_unused struct sfc_adapter *sa)
353 /* Just for symmetry of the API */
356 /** Get the number of milliseconds since boot from the default timer */
357 static inline uint64_t
358 sfc_get_system_msecs(void)
360 return rte_get_timer_cycles() * MS_PER_S / rte_get_timer_hz();
363 int sfc_dma_alloc(const struct sfc_adapter *sa, const char *name, uint16_t id,
364 size_t len, int socket_id, efsys_mem_t *esmp);
365 void sfc_dma_free(const struct sfc_adapter *sa, efsys_mem_t *esmp);
367 uint32_t sfc_register_logtype(const struct rte_pci_addr *pci_addr,
368 const char *lt_prefix_str,
369 uint32_t ll_default);
371 int sfc_probe(struct sfc_adapter *sa);
372 void sfc_unprobe(struct sfc_adapter *sa);
373 int sfc_attach(struct sfc_adapter *sa);
374 void sfc_detach(struct sfc_adapter *sa);
375 int sfc_start(struct sfc_adapter *sa);
376 void sfc_stop(struct sfc_adapter *sa);
378 void sfc_schedule_restart(struct sfc_adapter *sa);
380 int sfc_mcdi_init(struct sfc_adapter *sa);
381 void sfc_mcdi_fini(struct sfc_adapter *sa);
383 int sfc_configure(struct sfc_adapter *sa);
384 void sfc_close(struct sfc_adapter *sa);
386 int sfc_intr_attach(struct sfc_adapter *sa);
387 void sfc_intr_detach(struct sfc_adapter *sa);
388 int sfc_intr_configure(struct sfc_adapter *sa);
389 void sfc_intr_close(struct sfc_adapter *sa);
390 int sfc_intr_start(struct sfc_adapter *sa);
391 void sfc_intr_stop(struct sfc_adapter *sa);
393 int sfc_port_attach(struct sfc_adapter *sa);
394 void sfc_port_detach(struct sfc_adapter *sa);
395 int sfc_port_configure(struct sfc_adapter *sa);
396 void sfc_port_close(struct sfc_adapter *sa);
397 int sfc_port_start(struct sfc_adapter *sa);
398 void sfc_port_stop(struct sfc_adapter *sa);
399 void sfc_port_link_mode_to_info(efx_link_mode_t link_mode,
400 struct rte_eth_link *link_info);
401 int sfc_port_update_mac_stats(struct sfc_adapter *sa);
402 int sfc_port_reset_mac_stats(struct sfc_adapter *sa);
403 int sfc_set_rx_mode(struct sfc_adapter *sa);
404 int sfc_set_rx_mode_unchecked(struct sfc_adapter *sa);
406 struct sfc_hw_switch_id;
408 int sfc_hw_switch_id_init(struct sfc_adapter *sa,
409 struct sfc_hw_switch_id **idp);
410 void sfc_hw_switch_id_fini(struct sfc_adapter *sa,
411 struct sfc_hw_switch_id *idp);
412 bool sfc_hw_switch_ids_equal(const struct sfc_hw_switch_id *left,
413 const struct sfc_hw_switch_id *right);