1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2014-2018 Chelsio Communications.
6 #ifndef __CHELSIO_COMMON_H
7 #define __CHELSIO_COMMON_H
9 #include "cxgbe_compat.h"
12 #include "t4_chip_type.h"
13 #include "t4fw_interface.h"
19 #define CXGBE_PAGE_SIZE RTE_PGSIZE_4K
21 #define T4_MEMORY_WRITE 0
22 #define T4_MEMORY_READ 1
25 MAX_NPORTS = 4, /* max # of ports */
29 T5_REGMAP_SIZE = (332 * 1024),
33 MEMWIN0_APERTURE = 2048,
34 MEMWIN0_BASE = 0x1b800,
37 enum dev_master { MASTER_CANT, MASTER_MAY, MASTER_MUST };
39 enum dev_state { DEV_STATE_UNINIT, DEV_STATE_INIT, DEV_STATE_ERR };
44 PAUSE_AUTONEG = 1 << 2
48 FEC_AUTO = 1 << 0, /* IEEE 802.3 "automatic" */
49 FEC_RS = 1 << 1, /* Reed-Solomon */
50 FEC_BASER_RS = 1 << 2, /* BaseR/Reed-Solomon */
53 enum { MEM_EDC0, MEM_EDC1, MEM_MC, MEM_MC0 = MEM_MC, MEM_MC1 };
56 u64 tx_octets; /* total # of octets in good frames */
57 u64 tx_frames; /* all good frames */
58 u64 tx_bcast_frames; /* all broadcast frames */
59 u64 tx_mcast_frames; /* all multicast frames */
60 u64 tx_ucast_frames; /* all unicast frames */
61 u64 tx_error_frames; /* all error frames */
63 u64 tx_frames_64; /* # of Tx frames in a particular range */
65 u64 tx_frames_128_255;
66 u64 tx_frames_256_511;
67 u64 tx_frames_512_1023;
68 u64 tx_frames_1024_1518;
69 u64 tx_frames_1519_max;
71 u64 tx_drop; /* # of dropped Tx frames */
72 u64 tx_pause; /* # of transmitted pause frames */
73 u64 tx_ppp0; /* # of transmitted PPP prio 0 frames */
74 u64 tx_ppp1; /* # of transmitted PPP prio 1 frames */
75 u64 tx_ppp2; /* # of transmitted PPP prio 2 frames */
76 u64 tx_ppp3; /* # of transmitted PPP prio 3 frames */
77 u64 tx_ppp4; /* # of transmitted PPP prio 4 frames */
78 u64 tx_ppp5; /* # of transmitted PPP prio 5 frames */
79 u64 tx_ppp6; /* # of transmitted PPP prio 6 frames */
80 u64 tx_ppp7; /* # of transmitted PPP prio 7 frames */
82 u64 rx_octets; /* total # of octets in good frames */
83 u64 rx_frames; /* all good frames */
84 u64 rx_bcast_frames; /* all broadcast frames */
85 u64 rx_mcast_frames; /* all multicast frames */
86 u64 rx_ucast_frames; /* all unicast frames */
87 u64 rx_too_long; /* # of frames exceeding MTU */
88 u64 rx_jabber; /* # of jabber frames */
89 u64 rx_fcs_err; /* # of received frames with bad FCS */
90 u64 rx_len_err; /* # of received frames with length error */
91 u64 rx_symbol_err; /* symbol errors */
92 u64 rx_runt; /* # of short frames */
94 u64 rx_frames_64; /* # of Rx frames in a particular range */
96 u64 rx_frames_128_255;
97 u64 rx_frames_256_511;
98 u64 rx_frames_512_1023;
99 u64 rx_frames_1024_1518;
100 u64 rx_frames_1519_max;
102 u64 rx_pause; /* # of received pause frames */
103 u64 rx_ppp0; /* # of received PPP prio 0 frames */
104 u64 rx_ppp1; /* # of received PPP prio 1 frames */
105 u64 rx_ppp2; /* # of received PPP prio 2 frames */
106 u64 rx_ppp3; /* # of received PPP prio 3 frames */
107 u64 rx_ppp4; /* # of received PPP prio 4 frames */
108 u64 rx_ppp5; /* # of received PPP prio 5 frames */
109 u64 rx_ppp6; /* # of received PPP prio 6 frames */
110 u64 rx_ppp7; /* # of received PPP prio 7 frames */
112 u64 rx_ovflow0; /* drops due to buffer-group 0 overflows */
113 u64 rx_ovflow1; /* drops due to buffer-group 1 overflows */
114 u64 rx_ovflow2; /* drops due to buffer-group 2 overflows */
115 u64 rx_ovflow3; /* drops due to buffer-group 3 overflows */
116 u64 rx_trunc0; /* buffer-group 0 truncated packets */
117 u64 rx_trunc1; /* buffer-group 1 truncated packets */
118 u64 rx_trunc2; /* buffer-group 2 truncated packets */
119 u64 rx_trunc3; /* buffer-group 3 truncated packets */
123 u32 hps; /* host page size for our PF/VF */
124 u32 eq_qpp; /* egress queues/page for our PF/VF */
125 u32 iq_qpp; /* egress queues/page for our PF/VF */
129 unsigned int ntxchan; /* # of Tx channels */
130 unsigned int tre; /* log2 of core clocks per TP tick */
131 unsigned int dack_re; /* DACK timer resolution */
132 unsigned int la_mask; /* what events are recorded by TP LA */
133 unsigned short tx_modq[NCHAN]; /* channel to modulation queue map */
135 u32 vlan_pri_map; /* cached TP_VLAN_PRI_MAP */
136 u32 ingress_config; /* cached TP_INGRESS_CONFIG */
138 /* cached TP_OUT_CONFIG compressed error vector
139 * and passing outer header info for encapsulated packets.
144 * TP_VLAN_PRI_MAP Compressed Filter Tuple field offsets. This is a
145 * subset of the set of fields which may be present in the Compressed
146 * Filter Tuple portion of filters and TCP TCB connections. The
147 * fields which are present are controlled by the TP_VLAN_PRI_MAP.
148 * Since a variable number of fields may or may not be present, their
149 * shifted field positions within the Compressed Filter Tuple may
150 * vary, or not even be present if the field isn't selected in
151 * TP_VLAN_PRI_MAP. Since some of these fields are needed in various
152 * places we store their offsets here, or a -1 if the field isn't
162 u64 hash_filter_mask;
172 uint32_t vpd_cap_addr;
178 * Firmware device log.
180 struct devlog_params {
181 u32 memtype; /* which memory (EDC0, EDC1, MC) */
182 u32 start; /* start of log in firmware memory */
183 u32 size; /* size of log */
186 struct arch_specific_params {
195 * Global Receive Side Scaling (RSS) parameters in host-native format.
198 unsigned int mode; /* RSS mode */
201 uint synmapen:1; /* SYN Map Enable */
202 uint syn4tupenipv6:1; /* en 4-tuple IPv6 SYNs hash */
203 uint syn2tupenipv6:1; /* en 2-tuple IPv6 SYNs hash */
204 uint syn4tupenipv4:1; /* en 4-tuple IPv4 SYNs hash */
205 uint syn2tupenipv4:1; /* en 2-tuple IPv4 SYNs hash */
206 uint ofdmapen:1; /* Offload Map Enable */
207 uint tnlmapen:1; /* Tunnel Map Enable */
208 uint tnlalllookup:1; /* Tunnel All Lookup */
209 uint hashtoeplitz:1; /* use Toeplitz hash */
215 * Maximum resources provisioned for a PCI PF.
217 struct pf_resources {
218 unsigned int neq; /* N egress Qs */
219 unsigned int niqflint; /* N ingress Qs/w free list(s) & intr */
223 * Maximum resources provisioned for a PCI VF.
225 struct vf_resources {
226 unsigned int nvi; /* N virtual interfaces */
227 unsigned int neq; /* N egress Qs */
228 unsigned int nethctrl; /* N egress ETH or CTRL Qs */
229 unsigned int niqflint; /* N ingress Qs/w free list(s) & intr */
230 unsigned int niq; /* N ingress Qs */
231 unsigned int tc; /* PCI-E traffic class */
232 unsigned int pmask; /* port access rights mask */
233 unsigned int nexactf; /* N exact MPS filters */
234 unsigned int r_caps; /* read capabilities */
235 unsigned int wx_caps; /* write/execute capabilities */
238 struct adapter_params {
239 struct sge_params sge;
241 struct vpd_params vpd;
242 struct pci_params pci;
243 struct devlog_params devlog;
244 struct rss_params rss;
245 struct pf_resources pfres;
246 struct vf_resources vfres;
247 enum pcie_memwin drv_memwin;
249 unsigned int sf_size; /* serial flash size in bytes */
250 unsigned int sf_nsec; /* # of flash sectors */
252 unsigned int fw_vers;
253 unsigned int bs_vers;
254 unsigned int tp_vers;
255 unsigned int er_vers;
257 unsigned short mtus[NMTUS];
258 unsigned short a_wnd[NCCTRL_WIN];
259 unsigned short b_wnd[NCCTRL_WIN];
261 unsigned int mc_size; /* MC memory size */
262 unsigned int cim_la_size;
264 unsigned char nports; /* # of ethernet ports */
265 unsigned char portvec;
267 unsigned char hash_filter;
269 enum chip_type chip; /* chip code */
270 struct arch_specific_params arch; /* chip specific params */
272 bool ulptx_memwrite_dsgl; /* use of T5 DSGL allowed */
273 u8 fw_caps_support; /* 32-bit Port Capabilities */
274 u8 filter2_wr_support; /* FW support for FILTER2_WR */
277 /* Firmware Port Capabilities types.
279 typedef u16 fw_port_cap16_t; /* 16-bit Port Capabilities integral value */
280 typedef u32 fw_port_cap32_t; /* 32-bit Port Capabilities integral value */
283 FW_CAPS_UNKNOWN = 0, /* 0'ed out initial state */
284 FW_CAPS16 = 1, /* old Firmware: 16-bit Port Capabilities */
285 FW_CAPS32 = 2, /* new Firmware: 32-bit Port Capabilities */
289 fw_port_cap32_t pcaps; /* link capabilities */
290 fw_port_cap32_t acaps; /* advertised capabilities */
292 u32 requested_speed; /* speed (Mb/s) user has requested */
293 u32 speed; /* actual link speed (Mb/s) */
295 enum cc_pause requested_fc; /* flow control user has requested */
296 enum cc_pause fc; /* actual link flow control */
298 enum cc_fec auto_fec; /* Forward Error Correction
299 * "automatic" (IEEE 802.3)
301 enum cc_fec requested_fec; /* Forward Error Correction requested */
302 enum cc_fec fec; /* Forward Error Correction actual */
304 unsigned char autoneg; /* autonegotiating? */
306 unsigned char link_ok; /* link up? */
307 unsigned char link_down_rc; /* link down reason */
312 void t4_set_reg_field(struct adapter *adap, unsigned int addr, u32 mask,
314 int t4_wait_op_done_val(struct adapter *adapter, int reg, u32 mask,
316 int attempts, int delay, u32 *valp);
318 static inline int t4_wait_op_done(struct adapter *adapter, int reg, u32 mask,
319 int polarity, int attempts, int delay)
321 return t4_wait_op_done_val(adapter, reg, mask, polarity, attempts,
325 static inline int is_pf4(struct adapter *adap)
327 return adap->pf == 4;
330 #define for_each_port(adapter, iter) \
331 for (iter = 0; iter < (adapter)->params.nports; ++iter)
333 static inline int is_hashfilter(const struct adapter *adap)
335 return adap->params.hash_filter;
338 void t4_read_mtu_tbl(struct adapter *adap, u16 *mtus, u8 *mtu_log);
339 void t4_tp_wr_bits_indirect(struct adapter *adap, unsigned int addr,
340 unsigned int mask, unsigned int val);
341 void t4_intr_enable(struct adapter *adapter);
342 void t4_intr_disable(struct adapter *adapter);
343 int t4_link_l1cfg(struct adapter *adap, unsigned int mbox, unsigned int port,
344 struct link_config *lc);
345 void t4_load_mtus(struct adapter *adap, const unsigned short *mtus,
346 const unsigned short *alpha, const unsigned short *beta);
347 int t4_fw_hello(struct adapter *adap, unsigned int mbox, unsigned int evt_mbox,
348 enum dev_master master, enum dev_state *state);
349 int t4_fw_bye(struct adapter *adap, unsigned int mbox);
350 int t4_fw_reset(struct adapter *adap, unsigned int mbox, int reset);
351 int t4vf_fw_reset(struct adapter *adap);
352 int t4_fw_halt(struct adapter *adap, unsigned int mbox, int reset);
353 int t4_fw_restart(struct adapter *adap, unsigned int mbox, int reset);
354 int t4_fl_pkt_align(struct adapter *adap);
355 int t4vf_fl_pkt_align(struct adapter *adap, u32 sge_control, u32 sge_control2);
356 int t4vf_get_vfres(struct adapter *adap);
357 int t4_fixup_host_params_compat(struct adapter *adap, unsigned int page_size,
358 unsigned int cache_line_size,
359 enum chip_type chip_compat);
360 int t4_fixup_host_params(struct adapter *adap, unsigned int page_size,
361 unsigned int cache_line_size);
362 int t4_fw_initialize(struct adapter *adap, unsigned int mbox);
363 int t4_query_params(struct adapter *adap, unsigned int mbox, unsigned int pf,
364 unsigned int vf, unsigned int nparams, const u32 *params,
366 int t4vf_query_params(struct adapter *adap, unsigned int nparams,
367 const u32 *params, u32 *vals);
368 int t4vf_get_dev_params(struct adapter *adap);
369 int t4vf_get_vpd_params(struct adapter *adap);
370 int t4vf_get_rss_glb_config(struct adapter *adap);
371 int t4vf_set_params(struct adapter *adapter, unsigned int nparams,
372 const u32 *params, const u32 *vals);
373 int t4_set_params_timeout(struct adapter *adap, unsigned int mbox,
374 unsigned int pf, unsigned int vf,
375 unsigned int nparams, const u32 *params,
376 const u32 *val, int timeout);
377 int t4_set_params(struct adapter *adap, unsigned int mbox, unsigned int pf,
378 unsigned int vf, unsigned int nparams, const u32 *params,
380 int t4_alloc_vi_func(struct adapter *adap, unsigned int mbox,
381 unsigned int port, unsigned int pf, unsigned int vf,
382 unsigned int nmac, u8 *mac, unsigned int *rss_size,
383 unsigned int portfunc, unsigned int idstype);
384 int t4_alloc_vi(struct adapter *adap, unsigned int mbox, unsigned int port,
385 unsigned int pf, unsigned int vf, unsigned int nmac, u8 *mac,
386 unsigned int *rss_size);
387 int t4_free_vi(struct adapter *adap, unsigned int mbox,
388 unsigned int pf, unsigned int vf,
390 int t4_set_rxmode(struct adapter *adap, unsigned int mbox, unsigned int viid,
391 int mtu, int promisc, int all_multi, int bcast, int vlanex,
393 int t4_free_raw_mac_filt(struct adapter *adap, unsigned int viid,
394 const u8 *addr, const u8 *mask, unsigned int idx,
395 u8 lookup_type, u8 port_id, bool sleep_ok);
396 int t4_alloc_raw_mac_filt(struct adapter *adap, unsigned int viid,
397 const u8 *addr, const u8 *mask, unsigned int idx,
398 u8 lookup_type, u8 port_id, bool sleep_ok);
399 int t4_change_mac(struct adapter *adap, unsigned int mbox, unsigned int viid,
400 int idx, const u8 *addr, bool persist, bool add_smt);
401 int t4_enable_vi_params(struct adapter *adap, unsigned int mbox,
402 unsigned int viid, bool rx_en, bool tx_en, bool dcb_en);
403 int t4_enable_vi(struct adapter *adap, unsigned int mbox, unsigned int viid,
404 bool rx_en, bool tx_en);
405 int t4_iq_start_stop(struct adapter *adap, unsigned int mbox, bool start,
406 unsigned int pf, unsigned int vf, unsigned int iqid,
407 unsigned int fl0id, unsigned int fl1id);
408 int t4_iq_free(struct adapter *adap, unsigned int mbox, unsigned int pf,
409 unsigned int vf, unsigned int iqtype, unsigned int iqid,
410 unsigned int fl0id, unsigned int fl1id);
411 int t4_eth_eq_free(struct adapter *adap, unsigned int mbox, unsigned int pf,
412 unsigned int vf, unsigned int eqid);
413 int t4_ctrl_eq_free(struct adapter *adap, unsigned int mbox, unsigned int pf,
414 unsigned int vf, unsigned int eqid);
416 static inline unsigned int core_ticks_per_usec(const struct adapter *adap)
418 return adap->params.vpd.cclk / 1000;
421 static inline unsigned int us_to_core_ticks(const struct adapter *adap,
424 return (us * adap->params.vpd.cclk) / 1000;
427 static inline unsigned int core_ticks_to_us(const struct adapter *adapter,
430 /* add Core Clock / 2 to round ticks to nearest uS */
431 return ((ticks * 1000 + adapter->params.vpd.cclk / 2) /
432 adapter->params.vpd.cclk);
435 int t4_wr_mbox_meat_timeout(struct adapter *adap, int mbox, const void *cmd,
436 int size, void *rpl, bool sleep_ok, int timeout);
437 int t4_wr_mbox_meat(struct adapter *adap, int mbox,
438 const void __attribute__((__may_alias__)) *cmd, int size,
439 void *rpl, bool sleep_ok);
441 static inline int t4_wr_mbox_timeout(struct adapter *adap, int mbox,
442 const void *cmd, int size, void *rpl,
445 return t4_wr_mbox_meat_timeout(adap, mbox, cmd, size, rpl, true,
449 int t4_get_core_clock(struct adapter *adapter, struct vpd_params *p);
451 static inline int t4_wr_mbox(struct adapter *adap, int mbox, const void *cmd,
454 return t4_wr_mbox_meat(adap, mbox, cmd, size, rpl, true);
457 static inline int t4_wr_mbox_ns(struct adapter *adap, int mbox, const void *cmd,
460 return t4_wr_mbox_meat(adap, mbox, cmd, size, rpl, false);
463 int t4vf_wr_mbox_core(struct adapter *, const void *, int, void *, bool);
465 static inline int t4vf_wr_mbox(struct adapter *adapter, const void *cmd,
468 return t4vf_wr_mbox_core(adapter, cmd, size, rpl, true);
471 static inline int t4vf_wr_mbox_ns(struct adapter *adapter, const void *cmd,
474 return t4vf_wr_mbox_core(adapter, cmd, size, rpl, false);
478 void t4_read_indirect(struct adapter *adap, unsigned int addr_reg,
479 unsigned int data_reg, u32 *vals, unsigned int nregs,
480 unsigned int start_idx);
481 void t4_write_indirect(struct adapter *adap, unsigned int addr_reg,
482 unsigned int data_reg, const u32 *vals,
483 unsigned int nregs, unsigned int start_idx);
485 int t4_get_vpd_params(struct adapter *adapter, struct vpd_params *p);
486 int t4_get_pfres(struct adapter *adapter);
487 int t4_read_flash(struct adapter *adapter, unsigned int addr,
488 unsigned int nwords, u32 *data, int byte_oriented);
489 int t4_flash_cfg_addr(struct adapter *adapter);
490 unsigned int t4_get_mps_bg_map(struct adapter *adapter, unsigned int pidx);
491 unsigned int t4_get_tp_ch_map(struct adapter *adapter, unsigned int pidx);
492 const char *t4_get_port_type_description(enum fw_port_type port_type);
493 void t4_get_port_stats(struct adapter *adap, int idx, struct port_stats *p);
494 void t4vf_get_port_stats(struct adapter *adapter, int pidx,
495 struct port_stats *p);
496 void t4_get_port_stats_offset(struct adapter *adap, int idx,
497 struct port_stats *stats,
498 struct port_stats *offset);
499 void t4_clr_port_stats(struct adapter *adap, int idx);
500 void init_link_config(struct link_config *lc, fw_port_cap32_t pcaps,
501 fw_port_cap32_t acaps);
502 void t4_reset_link_config(struct adapter *adap, int idx);
503 int t4_get_version_info(struct adapter *adapter);
504 void t4_dump_version_info(struct adapter *adapter);
505 int t4_get_flash_params(struct adapter *adapter);
506 int t4_get_chip_type(struct adapter *adap, int ver);
507 int t4_prep_adapter(struct adapter *adapter);
508 int t4vf_prep_adapter(struct adapter *adapter);
509 int t4_port_init(struct adapter *adap, int mbox, int pf, int vf);
510 int t4vf_port_init(struct adapter *adap);
511 int t4_init_rss_mode(struct adapter *adap, int mbox);
512 int t4_config_rss_range(struct adapter *adapter, int mbox, unsigned int viid,
513 int start, int n, const u16 *rspq, unsigned int nrspq);
514 int t4_config_vi_rss(struct adapter *adapter, int mbox, unsigned int viid,
515 unsigned int flags, unsigned int defq);
516 int t4_read_config_vi_rss(struct adapter *adapter, int mbox, unsigned int viid,
517 u64 *flags, unsigned int *defq);
518 void t4_fw_tp_pio_rw(struct adapter *adap, u32 *vals, unsigned int nregs,
519 unsigned int start_index, unsigned int rw);
520 void t4_write_rss_key(struct adapter *adap, u32 *key, int idx);
521 void t4_read_rss_key(struct adapter *adap, u32 *key);
523 enum t4_bar2_qtype { T4_BAR2_QTYPE_EGRESS, T4_BAR2_QTYPE_INGRESS };
524 int t4_bar2_sge_qregs(struct adapter *adapter, unsigned int qid,
525 unsigned int qtype, u64 *pbar2_qoffset,
526 unsigned int *pbar2_qid);
528 int t4_init_sge_params(struct adapter *adapter);
529 int t4_init_tp_params(struct adapter *adap);
530 int t4_filter_field_shift(const struct adapter *adap, unsigned int filter_sel);
531 int t4_handle_fw_rpl(struct adapter *adap, const __be64 *rpl);
532 unsigned int t4_get_regs_len(struct adapter *adap);
533 unsigned int t4vf_get_pf_from_vf(struct adapter *adap);
534 void t4_get_regs(struct adapter *adap, void *buf, size_t buf_size);
535 int t4_seeprom_read(struct adapter *adapter, u32 addr, u32 *data);
536 int t4_seeprom_write(struct adapter *adapter, u32 addr, u32 data);
537 int t4_seeprom_wp(struct adapter *adapter, int enable);
538 int t4_memory_rw_addr(struct adapter *adap, int win,
539 u32 addr, u32 len, void *hbuf, int dir);
540 int t4_memory_rw_mtype(struct adapter *adap, int win, int mtype, u32 maddr,
541 u32 len, void *hbuf, int dir);
542 static inline int t4_memory_rw(struct adapter *adap, int win,
543 int mtype, u32 maddr, u32 len,
546 return t4_memory_rw_mtype(adap, win, mtype, maddr, len, hbuf, dir);
548 fw_port_cap32_t fwcaps16_to_caps32(fw_port_cap16_t caps16);
549 #endif /* __CHELSIO_COMMON_H */