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"
37 * | UNINITIALIZED |<-----------+
39 * |.eth_dev_init |.eth_dev_uninit
41 * +---------------+------------+
43 * +---------------+<-----------<---------------+
46 * +---------------+------------+ |
48 * +---------------+----+ |
50 * | | +---------------+
52 * | | +---------------+
55 * +---------------+----+ |.dev_close
56 * | CONFIGURED |----------------------------+
57 * +---------------+<-----------+
61 * | STARTING |------------^
62 * +---------------+ failed |
69 * +---------------+------------+
73 enum sfc_adapter_state {
74 SFC_ADAPTER_UNINITIALIZED = 0,
75 SFC_ADAPTER_INITIALIZED,
76 SFC_ADAPTER_CONFIGURING,
77 SFC_ADAPTER_CONFIGURED,
86 enum sfc_dev_filter_mode {
87 SFC_DEV_FILTER_MODE_PROMISC = 0,
88 SFC_DEV_FILTER_MODE_ALLMULTI,
95 rte_intr_callback_fn handler;
108 unsigned int lsc_seq;
110 uint32_t phy_adv_cap_mask;
111 uint32_t phy_adv_cap;
113 unsigned int flow_ctrl;
114 boolean_t flow_ctrl_autoneg;
118 * Flow API isolated mode overrides promisc and allmulti settings;
119 * they won't be applied if isolated mode is active
124 struct rte_ether_addr default_mac_addr;
126 unsigned int max_mcast_addrs;
127 unsigned int nb_mcast_addrs;
128 uint8_t *mcast_addrs;
130 rte_spinlock_t mac_stats_lock;
131 uint64_t *mac_stats_buf;
132 unsigned int mac_stats_nb_supported;
133 efsys_mem_t mac_stats_dma_mem;
134 boolean_t mac_stats_reset_pending;
135 uint16_t mac_stats_update_period_ms;
136 uint32_t mac_stats_update_generation;
137 boolean_t mac_stats_periodic_dma_supported;
138 uint64_t mac_stats_last_request_timestamp;
140 uint32_t mac_stats_mask[EFX_MAC_STATS_MASK_NPAGES];
145 struct sfc_rss_hf_rte_to_efx {
147 efx_rx_hash_type_t efx;
151 unsigned int channels;
152 efx_rx_scale_context_type_t context_type;
153 efx_rx_hash_support_t hash_support;
154 efx_rx_hash_alg_t hash_alg;
155 unsigned int hf_map_nb_entries;
156 struct sfc_rss_hf_rte_to_efx *hf_map;
158 efx_rx_hash_type_t hash_types;
159 unsigned int tbl[EFX_RSS_TBL_SIZE];
160 uint8_t key[EFX_RSS_KEY_SIZE];
162 uint32_t dummy_rss_context;
165 /* Adapter private data shared by primary and secondary processes */
166 struct sfc_adapter_shared {
167 unsigned int rxq_count;
168 struct sfc_rxq_info *rxq_info;
170 unsigned int txq_count;
171 struct sfc_txq_info *txq_info;
176 uint32_t tunnel_encaps;
178 char log_prefix[SFC_LOG_PREFIX_MAX];
179 struct rte_pci_addr pci_addr;
186 /* Adapter process private data */
187 struct sfc_adapter_priv {
188 struct sfc_adapter_shared *shared;
189 const struct sfc_dp_rx *dp_rx;
190 const struct sfc_dp_tx *dp_tx;
191 uint32_t logtype_main;
194 static inline struct sfc_adapter_priv *
195 sfc_adapter_priv_by_eth_dev(struct rte_eth_dev *eth_dev)
197 struct sfc_adapter_priv *sap = eth_dev->process_private;
199 SFC_ASSERT(sap != NULL);
203 /* Adapter private data */
206 * It must be the first field of the sfc_adapter structure since
207 * sfc_adapter is the primary process private data (i.e. process
208 * private data plus additional primary process specific data).
210 struct sfc_adapter_priv priv;
213 * PMD setup and configuration is not thread safe. Since it is not
214 * performance sensitive, it is better to guarantee thread-safety
215 * and add device level lock. Adapter control operations which
216 * change its state should acquire the lock.
219 enum sfc_adapter_state state;
220 struct rte_eth_dev *eth_dev;
221 struct rte_kvargs *kvargs;
224 /* Function control window offset */
225 efsys_dma_addr_t fcw_offset;
228 rte_spinlock_t nic_lock;
229 rte_atomic32_t restart_required;
231 struct sfc_efx_mcdi mcdi;
232 struct sfc_sriov sriov;
233 struct sfc_intr intr;
234 struct sfc_port port;
235 struct sfc_filter filter;
237 struct sfc_flow_list flow_list;
239 unsigned int rxq_max;
240 unsigned int txq_max;
242 unsigned int rxq_max_entries;
243 unsigned int rxq_min_entries;
245 unsigned int txq_max_entries;
246 unsigned int txq_min_entries;
248 unsigned int evq_max_entries;
249 unsigned int evq_min_entries;
252 unsigned int evq_count;
254 unsigned int mgmt_evq_index;
256 * The lock is used to serialise management event queue polling
257 * which can be done from different context. Also the lock
258 * guarantees that mgmt_evq_running is preserved while the lock
259 * is held. It is used to serialise polling and start/stop
262 * Locks which may be held when the lock is acquired:
263 * - adapter lock, when:
264 * - device start/stop to change mgmt_evq_running
265 * - any control operations in client side MCDI proxy handling to
266 * poll management event queue waiting for proxy response
268 * - any control operations in client side MCDI proxy handling to
269 * poll management event queue waiting for proxy response
271 * Locks which are acquired with the lock held:
273 * - MC event processing on management event queue polling
274 * (e.g. MC REBOOT or BADASSERT events)
276 rte_spinlock_t mgmt_evq_lock;
277 bool mgmt_evq_running;
278 struct sfc_evq *mgmt_evq;
280 struct sfc_rxq *rxq_ctrl;
281 struct sfc_txq *txq_ctrl;
286 uint32_t rxd_wait_timeout_ns;
289 static inline struct sfc_adapter_shared *
290 sfc_adapter_shared_by_eth_dev(struct rte_eth_dev *eth_dev)
292 struct sfc_adapter_shared *sas = eth_dev->data->dev_private;
297 static inline struct sfc_adapter *
298 sfc_adapter_by_eth_dev(struct rte_eth_dev *eth_dev)
300 struct sfc_adapter_priv *sap = sfc_adapter_priv_by_eth_dev(eth_dev);
302 SFC_ASSERT(rte_eal_process_type() == RTE_PROC_PRIMARY);
304 return container_of(sap, struct sfc_adapter, priv);
307 static inline struct sfc_adapter_shared *
308 sfc_sa2shared(struct sfc_adapter *sa)
310 return sa->priv.shared;
314 * Add wrapper functions to acquire/release lock to be able to remove or
315 * change the lock in one place.
319 sfc_adapter_lock_init(struct sfc_adapter *sa)
321 rte_spinlock_init(&sa->lock);
325 sfc_adapter_is_locked(struct sfc_adapter *sa)
327 return rte_spinlock_is_locked(&sa->lock);
331 sfc_adapter_lock(struct sfc_adapter *sa)
333 rte_spinlock_lock(&sa->lock);
337 sfc_adapter_trylock(struct sfc_adapter *sa)
339 return rte_spinlock_trylock(&sa->lock);
343 sfc_adapter_unlock(struct sfc_adapter *sa)
345 rte_spinlock_unlock(&sa->lock);
349 sfc_adapter_lock_fini(__rte_unused struct sfc_adapter *sa)
351 /* Just for symmetry of the API */
354 /** Get the number of milliseconds since boot from the default timer */
355 static inline uint64_t
356 sfc_get_system_msecs(void)
358 return rte_get_timer_cycles() * MS_PER_S / rte_get_timer_hz();
361 int sfc_dma_alloc(const struct sfc_adapter *sa, const char *name, uint16_t id,
362 size_t len, int socket_id, efsys_mem_t *esmp);
363 void sfc_dma_free(const struct sfc_adapter *sa, efsys_mem_t *esmp);
365 uint32_t sfc_register_logtype(const struct rte_pci_addr *pci_addr,
366 const char *lt_prefix_str,
367 uint32_t ll_default);
369 int sfc_probe(struct sfc_adapter *sa);
370 void sfc_unprobe(struct sfc_adapter *sa);
371 int sfc_attach(struct sfc_adapter *sa);
372 void sfc_detach(struct sfc_adapter *sa);
373 int sfc_start(struct sfc_adapter *sa);
374 void sfc_stop(struct sfc_adapter *sa);
376 void sfc_schedule_restart(struct sfc_adapter *sa);
378 int sfc_mcdi_init(struct sfc_adapter *sa);
379 void sfc_mcdi_fini(struct sfc_adapter *sa);
381 int sfc_configure(struct sfc_adapter *sa);
382 void sfc_close(struct sfc_adapter *sa);
384 int sfc_intr_attach(struct sfc_adapter *sa);
385 void sfc_intr_detach(struct sfc_adapter *sa);
386 int sfc_intr_configure(struct sfc_adapter *sa);
387 void sfc_intr_close(struct sfc_adapter *sa);
388 int sfc_intr_start(struct sfc_adapter *sa);
389 void sfc_intr_stop(struct sfc_adapter *sa);
391 int sfc_port_attach(struct sfc_adapter *sa);
392 void sfc_port_detach(struct sfc_adapter *sa);
393 int sfc_port_configure(struct sfc_adapter *sa);
394 void sfc_port_close(struct sfc_adapter *sa);
395 int sfc_port_start(struct sfc_adapter *sa);
396 void sfc_port_stop(struct sfc_adapter *sa);
397 void sfc_port_link_mode_to_info(efx_link_mode_t link_mode,
398 struct rte_eth_link *link_info);
399 int sfc_port_update_mac_stats(struct sfc_adapter *sa);
400 int sfc_port_reset_mac_stats(struct sfc_adapter *sa);
401 int sfc_set_rx_mode(struct sfc_adapter *sa);
402 int sfc_set_rx_mode_unchecked(struct sfc_adapter *sa);